Add comments for these header files

[mirror_edk2.git] / MdeModulePkg / Include / Guid / OverrideVariable.h

diff --git a/MdeModulePkg/Include/Guid/OverrideVariable.h b/MdeModulePkg/Include/Guid/OverrideVariable.h
index 3cd5b0333f4d3af4ddb1b80bedcd392592ec5425..2e6601d5a5662d2e0a35f291b0b21714ad7b2bfa 100644 (file)
--- a/MdeModulePkg/Include/Guid/OverrideVariable.h
+++ b/MdeModulePkg/Include/Guid/OverrideVariable.h
@@ -1,7 +1,37 @@
 /** @file\r
   This file defines the platform driver override variable name and variable guid.\r
-\r
-Copyright (c) 2008, Intel Corporation\r
+  The variable(s) contain the override mappings from Controller Device Path to a set of Driver Device Paths.\r
+  \r
+  VariableLayout {\r
+  //\r
+  // NotEnd indicate whether the variable is the last one, and has no subsequent variable need to load.\r
+  // Each variable has MaximumVariableSize limitation, so multiple variables are required to store\r
+  // large mapping infos.\r
+  // The variable(s) name rule is PlatDriOver, PlatDriOver1, PlatDriOver2, ....\r
+  //\r
+  UINT32                         NotEnd;               //Zero is the last one.\r
+  //\r
+  // The entry which contains the mapping that Controller Device Path to a set of Driver Device Paths\r
+  // There are often multi mapping entries in a variable.\r
+  //\r
+  UINT32                         SIGNATURE;            //SIGNATURE_32('p','d','o','i')\r
+  UINT32                         DriverNum;\r
+  EFI_DEVICE_PATH_PROTOCOL       ControllerDevicePath[];\r
+  EFI_DEVICE_PATH_PROTOCOL       DriverDevicePath[];\r
+  EFI_DEVICE_PATH_PROTOCOL       DriverDevicePath[];\r
+  EFI_DEVICE_PATH_PROTOCOL       DriverDevicePath[];\r
+  ......\r
+  UINT32                         NotEnd;                //Zero is the last one.\r
+  UINT32                         SIGNATURE;\r
+  UINT32                         DriverNum;\r
+  EFI_DEVICE_PATH_PROTOCOL       ControllerDevicePath[];\r
+  EFI_DEVICE_PATH_PROTOCOL       DriverDevicePath[];\r
+  EFI_DEVICE_PATH_PROTOCOL       DriverDevicePath[];\r
+  EFI_DEVICE_PATH_PROTOCOL       DriverDevicePath[];\r
+  ......\r
+  }\r
+\r
+Copyright (c) 2008 - 2009, 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