public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: Dandan Bi <dandan.bi@intel.com>
To: edk2-devel@lists.01.org
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>,
	Ruiyu Ni <ruiyu.ni@intel.com>
Subject: [patch 8/8] MdeModulePkg/NonDiscoverableDeviceRegistrationLib: Fix coding style issues
Date: Mon, 19 Dec 2016 15:20:23 +0800	[thread overview]
Message-ID: <1482132023-10416-9-git-send-email-dandan.bi@intel.com> (raw)
In-Reply-To: <1482132023-10416-1-git-send-email-dandan.bi@intel.com>

1. Fix issues 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>
---
 .../Library/NonDiscoverableDeviceRegistrationLib.h |  4 +++-
 .../NonDiscoverableDeviceRegistrationLib.c         | 14 ++++++++++++--
 .../NonDiscoverableDeviceRegistrationLib.inf       | 22 ++++++++++++----------
 3 files changed, 27 insertions(+), 13 deletions(-)

diff --git a/MdeModulePkg/Include/Library/NonDiscoverableDeviceRegistrationLib.h b/MdeModulePkg/Include/Library/NonDiscoverableDeviceRegistrationLib.h
index 120d914..c2d9e48 100644
--- a/MdeModulePkg/Include/Library/NonDiscoverableDeviceRegistrationLib.h
+++ b/MdeModulePkg/Include/Library/NonDiscoverableDeviceRegistrationLib.h
@@ -30,21 +30,23 @@ typedef enum {
 } NON_DISCOVERABLE_DEVICE_TYPE;
 
 /**
   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
   @param[in,out]  Handle              The handle onto which to install the
                                       non-discoverable device protocol.
                                       If Handle is NULL or *Handle is NULL, a
                                       new handle will be allocated.
   @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 94cd946..6f46dfa 100644
--- a/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.c
+++ b/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.c
@@ -23,10 +23,18 @@
 #include <Library/UefiBootServicesTableLib.h>
 
 #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 (
   IN  NON_DISCOVERABLE_DEVICE_TYPE  Type
   )
@@ -72,23 +80,25 @@ typedef struct {
   EFI_DEVICE_PATH_PROTOCOL            End;
 } NON_DISCOVERABLE_DEVICE_PATH;
 #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
   @param[in,out]  Handle              The handle onto which to install the
                                       non-discoverable device protocol.
                                       If Handle is NULL or *Handle is NULL, a
                                       new handle will be allocated.
   @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
   @retval Other                       The registration failed.
 
diff --git a/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf b/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf
index ba32324..dfcf8dc 100644
--- a/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf
+++ b/MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf
@@ -1,6 +1,8 @@
 # @file
+# Component Description File for NonDiscoverableDeviceRegistrationLib.
+#
 # Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>
 #
 # 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
@@ -30,17 +32,17 @@ [LibraryClasses]
   DebugLib
   DevicePathLib
   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
-- 
1.9.5.msysgit.1



  parent reply	other threads:[~2016-12-19  7:21 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-12-19  7:20 [patch 0/8] Fix coding style issues Dandan Bi
2016-12-19  7:20 ` [patch 1/8] SecurityPkg/FmpAuthenticationLib: Fix Guid format issues Dandan Bi
2016-12-19  7:32   ` Yao, Jiewen
2016-12-19  7:20 ` [patch 2/8] IntelSiliconPkg: Fix " Dandan Bi
2016-12-19  7:32   ` Yao, Jiewen
2016-12-19  7:20 ` [patch 3/8] MdeModulePkg/CapsuleApp: Fix Guid " Dandan Bi
2016-12-19  7:32   ` Yao, Jiewen
2016-12-19  7:20 ` [patch 4/8] MdeModulePkg/EbcDxe: Make variable name follow rules Dandan Bi
2016-12-19  7:33   ` Yao, Jiewen
2016-12-19  7:20 ` [patch 5/8] MdeModulePkg/EmmcDxe: Avoid Non-Boolean type used as Boolean Dandan Bi
2016-12-19  7:38   ` Tian, Feng
2016-12-19  7:20 ` [patch 6/8] MdeModulePkg/TerminalDxe: Initialize variable after declaration Dandan Bi
2016-12-20  1:14   ` Tian, Feng
2016-12-19  7:20 ` [patch 7/8] MdeModulePkg/SataControllerDxe: Fix coding style issue Dandan Bi
2016-12-20  1:18   ` Tian, Feng
2016-12-19  7:20 ` Dandan Bi [this message]
2016-12-19 13:44   ` [patch 8/8] MdeModulePkg/NonDiscoverableDeviceRegistrationLib: Fix coding style issues Ard Biesheuvel

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1482132023-10416-9-git-send-email-dandan.bi@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox