MdeModulePkg/NonDiscoverableDeviceRegistrationLib: Fix coding style issues

1. Fix issues in comments
2. Fix Guid/protocol format

Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

3 files changed, 27 insertions, 13 deletions

diff --git a/MdeModulePkg/Include/Library/NonDiscoverableDeviceRegistrationLib.h b/MdeModulePkg/Include/Library/NonDiscoverableDeviceRegistrationLib.h
index 120d914660..c2d9e48353 100644
--- a/MdeModulePkg/Include/Library/NonDiscoverableDeviceRegistrationLib.h
+++ b/MdeModulePkg/Include/Library/NonDiscoverableDeviceRegistrationLib.h
@@ -32,7 +32,7 @@ typedef enum {
 /**

   Register a non-discoverable MMIO device

 

-  @param[in]      DeviceType          The type of non-discoverable device

+  @param[in]      Type                The type of non-discoverable device

   @param[in]      DmaType             Whether the device is DMA coherent

   @param[in]      InitFunc            Initialization routine to be invoked when

                                       the device is enabled

@@ -43,6 +43,8 @@ typedef enum {
   @param[in]      NumMmioResources    The number of UINTN base/size pairs that

                                       follow, each describing an MMIO region

                                       owned by the device

+  @param[in]  ...                     The variable argument list which contains the

+                                      info about MmioResources.

 

   @retval EFI_SUCCESS                 The registration succeeded.

   @retval Other                       The registration failed.

diff --git a/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.c b/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.c
index 94cd946b69..6f46dfac0f 100644
--- a/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.c
+++ b/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.c
@@ -25,6 +25,14 @@
 #include <Protocol/DevicePath.h>

 #include <Protocol/NonDiscoverableDevice.h>

 

+/**

+  Get Guid form the type of non-discoverable device.

+

+  @param[in]  Type    The type of non-discoverable device.

+

+  @retval   Return the Guid.

+

+**/

 STATIC

 CONST EFI_GUID *

 GetGuidFromType (

@@ -74,9 +82,9 @@ typedef struct {
 #pragma pack ()

 

 /**

-  Register a non-discoverable MMIO device

+  Register a non-discoverable MMIO device.

 

-  @param[in]      DeviceType          The type of non-discoverable device

+  @param[in]      Type                The type of non-discoverable device

   @param[in]      DmaType             Whether the device is DMA coherent

   @param[in]      InitFunc            Initialization routine to be invoked when

                                       the device is enabled

@@ -87,6 +95,8 @@ typedef struct {
   @param[in]      NumMmioResources    The number of UINTN base/size pairs that

                                       follow, each describing an MMIO region

                                       owned by the device

+  @param[in]  ...                     The variable argument list which contains the

+                                      info about MmioResources.

 

   @retval EFI_SUCCESS                 The registration succeeded.

   @retval EFI_INVALID_PARAMETER       An invalid argument was given

diff --git a/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf b/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf
index ba32324c30..dfcf8dcae9 100644
--- a/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf
+++ b/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf
@@ -1,4 +1,6 @@
 # @file

+# Component Description File for NonDiscoverableDeviceRegistrationLib.

+#

 # Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>

 #

 # This program and the accompanying materials

@@ -32,15 +34,15 @@
   UefiBootServicesTableLib

 

 [Protocols]

-  gEdkiiNonDiscoverableDeviceProtocolGuid

+  gEdkiiNonDiscoverableDeviceProtocolGuid    ## PRODUCES

 

 [Guids]

-  gEdkiiNonDiscoverableAhciDeviceGuid

-  gEdkiiNonDiscoverableAmbaDeviceGuid

-  gEdkiiNonDiscoverableEhciDeviceGuid

-  gEdkiiNonDiscoverableNvmeDeviceGuid

-  gEdkiiNonDiscoverableOhciDeviceGuid

-  gEdkiiNonDiscoverableSdhciDeviceGuid

-  gEdkiiNonDiscoverableUfsDeviceGuid

-  gEdkiiNonDiscoverableUhciDeviceGuid

-  gEdkiiNonDiscoverableXhciDeviceGuid

+  gEdkiiNonDiscoverableAhciDeviceGuid    ## CONSUMES   ## GUID

+  gEdkiiNonDiscoverableAmbaDeviceGuid    ## CONSUMES   ## GUID

+  gEdkiiNonDiscoverableEhciDeviceGuid    ## CONSUMES   ## GUID

+  gEdkiiNonDiscoverableNvmeDeviceGuid    ## CONSUMES   ## GUID

+  gEdkiiNonDiscoverableOhciDeviceGuid    ## CONSUMES   ## GUID

+  gEdkiiNonDiscoverableSdhciDeviceGuid   ## CONSUMES   ## GUID

+  gEdkiiNonDiscoverableUfsDeviceGuid     ## CONSUMES   ## GUID

+  gEdkiiNonDiscoverableUhciDeviceGuid    ## CONSUMES   ## GUID

+  gEdkiiNonDiscoverableXhciDeviceGuid    ## CONSUMES   ## GUID