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

diff --git a/IntelFrameworkModulePkg/Bus/Isa/IsaBusDxe/IsaIo.c b/IntelFrameworkModulePkg/Bus/Isa/IsaBusDxe/IsaIo.c
index a86b0c37bacdabeb6ef0899b707329ebc686ae65..2caaed3dc80d11267e92b6104a6e9d7849f3c0aa 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Isa/IsaBusDxe/IsaIo.c
+++ b/IntelFrameworkModulePkg/Bus/Isa/IsaBusDxe/IsaIo.c
@@ -85,7 +85,7 @@ static EFI_ISA_DMA_REGISTERS  DmaRegisters[8] = {
 \r
   @param Code         - The error status code.\r
   \r
-  @Return EFI_SUCCESS  - Success to report status code.\r
+  @return EFI_SUCCESS  - Success to report status code.\r
 **/\r
 EFI_STATUS\r
 ReportErrorStatusCode (\r
@@ -204,10 +204,10 @@ IsaIoIoRead (
   @param Count                 - The number of I/O operations to perform. \r
   @param Buffer                - The source buffer to write data from\r
 \r
-  @Retval EFI_SUCCESS           - The data was writen to the device sucessfully.\r
-  @Retval EFI_UNSUPPORTED       - The Offset is not valid for this device.\r
-  @Retval EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.\r
-  @Retval EFI_OUT_OF_RESOURCES  - The request could not be completed due to a lack of resources.\r
+  @retval EFI_SUCCESS           - The data was writen to the device sucessfully.\r
+  @retval EFI_UNSUPPORTED       - The Offset is not valid for this device.\r
+  @retval EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.\r
+  @retval EFI_OUT_OF_RESOURCES  - The request could not be completed due to a lack of resources.\r
 \r
 **/\r
 EFI_STATUS\r

diff --git a/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppy.c b/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppy.c
index e1d65666665d2bd048ac361f34f211ed4fc8e351..e819a1d13219e0b3939c1450bf697cd8751274ab 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppy.c
+++ b/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppy.c
@@ -361,7 +361,7 @@ Done:
   created by this driver.\r
 \r
   @param  This              Protocol instance pointer.\r
-  @param  ControllerHandle  Handle of device to stop driver on\r
+  @param  Controller        Handle of device to stop driver on\r
   @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
                             children is zero stop the entire bus driver.\r
   @param  ChildHandleBuffer List of Child Handles to Stop.\r

diff --git a/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppy.h b/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppy.h
index f2f701f9010a9ebf6b0a3be270297dcdd5edf798..520a41aa45ec3d38a295581f36828be6afaebb66 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppy.h
+++ b/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppy.h
@@ -534,7 +534,7 @@ FdcControllerDriverStart (
   created by this driver.\r
 \r
   @param  This              Protocol instance pointer.\r
-  @param  ControllerHandle  Handle of device to stop driver on\r
+  @param  Controller        Handle of device to stop driver on\r
   @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
                             children is zero stop the entire bus driver.\r
   @param  ChildHandleBuffer List of Child Handles to Stop.\r
@@ -759,7 +759,7 @@ DisketChanged (
   and the initial values for each of the three internal\r
   times: HUT, SRT and HLT\r
   \r
-  @param This    Pointer to instance of FDC_BLK_IO_DEV\r
+  @param FdcDev    Pointer to instance of FDC_BLK_IO_DEV\r
   \r
   @retval  EFI_SUCCESS:    Execute the Specify command successfully\r
   @retval  EFI_DEVICE_ERROR: Fail to execute the command\r
@@ -806,7 +806,7 @@ Seek (
   Do the Sense Interrupt Status command, this command\r
   resets the interrupt signal\r
   \r
-  \r
+  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
   @param  StatusRegister0 UINT8 *: Be used to save Status Register 0 read from FDC\r
   @param  PresentCylinderNumber  UINT8 *: Be used to save present cylinder number\r
                                     read from FDC\r
@@ -947,7 +947,7 @@ DataOutByte (
   Detect the specified floppy logic drive is busy or\r
   not within a period of time\r
   \r
-  @param Disk             Indicate it is drive A or drive B\r
+  @param FdcDev          Indicate it is drive A or drive B\r
   @param TimeoutInSeconds the time period for waiting\r
   \r
   @retval EFI_SUCCESS:  The drive and command are not busy\r
@@ -989,10 +989,10 @@ FddDRQReady (
   @param Result  Point to result structure\r
   @param FdcDev  FDC control structure\r
 \r
-  @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
-  @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
-  @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
-  @param EFI_SUCCESS - GC_TODO: Add description for return value\r
+  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+  @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1072,7 +1072,8 @@ FdcReadPort (
  \r
   @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
   @param Offset The offset address of port\r
-\r
+  @param Data   Value written to port\r
+  \r
 **/\r
 VOID\r
 FdcWritePort (\r
@@ -1090,7 +1091,7 @@ FdcWritePort (
   @param LBA      The starting logic block address to read from on the device\r
   @param BufferSize The size of the Buffer in bytes\r
   @param Operation   - GC_TODO: add argument description\r
-  Buffer      - GC_TODO: add argument description\r
+  @param Buffer      - GC_TODO: add argument description\r
 \r
   @retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
   @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
@@ -1122,7 +1123,7 @@ FddReadWriteBlocks (
 /**\r
   Common interface for free cache \r
   \r
-  @param FdcDec  Pointer of FDC_BLK_IO_DEV instance\r
+  @param FdcDev  Pointer of FDC_BLK_IO_DEV instance\r
   \r
 **/\r
 VOID\r

diff --git a/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppyBlock.c b/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppyBlock.c
index 6b254cd6a51048b7d1edeba70a797628e1bb9c8d..36280becadaa63d17c34445d2e2b971c8d3f93f1 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppyBlock.c
+++ b/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppyBlock.c
@@ -191,7 +191,7 @@ FddWriteBlocks (
   @param LBA      The starting logic block address to read from on the device\r
   @param BufferSize The size of the Buffer in bytes\r
   @param Operation   - GC_TODO: add argument description\r
-  Buffer      - GC_TODO: add argument description\r
+  @param Buffer      - GC_TODO: add argument description\r
 \r
   @retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
   @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
@@ -384,7 +384,7 @@ FddReadWriteBlocks (
 /**\r
   Common interface for free cache \r
   \r
-  @param FdcDec  Pointer of FDC_BLK_IO_DEV instance\r
+  @param FdcDev  Pointer of FDC_BLK_IO_DEV instance\r
   \r
 **/\r
 VOID\r

diff --git a/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppyCtrl.c b/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppyCtrl.c
index da6af56a4347581ec219206c29946cbf71815f3b..fab96051fdeb7de1632786e6870bb1572e91e035 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppyCtrl.c
+++ b/IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppyCtrl.c
@@ -408,7 +408,7 @@ DisketChanged (
   and the initial values for each of the three internal\r
   times: HUT, SRT and HLT\r
   \r
-  @param This    Pointer to instance of FDC_BLK_IO_DEV\r
+  @param FdcDev    Pointer to instance of FDC_BLK_IO_DEV\r
   \r
   @retval  EFI_SUCCESS:    Execute the Specify command successfully\r
   @retval  EFI_DEVICE_ERROR: Fail to execute the command\r
@@ -627,7 +627,7 @@ Seek (
   Do the Sense Interrupt Status command, this command\r
   resets the interrupt signal\r
   \r
-  \r
+  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
   @param  StatusRegister0 UINT8 *: Be used to save Status Register 0 read from FDC\r
   @param  PresentCylinderNumber  UINT8 *: Be used to save present cylinder number\r
                                     read from FDC\r
@@ -1111,7 +1111,7 @@ DataOutByte (
   Detect the specified floppy logic drive is busy or\r
   not within a period of time\r
   \r
-  @param Disk             Indicate it is drive A or drive B\r
+  @param FdcDev           Indicate it is drive A or drive B\r
   @param TimeoutInSeconds the time period for waiting\r
   \r
   @retval EFI_SUCCESS:  The drive and command are not busy\r
@@ -1232,10 +1232,10 @@ FddDRQReady (
   @param Result  Point to result structure\r
   @param FdcDev  FDC control structure\r
 \r
-  @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
-  @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
-  @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
-  @param EFI_SUCCESS - GC_TODO: Add description for return value\r
+  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+  @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1407,7 +1407,8 @@ FdcReadPort (
  \r
   @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
   @param Offset The offset address of port\r
-\r
+  @param Data   Value written to port\r
+  \r
 **/\r
 VOID\r
 FdcWritePort (\r

diff --git a/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/Serial.c b/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/Serial.c
index ac208dbe09c81f41c6fb1d71988ada75ef311c0c..f4c00bb77015a123105fb9201e2babca1ae11a1a 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/Serial.c
+++ b/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/Serial.c
@@ -520,7 +520,7 @@ Error:
   @param  This                - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
   @param  Controller          - The handle of the controller to test.\r
   @param  NumberOfChildren    - Number of child device.\r
-  @param  RemainingDevicePath - A pointer to the remaining portion of a device path.\r
+  @param  ChildHandleBuffer   - A pointer to the remaining portion of a device path.\r
 \r
   @retval EFI_SUCCESS         - Operation successfully\r
   @retval EFI_DEVICE_ERROR    - Cannot stop the driver successfully\r

diff --git a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdCtrller.c b/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdCtrller.c
index 6ca9ece4c1c9dbb61ace76bcaa1db88c1f05c23d..211bcc254204b67c262e6dda3a7f20ba74902ef3 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdCtrller.c
+++ b/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdCtrller.c
@@ -2008,7 +2008,7 @@ DisableKeyboard (
   If Keyboard receives 0xF4, it will respond with 'ACK'. If it doesn't respond, the device\r
   should not be in system.\r
 \r
-  @param[in]  BiosKeyboardPrivate   Keyboard Private Data Structure\r
+  @param[in]  ConsoleIn             Keyboard Private Data Structure\r
 \r
   @retval     TRUE                  Keyboard in System.\r
   @retval     FALSE                 Keyboard not in System.\r

diff --git a/IntelFrameworkModulePkg/Universal/SectionExtractionDxe/SectionExtraction.c b/IntelFrameworkModulePkg/Universal/SectionExtractionDxe/SectionExtraction.c
index 2c7441b3e0a7d9065710e767b6cfe2a3ea61e3ff..a69ec6f4407c910473bfcf81f1c68241a263fbe9 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/SectionExtractionDxe/SectionExtraction.c
+++ b/IntelFrameworkModulePkg/Universal/SectionExtractionDxe/SectionExtraction.c
@@ -1299,7 +1299,7 @@ IsValidSectionStream (
 \r
   @param SignalFlag      -  Boolean value to decide whether kick the event after register or not.\r
 \r
-  @Return  The EFI_EVENT that has been registered to be signaled when a ProtocolGuid\r
+  @return  The EFI_EVENT that has been registered to be signaled when a ProtocolGuid\r
            is added to the system.\r
 \r
 **/\r

diff --git a/IntelFrameworkModulePkg/Universal/VariablePei/Variable.c b/IntelFrameworkModulePkg/Universal/VariablePei/Variable.c
index f57e2002e262af50ea6d43e8f4a107ff0205e67c..746e16979df6945223042ce8ba74a37ad64e088d 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/VariablePei/Variable.c
+++ b/IntelFrameworkModulePkg/Universal/VariablePei/Variable.c
@@ -73,7 +73,7 @@ PeimInitializeVariableServices (
 \r
   @param VarStoreHeader        Pointer to the Variable Store Header.\r
 \r
-  @Return VARIABLE_HEADER*      Pointer to last unavailable Variable Header\r
+  @return VARIABLE_HEADER*      Pointer to last unavailable Variable Header\r
 \r
 **/\r
 VARIABLE_HEADER *\r
@@ -92,7 +92,7 @@ GetStartPointer (
 \r
   @param VarStoreHeader        Pointer to the Variable Store Header.\r
 \r
-  @Return  VARIABLE_HEADER*      Pointer to last unavailable Variable Header\r
+  @return  VARIABLE_HEADER*      Pointer to last unavailable Variable Header\r
 \r
 **/\r
 VARIABLE_HEADER *\r
@@ -136,7 +136,7 @@ IsValidVariableHeader (
 \r
   @param Variable            Pointer to the Variable Header.\r
 \r
-  @Return UINTN               Size of variable in bytes\r
+  @return UINTN               Size of variable in bytes\r
 \r
 **/\r
 UINTN\r
@@ -158,7 +158,7 @@ NameSizeOfVariable (
 \r
   @param Variable            Pointer to the Variable Header.\r
 \r
-  @Return  UINTN               Size of variable in bytes\r
+  @return  UINTN               Size of variable in bytes\r
 \r
 **/\r
 UINTN\r
@@ -180,7 +180,7 @@ DataSizeOfVariable (
 \r
   @param Variable            Pointer to the Variable Header.\r
 \r
-  @Return CHAR16*              Pointer to Variable Name\r
+  @return CHAR16*              Pointer to Variable Name\r
 \r
 **/\r
 CHAR16 *\r
@@ -198,7 +198,7 @@ GetVariableNamePtr (
 \r
   @param Variable            Pointer to the Variable Header.\r
 \r
-  @Return  UINT8*              Pointer to Variable Data\r
+  @return  UINT8*              Pointer to Variable Data\r
 \r
 **/\r
 UINT8 *\r
@@ -223,7 +223,7 @@ GetVariableDataPtr (
 \r
   @param Variable              Pointer to the Variable Header.\r
 \r
-  @Return VARIABLE_HEADER*      Pointer to next variable header.\r
+  @return VARIABLE_HEADER*      Pointer to next variable header.\r
 \r
 **/\r
 VARIABLE_HEADER *\r
@@ -295,7 +295,7 @@ GetVariableStoreStatus (
   @param PtrTrack       - Variable Track Pointer structure that contains\r
                    Variable Information.\r
 \r
-  @Retval  EFI_SUCCESS    - Found match variable\r
+  @retval  EFI_SUCCESS    - Found match variable\r
   @retval EFI_NOT_FOUND  - Variable not found\r
 \r
 **/\r