Coding style modification.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5058 6f19259b-4bc3-4df7-8a09-765794883524

IntelFrameworkModulePkg/Bus/Isa/IsaBusDxe/InternalIsaBus.h

@@ -173,7 +173,7 @@ IsaBusControllerDriverSupported (
   IN EFI_HANDLE                   Controller,
   IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL
   )
-/*++
+/**
 
   Routine Description:
   
@@ -194,7 +194,7 @@ IsaBusControllerDriverSupported (
     EFI_SUCCESS          - The device is supported by this driver.
     EFI_UNSUPPORTED      - The device is not supported by this driver.
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -204,7 +204,7 @@ IsaBusControllerDriverStart (
   IN EFI_HANDLE                   Controller,
   IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL
   )
-/*++
+/**
 
   Routine Description:
   
@@ -227,7 +227,7 @@ IsaBusControllerDriverStart (
     EFI_OUT_OF_RESOURCES  - The request could not be completed due to a lack of 
                             resources.
   
---*/
+**/
 ;
 
 EFI_STATUS
@@ -238,7 +238,7 @@ IsaBusControllerDriverStop (
   IN  UINTN                        NumberOfChildren,
   IN  EFI_HANDLE                   * ChildHandleBuffer OPTIONAL
   )
-/*++
+/**
 
   Routine Description:
   
@@ -262,7 +262,7 @@ IsaBusControllerDriverStop (
     EFI_OUT_OF_RESOURCES   - The request could not be completed due to a lack of 
                              resources.
 
---*/
+**/
 ;
 
 //
@@ -278,7 +278,7 @@ IsaCreateDevice (
   IN EFI_ISA_ACPI_RESOURCE_LIST   *IsaDeviceResourceList,
   OUT EFI_DEVICE_PATH_PROTOCOL    **ChildDevicePath
   )
-/*++
+/**
 
   Routine Description:
   
@@ -300,7 +300,7 @@ IsaCreateDevice (
                              resources.
     EFI_DEVICE_ERROR       - Can not create child device.
     
---*/
+**/
 ;
 
 EFI_STATUS
@@ -308,7 +308,7 @@ InitializeIsaIoInstance (
   IN ISA_IO_DEVICE               *IsaIoDevice,
   IN EFI_ISA_ACPI_RESOURCE_LIST  *IsaDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -323,7 +323,7 @@ Returns:
 
   EFI_SUCCESS            - Initial success.
   
---*/
+**/
 ;
 
 #endif

IntelFrameworkModulePkg/Bus/Isa/IsaBusDxe/IsaBus.c

@@ -77,7 +77,7 @@ IsaBusControllerDriverSupported (
   IN EFI_HANDLE                   Controller,
   IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL
   )
-/*++
+/**
 
   Routine Description:
   
@@ -98,7 +98,7 @@ IsaBusControllerDriverSupported (
     EFI_SUCCESS          - The device is supported by this driver.
     EFI_UNSUPPORTED      - The device is not supported by this driver.
 
---*/
+**/
 {
   EFI_STATUS            Status;
   EFI_ISA_ACPI_PROTOCOL *IsaAcpi;
@@ -172,7 +172,7 @@ IsaBusControllerDriverStart (
   IN EFI_HANDLE                   Controller,
   IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL
   )
-/*++
+/**
 
   Routine Description:
   
@@ -195,7 +195,7 @@ IsaBusControllerDriverStart (
     EFI_OUT_OF_RESOURCES  - The request could not be completed due to a lack of 
                             resources.
   
---*/
+**/
 {
   EFI_STATUS                            Status;
   EFI_PCI_IO_PROTOCOL                   *PciIo;
@@ -414,7 +414,7 @@ IsaBusControllerDriverStop (
   IN  UINTN                        NumberOfChildren,
   IN  EFI_HANDLE                   * ChildHandleBuffer OPTIONAL
   )
-/*++
+/**
 
   Routine Description:
   
@@ -438,7 +438,7 @@ IsaBusControllerDriverStop (
     EFI_OUT_OF_RESOURCES   - The request could not be completed due to a lack of 
                              resources.
 
---*/
+**/
 {
   EFI_STATUS                          Status;
   UINTN                               Index;
@@ -555,7 +555,7 @@ IsaCreateDevice (
   IN EFI_ISA_ACPI_RESOURCE_LIST   *IsaDeviceResourceList,
   OUT EFI_DEVICE_PATH_PROTOCOL    **ChildDevicePath
   )
-/*++
+/**
 
   Routine Description:
   
@@ -577,7 +577,7 @@ IsaCreateDevice (
                              resources.
     EFI_DEVICE_ERROR       - Can not create child device.
     
---*/
+**/
 {
   EFI_STATUS    Status;
   ISA_IO_DEVICE *IsaIoDevice;

IntelFrameworkModulePkg/Bus/Isa/IsaBusDxe/IsaIo.c

@@ -80,26 +80,18 @@ static EFI_ISA_DMA_REGISTERS  DmaRegisters[8] = {
   },
 };
 
+/**
+  report a error Status code of PCI bus driver controller
+
+  @param Code         - The error status code.
+  
+  @Return EFI_SUCCESS  - Success to report status code.
+**/
 EFI_STATUS
 ReportErrorStatusCode (
   EFI_STATUS_CODE_VALUE Code
   )
-/*++
 
-Routine Description:
-
-  report a error Status code of PCI bus driver controller
-
-Arguments:
-
-  Code         - The error status code.
-  
-Returns:
-
-  EFI_SUCCESS  - Success to report status code.
-  
-
---*/
 {
   return REPORT_STATUS_CODE (
                 EFI_ERROR_CODE | EFI_ERROR_MINOR,
@@ -110,28 +102,21 @@ Returns:
 //
 // Driver Support Functions
 //
+/**
 
+  Initializes an ISA I/O Instance
+
+  @param IsaIoDevice            - The iso device to be initialized.
+  @param IsaDeviceResourceList  - The resource list.
+  
+  @retval EFI_SUCCESS            - Initial success.
+  
+**/
 EFI_STATUS
 InitializeIsaIoInstance (
   IN ISA_IO_DEVICE               *IsaIoDevice,
   IN EFI_ISA_ACPI_RESOURCE_LIST  *IsaDeviceResourceList
   )
-/*++
-
-Routine Description:
-
-  Initializes an ISA I/O Instance
-
-Arguments:
-
-  IsaIoDevice            - The iso device to be initialized.
-  IsaDeviceResourceList  - The resource list.
-  
-Returns:
-
-  EFI_SUCCESS            - Initial success.
-  
---*/
 {
   //
   // Initializes an ISA I/O Instance
@@ -147,6 +132,21 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Performs an ISA I/O Read Cycle
+
+  @param This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
+  @param Width                 - Signifies the width of the I/O operation.
+  @param Offset                - The offset in ISA I/O space to start the I/O operation.  
+  @param Count                 - The number of I/O operations to perform. 
+  @param Buffer                - The destination buffer to store the results
+
+  @retval EFI_SUCCESS           - The data was read from the device sucessfully.
+  @retval EFI_UNSUPPORTED       - The Offset is not valid for this device.
+  @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.
+
+**/
 EFI_STATUS
 EFIAPI
 IsaIoIoRead (
@@ -156,28 +156,7 @@ IsaIoIoRead (
   IN     UINTN                                      Count,
   IN OUT VOID                                       *Buffer
   )
-/*++
 
-Routine Description:
-
-  Performs an ISA I/O Read Cycle
-
-Arguments:
-
-  This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
-  Width                 - Signifies the width of the I/O operation.
-  Offset                - The offset in ISA I/O space to start the I/O operation.  
-  Count                 - The number of I/O operations to perform. 
-  Buffer                - The destination buffer to store the results
-
-Returns:
-
-  EFI_SUCCESS           - The data was read from the device sucessfully.
-  EFI_UNSUPPORTED       - The Offset is not valid for this device.
-  EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.
-  EFI_OUT_OF_RESOURCES  - The request could not be completed due to a lack of resources.
-
---*/
 {
   EFI_STATUS    Status;
   ISA_IO_DEVICE *IsaIoDevice;
@@ -216,6 +195,21 @@ Returns:
   return Status;
 }
 
+/**
+  Performs an ISA I/O Write Cycle
+
+  @param This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
+  @param Width                 - Signifies the width of the I/O operation.
+  @param Offset                - The offset in ISA I/O space to start the I/O operation.  
+  @param Count                 - The number of I/O operations to perform. 
+  @param Buffer                - The source buffer to write data from
+
+  @Retval EFI_SUCCESS           - The data was writen to the device sucessfully.
+  @Retval EFI_UNSUPPORTED       - The Offset is not valid for this device.
+  @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.
+
+**/
 EFI_STATUS
 EFIAPI
 IsaIoIoWrite (
@@ -225,28 +219,6 @@ IsaIoIoWrite (
   IN     UINTN                                      Count,
   IN OUT VOID                                       *Buffer
   )
-/*++
-
-Routine Description:
-
-  Performs an ISA I/O Write Cycle
-
-Arguments:
-
-  This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
-  Width                 - Signifies the width of the I/O operation.
-  Offset                - The offset in ISA I/O space to start the I/O operation.  
-  Count                 - The number of I/O operations to perform. 
-  Buffer                - The source buffer to write data from
-
-Returns:
-
-  EFI_SUCCESS           - The data was writen to the device sucessfully.
-  EFI_UNSUPPORTED       - The Offset is not valid for this device.
-  EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.
-  EFI_OUT_OF_RESOURCES  - The request could not be completed due to a lack of resources.
-
---*/
 {
   EFI_STATUS    Status;
   ISA_IO_DEVICE *IsaIoDevice;
@@ -285,32 +257,26 @@ Returns:
   return Status;
 }
 
+/**
+  Writes an 8 bit I/O Port
+
+  @param This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
+  @param Offset                - The offset in ISA IO space to start the IO operation.  
+  @param Value                 - The data to write port.
+
+  @retval EFI_SUCCESS           - Success.
+  @retval EFI_INVALID_PARAMETER - Parameter is invalid.
+  @retval EFI_UNSUPPORTED       - The address range specified by Offset is not valid.
+  @retval EFI_OUT_OF_RESOURCES  - The request could not be completed due to a lack of resources.
+  
+**/
 EFI_STATUS
 WritePort (
   IN EFI_ISA_IO_PROTOCOL                  *This,
   IN UINT32                               Offset,
   IN UINT8                                Value
   )
-/*++
 
-Routine Description:
-
-  Writes an 8 bit I/O Port
-
-Arguments:
-
-  This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
-  Offset                - The offset in ISA IO space to start the IO operation.  
-  Value                 - The data to write port.
-  
-Returns:
-
-  EFI_SUCCESS           - Success.
-  EFI_INVALID_PARAMETER - Parameter is invalid.
-  EFI_UNSUPPORTED       - The address range specified by Offset is not valid.
-  EFI_OUT_OF_RESOURCES  - The request could not be completed due to a lack of resources.
-  
---*/
 {
   EFI_STATUS    Status;
   ISA_IO_DEVICE *IsaIoDevice;
@@ -338,6 +304,22 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Writes I/O operation base address and count number to a 8 bit I/O Port.
+
+  @param This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
+  @param AddrOffset            - The address' offset.
+  @param PageOffset            - The page's offest.
+  @param CountOffset           - The count's offset.
+  @param BaseAddress           - The base address.
+  @param Count                 - The number of I/O operations to perform. 
+  
+  @retval EFI_SUCCESS           - Success.
+  @retval EFI_INVALID_PARAMETER - Parameter is invalid.
+  @retval EFI_UNSUPPORTED       - The address range specified by these Offsets and Count is not valid.
+  @retval EFI_OUT_OF_RESOURCES  - The request could not be completed due to a lack of resources.
+
+**/
 EFI_STATUS
 WriteDmaPort (
   IN EFI_ISA_IO_PROTOCOL                  *This,
@@ -347,29 +329,7 @@ WriteDmaPort (
   IN UINT32                               BaseAddress,
   IN UINT16                               Count
   )
-/*++
 
-Routine Description:
-
-  Writes I/O operation base address and count number to a 8 bit I/O Port.
-
-Arguments:
-
-  This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
-  AddrOffset            - The address' offset.
-  PageOffset            - The page's offest.
-  CountOffset           - The count's offset.
-  BaseAddress           - The base address.
-  Count                 - The number of I/O operations to perform. 
-  
-Returns:
-
-  EFI_SUCCESS           - Success.
-  EFI_INVALID_PARAMETER - Parameter is invalid.
-  EFI_UNSUPPORTED       - The address range specified by these Offsets and Count is not valid.
-  EFI_OUT_OF_RESOURCES  - The request could not be completed due to a lack of resources.
-
---*/
 {
   EFI_STATUS  Status;
 
@@ -401,29 +361,22 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Unmaps a memory region for DMA
+
+  @param This             - A pointer to the EFI_ISA_IO_PROTOCOL instance.
+  @param Mapping          - The mapping value returned from EFI_ISA_IO.Map().
+
+  @retval EFI_SUCCESS      - The range was unmapped.
+  @retval EFI_DEVICE_ERROR - The data was not committed to the target system memory.
+
+**/
 EFI_STATUS
 EFIAPI
 IsaIoUnmap (
   IN EFI_ISA_IO_PROTOCOL                  *This,
   IN VOID                                 *Mapping
   )
-/*++
-
-Routine Description:
-
-  Unmaps a memory region for DMA
-
-Arguments:
-
-  This             - A pointer to the EFI_ISA_IO_PROTOCOL instance.
-  Mapping          - The mapping value returned from EFI_ISA_IO.Map().
-
-Returns:
-
-  EFI_SUCCESS      - The range was unmapped.
-  EFI_DEVICE_ERROR - The data was not committed to the target system memory.
-
---*/
 {
   ISA_MAP_INFO  *IsaMapInfo;
 
@@ -467,27 +420,21 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Flushes a DMA buffer
+
+  @param This             - A pointer to the EFI_ISA_IO_PROTOCOL instance.
+
+  @retval  EFI_SUCCESS      - The buffers were flushed.
+  @retval  EFI_DEVICE_ERROR - The buffers were not flushed due to a hardware error.
+
+**/
 EFI_STATUS
 EFIAPI
 IsaIoFlush (
   IN EFI_ISA_IO_PROTOCOL                  *This
   )
-/*++
 
-Routine Description:
-
-  Flushes a DMA buffer
-
-Arguments:
-
-  This             - A pointer to the EFI_ISA_IO_PROTOCOL instance.
-
-Returns:
-
-  EFI_SUCCESS      - The buffers were flushed.
-  EFI_DEVICE_ERROR - The buffers were not flushed due to a hardware error.
-
---*/
 {
   EFI_STATUS    Status;
   ISA_IO_DEVICE *IsaIoDevice;
@@ -506,6 +453,20 @@ Returns:
   return Status;
 }
 
+/**
+  Verifies access to an ISA device
+
+  @param IsaIoDevice           - The ISA device to be verified.
+  @param Type                  - The Access type. The input must be either IsaAccessTypeMem or IsaAccessTypeIo.
+  @param Width                 - Signifies the width of the memory operation.
+  @param Count                 - The number of memory operations to perform. 
+  @param Offset                - The offset in ISA memory space to start the memory operation.  
+  
+  @retval EFI_SUCCESS           - Verify success.
+  @retval EFI_INVALID_PARAMETER - One of the parameters has an invalid value.
+  @retval EFI_UNSUPPORTED       - The device ont support the access type.
+
+**/
 EFI_STATUS
 IsaIoVerifyAccess (
   IN     ISA_IO_DEVICE              *IsaIoDevice,
@@ -514,27 +475,7 @@ IsaIoVerifyAccess (
   IN     UINTN                      Count,
   IN OUT UINT32                     *Offset
   )
-/*++
 
-Routine Description:
-
-  Verifies access to an ISA device
-
-Arguments:
-
-  IsaIoDevice           - The ISA device to be verified.
-  Type                  - The Access type. The input must be either IsaAccessTypeMem or IsaAccessTypeIo.
-  Width                 - Signifies the width of the memory operation.
-  Count                 - The number of memory operations to perform. 
-  Offset                - The offset in ISA memory space to start the memory operation.  
-  
-Returns:
-
-  EFI_SUCCESS           - Verify success.
-  EFI_INVALID_PARAMETER - One of the parameters has an invalid value.
-  EFI_UNSUPPORTED       - The device ont support the access type.
-
---*/
 {
   EFI_ISA_ACPI_RESOURCE *Item;
   EFI_STATUS            Status;
@@ -579,6 +520,22 @@ Returns:
   return Status;
 }
 
+/**
+
+  Performs an ISA Memory Read Cycle
+
+  @param This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
+  @param Width                 - Signifies the width of the memory operation.
+  @param Offset                - The offset in ISA memory space to start the memory operation.  
+  @param Count                 - The number of memory operations to perform. 
+  @param Buffer                - The destination buffer to store the results
+ 
+  @retval EFI_SUCCESS           - The data was read from the device successfully.
+  @retval EFI_UNSUPPORTED       - The Offset is not valid for this device.
+  @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.
+
+**/
 EFI_STATUS
 EFIAPI
 IsaIoMemRead (
@@ -588,28 +545,7 @@ IsaIoMemRead (
   IN     UINTN                                     Count,
   IN OUT VOID                                      *Buffer
   )
-/*++
 
-Routine Description:
-
-  Performs an ISA Memory Read Cycle
-
-Arguments:
-
-  This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
-  Width                 - Signifies the width of the memory operation.
-  Offset                - The offset in ISA memory space to start the memory operation.  
-  Count                 - The number of memory operations to perform. 
-  Buffer                - The destination buffer to store the results
-  
-Returns:
-
-  EFI_SUCCESS           - The data was read from the device successfully.
-  EFI_UNSUPPORTED       - The Offset is not valid for this device.
-  EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.
-  EFI_OUT_OF_RESOURCES  - The request could not be completed due to a lack of resources.
-
---*/
 {
   EFI_STATUS    Status;
   ISA_IO_DEVICE *IsaIoDevice;
@@ -658,6 +594,21 @@ Returns:
   return Status;
 }
 
+/**
+  Performs an ISA Memory Write Cycle
+
+  @param This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.  
+  @param Width                 - Signifies the width of the memory operation.
+  @param Offset                - The offset in ISA memory space to start the memory operation.  
+  @param Count                 - The number of memory operations to perform. 
+  @param Buffer                - The source buffer to write data from
+
+  @retval EFI_SUCCESS           - The data was written to the device sucessfully.
+  @retval EFI_UNSUPPORTED       - The Offset is not valid for this device.
+  @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.
+
+**/
 EFI_STATUS
 EFIAPI
 IsaIoMemWrite (
@@ -667,28 +618,6 @@ IsaIoMemWrite (
   IN     UINTN                                      Count,
   IN OUT VOID                                       *Buffer
   )
-/*++
-
-Routine Description:
-
-  Performs an ISA Memory Write Cycle
-
-Arguments:
-
-  This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.  
-  Width                 - Signifies the width of the memory operation.
-  Offset                - The offset in ISA memory space to start the memory operation.  
-  Count                 - The number of memory operations to perform. 
-  Buffer                - The source buffer to write data from
-
-Returns:
-
-  EFI_SUCCESS           - The data was written to the device sucessfully.
-  EFI_UNSUPPORTED       - The Offset is not valid for this device.
-  EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.
-  EFI_OUT_OF_RESOURCES  - The request could not be completed due to a lack of resources.
-
---*/
 {
   EFI_STATUS    Status;
   ISA_IO_DEVICE *IsaIoDevice;
@@ -737,6 +666,21 @@ Returns:
   return Status;
 }
 
+/**
+  Performs an ISA I/O Copy Memory 
+
+  @param This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
+  @param Width                 - Signifies the width of the memory copy operation.
+  @param DestOffset            - The offset of the destination 
+  @param SrcOffset             - The offset of the source
+  @param Count                 - The number of memory copy  operations to perform
+
+  @retval EFI_SUCCESS           - The data was copied sucessfully.
+  @retval EFI_UNSUPPORTED       - The DestOffset or SrcOffset is not valid for this device.
+  @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.
+
+**/
 EFI_STATUS
 EFIAPI
 IsaIoCopyMem (
@@ -746,28 +690,7 @@ IsaIoCopyMem (
   IN UINT32                                     SrcOffset,
   IN UINTN                                      Count
   )
-/*++
 
-Routine Description:
-
-  Performs an ISA I/O Copy Memory 
-
-Arguments:
-
-  This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
-  Width                 - Signifies the width of the memory copy operation.
-  DestOffset            - The offset of the destination 
-  SrcOffset             - The offset of the source
-  Count                 - The number of memory copy  operations to perform
-
-Returns:
-
-  EFI_SUCCESS           - The data was copied sucessfully.
-  EFI_UNSUPPORTED       - The DestOffset or SrcOffset is not valid for this device.
-  EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.
-  EFI_OUT_OF_RESOURCES  - The request could not be completed due to a lack of resources.
-
---*/
 {
   EFI_STATUS    Status;
   ISA_IO_DEVICE *IsaIoDevice;
@@ -828,6 +751,32 @@ Returns:
   return Status;
 }
 
+/**
+  Maps a memory region for DMA, note this implementation
+  only supports slave read/write operation to save code size.
+
+  @param This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
+  @param Operation             - Indicates the type of DMA (slave or bus master), and if 
+                          the DMA operation is going to read or write to system memory. 
+  @param ChannelNumber         - The slave channel number to use for this DMA operation. 
+                          If Operation and ChannelAttributes shows that this device 
+                          performs bus mastering DMA, then this field is ignored.  
+                          The legal range for this field is 0..7.  
+  @param ChannelAttributes     - The attributes of the DMA channel to use for this DMA operation
+  @param HostAddress           - The system memory address to map to the device.  
+  @param NumberOfBytes         - On input the number of bytes to map.  On output the number 
+                          of bytes that were mapped.
+  @param DeviceAddress         - The resulting map address for the bus master device to use 
+                          to access the hosts HostAddress.  
+  @param Mapping               - A resulting value to pass to EFI_ISA_IO.Unmap().
+
+  @retval EFI_SUCCESS           - The range was mapped for the returned NumberOfBytes.
+  @retval EFI_INVALID_PARAMETER - The Operation or HostAddress is undefined.
+  @retval EFI_UNSUPPORTED       - The HostAddress can not be mapped as a common buffer.
+  @retval EFI_DEVICE_ERROR      - The system hardware could not map the requested address.
+  @retval EFI_OUT_OF_RESOURCES  - The memory pages could not be allocated.
+
+**/
 STATIC
 EFI_STATUS
 IsaIoMap_OnlySupportSlaveReadWrite (
@@ -840,39 +789,7 @@ IsaIoMap_OnlySupportSlaveReadWrite (
   OUT    EFI_PHYSICAL_ADDRESS                                 *DeviceAddress,
   OUT    VOID                                                 **Mapping
   )
-/*++
 
-Routine Description:
-
-  Maps a memory region for DMA, note this implementation
-  only supports slave read/write operation to save code size.
-
-Arguments:
-
-  This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
-  Operation             - Indicates the type of DMA (slave or bus master), and if 
-                          the DMA operation is going to read or write to system memory. 
-  ChannelNumber         - The slave channel number to use for this DMA operation. 
-                          If Operation and ChannelAttributes shows that this device 
-                          performs bus mastering DMA, then this field is ignored.  
-                          The legal range for this field is 0..7.  
-  ChannelAttributes     - The attributes of the DMA channel to use for this DMA operation
-  HostAddress           - The system memory address to map to the device.  
-  NumberOfBytes         - On input the number of bytes to map.  On output the number 
-                          of bytes that were mapped.
-  DeviceAddress         - The resulting map address for the bus master device to use 
-                          to access the hosts HostAddress.  
-  Mapping               - A resulting value to pass to EFI_ISA_IO.Unmap().
-
-Returns:
-
-  EFI_SUCCESS           - The range was mapped for the returned NumberOfBytes.
-  EFI_INVALID_PARAMETER - The Operation or HostAddress is undefined.
-  EFI_UNSUPPORTED       - The HostAddress can not be mapped as a common buffer.
-  EFI_DEVICE_ERROR      - The system hardware could not map the requested address.
-  EFI_OUT_OF_RESOURCES  - The memory pages could not be allocated.
-
---*/
 {
   EFI_STATUS            Status;
   EFI_PHYSICAL_ADDRESS  PhysicalAddress;
@@ -1075,6 +992,32 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Maps a memory region for DMA. This implementation implement the 
+  the full mapping support.
+
+  @param This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
+  @param Operation             - Indicates the type of DMA (slave or bus master), and if 
+                          the DMA operation is going to read or write to system memory. 
+  @param ChannelNumber         - The slave channel number to use for this DMA operation. 
+                          If Operation and ChannelAttributes shows that this device 
+                          performs bus mastering DMA, then this field is ignored.  
+                          The legal range for this field is 0..7.  
+  @param ChannelAttributes     - The attributes of the DMA channel to use for this DMA operation
+  @param HostAddress           - The system memory address to map to the device.  
+  @param NumberOfBytes         - On input the number of bytes to map.  On output the number 
+                          of bytes that were mapped.
+  @param DeviceAddress         - The resulting map address for the bus master device to use 
+                        - to access the hosts HostAddress.  
+  @param Mapping               - A resulting value to pass to EFI_ISA_IO.Unmap().
+
+  @retval EFI_SUCCESS           - The range was mapped for the returned NumberOfBytes.
+  @retval EFI_INVALID_PARAMETER - The Operation or HostAddress is undefined.
+  @retval EFI_UNSUPPORTED       - The HostAddress can not be mapped as a common buffer.
+  @retval EFI_DEVICE_ERROR      - The system hardware could not map the requested address.
+  @retval EFI_OUT_OF_RESOURCES  - The memory pages could not be allocated.
+
+**/
 STATIC
 EFI_STATUS
 IsaIoMap_FullSupport (
@@ -1087,39 +1030,7 @@ IsaIoMap_FullSupport (
   OUT    EFI_PHYSICAL_ADDRESS                                 *DeviceAddress,
   OUT    VOID                                                 **Mapping
   )
-/*++
 
-Routine Description:
-
-  Maps a memory region for DMA. This implementation implement the 
-  the full mapping support.
-
-Arguments:
-
-  This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
-  Operation             - Indicates the type of DMA (slave or bus master), and if 
-                          the DMA operation is going to read or write to system memory. 
-  ChannelNumber         - The slave channel number to use for this DMA operation. 
-                          If Operation and ChannelAttributes shows that this device 
-                          performs bus mastering DMA, then this field is ignored.  
-                          The legal range for this field is 0..7.  
-  ChannelAttributes     - The attributes of the DMA channel to use for this DMA operation
-  HostAddress           - The system memory address to map to the device.  
-  NumberOfBytes         - On input the number of bytes to map.  On output the number 
-                          of bytes that were mapped.
-  DeviceAddress         - The resulting map address for the bus master device to use 
-                        - to access the hosts HostAddress.  
-  Mapping               - A resulting value to pass to EFI_ISA_IO.Unmap().
-
-Returns:
-
-  EFI_SUCCESS           - The range was mapped for the returned NumberOfBytes.
-  EFI_INVALID_PARAMETER - The Operation or HostAddress is undefined.
-  EFI_UNSUPPORTED       - The HostAddress can not be mapped as a common buffer.
-  EFI_DEVICE_ERROR      - The system hardware could not map the requested address.
-  EFI_OUT_OF_RESOURCES  - The memory pages could not be allocated.
-
---*/
 {
   EFI_STATUS            Status;
   BOOLEAN               Master;
@@ -1411,6 +1322,32 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Maps a memory region for DMA
+
+  @param This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
+  @param Operation             - Indicates the type of DMA (slave or bus master), and if 
+                          the DMA operation is going to read or write to system memory. 
+  @param ChannelNumber         - The slave channel number to use for this DMA operation. 
+                          If Operation and ChannelAttributes shows that this device 
+                          performs bus mastering DMA, then this field is ignored.  
+                          The legal range for this field is 0..7.  
+  @param ChannelAttributes     - The attributes of the DMA channel to use for this DMA operation
+  @param HostAddress           - The system memory address to map to the device.  
+  @param NumberOfBytes         - On input the number of bytes to map.  On output the number 
+                          of bytes that were mapped.
+  @param DeviceAddress         - The resulting map address for the bus master device to use 
+                        - to access the hosts HostAddress.  
+  @param Mapping               - A resulting value to pass to EFI_ISA_IO.Unmap().
+
+
+  @retval EFI_SUCCESS           - The range was mapped for the returned NumberOfBytes.
+  @retval EFI_INVALID_PARAMETER - The Operation or HostAddress is undefined.
+  @retval EFI_UNSUPPORTED       - The HostAddress can not be mapped as a common buffer.
+  @retval EFI_DEVICE_ERROR      - The system hardware could not map the requested address.
+  @retval EFI_OUT_OF_RESOURCES  - The memory pages could not be allocated.
+
+**/
 EFI_STATUS
 EFIAPI
 IsaIoMap (
@@ -1423,38 +1360,7 @@ IsaIoMap (
   OUT    EFI_PHYSICAL_ADDRESS                                 *DeviceAddress,
   OUT    VOID                                                 **Mapping
   )
-/*++
 
-Routine Description:
-
-  Maps a memory region for DMA
-
-Arguments:
-
-  This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
-  Operation             - Indicates the type of DMA (slave or bus master), and if 
-                          the DMA operation is going to read or write to system memory. 
-  ChannelNumber         - The slave channel number to use for this DMA operation. 
-                          If Operation and ChannelAttributes shows that this device 
-                          performs bus mastering DMA, then this field is ignored.  
-                          The legal range for this field is 0..7.  
-  ChannelAttributes     - The attributes of the DMA channel to use for this DMA operation
-  HostAddress           - The system memory address to map to the device.  
-  NumberOfBytes         - On input the number of bytes to map.  On output the number 
-                          of bytes that were mapped.
-  DeviceAddress         - The resulting map address for the bus master device to use 
-                        - to access the hosts HostAddress.  
-  Mapping               - A resulting value to pass to EFI_ISA_IO.Unmap().
-
-Returns:
-
-  EFI_SUCCESS           - The range was mapped for the returned NumberOfBytes.
-  EFI_INVALID_PARAMETER - The Operation or HostAddress is undefined.
-  EFI_UNSUPPORTED       - The HostAddress can not be mapped as a common buffer.
-  EFI_DEVICE_ERROR      - The system hardware could not map the requested address.
-  EFI_OUT_OF_RESOURCES  - The memory pages could not be allocated.
-
---*/
 {
   //
   // Or unset Feature Flag PcdIsaBusSupportDma to disable support for ISA DMA.
@@ -1493,6 +1399,24 @@ Returns:
              );
   }
 }
+
+/**
+  Allocates a common buffer for DMA
+
+  @param This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
+  @param Type                  - The type allocation to perform.
+  @param MemoryType            - The type of memory to allocate.
+  @param Pages                 - The number of pages to allocate.
+  @param HostAddress           - A pointer to store the base address of the allocated range.
+  @param Attributes            - The requested bit mask of attributes for the allocated range.
+
+  @retval EFI_SUCCESS           - The requested memory pages were allocated.
+  @retval EFI_INVALID_PARAMETER - Type is invalid or MemoryType is invalid or HostAddress is NULL
+  @retval EFI_UNSUPPORTED       - Attributes is unsupported or the memory range specified 
+                          by HostAddress, Pages, and Type is not available for common buffer use.
+  @retval EFI_OUT_OF_RESOURCES  - The memory pages could not be allocated.
+
+**/
 EFI_STATUS
 EFIAPI
 IsaIoAllocateBuffer (
@@ -1503,30 +1427,6 @@ IsaIoAllocateBuffer (
   OUT VOID                                 **HostAddress,
   IN  UINT64                               Attributes
   )
-/*++
-
-Routine Description:
-
-  Allocates a common buffer for DMA
-
-Arguments:
-
-  This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
-  Type                  - The type allocation to perform.
-  MemoryType            - The type of memory to allocate.
-  Pages                 - The number of pages to allocate.
-  HostAddress           - A pointer to store the base address of the allocated range.
-  Attributes            - The requested bit mask of attributes for the allocated range.
-
-Returns:
-
-  EFI_SUCCESS           - The requested memory pages were allocated.
-  EFI_INVALID_PARAMETER - Type is invalid or MemoryType is invalid or HostAddress is NULL
-  EFI_UNSUPPORTED       - Attributes is unsupported or the memory range specified 
-                          by HostAddress, Pages, and Type is not available for common buffer use.
-  EFI_OUT_OF_RESOURCES  - The memory pages could not be allocated.
-
---*/
 {
   EFI_STATUS            Status;
   EFI_PHYSICAL_ADDRESS  PhysicalAddress;
@@ -1581,6 +1481,20 @@ Returns:
   return Status;
 }
 
+/**
+
+  Frees a common buffer 
+
+  @param This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
+  @param Pages                 - The number of pages to free.
+  @param HostAddress           - The base address of the allocated range.
+
+
+  @retval EFI_SUCCESS           - The requested memory pages were freed.
+  @retval EFI_INVALID_PARAMETER - The memory was not allocated with EFI_ISA_IO.AllocateBufer().
+
+**/
+
 EFI_STATUS
 EFIAPI
 IsaIoFreeBuffer (
@@ -1588,24 +1502,6 @@ IsaIoFreeBuffer (
   IN UINTN                                Pages,
   IN VOID                                 *HostAddress
   )
-/*++
-
-Routine Description:
-
-  Frees a common buffer 
-
-Arguments:
-
-  This                  - A pointer to the EFI_ISA_IO_PROTOCOL instance.
-  Pages                 - The number of pages to free.
-  HostAddress           - The base address of the allocated range.
-
-Returns:
-
-  EFI_SUCCESS           - The requested memory pages were freed.
-  EFI_INVALID_PARAMETER - The memory was not allocated with EFI_ISA_IO.AllocateBufer().
-
---*/
 {
   EFI_STATUS            Status;
   EFI_PHYSICAL_ADDRESS  PhysicalAddress;

IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/ComponentName.c

@@ -1,6 +1,5 @@
 /**@file
 
-  
 Copyright (c) 2006 - 2007, Intel Corporation.<BR>
 All rights reserved. This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
@@ -242,25 +241,17 @@ IsaFloppyComponentNameGetControllerName (
            );
 }
 
+/**
+  Add the component name for the floppy device
+
+  @param  FdcDev                 - A pointer to the FDC_BLK_IO_DEV instance.
+
+**/
 VOID
 AddName (
   IN  FDC_BLK_IO_DEV         *FdcDev
   )
-/*++
 
-  Routine Description:
-  
-    Add the component name for the floppy device
-
-  Arguments:
-  
-    FdcDev                 - A pointer to the FDC_BLK_IO_DEV instance.
-
-  Returns:
-
-    None
-    
---*/
 {
   CHAR16  FloppyDriveName[FLOPPY_DRIVE_NAME_ASCII_LEN + 1];
 
@@ -282,3 +273,4 @@ AddName (
     );
 
 }
+

IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/ComponentName.h

@@ -1,6 +1,5 @@
 /**@file
 
-  
 Copyright (c) 2006 - 2007, Intel Corporation.<BR>
 All rights reserved. This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
@@ -156,7 +155,7 @@ VOID
 AddName (
   IN  FDC_BLK_IO_DEV               *FdcDev
   )
-/*++
+/**
 
 Routine Description:
 
@@ -170,7 +169,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 #endif

IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppy.c

@@ -73,7 +73,16 @@ InitializeIsaFloppy(
   return Status;
 }
 
-
+/**
+  Test controller is a Floppy Disk Controller
+  
+  @param This                 Pointer of EFI_DRIVER_BINDING_PROTOCOL
+  @param Controller           driver's controller
+  @param RemainingDevicePath  children device path
+  
+  @retval EFI_UNSUPPORTED controller is not floppy disk
+  @retval EFI_SUCCESS     controller is floppy disk
+**/
 EFI_STATUS
 EFIAPI
 FdcControllerDriverSupported (
@@ -81,20 +90,6 @@ FdcControllerDriverSupported (
   IN EFI_HANDLE                   Controller,
   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
   )
-/*++
-
-Routine Description:
-
-  ControllerDriver Protocol Method
-
-Arguments:
-
-Returns:
-
---*/
-// GC_TODO:    This - add argument and description to function comment
-// GC_TODO:    Controller - add argument and description to function comment
-// GC_TODO:    RemainingDevicePath - add argument and description to function comment
 {
   EFI_STATUS                          Status;
   EFI_ISA_IO_PROTOCOL                 *IsaIo;
@@ -133,6 +128,15 @@ Returns:
   return Status;
 }
 
+/**
+  Create floppy control instance on controller.
+  
+  @param This         Pointer of EFI_DRIVER_BINDING_PROTOCOL
+  @param Controller   driver controller handle
+  @param RemainingDevicePath Children's device path
+  
+  @retval whether success to create floppy control instance.
+**/
 EFI_STATUS
 EFIAPI
 FdcControllerDriverStart (
@@ -140,18 +144,6 @@ FdcControllerDriverStart (
   IN EFI_HANDLE                   Controller,
   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
   )
-/*++
-
-Routine Description:
-
-Arguments:
-
-Returns:
-
---*/
-// GC_TODO:    This - add argument and description to function comment
-// GC_TODO:    Controller - add argument and description to function comment
-// GC_TODO:    RemainingDevicePath - add argument and description to function comment
 {
   EFI_STATUS                                Status;
   FDC_BLK_IO_DEV                            *FdcDev;
@@ -364,6 +356,20 @@ Done:
   return Status;
 }
 
+/**
+  Stop this driver on ControllerHandle. Support stoping any child handles
+  created by this driver.
+
+  @param  This              Protocol instance pointer.
+  @param  ControllerHandle  Handle of device to stop driver on
+  @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of
+                            children is zero stop the entire bus driver.
+  @param  ChildHandleBuffer List of Child Handles to Stop.
+
+  @retval EFI_SUCCESS       This driver is removed ControllerHandle
+  @retval other             This driver was not removed from this device
+
+**/
 EFI_STATUS
 EFIAPI
 FdcControllerDriverStop (
@@ -372,20 +378,6 @@ FdcControllerDriverStop (
   IN  UINTN                        NumberOfChildren,
   IN  EFI_HANDLE                   *ChildHandleBuffer
   )
-/*++
-
-  Routine Description:
-
-  Arguments:
-
-  Returns:
-
---*/
-// GC_TODO:    This - add argument and description to function comment
-// GC_TODO:    Controller - add argument and description to function comment
-// GC_TODO:    NumberOfChildren - add argument and description to function comment
-// GC_TODO:    ChildHandleBuffer - add argument and description to function comment
-// GC_TODO:    EFI_SUCCESS - add return value to function comment
 {
   EFI_STATUS            Status;
   EFI_BLOCK_IO_PROTOCOL *BlkIo;
@@ -478,3 +470,4 @@ FdcControllerDriverStop (
 
   return EFI_SUCCESS;
 }
+

IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppyBlock.c

@@ -23,29 +23,24 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
 #include "IsaFloppy.h"
 
+/**
+  Reset the Floppy Logic Drive, call the FddReset function   
+  
+  @param This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface
+  @param ExtendedVerification BOOLEAN: Indicate that the driver may perform a more 
+                    exhaustive verification operation of the device during 
+                    reset, now this par is ignored in this driver          
+  @retval  EFI_SUCCESS:      The Floppy Logic Drive is reset
+  @retval  EFI_DEVICE_ERROR: The Floppy Logic Drive is not functioning correctly 
+                      and can not be reset
+
+**/
 EFI_STATUS
 EFIAPI
 FdcReset (
   IN  EFI_BLOCK_IO_PROTOCOL  *This,
   IN  BOOLEAN                ExtendedVerification
   )
-/*++
-  
-  Routine Description:  Reset the Floppy Logic Drive, call the FddReset function   
-  Parameters:
-    This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface
-    ExtendedVerification BOOLEAN: Indicate that the driver may perform a more 
-                    exhaustive verification operation of the device during 
-                    reset, now this par is ignored in this driver          
-  Returns:
-    EFI_SUCCESS:      The Floppy Logic Drive is reset
-    EFI_DEVICE_ERROR: The Floppy Logic Drive is not functioning correctly 
-                      and can not be reset
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    This - add argument and description to function comment
-// GC_TODO:    ExtendedVerification - add argument and description to function comment
 {
   FDC_BLK_IO_DEV  *FdcDev;
 
@@ -63,22 +58,18 @@ FdcReset (
   return FddReset (FdcDev);
 }
 
+/**
+  Flush block via fdd controller
+  
+  @param  This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface
+  @return EFI_SUCCESS
+
+**/
 EFI_STATUS
 EFIAPI
 FddFlushBlocks (
   IN  EFI_BLOCK_IO_PROTOCOL  *This
   )
-/*++
-  
-  Routine Description:  
-  Parameters:
-    This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface
-  Returns:
-    EFI_SUCCESS:    
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    This - add argument and description to function comment
 {
   //
   // Not supported yet
@@ -86,28 +77,18 @@ FddFlushBlocks (
   return EFI_SUCCESS;
 }
 
+/**
+  Common report status code interface
+  
+  @param This  Pointer of FDC_BLK_IO_DEV instance
+  @param Read  Error type: read or write?
+**/
 STATIC
 VOID
 FddReportStatus (
   IN  EFI_BLOCK_IO_PROTOCOL  *This,
   IN  BOOLEAN                Read
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  This  - GC_TODO: add argument description
-  Read  - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   FDC_BLK_IO_DEV  *FdcDev;
 
@@ -120,6 +101,26 @@ Returns:
     );
 }
 
+/**
+  Read the requested number of blocks from the device   
+  
+  @param This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface
+  @param MediaId UINT32:    The media id that the read request is for    
+  @param  LBA EFI_LBA:     The starting logic block address to read from on the device
+  @param  BufferSize UINTN:  The size of the Buffer in bytes
+  @param  Buffer VOID *:     A pointer to the destination buffer for the data
+  
+  @retval  EFI_SUCCESS:     The data was read correctly from the device
+  @retval  EFI_DEVICE_ERROR:The device reported an error while attempting to perform
+                     the read operation
+  @retval  EFI_NO_MEDIA:    There is no media in the device
+  @retval  EFI_MEDIA_CHANGED:   The MediaId is not for the current media
+  @retval  EFI_BAD_BUFFER_SIZE: The BufferSize parameter is not a multiple of the 
+                         intrinsic block size of the device
+  @retval  EFI_INVALID_PARAMETER:The read request contains LBAs that are not valid, 
+                          or the buffer is not on proper alignment 
+
+**/
 EFI_STATUS
 EFIAPI
 FddReadBlocks (
@@ -129,33 +130,6 @@ FddReadBlocks (
   IN  UINTN                  BufferSize,
   OUT VOID                   *Buffer
   )
-/*++
-
-  Routine Description:  Read the requested number of blocks from the device   
-  Parameters:
-    This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface
-    MediaId UINT32:    The media id that the read request is for    
-    LBA EFI_LBA:     The starting logic block address to read from on the device
-    BufferSize UINTN:  The size of the Buffer in bytes
-    Buffer VOID *:     A pointer to the destination buffer for the data
-  Returns:
-    EFI_SUCCESS:     The data was read correctly from the device
-    EFI_DEVICE_ERROR:The device reported an error while attempting to perform
-                     the read operation
-    EFI_NO_MEDIA:    There is no media in the device
-    EFI_MEDIA_CHANGED:   The MediaId is not for the current media
-    EFI_BAD_BUFFER_SIZE: The BufferSize parameter is not a multiple of the 
-                         intrinsic block size of the device
-    EFI_INVALID_PARAMETER:The read request contains LBAs that are not valid, 
-                          or the buffer is not on proper alignment 
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    This - add argument and description to function comment
-// GC_TODO:    MediaId - add argument and description to function comment
-// GC_TODO:    LBA - add argument and description to function comment
-// GC_TODO:    BufferSize - add argument and description to function comment
-// GC_TODO:    Buffer - add argument and description to function comment
 {
   EFI_STATUS  Status;
 
@@ -168,6 +142,26 @@ FddReadBlocks (
   return Status;
 }
 
+/**
+  Write a specified number of blocks to the device   
+  
+  @param  This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface
+  @param  MediaId UINT32:    The media id that the write request is for   
+  @param  LBA EFI_LBA:     The starting logic block address to be written
+  @param  BufferSize UINTN:  The size in bytes in Buffer
+  @param  Buffer VOID *:     A pointer to the source buffer for the data
+  
+  @retval  EFI_SUCCESS:     The data were written correctly to the device
+  @retval  EFI_WRITE_PROTECTED: The device can not be written to 
+  @retval  EFI_NO_MEDIA:    There is no media in the device
+  @retval  EFI_MEDIA_CHANGED:   The MediaId is not for the current media
+  @retval  EFI_DEVICE_ERROR:  The device reported an error while attempting to perform 
+                       the write operation 
+  @retval  EFI_BAD_BUFFER_SIZE: The BufferSize parameter is not a multiple of the 
+                         intrinsic block size of the device
+  @retval  EFI_INVALID_PARAMETER:The write request contains LBAs that are not valid, 
+                          or the buffer is not on proper alignment 
+**/
 EFI_STATUS
 EFIAPI
 FddWriteBlocks (
@@ -177,35 +171,6 @@ FddWriteBlocks (
   IN UINTN                  BufferSize,
   IN VOID                   *Buffer
   )
-/*++
-
-  Routine Description:  Write a specified number of blocks to the device   
-  Parameters:
-    This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface
-    MediaId UINT32:    The media id that the write request is for   
-    LBA EFI_LBA:     The starting logic block address to be written
-    BufferSize UINTN:  The size in bytes in Buffer
-    Buffer VOID *:     A pointer to the source buffer for the data
-  Returns :
-    EFI_SUCCESS:     The data were written correctly to the device
-    EFI_WRITE_PROTECTED: The device can not be written to 
-    EFI_NO_MEDIA:    There is no media in the device
-    EFI_MEDIA_CHANGED:   The MediaId is not for the current media
-    EFI_DEVICE_ERROR:  The device reported an error while attempting to perform 
-                       the write operation 
-    EFI_BAD_BUFFER_SIZE: The BufferSize parameter is not a multiple of the 
-                         intrinsic block size of the device
-    EFI_INVALID_PARAMETER:The write request contains LBAs that are not valid, 
-                          or the buffer is not on proper alignment 
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO: function comment is missing 'Returns:'
-// GC_TODO:    This - add argument and description to function comment
-// GC_TODO:    MediaId - add argument and description to function comment
-// GC_TODO:    LBA - add argument and description to function comment
-// GC_TODO:    BufferSize - add argument and description to function comment
-// GC_TODO:    Buffer - add argument and description to function comment
 {
   EFI_STATUS  Status;
 
@@ -218,6 +183,32 @@ FddWriteBlocks (
   return Status;
 }
 
+/**
+  Read or Write a number of blocks to floppy device
+
+  @param This     Pointer to instance of EFI_BLOCK_IO_PROTOCOL
+  @param MediaId  The media id of read/write request
+  @param LBA      The starting logic block address to read from on the device
+  @param BufferSize The size of the Buffer in bytes
+  @param Operation   - GC_TODO: add argument description
+  Buffer      - GC_TODO: add argument description
+
+  @retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value
+  @retval EFI_SUCCESS - GC_TODO: Add description for return value
+  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value
+  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value
+  @retval EFI_NO_MEDIA - GC_TODO: Add description for return value
+  @retval EFI_MEDIA_CHANGED - GC_TODO: Add description for return value
+  @retval EFI_WRITE_PROTECTED - GC_TODO: Add description for return value
+  @retval EFI_BAD_BUFFER_SIZE - GC_TODO: Add description for return value
+  @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_DEVICE_ERROR - GC_TODO: Add description for return value
+  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value
+  @retval EFI_SUCCESS - GC_TODO: Add description for return value
+
+**/
 EFI_STATUS
 FddReadWriteBlocks (
   IN  EFI_BLOCK_IO_PROTOCOL  *This,
@@ -227,39 +218,6 @@ FddReadWriteBlocks (
   IN  BOOLEAN                Operation,
   OUT VOID                   *Buffer
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  This        - GC_TODO: add argument description
-  MediaId     - GC_TODO: add argument description
-  LBA         - GC_TODO: add argument description
-  BufferSize  - GC_TODO: add argument description
-  Operation   - GC_TODO: add argument description
-  Buffer      - GC_TODO: add argument description
-
-Returns:
-
-  EFI_INVALID_PARAMETER - GC_TODO: Add description for return value
-  EFI_SUCCESS - GC_TODO: Add description for return value
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value
-  EFI_NO_MEDIA - GC_TODO: Add description for return value
-  EFI_MEDIA_CHANGED - GC_TODO: Add description for return value
-  EFI_WRITE_PROTECTED - GC_TODO: Add description for return value
-  EFI_BAD_BUFFER_SIZE - GC_TODO: Add description for return value
-  EFI_INVALID_PARAMETER - GC_TODO: Add description for return value
-  EFI_INVALID_PARAMETER - GC_TODO: Add description for return value
-  EFI_SUCCESS - GC_TODO: Add description for return value
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   EFI_BLOCK_IO_MEDIA  *Media;
   FDC_BLK_IO_DEV      *FdcDev;
@@ -423,25 +381,16 @@ Returns:
 
 }
 
+/**
+  Common interface for free cache 
+  
+  @param FdcDec  Pointer of FDC_BLK_IO_DEV instance
+  
+**/
 VOID
 FdcFreeCache (
   IN    FDC_BLK_IO_DEV  *FdcDev
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  FdcDev  - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   if (FdcDev->Cache) {
     gBS->FreePool (FdcDev->Cache);

IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/IsaFloppyCtrl.c

@@ -22,22 +22,19 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
 #include "IsaFloppy.h"
 
+/**
+
+  Detect the floppy drive is presented or not
+ 
+  @param  FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV
+  @retval EFI_SUCCESS    Drive is presented
+  @retval EFI_NOT_FOUND  Drive is not presented
+
+**/
 EFI_STATUS
 DiscoverFddDevice (
   IN FDC_BLK_IO_DEV  *FdcDev
   )
-/*++
-
-  Routine Description:  Detect the floppy drive is presented or not
-  Parameters:
-    FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV
-  Returns:
-    EFI_SUCCESS    Drive is presented
-    EFI_NOT_FOUND  Drive is not presented
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
 {
   EFI_STATUS  Status;
 
@@ -61,23 +58,19 @@ DiscoverFddDevice (
   return EFI_SUCCESS;
 }
 
+/**
+
+  Do recalibrate  and see the drive is presented or not
+  Set the media parameters
+  
+  @param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV
+  @return the drive is presented or not
+
+**/
 EFI_STATUS
 FddIdentify (
   IN FDC_BLK_IO_DEV  *FdcDev
   )
-/*++
-
-  Routine Description:   Do recalibrate  and see the drive is presented or not
-         Set the media parameters
-  Parameters:
-    FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV
-  Returns:
-    EFI_SUCCESS:
-    EFI_DEVICE_ERROR:
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
 {
   EFI_STATUS  Status;
 
@@ -143,23 +136,21 @@ FddIdentify (
   return EFI_SUCCESS;
 }
 
+/**
+
+  Reset the Floppy Logic Drive
+  
+  @param  FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV
+  
+  @retval EFI_SUCCESS:    The Floppy Logic Drive is reset
+  @retval EFI_DEVICE_ERROR: The Floppy Logic Drive is not functioning correctly and
+                      can not be reset
+
+**/
 EFI_STATUS
 FddReset (
   IN FDC_BLK_IO_DEV  *FdcDev
   )
-/*++
-
-  Routine Description:  Reset the Floppy Logic Drive
-  Parameters:
-    FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV
-  Returns:
-    EFI_SUCCESS:    The Floppy Logic Drive is reset
-    EFI_DEVICE_ERROR: The Floppy Logic Drive is not functioning correctly and
-                      can not be reset
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
 {
   UINT8 data;
   UINT8 StatusRegister0;
@@ -244,24 +235,22 @@ FddReset (
   return EFI_SUCCESS;
 }
 
+/**
+
+  Turn the drive's motor on
+  The drive's motor must be on before any command can be executed
+  
+  @param  FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV
+  
+  @retval  EFI_SUCCESS:       Turn the drive's motor on successfully
+  @retval  EFI_DEVICE_ERROR:    The drive is busy, so can not turn motor on
+  @retval  EFI_INVALID_PARAMETER: Fail to Set timer(Cancel timer)
+
+**/
 EFI_STATUS
 MotorOn (
   IN FDC_BLK_IO_DEV  *FdcDev
   )
-/*++
-
-  Routine Description:  Turn the drive's motor on
-        The drive's motor must be on before any command can be executed
-  Parameters:
-    FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV
-  Returns:
-    EFI_SUCCESS:       Turn the drive's motor on successfully
-    EFI_DEVICE_ERROR:    The drive is busy, so can not turn motor on
-    EFI_INVALID_PARAMETER: Fail to Set timer(Cancel timer)
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
 {
   EFI_STATUS  Status;
   UINT8       data;
@@ -328,22 +317,21 @@ MotorOn (
   return EFI_SUCCESS;
 }
 
+/**
+
+  Set a Timer and when Timer goes off, turn the motor off
+  
+  
+  @param  FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV
+  
+  @retval  EFI_SUCCESS:       Set the Timer successfully
+  @retval  EFI_INVALID_PARAMETER: Fail to Set the timer
+
+**/
 EFI_STATUS
 MotorOff (
   IN FDC_BLK_IO_DEV  *FdcDev
   )
-/*++
-
-  Routine Description:  Set a Timer and when Timer goes off, turn the motor off
-  Parameters:
-    FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV
-  Returns:
-    EFI_SUCCESS:       Set the Timer successfully
-    EFI_INVALID_PARAMETER: Fail to Set the timer
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
 {
   //
   // Set the timer : 2s
@@ -351,24 +339,21 @@ MotorOff (
   return gBS->SetTimer (FdcDev->Event, TimerRelative, 20000000);
 }
 
+/**
+  Detect the disk in the drive is changed or not
+  
+  
+  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
+  
+  @retval  EFI_SUCCESS:    No disk media change
+  @retval  EFI_DEVICE_ERROR: Fail to do the recalibrate or seek operation
+  @retval  EFI_NO_MEDIA:   No disk in the drive
+  @retval  EFI_MEDIA_CHANGED:  There is a new disk in the drive
+**/
 EFI_STATUS
 DisketChanged (
   IN FDC_BLK_IO_DEV  *FdcDev
   )
-/*++
-
-  Routine Description:  Detect the disk in the drive is changed or not
-  Parameters:
-    FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
-  Returns:
-    EFI_SUCCESS:    No disk media change
-    EFI_DEVICE_ERROR: Fail to do the recalibrate or seek operation
-    EFI_NO_MEDIA:   No disk in the drive
-    EFI_MEDIA_CHANGED:  There is a new disk in the drive
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
 {
   EFI_STATUS  Status;
   UINT8       data;
@@ -418,24 +403,21 @@ DisketChanged (
   return EFI_SUCCESS;
 }
 
+/**
+  Do the Specify command, this command sets DMA operation
+  and the initial values for each of the three internal
+  times: HUT, SRT and HLT
+  
+  @param This    Pointer to instance of FDC_BLK_IO_DEV
+  
+  @retval  EFI_SUCCESS:    Execute the Specify command successfully
+  @retval  EFI_DEVICE_ERROR: Fail to execute the command
+
+**/
 EFI_STATUS
 Specify (
   IN FDC_BLK_IO_DEV  *FdcDev
   )
-/*++
-
-  Routine Description:  Do the Specify command, this command sets DMA operation
-                        and the initial values for each of the three internal
-                        times: HUT, SRT and HLT
-  Parameters:
-    None
-  Returns:
-    EFI_SUCCESS:    Execute the Specify command successfully
-    EFI_DEVICE_ERROR: Fail to execute the command
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
 {
   FDD_SPECIFY_CMD Command;
   UINTN           Index;
@@ -464,22 +446,18 @@ Specify (
   return EFI_SUCCESS;
 }
 
+/**
+  Set the head of floppy drive to track 0
+ 
+  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
+  @retval EFI_SUCCESS:    Execute the Recalibrate operation successfully
+  @retval EFI_DEVICE_ERROR: Fail to execute the Recalibrate operation
+
+**/
 EFI_STATUS
 Recalibrate (
   IN FDC_BLK_IO_DEV  *FdcDev
   )
-/*++
-
-  Routine Description:  Set the head of floppy drive to track 0
-  Parameters:
-    FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
-  Returns:
-    EFI_SUCCESS:    Execute the Recalibrate operation successfully
-    EFI_DEVICE_ERROR: Fail to execute the Recalibrate operation
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
 {
   FDD_COMMAND_PACKET2 Command;
   UINTN               Index;
@@ -542,25 +520,21 @@ Recalibrate (
   return EFI_SUCCESS;
 }
 
+/**
+  Set the head of floppy drive to the new cylinder
+  
+  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
+  @param  Lba EFI_LBA     : The logic block address want to seek
+  
+  @retval  EFI_SUCCESS:    Execute the Seek operation successfully
+  @retval  EFI_DEVICE_ERROR: Fail to execute the Seek operation
+
+**/
 EFI_STATUS
 Seek (
   IN FDC_BLK_IO_DEV  *FdcDev,
   IN EFI_LBA         Lba
   )
-/*++
-
-  Routine Description:  Set the head of floppy drive to the new cylinder
-  Parameters:
-    FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
-    Lba EFI_LBA     : The logic block address want to seek
-  Returns:
-    EFI_SUCCESS:    Execute the Seek operation successfully
-    EFI_DEVICE_ERROR: Fail to execute the Seek operation
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
-// GC_TODO:    Lba - add argument and description to function comment
 {
   FDD_SEEK_CMD  Command;
   UINT8         EndOfTrack;
@@ -649,29 +623,25 @@ Seek (
   }
 }
 
+/**
+  Do the Sense Interrupt Status command, this command
+  resets the interrupt signal
+  
+  
+  @param  StatusRegister0 UINT8 *: Be used to save Status Register 0 read from FDC
+  @param  PresentCylinderNumber  UINT8 *: Be used to save present cylinder number
+                                    read from FDC
+  
+  @retval  EFI_SUCCESS:    Execute the Sense Interrupt Status command successfully
+  @retval  EFI_DEVICE_ERROR: Fail to execute the command
+
+**/
 EFI_STATUS
 SenseIntStatus (
   IN     FDC_BLK_IO_DEV  *FdcDev,
   IN OUT UINT8           *StatusRegister0,
   IN OUT UINT8           *PresentCylinderNumber
   )
-/*++
-
-  Routine Description:  Do the Sense Interrupt Status command, this command
-                        resets the interrupt signal
-  Parameters:
-    StatusRegister0 UINT8 *: Be used to save Status Register 0 read from FDC
-    PresentCylinderNumber  UINT8 *: Be used to save present cylinder number
-                                    read from FDC
-  Returns:
-    EFI_SUCCESS:    Execute the Sense Interrupt Status command successfully
-    EFI_DEVICE_ERROR: Fail to execute the command
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
-// GC_TODO:    StatusRegister0 - add argument and description to function comment
-// GC_TODO:    PresentCylinderNumber - add argument and description to function comment
 {
   UINT8 command;
 
@@ -691,26 +661,22 @@ SenseIntStatus (
   return EFI_SUCCESS;
 }
 
+/**
+  Do the Sense Drive Status command
+  
+  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
+  @param  Lba EFI_LBA     : Logic block address
+  
+  @retval  EFI_SUCCESS:    Execute the Sense Drive Status command successfully
+  @retval  EFI_DEVICE_ERROR: Fail to execute the command
+  @retval  EFI_WRITE_PROTECTED:The disk is write protected
+
+**/
 EFI_STATUS
 SenseDrvStatus (
   IN FDC_BLK_IO_DEV  *FdcDev,
   IN EFI_LBA         Lba
   )
-/*++
-
-  Routine Description:  Do the Sense Drive Status command
-  Parameters:
-    FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
-    Lba EFI_LBA     : Logic block address
-  Returns:
-    EFI_SUCCESS:    Execute the Sense Drive Status command successfully
-    EFI_DEVICE_ERROR: Fail to execute the command
-    EFI_WRITE_PROTECTED:The disk is write protected
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
-// GC_TODO:    Lba - add argument and description to function comment
 {
   FDD_COMMAND_PACKET2 Command;
   UINT8               Head;
@@ -758,23 +724,20 @@ SenseDrvStatus (
   return CheckStatus3 (StatusRegister3);
 }
 
+/**
+  Update the disk media properties and if necessary
+                        reinstall Block I/O interface
+ 
+  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
+  
+  @retval  EFI_SUCCESS:    Do the operation successfully
+  @retval  EFI_DEVICE_ERROR: Fail to the operation
+
+**/
 EFI_STATUS
 DetectMedia (
   IN FDC_BLK_IO_DEV  *FdcDev
   )
-/*++
-
-  Routine Description:  Update the disk media properties and if necessary
-                        reinstall Block I/O interface
-  Parameters:
-    FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
-  Returns:
-    EFI_SUCCESS:    Do the operation successfully
-    EFI_DEVICE_ERROR: Fail to the operation
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
 {
   EFI_STATUS  Status;
   BOOLEAN     bReset;
@@ -840,22 +803,17 @@ DetectMedia (
   return EFI_SUCCESS;
 }
 
+/**
+  Set the data rate and so on
+ 
+  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
+
+  @retval EFI_SUCCESS success to set the data rate
+**/
 EFI_STATUS
 Setup (
   IN FDC_BLK_IO_DEV  *FdcDev
   )
-/*++
-
-  Routine Description: Set the data rate and so on
-  Parameters:
-    None
-  Returns:
-    EFI_SUCCESS:
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
-// GC_TODO:    EFI_DEVICE_ERROR - add return value to function comment
 {
   EFI_STATUS  Status;
 
@@ -878,6 +836,18 @@ Setup (
   return EFI_SUCCESS;
 }
 
+/**
+  Read or Write a number of blocks in the same cylinder
+ 
+  @param  FdcDev      A pointer to Data Structure FDC_BLK_IO_DEV
+  @param  HostAddress device address 
+  @param  Lba         The starting logic block address to read from on the device
+  @param  NumberOfBlocks The number of block wanted to be read or write
+  @param  Read        Operation type: read or write
+  
+  @retval EFI_SUCCESS Success operate
+
+**/
 EFI_STATUS
 ReadWriteDataSector (
   IN  FDC_BLK_IO_DEV  *FdcDev,
@@ -886,30 +856,6 @@ ReadWriteDataSector (
   IN  UINTN           NumberOfBlocks,
   IN  BOOLEAN         Read
   )
-/*++
-
-  Routine Description: Read or Write a number of blocks in the same cylinder
-  Parameters:
-    FdcDev FDC_BLK_IO_DEV * : A pointer to Data Structure FDC_BLK_IO_DEV
-    Buffer VOID *:
-    Lba EFI_LBA:
-    NumberOfBlocks UINTN:
-    Read BOOLEAN:
-  Returns:
-    EFI_SUCCESS:
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
-// GC_TODO:    HostAddress - add argument and description to function comment
-// GC_TODO:    Lba - add argument and description to function comment
-// GC_TODO:    NumberOfBlocks - add argument and description to function comment
-// GC_TODO:    Read - add argument and description to function comment
-// GC_TODO:    EFI_DEVICE_ERROR - add return value to function comment
-// GC_TODO:    EFI_DEVICE_ERROR - add return value to function comment
-// GC_TODO:    EFI_DEVICE_ERROR - add return value to function comment
-// GC_TODO:    EFI_TIMEOUT - add return value to function comment
-// GC_TODO:    EFI_DEVICE_ERROR - add return value to function comment
 {
   EFI_STATUS                                    Status;
   FDD_COMMAND_PACKET1                           Command;
@@ -1040,23 +986,20 @@ ReadWriteDataSector (
   return CheckResult (&Result, FdcDev);
 }
 
+/**
+  Fill in FDD command's parameter
+  
+  @param FdcDev   Pointer to instance of FDC_BLK_IO_DEV
+  @param Lba      The starting logic block address to read from on the device
+  @param Command  FDD command
+
+**/
 VOID
 FillPara (
   IN  FDC_BLK_IO_DEV       *FdcDev,
   IN  EFI_LBA              Lba,
   IN  FDD_COMMAND_PACKET1  *Command
   )
-/*++
-
-  Routine Description: Fill in Parameter
-  Parameters:
-  Returns:
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
-// GC_TODO:    Lba - add argument and description to function comment
-// GC_TODO:    Command - add argument and description to function comment
 {
   UINT8 EndOfTrack;
 
@@ -1084,24 +1027,22 @@ FillPara (
   Command->DataLength = DISK_1440K_DTL;
 }
 
+/**
+  Read result byte from Data Register of FDC
+  
+  @param FdcDev  Pointer to instance of FDC_BLK_IO_DEV
+  @param Pointer UINT8 *: Be used to save result byte read from FDC
+  
+  
+  @retval  EFI_SUCCESS:    Read result byte from FDC successfully
+  @retval  EFI_DEVICE_ERROR: The FDC is not ready to be read
+
+**/
 EFI_STATUS
 DataInByte (
   IN     FDC_BLK_IO_DEV  *FdcDev,
   IN OUT UINT8           *Pointer
   )
-/*++
-
-  Routine Description:  Read result byte from Data Register of FDC
-  Parameters:
-    Pointer UINT8 *: Be used to save result byte read from FDC
-  Returns:
-    EFI_SUCCESS:    Read result byte from FDC successfully
-    EFI_DEVICE_ERROR: The FDC is not ready to be read
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
-// GC_TODO:    Pointer - add argument and description to function comment
 {
   UINT8 data;
 
@@ -1126,24 +1067,21 @@ DataInByte (
   return EFI_SUCCESS;
 }
 
+/**
+  Write command byte to Data Register of FDC
+  
+  @param FdcDev  Pointer to instance of FDC_BLK_IO_DEV
+  @param Pointer Be used to save command byte written to FDC
+  
+  @retval  EFI_SUCCESS:    Write command byte to FDC successfully
+  @retval  EFI_DEVICE_ERROR: The FDC is not ready to be written
+
+**/
 EFI_STATUS
 DataOutByte (
   IN FDC_BLK_IO_DEV  *FdcDev,
   IN UINT8           *Pointer
   )
-/*++
-
-  Routine Description:  Write command byte to Data Register of FDC
-  Parameters:
-    Pointer UINT8 *: Be used to save command byte written to FDC
-  Returns:
-    EFI_SUCCESS:    Write command byte to FDC successfully
-    EFI_DEVICE_ERROR: The FDC is not ready to be written
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
-// GC_TODO:    Pointer - add argument and description to function comment
 {
   UINT8 data;
 
@@ -1169,27 +1107,23 @@ DataOutByte (
   return EFI_SUCCESS;
 }
 
+/**
+  Detect the specified floppy logic drive is busy or
+  not within a period of time
+  
+  @param Disk             Indicate it is drive A or drive B
+  @param TimeoutInSeconds the time period for waiting
+  
+  @retval EFI_SUCCESS:  The drive and command are not busy
+  @retval EFI_TIMEOUT:  The drive or command is still busy after a period time that
+                        set by TimeoutInSeconds
+
+**/
 EFI_STATUS
 FddWaitForBSYClear (
   IN FDC_BLK_IO_DEV  *FdcDev,
   IN UINTN           TimeoutInSeconds
   )
-/*++
-
-  Routine Description:  Detect the specified floppy logic drive is busy or
-                        not within a period of time
-  Parameters:
-    Disk EFI_FDC_DISK:    Indicate it is drive A or drive B
-    TimeoutInSeconds UINTN: the time period for waiting
-  Returns:
-    EFI_SUCCESS:  The drive and command are not busy
-    EFI_TIMEOUT:  The drive or command is still busy after a period time that
-                  set by TimeoutInSeconds
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
-// GC_TODO:    TimeoutInSeconds - add argument and description to function comment
 {
   UINTN Delay;
   UINT8 StatusRegister;
@@ -1228,27 +1162,24 @@ FddWaitForBSYClear (
   return EFI_SUCCESS;
 }
 
+/**
+
+  Routine Description:  Determine whether FDC is ready to write or read
+  
+  @param  FdcDev Pointer to instance of FDC_BLK_IO_DEV
+  @param  Dio BOOLEAN:      Indicate the FDC is waiting to write or read
+  @param  TimeoutInSeconds UINTN: The time period for waiting
+  
+  @retval EFI_SUCCESS:  FDC is ready to write or read
+  @retval EFI_NOT_READY:  FDC is not ready within the specified time period
+
+**/
 EFI_STATUS
 FddDRQReady (
   IN FDC_BLK_IO_DEV  *FdcDev,
   IN BOOLEAN         Dio,
   IN  UINTN          TimeoutInSeconds
   )
-/*++
-
-  Routine Description:  Determine whether FDC is ready to write or read
-  Parameters:
-    Dio BOOLEAN:      Indicate the FDC is waiting to write or read
-    TimeoutInSeconds UINTN: The time period for waiting
-  Returns:
-    EFI_SUCCESS:  FDC is ready to write or read
-    EFI_NOT_READY:  FDC is not ready within the specified time period
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
-// GC_TODO:    Dio - add argument and description to function comment
-// GC_TODO:    TimeoutInSeconds - add argument and description to function comment
 {
   UINTN Delay;
   UINT8 StatusRegister;
@@ -1294,30 +1225,24 @@ FddDRQReady (
   return EFI_SUCCESS;
 }
 
+/**
+  Set FDC control structure's attribute according to
+  result 
+
+  @param Result  Point to result structure
+  @param FdcDev  FDC control structure
+
+  @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value
+  @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value
+  @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value
+  @param EFI_SUCCESS - GC_TODO: Add description for return value
+
+**/
 EFI_STATUS
 CheckResult (
   IN     FDD_RESULT_PACKET  *Result,
   IN OUT FDC_BLK_IO_DEV     *FdcDev
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  Result  - GC_TODO: add argument description
-  FdcDev  - GC_TODO: add argument description
-
-Returns:
-
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   //
   // Check Status Register0
@@ -1351,22 +1276,19 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Check the drive status information
+  
+  @param StatusRegister3  the value of Status Register 3
+  
+  @retval EFI_SUCCESS           The disk is not write protected
+  @retval EFI_WRITE_PROTECTED:  The disk is write protected
+
+**/
 EFI_STATUS
 CheckStatus3 (
   IN UINT8 StatusRegister3
   )
-/*++
-
-  Routine Description:  Check the drive status information
-  Parameters:
-    StatusRegister3 UINT8: the value of Status Register 3
-  Returns:
-    EFI_SUCCESS:
-    EFI_WRITE_PROTECTED:  The disk is write protected
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    StatusRegister3 - add argument and description to function comment
 {
   if (StatusRegister3 & STS3_WP) {
     return EFI_WRITE_PROTECTED;
@@ -1375,29 +1297,24 @@ CheckStatus3 (
   return EFI_SUCCESS;
 }
 
+/**
+  Calculate the number of block in the same cylinder
+  according to LBA
+  
+  @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
+  @param LBA EFI_LBA:      The starting logic block address
+  @param NumberOfBlocks UINTN: The number of blocks
+  
+  @return The number of blocks in the same cylinder which the starting
+        logic block address is LBA
+
+**/
 UINTN
 GetTransferBlockCount (
   IN  FDC_BLK_IO_DEV  *FdcDev,
   IN  EFI_LBA         LBA,
   IN  UINTN           NumberOfBlocks
   )
-/*++
-
-  Routine Description:  Calculate the number of block in the same cylinder
-                        according to LBA
-  Parameters:
-    FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
-    LBA EFI_LBA:      The starting logic block address
-    NumberOfBlocks UINTN: The number of blocks
-  Returns:
-    UINTN : The number of blocks in the same cylinder which the starting
-        logic block address is LBA
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
-// GC_TODO:    LBA - add argument and description to function comment
-// GC_TODO:    NumberOfBlocks - add argument and description to function comment
 {
   UINT8 EndOfTrack;
   UINT8 Head;
@@ -1417,26 +1334,20 @@ GetTransferBlockCount (
   }
 }
 
+/**
+  When the Timer(2s) off, turn the drive's motor off
+  
+  @param Event EFI_EVENT: Event(the timer) whose notification function is being
+                     invoked
+  @param Context VOID *:  Pointer to the notification function's context
+
+**/
 VOID
 EFIAPI
 FddTimerProc (
   IN EFI_EVENT  Event,
   IN VOID       *Context
   )
-/*++
-
-  Routine Description:  When the Timer(2s) off, turn the drive's motor off
-  Parameters:
-    Event EFI_EVENT: Event(the timer) whose notification function is being
-                     invoked
-    Context VOID *:  Pointer to the notification function's context
-  Returns:
-    VOID
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    Event - add argument and description to function comment
-// GC_TODO:    Context - add argument and description to function comment
 {
   FDC_BLK_IO_DEV  *FdcDev;
   UINT8           data;
@@ -1462,21 +1373,18 @@ FddTimerProc (
   MicroSecondDelay (500);
 }
 
+/**
+  Read I/O port for FDC
+ 
+  @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
+  @param Offset The offset address of port
+
+**/
 UINT8
 FdcReadPort (
   IN FDC_BLK_IO_DEV  *FdcDev,
   IN UINT32          Offset
   )
-/*++
-
-  Routine Description: Read I/O port for FDC
-  Parameters:
-  Returns:
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
-// GC_TODO:    Offset - add argument and description to function comment
 {
   UINT8       Data;
 
@@ -1494,23 +1402,19 @@ FdcReadPort (
   return Data;
 }
 
+/**
+  Write I/O port for FDC
+ 
+  @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV
+  @param Offset The offset address of port
+
+**/
 VOID
 FdcWritePort (
   IN FDC_BLK_IO_DEV  *FdcDev,
   IN UINT32          Offset,
   IN UINT8           Data
   )
-/*++
-
-  Routine Description: Write I/O port for FDC
-  Parameters:
-  Returns:
-
---*/
-// GC_TODO: function comment is missing 'Arguments:'
-// GC_TODO:    FdcDev - add argument and description to function comment
-// GC_TODO:    Offset - add argument and description to function comment
-// GC_TODO:    Data - add argument and description to function comment
 {
 
   //
@@ -1524,3 +1428,4 @@ FdcWritePort (
                       &Data
                       );
 }
+

IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/ComponentName.c

@@ -232,7 +232,7 @@ AddName (
   IN  SERIAL_DEV                               *SerialDevice,
   IN  EFI_ISA_IO_PROTOCOL                      *IsaIo
   )
-/*++
+/**
 
   Routine Description:
   
@@ -247,7 +247,7 @@ AddName (
 
     None
     
---*/
+**/
 {
   CHAR16  SerialPortName[sizeof (SERIAL_PORT_NAME)];
 

IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/ComponentName.h

@@ -156,7 +156,7 @@ AddName (
   IN  SERIAL_DEV                                   *SerialDevice,
   IN  EFI_ISA_IO_PROTOCOL                          *IsaIo
   )
-/*++
+/**
 
   Routine Description:
 
@@ -171,7 +171,7 @@ AddName (
 
     None
 
---*/
+**/
 ;
 
 #endif

IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/Serial.c

@@ -1,5 +1,5 @@
 /**@file
-	Serial driver for standard UARTS on an ISA bus.
+  Serial driver for standard UARTS on an ISA bus.
 
   Copyright (c) 2006 - 2007, Intel Corporation<BR>
   All rights reserved. This program and the accompanying materials
@@ -122,7 +122,16 @@ InitializeIsaSerial (
   return Status;
 }
 
+/**
+  Check to see if this driver supports the given controller
 
+  @param  This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
+  @param  Controller - The handle of the controller to test.
+  @param  RemainingDevicePath - A pointer to the remaining portion of a device path.
+
+  @return EFI_SUCCESS - This driver can support the given controller
+
+**/
 EFI_STATUS
 EFIAPI
 SerialControllerDriverSupported (
@@ -130,23 +139,7 @@ SerialControllerDriverSupported (
   IN EFI_HANDLE                     Controller,
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
   )
-/*++
 
-  Routine Description:
-
-    Check to see if this driver supports the given controller
-
-  Arguments:
-
-    This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
-    Controller - The handle of the controller to test.
-    RemainingDevicePath - A pointer to the remaining portion of a device path.
-
-  Returns:
-
-    EFI_SUCCESS - This driver can support the given controller
-
---*/
 {
   EFI_STATUS                                Status;
   EFI_DEVICE_PATH_PROTOCOL                  *ParentDevicePath;
@@ -265,6 +258,16 @@ Error:
   return Status;
 }
 
+/**
+  Start to management the controller passed in
+
+  @param  This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
+  @param  Controller - The handle of the controller to test.
+  @param  RemainingDevicePath - A pointer to the remaining portion of a device path.
+
+  @return EFI_SUCCESS - Driver is started successfully
+
+**/
 EFI_STATUS
 EFIAPI
 SerialControllerDriverStart (
@@ -272,23 +275,7 @@ SerialControllerDriverStart (
   IN EFI_HANDLE                     Controller,
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
   )
-/*++
 
-  Routine Description:
-
-    Start to management the controller passed in
-
-  Arguments:
-
-    This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
-    Controller - The handle of the controller to test.
-    RemainingDevicePath - A pointer to the remaining portion of a device path.
-
-  Returns:
-
-    EFI_SUCCESS - Driver is started successfully
-
---*/
 {
   EFI_STATUS                          Status;
   EFI_ISA_IO_PROTOCOL                 *IsaIo;
@@ -527,6 +514,18 @@ Error:
   return Status;
 }
 
+/**
+  Disconnect this driver with the controller, uninstall related protocol instance
+
+  @param  This                - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
+  @param  Controller          - The handle of the controller to test.
+  @param  NumberOfChildren    - Number of child device.
+  @param  RemainingDevicePath - A pointer to the remaining portion of a device path.
+
+  @retval EFI_SUCCESS         - Operation successfully
+  @retval EFI_DEVICE_ERROR    - Cannot stop the driver successfully
+
+**/
 EFI_STATUS
 EFIAPI
 SerialControllerDriverStop (
@@ -535,25 +534,7 @@ SerialControllerDriverStop (
   IN  UINTN                          NumberOfChildren,
   IN  EFI_HANDLE                     *ChildHandleBuffer
   )
-/*++
 
-  Routine Description:
-
-    Disconnect this driver with the controller, uninstall related protocol instance
-
-  Arguments:
-
-    This                - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
-    Controller          - The handle of the controller to test.
-    NumberOfChildren    - Number of child device.
-    RemainingDevicePath - A pointer to the remaining portion of a device path.
-
-  Returns:
-
-    EFI_SUCCESS         - Operation successfully
-    EFI_DEVICE_ERROR    - Cannot stop the driver successfully
-
---*/
 {
   EFI_STATUS                          Status;
   UINTN                               Index;
@@ -664,26 +645,19 @@ SerialControllerDriverStop (
   return EFI_SUCCESS;
 }
 
+/**
+  Detect whether specific FIFO is full or not
+
+  @param Fifo  - A pointer to the Data Structure SERIAL_DEV_FIFO
+
+  @return whether specific FIFO is full or not
+
+**/
 BOOLEAN
 IsaSerialFifoFull (
   IN SERIAL_DEV_FIFO *Fifo
   )
-/*++
 
-  Routine Description:
-
-    Detect whether specific FIFO is full or not
-
-  Arguments:
-
-    Fifo  - A pointer to the Data Structure SERIAL_DEV_FIFO
-
-  Returns:
-
-    TRUE  - the FIFO is full
-    FALSE - the FIFO is not full
-
---*/
 {
   if (Fifo->Surplus == 0) {
     return TRUE;
@@ -692,26 +666,20 @@ IsaSerialFifoFull (
   return FALSE;
 }
 
+/**
+  Detect whether specific FIFO is empty or not
+
+ 
+  @param  Fifo  - A pointer to the Data Structure SERIAL_DEV_FIFO
+
+  @return whether specific FIFO is empty or not
+
+**/
 BOOLEAN
 IsaSerialFifoEmpty (
   IN SERIAL_DEV_FIFO *Fifo
   )
-/*++
 
-  Routine Description:
-
-    Detect whether specific FIFO is empty or not
-
-  Arguments:
-
-    Fifo  - A pointer to the Data Structure SERIAL_DEV_FIFO
-
-  Returns:
-
-    TRUE  - the FIFO is empty
-    FALSE - the FIFO is not empty
-
---*/
 {
   if (Fifo->Surplus == SERIAL_MAX_BUFFER_SIZE) {
     return TRUE;
@@ -720,28 +688,22 @@ IsaSerialFifoEmpty (
   return FALSE;
 }
 
+/**
+  Add data to specific FIFO
+
+  @param Fifo                - A pointer to the Data Structure SERIAL_DEV_FIFO
+  @param Data                - the data added to FIFO
+
+  @retval EFI_SUCCESS         - Add data to specific FIFO successfully
+  @retval EFI_OUT_OF_RESOURCE - Failed to add data because FIFO is already full
+
+**/
 EFI_STATUS
 IsaSerialFifoAdd (
   IN SERIAL_DEV_FIFO *Fifo,
   IN UINT8           Data
   )
-/*++
 
-  Routine Description:
-
-    Add data to specific FIFO
-
-  Arguments:
-
-    Fifo                - A pointer to the Data Structure SERIAL_DEV_FIFO
-    Data                - the data added to FIFO
-
-  Returns:
-
-    EFI_SUCCESS         - Add data to specific FIFO successfully
-    EFI_OUT_OF_RESOURCE - Failed to add data because FIFO is already full
-
---*/
 {
   //
   // if FIFO full can not add data
@@ -762,27 +724,22 @@ IsaSerialFifoAdd (
   return EFI_SUCCESS;
 }
 
+/**
+  Remove data from specific FIFO
+
+  @param Fifo                - A pointer to the Data Structure SERIAL_DEV_FIFO
+  @param Data                - the data removed from FIFO
+
+  @retval EFI_SUCCESS         - Remove data from specific FIFO successfully
+  @retval EFI_OUT_OF_RESOURCE - Failed to remove data because FIFO is empty
+
+**/
 EFI_STATUS
 IsaSerialFifoRemove (
   IN  SERIAL_DEV_FIFO *Fifo,
   OUT UINT8           *Data
   )
-/*++
 
-  Routine Description:
-
-    Remove data from specific FIFO
-
-  Arguments:
-
-    Fifo                - A pointer to the Data Structure SERIAL_DEV_FIFO
-    Data                - the data removed from FIFO
-
-  Returns:
-    EFI_SUCCESS         - Remove data from specific FIFO successfully
-    EFI_OUT_OF_RESOURCE - Failed to remove data because FIFO is empty
-
---*/
 {
   //
   // if FIFO is empty, no data can remove
@@ -803,27 +760,21 @@ IsaSerialFifoRemove (
   return EFI_SUCCESS;
 }
 
+/**
+  Reads and writes all avaliable data.
+
+  @param SerialDevice         - The device to flush
+
+  @retval EFI_SUCCESS         - Data was read/written successfully.
+  @retval EFI_OUT_OF_RESOURCE - Failed because software receive FIFO is full.  Note, when
+                                this happens, pending writes are not done.
+
+**/
 EFI_STATUS
 IsaSerialReceiveTransmit (
   IN SERIAL_DEV *SerialDevice
   )
-/*++
 
-  Routine Description:
-
-    Reads and writes all avaliable data.
-
-  Arguments:
-
-    SerialDevice        - The device to flush
-
-  Returns:
-
-    EFI_SUCCESS         - Data was read/written successfully.
-    EFI_OUT_OF_RESOURCE - Failed because software receive FIFO is full.  Note, when
-                          this happens, pending writes are not done.
-
---*/
 {
   SERIAL_PORT_LSR Lsr;
   UINT8           Data;
@@ -968,30 +919,24 @@ IsaSerialReceiveTransmit (
 
   return EFI_SUCCESS;
 }
+
 //
 // Interface Functions
 //
+/**
+  Reset serial device
+
+  @param This             - Pointer to EFI_SERIAL_IO_PROTOCOL
+
+  @retval EFI_SUCCESS      - Reset successfully
+  @retval EFI_DEVICE_ERROR - Failed to reset
+
+**/
 EFI_STATUS
 EFIAPI
 IsaSerialReset (
   IN EFI_SERIAL_IO_PROTOCOL  *This
   )
-/*++
-
-  Routine Description:
-
-    Reset serial device
-
-  Arguments:
-
-    This             - Pointer to EFI_SERIAL_IO_PROTOCOL
-
-  Returns:
-
-    EFI_SUCCESS      - Reset successfully
-    EFI_DEVICE_ERROR - Failed to reset
-
---*/
 {
   EFI_STATUS      Status;
   SERIAL_DEV      *SerialDevice;
@@ -1106,6 +1051,23 @@ IsaSerialReset (
   return EFI_SUCCESS;
 }
 
+/**
+  Set new attributes to a serial device
+
+  @param This                   - Pointer to EFI_SERIAL_IO_PROTOCOL
+  @param  BaudRate               - The baudrate of the serial device
+  @param  ReceiveFifoDepth       - The depth of receive FIFO buffer
+  @param  Timeout                - The request timeout for a single char
+  @param  Parity                 - The type of parity used in serial device
+  @param  DataBits               - Number of databits used in serial device
+  @param  StopBits               - Number of stopbits used in serial device
+
+  @retval  EFI_SUCCESS            - The new attributes were set
+  @retval  EFI_INVALID_PARAMETERS - One or more attributes have an unsupported value
+  @retval  EFI_UNSUPPORTED        - Data Bits can not set to 5 or 6
+  @retval  EFI_DEVICE_ERROR       - The serial device is not functioning correctly (no return)
+
+**/
 EFI_STATUS
 EFIAPI
 IsaSerialSetAttributes (
@@ -1117,30 +1079,6 @@ IsaSerialSetAttributes (
   IN UINT8                   DataBits,
   IN EFI_STOP_BITS_TYPE      StopBits
   )
-/*++
-
-  Routine Description:
-
-    Set new attributes to a serial device
-
-  Arguments:
-
-    This                   - Pointer to EFI_SERIAL_IO_PROTOCOL
-    BaudRate               - The baudrate of the serial device
-    ReceiveFifoDepth       - The depth of receive FIFO buffer
-    Timeout                - The request timeout for a single char
-    Parity                 - The type of parity used in serial device
-    DataBits               - Number of databits used in serial device
-    StopBits               - Number of stopbits used in serial device
-
-  Returns:
-
-    EFI_SUCCESS            - The new attributes were set
-    EFI_INVALID_PARAMETERS - One or more attributes have an unsupported value
-    EFI_UNSUPPORTED        - Data Bits can not set to 5 or 6
-    EFI_DEVICE_ERROR       - The serial device is not functioning correctly (no return)
-
---*/
 {
   EFI_STATUS                Status;
   SERIAL_DEV                *SerialDevice;
@@ -1424,29 +1362,22 @@ IsaSerialSetAttributes (
   return EFI_SUCCESS;
 }
 
+/**
+  Set Control Bits
+
+  @param This            - Pointer to EFI_SERIAL_IO_PROTOCOL
+  @param Control         - Control bits that can be settable
+
+  @retval EFI_SUCCESS     - New Control bits were set successfully
+  @retval EFI_UNSUPPORTED - The Control bits wanted to set are not supported
+
+**/
 EFI_STATUS
 EFIAPI
 IsaSerialSetControl (
   IN EFI_SERIAL_IO_PROTOCOL  *This,
   IN UINT32                  Control
   )
-/*++
-
-  Routine Description:
-
-    Set Control Bits
-
-  Arguments:
-
-    This            - Pointer to EFI_SERIAL_IO_PROTOCOL
-    Control         - Control bits that can be settable
-
-  Returns:
-
-    EFI_SUCCESS     - New Control bits were set successfully
-    EFI_UNSUPPORTED - The Control bits wanted to set are not supported
-
---*/
 {
   SERIAL_DEV      *SerialDevice;
   SERIAL_PORT_MCR Mcr;
@@ -1504,28 +1435,21 @@ IsaSerialSetControl (
   return EFI_SUCCESS;
 }
 
+/**
+  Get ControlBits
+
+  @param This        - Pointer to EFI_SERIAL_IO_PROTOCOL
+  @param Control     - Control signals of the serial device
+
+  @retval EFI_SUCCESS - Get Control signals successfully
+
+**/
 EFI_STATUS
 EFIAPI
 IsaSerialGetControl (
   IN EFI_SERIAL_IO_PROTOCOL  *This,
   OUT UINT32                 *Control
   )
-/*++
-
-  Routine Description:
-
-    Get ControlBits
-
-  Arguments:
-
-    This        - Pointer to EFI_SERIAL_IO_PROTOCOL
-    Control     - Control signals of the serial device
-
-  Returns:
-
-    EFI_SUCCESS - Get Control signals successfully
-
---*/
 {
   SERIAL_DEV      *SerialDevice;
   SERIAL_PORT_MSR Msr;
@@ -1604,6 +1528,19 @@ IsaSerialGetControl (
   return EFI_SUCCESS;
 }
 
+/**
+  Write the specified number of bytes to serial device
+
+  @param This             - Pointer to EFI_SERIAL_IO_PROTOCOL
+  @param  BufferSize       - On input the size of Buffer, on output the amount of
+                       data actually written
+  @param  Buffer           - The buffer of data to write
+
+  @retval EFI_SUCCESS      - The data were written successfully
+  @retval EFI_DEVICE_ERROR - The device reported an error
+  @retval EFI_TIMEOUT      - The write operation was stopped due to timeout
+
+**/
 EFI_STATUS
 EFIAPI
 IsaSerialWrite (
@@ -1611,26 +1548,6 @@ IsaSerialWrite (
   IN OUT UINTN               *BufferSize,
   IN VOID                    *Buffer
   )
-/*++
-
-  Routine Description:
-
-    Write the specified number of bytes to serial device
-
-  Arguments:
-
-    This             - Pointer to EFI_SERIAL_IO_PROTOCOL
-    BufferSize       - On input the size of Buffer, on output the amount of
-                       data actually written
-    Buffer           - The buffer of data to write
-
-  Returns:
-
-    EFI_SUCCESS      - The data were written successfully
-    EFI_DEVICE_ERROR - The device reported an error
-    EFI_TIMEOUT      - The write operation was stopped due to timeout
-
---*/
 {
   SERIAL_DEV  *SerialDevice;
   UINT8       *CharBuffer;
@@ -1692,6 +1609,19 @@ IsaSerialWrite (
   return EFI_SUCCESS;
 }
 
+/**
+  Read the specified number of bytes from serial device
+
+  @param This             - Pointer to EFI_SERIAL_IO_PROTOCOL
+  @param BufferSize       - On input the size of Buffer, on output the amount of
+                       data returned in buffer
+  @param Buffer           -  The buffer to return the data into
+
+  @retval EFI_SUCCESS      - The data were read successfully
+  @retval EFI_DEVICE_ERROR - The device reported an error
+  @retval EFI_TIMEOUT      - The read operation was stopped due to timeout
+
+**/
 EFI_STATUS
 EFIAPI
 IsaSerialRead (
@@ -1699,26 +1629,6 @@ IsaSerialRead (
   IN OUT UINTN               *BufferSize,
   OUT VOID                   *Buffer
   )
-/*++
-
-  Routine Description:
-
-    Read the specified number of bytes from serial device
-
-  Arguments:
-
-    This             - Pointer to EFI_SERIAL_IO_PROTOCOL
-    BufferSize       - On input the size of Buffer, on output the amount of
-                       data returned in buffer
-    Buffer           -  The buffer to return the data into
-
-  Returns:
-
-    EFI_SUCCESS      - The data were read successfully
-    EFI_DEVICE_ERROR - The device reported an error
-    EFI_TIMEOUT      - The read operation was stopped due to timeout
-
---*/
 {
   SERIAL_DEV  *SerialDevice;
   UINT32      Index;
@@ -1793,26 +1703,18 @@ IsaSerialRead (
   return EFI_SUCCESS;
 }
 
+/**
+  Use scratchpad register to test if this serial port is present
+
+  @param SerialDevice - Pointer to serial device structure
+
+  @return if this serial port is present
+**/
 BOOLEAN
 IsaSerialPortPresent (
   IN SERIAL_DEV *SerialDevice
   )
-/*++
 
-  Routine Description:
-
-    Use scratchpad register to test if this serial port is present
-
-  Arguments:
-
-    SerialDevice - Pointer to serial device structure
-
-  Returns:
-
-    TRUE         - The serial port is present
-    FALSE        - The serial port is NOT present
-
---*/
 {
   UINT8   Temp;
   BOOLEAN Status;
@@ -1845,29 +1747,22 @@ IsaSerialPortPresent (
   return Status;
 }
 
+/**
+  Use IsaIo protocol to read serial port
+
+  @param IsaIo       - Pointer to EFI_ISA_IO_PROTOCOL instance
+  @param BaseAddress - Serial port register group base address
+  @param Offset      - Offset in register group
+
+  @return Data read from serial port
+
+**/
 UINT8
 IsaSerialReadPort (
   IN EFI_ISA_IO_PROTOCOL                   *IsaIo,
   IN UINT16                                BaseAddress,
   IN UINT32                                Offset
   )
-/*++
-
-  Routine Description:
-
-    Use IsaIo protocol to read serial port
-
-  Arguments:
-
-    IsaIo       - Pointer to EFI_ISA_IO_PROTOCOL instance
-    BaseAddress - Serial port register group base address
-    Offset      - Offset in register group
-
-  Returns:
-
-    Data read from serial port
-
---*/
 {
   UINT8 Data;
 
@@ -1884,6 +1779,15 @@ IsaSerialReadPort (
   return Data;
 }
 
+/**
+  Use IsaIo protocol to write serial port
+
+  @param  IsaIo       - Pointer to EFI_ISA_IO_PROTOCOL instance
+  @param  BaseAddress - Serial port register group base address
+  @param  Offset      - Offset in register group
+  @param  Data        - data which is to be written to some serial port register
+
+**/
 VOID
 IsaSerialWritePort (
   IN EFI_ISA_IO_PROTOCOL                 *IsaIo,
@@ -1891,24 +1795,6 @@ IsaSerialWritePort (
   IN UINT32                              Offset,
   IN UINT8                               Data
   )
-/*++
-
-  Routine Description:
-
-    Use IsaIo protocol to write serial port
-
-  Arguments:
-
-    IsaIo       - Pointer to EFI_ISA_IO_PROTOCOL instance
-    BaseAddress - Serial port register group base address
-    Offset      - Offset in register group
-    Data        - data which is to be written to some serial port register
-
-  Returns:
-
-    None
-
---*/
 {
   //
   // Use IsaIo to access IO

IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdCtrller.c

@@ -635,26 +635,20 @@ ConvertKeyboardScanCodeToEfiKey[] = {
 //
 STATIC UINTN  mWaitForValueTimeOut = KEYBOARD_WAITFORVALUE_TIMEOUT;
 
+/**
+  Read data register 
+
+  @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV
+
+  @return return the value 
+
+**/
 STATIC
 UINT8
 KeyReadDataRegister (
   IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn
   )
-/*++
 
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  ConsoleIn - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   EFI_ISA_IO_PROTOCOL                 *IsaIo;
   UINT8                               Data;
@@ -675,28 +669,20 @@ Returns:
   return Data;
 }
 
+/**
+  Write data register
+
+  @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV
+  @param Data      value wanted to be written
+
+**/
 STATIC
 VOID
 KeyWriteDataRegister (
   IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,
   IN UINT8                   Data
   )
-/*++
 
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  ConsoleIn - GC_TODO: add argument description
-  Data      - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   EFI_ISA_IO_PROTOCOL                 *IsaIo;
 
@@ -718,25 +704,18 @@ Returns:
   //
 }
 
+/**
+  Read status register
+
+  @param ConsoleIn  Pointer to instance of KEYBOARD_CONSOLE_IN_DEV
+
+  @return value in status register
+
+**/
 UINT8
 KeyReadStatusRegister (
   IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  ConsoleIn - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   EFI_ISA_IO_PROTOCOL                 *IsaIo;
   UINT8                               Data;
@@ -758,28 +737,20 @@ Returns:
 
 }
 
+/**
+  Write command register 
+
+  @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV
+  @param Data      The value wanted to be written
+
+**/
+
 STATIC
 VOID
 KeyWriteCommandRegister (
   IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,
   IN UINT8                   Data
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  ConsoleIn - GC_TODO: add argument description
-  Data      - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   EFI_ISA_IO_PROTOCOL                 *IsaIo;
 
@@ -798,25 +769,19 @@ Returns:
 
 }
 
+/**
+  Display error message
+
+  @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV
+  @param ErrMsg    Unicode string of error message
+  
+**/
 STATIC
 VOID
 KeyboardError (
   IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,
   IN CHAR16                  *ErrMsg
   )
-/*++
-
-Routine Description:
-
-  Display error message
-
-Arguments:
-
-Returns:
-
---*/
-// GC_TODO:    ConsoleIn - add argument and description to function comment
-// GC_TODO:    ErrMsg - add argument and description to function comment
 {
   ConsoleIn->KeyboardErr = TRUE;
 
@@ -826,30 +791,24 @@ Returns:
   //
 }
 
-VOID
+/**
-EFIAPI
-KeyboardTimerHandler (
-  IN EFI_EVENT    Event,
-  IN VOID         *Context
-  )
-/*++
-
-Routine Description:
-
   Timer event handler: read a series of scancodes from 8042
   and put them into memory scancode buffer.
   it read as much scancodes to either fill
   the memory buffer or empty the keyboard buffer.
   It is registered as running under TPL_NOTIFY
 
-Arguments:
+  @param Event - The timer event
+  @param Context - A KEYBOARD_CONSOLE_IN_DEV pointer
 
-  Event - The timer event
+**/
-  Context - A KEYBOARD_CONSOLE_IN_DEV pointer
+VOID
+EFIAPI
+KeyboardTimerHandler (
+  IN EFI_EVENT    Event,
+  IN VOID         *Context
+  )
 
-Returns:
-
---*/
 {
   UINT8                   Data;
   EFI_TPL                 OldTpl;
@@ -942,6 +901,17 @@ Returns:
   return ;
 }
 
+/**
+  Read several bytes from the scancode buffer without removing them.
+  This function is called to see if there are enough bytes of scancode
+  representing a single key.
+
+  @param Count - Number of bytes to be read
+  @param Buf - Store the results
+
+  @retval EFI_SUCCESS success to scan the keyboard code
+  @retval EFI_NOT_READY invalid parameter
+**/
 STATIC
 EFI_STATUS
 GetScancodeBufHead (
@@ -949,27 +919,6 @@ GetScancodeBufHead (
   IN UINT32                  Count,
   OUT UINT8                  *Buf
   )
-/*++
-
-Routine Description:
-
-  Read several bytes from the scancode buffer without removing them.
-  This function is called to see if there are enough bytes of scancode
-  representing a single key.
-
-Arguments:
-
-  Count - Number of bytes to be read
-  Buf - Store the results
-
-Returns:
-
-  EFI_STATUS
-
---*/
-// GC_TODO:    ConsoleIn - add argument and description to function comment
-// GC_TODO:    EFI_NOT_READY - add return value to function comment
-// GC_TODO:    EFI_SUCCESS - add return value to function comment
 {
   UINT32  Index;
   UINT32  Pos;
@@ -1005,6 +954,17 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+
+  Read & remove several bytes from the scancode buffer.
+  This function is usually called after GetScancodeBufHead()
+
+  @param Count - Number of bytes to be read
+  @param Buf - Store the results
+
+  @retval EFI_SUCCESS success to scan the keyboard code
+  @retval EFI_NOT_READY invalid parameter
+**/
 STATIC
 EFI_STATUS
 PopScancodeBufHead (
@@ -1012,26 +972,6 @@ PopScancodeBufHead (
   IN UINT32                 Count,
   OUT UINT8                 *Buf
   )
-/*++
-
-Routine Description:
-
-  Read & remove several bytes from the scancode buffer.
-  This function is usually called after GetScancodeBufHead()
-
-Arguments:
-
-  Count - Number of bytes to be read
-  Buf - Store the results
-
-Returns:
-
-  EFI_STATUS
-
---*/
-// GC_TODO:    ConsoleIn - add argument and description to function comment
-// GC_TODO:    EFI_NOT_READY - add return value to function comment
-// GC_TODO:    EFI_SUCCESS - add return value to function comment
 {
   UINT32  Index;
 
@@ -1068,28 +1008,22 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Read key value 
+
+  @param ConsoleIn - Pointer to instance of KEYBOARD_CONSOLE_IN_DEV
+  @param Data      - Pointer to outof buffer for keeping key value
+
+  @retval EFI_TIMEOUT Status resigter time out
+  @retval EFI_SUCCESS Success to read keyboard
+
+**/
 EFI_STATUS
 KeyboardRead (
   IN KEYBOARD_CONSOLE_IN_DEV  *ConsoleIn,
   OUT UINT8                   *Data
   )
-/*++
 
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  ConsoleIn - GC_TODO: add argument description
-  Data      - GC_TODO: add argument description
-
-Returns:
-
-  EFI_TIMEOUT - GC_TODO: Add description for return value
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   UINT32  TimeOut;
   UINT32  RegFilled;
@@ -1117,29 +1051,22 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  write key to keyboard
+
+  @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV
+  @param Data      value wanted to be written
+
+  @retval EFI_TIMEOUT - GC_TODO: Add description for return value
+  @retval EFI_SUCCESS - GC_TODO: Add description for return value
+
+**/
 STATIC
 EFI_STATUS
 KeyboardWrite (
   IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,
   IN UINT8                   Data
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  ConsoleIn - GC_TODO: add argument description
-  Data      - GC_TODO: add argument description
-
-Returns:
-
-  EFI_TIMEOUT - GC_TODO: Add description for return value
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   UINT32  TimeOut;
   UINT32  RegEmptied;
@@ -1170,30 +1097,22 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Issue keyboard command
+
+  @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV
+  @param Data      The buff holding the command 
+
+  @retval EFI_TIMEOUT Keyboard is not ready to issuing 
+  @retval EFI_SUCCESS Success to issue keyboard command
+
+**/
 STATIC
 EFI_STATUS
 KeyboardCommand (
   IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,
   IN UINT8                   Data
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  ConsoleIn - GC_TODO: add argument description
-  Data      - GC_TODO: add argument description
-
-Returns:
-
-  EFI_TIMEOUT - GC_TODO: Add description for return value
-  EFI_TIMEOUT - GC_TODO: Add description for return value
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   UINT32  TimeOut;
   UINT32  RegEmptied;
@@ -1241,32 +1160,24 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  wait for a specific value to be presented on
+  8042 Data register by keyboard and then read it,
+  used in keyboard commands ack
+
+  @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV
+  @param Value     the value wanted to be waited.
+
+  @retval EFI_TIMEOUT Fail to get specific value in given time
+  @retval EFI_SUCCESS Success to get specific value in given time.
+  
+**/
 STATIC
 EFI_STATUS
 KeyboardWaitForValue (
   IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,
   IN UINT8                   Value
   )
-/*++
-
-Routine Description:
-
-  wait for a specific value to be presented on
-  8042 Data register by keyboard and then read it,
-  used in keyboard commands ack
-
-Arguments:
-
-  ConsoleIn - The KEYBOARD_CONSOLE_IN_DEV instance pointer
-  Value - The value to be waited for
-
-Returns:
-
-  EFI_STATUS
-
---*/
-// GC_TODO:    EFI_SUCCESS - add return value to function comment
-// GC_TODO:    EFI_TIMEOUT - add return value to function comment
 {
   UINT8   Data;
   UINT32  TimeOut;
@@ -1324,23 +1235,19 @@ Returns:
 
 }
 
+/**
+  Show keyboard status lights according to
+  indicators in ConsoleIn.
+
+  @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV
+  
+  @return status
+
+**/
 EFI_STATUS
 UpdateStatusLights (
   IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn
   )
-/*++
-
-Routine Description:
-
-  Show keyboard status lights according to
-  indicators in ConsoleIn.
-
-Arguments:
-
-Returns:
-
---*/
-// GC_TODO:    ConsoleIn - add argument and description to function comment
 {
   EFI_STATUS  Status;
   UINT8       Command;
@@ -1381,28 +1288,21 @@ Returns:
   return Status;
 }
 
-EFI_STATUS
+/**
-KeyGetchar (
-  IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn
-  )
-/*++
-
-Routine Description:
-
   Get scancode from scancode buffer
   and translate into EFI-scancode and unicode defined by EFI spec
   The function is always called in TPL_NOTIFY
 
-Arguments:
+  @param ConsoleIn KEYBOARD_CONSOLE_IN_DEV instance pointer
 
-  ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer
+  @retval EFI_NOT_READY - Input from console not ready yet.
+  @retval EFI_SUCCESS   - Function executed successfully.
 
-Returns:
+**/
-
+EFI_STATUS
-  EFI_NOT_READY - Input from console not ready yet.
+KeyGetchar (
-  EFI_SUCCESS   - Function executed successfully.
+  IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn
-
+  )
---*/
 {
   EFI_STATUS  Status;
   UINT8       ScanCode;
@@ -1740,32 +1640,22 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Perform 8042 controller and keyboard Initialization
+  If ExtendedVerification is TRUE, do additional test for
+  the keyboard interface
+
+  @param ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer
+  @param ExtendedVerification - indicates a thorough initialization
+
+  @retval EFI_DEVICE_ERROR Fail to init keyboard
+  @retval EFI_SUCCESS      Success to init keyboard
+**/
 EFI_STATUS
 InitKeyboard (
   IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,
   IN BOOLEAN                     ExtendedVerification
   )
-/*++
-
-Routine Description:
-
-  Perform 8042 controller and keyboard Initialization
-  If ExtendedVerification is TRUE, do additional test for
-  the keyboard interface
-
-Arguments:
-
-  ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer
-  ExtendedVerification - indicates a thorough initialization
-
-Returns:
-
-  EFI_STATUS
-
---*/
-// GC_TODO:    EFI_DEVICE_ERROR - add return value to function comment
-// GC_TODO:    EFI_SUCCESS - add return value to function comment
-// GC_TODO:    EFI_DEVICE_ERROR - add return value to function comment
 {
   EFI_STATUS              Status;
   EFI_STATUS              Status1;
@@ -2086,26 +1976,18 @@ Done:
 
 }
 
+/**
+  Disable the keyboard interface of the 8042 controller
+
+  @param ConsoleIn   - the device instance
+
+  @return status of issuing disable command
+
+**/
 EFI_STATUS
 DisableKeyboard (
   IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn
   )
-/*++
-
-Routine Description:
-
-  Disable the keyboard interface of the 8042 controller
-
-Arguments:
-
-  ConsoleIn   - the device instance
-
-Returns:
-
-  EFI_STATUS
-
---*/
-// GC_TODO:    EFI_DEVICE_ERROR - add return value to function comment
 {
   EFI_STATUS  Status;
 
@@ -2170,3 +2052,4 @@ CheckKeyboardConnect (
 
   return TRUE;
 }
+

IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c

@@ -45,54 +45,48 @@ KeyboardCheckForKey (
   IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This
   );
 
+/**
+  @param RegsiteredData    - A pointer to a buffer that is filled in with the keystroke 
+                      state data for the key that was registered.
+  @param InputData         - A pointer to a buffer that is filled in with the keystroke 
+                      state data for the key that was pressed.
+
+  @retval TRUE              - Key be pressed matches a registered key.
+  @retval FALSE             - Match failed. 
+  
+**/
 STATIC
 BOOLEAN
 IsKeyRegistered (
   IN EFI_KEY_DATA  *RegsiteredData,
   IN EFI_KEY_DATA  *InputData
   )
-/*++
-
-Routine Description:
-
-Arguments:
-
-  RegsiteredData    - A pointer to a buffer that is filled in with the keystroke 
-                      state data for the key that was registered.
-  InputData         - A pointer to a buffer that is filled in with the keystroke 
-                      state data for the key that was pressed.
-
-Returns:
-  TRUE              - Key be pressed matches a registered key.
-  FLASE             - Match failed. 
-  
---*/
 ;
+
+/**
+    Reads the next keystroke from the input device. The WaitForKey Event can 
+    be used to test for existance of a keystroke via WaitForEvent () call.
+
+  
+    @param ConsoleInDev          - Ps2 Keyboard private structure
+    @param KeyData               - A pointer to a buffer that is filled in with the keystroke 
+                            state data for the key that was pressed.
+
+  
+    @retval EFI_SUCCESS           - The keystroke information was returned.
+    @retval EFI_NOT_READY         - There was no keystroke data availiable.
+    @retval EFI_DEVICE_ERROR      - The keystroke information was not returned due to 
+                            hardware errors.
+    @retval EFI_INVALID_PARAMETER - KeyData is NULL.                        
+
+**/
 STATIC
 EFI_STATUS
 KeyboardReadKeyStrokeWorker (
   IN  KEYBOARD_CONSOLE_IN_DEV           *ConsoleInDev,
   OUT EFI_KEY_DATA                      *KeyData
   )
-/*++
 
-  Routine Description:
-    Reads the next keystroke from the input device. The WaitForKey Event can 
-    be used to test for existance of a keystroke via WaitForEvent () call.
-
-  Arguments:
-    ConsoleInDev          - Ps2 Keyboard private structure
-    KeyData               - A pointer to a buffer that is filled in with the keystroke 
-                            state data for the key that was pressed.
-
-  Returns:
-    EFI_SUCCESS           - The keystroke information was returned.
-    EFI_NOT_READY         - There was no keystroke data availiable.
-    EFI_DEVICE_ERROR      - The keystroke information was not returned due to 
-                            hardware errors.
-    EFI_INVALID_PARAMETER - KeyData is NULL.                        
-
---*/
 {
   EFI_STATUS                            Status;
   EFI_TPL                               OldTpl;
@@ -161,29 +155,23 @@ KeyboardReadKeyStrokeWorker (
   return EFI_SUCCESS;
 }
 
+/**
+  logic reset keyboard
+  Implement SIMPLE_TEXT_IN.Reset()
+  Perform 8042 controller and keyboard initialization
+
+  @param This    Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL
+  @param ExtendedVerification Indicate that the driver may perform a more 
+                              exhaustive verification operation of the device during 
+                              reset, now this par is ignored in this driver    
+
+**/
 EFI_STATUS
 EFIAPI
 KeyboardEfiReset (
   IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *This,
   IN  BOOLEAN                         ExtendedVerification
   )
-/*++
-
-Routine Description:
-
-  Implement SIMPLE_TEXT_IN.Reset()
-  Perform 8042 controller and keyboard initialization
-
-Arguments:
-
-Returns:
-
---*/
-// GC_TODO:    This - add argument and description to function comment
-// GC_TODO:    ExtendedVerification - add argument and description to function comment
-// GC_TODO:    EFI_DEVICE_ERROR - add return value to function comment
-// GC_TODO:    EFI_DEVICE_ERROR - add return value to function comment
-// GC_TODO:    EFI_SUCCESS - add return value to function comment
 {
   EFI_STATUS              Status;
   KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;
@@ -251,29 +239,21 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Implement SIMPLE_TEXT_IN.ReadKeyStroke().
+  Retrieve key values for driver user.
+
+  @param This    Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL
+  @param Key     The output buffer for key value 
+
+  @retval EFI_SUCCESS success to read key stroke
+**/
 EFI_STATUS
 EFIAPI
 KeyboardReadKeyStroke (
   IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *This,
   OUT EFI_INPUT_KEY                   *Key
   )
-/*++
-
-Routine Description:
-
-  Implement SIMPLE_TEXT_IN.ReadKeyStroke().
-  Retrieve key values for driver user.
-
-Arguments:
-
-Returns:
-
---*/
-// GC_TODO:    This - add argument and description to function comment
-// GC_TODO:    Key - add argument and description to function comment
-// GC_TODO:    EFI_DEVICE_ERROR - add return value to function comment
-// GC_TODO:    EFI_NOT_READY - add return value to function comment
-// GC_TODO:    EFI_SUCCESS - add return value to function comment
 {
   EFI_STATUS              Status;
   KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;
@@ -290,26 +270,20 @@ Returns:
   
 }
 
+/**
+  Event notification function for SIMPLE_TEXT_IN.WaitForKey event
+  Signal the event if there is key available
+
+  @param Event    the event object
+  @param Context  waitting context
+
+**/
 VOID
 EFIAPI
 KeyboardWaitForKey (
   IN  EFI_EVENT               Event,
   IN  VOID                    *Context
   )
-/*++
-
-Routine Description:
-
-  Event notification function for SIMPLE_TEXT_IN.WaitForKey event
-  Signal the event if there is key available
-
-Arguments:
-
-Returns:
-
---*/
-// GC_TODO:    Event - add argument and description to function comment
-// GC_TODO:    Context - add argument and description to function comment
 {
   EFI_TPL                 OldTpl;
   KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;
@@ -343,25 +317,17 @@ Returns:
   return ;
 }
 
+/**
+  Check keyboard for given key value
+  
+  @param  This  Point to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL
+  
+  @retval EFI_SUCCESS success check keyboard value
+**/
 EFI_STATUS
 KeyboardCheckForKey (
   IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  This  - GC_TODO: add argument description
-
-Returns:
-
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;
 
@@ -377,28 +343,25 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Judge whether is a registed key
+
+  @param RegsiteredData    - A pointer to a buffer that is filled in with the keystroke 
+                      state data for the key that was registered.
+  @param InputData         - A pointer to a buffer that is filled in with the keystroke 
+                      state data for the key that was pressed.
+
+  @retval TRUE              - Key be pressed matches a registered key.
+  @retval FLASE             - Match failed. 
+  
+**/
 STATIC
 BOOLEAN
 IsKeyRegistered (
   IN EFI_KEY_DATA  *RegsiteredData,
   IN EFI_KEY_DATA  *InputData
   )
-/*++
 
-Routine Description:
-
-Arguments:
-
-  RegsiteredData    - A pointer to a buffer that is filled in with the keystroke 
-                      state data for the key that was registered.
-  InputData         - A pointer to a buffer that is filled in with the keystroke 
-                      state data for the key that was pressed.
-
-Returns:
-  TRUE              - Key be pressed matches a registered key.
-  FLASE             - Match failed. 
-  
---*/
 {
   ASSERT (RegsiteredData != NULL && InputData != NULL);
   
@@ -423,24 +386,21 @@ Returns:
 
 }
 
+/**
+  Event notification function for SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event
+  Signal the event if there is key available
+
+  @param Event    event object
+  @param Context  waiting context
+
+**/
 VOID
 EFIAPI
 KeyboardWaitForKeyEx (
   IN  EFI_EVENT               Event,
   IN  VOID                    *Context
   )
-/*++
 
-Routine Description:
-
-  Event notification function for SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event
-  Signal the event if there is key available
-
-Arguments:
-
-Returns:
-
---*/
 {
   KEYBOARD_CONSOLE_IN_DEV               *ConsoleInDev;
 
@@ -449,27 +409,24 @@ Returns:
   
 }
 
+/**
+  Reset the input device and optionaly run diagnostics
+
+  @param This                 - Protocol instance pointer.
+  @param ExtendedVerification - Driver may perform diagnostics on reset.
+
+  @retval EFI_SUCCESS           - The device was reset.
+  @retval EFI_DEVICE_ERROR      - The device is not functioning properly and could 
+                                  not be reset.
+
+**/
 EFI_STATUS
 EFIAPI
 KeyboardEfiResetEx (
   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,
   IN BOOLEAN                            ExtendedVerification
   )
-/*++
 
-  Routine Description:
-    Reset the input device and optionaly run diagnostics
-
-  Arguments:
-    This                 - Protocol instance pointer.
-    ExtendedVerification - Driver may perform diagnostics on reset.
-
-  Returns:
-    EFI_SUCCESS           - The device was reset.
-    EFI_DEVICE_ERROR      - The device is not functioning properly and could 
-                            not be reset.
-
---*/
 {
   EFI_STATUS                            Status;
   KEYBOARD_CONSOLE_IN_DEV               *ConsoleInDev;
@@ -498,31 +455,29 @@ KeyboardEfiResetEx (
   return EFI_SUCCESS;
 }
 
+/**
+    Reads the next keystroke from the input device. The WaitForKey Event can 
+    be used to test for existance of a keystroke via WaitForEvent () call.
+
+
+    @param This       - Protocol instance pointer.
+    @param KeyData    - A pointer to a buffer that is filled in with the keystroke 
+                 state data for the key that was pressed.
+
+    @retval EFI_SUCCESS           - The keystroke information was returned.
+    @retval EFI_NOT_READY         - There was no keystroke data availiable.
+    @retval EFI_DEVICE_ERROR      - The keystroke information was not returned due to 
+                            hardware errors.
+    @retval EFI_INVALID_PARAMETER - KeyData is NULL.                        
+
+**/
 EFI_STATUS
 EFIAPI
 KeyboardReadKeyStrokeEx (
   IN  EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
   OUT EFI_KEY_DATA                      *KeyData
   )
-/*++
 
-  Routine Description:
-    Reads the next keystroke from the input device. The WaitForKey Event can 
-    be used to test for existance of a keystroke via WaitForEvent () call.
-
-  Arguments:
-    This       - Protocol instance pointer.
-    KeyData    - A pointer to a buffer that is filled in with the keystroke 
-                 state data for the key that was pressed.
-
-  Returns:
-    EFI_SUCCESS           - The keystroke information was returned.
-    EFI_NOT_READY         - There was no keystroke data availiable.
-    EFI_DEVICE_ERROR      - The keystroke information was not returned due to 
-                            hardware errors.
-    EFI_INVALID_PARAMETER - KeyData is NULL.                        
-
---*/
 {
   KEYBOARD_CONSOLE_IN_DEV               *ConsoleInDev;
 
@@ -535,30 +490,27 @@ KeyboardReadKeyStrokeEx (
   
 }
 
+/**
+  Set certain state for the input device.
+
+  @param This              - Protocol instance pointer.
+  @param KeyToggleState    - A pointer to the EFI_KEY_TOGGLE_STATE to set the 
+                        state for the input device.
+
+  @retval EFI_SUCCESS           - The device state was set successfully.
+  @retval EFI_DEVICE_ERROR      - The device is not functioning correctly and could 
+                            not have the setting adjusted.
+  @retval EFI_UNSUPPORTED       - The device does not have the ability to set its state.
+  @retval EFI_INVALID_PARAMETER - KeyToggleState is NULL.                       
+
+**/   
 EFI_STATUS
 EFIAPI
 KeyboardSetState (
   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,
   IN EFI_KEY_TOGGLE_STATE               *KeyToggleState
   )
-/*++
 
-  Routine Description:
-    Set certain state for the input device.
-
-  Arguments:
-    This              - Protocol instance pointer.
-    KeyToggleState    - A pointer to the EFI_KEY_TOGGLE_STATE to set the 
-                        state for the input device.
-
-  Returns:
-    EFI_SUCCESS           - The device state was set successfully.
-    EFI_DEVICE_ERROR      - The device is not functioning correctly and could 
-                            not have the setting adjusted.
-    EFI_UNSUPPORTED       - The device does not have the ability to set its state.
-    EFI_INVALID_PARAMETER - KeyToggleState is NULL.                       
-
---*/   
 {
   EFI_STATUS                            Status;
   KEYBOARD_CONSOLE_IN_DEV               *ConsoleInDev;
@@ -619,6 +571,22 @@ Exit:
   return Status;
 
 }
+
+/**
+    Register a notification function for a particular keystroke for the input device.
+
+    @param This                    - Protocol instance pointer.
+    @param KeyData                 - A pointer to a buffer that is filled in with the keystroke 
+                              information data for the key that was pressed.
+    @param KeyNotificationFunction - Points to the function to be called when the key 
+                              sequence is typed specified by KeyData.                        
+    @param NotifyHandle            - Points to the unique handle assigned to the registered notification.                          
+
+    @retval EFI_SUCCESS             - The notification function was registered successfully.
+    @retval EFI_OUT_OF_RESOURCES    - Unable to allocate resources for necesssary data structures.
+    @retval EFI_INVALID_PARAMETER   - KeyData or NotifyHandle is NULL.                       
+                              
+**/   
 EFI_STATUS
 EFIAPI
 KeyboardRegisterKeyNotify (
@@ -627,25 +595,6 @@ KeyboardRegisterKeyNotify (
   IN EFI_KEY_NOTIFY_FUNCTION            KeyNotificationFunction,
   OUT EFI_HANDLE                        *NotifyHandle
   )
-/*++
-
-  Routine Description:
-    Register a notification function for a particular keystroke for the input device.
-
-  Arguments:
-    This                    - Protocol instance pointer.
-    KeyData                 - A pointer to a buffer that is filled in with the keystroke 
-                              information data for the key that was pressed.
-    KeyNotificationFunction - Points to the function to be called when the key 
-                              sequence is typed specified by KeyData.                        
-    NotifyHandle            - Points to the unique handle assigned to the registered notification.                          
-
-  Returns:
-    EFI_SUCCESS             - The notification function was registered successfully.
-    EFI_OUT_OF_RESOURCES    - Unable to allocate resources for necesssary data structures.
-    EFI_INVALID_PARAMETER   - KeyData or NotifyHandle is NULL.                       
-                              
---*/   
 {
   EFI_STATUS                            Status;
   KEYBOARD_CONSOLE_IN_DEV               *ConsoleInDev;
@@ -720,27 +669,24 @@ Exit:
 
 }
 
+/**
+    Remove a registered notification function from a particular keystroke.
+
+    @param This                    - Protocol instance pointer.    
+    @param NotificationHandle      - The handle of the notification function being unregistered.
+
+  
+    @retval EFI_SUCCESS             - The notification function was unregistered successfully.
+    @retval EFI_INVALID_PARAMETER   - The NotificationHandle is invalid.
+    @retval EFI_NOT_FOUND           - Can not find the matching entry in database.  
+                              
+**/   
 EFI_STATUS
 EFIAPI
 KeyboardUnregisterKeyNotify (
   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,
   IN EFI_HANDLE                         NotificationHandle
   )
-/*++
-
-  Routine Description:
-    Remove a registered notification function from a particular keystroke.
-
-  Arguments:
-    This                    - Protocol instance pointer.    
-    NotificationHandle      - The handle of the notification function being unregistered.
-
-  Returns:
-    EFI_SUCCESS             - The notification function was unregistered successfully.
-    EFI_INVALID_PARAMETER   - The NotificationHandle is invalid.
-    EFI_NOT_FOUND           - Can not find the matching entry in database.  
-                              
---*/   
 {
   EFI_STATUS                            Status;
   KEYBOARD_CONSOLE_IN_DEV               *ConsoleInDev;

IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.c

@@ -62,6 +62,16 @@ EFI_DRIVER_BINDING_PROTOCOL gKeyboardControllerDriver = {
   NULL
 };
 
+/**
+  Test controller is a keyboard Controller
+  
+  @param This                 Pointer of EFI_DRIVER_BINDING_PROTOCOL
+  @param Controller           driver's controller
+  @param RemainingDevicePath  children device path
+  
+  @retval EFI_UNSUPPORTED controller is not floppy disk
+  @retval EFI_SUCCESS     controller is floppy disk
+**/
 EFI_STATUS
 EFIAPI
 KbdControllerDriverSupported (
@@ -69,20 +79,6 @@ KbdControllerDriverSupported (
   IN EFI_HANDLE                     Controller,
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
   )
-/*++
-
-Routine Description:
-
-  ControllerDriver Protocol Method
-
-Arguments:
-
-Returns:
-
---*/
-// GC_TODO:    This - add argument and description to function comment
-// GC_TODO:    Controller - add argument and description to function comment
-// GC_TODO:    RemainingDevicePath - add argument and description to function comment
 {
   EFI_STATUS                          Status;
   EFI_ISA_IO_PROTOCOL                 *IsaIo;
@@ -120,6 +116,15 @@ Returns:
   return Status;
 }
 
+/**
+  Create KEYBOARD_CONSOLE_IN_DEV instance on controller.
+  
+  @param This         Pointer of EFI_DRIVER_BINDING_PROTOCOL
+  @param Controller   driver controller handle
+  @param RemainingDevicePath Children's device path
+  
+  @retval whether success to create floppy control instance.
+**/
 EFI_STATUS
 EFIAPI
 KbdControllerDriverStart (
@@ -127,19 +132,6 @@ KbdControllerDriverStart (
   IN EFI_HANDLE                     Controller,
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
   )
-/*++
-
-Routine Description:
-
-Arguments:
-
-Returns:
-
---*/
-// GC_TODO:    This - add argument and description to function comment
-// GC_TODO:    Controller - add argument and description to function comment
-// GC_TODO:    RemainingDevicePath - add argument and description to function comment
-// GC_TODO:    EFI_INVALID_PARAMETER - add return value to function comment
 {
   EFI_STATUS                                Status;
   EFI_STATUS                                Status1;
@@ -388,6 +380,20 @@ ErrorExit:
   return Status;
 }
 
+/**
+  Stop this driver on ControllerHandle. Support stoping any child handles
+  created by this driver.
+
+  @param  This              Protocol instance pointer.
+  @param  ControllerHandle  Handle of device to stop driver on
+  @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of
+                            children is zero stop the entire bus driver.
+  @param  ChildHandleBuffer List of Child Handles to Stop.
+
+  @retval EFI_SUCCESS       This driver is removed ControllerHandle
+  @retval other             This driver was not removed from this device
+
+**/
 EFI_STATUS
 EFIAPI
 KbdControllerDriverStop (
@@ -396,20 +402,6 @@ KbdControllerDriverStop (
   IN  UINTN                          NumberOfChildren,
   IN  EFI_HANDLE                     *ChildHandleBuffer
   )
-/*++
-
-  Routine Description:
-
-  Arguments:
-
-  Returns:
-
---*/
-// GC_TODO:    This - add argument and description to function comment
-// GC_TODO:    Controller - add argument and description to function comment
-// GC_TODO:    NumberOfChildren - add argument and description to function comment
-// GC_TODO:    ChildHandleBuffer - add argument and description to function comment
-// GC_TODO:    EFI_SUCCESS - add return value to function comment
 {
   EFI_STATUS                     Status;
   EFI_SIMPLE_TEXT_INPUT_PROTOCOL *ConIn;
@@ -517,25 +509,16 @@ KbdControllerDriverStop (
   return EFI_SUCCESS;
 }
 
+/**
+  Free the waiting key notify list.
+  
+  @param ListHead  Pointer to list head
+**/
 STATIC
 EFI_STATUS
 KbdFreeNotifyList (
   IN OUT LIST_ENTRY           *ListHead
   )
-/*++
-
-Routine Description:
-
-Arguments:
-
-  ListHead   - The list head
-
-Returns:
-
-  EFI_SUCCESS           - Free the notify list successfully
-  EFI_INVALID_PARAMETER - ListHead is invalid.
-
---*/
 {
   KEYBOARD_CONSOLE_IN_EX_NOTIFY *NotifyNode;
 
@@ -591,3 +574,4 @@ InitializePs2Keyboard(
 
   return Status;
 }
+

IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h

@@ -131,28 +131,22 @@ extern EFI_GUID                      gSimpleTextInExNotifyGuid;
 //
 // Driver entry point
 //
+/**
+  The user Entry Point for module Ps2Keyboard. The user code starts with this function.
+
+  @param[in] ImageHandle    The firmware allocated handle for the EFI image.  
+  @param[in] SystemTable    A pointer to the EFI System Table.
+  
+  @retval EFI_SUCCESS       The entry point is executed successfully.
+  @retval other             Some error occurs when executing this entry point.
+
+**/
 EFI_STATUS
 EFIAPI
 InstallPs2KeyboardDriver (
   IN EFI_HANDLE           ImageHandle,
   IN EFI_SYSTEM_TABLE     *SystemTable
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  ImageHandle - GC_TODO: add argument description
-  SystemTable - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
 #define KEYBOARD_8042_DATA_REGISTER     0x60
@@ -191,233 +185,170 @@ Returns:
 //
 // Other functions that are used among .c files
 //
+/**
+  Show keyboard status lights according to
+  indicators in ConsoleIn.
 
+  @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV
+  
+  @return status
+
+**/
 EFI_STATUS
 UpdateStatusLights (
   IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn
   )
-/*++
-
-Routine Description:
-
-  Show keyboard status light for ScrollLock, NumLock and CapsLock
-  according to indicators in ConsoleIn.
-
-Arguments:
-
-  ConsoleIn   - driver private structure
-
-Returns:
-
-  EFI_SUCCESS - Show the status light successfully.
-  EFI_TIMEOUT - Timeout when operating read/write on registers.
-
---*/  
 ;
 
+/**
+  write key to keyboard
+
+  @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV
+  @param Data      value wanted to be written
+
+  @retval EFI_TIMEOUT - GC_TODO: Add description for return value
+  @retval EFI_SUCCESS - GC_TODO: Add description for return value
+
+**/
 EFI_STATUS
 KeyboardRead (
   IN KEYBOARD_CONSOLE_IN_DEV  *ConsoleIn,
   OUT UINT8                   *Data
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  ConsoleIn - GC_TODO: add argument description
-  Data      - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Get scancode from scancode buffer
+  and translate into EFI-scancode and unicode defined by EFI spec
+  The function is always called in TPL_NOTIFY
+
+  @param ConsoleIn KEYBOARD_CONSOLE_IN_DEV instance pointer
+
+  @retval EFI_NOT_READY - Input from console not ready yet.
+  @retval EFI_SUCCESS   - Function executed successfully.
+
+**/
 EFI_STATUS
 KeyGetchar (
   IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  ConsoleIn - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Perform 8042 controller and keyboard Initialization
+  If ExtendedVerification is TRUE, do additional test for
+  the keyboard interface
+
+  @param ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer
+  @param ExtendedVerification - indicates a thorough initialization
+
+  @retval EFI_DEVICE_ERROR Fail to init keyboard
+  @retval EFI_SUCCESS      Success to init keyboard
+**/
 EFI_STATUS
 InitKeyboard (
   IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,
   IN BOOLEAN                     ExtendedVerification
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  ConsoleIn             - GC_TODO: add argument description
-  ExtendedVerification  - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Disable the keyboard interface of the 8042 controller
+
+  @param ConsoleIn   - the device instance
+
+  @return status of issuing disable command
+
+**/
 EFI_STATUS
 DisableKeyboard (
   IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  ConsoleIn - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Timer event handler: read a series of scancodes from 8042
+  and put them into memory scancode buffer.
+  it read as much scancodes to either fill
+  the memory buffer or empty the keyboard buffer.
+  It is registered as running under TPL_NOTIFY
+
+  @param Event - The timer event
+  @param Context - A KEYBOARD_CONSOLE_IN_DEV pointer
+
+**/
 VOID
 EFIAPI
 KeyboardTimerHandler (
   IN EFI_EVENT    Event,
   IN VOID         *Context
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  Event   - GC_TODO: add argument description
-  Context - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  logic reset keyboard
+  Implement SIMPLE_TEXT_IN.Reset()
+  Perform 8042 controller and keyboard initialization
+
+  @param This    Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL
+  @param ExtendedVerification Indicate that the driver may perform a more 
+                              exhaustive verification operation of the device during 
+                              reset, now this par is ignored in this driver    
+
+**/
 EFI_STATUS
 EFIAPI
 KeyboardEfiReset (
   IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *This,
   IN  BOOLEAN                         ExtendedVerification
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  This                  - GC_TODO: add argument description
-  ExtendedVerification  - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Implement SIMPLE_TEXT_IN.ReadKeyStroke().
+  Retrieve key values for driver user.
+
+  @param This    Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL
+  @param Key     The output buffer for key value 
+
+  @retval EFI_SUCCESS success to read key stroke
+**/
 EFI_STATUS
 EFIAPI
 KeyboardReadKeyStroke (
   IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *This,
   OUT EFI_INPUT_KEY                   *Key
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  This  - GC_TODO: add argument description
-  Key   - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Event notification function for SIMPLE_TEXT_IN.WaitForKey event
+  Signal the event if there is key available
+
+  @param Event    the event object
+  @param Context  waitting context
+
+**/
 VOID
 EFIAPI
 KeyboardWaitForKey (
   IN  EFI_EVENT               Event,
   IN  VOID                    *Context
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  Event   - GC_TODO: add argument description
-  Context - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Read status register
+
+  @param ConsoleIn  Pointer to instance of KEYBOARD_CONSOLE_IN_DEV
+
+  @return value in status register
+
+**/
 UINT8
 KeyReadStatusRegister (
   IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  ConsoleIn - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
 /**
@@ -437,106 +368,106 @@ CheckKeyboardConnect (
   )
 ;
 
+/**
+  Event notification function for SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event
+  Signal the event if there is key available
+
+  @param Event    event object
+  @param Context  waiting context
+
+**/
 VOID
 EFIAPI
 KeyboardWaitForKeyEx (
   IN  EFI_EVENT               Event,
   IN  VOID                    *Context
   )
-/*++
-
-Routine Description:
-
-  Event notification function for SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event
-  Signal the event if there is key available
-
-Arguments:
-
-Returns:
-
---*/    
 ;  
 
 //
 // Simple Text Input Ex protocol function prototypes
 //
 
+/**
+  Reset the input device and optionaly run diagnostics
+
+  @param This                 - Protocol instance pointer.
+  @param ExtendedVerification - Driver may perform diagnostics on reset.
+
+  @retval EFI_SUCCESS           - The device was reset.
+  @retval EFI_DEVICE_ERROR      - The device is not functioning properly and could 
+                                  not be reset.
+
+**/
 EFI_STATUS
 EFIAPI
 KeyboardEfiResetEx (
   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,
   IN BOOLEAN                            ExtendedVerification
   )
-/*++
-
-  Routine Description:
-    Reset the input device and optionaly run diagnostics
-
-  Arguments:
-    This                 - Protocol instance pointer.
-    ExtendedVerification - Driver may perform diagnostics on reset.
-
-  Returns:
-    EFI_SUCCESS           - The device was reset.
-    EFI_DEVICE_ERROR      - The device is not functioning properly and could 
-                            not be reset.
-
---*/
 ;
 
+/**
+    Reads the next keystroke from the input device. The WaitForKey Event can 
+    be used to test for existance of a keystroke via WaitForEvent () call.
+
+
+    @param This       - Protocol instance pointer.
+    @param KeyData    - A pointer to a buffer that is filled in with the keystroke 
+                 state data for the key that was pressed.
+
+    @retval EFI_SUCCESS           - The keystroke information was returned.
+    @retval EFI_NOT_READY         - There was no keystroke data availiable.
+    @retval EFI_DEVICE_ERROR      - The keystroke information was not returned due to 
+                            hardware errors.
+    @retval EFI_INVALID_PARAMETER - KeyData is NULL.                        
+
+**/
 EFI_STATUS
 EFIAPI
 KeyboardReadKeyStrokeEx (
   IN  EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
   OUT EFI_KEY_DATA                      *KeyData
   )
-/*++
-
-  Routine Description:
-    Reads the next keystroke from the input device. The WaitForKey Event can 
-    be used to test for existance of a keystroke via WaitForEvent () call.
-
-  Arguments:
-    This       - Protocol instance pointer.
-    KeyData    - A pointer to a buffer that is filled in with the keystroke 
-                 state data for the key that was pressed.
-
-  Returns:
-    EFI_SUCCESS           - The keystroke information was returned.
-    EFI_NOT_READY         - There was no keystroke data availiable.
-    EFI_DEVICE_ERROR      - The keystroke information was not returned due to 
-                            hardware errors.
-    EFI_INVALID_PARAMETER - KeyData is NULL.                        
-
---*/
 ;
 
+/**
+  Set certain state for the input device.
+
+  @param This              - Protocol instance pointer.
+  @param KeyToggleState    - A pointer to the EFI_KEY_TOGGLE_STATE to set the 
+                        state for the input device.
+
+  @retval EFI_SUCCESS           - The device state was set successfully.
+  @retval EFI_DEVICE_ERROR      - The device is not functioning correctly and could 
+                            not have the setting adjusted.
+  @retval EFI_UNSUPPORTED       - The device does not have the ability to set its state.
+  @retval EFI_INVALID_PARAMETER - KeyToggleState is NULL.                       
+
+**/
 EFI_STATUS
 EFIAPI
 KeyboardSetState (
   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,
   IN EFI_KEY_TOGGLE_STATE               *KeyToggleState
   )
-/*++
-
-  Routine Description:
-    Set certain state for the input device.
-
-  Arguments:
-    This                  - Protocol instance pointer.
-    KeyToggleState        - A pointer to the EFI_KEY_TOGGLE_STATE to set the 
-                            state for the input device.
-                          
-  Returns:                
-    EFI_SUCCESS           - The device state was set successfully.
-    EFI_DEVICE_ERROR      - The device is not functioning correctly and could 
-                            not have the setting adjusted.
-    EFI_UNSUPPORTED       - The device does not have the ability to set its state.
-    EFI_INVALID_PARAMETER - KeyToggleState is NULL.                       
-
---*/   
 ;
 
+/**
+    Register a notification function for a particular keystroke for the input device.
+
+    @param This                    - Protocol instance pointer.
+    @param KeyData                 - A pointer to a buffer that is filled in with the keystroke 
+                              information data for the key that was pressed.
+    @param KeyNotificationFunction - Points to the function to be called when the key 
+                              sequence is typed specified by KeyData.                        
+    @param NotifyHandle            - Points to the unique handle assigned to the registered notification.                          
+
+    @retval EFI_SUCCESS             - The notification function was registered successfully.
+    @retval EFI_OUT_OF_RESOURCES    - Unable to allocate resources for necesssary data structures.
+    @retval EFI_INVALID_PARAMETER   - KeyData or NotifyHandle is NULL.                       
+                              
+**/   
 EFI_STATUS
 EFIAPI
 KeyboardRegisterKeyNotify (
@@ -545,48 +476,26 @@ KeyboardRegisterKeyNotify (
   IN EFI_KEY_NOTIFY_FUNCTION            KeyNotificationFunction,
   OUT EFI_HANDLE                        *NotifyHandle
   )
-/*++
-
-  Routine Description:
-    Register a notification function for a particular keystroke for the input device.
-
-  Arguments:
-    This                    - Protocol instance pointer.
-    KeyData                 - A pointer to a buffer that is filled in with the keystroke 
-                              information data for the key that was pressed.
-    KeyNotificationFunction - Points to the function to be called when the key 
-                              sequence is typed specified by KeyData.                        
-    NotifyHandle            - Points to the unique handle assigned to the registered notification.                          
-
-  Returns:
-    EFI_SUCCESS             - The notification function was registered successfully.
-    EFI_OUT_OF_RESOURCES    - Unable to allocate resources for necesssary data structures.
-    EFI_INVALID_PARAMETER   - KeyData or NotifyHandle is NULL.                       
-                              
---*/   
 ;
 
+/**
+    Remove a registered notification function from a particular keystroke.
+
+    @param This                    - Protocol instance pointer.    
+    @param NotificationHandle      - The handle of the notification function being unregistered.
+
+  
+    @retval EFI_SUCCESS             - The notification function was unregistered successfully.
+    @retval EFI_INVALID_PARAMETER   - The NotificationHandle is invalid.
+    @retval EFI_NOT_FOUND           - Can not find the matching entry in database.  
+                              
+**/ 
 EFI_STATUS
 EFIAPI
 KeyboardUnregisterKeyNotify (
   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,
   IN EFI_HANDLE                         NotificationHandle
   )
-/*++
-
-  Routine Description:
-    Remove a registered notification function from a particular keystroke.
-
-  Arguments:
-    This                    - Protocol instance pointer.    
-    NotificationHandle      - The handle of the notification function being unregistered.
-
-  Returns:
-    EFI_SUCCESS             - The notification function was unregistered successfully.
-    EFI_INVALID_PARAMETER   - The NotificationHandle is invalid.
-    EFI_NOT_FOUND           - Can not find the matching entry in database.  
-                              
---*/   
 ;
 
 #endif

IntelFrameworkModulePkg/Bus/Isa/Ps2MouseAbsolutePointerDxe/CommPs2.c

@@ -19,26 +19,18 @@ UINT8 SampleRateTbl[MAX_SR]   = { 0xa, 0x14, 0x28, 0x3c, 0x50, 0x64, 0xc8 };
 
 UINT8 ResolutionTbl[MAX_CMR]  = { 0, 1, 2, 3 };
 
+/**
+  Issue self test command via IsaIo interface.
+  
+  @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @return EFI_SUCCESS  Success to do keyboard self testing.
+  @return others       Fail to do keyboard self testing.
+**/
 EFI_STATUS
 KbcSelfTest (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   EFI_STATUS  Status;
   UINT8       Data;
@@ -88,25 +80,17 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Issue command to enable keyboard AUX functionality.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 KbcEnableAux (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   //
   // Send 8042 enable mouse command
@@ -114,25 +98,17 @@ Returns:
   return Out8042Command (IsaIo, ENABLE_AUX);
 }
 
+/**
+  Issue command to disable keyboard AUX functionality.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 KbcDisableAux (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   //
   // Send 8042 disable mouse command
@@ -140,25 +116,17 @@ Returns:
   return Out8042Command (IsaIo, DISABLE_AUX);
 }
 
+/**
+  Issue command to enable keyboard.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 KbcEnableKb (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   //
   // Send 8042 enable keyboard command
@@ -166,25 +134,17 @@ Returns:
   return Out8042Command (IsaIo, ENABLE_KB);
 }
 
+/**
+  Issue command to disable keyboard.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 KbcDisableKb (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   //
   // Send 8042 disable keyboard command
@@ -192,27 +152,19 @@ Returns:
   return Out8042Command (IsaIo, DISABLE_KB);
 }
 
+/**
+  Issue command to check keyboard status.
+  
+  @param IsaIo          Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param KeyboardEnable return whether keyboard is enable.
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 CheckKbStatus (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   OUT BOOLEAN                             *KeyboardEnable
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo           - GC_TODO: add argument description
-  KeyboardEnable  - GC_TODO: add argument description
-
-Returns:
-
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   EFI_STATUS  Status;
   UINT8       Data;
@@ -241,27 +193,17 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Issue command to reset keyboard.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 PS2MouseReset (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   EFI_STATUS  Status;
   UINT8       Data;
@@ -296,27 +238,19 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Issue command to set mouse's sample rate
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param SampleRate value of sample rate 
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 PS2MouseSetSampleRate (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN MOUSE_SR                             SampleRate
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo       - GC_TODO: add argument description
-  SampleRate  - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   EFI_STATUS  Status;
 
@@ -333,27 +267,19 @@ Returns:
   return Status;
 }
 
+/**
+  Issue command to set mouse's resolution.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Resolution value of resolution
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 PS2MouseSetResolution (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN MOUSE_RE                             Resolution
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo       - GC_TODO: add argument description
-  Resolution  - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   EFI_STATUS  Status;
 
@@ -370,27 +296,19 @@ Returns:
   return Status;
 }
 
+/**
+  Issue command to set mouse's scaling.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Scaling value of scaling
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 PS2MouseSetScaling (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN MOUSE_SF                             Scaling
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo   - GC_TODO: add argument description
-  Scaling - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   UINT8 Command;
 
@@ -402,25 +320,17 @@ Returns:
   return Out8042AuxCommand (IsaIo, Command, FALSE);
 }
 
+/**
+  Issue command to enable Ps2 mouse.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 PS2MouseEnable (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   //
   // Send auxiliary command to enable mouse
@@ -428,26 +338,20 @@ Returns:
   return Out8042AuxCommand (IsaIo, ENABLE_CMD, FALSE);
 }
 
+/**
+  Get mouse packet . Only care first 3 bytes
+
+  @param MouseDev  Pointer of PS2 Mouse Private Data Structure 
+
+  @retval EFI_NOT_READY  Mouse Device not ready to input data packet, or some error happened during getting the packet
+  @retval EFI_SUCCESS    The data packet is gotten successfully.
+
+**/
 EFI_STATUS
 PS2MouseGetPacket (
   PS2_MOUSE_ABSOLUTE_POINTER_DEV     *MouseAbsolutePointerDev
   )
-/*++
 
-Routine Description:
-
-  Get mouse packet . Only care first 3 bytes
-
-Arguments:
-
-  MouseDev  - Pointer of PS2 Mouse Private Data Structure 
-
-Returns:
-
-  EFI_NOT_READY -  Mouse Device not ready to input data packet, or some error happened during getting the packet
-  EFI_SUCCESS - The data packet is gotten successfully.
-
---*/
 {
   EFI_STATUS  Status;
   BOOLEAN     KeyboardEnable;
@@ -569,6 +473,16 @@ Returns:
   }
 }
 
+/**
+  Read data via IsaIo protocol with given number.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Buffer  Buffer receive data of mouse
+  @param BufSize The size of buffer
+  @param State   Check input or read data
+  
+  @return status of reading mouse data.
+**/
 EFI_STATUS
 PS2MouseRead (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
@@ -576,24 +490,6 @@ PS2MouseRead (
   IN OUT UINTN                            *BufSize,
   IN  UINTN                               State
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo   - GC_TODO: add argument description
-  Buffer  - GC_TODO: add argument description
-  BufSize - GC_TODO: add argument description
-  State   - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 {
   EFI_STATUS  Status;
   UINTN       BytesRead;
@@ -634,30 +530,24 @@ Returns:
   *BufSize = BytesRead;
   return Status;
 }
+
 //
 // 8042 I/O function
 //
+/**
+  I/O work flow of outing 8042 command.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Command I/O command.
+  
+  @retval EFI_SUCCESS Success to excute I/O work flow
+  @retval EFI_TIMEOUT Keyboard controller time out.
+**/
 EFI_STATUS
 Out8042Command (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINT8                                Command
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo   - GC_TODO: add argument description
-  Command - GC_TODO: add argument description
-
-Returns:
-
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   EFI_STATUS  Status;
   UINT8       Data;
@@ -683,27 +573,20 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  I/O work flow of outing 8042 data.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Data    Data value
+  
+  @retval EFI_SUCCESS Success to excute I/O work flow
+  @retval EFI_TIMEOUT Keyboard controller time out.
+**/
 EFI_STATUS
 Out8042Data (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINT8                                Data
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-  Data  - GC_TODO: add argument description
-
-Returns:
-
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   EFI_STATUS  Status;
   UINT8       temp;
@@ -726,28 +609,20 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  I/O work flow of in 8042 data.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Data    Data value
+  
+  @retval EFI_SUCCESS Success to excute I/O work flow
+  @retval EFI_TIMEOUT Keyboard controller time out.
+**/
 EFI_STATUS
 In8042Data (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN OUT UINT8                            *Data
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-  Data  - GC_TODO: add argument description
-
-Returns:
-
-  EFI_TIMEOUT - GC_TODO: Add description for return value
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   UINTN Delay;
   UINT8 temp;
@@ -777,32 +652,22 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  I/O work flow of outing 8042 Aux command.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Command Aux I/O command
+  @param Resend  Whether need resend the Aux command.
+  
+  @retval EFI_SUCCESS Success to excute I/O work flow
+  @retval EFI_TIMEOUT Keyboard controller time out.
+**/
 EFI_STATUS
 Out8042AuxCommand (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINT8                                Command,
   IN BOOLEAN                              Resend
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo   - GC_TODO: add argument description
-  Command - GC_TODO: add argument description
-  Resend  - GC_TODO: add argument description
-
-Returns:
-
-  EFI_SUCCESS - GC_TODO: Add description for return value
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value
-  EFI_DEVICE_ERROR - GC_TODO: Add description for return value
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   EFI_STATUS  Status;
   UINT8       Data;
@@ -869,27 +734,20 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  I/O work flow of outing 8042 Aux data.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Command Aux I/O command
+  
+  @retval EFI_SUCCESS Success to excute I/O work flow
+  @retval EFI_TIMEOUT Keyboard controller time out.
+**/
 EFI_STATUS
 Out8042AuxData (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINT8                                Data
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-  Data  - GC_TODO: add argument description
-
-Returns:
-
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   EFI_STATUS  Status;
   UINT8       Temp;
@@ -922,27 +780,20 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  I/O work flow of in 8042 Aux data.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Data    Buffer holding return value.
+  
+  @retval EFI_SUCCESS Success to excute I/O work flow
+  @retval EFI_TIMEOUT Keyboard controller time out.
+**/
 EFI_STATUS
 In8042AuxData (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN OUT UINT8                            *Data
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-  Data  - GC_TODO: add argument description
-
-Returns:
-
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   EFI_STATUS  Status;
 
@@ -959,26 +810,19 @@ Returns:
   return EFI_SUCCESS;
 }
 
+
+/**
+  Check keyboard controller status, if it is output buffer full and for auxiliary device
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @retval EFI_SUCCESS   Keyboard controller is ready
+  @retval EFI_NOT_READY Keyboard controller is not ready
+**/
 EFI_STATUS
 CheckForInput (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  EFI_NOT_READY - GC_TODO: Add description for return value
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   UINT8 Data;
 
@@ -994,28 +838,20 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  I/O work flow to wait input buffer empty in given time.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Timeout Wating time.
+  
+  @retval EFI_TIMEOUT if input is still not empty in given time.
+  @retval EFI_SUCCESS input is empty.
+**/
 EFI_STATUS
 WaitInputEmpty (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINTN                                Timeout
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo   - GC_TODO: add argument description
-  Timeout - GC_TODO: add argument description
-
-Returns:
-
-  EFI_TIMEOUT - GC_TODO: Add description for return value
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   UINTN Delay;
   UINT8 Data;
@@ -1043,12 +879,21 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  I/O work flow to wait output buffer full in given time.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Timeout given time
+  
+  @retval EFI_TIMEOUT  output is not full in given time
+  @retval EFI_SUCCESS  output is full in given time.
+**/
 EFI_STATUS
 WaitOutputFull (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINTN                                Timeout
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1064,7 +909,7 @@ Returns:
   EFI_TIMEOUT - GC_TODO: Add description for return value
   EFI_SUCCESS - GC_TODO: Add description for return value
 
---*/
+**/
 {
   UINTN Delay;
   UINT8 Data;
@@ -1092,3 +937,4 @@ Returns:
 
   return EFI_SUCCESS;
 }
+

IntelFrameworkModulePkg/Bus/Isa/Ps2MouseAbsolutePointerDxe/CommPs2.h

@@ -1,6 +1,5 @@
 /**@file
   PS2 Mouse Communication Interface 
-
   
 Copyright (c) 2006 - 2007, Intel Corporation
 All rights reserved. This program and the accompanying materials
@@ -102,266 +101,184 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //    0 - output buffer empty
 //    1 - keyboard controller data in output buffer
 //
+
+/**
+  Issue self test command via IsaIo interface.
+  
+  @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @return EFI_SUCCESS  Success to do keyboard self testing.
+  @return others       Fail to do keyboard self testing.
+**/
 EFI_STATUS
 KbcSelfTest (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Issue command to enable keyboard AUX functionality.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 KbcEnableAux (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Issue command to disable keyboard AUX functionality.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 KbcDisableAux (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Issue command to enable keyboard.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 KbcEnableKb (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Issue command to disable keyboard.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 KbcDisableKb (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Issue command to check keyboard status.
+  
+  @param IsaIo          Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param KeyboardEnable return whether keyboard is enable.
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 CheckKbStatus (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   OUT BOOLEAN                             *KeyboardEnable
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo           - GC_TODO: add argument description
-  KeyboardEnable  - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Issue command to reset keyboard.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 PS2MouseReset (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Issue command to set mouse's sample rate
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param SampleRate value of sample rate 
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 PS2MouseSetSampleRate (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN MOUSE_SR                             SampleRate
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo       - GC_TODO: add argument description
-  SampleRate  - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Issue command to set mouse's resolution.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Resolution value of resolution
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 PS2MouseSetResolution (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN MOUSE_RE                             Resolution
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo       - GC_TODO: add argument description
-  Resolution  - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Issue command to set mouse's scaling.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Scaling value of scaling
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 PS2MouseSetScaling (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN MOUSE_SF                             Scaling
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo   - GC_TODO: add argument description
-  Scaling - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Issue command to enable Ps2 mouse.
+  
+  @param IsaIo  Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @return Status of command issuing.
+**/
 EFI_STATUS
 PS2MouseEnable (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  IsaIo - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Get mouse packet . Only care first 3 bytes
+
+  @param MouseDev  Pointer of PS2 Mouse Private Data Structure 
+
+  @retval EFI_NOT_READY  Mouse Device not ready to input data packet, or some error happened during getting the packet
+  @retval EFI_SUCCESS    The data packet is gotten successfully.
+
+**/
 EFI_STATUS
 PS2MouseGetPacket (
   PS2_MOUSE_ABSOLUTE_POINTER_DEV     *MouseAbsolutePointerDev
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  MouseDev  - GC_TODO: add argument description
-
-Returns:
-
-  GC_TODO: add return values
-
---*/
 ;
 
+/**
+  Read data via IsaIo protocol with given number.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Buffer  Buffer receive data of mouse
+  @param BufSize The size of buffer
+  @param State   Check input or read data
+  
+  @return status of reading mouse data.
+**/
 EFI_STATUS
 PS2MouseRead (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
@@ -373,24 +290,61 @@ PS2MouseRead (
 //
 // 8042 I/O function
 //
+/**
+  I/O work flow of outing 8042 command.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Command I/O command.
+  
+  @retval EFI_SUCCESS Success to excute I/O work flow
+  @retval EFI_TIMEOUT Keyboard controller time out.
+**/
 EFI_STATUS
 Out8042Command (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINT8                                Command
   );
 
+/**
+  I/O work flow of in 8042 data.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Data    Data value
+  
+  @retval EFI_SUCCESS Success to excute I/O work flow
+  @retval EFI_TIMEOUT Keyboard controller time out.
+**/
 EFI_STATUS
 In8042Data (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN OUT UINT8                            *Data
   );
 
+/**
+  I/O work flow of outing 8042 data.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Data    Data value
+  
+  @retval EFI_SUCCESS Success to excute I/O work flow
+  @retval EFI_TIMEOUT Keyboard controller time out.
+**/
 EFI_STATUS
 Out8042Data (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINT8                                Data
   );
 
+/**
+  I/O work flow of outing 8042 Aux command.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Command Aux I/O command
+  @param Resend  Whether need resend the Aux command.
+  
+  @retval EFI_SUCCESS Success to excute I/O work flow
+  @retval EFI_TIMEOUT Keyboard controller time out.
+**/
 EFI_STATUS
 Out8042AuxCommand (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
@@ -398,29 +352,73 @@ Out8042AuxCommand (
   IN BOOLEAN                              Resend
   );
 
+/**
+  I/O work flow of in 8042 Aux data.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Data    Buffer holding return value.
+  
+  @retval EFI_SUCCESS Success to excute I/O work flow
+  @retval EFI_TIMEOUT Keyboard controller time out.
+**/
 EFI_STATUS
 In8042AuxData (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN OUT UINT8                            *Data
   );
 
+/**
+  I/O work flow of outing 8042 Aux data.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Command Aux I/O command
+  
+  @retval EFI_SUCCESS Success to excute I/O work flow
+  @retval EFI_TIMEOUT Keyboard controller time out.
+**/
 EFI_STATUS
 Out8042AuxData (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINT8                                Data
   );
 
+/**
+  Check keyboard controller status, if it is output buffer full and for auxiliary device
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  
+  @retval EFI_SUCCESS   Keyboard controller is ready
+  @retval EFI_NOT_READY Keyboard controller is not ready
+**/
 EFI_STATUS
 CheckForInput (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   );
 
+/**
+  I/O work flow to wait input buffer empty in given time.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Timeout Wating time.
+  
+  @retval EFI_TIMEOUT if input is still not empty in given time.
+  @retval EFI_SUCCESS input is empty.
+**/
 EFI_STATUS
 WaitInputEmpty (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINTN                                Timeout
   );
 
+/**
+  I/O work flow to wait output buffer full in given time.
+  
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL
+  @param Timeout given time
+  
+  @retval EFI_TIMEOUT  output is not full in given time
+  @retval EFI_SUCCESS  output is full in given time.
+**/
 EFI_STATUS
 WaitOutputFull (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,

IntelFrameworkModulePkg/Bus/Isa/Ps2MouseAbsolutePointerDxe/Ps2MouseAbsolutePointer.c

@@ -28,6 +28,20 @@ EFI_DRIVER_BINDING_PROTOCOL gPS2MouseAbsolutePointerDriver = {
   NULL
 };
 
+/**
+  Test to see if this driver supports ControllerHandle. Any ControllerHandle
+  than contains a IsaIo protocol can be supported.
+
+  @param  This                Protocol instance pointer.
+  @param  ControllerHandle    Handle of device to test
+  @param  RemainingDevicePath Optional parameter use to pick a specific child
+                              device to start.
+
+  @retval EFI_SUCCESS         This driver supports this device
+  @retval EFI_ALREADY_STARTED This driver is already running on this device
+  @retval other               This driver does not support this device
+
+**/
 EFI_STATUS
 EFIAPI
 PS2MouseAbsolutePointerDriverSupported (
@@ -35,20 +49,6 @@ PS2MouseAbsolutePointerDriverSupported (
   IN EFI_HANDLE                     Controller,
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
   )
-/*++
-
-Routine Description:
-
-  ControllerDriver Protocol Method
-
-Arguments:
-
-Returns:
-
---*/
-// GC_TODO:    This - add argument and description to function comment
-// GC_TODO:    Controller - add argument and description to function comment
-// GC_TODO:    RemainingDevicePath - add argument and description to function comment
 {
   EFI_STATUS                          Status;
   EFI_ISA_IO_PROTOCOL                 *IsaIo;
@@ -108,6 +108,21 @@ Returns:
   return Status;
 }
 
+/**
+  Start this driver on ControllerHandle by opening a IsaIo
+  protocol, creating PS2_MOUSE_ABSOLUTE_POINTER_DEV device and install gEfiAbsolutePointerProtocolGuid
+  finnally.
+
+  @param  This                 Protocol instance pointer.
+  @param  ControllerHandle     Handle of device to bind driver to
+  @param  RemainingDevicePath  Optional parameter use to pick a specific child
+                               device to start.
+
+  @retval EFI_SUCCESS          This driver is added to ControllerHandle
+  @retval EFI_ALREADY_STARTED  This driver is already running on ControllerHandle
+  @retval other                This driver does not support this device
+
+**/
 EFI_STATUS
 EFIAPI
 PS2MouseAbsolutePointerDriverStart (
@@ -115,21 +130,6 @@ PS2MouseAbsolutePointerDriverStart (
   IN EFI_HANDLE                     Controller,
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
   )
-/*++
-
-Routine Description:
-    Start protocol interfaces for the mouse device handles.
-
-Arguments:
-    This                               - Protocol instance pointer.
-    Controller                      - Handle of device to bind driver to.
-    RemainingDevicePath  - Not used.
-
-Returns:
-    EFI_SUCCESS             - This driver is added to DeviceHandle.
-    other                               - Errors occurred.
-
---*/
 {
   EFI_STATUS                          Status;
   EFI_STATUS                          EmptyStatus;
@@ -385,6 +385,20 @@ ErrorExit:
   return Status;
 }
 
+/**
+  Stop this driver on ControllerHandle. Support stoping any child handles
+  created by this driver.
+
+  @param  This              Protocol instance pointer.
+  @param  ControllerHandle  Handle of device to stop driver on
+  @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of
+                            children is zero stop the entire bus driver.
+  @param  ChildHandleBuffer List of Child Handles to Stop.
+
+  @retval EFI_SUCCESS       This driver is removed ControllerHandle
+  @retval other             This driver was not removed from this device
+
+**/
 EFI_STATUS
 EFIAPI
 PS2MouseAbsolutePointerDriverStop (
@@ -393,21 +407,6 @@ PS2MouseAbsolutePointerDriverStop (
   IN UINTN                          NumberOfChildren,
   IN EFI_HANDLE                     *ChildHandleBuffer
   )
-/*++
-
-  Routine Description:
-
-  Arguments:
-
-  Returns:
-
---*/
-// GC_TODO:    This - add argument and description to function comment
-// GC_TODO:    Controller - add argument and description to function comment
-// GC_TODO:    NumberOfChildren - add argument and description to function comment
-// GC_TODO:    ChildHandleBuffer - add argument and description to function comment
-// GC_TODO:    EFI_SUCCESS - add return value to function comment
-// GC_TODO:    EFI_SUCCESS - add return value to function comment
 {
   EFI_STATUS                            Status;
   EFI_ABSOLUTE_POINTER_PROTOCOL         *AbsolutePointerProtocol;
@@ -486,29 +485,23 @@ PS2MouseAbsolutePointerDriverStop (
   return EFI_SUCCESS;
 }
 
+/**
+  Reset the Mouse and do BAT test for it, if ExtendedVerification isTRUE and there is a mouse device connectted to system
+
+  @param This                 - Pointer of simple pointer Protocol.
+  @param ExtendedVerification - Whether configure mouse parameters. True: do; FALSE: skip.
+
+
+  @retval EFI_SUCCESS         - The command byte is written successfully.
+  @retval EFI_DEVICE_ERROR    - Errors occurred during reseting keyboard.
+
+**/
 EFI_STATUS
 EFIAPI
 MouseAbsolutePointerReset (
   IN EFI_ABSOLUTE_POINTER_PROTOCOL    *This,
   IN BOOLEAN                          ExtendedVerification
   )
-/*++
-
-Routine Description:
-
-  Reset the Mouse and do BAT test for it, if ExtendedVerification isTRUE and there is a mouse device connectted to system
-
-Arguments:
-
-  This                 - Pointer of simple pointer Protocol.
-  ExtendedVerification - Whether configure mouse parameters. True: do; FALSE: skip.
-
-Returns:
-
- EFI_SUCCESS         - The command byte is written successfully.
- EFI_DEVICE_ERROR    - Errors occurred during reseting keyboard.
-
---*/
 {
   EFI_STATUS                       Status;
   PS2_MOUSE_ABSOLUTE_POINTER_DEV  *MouseAbsolutePointerDev;
@@ -608,26 +601,20 @@ Exit:
   return Status;
 }
 
+/**
+  Check whether there is Ps/2 mouse device in system
+
+  @param PS2_MOUSE_DEV - Mouse Private Data Structure
+
+  @retval TRUE                - Keyboard in System.
+  @retval FALSE               - Keyboard not in System.
+
+**/
 BOOLEAN
 CheckMouseAbsolutePointerConnect (
   IN  PS2_MOUSE_ABSOLUTE_POINTER_DEV     *MouseAbsolutePointerDev
   )
-/*++
 
-Routine Description:
-
-  Check whether there is Ps/2 mouse device in system
-
-Arguments:
-
-  PS2_MOUSE_DEV - Mouse Private Data Structure
-
-Returns:
-
-  TRUE                - Keyboard in System.
-  FALSE               - Keyboard not in System.
-
---*/
 {
   EFI_STATUS     Status;
 
@@ -639,30 +626,22 @@ Returns:
   return FALSE;
 }
 
+/**
+  Get and Clear mouse status.
+  
+  @param This                 - Pointer of simple pointer Protocol.
+  @param State                - Output buffer holding status.
+
+  @retval EFI_INVALID_PARAMETER Output buffer is invalid.
+  @retval EFI_NOT_READY         Mouse is not changed status yet.
+  @retval EFI_SUCCESS           Mouse status is changed and get successful.
+**/
 EFI_STATUS
 EFIAPI
 MouseAbsolutePointerGetState (
   IN EFI_ABSOLUTE_POINTER_PROTOCOL     *This,
   IN OUT EFI_ABSOLUTE_POINTER_STATE    *State
   )
-/*++
-
-Routine Description:
-
-  GC_TODO: Add function description
-
-Arguments:
-
-  This  - GC_TODO: add argument description
-  State - GC_TODO: add argument description
-
-Returns:
-
-  EFI_INVALID_PARAMETER - GC_TODO: Add description for return value
-  EFI_NOT_READY - GC_TODO: Add description for return value
-  EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
 {
   PS2_MOUSE_ABSOLUTE_POINTER_DEV *MouseAbsolutePointerDev;
   EFI_TPL       OldTpl;
@@ -693,24 +672,22 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+
+  Event notification function for SIMPLE_POINTER.WaitForInput event
+  Signal the event if there is input from mouse
+
+  @param Event    event object
+  @param Context  event context
+
+**/
+
 VOID
 EFIAPI
 MouseAbsolutePointerWaitForInput (
   IN  EFI_EVENT               Event,
   IN  VOID                    *Context
   )
-/*++
-
-Routine Description:
-
-  Event notification function for SIMPLE_POINTER.WaitForInput event
-  Signal the event if there is input from mouse
-
-Arguments:
-
-Returns:
-
---*/
 // GC_TODO:    Event - add argument and description to function comment
 // GC_TODO:    Context - add argument and description to function comment
 {
@@ -728,29 +705,21 @@ Returns:
 
 }
 
+/**
+  Event notification function for TimerEvent event
+  If mouse device is connected to system, try to get the mouse packet data
+
+  @param Event      -  TimerEvent in PS2_MOUSE_DEV
+  @param Context    -  Pointer to PS2_MOUSE_DEV structure
+
+**/
 VOID
 EFIAPI
 PollMouseAbsolutePointer(
   IN EFI_EVENT  Event,
   IN VOID       *Context
   )
-/*++
 
-Routine Description:
-
-  Event notification function for TimerEvent event
-  If mouse device is connected to system, try to get the mouse packet data
-
-Arguments:
-
-  Event      -  TimerEvent in PS2_MOUSE_DEV
-  Context  -  Pointer to PS2_MOUSE_DEV structure
-
-Returns:
-
-  None
-
---*/
 {
   PS2_MOUSE_ABSOLUTE_POINTER_DEV *MouseAbsolutePointerDev;
 
@@ -797,3 +766,4 @@ InitializePs2MouseAbsolutePointer(
 
   return Status;
 }
+

IntelFrameworkModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.c

@@ -23,7 +23,7 @@ EFI_STATUS
 KbcSelfTest (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -38,7 +38,7 @@ Returns:
   EFI_DEVICE_ERROR - GC_TODO: Add description for return value
   EFI_SUCCESS - GC_TODO: Add description for return value
 
---*/
+**/
 {
   EFI_STATUS  Status;
   UINT8       Data;
@@ -92,7 +92,7 @@ EFI_STATUS
 KbcEnableAux (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -106,7 +106,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 {
   //
   // Send 8042 enable mouse command
@@ -118,7 +118,7 @@ EFI_STATUS
 KbcDisableAux (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -132,7 +132,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 {
   //
   // Send 8042 disable mouse command
@@ -144,7 +144,7 @@ EFI_STATUS
 KbcEnableKb (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -158,7 +158,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 {
   //
   // Send 8042 enable keyboard command
@@ -170,7 +170,7 @@ EFI_STATUS
 KbcDisableKb (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -184,7 +184,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 {
   //
   // Send 8042 disable keyboard command
@@ -197,7 +197,7 @@ CheckKbStatus (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   OUT BOOLEAN                             *KeyboardEnable
   )
-/*++
+/**
 
 Routine Description:
 
@@ -212,7 +212,7 @@ Returns:
 
   EFI_SUCCESS - GC_TODO: Add description for return value
 
---*/
+**/
 {
   EFI_STATUS  Status;
   UINT8       Data;
@@ -245,7 +245,7 @@ EFI_STATUS
 PS2MouseReset (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -261,7 +261,7 @@ Returns:
   EFI_DEVICE_ERROR - GC_TODO: Add description for return value
   EFI_SUCCESS - GC_TODO: Add description for return value
 
---*/
+**/
 {
   EFI_STATUS  Status;
   UINT8       Data;
@@ -301,7 +301,7 @@ PS2MouseSetSampleRate (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN MOUSE_SR                             SampleRate
   )
-/*++
+/**
 
 Routine Description:
 
@@ -316,7 +316,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 {
   EFI_STATUS  Status;
 
@@ -338,7 +338,7 @@ PS2MouseSetResolution (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN MOUSE_RE                             Resolution
   )
-/*++
+/**
 
 Routine Description:
 
@@ -353,7 +353,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 {
   EFI_STATUS  Status;
 
@@ -375,7 +375,7 @@ PS2MouseSetScaling (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN MOUSE_SF                             Scaling
   )
-/*++
+/**
 
 Routine Description:
 
@@ -390,7 +390,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 {
   UINT8 Command;
 
@@ -406,7 +406,7 @@ EFI_STATUS
 PS2MouseEnable (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -420,7 +420,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 {
   //
   // Send auxiliary command to enable mouse
@@ -432,7 +432,7 @@ EFI_STATUS
 PS2MouseGetPacket (
   PS2_MOUSE_DEV     *MouseDev
   )
-/*++
+/**
 
 Routine Description:
 
@@ -447,7 +447,7 @@ Returns:
   EFI_NOT_READY -  Mouse Device not ready to input data packet, or some error happened during getting the packet
   EFI_SUCCESS - The data packet is gotten successfully.
 
---*/
+**/
 {
   EFI_STATUS  Status;
   BOOLEAN     KeyboardEnable;
@@ -576,7 +576,7 @@ PS2MouseRead (
   IN OUT UINTN                            *BufSize,
   IN  UINTN                               State
   )
-/*++
+/**
 
 Routine Description:
 
@@ -593,7 +593,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 {
   EFI_STATUS  Status;
   UINTN       BytesRead;
@@ -642,7 +642,7 @@ Out8042Command (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINT8                                Command
   )
-/*++
+/**
 
 Routine Description:
 
@@ -657,7 +657,7 @@ Returns:
 
   EFI_SUCCESS - GC_TODO: Add description for return value
 
---*/
+**/
 {
   EFI_STATUS  Status;
   UINT8       Data;
@@ -688,7 +688,7 @@ Out8042Data (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINT8                                Data
   )
-/*++
+/**
 
 Routine Description:
 
@@ -703,7 +703,7 @@ Returns:
 
   EFI_SUCCESS - GC_TODO: Add description for return value
 
---*/
+**/
 {
   EFI_STATUS  Status;
   UINT8       temp;
@@ -731,7 +731,7 @@ In8042Data (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN OUT UINT8                            *Data
   )
-/*++
+/**
 
 Routine Description:
 
@@ -747,7 +747,7 @@ Returns:
   EFI_TIMEOUT - GC_TODO: Add description for return value
   EFI_SUCCESS - GC_TODO: Add description for return value
 
---*/
+**/
 {
   UINTN Delay;
   UINT8 temp;
@@ -783,7 +783,7 @@ Out8042AuxCommand (
   IN UINT8                                Command,
   IN BOOLEAN                              Resend
   )
-/*++
+/**
 
 Routine Description:
 
@@ -802,7 +802,7 @@ Returns:
   EFI_DEVICE_ERROR - GC_TODO: Add description for return value
   EFI_SUCCESS - GC_TODO: Add description for return value
 
---*/
+**/
 {
   EFI_STATUS  Status;
   UINT8       Data;
@@ -874,7 +874,7 @@ Out8042AuxData (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINT8                                Data
   )
-/*++
+/**
 
 Routine Description:
 
@@ -889,7 +889,7 @@ Returns:
 
   EFI_SUCCESS - GC_TODO: Add description for return value
 
---*/
+**/
 {
   EFI_STATUS  Status;
   UINT8       Temp;
@@ -927,7 +927,7 @@ In8042AuxData (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN OUT UINT8                            *Data
   )
-/*++
+/**
 
 Routine Description:
 
@@ -942,7 +942,7 @@ Returns:
 
   EFI_SUCCESS - GC_TODO: Add description for return value
 
---*/
+**/
 {
   EFI_STATUS  Status;
 
@@ -963,7 +963,7 @@ EFI_STATUS
 CheckForInput (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -978,7 +978,7 @@ Returns:
   EFI_NOT_READY - GC_TODO: Add description for return value
   EFI_SUCCESS - GC_TODO: Add description for return value
 
---*/
+**/
 {
   UINT8 Data;
 
@@ -999,7 +999,7 @@ WaitInputEmpty (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINTN                                Timeout
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1015,7 +1015,7 @@ Returns:
   EFI_TIMEOUT - GC_TODO: Add description for return value
   EFI_SUCCESS - GC_TODO: Add description for return value
 
---*/
+**/
 {
   UINTN Delay;
   UINT8 Data;
@@ -1048,7 +1048,7 @@ WaitOutputFull (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN UINTN                                Timeout
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1064,7 +1064,7 @@ Returns:
   EFI_TIMEOUT - GC_TODO: Add description for return value
   EFI_SUCCESS - GC_TODO: Add description for return value
 
---*/
+**/
 {
   UINTN Delay;
   UINT8 Data;

IntelFrameworkModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.h

@@ -106,7 +106,7 @@ EFI_STATUS
 KbcSelfTest (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -120,14 +120,14 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 KbcEnableAux (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -141,14 +141,14 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 KbcDisableAux (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -162,14 +162,14 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 KbcEnableKb (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -183,14 +183,14 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 KbcDisableKb (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -204,7 +204,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -212,7 +212,7 @@ CheckKbStatus (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   OUT BOOLEAN                             *KeyboardEnable
   )
-/*++
+/**
 
 Routine Description:
 
@@ -227,14 +227,14 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 PS2MouseReset (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -248,7 +248,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -256,7 +256,7 @@ PS2MouseSetSampleRate (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN MOUSE_SR                             SampleRate
   )
-/*++
+/**
 
 Routine Description:
 
@@ -271,7 +271,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -279,7 +279,7 @@ PS2MouseSetResolution (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN MOUSE_RE                             Resolution
   )
-/*++
+/**
 
 Routine Description:
 
@@ -294,7 +294,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -302,7 +302,7 @@ PS2MouseSetScaling (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,
   IN MOUSE_SF                             Scaling
   )
-/*++
+/**
 
 Routine Description:
 
@@ -317,14 +317,14 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 PS2MouseEnable (
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo
   )
-/*++
+/**
 
 Routine Description:
 
@@ -338,14 +338,14 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 PS2MouseGetPacket (
   PS2_MOUSE_DEV     *MouseDev
   )
-/*++
+/**
 
 Routine Description:
 
@@ -359,7 +359,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS

IntelFrameworkModulePkg/Bus/Isa/Ps2MouseDxe/Ps2Mouse.c

@@ -35,7 +35,7 @@ PS2MouseDriverSupported (
   IN EFI_HANDLE                     Controller,
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
   )
-/*++
+/**
 
 Routine Description:
 
@@ -45,7 +45,7 @@ Arguments:
 
 Returns:
 
---*/
+**/
 // GC_TODO:    This - add argument and description to function comment
 // GC_TODO:    Controller - add argument and description to function comment
 // GC_TODO:    RemainingDevicePath - add argument and description to function comment
@@ -115,7 +115,7 @@ PS2MouseDriverStart (
   IN EFI_HANDLE                     Controller,
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
   )
-/*++
+/**
 
 Routine Description:
     Start protocol interfaces for the mouse device handles.
@@ -129,7 +129,7 @@ Returns:
     EFI_SUCCESS             - This driver is added to DeviceHandle.
     other                               - Errors occurred.
 
---*/
+**/
 {
   EFI_STATUS                          Status;
   EFI_STATUS                          EmptyStatus;
@@ -390,7 +390,7 @@ PS2MouseDriverStop (
   IN UINTN                          NumberOfChildren,
   IN EFI_HANDLE                     *ChildHandleBuffer
   )
-/*++
+/**
 
   Routine Description:
 
@@ -398,7 +398,7 @@ PS2MouseDriverStop (
 
   Returns:
 
---*/
+**/
 // GC_TODO:    This - add argument and description to function comment
 // GC_TODO:    Controller - add argument and description to function comment
 // GC_TODO:    NumberOfChildren - add argument and description to function comment
@@ -489,7 +489,7 @@ MouseReset (
   IN EFI_SIMPLE_POINTER_PROTOCOL    *This,
   IN BOOLEAN                        ExtendedVerification
   )
-/*++
+/**
 
 Routine Description:
 
@@ -505,7 +505,7 @@ Returns:
  EFI_SUCCESS         - The command byte is written successfully.
  EFI_DEVICE_ERROR    - Errors occurred during reseting keyboard.
 
---*/
+**/
 {
   EFI_STATUS    Status;
   PS2_MOUSE_DEV *MouseDev;
@@ -609,7 +609,7 @@ BOOLEAN
 CheckMouseConnect (
   IN  PS2_MOUSE_DEV     *MouseDev
   )
-/*++
+/**
 
 Routine Description:
 
@@ -624,7 +624,7 @@ Returns:
   TRUE                - Keyboard in System.
   FALSE               - Keyboard not in System.
 
---*/
+**/
 {
   EFI_STATUS     Status;
 
@@ -642,7 +642,7 @@ MouseGetState (
   IN EFI_SIMPLE_POINTER_PROTOCOL    *This,
   IN OUT EFI_SIMPLE_POINTER_STATE   *State
   )
-/*++
+/**
 
 Routine Description:
 
@@ -659,7 +659,7 @@ Returns:
   EFI_NOT_READY - GC_TODO: Add description for return value
   EFI_SUCCESS - GC_TODO: Add description for return value
 
---*/
+**/
 {
   PS2_MOUSE_DEV *MouseDev;
   EFI_TPL       OldTpl;
@@ -695,7 +695,7 @@ MouseWaitForInput (
   IN  EFI_EVENT               Event,
   IN  VOID                    *Context
   )
-/*++
+/**
 
 Routine Description:
 
@@ -706,7 +706,7 @@ Arguments:
 
 Returns:
 
---*/
+**/
 // GC_TODO:    Event - add argument and description to function comment
 // GC_TODO:    Context - add argument and description to function comment
 {
@@ -730,7 +730,7 @@ PollMouse (
   IN EFI_EVENT  Event,
   IN VOID       *Context
   )
-/*++
+/**
 
 Routine Description:
 
@@ -746,7 +746,7 @@ Returns:
 
   None
 
---*/
+**/
 {
   PS2_MOUSE_DEV *MouseDev;
 

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciCommand.c

@@ -22,7 +22,7 @@ PciOperateRegister (
   IN  UINT8         Operation,
   OUT UINT16        *PtrCommand
   )
-/*++
+/**
 
 Routine Description:
 
@@ -32,7 +32,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    Command - add argument and description to function comment
 // TODO:    Offset - add argument and description to function comment
@@ -82,7 +82,7 @@ BOOLEAN
 PciCapabilitySupport (
   IN PCI_IO_DEVICE  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -92,7 +92,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 {
 
@@ -110,7 +110,7 @@ LocateCapabilityRegBlock (
   IN OUT UINT8      *Offset,
   OUT UINT8         *NextRegBlock OPTIONAL
   )
-/*++
+/**
 
 Routine Description:
   Locate cap reg.
@@ -125,7 +125,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_UNSUPPORTED - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 // TODO:    EFI_NOT_FOUND - add return value to function comment

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciCommand.h

@@ -69,7 +69,7 @@ PciOperateRegister (
   IN  UINT8         Operation,
   OUT UINT16        *PtrCommand
   )
-/*++
+/**
 
 Routine Description:
 
@@ -87,14 +87,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 BOOLEAN
 PciCapabilitySupport (
   IN PCI_IO_DEVICE  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -108,7 +108,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -118,7 +118,7 @@ LocateCapabilityRegBlock (
   IN OUT UINT8      *Offset,
   OUT UINT8         *NextRegBlock OPTIONAL
   )
-/*++
+/**
 
 Routine Description:
 
@@ -135,7 +135,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDeviceSupport.c

@@ -25,7 +25,7 @@ EFI_STATUS
 InitializePciDevicePool (
   VOID
   )
-/*++
+/**
 
 Routine Description:
 
@@ -37,7 +37,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
   InitializeListHead (&gPciDevicePool);
@@ -49,7 +49,7 @@ EFI_STATUS
 InsertRootBridge (
   PCI_IO_DEVICE *RootBridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -63,7 +63,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
 
@@ -77,7 +77,7 @@ InsertPciDevice (
   PCI_IO_DEVICE *Bridge,
   PCI_IO_DEVICE *PciDeviceNode
   )
-/*++
+/**
 
 Routine Description:
 
@@ -92,7 +92,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
 
@@ -106,7 +106,7 @@ EFI_STATUS
 DestroyRootBridge (
   IN PCI_IO_DEVICE *RootBridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -119,7 +119,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
   DestroyPciDeviceTree (RootBridge);
@@ -133,7 +133,7 @@ EFI_STATUS
 FreePciDevice (
   IN PCI_IO_DEVICE *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -148,7 +148,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
 
@@ -172,7 +172,7 @@ EFI_STATUS
 DestroyPciDeviceTree (
   IN PCI_IO_DEVICE *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -187,7 +187,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
   LIST_ENTRY      *CurrentLink;
@@ -218,7 +218,7 @@ EFI_STATUS
 DestroyRootBridgeByHandle (
   EFI_HANDLE Controller
   )
-/*++
+/**
 
 Routine Description:
 
@@ -234,7 +234,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_SUCCESS - add return value to function comment
 // TODO:    EFI_NOT_FOUND - add return value to function comment
 {
@@ -270,7 +270,7 @@ RegisterPciDevice (
   IN  PCI_IO_DEVICE                  *PciIoDevice,
   OUT EFI_HANDLE                     *Handle OPTIONAL
   )
-/*++
+/**
 
 Routine Description:
 
@@ -289,7 +289,7 @@ Returns:
   EFI_SUCCESS   - The PCI device is successfully registered.
   Others        - An error occurred when registering the PCI device.
 
---*/
+**/
 {
   EFI_STATUS          Status;
   VOID                *PlatformOpRomBuffer;
@@ -440,7 +440,7 @@ RemoveAllPciDeviceOnBridge (
   EFI_HANDLE               RootBridgeHandle,
   PCI_IO_DEVICE            *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -455,7 +455,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
 
@@ -495,7 +495,7 @@ DeRegisterPciDevice (
   IN  EFI_HANDLE                     Controller,
   IN  EFI_HANDLE                     Handle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -512,7 +512,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_SUCCESS - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -639,7 +639,7 @@ StartPciDevicesOnBridge (
   IN OUT UINT8                           *NumberOfChildren,
   IN OUT EFI_HANDLE                      *ChildHandleBuffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -657,7 +657,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_NOT_READY - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 // TODO:    EFI_UNSUPPORTED - add return value to function comment
@@ -810,7 +810,7 @@ EFI_STATUS
 StartPciDevices (
   IN EFI_HANDLE                         Controller
   )
-/*++
+/**
 
 Routine Description:
 
@@ -824,7 +824,7 @@ Returns:
 
   None
 
---*/
+**/
 {
   PCI_IO_DEVICE     *RootBridge;
   EFI_HANDLE        ThisHostBridge;
@@ -862,7 +862,7 @@ PCI_IO_DEVICE *
 CreateRootBridge (
   IN EFI_HANDLE RootBridgeHandle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -874,7 +874,7 @@ Returns:
 
   None
 
---*/
+**/
 {
 
   EFI_STATUS                      Status;
@@ -956,7 +956,7 @@ PCI_IO_DEVICE *
 GetRootBridgeByHandle (
   EFI_HANDLE RootBridgeHandle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -969,7 +969,7 @@ Returns:
 
   None
 
---*/
+**/
 {
   PCI_IO_DEVICE   *RootBridgeDev;
   LIST_ENTRY      *CurrentLink;
@@ -994,7 +994,7 @@ PciDeviceExisted (
   IN PCI_IO_DEVICE    *Bridge,
   IN PCI_IO_DEVICE    *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1007,7 +1007,7 @@ Returns:
 
   None
 
---*/
+**/
 {
 
   PCI_IO_DEVICE   *Temp;
@@ -1039,7 +1039,7 @@ PCI_IO_DEVICE *
 ActiveVGADeviceOnTheSameSegment (
   IN PCI_IO_DEVICE        *VgaDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1051,7 +1051,7 @@ Returns:
 
   None
 
---*/
+**/
 {
   LIST_ENTRY      *CurrentLink;
   PCI_IO_DEVICE   *Temp;
@@ -1081,7 +1081,7 @@ PCI_IO_DEVICE *
 ActiveVGADeviceOnTheRootBridge (
   IN PCI_IO_DEVICE        *RootBridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1093,7 +1093,7 @@ Returns:
 
   None
 
---*/
+**/
 {
   LIST_ENTRY      *CurrentLink;
   PCI_IO_DEVICE   *Temp;
@@ -1133,7 +1133,7 @@ GetHpcPciAddress (
   IN  EFI_DEVICE_PATH_PROTOCOL         *HpcDevicePath,
   OUT UINT64                           *PciAddress
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1147,7 +1147,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_NOT_FOUND - add return value to function comment
 // TODO:    EFI_NOT_FOUND - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -1222,7 +1222,7 @@ GetHpcPciAddressFromRootBridge (
   IN  EFI_DEVICE_PATH_PROTOCOL         *RemainingDevicePath,
   OUT UINT64                           *PciAddress
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1236,7 +1236,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    RootBridge - add argument and description to function comment
 // TODO:    RemainingDevicePath - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDeviceSupport.h

@@ -18,7 +18,7 @@ EFI_STATUS
 InitializePciDevicePool (
   VOID
   )
-/*++
+/**
 
 Routine Description:
 
@@ -32,14 +32,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 InsertRootBridge (
   PCI_IO_DEVICE *RootBridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -53,7 +53,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -61,7 +61,7 @@ InsertPciDevice (
   PCI_IO_DEVICE *Bridge,
   PCI_IO_DEVICE *PciDeviceNode
   )
-/*++
+/**
 
 Routine Description:
 
@@ -76,14 +76,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 DestroyRootBridge (
   IN PCI_IO_DEVICE *RootBridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -97,14 +97,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 DestroyPciDeviceTree (
   IN PCI_IO_DEVICE *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -118,14 +118,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 DestroyRootBridgeByHandle (
   EFI_HANDLE Controller
   )
-/*++
+/**
 
 Routine Description:
 
@@ -139,7 +139,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -148,7 +148,7 @@ RegisterPciDevice (
   IN  PCI_IO_DEVICE                  *PciIoDevice,
   OUT EFI_HANDLE                     *Handle OPTIONAL
   )
-/*++
+/**
 
 Routine Description:
 
@@ -164,7 +164,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -172,7 +172,7 @@ RemoveAllPciDeviceOnBridge (
   EFI_HANDLE               RootBridgeHandle,
   PCI_IO_DEVICE            *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -187,7 +187,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -195,7 +195,7 @@ DeRegisterPciDevice (
   IN  EFI_HANDLE                     Controller,
   IN  EFI_HANDLE                     Handle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -210,7 +210,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -221,7 +221,7 @@ StartPciDevicesOnBridge (
   IN OUT UINT8                           *NumberOfChildren,
   IN OUT EFI_HANDLE                      *ChildHandleBuffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -239,14 +239,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 StartPciDevices (
   IN EFI_HANDLE                         Controller
   )
-/*++
+/**
 
 Routine Description:
 
@@ -260,14 +260,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 PCI_IO_DEVICE *
 CreateRootBridge (
   IN EFI_HANDLE RootBridgeHandle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -281,14 +281,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 PCI_IO_DEVICE *
 GetRootBridgeByHandle (
   EFI_HANDLE RootBridgeHandle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -302,14 +302,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 BOOLEAN
 RootBridgeExisted (
   IN EFI_HANDLE RootBridgeHandle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -323,7 +323,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 BOOLEAN
@@ -331,7 +331,7 @@ PciDeviceExisted (
   IN PCI_IO_DEVICE    *Bridge,
   IN PCI_IO_DEVICE    *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -346,14 +346,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 PCI_IO_DEVICE *
 ActiveVGADeviceOnTheSameSegment (
   IN PCI_IO_DEVICE        *VgaDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -367,14 +367,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 PCI_IO_DEVICE *
 ActiveVGADeviceOnTheRootBridge (
   IN PCI_IO_DEVICE        *RootBridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -388,7 +388,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -397,7 +397,7 @@ GetHpcPciAddress (
   IN  EFI_DEVICE_PATH_PROTOCOL         *HpcDevicePath,
   OUT UINT64                           *PciAddress
   )
-/*++
+/**
 
 Routine Description:
 
@@ -413,7 +413,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -422,7 +422,7 @@ GetHpcPciAddressFromRootBridge (
   IN  EFI_DEVICE_PATH_PROTOCOL         *RemainingDevicePath,
   OUT UINT64                           *PciAddress
   )
-/*++
+/**
 
 Routine Description:
 
@@ -438,14 +438,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 FreePciDevice (
   IN PCI_IO_DEVICE *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -459,7 +459,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 #endif

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDriverOverride.c

@@ -18,7 +18,7 @@ EFI_STATUS
 InitializePciDriverOverrideInstance (
   PCI_IO_DEVICE  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -30,7 +30,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
@@ -44,7 +44,7 @@ GetDriver (
   IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL              *This,
   IN OUT EFI_HANDLE                                         *DriverImageHandle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -56,7 +56,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    DriverImageHandle - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -108,7 +108,7 @@ AddDriver (
   IN PCI_IO_DEVICE     *PciIoDevice,
   IN EFI_HANDLE        DriverImageHandle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -120,7 +120,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    DriverImageHandle - add argument and description to function comment
 // TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDriverOverride.h

@@ -32,7 +32,7 @@ EFI_STATUS
 InitializePciDriverOverrideInstance (
   PCI_IO_DEVICE  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -46,7 +46,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -54,7 +54,7 @@ AddDriver (
   IN PCI_IO_DEVICE     *PciIoDevice,
   IN EFI_HANDLE        DriverImageHandle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -69,7 +69,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -78,7 +78,7 @@ GetDriver (
   IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL              *This,
   IN OUT EFI_HANDLE                                         *DriverImageHandle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -93,7 +93,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 #endif

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciEnumerator.c

@@ -21,7 +21,7 @@ EFI_STATUS
 PciEnumerator (
   IN EFI_HANDLE                    Controller
   )
-/*++
+/**
 
 Routine Description:
 
@@ -34,7 +34,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Controller - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -139,7 +139,7 @@ PciRootBridgeEnumerator (
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL  *PciResAlloc,
   IN PCI_IO_DEVICE                                     *RootBridgeDev
   )
-/*++
+/**
 
 Routine Description:
 
@@ -149,7 +149,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciResAlloc - add argument and description to function comment
 // TODO:    RootBridgeDev - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -252,7 +252,7 @@ ProcessOptionRom (
   IN UINT64        RomBase,
   IN UINT64        MaxLength
   )
-/*++
+/**
 
 Routine Description:
 
@@ -264,7 +264,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    RomBase - add argument and description to function comment
 // TODO:    MaxLength - add argument and description to function comment
@@ -307,7 +307,7 @@ PciAssignBusNumber (
   IN UINT8                              StartBusNumber,
   OUT UINT8                             *SubBusNumber
   )
-/*++
+/**
 
 Routine Description:
 
@@ -319,7 +319,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    StartBusNumber - add argument and description to function comment
 // TODO:    SubBusNumber - add argument and description to function comment
@@ -456,7 +456,7 @@ DetermineRootBridgeAttributes (
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc,
   IN PCI_IO_DEVICE                                    *RootBridgeDev
   )
-/*++
+/**
 
 Routine Description:
 
@@ -469,7 +469,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciResAlloc - add argument and description to function comment
 // TODO:    RootBridgeDev - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -518,7 +518,7 @@ UINT64
 GetMaxOptionRomSize (
   IN PCI_IO_DEVICE   *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -530,7 +530,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 {
   LIST_ENTRY      *CurrentLink;
@@ -586,7 +586,7 @@ EFI_STATUS
 PciHostBridgeDeviceAttribute (
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc
   )
-/*++
+/**
 
 Routine Description:
 
@@ -598,7 +598,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciResAlloc - add argument and description to function comment
 // TODO:    EFI_NOT_FOUND - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -642,7 +642,7 @@ GetResourceAllocationStatus (
   OUT UINT64  *Mem64ResStatus,
   OUT UINT64  *PMem64ResStatus
   )
-/*++
+/**
 
 Routine Description:
 
@@ -654,7 +654,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    AcpiConfig - add argument and description to function comment
 // TODO:    IoResStatus - add argument and description to function comment
 // TODO:    Mem32ResStatus - add argument and description to function comment
@@ -728,7 +728,7 @@ EFI_STATUS
 RejectPciDevice (
   IN PCI_IO_DEVICE       *PciDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -740,7 +740,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciDevice - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 // TODO:    EFI_ABORTED - add return value to function comment
@@ -809,7 +809,7 @@ BOOLEAN
 IsRejectiveDevice (
   IN  PCI_RESOURCE_NODE   *PciResNode
   )
-/*++
+/**
 
 Routine Description:
 
@@ -821,7 +821,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciResNode - add argument and description to function comment
 {
   PCI_IO_DEVICE *Temp;
@@ -864,7 +864,7 @@ GetLargerConsumerDevice (
   IN  PCI_RESOURCE_NODE   *PciResNode1,
   IN  PCI_RESOURCE_NODE   *PciResNode2
   )
-/*++
+/**
 
 Routine Description:
 
@@ -876,7 +876,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciResNode1 - add argument and description to function comment
 // TODO:    PciResNode2 - add argument and description to function comment
 {
@@ -906,7 +906,7 @@ PCI_RESOURCE_NODE *
 GetMaxResourceConsumerDevice (
   IN  PCI_RESOURCE_NODE   *ResPool
   )
-/*++
+/**
 
 Routine Description:
 
@@ -918,7 +918,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    ResPool - add argument and description to function comment
 {
   PCI_RESOURCE_NODE *Temp;
@@ -966,7 +966,7 @@ PciHostBridgeAdjustAllocation (
   IN  UINT64              Mem64ResStatus,
   IN  UINT64              PMem64ResStatus
   )
-/*++
+/**
 
 Routine Description:
 
@@ -978,7 +978,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    IoPool - add argument and description to function comment
 // TODO:    Mem32Pool - add argument and description to function comment
 // TODO:    PMem32Pool - add argument and description to function comment
@@ -1108,7 +1108,7 @@ ConstructAcpiResourceRequestor (
   IN PCI_RESOURCE_NODE  *PMem64Node,
   OUT VOID              **pConfig
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1118,7 +1118,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    IoNode - add argument and description to function comment
 // TODO:    Mem32Node - add argument and description to function comment
@@ -1354,7 +1354,7 @@ GetResourceBase (
   OUT UINT64  *Mem64Base,
   OUT UINT64  *PMem64Base
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1364,7 +1364,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    pConfig - add argument and description to function comment
 // TODO:    IoBase - add argument and description to function comment
 // TODO:    Mem32Base - add argument and description to function comment
@@ -1448,7 +1448,7 @@ EFI_STATUS
 PciBridgeEnumerator (
   IN PCI_IO_DEVICE                                     *BridgeDev
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1458,7 +1458,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    BridgeDev - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
@@ -1512,7 +1512,7 @@ EFI_STATUS
 PciBridgeResourceAllocator (
   IN PCI_IO_DEVICE  *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1522,7 +1522,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
@@ -1676,7 +1676,7 @@ GetResourceBaseFromBridge (
   OUT UINT64        *Mem64Base,
   OUT UINT64        *PMem64Base
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1686,7 +1686,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    IoBase - add argument and description to function comment
 // TODO:    Mem32Base - add argument and description to function comment
@@ -1766,7 +1766,7 @@ NotifyPhase (
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc,
   EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE       Phase
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1776,7 +1776,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciResAlloc - add argument and description to function comment
 // TODO:    Phase - add argument and description to function comment
 // TODO:    EFI_NOT_FOUND - add return value to function comment
@@ -1850,7 +1850,7 @@ PreprocessController (
   IN UINT8                                            Func,
   IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE     Phase
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1860,7 +1860,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    Bus - add argument and description to function comment
 // TODO:    Device - add argument and description to function comment
@@ -1959,7 +1959,7 @@ PciHotPlugRequestNotify (
   IN OUT UINT8                        *NumberOfChildren,
   IN OUT EFI_HANDLE                   * ChildHandleBuffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1978,7 +1978,7 @@ Returns:
 
   Status code.
 
---*/
+**/
 // TODO:    RemainingDevicePath - add argument and description to function comment
 // TODO:    EFI_NOT_FOUND - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -2078,7 +2078,7 @@ BOOLEAN
 SearchHostBridgeHandle (
   IN EFI_HANDLE RootBridgeHandle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -2088,7 +2088,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    RootBridgeHandle - add argument and description to function comment
 {
   EFI_HANDLE                      HostBridgeHandle;
@@ -2126,7 +2126,7 @@ EFI_STATUS
 AddHostBridgeEnumerator (
   IN EFI_HANDLE HostBridgeHandle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -2136,7 +2136,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    HostBridgeHandle - add argument and description to function comment
 // TODO:    EFI_ABORTED - add return value to function comment
 // TODO:    EFI_ABORTED - add return value to function comment

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciEnumerator.h

@@ -21,7 +21,7 @@ EFI_STATUS
 PciEnumerator (
   IN EFI_HANDLE                    Controller
   )
-/*++
+/**
 
 Routine Description:
 
@@ -35,7 +35,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -43,7 +43,7 @@ PciRootBridgeEnumerator (
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL  *PciResAlloc,
   IN PCI_IO_DEVICE                                     *RootBridgeDev
   )
-/*++
+/**
 
 Routine Description:
 
@@ -58,7 +58,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -67,7 +67,7 @@ ProcessOptionRom (
   IN UINT64        RomBase,
   IN UINT64        MaxLength
   )
-/*++
+/**
 
 Routine Description:
 
@@ -83,7 +83,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -92,7 +92,7 @@ PciAssignBusNumber (
   IN UINT8                              StartBusNumber,
   OUT UINT8                             *SubBusNumber
   )
-/*++
+/**
 
 Routine Description:
 
@@ -108,7 +108,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -116,7 +116,7 @@ DetermineRootBridgeAttributes (
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc,
   IN PCI_IO_DEVICE                                    *RootBridgeDev
   )
-/*++
+/**
 
 Routine Description:
 
@@ -131,14 +131,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 UINT64
 GetMaxOptionRomSize (
   IN PCI_IO_DEVICE   *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -152,14 +152,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 PciHostBridgeDeviceAttribute (
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc
   )
-/*++
+/**
 
 Routine Description:
 
@@ -173,7 +173,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -185,7 +185,7 @@ GetResourceAllocationStatus (
   OUT UINT64  *Mem64ResStatus,
   OUT UINT64  *PMem64ResStatus
   )
-/*++
+/**
 
 Routine Description:
 
@@ -204,14 +204,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 RejectPciDevice (
   IN PCI_IO_DEVICE       *PciDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -225,14 +225,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 BOOLEAN
 IsRejectiveDevice (
   IN  PCI_RESOURCE_NODE   *PciResNode
   )
-/*++
+/**
 
 Routine Description:
 
@@ -246,7 +246,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 PCI_RESOURCE_NODE *
@@ -254,7 +254,7 @@ GetLargerConsumerDevice (
   IN  PCI_RESOURCE_NODE   *PciResNode1,
   IN  PCI_RESOURCE_NODE   *PciResNode2
   )
-/*++
+/**
 
 Routine Description:
 
@@ -269,14 +269,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 PCI_RESOURCE_NODE *
 GetMaxResourceConsumerDevice (
   IN  PCI_RESOURCE_NODE   *ResPool
   )
-/*++
+/**
 
 Routine Description:
 
@@ -290,7 +290,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -306,7 +306,7 @@ PciHostBridgeAdjustAllocation (
   IN  UINT64              Mem64ResStatus,
   IN  UINT64              PMem64ResStatus
   )
-/*++
+/**
 
 Routine Description:
 
@@ -329,7 +329,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -342,7 +342,7 @@ ConstructAcpiResourceRequestor (
   IN PCI_RESOURCE_NODE  *PMem64Node,
   OUT VOID              **pConfig
   )
-/*++
+/**
 
 Routine Description:
 
@@ -362,7 +362,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -374,7 +374,7 @@ GetResourceBase (
   OUT UINT64  *Mem64Base,
   OUT UINT64  *PMem64Base
   )
-/*++
+/**
 
 Routine Description:
 
@@ -393,14 +393,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 PciBridgeEnumerator (
   IN PCI_IO_DEVICE                                     *BridgeDev
   )
-/*++
+/**
 
 Routine Description:
 
@@ -414,14 +414,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 PciBridgeResourceAllocator (
   IN PCI_IO_DEVICE  *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -435,7 +435,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -447,7 +447,7 @@ GetResourceBaseFromBridge (
   OUT UINT64        *Mem64Base,
   OUT UINT64        *PMem64Base
   )
-/*++
+/**
 
 Routine Description:
 
@@ -466,14 +466,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 PciHostBridgeP2CProcess (
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc
   )
-/*++
+/**
 
 Routine Description:
 
@@ -487,7 +487,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -495,7 +495,7 @@ NotifyPhase (
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc,
   EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE       Phase
   )
-/*++
+/**
 
 Routine Description:
 
@@ -510,7 +510,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -521,7 +521,7 @@ PreprocessController (
   IN UINT8                                          Func,
   IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE   Phase
   )
-/*++
+/**
 
 Routine Description:
 
@@ -539,7 +539,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -552,7 +552,7 @@ PciHotPlugRequestNotify (
   IN OUT UINT8                        *NumberOfChildren,
   IN OUT EFI_HANDLE                   * ChildHandleBuffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -571,14 +571,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 BOOLEAN
 SearchHostBridgeHandle (
   IN EFI_HANDLE RootBridgeHandle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -592,14 +592,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 AddHostBridgeEnumerator (
   IN EFI_HANDLE HostBridgeHandle
   )
-/*++
+/**
 
 Routine Description:
 
@@ -613,7 +613,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 #endif

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciEnumeratorSupport.c

@@ -25,7 +25,7 @@ PciDevicePresent (
   UINT8                               Device,
   UINT8                               Func
   )
-/*++
+/**
 
 Routine Description:
 
@@ -37,7 +37,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciRootBridgeIo - add argument and description to function comment
 // TODO:    Pci - add argument and description to function comment
 // TODO:    Bus - add argument and description to function comment
@@ -92,7 +92,7 @@ PciPciDeviceInfoCollector (
   IN PCI_IO_DEVICE                      *Bridge,
   UINT8                                 StartBusNumber
   )
-/*++
+/**
 
 Routine Description:
 
@@ -102,7 +102,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    StartBusNumber - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -210,7 +210,7 @@ PciSearchDevice (
   IN  UINT8                                 Func,
   OUT PCI_IO_DEVICE                         **PciDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -229,7 +229,7 @@ Returns:
 
   Status code.
 
---*/
+**/
 // TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment
 // TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -339,7 +339,7 @@ GatherDeviceInfo (
   UINT8                               Device,
   UINT8                               Func
   )
-/*++
+/**
 
 Routine Description:
 
@@ -349,7 +349,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    Pci - add argument and description to function comment
 // TODO:    Bus - add argument and description to function comment
@@ -409,7 +409,7 @@ GatherPpbInfo (
   UINT8                               Device,
   UINT8                               Func
   )
-/*++
+/**
 
 Routine Description:
 
@@ -419,7 +419,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    Pci - add argument and description to function comment
 // TODO:    Bus - add argument and description to function comment
@@ -543,7 +543,7 @@ GatherP2CInfo (
   UINT8                               Device,
   UINT8                               Func
   )
-/*++
+/**
 
 Routine Description:
 
@@ -553,7 +553,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    Pci - add argument and description to function comment
 // TODO:    Bus - add argument and description to function comment
@@ -614,7 +614,7 @@ CreatePciDevicePath (
   IN  EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath,
   IN  PCI_IO_DEVICE            *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -624,7 +624,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    ParentDevicePath - add argument and description to function comment
 // TODO:    PciIoDevice - add argument and description to function comment
 {
@@ -652,7 +652,7 @@ BarExisted (
   OUT UINT32       *BarLengthValue,
   OUT UINT32       *OriginalBarValue
   )
-/*++
+/**
 
 Routine Description:
 
@@ -670,7 +670,7 @@ Returns:
   EFI_NOT_FOUND     - The bar don't exist.
   EFI_SUCCESS       - The bar exist.
 
---*/
+**/
 {
   EFI_PCI_IO_PROTOCOL *PciIo;
   UINT32              OriginalValue;
@@ -726,7 +726,7 @@ PciTestSupportedAttribute (
   IN UINT16                             *OldCommand,
   IN UINT16                             *OldBridgeControl
   )
-/*++
+/**
 
 Routine Description:
 
@@ -736,7 +736,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    Command - add argument and description to function comment
 // TODO:    BridgeControl - add argument and description to function comment
@@ -809,7 +809,7 @@ PciSetDeviceAttribute (
   IN UINT16                             BridgeControl,
   IN UINTN                              Option
   )
-/*++
+/**
 
   Routine Description:
     Set the supported or current attributes of a PCI device
@@ -822,9 +822,9 @@ PciSetDeviceAttribute (
 
   Returns:
 
---*/
+**/
 
-/*++
+/**
 
 Routine Description:
 
@@ -838,7 +838,7 @@ Returns:
   EFI_SUCCESS   Always success
 
 
---*/
+**/
 {
   UINT64  Attributes;
 
@@ -925,7 +925,7 @@ GetFastBackToBackSupport (
   IN PCI_IO_DEVICE                      *PciIoDevice,
   IN UINT8                              StatusIndex
   )
-/*++
+/**
 
 Routine Description:
 
@@ -937,7 +937,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    StatusIndex - add argument and description to function comment
 // TODO:    EFI_UNSUPPORTED - add return value to function comment
@@ -973,7 +973,7 @@ EFI_STATUS
 ProcessOptionRomLight (
   IN PCI_IO_DEVICE                      *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -986,7 +986,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
@@ -1022,7 +1022,7 @@ EFI_STATUS
 DetermineDeviceAttribute (
   IN PCI_IO_DEVICE                      *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1034,7 +1034,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
@@ -1201,7 +1201,7 @@ EFI_STATUS
 UpdatePciInfo (
   IN PCI_IO_DEVICE  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1213,7 +1213,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    EFI_UNSUPPORTED - add return value to function comment
 {
@@ -1359,7 +1359,7 @@ SetNewAlign (
   IN UINT64 *Alignment,
   IN UINT64 NewAlignment
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1371,7 +1371,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Alignment - add argument and description to function comment
 // TODO:    NewAlignment - add argument and description to function comment
 {
@@ -1438,7 +1438,7 @@ PciParseBar (
   IN UINTN          Offset,
   IN UINTN          BarIndex
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1448,7 +1448,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    Offset - add argument and description to function comment
 // TODO:    BarIndex - add argument and description to function comment
@@ -1628,7 +1628,7 @@ EFI_STATUS
 InitializePciDevice (
   IN PCI_IO_DEVICE *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1641,7 +1641,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
@@ -1666,7 +1666,7 @@ EFI_STATUS
 InitializePpb (
   IN PCI_IO_DEVICE *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1676,7 +1676,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
@@ -1719,7 +1719,7 @@ EFI_STATUS
 InitializeP2C (
   IN PCI_IO_DEVICE *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1729,7 +1729,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
@@ -1769,7 +1769,7 @@ CreatePciIoDevice (
   UINT8                               Device,
   UINT8                               Func
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1779,7 +1779,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciRootBridgeIo - add argument and description to function comment
 // TODO:    Pci - add argument and description to function comment
 // TODO:    Bus - add argument and description to function comment
@@ -1862,7 +1862,7 @@ EFI_STATUS
 PciEnumeratorLight (
   IN EFI_HANDLE                    Controller
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1876,7 +1876,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Controller - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -1985,7 +1985,7 @@ PciGetBusRange (
   OUT    UINT16                             *MaxBus,
   OUT    UINT16                             *BusRange
   )
-/*++
+/**
 
 Routine Description:
 
@@ -2002,7 +2002,7 @@ Returns:
 
   Status Code.
 
---*/
+**/
 // TODO:    EFI_SUCCESS - add return value to function comment
 // TODO:    EFI_NOT_FOUND - add return value to function comment
 {
@@ -2034,7 +2034,7 @@ EFI_STATUS
 StartManagingRootBridge (
   IN PCI_IO_DEVICE *RootBridgeDev
   )
-/*++
+/**
 
 Routine Description:
 
@@ -2045,7 +2045,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    RootBridgeDev - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
@@ -2088,7 +2088,7 @@ BOOLEAN
 IsPciDeviceRejected (
   IN PCI_IO_DEVICE *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -2101,7 +2101,7 @@ Returns:
   TRUE      This device should be rejected
   FALSE     This device shouldn't be rejected
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 {
   EFI_STATUS  Status;
@@ -2209,7 +2209,7 @@ ResetAllPpbBusNumber (
   IN PCI_IO_DEVICE                      *Bridge,
   IN UINT8                              StartBusNumber
   )
-/*++
+/**
 
 Routine Description:
 
@@ -2224,7 +2224,7 @@ Returns:
 
   EFI_SUCCESS - TODO: Add description for return value
 
---*/
+**/
 {
   EFI_STATUS                      Status;
   PCI_TYPE00                      Pci;

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciEnumeratorSupport.h

@@ -23,7 +23,7 @@ PciDevicePresent (
   UINT8                               Device,
   UINT8                               Func
   )
-/*++
+/**
 
 Routine Description:
 
@@ -41,7 +41,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -49,7 +49,7 @@ PciPciDeviceInfoCollector (
   IN PCI_IO_DEVICE                      *Bridge,
   UINT8                                 StartBusNumber
   )
-/*++
+/**
 
 Routine Description:
 
@@ -64,7 +64,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -76,7 +76,7 @@ PciSearchDevice (
   UINT8                                 Func,
   PCI_IO_DEVICE                         **PciDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -95,7 +95,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 PCI_IO_DEVICE             *
@@ -106,7 +106,7 @@ GatherDeviceInfo (
   UINT8                               Device,
   UINT8                               Func
   )
-/*++
+/**
 
 Routine Description:
 
@@ -124,7 +124,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 PCI_IO_DEVICE             *
@@ -135,7 +135,7 @@ GatherPpbInfo (
   UINT8                               Device,
   UINT8                               Func
   )
-/*++
+/**
 
 Routine Description:
 
@@ -153,7 +153,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 PCI_IO_DEVICE             *
@@ -164,7 +164,7 @@ GatherP2CInfo (
   UINT8                               Device,
   UINT8                               Func
   )
-/*++
+/**
 
 Routine Description:
 
@@ -182,7 +182,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_DEVICE_PATH_PROTOCOL  *
@@ -190,7 +190,7 @@ CreatePciDevicePath (
   IN  EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath,
   IN  PCI_IO_DEVICE            *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -205,7 +205,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -215,7 +215,7 @@ BarExisted (
   OUT UINT32       *BarLengthValue,
   OUT UINT32       *OriginalBarValue
   )
-/*++
+/**
 
 Routine Description:
 
@@ -232,7 +232,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -243,7 +243,7 @@ PciTestSupportedAttribute (
   IN UINT16                             *OldCommand,
   IN UINT16                             *OldBridgeControl
   )
-/*++
+/**
 
 Routine Description:
 
@@ -261,7 +261,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -271,7 +271,7 @@ PciSetDeviceAttribute (
   IN UINT16                             BridgeControl,
   IN UINTN                              Option
   )
-/*++
+/**
 
 Routine Description:
 
@@ -288,7 +288,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -296,7 +296,7 @@ GetFastBackToBackSupport (
   IN PCI_IO_DEVICE                      *PciIoDevice,
   IN UINT8                              StatusIndex
   )
-/*++
+/**
 
 Routine Description:
 
@@ -311,14 +311,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 DetermineDeviceAttribute (
   IN PCI_IO_DEVICE                      *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -332,14 +332,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 UpdatePciInfo (
   IN PCI_IO_DEVICE  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -353,7 +353,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 VOID
@@ -361,7 +361,7 @@ SetNewAlign (
   IN UINT64 *Alignment,
   IN UINT64 NewAlignment
   )
-/*++
+/**
 
 Routine Description:
 
@@ -376,7 +376,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 UINTN
@@ -385,7 +385,7 @@ PciParseBar (
   IN UINTN          Offset,
   IN UINTN          BarIndex
   )
-/*++
+/**
 
 Routine Description:
 
@@ -401,14 +401,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 InitializePciDevice (
   IN PCI_IO_DEVICE *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -422,14 +422,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 InitializePpb (
   IN PCI_IO_DEVICE *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -443,14 +443,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 InitializeP2C (
   IN PCI_IO_DEVICE *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -464,7 +464,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 PCI_IO_DEVICE             *
@@ -475,7 +475,7 @@ CreatePciIoDevice (
   UINT8                               Device,
   UINT8                               Func
   )
-/*++
+/**
 
 Routine Description:
 
@@ -493,14 +493,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 PciEnumeratorLight (
   IN EFI_HANDLE                    Controller
   )
-/*++
+/**
 
 Routine Description:
 
@@ -514,7 +514,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -524,7 +524,7 @@ PciGetBusRange (
   OUT    UINT16                             *MaxBus,
   OUT    UINT16                             *BusRange
   )
-/*++
+/**
 
 Routine Description:
 
@@ -541,14 +541,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 StartManagingRootBridge (
   IN PCI_IO_DEVICE *RootBridgeDev
   )
-/*++
+/**
 
 Routine Description:
 
@@ -562,14 +562,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 BOOLEAN
 IsPciDeviceRejected (
   IN PCI_IO_DEVICE *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -583,7 +583,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 #endif

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciHotPlugSupport.c

@@ -26,7 +26,7 @@ PciHPCInitialized (
   IN EFI_EVENT    Event,
   IN VOID         *Context
   )
-/*++
+/**
 
 Routine Description:
 
@@ -36,7 +36,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Event - add argument and description to function comment
 // TODO:    Context - add argument and description to function comment
 {
@@ -52,7 +52,7 @@ EfiCompareDevicePath (
   IN EFI_DEVICE_PATH_PROTOCOL *DevicePath1,
   IN EFI_DEVICE_PATH_PROTOCOL *DevicePath2
   )
-/*++
+/**
 
 Routine Description:
 
@@ -62,7 +62,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    DevicePath1 - add argument and description to function comment
 // TODO:    DevicePath2 - add argument and description to function comment
 {
@@ -87,7 +87,7 @@ EFI_STATUS
 InitializeHotPlugSupport (
   VOID
   )
-/*++
+/**
 
 Routine Description:
 
@@ -97,7 +97,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_UNSUPPORTED - add return value to function comment
 // TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -153,7 +153,7 @@ IsRootPciHotPlugBus (
   IN EFI_DEVICE_PATH_PROTOCOL         *HpbDevicePath,
   OUT UINTN                           *HpIndex
   )
-/*++
+/**
 
 Routine Description:
 
@@ -166,7 +166,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    HpbDevicePath - add argument and description to function comment
 {
   UINTN Index;
@@ -191,7 +191,7 @@ IsRootPciHotPlugController (
   IN EFI_DEVICE_PATH_PROTOCOL         *HpcDevicePath,
   OUT UINTN                           *HpIndex
   )
-/*++
+/**
 
 Routine Description:
 
@@ -204,7 +204,7 @@ Returns:
 
   None
 
---*/
+**/
 {
   UINTN Index;
 
@@ -228,7 +228,7 @@ CreateEventForHpc (
   IN UINTN       HpIndex,
   OUT EFI_EVENT  *Event
   )
-/*++
+/**
 
 Routine Description:
 
@@ -238,7 +238,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    HpIndex - add argument and description to function comment
 // TODO:    Event - add argument and description to function comment
 {
@@ -263,7 +263,7 @@ EFI_STATUS
 AllRootHPCInitialized (
   IN  UINTN           TimeoutInMicroSeconds
   )
-/*++
+/**
 
 Routine Description:
 
@@ -274,7 +274,7 @@ Returns:
   EFI_SUCCESS - All root hpc's initialization is finished before the timeout
   EFI_TIMEOUT - Time out
 
---*/
+**/
 {
   UINT32  Delay;
   UINTN   Index;
@@ -309,7 +309,7 @@ EFI_STATUS
 IsSHPC (
   PCI_IO_DEVICE                       *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -319,7 +319,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    EFI_NOT_FOUND - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -356,7 +356,7 @@ EFI_STATUS
 GetResourcePaddingForHpb (
   IN PCI_IO_DEVICE *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -366,7 +366,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 // TODO:    EFI_NOT_FOUND - add return value to function comment
@@ -409,7 +409,7 @@ EFI_STATUS
 IsPciHotPlugBus (
   PCI_IO_DEVICE                       *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -419,7 +419,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciHotPlugSupport.h

@@ -38,7 +38,7 @@ PciHPCInitialized (
   IN EFI_EVENT    Event,
   IN VOID         *Context
   )
-/*++
+/**
 
 Routine Description:
 
@@ -53,7 +53,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 BOOLEAN
@@ -61,7 +61,7 @@ EfiCompareDevicePath (
   IN EFI_DEVICE_PATH_PROTOCOL *DevicePath1,
   IN EFI_DEVICE_PATH_PROTOCOL *DevicePath2
   )
-/*++
+/**
 
 Routine Description:
 
@@ -76,14 +76,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 InitializeHotPlugSupport (
   VOID
   )
-/*++
+/**
 
 Routine Description:
 
@@ -97,14 +97,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 IsPciHotPlugBus (
   PCI_IO_DEVICE                       *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -118,7 +118,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 BOOLEAN
@@ -126,7 +126,7 @@ IsRootPciHotPlugBus (
   IN EFI_DEVICE_PATH_PROTOCOL         *HpbDevicePath,
   OUT UINTN                           *HpIndex
   )
-/*++
+/**
 
 Routine Description:
 
@@ -141,7 +141,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 BOOLEAN
@@ -149,7 +149,7 @@ IsRootPciHotPlugController (
   IN EFI_DEVICE_PATH_PROTOCOL         *HpcDevicePath,
   OUT UINTN                           *HpIndex
   )
-/*++
+/**
 
 Routine Description:
 
@@ -164,7 +164,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -172,7 +172,7 @@ CreateEventForHpc (
   IN UINTN       HpIndex,
   OUT EFI_EVENT  *Event
   )
-/*++
+/**
 
 Routine Description:
 
@@ -187,14 +187,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 AllRootHPCInitialized (
   IN  UINTN           TimeoutInMicroSeconds
   )
-/*++
+/**
 
 Routine Description:
 
@@ -207,14 +207,14 @@ Returns:
   EFI_SUCCESS - All root hpc's initialization is finished before the timeout
   EFI_TIMEOUT - Time out
 
---*/
+**/
 ;
 
 EFI_STATUS
 IsSHPC (
   PCI_IO_DEVICE                       *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -228,14 +228,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 GetResourcePaddingForHpb (
   IN PCI_IO_DEVICE *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -249,7 +249,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 #endif

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciIo.c

@@ -66,7 +66,7 @@ ReportErrorStatusCode (
   IN PCI_IO_DEVICE               *PciIoDevice,
   IN EFI_STATUS_CODE_VALUE       Code
   )
-/*++
+/**
 
 Routine Description:
 
@@ -78,7 +78,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    Code - add argument and description to function comment
 {
@@ -93,7 +93,7 @@ EFI_STATUS
 InitializePciIoInstance (
   PCI_IO_DEVICE  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -105,7 +105,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
@@ -122,7 +122,7 @@ PciIoVerifyBarAccess (
   IN UINTN                        Count,
   UINT64                          *Offset
   )
-/*++
+/**
 
 Routine Description:
 
@@ -134,7 +134,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    BarIndex - add argument and description to function comment
 // TODO:    Type - add argument and description to function comment
@@ -193,7 +193,7 @@ PciIoVerifyConfigAccess (
   IN UINTN                      Count,
   IN UINT64                     *Offset
   )
-/*++
+/**
 
 Routine Description:
 
@@ -205,7 +205,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    Width - add argument and description to function comment
 // TODO:    Count - add argument and description to function comment
@@ -258,7 +258,7 @@ PciIoPollMem (
   IN  UINT64                     Delay,
   OUT UINT64                     *Result
   )
-/*++
+/**
 
 Routine Description:
 
@@ -270,7 +270,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Width - add argument and description to function comment
 // TODO:    BarIndex - add argument and description to function comment
@@ -330,7 +330,7 @@ PciIoPollIo (
   IN  UINT64                     Delay,
   OUT UINT64                     *Result
   )
-/*++
+/**
 
 Routine Description:
 
@@ -342,7 +342,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Width - add argument and description to function comment
 // TODO:    BarIndex - add argument and description to function comment
@@ -396,7 +396,7 @@ PciIoMemRead (
   IN     UINTN                      Count,
   IN OUT VOID                       *Buffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -408,7 +408,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Width - add argument and description to function comment
 // TODO:    BarIndex - add argument and description to function comment
@@ -457,7 +457,7 @@ PciIoMemWrite (
   IN     UINTN                      Count,
   IN OUT VOID                       *Buffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -469,7 +469,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Width - add argument and description to function comment
 // TODO:    BarIndex - add argument and description to function comment
@@ -518,7 +518,7 @@ PciIoIoRead (
   IN     UINTN                      Count,
   IN OUT VOID                       *Buffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -530,7 +530,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Width - add argument and description to function comment
 // TODO:    BarIndex - add argument and description to function comment
@@ -579,7 +579,7 @@ PciIoIoWrite (
   IN     UINTN                      Count,
   IN OUT VOID                       *Buffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -591,7 +591,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Width - add argument and description to function comment
 // TODO:    BarIndex - add argument and description to function comment
@@ -639,7 +639,7 @@ PciIoConfigRead (
   IN     UINTN                      Count,
   IN OUT VOID                       *Buffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -651,7 +651,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Width - add argument and description to function comment
 // TODO:    Offset - add argument and description to function comment
@@ -694,7 +694,7 @@ PciIoConfigWrite (
   IN     UINTN                      Count,
   IN OUT VOID                       *Buffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -706,7 +706,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Width - add argument and description to function comment
 // TODO:    Offset - add argument and description to function comment
@@ -751,7 +751,7 @@ PciIoCopyMem (
   IN     UINT64                       SrcOffset,
   IN     UINTN                        Count
   )
-/*++
+/**
 
 Routine Description:
 
@@ -763,7 +763,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Width - add argument and description to function comment
 // TODO:    DestBarIndex - add argument and description to function comment
@@ -831,7 +831,7 @@ PciIoMap (
   OUT    EFI_PHYSICAL_ADDRESS           *DeviceAddress,
   OUT    VOID                           **Mapping
   )
-/*++
+/**
 
 Routine Description:
 
@@ -843,7 +843,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Operation - add argument and description to function comment
 // TODO:    HostAddress - add argument and description to function comment
@@ -892,7 +892,7 @@ PciIoUnmap (
   IN  EFI_PCI_IO_PROTOCOL  *This,
   IN  VOID                 *Mapping
   )
-/*++
+/**
 
 Routine Description:
 
@@ -904,7 +904,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Mapping - add argument and description to function comment
 {
@@ -935,7 +935,7 @@ PciIoAllocateBuffer (
   OUT VOID                  **HostAddress,
   IN  UINT64                Attributes
   )
-/*++
+/**
 
 Routine Description:
 
@@ -947,7 +947,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Type - add argument and description to function comment
 // TODO:    MemoryType - add argument and description to function comment
@@ -993,7 +993,7 @@ PciIoFreeBuffer (
   IN  UINTN                 Pages,
   IN  VOID                  *HostAddress
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1005,7 +1005,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Pages - add argument and description to function comment
 // TODO:    HostAddress - add argument and description to function comment
@@ -1033,7 +1033,7 @@ EFIAPI
 PciIoFlush (
   IN  EFI_PCI_IO_PROTOCOL  *This
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1045,7 +1045,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 {
   EFI_STATUS    Status;
@@ -1072,7 +1072,7 @@ PciIoGetLocation (
   OUT UINTN                *Device,
   OUT UINTN                *Function
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1084,7 +1084,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Segment - add argument and description to function comment
 // TODO:    Bus - add argument and description to function comment
@@ -1115,7 +1115,7 @@ CheckBarType (
   UINT8                  BarIndex,
   PCI_BAR_TYPE           BarType
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1127,7 +1127,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    BarIndex - add argument and description to function comment
 // TODO:    BarType - add argument and description to function comment
@@ -1166,7 +1166,7 @@ ModifyRootBridgeAttributes (
   IN  UINT64                                   Attributes,
   IN  EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION  Operation
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1178,7 +1178,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    Attributes - add argument and description to function comment
 // TODO:    Operation - add argument and description to function comment
@@ -1244,7 +1244,7 @@ SupportPaletteSnoopAttributes (
   IN  PCI_IO_DEVICE                            *PciIoDevice,
   IN  EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION  Operation
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1256,7 +1256,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    Operation - add argument and description to function comment
 // TODO:    EFI_UNSUPPORTED - add return value to function comment
@@ -1372,7 +1372,7 @@ PciIoAttributes (
   IN  UINT64                                   Attributes,
   OUT UINT64                                   *Result OPTIONAL
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1383,7 +1383,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Operation - add argument and description to function comment
 // TODO:    Attributes - add argument and description to function comment
@@ -1666,7 +1666,7 @@ PciIoGetBarAttributes (
   OUT UINT64                         *Supports, OPTIONAL
   OUT VOID                           **Resources OPTIONAL
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1677,7 +1677,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    BarIndex - add argument and description to function comment
 // TODO:    Supports - add argument and description to function comment
@@ -1830,7 +1830,7 @@ PciIoSetBarAttributes (
   IN OUT UINT64                       *Offset,
   IN OUT UINT64                       *Length
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1841,7 +1841,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Attributes - add argument and description to function comment
 // TODO:    BarIndex - add argument and description to function comment
@@ -1905,7 +1905,7 @@ UpStreamBridgesAttributes (
   IN  EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION  Operation,
   IN  UINT64                                   Attributes
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1915,7 +1915,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    Operation - add argument and description to function comment
 // TODO:    Attributes - add argument and description to function comment
@@ -1946,7 +1946,7 @@ PciDevicesOnTheSamePath (
   IN PCI_IO_DEVICE        *PciDevice1,
   IN PCI_IO_DEVICE        *PciDevice2
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1956,7 +1956,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciDevice1 - add argument and description to function comment
 // TODO:    PciDevice2 - add argument and description to function comment
 {

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciIo.h

@@ -19,7 +19,7 @@ EFI_STATUS
 InitializePciIoInstance (
   PCI_IO_DEVICE  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -33,7 +33,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -45,7 +45,7 @@ PciIoVerifyBarAccess (
   IN UINTN                        Count,
   UINT64                          *Offset
   )
-/*++
+/**
 
 Routine Description:
 
@@ -64,7 +64,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -74,7 +74,7 @@ PciIoVerifyConfigAccess (
   IN UINTN                      Count,
   IN UINT64                     *Offset
   )
-/*++
+/**
 
 Routine Description:
 
@@ -91,7 +91,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -106,7 +106,7 @@ PciIoPollMem (
   IN  UINT64                     Delay,
   OUT UINT64                     *Result
   )
-/*++
+/**
 
 Routine Description:
 
@@ -127,7 +127,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -142,7 +142,7 @@ PciIoPollIo (
   IN  UINT64                     Delay,
   OUT UINT64                     *Result
   )
-/*++
+/**
 
 Routine Description:
 
@@ -163,7 +163,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -176,7 +176,7 @@ PciIoMemRead (
   IN     UINTN                      Count,
   IN OUT VOID                       *Buffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -195,7 +195,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -208,7 +208,7 @@ PciIoMemWrite (
   IN     UINTN                      Count,
   IN OUT VOID                       *Buffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -227,7 +227,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -240,7 +240,7 @@ PciIoIoRead (
   IN     UINTN                      Count,
   IN OUT VOID                       *Buffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -259,7 +259,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -272,7 +272,7 @@ PciIoIoWrite (
   IN     UINTN                      Count,
   IN OUT VOID                       *Buffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -291,7 +291,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -303,7 +303,7 @@ PciIoConfigRead (
   IN     UINTN                      Count,
   IN OUT VOID                       *Buffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -321,7 +321,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -333,7 +333,7 @@ PciIoConfigWrite (
   IN     UINTN                      Count,
   IN OUT VOID                       *Buffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -351,7 +351,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -365,7 +365,7 @@ PciIoCopyMem (
   IN     UINT64                       SrcOffset,
   IN     UINTN                        Count
   )
-/*++
+/**
 
 Routine Description:
 
@@ -385,7 +385,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -398,7 +398,7 @@ PciIoMap (
   OUT    EFI_PHYSICAL_ADDRESS           *DeviceAddress,
   OUT    VOID                           **Mapping
   )
-/*++
+/**
 
 Routine Description:
 
@@ -417,7 +417,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -426,7 +426,7 @@ PciIoUnmap (
   IN  EFI_PCI_IO_PROTOCOL  *This,
   IN  VOID                 *Mapping
   )
-/*++
+/**
 
 Routine Description:
 
@@ -441,7 +441,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -454,7 +454,7 @@ PciIoAllocateBuffer (
   OUT VOID                  **HostAddress,
   IN  UINT64                Attributes
   )
-/*++
+/**
 
 Routine Description:
 
@@ -473,7 +473,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -483,7 +483,7 @@ PciIoFreeBuffer (
   IN  UINTN                 Pages,
   IN  VOID                  *HostAddress
   )
-/*++
+/**
 
 Routine Description:
 
@@ -499,7 +499,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -507,7 +507,7 @@ EFIAPI
 PciIoFlush (
   IN  EFI_PCI_IO_PROTOCOL  *This
   )
-/*++
+/**
 
 Routine Description:
 
@@ -521,7 +521,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -533,7 +533,7 @@ PciIoGetLocation (
   OUT UINTN                *Device,
   OUT UINTN                *Function
   )
-/*++
+/**
 
 Routine Description:
 
@@ -551,7 +551,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 BOOLEAN
@@ -560,7 +560,7 @@ CheckBarType (
   UINT8                  BarIndex,
   PCI_BAR_TYPE           BarType
   )
-/*++
+/**
 
 Routine Description:
 
@@ -576,7 +576,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -585,7 +585,7 @@ ModifyRootBridgeAttributes (
   IN  UINT64                                   Attributes,
   IN  EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION  Operation
   )
-/*++
+/**
 
 Routine Description:
 
@@ -601,7 +601,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -609,7 +609,7 @@ SupportPaletteSnoopAttributes (
   IN  PCI_IO_DEVICE                            *PciIoDevice,
   IN  EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION  Operation
   )
-/*++
+/**
 
 Routine Description:
 
@@ -624,7 +624,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -635,7 +635,7 @@ PciIoAttributes (
   IN  UINT64                                   Attributes,
   OUT UINT64                                   *Result OPTIONAL
   )
-/*++
+/**
 
 Routine Description:
 
@@ -652,7 +652,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -663,7 +663,7 @@ PciIoGetBarAttributes (
   OUT UINT64                         *Supports, OPTIONAL
   OUT VOID                           **Resources OPTIONAL
   )
-/*++
+/**
 
 Routine Description:
 
@@ -680,7 +680,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -692,7 +692,7 @@ PciIoSetBarAttributes (
   IN OUT UINT64                       *Offset,
   IN OUT UINT64                       *Length
   )
-/*++
+/**
 
 Routine Description:
 
@@ -710,7 +710,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -719,7 +719,7 @@ UpStreamBridgesAttributes (
   IN  EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION  Operation,
   IN  UINT64                                   Attributes
   )
-/*++
+/**
 
 Routine Description:
 
@@ -735,7 +735,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 BOOLEAN
@@ -743,7 +743,7 @@ PciDevicesOnTheSamePath (
   IN PCI_IO_DEVICE        *PciDevice1,
   IN PCI_IO_DEVICE        *PciDevice2
   )
-/*++
+/**
 
 Routine Description:
 
@@ -758,7 +758,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 #endif

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.c

@@ -26,7 +26,7 @@ VOID
 InstallHotPlugRequestProtocol (
   IN EFI_STATUS *Status
   )
-/*++
+/**
 
 Routine Description:
 
@@ -37,7 +37,7 @@ Returns:
 
   None
 
---*/
+**/
 {
   EFI_HANDLE  Handle;
 
@@ -58,7 +58,7 @@ VOID
 InstallPciHotplugGuid (
   IN  PCI_IO_DEVICE                  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -70,7 +70,7 @@ Returns:
 
   None
 
---*/
+**/
 {
   EFI_STATUS  Status;
 
@@ -94,7 +94,7 @@ VOID
 UninstallPciHotplugGuid (
   IN  PCI_IO_DEVICE                  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -106,7 +106,7 @@ Returns:
 
   None
 
---*/
+**/
 {
   EFI_STATUS  Status;
 
@@ -140,7 +140,7 @@ VOID
 GetBackPcCardBar (
   IN  PCI_IO_DEVICE                  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -153,7 +153,7 @@ Returns:
 
   None
 
---*/
+**/
 {
   UINT32  Address;
 
@@ -227,7 +227,7 @@ RemoveRejectedPciDevices (
   EFI_HANDLE        RootBridgeHandle,
   IN PCI_IO_DEVICE  *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -241,7 +241,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
   PCI_IO_DEVICE   *Temp;
@@ -316,7 +316,7 @@ EFI_STATUS
 PciHostBridgeResourceAllocator_WithoutHotPlugDeviceSupport (
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc
   )
-/*++
+/**
 
 Routine Description:
 
@@ -326,7 +326,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciResAlloc - add argument and description to function comment
 // TODO:    EFI_NOT_FOUND - add return value to function comment
 // TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment
@@ -689,7 +689,7 @@ EFI_STATUS
 PciHostBridgeResourceAllocator_WithHotPlugDeviceSupport (
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc
   )
-/*++
+/**
 
 Routine Description:
 
@@ -703,7 +703,7 @@ Returns:
 
   EFI Status.
 
---*/
+**/
 // TODO:    EFI_NOT_FOUND - add return value to function comment
 // TODO:    EFI_NOT_FOUND - add return value to function comment
 // TODO:    EFI_NOT_FOUND - add return value to function comment
@@ -1224,7 +1224,7 @@ PciScanBus_WithoutHotPlugDeviceSupport (
   OUT UINT8                             *SubBusNumber,
   OUT UINT8                             *PaddedBusRange
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1236,7 +1236,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    StartBusNumber - add argument and description to function comment
 // TODO:    SubBusNumber - add argument and description to function comment
@@ -1409,7 +1409,7 @@ PciScanBus_WithHotPlugDeviceSupport (
   OUT UINT8                             *SubBusNumber,
   OUT UINT8                             *PaddedBusRange
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1426,7 +1426,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_DEVICE_ERROR - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
@@ -1704,7 +1704,7 @@ EFI_STATUS
 PciRootBridgeP2CProcess (
   IN PCI_IO_DEVICE *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1716,7 +1716,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
@@ -1782,7 +1782,7 @@ EFI_STATUS
 PciHostBridgeP2CProcess (
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1792,7 +1792,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciResAlloc - add argument and description to function comment
 // TODO:    EFI_NOT_FOUND - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -1833,7 +1833,7 @@ EFI_STATUS
 PciHostBridgeEnumerator (
   EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL  *PciResAlloc
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1848,7 +1848,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment
 // TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment
 // TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.h

@@ -53,7 +53,7 @@ void
 InstallHotPlugRequestProtocol (
   IN  EFI_STATUS                    *Status
   )
-/*++
+/**
 
 Routine Description:
 
@@ -67,14 +67,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 VOID
 InstallPciHotplugGuid (
   IN  PCI_IO_DEVICE                  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -88,14 +88,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 VOID
 UninstallPciHotplugGuid (
   IN  PCI_IO_DEVICE                  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -109,14 +109,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 VOID
 GetBackPcCardBar (
   IN  PCI_IO_DEVICE                  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -130,7 +130,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -138,7 +138,7 @@ RemoveRejectedPciDevices (
   EFI_HANDLE        RootBridgeHandle,
   IN PCI_IO_DEVICE  *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -153,14 +153,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 PciHostBridgeResourceAllocator (
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc
   )
-/*++
+/**
 
 Routine Description:
 
@@ -174,7 +174,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -196,7 +196,7 @@ PciScanBus (
   OUT UINT8                             *SubBusNumber,
   OUT UINT8                             *PaddedBusRange
   )
-/*++
+/**
 
 Routine Description:
 
@@ -213,7 +213,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -238,7 +238,7 @@ EFI_STATUS
 PciRootBridgeP2CProcess (
   IN PCI_IO_DEVICE *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -252,14 +252,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 PciHostBridgeP2CProcess (
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc
   )
-/*++
+/**
 
 Routine Description:
 
@@ -273,14 +273,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 PciHostBridgeEnumerator (
   EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL  *PciResAlloc
   )
-/*++
+/**
 
 Routine Description:
 
@@ -294,7 +294,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 /**

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.c

@@ -34,7 +34,7 @@ EFI_STATUS
 GetOpRomInfo (
   IN PCI_IO_DEVICE    *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -42,7 +42,7 @@ Arguments:
 
 Returns:
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    EFI_NOT_FOUND - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -130,7 +130,7 @@ LoadOpRomImage (
   IN PCI_IO_DEVICE   *PciDevice,
   IN UINT64          RomBase
   )
-/*++
+/**
 
 Routine Description:
 
@@ -140,7 +140,7 @@ Arguments:
 
 Returns:
 
---*/
+**/
 // TODO:    PciDevice - add argument and description to function comment
 // TODO:    RomBase - add argument and description to function comment
 // TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment
@@ -314,7 +314,7 @@ RomDecode (
   IN UINT32          RomBar,
   IN BOOLEAN         Enable
   )
-/*++
+/**
 
 Routine Description:
 
@@ -322,7 +322,7 @@ Arguments:
 
 Returns:
 
---*/
+**/
 // TODO:    PciDevice - add argument and description to function comment
 // TODO:    RomBarIndex - add argument and description to function comment
 // TODO:    RomBar - add argument and description to function comment
@@ -399,7 +399,7 @@ EFI_STATUS
 ProcessOpRomImage (
   PCI_IO_DEVICE   *PciDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -412,7 +412,7 @@ Returns:
 
   EFI Status.
 
---*/
+**/
 {
   UINT8                         Indicator;
   UINT32                        ImageSize;

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.h

@@ -18,7 +18,7 @@ EFI_STATUS
 GetOpRomInfo (
   IN PCI_IO_DEVICE    *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -32,7 +32,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -40,7 +40,7 @@ LoadOpRomImage (
   IN PCI_IO_DEVICE   *PciDevice,
   IN UINT64          RomBase
   )
-/*++
+/**
 
 Routine Description:
 
@@ -55,7 +55,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -65,7 +65,7 @@ RomDecode (
   IN UINT32          RomBar,
   IN BOOLEAN         Enable
   )
-/*++
+/**
 
 Routine Description:
 
@@ -82,14 +82,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 ProcessOpRomImage (
   PCI_IO_DEVICE   *PciDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -103,7 +103,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 #endif

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciPowerManagement.c

@@ -17,7 +17,7 @@ EFI_STATUS
 ResetPowerManagementFeature (
   IN PCI_IO_DEVICE *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -31,7 +31,7 @@ Returns:
   
   None
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    EFI_UNSUPPORTED - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciPowerManagement.h

@@ -18,7 +18,7 @@ EFI_STATUS
 ResetPowerManagementFeature (
   IN PCI_IO_DEVICE *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -32,7 +32,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 #endif

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciResourceSupport.c

@@ -20,7 +20,7 @@ SkipVGAAperture (
   OUT UINT64   *Start,
   IN  UINT64   Length
   )
-/*++
+/**
 
 Routine Description:
 
@@ -32,7 +32,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Start - add argument and description to function comment
 // TODO:    Length - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -62,7 +62,7 @@ SkipIsaAliasAperture (
   OUT UINT64   *Start,
   IN  UINT64   Length
   )
-/*++
+/**
 
 Routine Description:
 
@@ -74,7 +74,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Start - add argument and description to function comment
 // TODO:    Length - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -106,7 +106,7 @@ InsertResourceNode (
   PCI_RESOURCE_NODE *Bridge,
   PCI_RESOURCE_NODE *ResNode
   )
-/*++
+/**
 
 Routine Description:
 
@@ -119,7 +119,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    ResNode - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -159,7 +159,7 @@ MergeResourceTree (
   PCI_RESOURCE_NODE *Res,
   BOOLEAN           TypeMerge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -177,7 +177,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Dst - add argument and description to function comment
 // TODO:    Res - add argument and description to function comment
 // TODO:    TypeMerge - add argument and description to function comment
@@ -208,7 +208,7 @@ EFI_STATUS
 CalculateApertureIo16 (
   IN PCI_RESOURCE_NODE *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -221,7 +221,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -349,7 +349,7 @@ EFI_STATUS
 CalculateResourceAperture (
   IN PCI_RESOURCE_NODE *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -362,7 +362,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -464,7 +464,7 @@ GetResourceFromDevice (
   PCI_RESOURCE_NODE *Mem64Node,
   PCI_RESOURCE_NODE *PMem64Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -474,7 +474,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciDev - add argument and description to function comment
 // TODO:    IoNode - add argument and description to function comment
 // TODO:    Mem32Node - add argument and description to function comment
@@ -617,7 +617,7 @@ CreateResourceNode (
   IN PCI_BAR_TYPE          ResType,
   IN PCI_RESOURCE_USAGE    ResUsage
   )
-/*++
+/**
 
 Routine Description:
 
@@ -629,7 +629,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciDev - add argument and description to function comment
 // TODO:    Length - add argument and description to function comment
 // TODO:    Alignment - add argument and description to function comment
@@ -677,7 +677,7 @@ CreateResourceMap (
   IN PCI_RESOURCE_NODE *Mem64Node,
   IN PCI_RESOURCE_NODE *PMem64Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -690,7 +690,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    IoNode - add argument and description to function comment
 // TODO:    Mem32Node - add argument and description to function comment
@@ -932,7 +932,7 @@ ResourcePaddingPolicy (
   PCI_RESOURCE_NODE *Mem64Node,
   PCI_RESOURCE_NODE *PMem64Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -952,7 +952,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
   //
@@ -981,7 +981,7 @@ DegradeResource (
   IN PCI_RESOURCE_NODE *Mem64Node,
   IN PCI_RESOURCE_NODE *PMem64Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -997,7 +997,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    Mem32Node - add argument and description to function comment
 // TODO:    PMem32Node - add argument and description to function comment
@@ -1083,7 +1083,7 @@ BridgeSupportResourceDecode (
   IN PCI_IO_DEVICE *Bridge,
   IN UINT32        Decode
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1098,9 +1098,9 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 {
-  /*++
+  /**
 
 Routine Description:
 
@@ -1110,7 +1110,7 @@ Returns:
   
   None
 
---*/
+**/
   if ((Bridge->Decodes) & Decode) {
     return TRUE;
   }
@@ -1123,7 +1123,7 @@ ProgramResource (
   IN UINT64            Base,
   IN PCI_RESOURCE_NODE *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1136,7 +1136,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Base - add argument and description to function comment
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment
@@ -1184,7 +1184,7 @@ ProgramBar (
   IN UINT64            Base,
   IN PCI_RESOURCE_NODE *Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1194,7 +1194,7 @@ Returns:
   
   None
 
---*/
+**/
 // TODO:    Base - add argument and description to function comment
 // TODO:    Node - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -1274,7 +1274,7 @@ ProgramPpbApperture (
   IN UINT64            Base,
   IN PCI_RESOURCE_NODE *Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1284,7 +1284,7 @@ Returns:
   
   None
 
---*/
+**/
 // TODO:    Base - add argument and description to function comment
 // TODO:    Node - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -1456,7 +1456,7 @@ ProgrameUpstreamBridgeForRom (
   IN UINT32          OptionRomBase,
   IN BOOLEAN         Enable
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1464,7 +1464,7 @@ Arguments:
 
 Returns:
 
---*/
+**/
 // TODO:    PciDevice - add argument and description to function comment
 // TODO:    OptionRomBase - add argument and description to function comment
 // TODO:    Enable - add argument and description to function comment
@@ -1510,7 +1510,7 @@ BOOLEAN
 ResourceRequestExisted (
   IN PCI_RESOURCE_NODE *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1522,7 +1522,7 @@ Returns:
 
   None
 
---*/
+**/
 {
   if (Bridge != NULL) {
     if (!IsListEmpty (&Bridge->ChildList) || Bridge->Length != 0) {
@@ -1538,7 +1538,7 @@ InitializeResourcePool (
   PCI_RESOURCE_NODE   *ResourcePool,
   PCI_BAR_TYPE        ResourceType
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1548,7 +1548,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    ResourcePool - add argument and description to function comment
 // TODO:    ResourceType - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -1576,7 +1576,7 @@ GetResourceMap (
   PCI_RESOURCE_NODE  *Mem64Pool,
   PCI_RESOURCE_NODE  *PMem64Pool
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1586,7 +1586,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciDev - add argument and description to function comment
 // TODO:    IoBridge - add argument and description to function comment
 // TODO:    Mem32Bridge - add argument and description to function comment
@@ -1691,7 +1691,7 @@ EFI_STATUS
 DestroyResourceTree (
   IN PCI_RESOURCE_NODE *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1701,7 +1701,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Bridge - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 {
@@ -1733,7 +1733,7 @@ RecordReservedResource (
   IN PCI_BAR_TYPE   ResType,
   IN PCI_IO_DEVICE  *Bridge
   )
-/*++
+/**
 
 Routine Description:
   
@@ -1743,7 +1743,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    Base - add argument and description to function comment
 // TODO:    Length - add argument and description to function comment
 // TODO:    ResType - add argument and description to function comment
@@ -1777,7 +1777,7 @@ ResourcePaddingForCardBusBridge (
   PCI_RESOURCE_NODE *Mem64Node,
   PCI_RESOURCE_NODE *PMem64Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1787,7 +1787,7 @@ Returns:
 
   None
 
---*/
+**/
 // TODO:    PciDev - add argument and description to function comment
 // TODO:    IoNode - add argument and description to function comment
 // TODO:    Mem32Node - add argument and description to function comment
@@ -1880,7 +1880,7 @@ ProgramP2C (
   IN UINT64            Base,
   IN PCI_RESOURCE_NODE *Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -1890,7 +1890,7 @@ Returns:
   
   None
 
---*/
+**/
 // TODO:    Base - add argument and description to function comment
 // TODO:    Node - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
@@ -2127,7 +2127,7 @@ ApplyResourcePadding (
   PCI_RESOURCE_NODE *Mem64Node,
   PCI_RESOURCE_NODE *PMem64Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -2137,7 +2137,7 @@ Returns:
   
   None
 
---*/
+**/
 // TODO:    PciDev - add argument and description to function comment
 // TODO:    IoNode - add argument and description to function comment
 // TODO:    Mem32Node - add argument and description to function comment
@@ -2291,7 +2291,7 @@ VOID
 GetResourcePaddingPpb (
   IN  PCI_IO_DEVICE                  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -2305,7 +2305,7 @@ Returns:
 
   None
 
---*/
+**/
 {
   if (gPciHotPlugInit) {
     if (PciIoDevice->ResourcePaddingDescriptors == NULL) {

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciResourceSupport.h

@@ -64,7 +64,7 @@ SkipVGAAperture (
   OUT UINT64   *Start,
   IN  UINT64   Length
   )
-/*++
+/**
 
 Routine Description:
 
@@ -79,7 +79,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -87,7 +87,7 @@ SkipIsaAliasAperture (
   OUT UINT64   *Start,
   IN  UINT64   Length
   )
-/*++
+/**
 
 Routine Description:
 
@@ -102,7 +102,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -110,7 +110,7 @@ InsertResourceNode (
   PCI_RESOURCE_NODE *Bridge,
   PCI_RESOURCE_NODE *ResNode
   )
-/*++
+/**
 
 Routine Description:
 
@@ -125,7 +125,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -134,7 +134,7 @@ MergeResourceTree (
   PCI_RESOURCE_NODE *Res,
   BOOLEAN           TypeMerge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -150,14 +150,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 CalculateApertureIo16 (
   IN PCI_RESOURCE_NODE *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -171,14 +171,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 CalculateResourceAperture (
   IN PCI_RESOURCE_NODE *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -192,7 +192,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -204,7 +204,7 @@ GetResourceFromDevice (
   PCI_RESOURCE_NODE *Mem64Node,
   PCI_RESOURCE_NODE *PMem64Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -223,7 +223,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 PCI_RESOURCE_NODE *
@@ -235,7 +235,7 @@ CreateResourceNode (
   IN PCI_BAR_TYPE          ResType,
   IN PCI_RESOURCE_USAGE    ResUsage
   )
-/*++
+/**
 
 Routine Description:
 
@@ -254,7 +254,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -266,7 +266,7 @@ CreateResourceMap (
   IN PCI_RESOURCE_NODE *Mem64Node,
   IN PCI_RESOURCE_NODE *PMem64Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -285,7 +285,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -297,7 +297,7 @@ ResourcePaddingPolicy (
   PCI_RESOURCE_NODE *Mem64Node,
   PCI_RESOURCE_NODE *PMem64Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -316,7 +316,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -327,7 +327,7 @@ DegradeResource (
   IN PCI_RESOURCE_NODE *Mem64Node,
   IN PCI_RESOURCE_NODE *PMem64Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -345,7 +345,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 BOOLEAN
@@ -353,7 +353,7 @@ BridgeSupportResourceDecode (
   IN PCI_IO_DEVICE *Bridge,
   IN UINT32        Decode
   )
-/*++
+/**
 
 Routine Description:
 
@@ -368,7 +368,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -376,7 +376,7 @@ ProgramResource (
   IN UINT64            Base,
   IN PCI_RESOURCE_NODE *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -391,7 +391,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -399,7 +399,7 @@ ProgramBar (
   IN UINT64            Base,
   IN PCI_RESOURCE_NODE *Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -414,7 +414,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -422,7 +422,7 @@ ProgramPpbApperture (
   IN UINT64            Base,
   IN PCI_RESOURCE_NODE *Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -437,7 +437,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -446,7 +446,7 @@ ProgrameUpstreamBridgeForRom (
   IN UINT32          OptionRomBase,
   IN BOOLEAN         Enable
   )
-/*++
+/**
 
 Routine Description:
 
@@ -462,14 +462,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 BOOLEAN
 ResourceRequestExisted (
   IN PCI_RESOURCE_NODE *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -483,7 +483,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -491,7 +491,7 @@ InitializeResourcePool (
   PCI_RESOURCE_NODE   *ResourcePool,
   PCI_BAR_TYPE        ResourceType
   )
-/*++
+/**
 
 Routine Description:
 
@@ -506,7 +506,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -523,7 +523,7 @@ GetResourceMap (
   PCI_RESOURCE_NODE  *Mem64Pool,
   PCI_RESOURCE_NODE  *PMem64Pool
   )
-/*++
+/**
 
 Routine Description:
 
@@ -547,14 +547,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 DestroyResourceTree (
   IN PCI_RESOURCE_NODE *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -568,7 +568,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -578,7 +578,7 @@ RecordReservedResource (
   IN PCI_BAR_TYPE   ResType,
   IN PCI_IO_DEVICE  *Bridge
   )
-/*++
+/**
 
 Routine Description:
 
@@ -595,7 +595,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -607,7 +607,7 @@ ResourcePaddingForCardBusBridge (
   PCI_RESOURCE_NODE *Mem64Node,
   PCI_RESOURCE_NODE *PMem64Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -626,7 +626,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -634,7 +634,7 @@ ProgramP2C (
   IN UINT64            Base,
   IN PCI_RESOURCE_NODE *Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -649,7 +649,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -661,7 +661,7 @@ ApplyResourcePadding (
   PCI_RESOURCE_NODE *Mem64Node,
   PCI_RESOURCE_NODE *PMem64Node
   )
-/*++
+/**
 
 Routine Description:
 
@@ -680,14 +680,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 VOID
 GetResourcePaddingPpb (
   IN  PCI_IO_DEVICE                  *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -701,7 +701,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -709,7 +709,7 @@ ResetAllPpbBusNumber (
   IN PCI_IO_DEVICE                      *Bridge,
   IN UINT8                              StartBusNumber
   )
-/*++
+/**
 
 Routine Description:
 
@@ -724,7 +724,7 @@ Returns:
 
   None
 
---*/
+**/
 ;
 
 #endif

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciRomTable.c

@@ -39,7 +39,7 @@ PciRomAddImageMapping (
   IN UINT64      RomAddress,
   IN UINT64      RomLength
   )
-/*++
+/**
 
 Routine Description:
 
@@ -59,7 +59,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 {
   EFI_PCI_ROM_IMAGE_MAPPING *TempMapping;
 
@@ -98,7 +98,7 @@ PciRomGetRomResourceFromPciOptionRomTable (
   IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *PciRootBridgeIo,
   PCI_IO_DEVICE                       *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -106,7 +106,7 @@ Arguments:
 
 Returns:
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    PciRootBridgeIo - add argument and description to function comment
 // TODO:    PciIoDevice - add argument and description to function comment
@@ -152,7 +152,7 @@ EFI_STATUS
 PciRomGetImageMapping (
   PCI_IO_DEVICE                       *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -160,7 +160,7 @@ Arguments:
 
 Returns:
 
---*/
+**/
 // TODO:    PciIoDevice - add argument and description to function comment
 // TODO:    EFI_SUCCESS - add return value to function comment
 {

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciRomTable.h

@@ -25,7 +25,7 @@ PciRomAddImageMapping (
   IN UINT64      RomAddress,
   IN UINT64      RomLength
   )
-/*++
+/**
 
 Routine Description:
 
@@ -45,7 +45,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 
@@ -55,7 +55,7 @@ PciRomGetRomResourceFromPciOptionRomTable (
   IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *PciRootBridgeIo,
   PCI_IO_DEVICE                       *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -71,14 +71,14 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
 PciRomGetImageMapping (
   PCI_IO_DEVICE                       *PciIoDevice
   )
-/*++
+/**
 
 Routine Description:
 
@@ -92,7 +92,7 @@ Returns:
 
   TODO: add return values
 
---*/
+**/
 ;
 
 #endif

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/pcibus.c

@@ -45,7 +45,7 @@ PciBusEntryPoint (
   IN EFI_HANDLE         ImageHandle,
   IN EFI_SYSTEM_TABLE   *SystemTable
   )
-/*++
+/**
 
 Routine Description:
 
@@ -62,7 +62,7 @@ Returns:
   EFI_SUCCESS
   EFI_DEVICE_ERROR
 
---*/
+**/
 // TODO:    ImageHandle - add argument and description to function comment
 // TODO:    SystemTable - add argument and description to function comment
 {
@@ -99,7 +99,7 @@ PciBusDriverBindingSupported (
   IN EFI_HANDLE                     Controller,
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
   )
-/*++
+/**
 
 Routine Description:
 
@@ -115,7 +115,7 @@ Returns:
 
   EFI_SUCCESS
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Controller - add argument and description to function comment
 // TODO:    RemainingDevicePath - add argument and description to function comment
@@ -193,7 +193,7 @@ PciBusDriverBindingStart (
   IN EFI_HANDLE                   Controller,
   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
   )
-/*++
+/**
 
 Routine Description:
 
@@ -208,7 +208,7 @@ Arguments:
 Returns:
 
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Controller - add argument and description to function comment
 // TODO:    RemainingDevicePath - add argument and description to function comment
@@ -262,7 +262,7 @@ PciBusDriverBindingStop (
   IN  UINTN                         NumberOfChildren,
   IN  EFI_HANDLE                    *ChildHandleBuffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -279,7 +279,7 @@ Arguments:
 Returns:
 
 
---*/
+**/
 // TODO:    This - add argument and description to function comment
 // TODO:    Controller - add argument and description to function comment
 // TODO:    NumberOfChildren - add argument and description to function comment

IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/VgaMiniPort.c

@@ -42,7 +42,7 @@ PciVgaMiniPortDriverEntryPoint (
   IN EFI_HANDLE         ImageHandle,
   IN EFI_SYSTEM_TABLE   *SystemTable
   )
-/*++
+/**
 
   Routine Description:
     Driver Entry Point.
@@ -52,7 +52,7 @@ PciVgaMiniPortDriverEntryPoint (
 
   Returns:
     EFI_STATUS
---*/
+**/
 {
   return EfiLibInstallDriverBindingComponentName2 (
            ImageHandle,

IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.c

@@ -771,7 +771,7 @@ TianoDecompressGetInfo (
   @retval RETURN_INVALID_PARAMETER  The source data is corrupted, or
                                     The GUID in InputSection does not match this instance guid.
 
---*/
+**/
 RETURN_STATUS
 EFIAPI
 TianoDecompress (

IntelFrameworkModulePkg/Universal/Console/VgaClassDxe/VgaClass.h

@@ -82,7 +82,7 @@ VgaClassDriverBindingSupported (
   IN EFI_HANDLE                    Controller,
   IN EFI_DEVICE_PATH_PROTOCOL      *RemainingDevicePath
   )
-/*++
+/**
 
 Routine Description:
 
@@ -98,7 +98,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -108,7 +108,7 @@ VgaClassDriverBindingStart (
   IN EFI_HANDLE                    Controller,
   IN EFI_DEVICE_PATH_PROTOCOL      *RemainingDevicePath
   )
-/*++
+/**
 
 Routine Description:
 
@@ -124,7 +124,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -135,7 +135,7 @@ VgaClassDriverBindingStop (
   IN  UINTN                        NumberOfChildren,
   IN  EFI_HANDLE                   *ChildHandleBuffer
   )
-/*++
+/**
 
 Routine Description:
 
@@ -152,7 +152,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 //
@@ -164,7 +164,7 @@ VgaClassReset (
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
   IN  BOOLEAN                      ExtendedVerification
   )
-/*++
+/**
 
 Routine Description:
 
@@ -179,7 +179,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -188,7 +188,7 @@ VgaClassOutputString (
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
   IN  CHAR16                       *WString
   )
-/*++
+/**
 
 Routine Description:
 
@@ -203,7 +203,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -212,7 +212,7 @@ VgaClassTestString (
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
   IN  CHAR16                       *WString
   )
-/*++
+/**
 
 Routine Description:
 
@@ -227,7 +227,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -235,7 +235,7 @@ EFIAPI
 VgaClassClearScreen (
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This
   )
-/*++
+/**
 
 Routine Description:
 
@@ -249,7 +249,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -258,7 +258,7 @@ VgaClassSetAttribute (
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
   IN  UINTN                        Attribute
   )
-/*++
+/**
 
 Routine Description:
 
@@ -273,7 +273,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -283,7 +283,7 @@ VgaClassSetCursorPosition (
   IN  UINTN                        Column,
   IN  UINTN                        Row
   )
-/*++
+/**
 
 Routine Description:
 
@@ -299,7 +299,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -308,7 +308,7 @@ VgaClassEnableCursor (
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
   IN  BOOLEAN                      Visible
   )
-/*++
+/**
 
 Routine Description:
 
@@ -323,7 +323,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -334,7 +334,7 @@ VgaClassQueryMode (
   OUT UINTN                        *Columns,
   OUT UINTN                        *Rows
   )
-/*++
+/**
 
 Routine Description:
 
@@ -351,7 +351,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 EFI_STATUS
@@ -360,7 +360,7 @@ VgaClassSetMode (
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
   IN  UINTN                        ModeNumber
   )
-/*++
+/**
 
 Routine Description:
 
@@ -375,7 +375,7 @@ Returns:
 
   GC_TODO: add return values
 
---*/
+**/
 ;
 
 #endif

IntelFrameworkModulePkg/Universal/PcatSingleSegmentPciCfgPei/PciCfg.c

@@ -54,7 +54,7 @@ PciCfgRead (
   UINTN  PciLibAddress;
 
   PciLibAddress = PciCfgAddressConvert ((EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS *) &Address);
-	switch (Width) {
+  switch (Width) {
     case EfiPeiPciCfgWidthUint8:
       * (UINT8 *) Buffer = PciRead8 (PciLibAddress);
       break;
@@ -70,7 +70,7 @@ PciCfgRead (
     default:
       return EFI_INVALID_PARAMETER;
   }
-	return EFI_SUCCESS;
+  return EFI_SUCCESS;
 }
 
 
@@ -119,8 +119,8 @@ PciCfgWrite (
 
     default:
       return EFI_INVALID_PARAMETER;
-	}
+  }
-	return EFI_SUCCESS;
+  return EFI_SUCCESS;
 }
 
 
@@ -154,7 +154,7 @@ PciCfgModify (
   UINTN  PciLibAddress;
 
   PciLibAddress = PciCfgAddressConvert ((EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS *) &Address);
-	switch (Width) {
+  switch (Width) {
     case EfiPeiPciCfgWidthUint8:
       PciAndThenOr8 (PciLibAddress, (UINT8)~ClearBits, (UINT8)SetBits);
       break;
@@ -170,5 +170,6 @@ PciCfgModify (
     default:
       return EFI_INVALID_PARAMETER;
   }
-	return EFI_SUCCESS;
+  return EFI_SUCCESS;
 }
+

IntelFrameworkModulePkg/Universal/PcatSingleSegmentPciCfgPei/PciCfg2.c

@@ -260,7 +260,15 @@ PciCfg2Modify (
   return EFI_SUCCESS;
 }
 
-
+/**
+  Module's entry function. 
+  This routine will install EFI_PEI_PCI_CFG2_PPI or EFI_PEI_PCI_CFG_PPI
+  according to PeiServices's version.
+  
+  @param FfsHeader    Image's header
+  @param PeiServices  Pointer of EFI_PEI_SERVICES
+  @return Whether success to install service
+**/
 EFI_STATUS
 EFIAPI
 PeimInitializePciCfg (
@@ -298,3 +306,4 @@ PeimInitializePciCfg (
 
   return Status;
 }
+

IntelFrameworkModulePkg/Universal/SectionExtractionDxe/SectionExtraction.c

@@ -1,20 +1,4 @@
 /**@file
-
-Copyright (c) 2006, Intel Corporation                                                         
-All rights reserved. This program and the accompanying materials                          
-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        
-http://opensource.org/licenses/bsd-license.php                                            
-                                                                                          
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
-
-Module Name:
-
-  SectionExtraction.c
-  
-Abstract:
-
   Section Extraction Protocol implementation.
   
   Stream database is implemented as a linked list of section streams,
@@ -42,7 +26,17 @@ Abstract:
      
   3) A support protocol is not found, and the data is not available to be read
      without it.  This results in EFI_PROTOCOL_ERROR.
-  
+
+Copyright (c) 2006, Intel Corporation                                                         
+All rights reserved. This program and the accompanying materials                          
+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        
+http://opensource.org/licenses/bsd-license.php                                            
+                                                                                          
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
+
+
 **/
 
 #include "SectionExtraction.h"
@@ -235,27 +229,23 @@ EFI_SECTION_EXTRACTION_PROTOCOL mSectionExtraction = {
   CloseSectionStream
 };
 
+/**
+  Entry point of the section extraction code. Initializes an instance of the 
+  section extraction interface and installs it on a new handle.
+
+  @param ImageHandle   EFI_HANDLE: A handle for the image that is initializing this driver
+  @param SystemTable   EFI_SYSTEM_TABLE: A pointer to the EFI system table        
+
+  @retval EFI_SUCCESS            Driver initialized successfully
+  @retval EFI_OUT_OF_RESOURCES   Could not allocate needed resources
+
+**/
 EFI_STATUS
 EFIAPI
 SectionExtractionEntryPoint (
   IN EFI_HANDLE                   ImageHandle,
   IN EFI_SYSTEM_TABLE             *SystemTable
   )
-/*++
-
-Routine Description: 
-  Entry point of the section extraction code. Initializes an instance of the 
-  section extraction interface and installs it on a new handle.
-
-Arguments:  
-  ImageHandle   EFI_HANDLE: A handle for the image that is initializing this driver
-  SystemTable   EFI_SYSTEM_TABLE: A pointer to the EFI system table        
-
-Returns:  
-  EFI_SUCCESS:  Driver initialized successfully
-  EFI_OUT_OF_RESOURCES:   Could not allocate needed resources
-
---*/
 {
   EFI_STATUS                         Status;
 
@@ -273,6 +263,22 @@ Returns:
   return Status;
 }
 
+/**
+  SEP member function.  This function creates and returns a new section stream
+  handle to represent the new section stream.
+
+  @param This                 Indicates the calling context.
+  @param SectionStreamLength  Size in bytes of the section stream.
+  @param SectionStream        Buffer containing the new section stream.
+  @param SectionStreamHandle  A pointer to a caller allocated UINTN that on output
+                              contains the new section stream handle.
+
+  @retval EFI_SUCCESS
+  @retval EFI_OUT_OF_RESOURCES  memory allocation failed.
+  @retval EFI_INVALID_PARAMETER section stream does not end concident with end of
+                                last section.
+
+**/
 STATIC
 EFI_STATUS
 EFIAPI
@@ -282,26 +288,6 @@ OpenSectionStream (
   IN     VOID                                      *SectionStream,
      OUT UINTN                                     *SectionStreamHandle
   )
-/*++
-
-Routine Description:
-  SEP member function.  This function creates and returns a new section stream
-  handle to represent the new section stream.
-
-Arguments:
-  This                - Indicates the calling context.
-  SectionStreamLength - Size in bytes of the section stream.
-  SectionStream       - Buffer containing the new section stream.
-  SectionStreamHandle - A pointer to a caller allocated UINTN that on output
-                        contains the new section stream handle.
-
-Returns:
-  EFI_SUCCESS
-  EFI_OUT_OF_RESOURCES - memory allocation failed.
-  EFI_INVALID_PARAMETER - section stream does not end concident with end of
-                          last section.
-
---*/
 {
   //
   // Check to see section stream looks good...
@@ -319,6 +305,49 @@ Returns:
           );
 }
   
+/**
+  SEP member function.  Retrieves requested section from section stream.
+
+  @param This:                 Pointer to SEP instance.
+  @param SectionStreamHandle:  The section stream from which to extract the requested
+                               section.
+  @param SectionType:         A pointer to the type of section to search for.
+  @param SectionDefinitionGuid: If the section type is EFI_SECTION_GUID_DEFINED, then
+                                SectionDefinitionGuid indicates which of these types
+                                of sections to search for.
+  @param SectionInstance:      Indicates which instance of the requested section to
+                               return.
+  @param Buffer:               Double indirection to buffer.  If *Buffer is non-null on
+                               input, then the buffer is caller allocated.  If
+                               *Buffer is NULL, then the buffer is callee allocated.
+                               In either case, the requried buffer size is returned
+                               in *BufferSize.
+  @param BufferSize:           On input, indicates the size of *Buffer if *Buffer is
+                               non-null on input.  On output, indicates the required
+                               size (allocated size if callee allocated) of *Buffer.
+  @param AuthenticationStatus: Indicates the authentication status of the retrieved
+                               section.
+
+ 
+  @retval EFI_SUCCESS:        Section was retrieved successfully
+  @retval EFI_PROTOCOL_ERROR: A GUID defined section was encountered in the section 
+                        stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED
+                        bit set, but there was no corresponding GUIDed Section 
+                        Extraction Protocol in the handle database.  *Buffer is 
+                        unmodified.
+  @retval EFI_NOT_FOUND:      An error was encountered when parsing the SectionStream.
+                        This indicates the SectionStream  is not correctly 
+                        formatted.
+  @retval EFI_NOT_FOUND:      The requested section does not exist.
+  @retval EFI_OUT_OF_RESOURCES: The system has insufficient resources to process the 
+                        request.
+  @retval EFI_INVALID_PARAMETER: The SectionStreamHandle does not exist.
+  @retval EFI_WARN_TOO_SMALL: The size of the caller allocated input buffer is 
+                        insufficient to contain the requested section.  The 
+                        input buffer is filled and contents are section contents
+                        are truncated.
+
+**/  
 STATIC
 EFI_STATUS
 EFIAPI
@@ -332,52 +361,7 @@ GetSection (
   IN OUT UINTN                                          *BufferSize,
   OUT UINT32                                            *AuthenticationStatus
   )
-/*++
 
-Routine Description:
-  SEP member function.  Retrieves requested section from section stream.
-
-Arguments:  
-  This:                 Pointer to SEP instance.
-  SectionStreamHandle:  The section stream from which to extract the requested
-                          section.
-  SectionType:         A pointer to the type of section to search for.
-  SectionDefinitionGuid: If the section type is EFI_SECTION_GUID_DEFINED, then
-                        SectionDefinitionGuid indicates which of these types
-                          of sections to search for.
-  SectionInstance:      Indicates which instance of the requested section to
-                          return.
-  Buffer:               Double indirection to buffer.  If *Buffer is non-null on
-                          input, then the buffer is caller allocated.  If
-                          *Buffer is NULL, then the buffer is callee allocated.
-                          In either case, the requried buffer size is returned
-                          in *BufferSize.
-  BufferSize:           On input, indicates the size of *Buffer if *Buffer is
-                          non-null on input.  On output, indicates the required
-                          size (allocated size if callee allocated) of *Buffer.
-  AuthenticationStatus: Indicates the authentication status of the retrieved
-                          section.
-
-Returns:  
-  EFI_SUCCESS:        Section was retrieved successfully
-  EFI_PROTOCOL_ERROR: A GUID defined section was encountered in the section 
-                        stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED
-                        bit set, but there was no corresponding GUIDed Section 
-                        Extraction Protocol in the handle database.  *Buffer is 
-                        unmodified.
-  EFI_NOT_FOUND:      An error was encountered when parsing the SectionStream.
-                        This indicates the SectionStream  is not correctly 
-                        formatted.
-  EFI_NOT_FOUND:      The requested section does not exist.
-  EFI_OUT_OF_RESOURCES: The system has insufficient resources to process the 
-                        request.
-  EFI_INVALID_PARAMETER: The SectionStreamHandle does not exist.
-  EFI_WARN_TOO_SMALL: The size of the caller allocated input buffer is 
-                        insufficient to contain the requested section.  The 
-                        input buffer is filled and contents are section contents
-                        are truncated.
-
---*/
 {
   CORE_SECTION_STREAM_NODE                              *StreamNode;
   EFI_TPL                                               OldTpl;
@@ -461,7 +445,18 @@ GetSection_Done:
   return Status;
 }
 
+/**
+  SEP member function.  Deletes an existing section stream
 
+  @param This                - Indicates the calling context.
+  @param StreamHandleToClose - Indicates the stream to close
+
+  @retval EFI_SUCCESS
+  @retval EFI_OUT_OF_RESOURCES - memory allocation failed.
+  @retval EFI_INVALID_PARAMETER - section stream does not end concident with end of
+                          last section.
+
+**/
 STATIC
 EFI_STATUS
 EFIAPI
@@ -469,22 +464,7 @@ CloseSectionStream (
   IN  EFI_SECTION_EXTRACTION_PROTOCOL           *This,
   IN  UINTN                                     StreamHandleToClose
   )
-/*++
 
-Routine Description:
-  SEP member function.  Deletes an existing section stream
-
-Arguments:
-  This                - Indicates the calling context.
-  StreamHandleToClose - Indicates the stream to close
-
-Returns:
-  EFI_SUCCESS
-  EFI_OUT_OF_RESOURCES - memory allocation failed.
-  EFI_INVALID_PARAMETER - section stream does not end concident with end of
-                          last section.
-
---*/
 {
   CORE_SECTION_STREAM_NODE                      *StreamNode;
   EFI_TPL                                       OldTpl;
@@ -519,7 +499,19 @@ Returns:
   return Status;
 }
 
+/**
+  Worker function.  Determine if the input stream:child matches the input type.
 
+  @param Stream              - Indicates the section stream associated with the child
+  @param Child               - Indicates the child to check
+  @param SearchType          - Indicates the type of section to check against for
+  @param SectionDefinitionGuid - Indicates the GUID to check against if the type is
+                        EFI_SECTION_GUID_DEFINED
+
+  @retval TRUE                - The child matches
+  @retval FALSE               - The child doesn't match
+
+**/
 STATIC
 BOOLEAN
 ChildIsType (
@@ -528,22 +520,6 @@ ChildIsType (
   IN EFI_SECTION_TYPE         SearchType,
   IN EFI_GUID                 *SectionDefinitionGuid
   )
-/*++
-
-Routine Description:
-  Worker function.  Determine if the input stream:child matches the input type.
-
-Arguments:
-  Stream              - Indicates the section stream associated with the child
-  Child               - Indicates the child to check
-  SearchType          - Indicates the type of section to check against for
-  SectionDefinitionGuid - Indicates the GUID to check against if the type is
-                        EFI_SECTION_GUID_DEFINED
-Returns:
-  TRUE                - The child matches
-  FALSE               - The child doesn't match
-
---*/
 {
   EFI_GUID_DEFINED_SECTION    *GuidedSection;
   
@@ -560,7 +536,30 @@ Returns:
   return CompareGuid (&GuidedSection->SectionDefinitionGuid, SectionDefinitionGuid);
 }
 
+/**
+  Worker function  Recursively searches / builds section stream database
+  looking for requested section.
 
+
+  @param SourceStream        - Indicates the section stream in which to do the search.
+  @param SearchType          - Indicates the type of section to search for.
+  @param SectionInstance     - Indicates which instance of section to find.  This is
+                        an in/out parameter to deal with recursions.
+  @param SectionDefinitionGuid  - Guid of section definition
+  @param FoundChild          - Output indicating the child node that is found.
+  @param FoundStream         - Output indicating which section stream the child was
+                        found in.  If this stream was generated as a result of
+                        an encapsulation section, the streamhandle is visible
+                        within the SEP driver only.
+  @param AuthenticationStatus- Indicates the authentication status of the found section.
+
+  @retval EFI_SUCCESS         - Child node was found and returned.
+  @retval EFI_OUT_OF_RESOURCES- Memory allocation failed.
+  @retval EFI_NOT_FOUND       - Requested child node does not exist.
+  @retval EFI_PROTOCOL_ERROR  - a required GUIDED section extraction protocol does not
+                        exist
+
+**/
 STATIC
 EFI_STATUS
 FindChildNode (
@@ -572,33 +571,7 @@ FindChildNode (
   OUT    CORE_SECTION_STREAM_NODE                   **FoundStream,
   OUT    UINT32                                     *AuthenticationStatus
   )
-/*++
 
-Routine Description:
-  Worker function  Recursively searches / builds section stream database
-  looking for requested section.
-
-Arguments:
-  SourceStream        - Indicates the section stream in which to do the search.
-  SearchType          - Indicates the type of section to search for.
-  SectionInstance     - Indicates which instance of section to find.  This is
-                        an in/out parameter to deal with recursions.
-  SectionDefinitionGuid  - Guid of section definition
-  FoundChild          - Output indicating the child node that is found.
-  FoundStream         - Output indicating which section stream the child was
-                        found in.  If this stream was generated as a result of
-                        an encapsulation section, the streamhandle is visible
-                        within the SEP driver only.
-  AuthenticationStatus- Indicates the authentication status of the found section.
-
-Returns:
-  EFI_SUCCESS         - Child node was found and returned.
-  EFI_OUT_OF_RESOURCES- Memory allocation failed.
-  EFI_NOT_FOUND       - Requested child node does not exist.
-  EFI_PROTOCOL_ERROR  - a required GUIDED section extraction protocol does not
-                        exist
-
---*/
 {
   CORE_SECTION_CHILD_NODE                       *CurrentChildNode;
   CORE_SECTION_CHILD_NODE                       *RecursedChildNode;
@@ -715,7 +688,24 @@ Returns:
   }
 }
 
+/**
+  Worker function.  Constructor for new child nodes.
 
+  @param Stream              - Indicates the section stream in which to add the child.
+  @param ChildOffset         - Indicates the offset in Stream that is the beginning
+                        of the child section.
+  @param ChildNode           - Indicates the Callee allocated and initialized child.
+
+  @retval EFI_SUCCESS         - Child node was found and returned.
+  @retval EFI_OUT_OF_RESOURCES- Memory allocation failed.
+  @retval EFI_PROTOCOL_ERROR  - Encapsulation sections produce new stream handles when
+                        the child node is created.  If the section type is GUID
+                        defined, and the extraction GUID does not exist, and
+                        producing the stream requires the GUID, then a protocol
+                        error is generated and no child is produced.
+  Values returned by OpenSectionStreamEx.
+
+**/
 STATIC
 EFI_STATUS
 CreateChildNode (
@@ -723,28 +713,6 @@ CreateChildNode (
   IN     UINT32                                ChildOffset,
      OUT CORE_SECTION_CHILD_NODE               **ChildNode
   )
-/*++
-
-Routine Description:
-  Worker function.  Constructor for new child nodes.
-
-Arguments:
-  Stream              - Indicates the section stream in which to add the child.
-  ChildOffset         - Indicates the offset in Stream that is the beginning
-                        of the child section.
-  ChildNode           - Indicates the Callee allocated and initialized child.
-
-Returns:
-  EFI_SUCCESS         - Child node was found and returned.
-  EFI_OUT_OF_RESOURCES- Memory allocation failed.
-  EFI_PROTOCOL_ERROR  - Encapsulation sections produce new stream handles when
-                        the child node is created.  If the section type is GUID
-                        defined, and the extraction GUID does not exist, and
-                        producing the stream requires the GUID, then a protocol
-                        error is generated and no child is produced.
-  Values returned by OpenSectionStreamEx.
-
---*/
 {
   EFI_STATUS                                   Status;
   EFI_COMMON_SECTION_HEADER                    *SectionHeader;
@@ -997,27 +965,20 @@ Returns:
   return EFI_SUCCESS;
 }
 
+/**
+  Worker function.  Constructor for RPN event if needed to keep AuthenticationStatus
+  cache correct when a missing GUIDED_SECTION_EXTRACTION_PROTOCOL appears...
 
+  @param ParentStream        - Indicates the parent of the ecnapsulation section (child)
+  @param ChildNode           - Indicates the child node that is the encapsulation section.
+
+**/
 STATIC
 VOID
 CreateGuidedExtractionRpnEvent (
   IN CORE_SECTION_STREAM_NODE       *ParentStream,
   IN CORE_SECTION_CHILD_NODE        *ChildNode
   )
-/*++
-
-Routine Description:
-  Worker function.  Constructor for RPN event if needed to keep AuthenticationStatus
-  cache correct when a missing GUIDED_SECTION_EXTRACTION_PROTOCOL appears...
-
-Arguments:
-  ParentStream        - Indicates the parent of the ecnapsulation section (child)
-  ChildNode           - Indicates the child node that is the encapsulation section.
-
-Returns:
-  None
-
---*/
 {
   RPN_EVENT_CONTEXT *Context;
   
@@ -1040,7 +1001,15 @@ Returns:
                     );
 }
   
-  
+/**
+  RPN callback function.  Removes a stale section stream and re-initializes it
+  with an updated AuthenticationStatus.
+
+  @param Event               - The event that fired
+  @param RpnContext          - A pointer to the context that allows us to identify
+                        the relevent encapsulation...
+
+**/  
 STATIC
 VOID
 EFIAPI
@@ -1048,21 +1017,6 @@ NotifyGuidedExtraction (
   IN   EFI_EVENT   Event,
   IN   VOID        *RpnContext
   )
-/*++
-
-Routine Description:
-  RPN callback function.  Removes a stale section stream and re-initializes it
-  with an updated AuthenticationStatus.
-
-Arguments:
-  Event               - The event that fired
-  RpnContext          - A pointer to the context that allows us to identify
-                        the relevent encapsulation...
-
-Returns:
-  None
-
---*/
 {
   EFI_STATUS                              Status;
   EFI_GUID_DEFINED_SECTION                *GuidedHeader;
@@ -1120,24 +1074,18 @@ Returns:
   gBS->FreePool (Context);
 }  
   
+/**
+  Worker function.  Destructor for child nodes.
 
+  @param ChildNode           - Indicates the node to destroy
+
+**/
 STATIC
 VOID
 FreeChildNode (
   IN  CORE_SECTION_CHILD_NODE                   *ChildNode
   )
-/*++
 
-Routine Description:
-  Worker function.  Destructor for child nodes.
-
-Arguments:
-  ChildNode           - Indicates the node to destroy
-
-Returns:
-  none
-
---*/
 {
   ASSERT (ChildNode->Signature == CORE_SECTION_CHILD_SIGNATURE);
   //
@@ -1158,7 +1106,22 @@ Returns:
   gBS->FreePool (ChildNode);
 }  
 
+/**
+  Worker function.  Constructor for section streams.
 
+  @param SectionStreamLength - Size in bytes of the section stream.
+  @param SectionStream       - Buffer containing the new section stream.
+  @param AllocateBuffer      - Indicates whether the stream buffer is to be copied
+                          or the input buffer is to be used in place.
+  @param AuthenticationStatus- Indicates the default authentication status for the
+                          new stream.
+  @param SectionStreamHandle - A pointer to a caller allocated section stream handle.
+
+  
+  @retval EFI_SUCCESS         - Stream was added to stream database.
+  @retval EFI_OUT_OF_RESOURCES - memory allocation failed.
+
+**/
 STATIC
 EFI_STATUS
 OpenSectionStreamEx (
@@ -1168,25 +1131,7 @@ OpenSectionStreamEx (
   IN     UINT32                                    AuthenticationStatus,   
      OUT UINTN                                     *SectionStreamHandle
   )
-/*++
 
-  Routine Description:
-    Worker function.  Constructor for section streams.
-
-  Arguments:
-    SectionStreamLength - Size in bytes of the section stream.
-    SectionStream       - Buffer containing the new section stream.
-    AllocateBuffer      - Indicates whether the stream buffer is to be copied
-                          or the input buffer is to be used in place.
-    AuthenticationStatus- Indicates the default authentication status for the
-                          new stream.
-    SectionStreamHandle - A pointer to a caller allocated section stream handle.
-
-  Returns:
-    EFI_SUCCESS         - Stream was added to stream database.
-    EFI_OUT_OF_RESOURCES - memory allocation failed.
-
---*/
 {
   CORE_SECTION_STREAM_NODE    *NewStream;
   EFI_TPL                     OldTpl;
@@ -1250,28 +1195,24 @@ OpenSectionStreamEx (
   return EFI_SUCCESS;
 }
 
+/**
+  Worker function.  Search stream database for requested stream handle.
 
+  @param SearchHandle        - Indicates which stream to look for.
+  @param FoundStream         - Output pointer to the found stream.
+
+  @retval EFI_SUCCESS         - StreamHandle was found and *FoundStream contains
+                          the stream node.
+  @retval EFI_NOT_FOUND       - SearchHandle was not found in the stream database.
+
+**/
 STATIC
 EFI_STATUS
 FindStreamNode (
   IN  UINTN                                     SearchHandle,
   OUT CORE_SECTION_STREAM_NODE                  **FoundStream
   )
-/*++
 
-  Routine Description:
-    Worker function.  Search stream database for requested stream handle.
-
-  Arguments:
-    SearchHandle        - Indicates which stream to look for.
-    FoundStream         - Output pointer to the found stream.
-
-  Returns:
-    EFI_SUCCESS         - StreamHandle was found and *FoundStream contains
-                          the stream node.
-    EFI_NOT_FOUND       - SearchHandle was not found in the stream database.
-
---*/
 {  
   CORE_SECTION_STREAM_NODE                      *StreamNode;
   
@@ -1292,27 +1233,22 @@ FindStreamNode (
   return EFI_NOT_FOUND;
 }
 
+/**
 
+  Check if a stream is valid.
+
+  @param SectionStream         - The section stream to be checked
+  @param SectionStreamLength   - The length of section stream
+
+  @return if a stream is valid.
+**/
 STATIC
 BOOLEAN
 IsValidSectionStream (
   IN  VOID              *SectionStream,
   IN  UINTN             SectionStreamLength
   )
-/*++
 
-Routine Description:
-  Check if a stream is valid.
-
-Arguments:
-  SectionStream         - The section stream to be checked
-  SectionStreamLength   - The length of section stream
-
-Returns:
-  TRUE
-  FALSE
-
---*/
 {
   UINTN                       TotalLength;
   UINTN                       SectionLength;
@@ -1348,6 +1284,25 @@ Returns:
   return FALSE;
 }
 
+/**
+  Create a protocol notification event and return it.
+
+  @param ProtocolGuid    - Protocol to register notification event on.
+
+  @param NotifyTpl        - Maximum TPL to signal the NotifyFunction.
+
+  @param NotifyFuncition  - EFI notification routine.
+
+  @param NotifyContext   - Context passed into Event when it is created.
+
+  @param Registration    - Registration key returned from RegisterProtocolNotify().
+
+  @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
+           is added to the system.
+
+**/
 EFI_EVENT
 CoreCreateProtocolNotifyEvent (
   IN EFI_GUID             *ProtocolGuid,
@@ -1357,32 +1312,6 @@ CoreCreateProtocolNotifyEvent (
   OUT VOID                **Registration,
   IN  BOOLEAN             SignalFlag
   )
-/*++
-
-Routine Description:
-
-  Create a protocol notification event and return it.
-
-Arguments:
-
-  ProtocolGuid    - Protocol to register notification event on.
-
-  NotifyTpl        - Maximum TPL to signal the NotifyFunction.
-
-  NotifyFuncition  - EFI notification routine.
-
-  NotifyContext   - Context passed into Event when it is created.
-
-  Registration    - Registration key returned from RegisterProtocolNotify().
-
-  SignalFlag      -  Boolean value to decide whether kick the event after register or not.
-
-Returns:
-
-  The EFI_EVENT that has been registered to be signaled when a ProtocolGuid
-  is added to the system.
-
---*/
 {
   EFI_STATUS              Status;
   EFI_EVENT               Event;

IntelFrameworkModulePkg/Universal/SectionExtractionDxe/SectionExtraction.h

@@ -1,20 +1,4 @@
 /**@file
-
-Copyright (c) 2006, Intel Corporation                                                         
-All rights reserved. This program and the accompanying materials                          
-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        
-http://opensource.org/licenses/bsd-license.php                                            
-                                                                                          
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
-
-Module Name:
-
-  SectionExtraction.c
-  
-Abstract:
-
   Section Extraction Protocol implementation.
   
   Stream database is implemented as a linked list of section streams,
@@ -42,7 +26,16 @@ Abstract:
      
   3) A support protocol is not found, and the data is not available to be read
      without it.  This results in EFI_PROTOCOL_ERROR.
-  
+     
+Copyright (c) 2006, Intel Corporation                                                         
+All rights reserved. This program and the accompanying materials                          
+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        
+http://opensource.org/licenses/bsd-license.php                                            
+                                                                                          
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
+
 **/
 
 #ifndef _SECION_EXTRACTION_H_

IntelFrameworkModulePkg/Universal/StatusCode/Dxe/SerialStatusCodeWorker.c

@@ -1,4 +1,3 @@
-
 /** @file
   Serial I/O status code reporting worker.
 
@@ -220,3 +219,4 @@ SerialStatusCodeReportWorker (
 
   return EFI_SUCCESS;
 }
+

IntelFrameworkModulePkg/Universal/StatusCode/Pei/MemoryStausCodeWorker.c

@@ -149,3 +149,4 @@ MemoryStatusCodeReportWorker (
 
   return EFI_SUCCESS;
 }
+

IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.c

@@ -1,4 +1,3 @@
-
 /** @file
   Generic PeiStatusCode Module.
 

IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.h

@@ -1,4 +1,3 @@
-
 /** @file
   Heade file of status code PEIM
 
@@ -11,8 +10,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
-  Module Name:  PeiStatusCode.h
-
 **/
 
 #ifndef __PEI_STATUS_CODE_H__
@@ -155,4 +152,6 @@ ReportDispatcher (
   IN CONST EFI_STATUS_CODE_DATA     *Data OPTIONAL
   );
 
-#endif
+#endif //__PEI_STATUS_CODE_H__
+
+

IntelFrameworkModulePkg/Universal/StatusCode/Pei/SerialStatusCodeWorker.c

@@ -1,4 +1,3 @@
-
 /** @file
   Serial I/O status code reporting worker.
 
@@ -10,9 +9,6 @@
 
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-  Module Name:  SerialStatusCodeWorker.c
-
 **/
 
 #include "PeiStatusCode.h"
@@ -168,3 +164,4 @@ SerialStatusCodeReportWorker (
 
   return EFI_SUCCESS;
 }
+

IntelFrameworkModulePkg/Universal/VariablePei/Variable.c

@@ -1,5 +1,6 @@
 /** @file
-
+  Framework PEIM to provide the Variable functionality
+  
 Copyright (c) 2006 - 2008 Intel Corporation. <BR>
 All rights reserved. This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
@@ -10,12 +11,6 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 Module Name:
 
-  Variable.c
-
-Abstract:
-
-  Framework PEIM to provide the Variable functionality
-
 **/
 
 
@@ -49,29 +44,22 @@ static EFI_PEI_PPI_DESCRIPTOR     mPpiListVariable[] = {
 
 EFI_GUID mEfiVariableIndexTableGuid = EFI_VARIABLE_INDEX_TABLE_GUID;
 
+/**
+  Provide the functionality of the variable services.
+
+  @param FfsHeadher  - The FFS file header
+  @param PeiServices - General purpose services available to every PEIM.
+
+  @return Status -  EFI_SUCCESS if the interface could be successfully
+          installed
+
+**/
 EFI_STATUS
 EFIAPI
 PeimInitializeVariableServices (
   IN EFI_FFS_FILE_HEADER       *FfsHeader,
   IN EFI_PEI_SERVICES          **PeiServices
   )
-/*++
-
-Routine Description:
-
-  Provide the functionality of the variable services.
-
-Arguments:
-
-  FfsHeadher  - The FFS file header
-  PeiServices - General purpose services available to every PEIM.
-
-Returns:
-
-  Status -  EFI_SUCCESS if the interface could be successfully
-            installed
-
---*/
 {
   //
   // Publish the variable capability to other modules
@@ -80,25 +68,18 @@ Returns:
 
 }
 
+/**
+  This code gets the pointer to the first variable memory pointer byte
+
+  @param VarStoreHeader        Pointer to the Variable Store Header.
+
+  @Return VARIABLE_HEADER*      Pointer to last unavailable Variable Header
+
+**/
 VARIABLE_HEADER *
 GetStartPointer (
   IN VARIABLE_STORE_HEADER       *VarStoreHeader
   )
-/*++
-
-Routine Description:
-
-  This code gets the pointer to the first variable memory pointer byte
-
-Arguments:
-
-  VarStoreHeader        Pointer to the Variable Store Header.
-
-Returns:
-
-  VARIABLE_HEADER*      Pointer to last unavailable Variable Header
-
---*/
 {
   //
   // The end of variable store
@@ -106,25 +87,19 @@ Returns:
   return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1);
 }
 
+/**
+  This code gets the pointer to the last variable memory pointer byte
+
+  @param VarStoreHeader        Pointer to the Variable Store Header.
+
+  @Return  VARIABLE_HEADER*      Pointer to last unavailable Variable Header
+
+**/
 VARIABLE_HEADER *
 GetEndPointer (
   IN VARIABLE_STORE_HEADER       *VarStoreHeader
   )
-/*++
 
-Routine Description:
-
-  This code gets the pointer to the last variable memory pointer byte
-
-Arguments:
-
-  VarStoreHeader        Pointer to the Variable Store Header.
-
-Returns:
-
-  VARIABLE_HEADER*      Pointer to last unavailable Variable Header
-
---*/
 {
   //
   // The end of variable store
@@ -132,26 +107,22 @@ Returns:
   return (VARIABLE_HEADER *) HEADER_ALIGN ((UINTN) VarStoreHeader + VarStoreHeader->Size);
 }
 
+/**
+
+  This code checks if variable header is valid or not.
+
+  @param Variable              Pointer to the Variable Header.
+
+  @retval TRUE            Variable header is valid.
+  @retval FALSE           Variable header is not valid.
+
+**/
 STATIC
 BOOLEAN
 EFIAPI
 IsValidVariableHeader (
   IN  VARIABLE_HEADER   *Variable
   )
-/*++
-
-Routine Description:
-
-  This code checks if variable header is valid or not.
-
-Arguments:
-  Variable              Pointer to the Variable Header.
-
-Returns:
-  TRUE            Variable header is valid.
-  FALSE           Variable header is not valid.
-
---*/
 {
   if (Variable == NULL || Variable->StartId != VARIABLE_DATA ) {
     return FALSE;
@@ -160,26 +131,18 @@ Returns:
   return TRUE;
 }
 
+/**
+  This code gets the size of name of variable.
 
+  @param Variable            Pointer to the Variable Header.
+
+  @Return UINTN               Size of variable in bytes
+
+**/
 UINTN
 NameSizeOfVariable (
   IN  VARIABLE_HEADER   *Variable
   )
-/*++
-
-Routine Description:
-
-  This code gets the size of name of variable.
-
-Arguments:
-
-  Variable            Pointer to the Variable Header.
-
-Returns:
-
-  UINTN               Size of variable in bytes
-
---*/
 {
   if (Variable->State    == (UINT8) (-1) ||
       Variable->DataSize == (UINT32) -1 ||
@@ -190,25 +153,18 @@ Returns:
   return (UINTN) Variable->NameSize;
 }
 
+/**
+  This code gets the size of name of variable.
+
+  @param Variable            Pointer to the Variable Header.
+
+  @Return  UINTN               Size of variable in bytes
+
+**/
 UINTN
 DataSizeOfVariable (
   IN  VARIABLE_HEADER   *Variable
   )
-/*++
-
-Routine Description:
-
-  This code gets the size of name of variable.
-
-Arguments:
-
-  Variable            Pointer to the Variable Header.
-
-Returns:
-
-  UINTN               Size of variable in bytes
-
---*/
 {
   if (Variable->State    == (UINT8)  -1 ||
       Variable->DataSize == (UINT32) -1 ||
@@ -219,50 +175,36 @@ Returns:
   return (UINTN) Variable->DataSize;
 }
 
+/**
+  This code gets the pointer to the variable name.
+
+  @param Variable            Pointer to the Variable Header.
+
+  @Return CHAR16*              Pointer to Variable Name
+
+**/
 CHAR16 *
 GetVariableNamePtr (
   IN  VARIABLE_HEADER   *Variable
   )
-/*++
 
-Routine Description:
-
-  This code gets the pointer to the variable name.
-
-Arguments:
-
-  Variable            Pointer to the Variable Header.
-
-Returns:
-
-  CHAR16*              Pointer to Variable Name
-
---*/
 {
 
   return (CHAR16 *) (Variable + 1);
 }
 
+/**
+  This code gets the pointer to the variable data.
 
+  @param Variable            Pointer to the Variable Header.
+
+  @Return  UINT8*              Pointer to Variable Data
+
+**/
 UINT8 *
 GetVariableDataPtr (
   IN  VARIABLE_HEADER   *Variable
   )
-/*++
-
-Routine Description:
-
-  This code gets the pointer to the variable data.
-
-Arguments:
-
-  Variable            Pointer to the Variable Header.
-
-Returns:
-
-  UINT8*              Pointer to Variable Data
-
---*/
 {
   UINTN Value;
   
@@ -276,25 +218,19 @@ Returns:
   return (UINT8 *) Value;
 }
 
+/**
+  This code gets the pointer to the next variable header.
+
+  @param Variable              Pointer to the Variable Header.
+
+  @Return VARIABLE_HEADER*      Pointer to next variable header.
+
+**/
 VARIABLE_HEADER *
 GetNextVariablePtr (
   IN  VARIABLE_HEADER   *Variable
   )
-/*++
 
-Routine Description:
-
-  This code gets the pointer to the next variable header.
-
-Arguments:
-
-  Variable              Pointer to the Variable Header.
-
-Returns:
-
-  VARIABLE_HEADER*      Pointer to next variable header.
-
---*/
 {
   UINTN Value;
 
@@ -312,30 +248,23 @@ Returns:
   return (VARIABLE_HEADER *) HEADER_ALIGN (Value);
 }
 
+/**
+  This code gets the pointer to the variable name.
 
+  @param VarStoreHeader  Pointer to the Variable Store Header.
+
+  @retval EfiRaw        Variable store is raw
+  @retval EfiValid      Variable store is valid
+  @retval EfiInvalid    Variable store is invalid
+
+**/
 STATIC
 VARIABLE_STORE_STATUS
 EFIAPI
 GetVariableStoreStatus (
   IN VARIABLE_STORE_HEADER *VarStoreHeader
   )
-/*++
 
-Routine Description:
-
-  This code gets the pointer to the variable name.
-
-Arguments:
-
-  VarStoreHeader  Pointer to the Variable Store Header.
-
-Returns:
-
-  EfiRaw        Variable store is raw
-  EfiValid      Variable store is valid
-  EfiInvalid    Variable store is invalid
-
---*/
 {
   if (VarStoreHeader->Signature == VARIABLE_STORE_SIGNATURE &&
       VarStoreHeader->Format == VARIABLE_STORE_FORMATTED &&
@@ -357,6 +286,19 @@ Returns:
   }
 }
 
+/**
+  This function compares a variable with variable entries in database
+
+  @param Variable       - Pointer to the variable in our database
+  @param VariableName   - Name of the variable to compare to 'Variable'
+  @param VendorGuid     - GUID of the variable to compare to 'Variable'
+  @param PtrTrack       - Variable Track Pointer structure that contains
+                   Variable Information.
+
+  @Retval  EFI_SUCCESS    - Found match variable
+  @retval EFI_NOT_FOUND  - Variable not found
+
+**/
 STATIC
 EFI_STATUS
 CompareWithValidVariable (
@@ -365,26 +307,7 @@ CompareWithValidVariable (
   IN  CONST EFI_GUID                *VendorGuid,
   OUT VARIABLE_POINTER_TRACK        *PtrTrack
   )
-/*++
 
-Routine Description:
-
-  This function compares a variable with variable entries in database
-
-Arguments:
-
-  Variable       - Pointer to the variable in our database
-  VariableName   - Name of the variable to compare to 'Variable'
-  VendorGuid     - GUID of the variable to compare to 'Variable'
-  PtrTrack       - Variable Track Pointer structure that contains
-                   Variable Information.
-
-Returns:
-
-  EFI_SUCCESS    - Found match variable
-  EFI_NOT_FOUND  - Variable not found
-
---*/
 {
   VOID  *Point;
 
@@ -414,6 +337,20 @@ Returns:
   return EFI_NOT_FOUND;
 }
 
+/**
+  This code finds variable in storage blocks (Non-Volatile)
+
+  @param PeiServices    - General purpose services available to every PEIM.
+  @param VariableName   - Name of the variable to be found
+  @param VendorGuid     - Vendor GUID to be found.
+  @param PtrTrack       - Variable Track Pointer structure that contains
+                   Variable Information.
+
+  @retval EFI_SUCCESS      - Variable found successfully
+  @retval EFI_NOT_FOUND    - Variable not found
+  @retval EFI_INVALID_PARAMETER  - Invalid variable name
+
+**/
 STATIC
 EFI_STATUS
 EFIAPI
@@ -423,27 +360,7 @@ FindVariable (
   IN CONST  EFI_GUID          *VendorGuid,
   OUT VARIABLE_POINTER_TRACK  *PtrTrack
   )
-/*++
 
-Routine Description:
-
-  This code finds variable in storage blocks (Non-Volatile)
-
-Arguments:
-
-  PeiServices    - General purpose services available to every PEIM.
-  VariableName   - Name of the variable to be found
-  VendorGuid     - Vendor GUID to be found.
-  PtrTrack       - Variable Track Pointer structure that contains
-                   Variable Information.
-
-Returns:
-
-  EFI_SUCCESS      - Variable found successfully
-  EFI_NOT_FOUND    - Variable not found
-  EFI_INVALID_PARAMETER  - Invalid variable name
-
---*/
 {
   EFI_HOB_GUID_TYPE       *GuidHob;
   VARIABLE_STORE_HEADER   *VariableStoreHeader;
@@ -554,6 +471,28 @@ Returns:
   return EFI_NOT_FOUND;
 }
 
+/**
+  Provide the read variable functionality of the variable services.
+
+  @param PeiServices - General purpose services available to every PEIM.
+
+  @param VariableName     - The variable name
+
+  @param VendorGuid       - The vendor's GUID
+
+  @param Attributes       - Pointer to the attribute
+
+  @param DataSize         - Size of data
+
+  @param Data             - Pointer to data
+
+  @retval EFI_SUCCESS           - The interface could be successfully installed
+
+  @retval EFI_NOT_FOUND         - The variable could not be discovered
+
+  @retval EFI_BUFFER_TOO_SMALL  - The caller buffer is not large enough
+
+**/
 EFI_STATUS
 EFIAPI
 PeiGetVariable (
@@ -564,35 +503,7 @@ PeiGetVariable (
   IN OUT UINTN                           *DataSize,
   OUT VOID                               *Data
   )
-/*++
 
-Routine Description:
-
-  Provide the read variable functionality of the variable services.
-
-Arguments:
-
-  PeiServices - General purpose services available to every PEIM.
-
-  VariableName     - The variable name
-
-  VendorGuid       - The vendor's GUID
-
-  Attributes       - Pointer to the attribute
-
-  DataSize         - Size of data
-
-  Data             - Pointer to data
-
-Returns:
-
-  EFI_SUCCESS           - The interface could be successfully installed
-
-  EFI_NOT_FOUND         - The variable could not be discovered
-
-  EFI_BUFFER_TOO_SMALL  - The caller buffer is not large enough
-
---*/
 {
   VARIABLE_POINTER_TRACK  Variable;
   UINTN                   VarDataSize;
@@ -635,7 +546,28 @@ Returns:
   }
 }
 
+/**
+  Provide the read variable functionality of the variable services.
 
+  @param PeiServices - General purpose services available to every PEIM.
+
+  @param VariableName     - The variable name
+
+  @param VendorGuid       - The vendor's GUID
+
+  @param Attributes       - Pointer to the attribute
+
+  @param DataSize         - Size of data
+
+  @param Data             - Pointer to data
+
+  @retval EFI_SUCCESS           - The interface could be successfully installed
+
+  @retval EFI_NOT_FOUND         - The variable could not be discovered
+
+  @retval EFI_BUFFER_TOO_SMALL  - The caller buffer is not large enough
+
+**/
 EFI_STATUS
 EFIAPI
 PeiGetVariable2 (
@@ -646,35 +578,7 @@ PeiGetVariable2 (
   IN OUT    UINTN                           *DataSize,
   OUT       VOID                            *Data
   )
-/*++
 
-Routine Description:
-
-  Provide the read variable functionality of the variable services.
-
-Arguments:
-
-  PeiServices - General purpose services available to every PEIM.
-
-  VariableName     - The variable name
-
-  VendorGuid       - The vendor's GUID
-
-  Attributes       - Pointer to the attribute
-
-  DataSize         - Size of data
-
-  Data             - Pointer to data
-
-Returns:
-
-  EFI_SUCCESS           - The interface could be successfully installed
-
-  EFI_NOT_FOUND         - The variable could not be discovered
-
-  EFI_BUFFER_TOO_SMALL  - The caller buffer is not large enough
-
---*/
 {
   return PeiGetVariable (
            GetPeiServicesTablePointer (),
@@ -686,6 +590,25 @@ Returns:
            );
 }
 
+/**
+  Provide the get next variable functionality of the variable services.
+
+  @param PeiServices        - General purpose services available to every PEIM.
+  @param VariabvleNameSize  - The variable name's size.
+  @param VariableName       - A pointer to the variable's name.
+  @param VendorGuid         - A pointer to the EFI_GUID structure.
+
+  @param VariableNameSize - Size of the variable name
+
+  @param VariableName     - The variable name
+
+  @param VendorGuid       - The vendor's GUID
+
+  @retval EFI_SUCCESS - The interface could be successfully installed
+
+  @retval EFI_NOT_FOUND - The variable could not be discovered
+
+**/
 EFI_STATUS
 EFIAPI
 PeiGetNextVariableName (
@@ -694,32 +617,7 @@ PeiGetNextVariableName (
   IN OUT CHAR16                   *VariableName,
   IN OUT EFI_GUID                 *VendorGuid
   )
-/*++
 
-Routine Description:
-
-  Provide the get next variable functionality of the variable services.
-
-Arguments:
-
-  PeiServices        - General purpose services available to every PEIM.
-  VariabvleNameSize  - The variable name's size.
-  VariableName       - A pointer to the variable's name.
-  VendorGuid         - A pointer to the EFI_GUID structure.
-
-  VariableNameSize - Size of the variable name
-
-  VariableName     - The variable name
-
-  VendorGuid       - The vendor's GUID
-
-Returns:
-
-  EFI_SUCCESS - The interface could be successfully installed
-
-  EFI_NOT_FOUND - The variable could not be discovered
-
---*/
 {
   VARIABLE_POINTER_TRACK  Variable;
   UINTN                   VarNameSize;
@@ -774,6 +672,26 @@ Returns:
   return EFI_NOT_FOUND;
 }
 
+/**
+  Provide the get next variable functionality of the variable services.
+
+  @param PeiServices        - General purpose services available to every PEIM.
+  @param VariabvleNameSize  - The variable name's size.
+  @param VariableName       - A pointer to the variable's name.
+  @param VariableGuid       - A pointer to the EFI_GUID structure.
+
+  @param VariableNameSize - Size of the variable name
+
+  @param VariableName     - The variable name
+
+  @param VendorGuid       - The vendor's GUID
+
+
+  @retval EFI_SUCCESS - The interface could be successfully installed
+
+  @retval EFI_NOT_FOUND - The variable could not be discovered
+
+**/
 EFI_STATUS
 EFIAPI
 PeiGetNextVariableName2 (
@@ -782,32 +700,7 @@ PeiGetNextVariableName2 (
   IN OUT CHAR16                             *VariableName,
   IN OUT EFI_GUID                           *VariableGuid
   )
-/*++
 
-Routine Description:
-
-  Provide the get next variable functionality of the variable services.
-
-Arguments:
-
-  PeiServices        - General purpose services available to every PEIM.
-  VariabvleNameSize  - The variable name's size.
-  VariableName       - A pointer to the variable's name.
-  VariableGuid       - A pointer to the EFI_GUID structure.
-
-  VariableNameSize - Size of the variable name
-
-  VariableName     - The variable name
-
-  VendorGuid       - The vendor's GUID
-
-Returns:
-
-  EFI_SUCCESS - The interface could be successfully installed
-
-  EFI_NOT_FOUND - The variable could not be discovered
-
---*/
 {
   return PeiGetNextVariableName (
            GetPeiServicesTablePointer (),
@@ -816,3 +709,4 @@ Returns:
            VariableGuid
            );
 }
+

IntelFrameworkModulePkg/Universal/VariablePei/Variable.h

@@ -9,14 +9,6 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
-Module Name:
-
-  Variable.h
-
-Abstract:
-
-  Tiano PEIM to provide the variable functionality
-
 **/
 
 #ifndef _PEI_VARIABLE_H
@@ -73,22 +65,6 @@ PeimInitializeVariableServices (
   IN EFI_FFS_FILE_HEADER       *FfsHeader,
   IN EFI_PEI_SERVICES          **PeiServices
   )
-/*++
-
-Routine Description:
-
-  TODO: Add function description
-
-Arguments:
-
-  FfsHeader   - TODO: add argument description
-  PeiServices - TODO: add argument description
-
-Returns:
-
-  TODO: add return values
-
---*/
 ;
 
 EFI_STATUS
@@ -101,26 +77,6 @@ PeiGetVariable (
   IN OUT UINTN                    *DataSize,
   OUT VOID                        *Data
   )
-/*++
-
-Routine Description:
-
-  TODO: Add function description
-
-Arguments:
-
-  PeiServices   - TODO: add argument description
-  VariableName  - TODO: add argument description
-  VendorGuid    - TODO: add argument description
-  Attributes    - TODO: add argument description
-  DataSize      - TODO: add argument description
-  Data          - TODO: add argument description
-
-Returns:
-
-  TODO: add return values
-
---*/
 ;
 
 EFI_STATUS
@@ -133,35 +89,6 @@ PeiGetVariable2 (
   IN OUT    UINTN                           *DataSize,
   OUT       VOID                            *Data
   )
-/*++
-
-Routine Description:
-
-  Provide the read variable functionality of the variable services.
-
-Arguments:
-
-  PeiServices - General purpose services available to every PEIM.
-
-  VariableName     - The variable name
-
-  VendorGuid       - The vendor's GUID
-
-  Attributes       - Pointer to the attribute
-
-  DataSize         - Size of data
-
-  Data             - Pointer to data
-
-Returns:
-
-  EFI_SUCCESS           - The interface could be successfully installed
-
-  EFI_NOT_FOUND         - The variable could not be discovered
-
-  EFI_BUFFER_TOO_SMALL  - The caller buffer is not large enough
-
---*/
 ;  
   
 EFI_STATUS
@@ -172,32 +99,6 @@ PeiGetNextVariableName2 (
   IN OUT CHAR16                             *VariableName,
   IN OUT EFI_GUID                           *VariableGuid
   )
-/*++
-
-Routine Description:
-
-  Provide the get next variable functionality of the variable services.
-
-Arguments:
-
-  PeiServices        - General purpose services available to every PEIM.
-  VariabvleNameSize  - The variable name's size.
-  VariableName       - A pointer to the variable's name.
-  VariableGuid       - A pointer to the EFI_GUID structure.
-
-  VariableNameSize - Size of the variable name
-
-  VariableName     - The variable name
-
-  VendorGuid       - The vendor's GUID
-
-Returns:
-
-  EFI_SUCCESS - The interface could be successfully installed
-
-  EFI_NOT_FOUND - The variable could not be discovered
-
---*/
 ;
   
 EFI_STATUS
@@ -208,24 +109,6 @@ PeiGetNextVariableName (
   IN OUT CHAR16                   *VariableName,
   IN OUT EFI_GUID                 *VendorGuid
   )
-/*++
-
-Routine Description:
-
-  TODO: Add function description
-
-Arguments:
-
-  PeiServices       - TODO: add argument description
-  VariableNameSize  - TODO: add argument description
-  VariableName      - TODO: add argument description
-  VendorGuid        - TODO: add argument description
-
-Returns:
-
-  TODO: add return values
-
---*/
 ;
 
 /**