Minor update to some protocol interface function prototype for Doxygen document

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10207 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
rsun3
2010-03-05 06:31:45 +00:00
parent 6e374f4997
commit 0c1a4aa69a
3 changed files with 25 additions and 25 deletions

View File

@ -4,7 +4,7 @@ write capability for block devices. The protocol provides for non-volatile
storage of the intermediate data and private information a caller would need to storage of the intermediate data and private information a caller would need to
recover from a critical fault, such as a power failure. recover from a critical fault, such as a power failure.
Copyright (c) 2009, Intel Corporation Copyright (c) 2009 - 2010, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -42,7 +42,7 @@ typedef struct _EFI_FAULT_TOLERANT_WRITE_PROTOCOL EFI_FAULT_TOLERANT_WRITE_PROT
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_FAULT_TOLERANT_WRITE_GET_MAX_BLOCK_SIZE) ( (EFIAPI *EFI_FAULT_TOLERANT_WRITE_GET_MAX_BLOCK_SIZE)(
IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL * This, IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL * This,
OUT UINTN *BlockSize OUT UINTN *BlockSize
); );
@ -70,7 +70,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_FAULT_TOLERANT_WRITE_ALLOCATE) ( (EFIAPI *EFI_FAULT_TOLERANT_WRITE_ALLOCATE)(
IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL * This, IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL * This,
IN EFI_GUID * CallerId, IN EFI_GUID * CallerId,
IN UINTN PrivateDataSize, IN UINTN PrivateDataSize,
@ -106,7 +106,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_FAULT_TOLERANT_WRITE_WRITE) ( (EFIAPI *EFI_FAULT_TOLERANT_WRITE_WRITE)(
IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL * This, IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL * This,
IN EFI_LBA Lba, IN EFI_LBA Lba,
IN UINTN Offset, IN UINTN Offset,
@ -131,7 +131,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_FAULT_TOLERANT_WRITE_RESTART) ( (EFIAPI *EFI_FAULT_TOLERANT_WRITE_RESTART)(
IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL * This, IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL * This,
IN EFI_HANDLE FvbHandle IN EFI_HANDLE FvbHandle
); );
@ -148,7 +148,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_FAULT_TOLERANT_WRITE_ABORT) ( (EFIAPI *EFI_FAULT_TOLERANT_WRITE_ABORT)(
IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL * This IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL * This
); );
@ -179,7 +179,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_FAULT_TOLERANT_WRITE_GET_LAST_WRITE) ( (EFIAPI *EFI_FAULT_TOLERANT_WRITE_GET_LAST_WRITE)(
IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL * This, IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL * This,
OUT EFI_GUID * CallerId, OUT EFI_GUID * CallerId,
OUT EFI_LBA *Lba, OUT EFI_LBA *Lba,

View File

@ -3,7 +3,7 @@
This print protocol defines six basic print functions to This print protocol defines six basic print functions to
print the format unicode and ascii string. print the format unicode and ascii string.
Copyright (c) 2006 - 2009, Intel Corporation Copyright (c) 2006 - 2010, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -60,7 +60,7 @@ typedef struct _EFI_PRINT2_PROTOCOL EFI_PRINT2_PROTOCOL;
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *UNICODE_BS_PRINT) ( (EFIAPI *UNICODE_BS_PRINT)(
OUT CHAR16 *StartOfBuffer, OUT CHAR16 *StartOfBuffer,
IN UINTN BufferSize, IN UINTN BufferSize,
IN CONST CHAR16 *FormatString, IN CONST CHAR16 *FormatString,
@ -102,7 +102,7 @@ UINTN
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *UNICODE_S_PRINT) ( (EFIAPI *UNICODE_S_PRINT)(
OUT CHAR16 *StartOfBuffer, OUT CHAR16 *StartOfBuffer,
IN UINTN BufferSize, IN UINTN BufferSize,
IN CONST CHAR16 *FormatString, IN CONST CHAR16 *FormatString,
@ -143,7 +143,7 @@ UINTN
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *UNICODE_BS_PRINT_ASCII_FORMAT) ( (EFIAPI *UNICODE_BS_PRINT_ASCII_FORMAT)(
OUT CHAR16 *StartOfBuffer, OUT CHAR16 *StartOfBuffer,
IN UINTN BufferSize, IN UINTN BufferSize,
IN CONST CHAR8 *FormatString, IN CONST CHAR8 *FormatString,
@ -184,7 +184,7 @@ UINTN
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *UNICODE_S_PRINT_ASCII_FORMAT) ( (EFIAPI *UNICODE_S_PRINT_ASCII_FORMAT)(
OUT CHAR16 *StartOfBuffer, OUT CHAR16 *StartOfBuffer,
IN UINTN BufferSize, IN UINTN BufferSize,
IN CONST CHAR8 *FormatString, IN CONST CHAR8 *FormatString,
@ -234,7 +234,7 @@ UINTN
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *UNICODE_VALUE_TO_STRING) ( (EFIAPI *UNICODE_VALUE_TO_STRING)(
IN OUT CHAR16 *Buffer, IN OUT CHAR16 *Buffer,
IN UINTN Flags, IN UINTN Flags,
IN INT64 Value, IN INT64 Value,
@ -274,7 +274,7 @@ UINTN
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *ASCII_BS_PRINT) ( (EFIAPI *ASCII_BS_PRINT)(
OUT CHAR8 *StartOfBuffer, OUT CHAR8 *StartOfBuffer,
IN UINTN BufferSize, IN UINTN BufferSize,
IN CONST CHAR8 *FormatString, IN CONST CHAR8 *FormatString,
@ -314,7 +314,7 @@ UINTN
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *ASCII_S_PRINT) ( (EFIAPI *ASCII_S_PRINT)(
OUT CHAR8 *StartOfBuffer, OUT CHAR8 *StartOfBuffer,
IN UINTN BufferSize, IN UINTN BufferSize,
IN CONST CHAR8 *FormatString, IN CONST CHAR8 *FormatString,
@ -355,7 +355,7 @@ UINTN
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *ASCII_BS_PRINT_UNICODE_FORMAT) ( (EFIAPI *ASCII_BS_PRINT_UNICODE_FORMAT)(
OUT CHAR8 *StartOfBuffer, OUT CHAR8 *StartOfBuffer,
IN UINTN BufferSize, IN UINTN BufferSize,
IN CONST CHAR16 *FormatString, IN CONST CHAR16 *FormatString,
@ -396,7 +396,7 @@ UINTN
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *ASCII_S_PRINT_UNICODE_FORMAT) ( (EFIAPI *ASCII_S_PRINT_UNICODE_FORMAT)(
OUT CHAR8 *StartOfBuffer, OUT CHAR8 *StartOfBuffer,
IN UINTN BufferSize, IN UINTN BufferSize,
IN CONST CHAR16 *FormatString, IN CONST CHAR16 *FormatString,
@ -444,7 +444,7 @@ UINTN
**/ **/
typedef typedef
UINTN UINTN
(EFIAPI *ASCII_VALUE_TO_STRING) ( (EFIAPI *ASCII_VALUE_TO_STRING)(
OUT CHAR8 *Buffer, OUT CHAR8 *Buffer,
IN UINTN Flags, IN UINTN Flags,
IN INT64 Value, IN INT64 Value,

View File

@ -5,7 +5,7 @@ power failure happens during the boot block update, the swapped backup block (no
can boot the machine with the old boot block backed up in it. The swap operation is platform dependent, so can boot the machine with the old boot block backed up in it. The swap operation is platform dependent, so
other protocols such as FTW (Fault Tolerant Write) should use this protocol instead of handling hardware directly. other protocols such as FTW (Fault Tolerant Write) should use this protocol instead of handling hardware directly.
Copyright (c) 2009, Intel Corporation Copyright (c) 2009 - 2010, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -54,7 +54,7 @@ typedef UINT8 EFI_SWAP_LOCK_CAPABILITY;
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_GET_RANGE_LOCATION) ( (EFIAPI *EFI_GET_RANGE_LOCATION)(
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This, IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
OUT EFI_PHYSICAL_ADDRESS *BootBlockBase, OUT EFI_PHYSICAL_ADDRESS *BootBlockBase,
OUT UINTN *BootBlockSize, OUT UINTN *BootBlockSize,
@ -74,7 +74,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_GET_SWAP_STATE) ( (EFIAPI *EFI_GET_SWAP_STATE)(
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This, IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
OUT BOOLEAN *SwapState OUT BOOLEAN *SwapState
); );
@ -94,7 +94,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SET_SWAP_STATE) ( (EFIAPI *EFI_SET_SWAP_STATE)(
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This, IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
IN BOOLEAN NewSwapState IN BOOLEAN NewSwapState
); );
@ -115,7 +115,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_GET_RTC_POWER_STATUS) ( (EFIAPI *EFI_GET_RTC_POWER_STATUS)(
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This, IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
OUT BOOLEAN *RtcPowerFailed OUT BOOLEAN *RtcPowerFailed
); );
@ -132,7 +132,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_GET_SWAP_LOCK_CAPABILITY) ( (EFIAPI *EFI_GET_SWAP_LOCK_CAPABILITY)(
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This, IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
OUT EFI_SWAP_LOCK_CAPABILITY *LockCapability OUT EFI_SWAP_LOCK_CAPABILITY *LockCapability
); );
@ -153,7 +153,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SET_SWAP_LOCK) ( (EFIAPI *EFI_SET_SWAP_LOCK)(
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This, IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
IN EFI_SWAP_LOCK_CAPABILITY LockCapability, IN EFI_SWAP_LOCK_CAPABILITY LockCapability,
IN BOOLEAN NewLockState IN BOOLEAN NewLockState