Fix missing include header file and fix typo in comment.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5111 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
parent
01aef47bbe
commit
fdb05fa330
|
@ -85,7 +85,7 @@ static EFI_ISA_DMA_REGISTERS DmaRegisters[8] = {
|
||||||
|
|
||||||
@param Code - The error status code.
|
@param Code - The error status code.
|
||||||
|
|
||||||
@Return EFI_SUCCESS - Success to report status code.
|
@return EFI_SUCCESS - Success to report status code.
|
||||||
**/
|
**/
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
ReportErrorStatusCode (
|
ReportErrorStatusCode (
|
||||||
|
@ -204,10 +204,10 @@ IsaIoIoRead (
|
||||||
@param Count - The number of I/O operations to perform.
|
@param Count - The number of I/O operations to perform.
|
||||||
@param Buffer - The source buffer to write data from
|
@param Buffer - The source buffer to write data from
|
||||||
|
|
||||||
@Retval EFI_SUCCESS - The data was writen to the device sucessfully.
|
@retval EFI_SUCCESS - The data was writen to the device sucessfully.
|
||||||
@Retval EFI_UNSUPPORTED - The Offset is not valid for this device.
|
@retval EFI_UNSUPPORTED - The Offset is not valid for this device.
|
||||||
@Retval EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.
|
@retval EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.
|
||||||
@Retval EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.
|
@retval EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
|
|
|
@ -361,7 +361,7 @@ Done:
|
||||||
created by this driver.
|
created by this driver.
|
||||||
|
|
||||||
@param This Protocol instance pointer.
|
@param This Protocol instance pointer.
|
||||||
@param ControllerHandle Handle of device to stop driver on
|
@param Controller Handle of device to stop driver on
|
||||||
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
|
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
|
||||||
children is zero stop the entire bus driver.
|
children is zero stop the entire bus driver.
|
||||||
@param ChildHandleBuffer List of Child Handles to Stop.
|
@param ChildHandleBuffer List of Child Handles to Stop.
|
||||||
|
|
|
@ -534,7 +534,7 @@ FdcControllerDriverStart (
|
||||||
created by this driver.
|
created by this driver.
|
||||||
|
|
||||||
@param This Protocol instance pointer.
|
@param This Protocol instance pointer.
|
||||||
@param ControllerHandle Handle of device to stop driver on
|
@param Controller Handle of device to stop driver on
|
||||||
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
|
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
|
||||||
children is zero stop the entire bus driver.
|
children is zero stop the entire bus driver.
|
||||||
@param ChildHandleBuffer List of Child Handles to Stop.
|
@param ChildHandleBuffer List of Child Handles to Stop.
|
||||||
|
@ -759,7 +759,7 @@ DisketChanged (
|
||||||
and the initial values for each of the three internal
|
and the initial values for each of the three internal
|
||||||
times: HUT, SRT and HLT
|
times: HUT, SRT and HLT
|
||||||
|
|
||||||
@param This Pointer to instance of FDC_BLK_IO_DEV
|
@param FdcDev Pointer to instance of FDC_BLK_IO_DEV
|
||||||
|
|
||||||
@retval EFI_SUCCESS: Execute the Specify command successfully
|
@retval EFI_SUCCESS: Execute the Specify command successfully
|
||||||
@retval EFI_DEVICE_ERROR: Fail to execute the command
|
@retval EFI_DEVICE_ERROR: Fail to execute the command
|
||||||
|
@ -806,7 +806,7 @@ Seek (
|
||||||
Do the Sense Interrupt Status command, this command
|
Do the Sense Interrupt Status command, this command
|
||||||
resets the interrupt signal
|
resets the interrupt signal
|
||||||
|
|
||||||
|
@param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
|
||||||
@param StatusRegister0 UINT8 *: Be used to save Status Register 0 read from FDC
|
@param StatusRegister0 UINT8 *: Be used to save Status Register 0 read from FDC
|
||||||
@param PresentCylinderNumber UINT8 *: Be used to save present cylinder number
|
@param PresentCylinderNumber UINT8 *: Be used to save present cylinder number
|
||||||
read from FDC
|
read from FDC
|
||||||
|
@ -947,7 +947,7 @@ DataOutByte (
|
||||||
Detect the specified floppy logic drive is busy or
|
Detect the specified floppy logic drive is busy or
|
||||||
not within a period of time
|
not within a period of time
|
||||||
|
|
||||||
@param Disk Indicate it is drive A or drive B
|
@param FdcDev Indicate it is drive A or drive B
|
||||||
@param TimeoutInSeconds the time period for waiting
|
@param TimeoutInSeconds the time period for waiting
|
||||||
|
|
||||||
@retval EFI_SUCCESS: The drive and command are not busy
|
@retval EFI_SUCCESS: The drive and command are not busy
|
||||||
|
@ -989,10 +989,10 @@ FddDRQReady (
|
||||||
@param Result Point to result structure
|
@param Result Point to result structure
|
||||||
@param FdcDev FDC control structure
|
@param FdcDev FDC control structure
|
||||||
|
|
||||||
@param EFI_DEVICE_ERROR - GC_TODO: Add description for return value
|
@retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value
|
||||||
@param EFI_DEVICE_ERROR - GC_TODO: Add description for return value
|
@retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value
|
||||||
@param EFI_DEVICE_ERROR - GC_TODO: Add description for return value
|
@retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value
|
||||||
@param EFI_SUCCESS - GC_TODO: Add description for return value
|
@retval EFI_SUCCESS - GC_TODO: Add description for return value
|
||||||
|
|
||||||
**/
|
**/
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
|
@ -1072,6 +1072,7 @@ FdcReadPort (
|
||||||
|
|
||||||
@param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
|
@param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
|
||||||
@param Offset The offset address of port
|
@param Offset The offset address of port
|
||||||
|
@param Data Value written to port
|
||||||
|
|
||||||
**/
|
**/
|
||||||
VOID
|
VOID
|
||||||
|
@ -1090,7 +1091,7 @@ FdcWritePort (
|
||||||
@param LBA The starting logic block address to read from on the device
|
@param LBA The starting logic block address to read from on the device
|
||||||
@param BufferSize The size of the Buffer in bytes
|
@param BufferSize The size of the Buffer in bytes
|
||||||
@param Operation - GC_TODO: add argument description
|
@param Operation - GC_TODO: add argument description
|
||||||
Buffer - GC_TODO: add argument description
|
@param Buffer - GC_TODO: add argument description
|
||||||
|
|
||||||
@retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value
|
@retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value
|
||||||
@retval EFI_SUCCESS - GC_TODO: Add description for return value
|
@retval EFI_SUCCESS - GC_TODO: Add description for return value
|
||||||
|
@ -1122,7 +1123,7 @@ FddReadWriteBlocks (
|
||||||
/**
|
/**
|
||||||
Common interface for free cache
|
Common interface for free cache
|
||||||
|
|
||||||
@param FdcDec Pointer of FDC_BLK_IO_DEV instance
|
@param FdcDev Pointer of FDC_BLK_IO_DEV instance
|
||||||
|
|
||||||
**/
|
**/
|
||||||
VOID
|
VOID
|
||||||
|
|
|
@ -191,7 +191,7 @@ FddWriteBlocks (
|
||||||
@param LBA The starting logic block address to read from on the device
|
@param LBA The starting logic block address to read from on the device
|
||||||
@param BufferSize The size of the Buffer in bytes
|
@param BufferSize The size of the Buffer in bytes
|
||||||
@param Operation - GC_TODO: add argument description
|
@param Operation - GC_TODO: add argument description
|
||||||
Buffer - GC_TODO: add argument description
|
@param Buffer - GC_TODO: add argument description
|
||||||
|
|
||||||
@retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value
|
@retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value
|
||||||
@retval EFI_SUCCESS - GC_TODO: Add description for return value
|
@retval EFI_SUCCESS - GC_TODO: Add description for return value
|
||||||
|
@ -384,7 +384,7 @@ FddReadWriteBlocks (
|
||||||
/**
|
/**
|
||||||
Common interface for free cache
|
Common interface for free cache
|
||||||
|
|
||||||
@param FdcDec Pointer of FDC_BLK_IO_DEV instance
|
@param FdcDev Pointer of FDC_BLK_IO_DEV instance
|
||||||
|
|
||||||
**/
|
**/
|
||||||
VOID
|
VOID
|
||||||
|
|
|
@ -408,7 +408,7 @@ DisketChanged (
|
||||||
and the initial values for each of the three internal
|
and the initial values for each of the three internal
|
||||||
times: HUT, SRT and HLT
|
times: HUT, SRT and HLT
|
||||||
|
|
||||||
@param This Pointer to instance of FDC_BLK_IO_DEV
|
@param FdcDev Pointer to instance of FDC_BLK_IO_DEV
|
||||||
|
|
||||||
@retval EFI_SUCCESS: Execute the Specify command successfully
|
@retval EFI_SUCCESS: Execute the Specify command successfully
|
||||||
@retval EFI_DEVICE_ERROR: Fail to execute the command
|
@retval EFI_DEVICE_ERROR: Fail to execute the command
|
||||||
|
@ -627,7 +627,7 @@ Seek (
|
||||||
Do the Sense Interrupt Status command, this command
|
Do the Sense Interrupt Status command, this command
|
||||||
resets the interrupt signal
|
resets the interrupt signal
|
||||||
|
|
||||||
|
@param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
|
||||||
@param StatusRegister0 UINT8 *: Be used to save Status Register 0 read from FDC
|
@param StatusRegister0 UINT8 *: Be used to save Status Register 0 read from FDC
|
||||||
@param PresentCylinderNumber UINT8 *: Be used to save present cylinder number
|
@param PresentCylinderNumber UINT8 *: Be used to save present cylinder number
|
||||||
read from FDC
|
read from FDC
|
||||||
|
@ -1111,7 +1111,7 @@ DataOutByte (
|
||||||
Detect the specified floppy logic drive is busy or
|
Detect the specified floppy logic drive is busy or
|
||||||
not within a period of time
|
not within a period of time
|
||||||
|
|
||||||
@param Disk Indicate it is drive A or drive B
|
@param FdcDev Indicate it is drive A or drive B
|
||||||
@param TimeoutInSeconds the time period for waiting
|
@param TimeoutInSeconds the time period for waiting
|
||||||
|
|
||||||
@retval EFI_SUCCESS: The drive and command are not busy
|
@retval EFI_SUCCESS: The drive and command are not busy
|
||||||
|
@ -1232,10 +1232,10 @@ FddDRQReady (
|
||||||
@param Result Point to result structure
|
@param Result Point to result structure
|
||||||
@param FdcDev FDC control structure
|
@param FdcDev FDC control structure
|
||||||
|
|
||||||
@param EFI_DEVICE_ERROR - GC_TODO: Add description for return value
|
@retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value
|
||||||
@param EFI_DEVICE_ERROR - GC_TODO: Add description for return value
|
@retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value
|
||||||
@param EFI_DEVICE_ERROR - GC_TODO: Add description for return value
|
@retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value
|
||||||
@param EFI_SUCCESS - GC_TODO: Add description for return value
|
@retval EFI_SUCCESS - GC_TODO: Add description for return value
|
||||||
|
|
||||||
**/
|
**/
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
|
@ -1407,6 +1407,7 @@ FdcReadPort (
|
||||||
|
|
||||||
@param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
|
@param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
|
||||||
@param Offset The offset address of port
|
@param Offset The offset address of port
|
||||||
|
@param Data Value written to port
|
||||||
|
|
||||||
**/
|
**/
|
||||||
VOID
|
VOID
|
||||||
|
|
|
@ -520,7 +520,7 @@ Error:
|
||||||
@param This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
@param This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
||||||
@param Controller - The handle of the controller to test.
|
@param Controller - The handle of the controller to test.
|
||||||
@param NumberOfChildren - Number of child device.
|
@param NumberOfChildren - Number of child device.
|
||||||
@param RemainingDevicePath - A pointer to the remaining portion of a device path.
|
@param ChildHandleBuffer - A pointer to the remaining portion of a device path.
|
||||||
|
|
||||||
@retval EFI_SUCCESS - Operation successfully
|
@retval EFI_SUCCESS - Operation successfully
|
||||||
@retval EFI_DEVICE_ERROR - Cannot stop the driver successfully
|
@retval EFI_DEVICE_ERROR - Cannot stop the driver successfully
|
||||||
|
|
|
@ -2008,7 +2008,7 @@ DisableKeyboard (
|
||||||
If Keyboard receives 0xF4, it will respond with 'ACK'. If it doesn't respond, the device
|
If Keyboard receives 0xF4, it will respond with 'ACK'. If it doesn't respond, the device
|
||||||
should not be in system.
|
should not be in system.
|
||||||
|
|
||||||
@param[in] BiosKeyboardPrivate Keyboard Private Data Structure
|
@param[in] ConsoleIn Keyboard Private Data Structure
|
||||||
|
|
||||||
@retval TRUE Keyboard in System.
|
@retval TRUE Keyboard in System.
|
||||||
@retval FALSE Keyboard not in System.
|
@retval FALSE Keyboard not in System.
|
||||||
|
|
|
@ -1299,7 +1299,7 @@ IsValidSectionStream (
|
||||||
|
|
||||||
@param SignalFlag - Boolean value to decide whether kick the event after register or not.
|
@param SignalFlag - Boolean value to decide whether kick the event after register or not.
|
||||||
|
|
||||||
@Return The EFI_EVENT that has been registered to be signaled when a ProtocolGuid
|
@return The EFI_EVENT that has been registered to be signaled when a ProtocolGuid
|
||||||
is added to the system.
|
is added to the system.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
|
|
|
@ -73,7 +73,7 @@ PeimInitializeVariableServices (
|
||||||
|
|
||||||
@param VarStoreHeader Pointer to the Variable Store Header.
|
@param VarStoreHeader Pointer to the Variable Store Header.
|
||||||
|
|
||||||
@Return VARIABLE_HEADER* Pointer to last unavailable Variable Header
|
@return VARIABLE_HEADER* Pointer to last unavailable Variable Header
|
||||||
|
|
||||||
**/
|
**/
|
||||||
VARIABLE_HEADER *
|
VARIABLE_HEADER *
|
||||||
|
@ -92,7 +92,7 @@ GetStartPointer (
|
||||||
|
|
||||||
@param VarStoreHeader Pointer to the Variable Store Header.
|
@param VarStoreHeader Pointer to the Variable Store Header.
|
||||||
|
|
||||||
@Return VARIABLE_HEADER* Pointer to last unavailable Variable Header
|
@return VARIABLE_HEADER* Pointer to last unavailable Variable Header
|
||||||
|
|
||||||
**/
|
**/
|
||||||
VARIABLE_HEADER *
|
VARIABLE_HEADER *
|
||||||
|
@ -136,7 +136,7 @@ IsValidVariableHeader (
|
||||||
|
|
||||||
@param Variable Pointer to the Variable Header.
|
@param Variable Pointer to the Variable Header.
|
||||||
|
|
||||||
@Return UINTN Size of variable in bytes
|
@return UINTN Size of variable in bytes
|
||||||
|
|
||||||
**/
|
**/
|
||||||
UINTN
|
UINTN
|
||||||
|
@ -158,7 +158,7 @@ NameSizeOfVariable (
|
||||||
|
|
||||||
@param Variable Pointer to the Variable Header.
|
@param Variable Pointer to the Variable Header.
|
||||||
|
|
||||||
@Return UINTN Size of variable in bytes
|
@return UINTN Size of variable in bytes
|
||||||
|
|
||||||
**/
|
**/
|
||||||
UINTN
|
UINTN
|
||||||
|
@ -180,7 +180,7 @@ DataSizeOfVariable (
|
||||||
|
|
||||||
@param Variable Pointer to the Variable Header.
|
@param Variable Pointer to the Variable Header.
|
||||||
|
|
||||||
@Return CHAR16* Pointer to Variable Name
|
@return CHAR16* Pointer to Variable Name
|
||||||
|
|
||||||
**/
|
**/
|
||||||
CHAR16 *
|
CHAR16 *
|
||||||
|
@ -198,7 +198,7 @@ GetVariableNamePtr (
|
||||||
|
|
||||||
@param Variable Pointer to the Variable Header.
|
@param Variable Pointer to the Variable Header.
|
||||||
|
|
||||||
@Return UINT8* Pointer to Variable Data
|
@return UINT8* Pointer to Variable Data
|
||||||
|
|
||||||
**/
|
**/
|
||||||
UINT8 *
|
UINT8 *
|
||||||
|
@ -223,7 +223,7 @@ GetVariableDataPtr (
|
||||||
|
|
||||||
@param Variable Pointer to the Variable Header.
|
@param Variable Pointer to the Variable Header.
|
||||||
|
|
||||||
@Return VARIABLE_HEADER* Pointer to next variable header.
|
@return VARIABLE_HEADER* Pointer to next variable header.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
VARIABLE_HEADER *
|
VARIABLE_HEADER *
|
||||||
|
@ -295,7 +295,7 @@ GetVariableStoreStatus (
|
||||||
@param PtrTrack - Variable Track Pointer structure that contains
|
@param PtrTrack - Variable Track Pointer structure that contains
|
||||||
Variable Information.
|
Variable Information.
|
||||||
|
|
||||||
@Retval EFI_SUCCESS - Found match variable
|
@retval EFI_SUCCESS - Found match variable
|
||||||
@retval EFI_NOT_FOUND - Variable not found
|
@retval EFI_NOT_FOUND - Variable not found
|
||||||
|
|
||||||
**/
|
**/
|
||||||
|
|
Loading…
Reference in New Issue