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>

diff --git a/MdeModulePkg/Include/Library/NonDiscoverableDeviceRegistrationLib.h b/MdeModulePkg/Include/Library/NonDiscoverableDeviceRegistrationLib.h
index 120d91466095f882a7569205dcae6033adae69ae..c2d9e48353dca19987eb740314584c42340fdd0c 100644 (file)
--- a/MdeModulePkg/Include/Library/NonDiscoverableDeviceRegistrationLib.h
+++ b/MdeModulePkg/Include/Library/NonDiscoverableDeviceRegistrationLib.h
@@ -32,7 +32,7 @@ typedef enum {
 /**\r
   Register a non-discoverable MMIO device\r
 \r
-  @param[in]      DeviceType          The type of non-discoverable device\r
+  @param[in]      Type                The type of non-discoverable device\r
   @param[in]      DmaType             Whether the device is DMA coherent\r
   @param[in]      InitFunc            Initialization routine to be invoked when\r
                                       the device is enabled\r
@@ -43,6 +43,8 @@ typedef enum {
   @param[in]      NumMmioResources    The number of UINTN base/size pairs that\r
                                       follow, each describing an MMIO region\r
                                       owned by the device\r
+  @param[in]  ...                     The variable argument list which contains the\r
+                                      info about MmioResources.\r
 \r
   @retval EFI_SUCCESS                 The registration succeeded.\r
   @retval Other                       The registration failed.\r

diff --git a/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.c b/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.c
index 94cd946b69d3167d1fd25611bc4051b62e117919..6f46dfac0f07b7dfb3169d9adc8ec9e15223ca5b 100644 (file)
--- a/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.c
+++ b/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.c
@@ -25,6 +25,14 @@
 #include <Protocol/DevicePath.h>\r
 #include <Protocol/NonDiscoverableDevice.h>\r
 \r
+/**\r
+  Get Guid form the type of non-discoverable device.\r
+\r
+  @param[in]  Type    The type of non-discoverable device.\r
+\r
+  @retval   Return the Guid.\r
+\r
+**/\r
 STATIC\r
 CONST EFI_GUID *\r
 GetGuidFromType (\r
@@ -74,9 +82,9 @@ typedef struct {
 #pragma pack ()\r
 \r
 /**\r
-  Register a non-discoverable MMIO device\r
+  Register a non-discoverable MMIO device.\r
 \r
-  @param[in]      DeviceType          The type of non-discoverable device\r
+  @param[in]      Type                The type of non-discoverable device\r
   @param[in]      DmaType             Whether the device is DMA coherent\r
   @param[in]      InitFunc            Initialization routine to be invoked when\r
                                       the device is enabled\r
@@ -87,6 +95,8 @@ typedef struct {
   @param[in]      NumMmioResources    The number of UINTN base/size pairs that\r
                                       follow, each describing an MMIO region\r
                                       owned by the device\r
+  @param[in]  ...                     The variable argument list which contains the\r
+                                      info about MmioResources.\r
 \r
   @retval EFI_SUCCESS                 The registration succeeded.\r
   @retval EFI_INVALID_PARAMETER       An invalid argument was given\r

diff --git a/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf b/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf
index ba32324c303e52d8effae6b1a573aa2f508f0ae7..dfcf8dcae9f5e68b48ba646ad681d2a090f65bab 100644 (file)
--- a/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf
+++ b/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf
@@ -1,4 +1,6 @@
 # @file\r
+# Component Description File for NonDiscoverableDeviceRegistrationLib.\r
+#\r
 # Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>\r
 #\r
 # This program and the accompanying materials\r
@@ -32,15 +34,15 @@
   UefiBootServicesTableLib\r
 \r
 [Protocols]\r
-  gEdkiiNonDiscoverableDeviceProtocolGuid\r
+  gEdkiiNonDiscoverableDeviceProtocolGuid    ## PRODUCES\r
 \r
 [Guids]\r
-  gEdkiiNonDiscoverableAhciDeviceGuid\r
-  gEdkiiNonDiscoverableAmbaDeviceGuid\r
-  gEdkiiNonDiscoverableEhciDeviceGuid\r
-  gEdkiiNonDiscoverableNvmeDeviceGuid\r
-  gEdkiiNonDiscoverableOhciDeviceGuid\r
-  gEdkiiNonDiscoverableSdhciDeviceGuid\r
-  gEdkiiNonDiscoverableUfsDeviceGuid\r
-  gEdkiiNonDiscoverableUhciDeviceGuid\r
-  gEdkiiNonDiscoverableXhciDeviceGuid\r
+  gEdkiiNonDiscoverableAhciDeviceGuid    ## CONSUMES   ## GUID\r
+  gEdkiiNonDiscoverableAmbaDeviceGuid    ## CONSUMES   ## GUID\r
+  gEdkiiNonDiscoverableEhciDeviceGuid    ## CONSUMES   ## GUID\r
+  gEdkiiNonDiscoverableNvmeDeviceGuid    ## CONSUMES   ## GUID\r
+  gEdkiiNonDiscoverableOhciDeviceGuid    ## CONSUMES   ## GUID\r
+  gEdkiiNonDiscoverableSdhciDeviceGuid   ## CONSUMES   ## GUID\r
+  gEdkiiNonDiscoverableUfsDeviceGuid     ## CONSUMES   ## GUID\r
+  gEdkiiNonDiscoverableUhciDeviceGuid    ## CONSUMES   ## GUID\r
+  gEdkiiNonDiscoverableXhciDeviceGuid    ## CONSUMES   ## GUID\r