tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use doxygen comment style for document entity such as struct, enum, variable that use /// but not // 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5647 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2008-08-14 03:30:12 +00:00
parent ec8432e515
commit fc30687f39
17 changed files with 847 additions and 847 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
MdePkg/Include/Library/BaseLib.h
View File

@ -20,15 +20,15 @@
// These include SPIN_LOCK and BASE_LIBRARY_JUMP_BUFFER
//
//
// SPIN_LOCK
//
///
/// SPIN_LOCK
///
typedef volatile UINTN SPIN_LOCK;
#if defined (MDE_CPU_IA32)
//
// IA32 context buffer used by SetJump() and LongJump()
//
///
/// IA32 context buffer used by SetJump() and LongJump()
///
typedef struct {
UINT32 Ebx;
UINT32 Esi;
@ -42,9 +42,9 @@ typedef struct {
#elif defined (MDE_CPU_IPF)
//
// IPF context buffer used by SetJump() and LongJump()
//
///
/// IPF context buffer used by SetJump() and LongJump()
///
typedef struct {
UINT64 F2[2];
UINT64 F3[2];
@ -89,9 +89,9 @@ typedef struct {
#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10
#elif defined (MDE_CPU_X64)
//
// X64 context buffer used by SetJump() and LongJump()
//
///
/// X64 context buffer used by SetJump() and LongJump()
///
typedef struct {
UINT64 Rbx;
UINT64 Rsp;
@ -108,9 +108,9 @@ typedef struct {
#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
#elif defined (MDE_CPU_EBC)
//
// EBC context buffer used by SetJump() and LongJump()
//
///
/// EBC context buffer used by SetJump() and LongJump()
///
typedef struct {
UINT64 R0;
UINT64 R1;

6
MdePkg/Include/Library/DxeCoreEntryPoint.h
View File

@ -15,9 +15,9 @@
#ifndef __MODULE_ENTRY_POINT_H__
#define __MODULE_ENTRY_POINT_H__
//
// Declare the cache of copy of HobList.
//
///
/// Declare the cache of copy of HobList.
///
extern VOID *gHobList;

6
MdePkg/Include/Library/DxeServicesTableLib.h
View File

@ -15,9 +15,9 @@
#ifndef __DXE_SERVICES_TABLE_LIB_H__
#define __DXE_SERVICES_TABLE_LIB_H__
//
// Cache copy of the DXE Services Table
//
///
/// Cache copy of the DXE Services Table
///
extern EFI_DXE_SERVICES *gDS;
#endif

18
MdePkg/Include/Library/DxeSmmDriverEntryPoint.h
View File

@ -15,19 +15,19 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __MODULE_ENTRY_POINT_H__
#define __MODULE_ENTRY_POINT_H__
//
// Declare the EFI/UEFI Specification Revision to which this driver is implemented
//
///
/// Declare the EFI/UEFI Specification Revision to which this driver is implemented
///
extern const UINT32 _gUefiDriverRevision;
//
// Declare the number of entry points in the image.
//
///
/// Declare the number of entry points in the image.
///
extern const UINT8 _gDriverEntryPointCount;
//
// Declare the number of unload handler in the image.
//
///
/// Declare the number of unload handler in the image.
///
extern const UINT8 _gDriverUnloadImageCount;
/**

8
MdePkg/Include/Library/HiiLib.h
View File

@ -15,10 +15,10 @@
#ifndef __HII_LIB_H__
#define __HII_LIB_H__
//
// Limited buffer size recommended by RFC4646 (4.3. Length Considerations)
// (42 characters plus a NULL terminator)
//
///
/// Limited buffer size recommended by RFC4646 (4.3. Length Considerations)
/// (42 characters plus a NULL terminator)
///
#define RFC_3066_ENTRY_SIZE (42 + 1)
#define ISO_639_2_ENTRY_SIZE 3

1330
MdePkg/Include/Library/IfrSupportLib.h
View File

File diff suppressed because it is too large Load Diff

6
MdePkg/Include/Library/PcdLib.h
View File

@ -30,9 +30,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define PcdToken(TokenName) _PCD_TOKEN_##TokenName
//
// Feature Flag is in the form of a global constant
//
///
/// Feature Flag is in the form of a global constant
///
#define FeaturePcdGet(TokenName) _PCD_GET_MODE_BOOL_##TokenName

6
MdePkg/Include/Library/PeimEntryPoint.h
View File

@ -15,9 +15,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __MODULE_ENTRY_POINT_H__
#define __MODULE_ENTRY_POINT_H__
//
// Declare the EFI/UEFI Specification Revision to which this driver is implemented
//
///
/// Declare the EFI/UEFI Specification Revision to which this driver is implemented
///
extern const UINT32 _gPeimRevision;
/**

6
MdePkg/Include/Library/PerformanceLib.h
View File

@ -15,9 +15,9 @@
#ifndef __PERFORMANCE_LIB_H__
#define __PERFORMANCE_LIB_H__
//
// Performance library propery mask bits
//
///
/// Performance library propery mask bits
///
#define PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED 0x00000001
/**

188
MdePkg/Include/Library/ScsiLib.h
View File

@ -24,24 +24,24 @@
#define EFI_SCSI_STALL_1_MILLISECOND 10000
#define EFI_SCSI_STALL_1_SECOND 10000000
//
// this macro cannot be directly used by the gBS->Stall(),
// since the value output by this macro is in 100ns unit,
// not 1us unit (1us = 1000ns)
//
///
/// this macro cannot be directly used by the gBS->Stall(),
/// since the value output by this macro is in 100ns unit,
/// not 1us unit (1us = 1000ns)
///
#define EfiScsiStallSeconds(a) ((a) * EFI_SCSI_STALL_1_SECOND)
/**
/**
Function test the ready status of the SCSI unit.
@param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period.
@param[out] SenseData A pointer to output sense data.
@param[out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period.
@param[out] SenseData A pointer to output sense data.
@param[out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@retval EFI_SUCCESS The status of the unit is tested successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
@ -58,7 +58,7 @@
Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
**/
EFI_STATUS
EFIAPI
@ -72,19 +72,19 @@ ScsiTestUnitReadyCommand (
);
/**
/**
Function to submit SCSI inquiry command.
@param[in] ScsiIo SCSI IO Protocol to use
@param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data.
@param[in out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[in out] InquirydataBuffer A pointer to inquiry data buffer.
@param[in out] InquiryDataLength The length of inquiry data buffer.
@param[in] EnableVitalProductData Boolean to enable Vital Product Data.
@param[in] ScsiIo SCSI IO Protocol to use
@param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data.
@param[in out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[in out] InquirydataBuffer A pointer to inquiry data buffer.
@param[in out] InquiryDataLength The length of inquiry data buffer.
@param[in] EnableVitalProductData Boolean to enable Vital Product Data.
@retval EFI_SUCCESS The status of the unit is tested successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
@ -101,7 +101,7 @@ ScsiTestUnitReadyCommand (
Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
**/
EFI_STATUS
EFIAPI
@ -118,21 +118,21 @@ ScsiInquiryCommand (
);
/**
/**
Function to submit SCSI mode sense 10 command.
@param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data.
@param[in out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[in] DataBuffer A pointer to input data buffer.
@param[in out] DataLength The length of input data buffer.
@param[in] DBDField The DBD Field (Optional).
@param[in] PageControl Page Control.
@param[in] PageCode Page code.
@param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data.
@param[in out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[in] DataBuffer A pointer to input data buffer.
@param[in out] DataLength The length of input data buffer.
@param[in] DBDField The DBD Field (Optional).
@param[in] PageControl Page Control.
@param[in] PageCode Page code.
@retval EFI_SUCCESS The status of the unit is tested successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
@ -149,7 +149,7 @@ ScsiInquiryCommand (
Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
**/
EFI_STATUS
EFIAPI
@ -169,7 +169,7 @@ ScsiModeSense10Command (
/**
/**
Function to submit SCSI request sense command.
ScsiIo - A pointer to SCSI IO protocol.
Timeout - The length of timeout period.
@ -177,15 +177,15 @@ ScsiModeSense10Command (
SenseDataLength - The length of output sense data.
HostAdapterStatus - The status of Host Adapter.
TargetStatus - The status of the target.
@param[in] ScsiIo SCSI IO Protocol to use
@param[in] Timeout TODO:
@param[in] SenseData TODO:
@param[in out] SenseDataLength TODO:
@param[out] HostAdapterStatus TODO:
@param[out] TargetStatus TODO:
@retval EFI_SUCCESS Valid data returned
@param[in] ScsiIo SCSI IO Protocol to use
@param[in] Timeout TODO:
@param[in] SenseData TODO:
@param[in out] SenseDataLength TODO:
@param[out] HostAdapterStatus TODO:
@param[out] TargetStatus TODO:
@retval EFI_SUCCESS Valid data returned
@retval EFI_SUCCESS The status of the unit is tested successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
@ -202,7 +202,7 @@ ScsiModeSense10Command (
Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
**/
EFI_STATUS
EFIAPI
@ -216,19 +216,19 @@ ScsiRequestSenseCommand (
);
/**
/**
Function to submit read capacity command.
@param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data.
@param[in out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[out] DataBuffer A pointer to a data buffer.
@param[in out] DataLength The length of data buffer.
@param[in] PMI Partial medium indicator.
@param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data.
@param[in out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[out] DataBuffer A pointer to a data buffer.
@param[in out] DataLength The length of data buffer.
@param[in] PMI Partial medium indicator.
@retval EFI_SUCCESS The status of the unit is tested successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
@ -245,7 +245,7 @@ ScsiRequestSenseCommand (
Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
**/
EFI_STATUS
EFIAPI
@ -262,20 +262,20 @@ ScsiReadCapacityCommand (
);
/**
/**
Function to submit read 10 command.
@param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data.
@param[in out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[out] DataBuffer Read 10 command data.
@param[in out] DataLength The length of data buffer.
@param[in] StartLba The start address of LBA.
@param[in] SectorSize The sector size.
@param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data.
@param[in out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[out] DataBuffer Read 10 command data.
@param[in out] DataLength The length of data buffer.
@param[in] StartLba The start address of LBA.
@param[in] SectorSize The sector size.
@retval EFI_SUCCESS The status of the unit is tested successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
@ -292,7 +292,7 @@ ScsiReadCapacityCommand (
Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
**/
EFI_STATUS
EFIAPI
@ -310,20 +310,20 @@ ScsiRead10Command (
);
/**
/**
Function to submit SCSI write 10 command.
@param[in] ScsiIo SCSI IO Protocol to use
@param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data.
@param[in out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[out] DataBuffer A pointer to a data buffer.
@param[in out] DataLength The length of data buffer.
@param[in] StartLba The start address of LBA.
@param[in] SectorSize The sector size.
@param[in] ScsiIo SCSI IO Protocol to use
@param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data.
@param[in out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[out] DataBuffer A pointer to a data buffer.
@param[in out] DataLength The length of data buffer.
@param[in] StartLba The start address of LBA.
@param[in] SectorSize The sector size.
@retval EFI_SUCCESS The status of the unit is tested successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
@ -340,7 +340,7 @@ ScsiRead10Command (
Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
**/
EFI_STATUS
EFIAPI

6
MdePkg/Include/Library/SmbusLib.h
View File

@ -15,9 +15,9 @@
#ifndef __SMBUS_LIB__
#define __SMBUS_LIB__
//
// PEC BIT is bit 22 in SMBUS address
//
///
/// PEC BIT is bit 22 in SMBUS address
///
#define SMBUS_LIB_PEC_BIT (1 << 22)
/**

6
MdePkg/Include/Library/UefiApplicationEntryPoint.h
View File

@ -15,9 +15,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __UEFI_APPLICATION_ENTRY_POINT_H__
#define __UEFI_APPLICATION_ENTRY_POINT_H__
//
// Declare the EFI/UEFI Specification Revision to which this driver is implemented
//
///
/// Declare the EFI/UEFI Specification Revision to which this driver is implemented
///
extern const UINT32 _gUefiDriverRevision;
/**

18
MdePkg/Include/Library/UefiBootServicesTableLib.h
View File

@ -15,19 +15,19 @@
#ifndef __UEFI_BOOT_SERVICES_TABLE_LIB_H__
#define __UEFI_BOOT_SERVICES_TABLE_LIB_H__
//
// Cache the Image Handle
//
///
/// Cache the Image Handle
///
extern EFI_HANDLE gImageHandle;
//
// Cache pointer to the EFI System Table
//
///
/// Cache pointer to the EFI System Table
///
extern EFI_SYSTEM_TABLE *gST;
//
// Cache pointer to the EFI Boot Services Table
//
///
/// Cache pointer to the EFI Boot Services Table
///
extern EFI_BOOT_SERVICES *gBS;
#endif

30
MdePkg/Include/Library/UefiDriverEntryPoint.h
View File

@ -15,29 +15,29 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __MODULE_ENTRY_POINT_H__
#define __MODULE_ENTRY_POINT_H__
//
// Declare the EFI/UEFI Specification Revision to which this driver is implemented
//
///
/// Declare the EFI/UEFI Specification Revision to which this driver is implemented
///
extern const UINT32 _gUefiDriverRevision;
//
// Declare the number of entry points in the image.
//
///
/// Declare the number of entry points in the image.
///
extern const UINT8 _gDriverEntryPointCount;
//
// Declare the number of unload handler in the image.
//
///
/// Declare the number of unload handler in the image.
///
extern const UINT8 _gDriverUnloadImageCount;
//
// Declare the arrary of Boot Sevice Exit Event callbacks .
//
///
/// Declare the arrary of Boot Sevice Exit Event callbacks .
///
extern const EFI_EVENT_NOTIFY _gDriverExitBootServicesEvent[];
//
// Declare the arrary of Virtual Address Change Event callbacks .
//
///
/// Declare the arrary of Virtual Address Change Event callbacks .
///
extern const EFI_EVENT_NOTIFY _gDriverSetVirtualAddressMapEvent[];
/**

18
MdePkg/Include/Library/UefiLib.h
View File

@ -22,26 +22,26 @@
#include <Protocol/DriverDiagnostics.h>
#include <Protocol/DriverDiagnostics2.h>
//
// Unicode String Table
//
///
/// Unicode String Table
///
typedef struct {
CHAR8 *Language;
CHAR16 *UnicodeString;
} EFI_UNICODE_STRING_TABLE;
//
// EFI Lock Status
//
///
/// EFI Lock Status
///
typedef enum {
EfiLockUninitialized = 0,
EfiLockReleased = 1,
EfiLockAcquired = 2
} EFI_LOCK_STATE;
//
// EFI Lock
//
///
/// EFI Lock
///
typedef struct {
EFI_TPL Tpl;
EFI_TPL OwnerTpl;

6
MdePkg/Include/Library/UefiRuntimeServicesTableLib.h
View File

@ -15,9 +15,9 @@
#ifndef __UEFI_RUNTIME_SERVICES_TABLE_LIB_H__
#define __UEFI_RUNTIME_SERVICES_TABLE_LIB_H__
//
// Cached copy of the EFI Runtime Services Table
//
///
/// Cached copy of the EFI Runtime Services Table
///
extern EFI_RUNTIME_SERVICES *gRT;
#endif

6
MdePkg/Include/Library/UsbLib.h
View File

@ -18,9 +18,9 @@
#include <Protocol/UsbIo.h>
//
// define the timeout time as 3ms
//
///
/// define the timeout time as 3ms
///
#define TIMEOUT_VALUE 3 * 1000
/**