Add more comments in UefiDriverModelLib

[mirror_edk2.git] / MdePkg / Include / Library / UefiDriverModelLib.h

diff --git a/MdePkg/Include/Library/UefiDriverModelLib.h b/MdePkg/Include/Library/UefiDriverModelLib.h
index b6532f15c3839139bf57bd85ccdb86149f49e8c8..d303dfc0656b7c1489d2bf930c615fafb3b0d1e4 100644 (file)
--- a/MdePkg/Include/Library/UefiDriverModelLib.h
+++ b/MdePkg/Include/Library/UefiDriverModelLib.h
@@ -1,16 +1,16 @@
 /** @file\r
-       UEFI Driver Model Library Services\r
+  UEFI Driver Model Library Services\r
 \r
-       Copyright (c) 2006, Intel Corporation                                                         \r
-       All rights reserved. This program and the accompanying materials                          \r
-       are licensed and made available under the terms and conditions of the BSD License         \r
-       which accompanies this distribution.  The full text of the license may be found at        \r
-       http://opensource.org/licenses/bsd-license.php                                            \r
+  Copyright (c) 2006, Intel Corporation                                                         \r
+  All rights reserved. This program and the accompanying materials                          \r
+  are licensed and made available under the terms and conditions of the BSD License         \r
+  which accompanies this distribution.  The full text of the license may be found at        \r
+  http://opensource.org/licenses/bsd-license.php                                            \r
 \r
-       THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-       WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-       Module Name:    UefiDriverModelLib.h\r
+  Module Name:  UefiDriverModelLib.h\r
 \r
 **/\r
 \r
@@ -25,12 +25,13 @@
 #define UEFI_DRIVER_MODEL_LIBRARY_DRIVER_CONFIGURATION_PROTOCOL_ENABLED  0x04\r
 \r
 //\r
-// \r
+// Bitmask values for the protocols that are enabled\r
 //\r
 extern const UINT8                           _gDriverModelProtocolBitmask;\r
 \r
 //\r
-//\r
+// Data structure that declares pointers to the Driver Model \r
+// Protocols.\r
 //\r
 typedef struct {\r
   const EFI_DRIVER_BINDING_PROTOCOL        *DriverBinding;\r
@@ -40,9 +41,15 @@ typedef struct {
 } EFI_DRIVER_MODEL_PROTOCOL_LIST;\r
 \r
 //\r
-//\r
+// The number of UEFI Driver Model Protocols that the module\r
+// produces.  Typically drivers only produce one.\r
+// When UEFI drivers are merged, they will produce several.\r
 //\r
 extern const UINTN                           _gDriverModelProtocolListEntries;\r
+\r
+//\r
+// UEFI Driver Model Protocols arrary\r
+//\r
 extern const EFI_DRIVER_MODEL_PROTOCOL_LIST  _gDriverModelProtocolList[];\r
 \r
 #endif\r