Committing changes to the comments, after review with engineers.

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Library / GenericBdsLib.h

diff --git a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
index f17f4344b039bb71214a46c1e96ad4bb97e3b90f..b3c748c3f6fff5acfa56d883d64efc561434a755 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
@@ -109,8 +109,7 @@ BdsLibBootNext (
   );\r
 \r
 /**\r
-  Process the boot option follow the UEFI specification and\r
-  special treat the legacy boot option with BBS_DEVICE_PATH.\r
+  Process the boot option according to the UEFI specification. The legacy boot option device path includes BBS_DEVICE_PATH.\r
 \r
   @param  Option                 The boot option to be processed\r
   @param  DevicePath             The device path describing where to load the\r
@@ -255,7 +254,8 @@ BdsLibLoadDrivers (
 \r
 \r
 /**\r
-  Process BootOrder, or DriverOrder variables, by calling\r
+  This function processes BootOrder or DriverOrder variables, by calling\r
+\r
   BdsLibVariableToOption () for each UINT16 in the variables.\r
 \r
   @param  BdsCommonOptionList   The header of the option list base on variable\r
@@ -384,7 +384,7 @@ BdsLibConnectAll (
   );\r
 \r
 /**\r
-  This function creates all handles associated with every device\r
+  This function creates all handles associated with the given device\r
   path node. If the handle associated with one device path node can not\r
   be created, then it tries to execute the dispatch to load the missing drivers.  \r
 \r
@@ -430,7 +430,7 @@ BdsLibDisconnectAllEfi (
 //\r
 /**\r
   This function will search every simpletxt device in the current system,\r
-  and make every simpletxt device as pertantial console device.\r
+  and make every simpletxt device a potential console device.\r
 \r
 **/\r
 VOID\r
@@ -671,7 +671,7 @@ BdsUpdateLegacyDevOrder (
   );\r
 \r
 /**\r
-  Set the boot priority for BBS entries based on boot option entry and boot order.\r
+  Refresh the boot priority for BBS entries based on boot option entry and boot order.\r
 \r
   @param  Entry             The boot option is to be checked for refresh BBS table.\r
   \r
@@ -686,7 +686,7 @@ BdsRefreshBbsTableForBoot (
   );\r
 \r
 /**\r
-  Deletete the Boot Option from EFI Variable. The Boot Order Arrray\r
+  Delete the Boot Option from EFI Variable. The Boot Order Arrray\r
   is also updated.\r
 \r
   @param OptionNumber    The number of Boot option want to be deleted.\r
@@ -786,24 +786,6 @@ SetupResetReminder (
   );\r
 \r
 \r
-///\r
-/// Define the boot option default description \r
-///\r
-#define DESCRIPTION_FLOPPY        L"EFI Floppy"\r
-#define DESCRIPTION_FLOPPY_NUM    L"EFI Floppy %d"\r
-#define DESCRIPTION_DVD           L"EFI DVD/CDROM"\r
-#define DESCRIPTION_DVD_NUM       L"EFI DVD/CDROM %d"\r
-#define DESCRIPTION_USB           L"EFI USB Device"\r
-#define DESCRIPTION_USB_NUM       L"EFI USB Device %d"\r
-#define DESCRIPTION_SCSI          L"EFI SCSI Device"\r
-#define DESCRIPTION_SCSI_NUM      L"EFI SCSI Device %d"\r
-#define DESCRIPTION_MISC          L"EFI Misc Device"\r
-#define DESCRIPTION_MISC_NUM      L"EFI Misc Device %d"\r
-#define DESCRIPTION_NETWORK       L"EFI Network"\r
-#define DESCRIPTION_NETWORK_NUM   L"EFI Network %d"       \r
-#define DESCRIPTION_NON_BLOCK     L"EFI Non-Block Boot Device"\r
-#define DESCRIPTION_NON_BLOCK_NUM L"EFI Non-Block Boot Device %d"\r
-\r
 ///\r
 /// Define the boot type which to classify the boot option type\r
 /// Different boot option type could have different boot behavior\r
@@ -822,8 +804,10 @@ SetupResetReminder (
 #define  BDS_EFI_MESSAGE_ATAPI_BOOT       0x0301 // Type 03; Sub-Type 01\r
 #define  BDS_EFI_MESSAGE_SCSI_BOOT        0x0302 // Type 03; Sub-Type 02\r
 #define  BDS_EFI_MESSAGE_USB_DEVICE_BOOT  0x0305 // Type 03; Sub-Type 05\r
-#define  BDS_EFI_MESSAGE_SATA_BOOT        0x0318 // Type 03; Sub-Type 18\r
+#define  BDS_EFI_MESSAGE_SATA_BOOT        0x0312 // Type 03; Sub-Type 18\r
+#define  BDS_EFI_MESSAGE_MAC_BOOT         0x030b // Type 03; Sub-Type 11\r
 #define  BDS_EFI_MESSAGE_MISC_BOOT        0x03FF\r
+\r
 ///\r
 /// Media boot type\r
 /// If a device path of boot option contain a media node, the boot option is media boot type\r
@@ -865,11 +849,11 @@ MatchPartitionDevicePathNode (
 \r
 /**\r
   Expand a device path that starts with a hard drive media device path node to be a\r
-  full device path that includes the full hardware path to the device. We need\r
-  to do this so it can be booted. As an optimizaiton the front match (the part point\r
-  to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ) is saved in a variable\r
-  so a connect all is not required on every boot. All successful history device path\r
-  which point to partition node (the front part) will be saved.\r
+  full device path that includes the full hardware path to the device. This function enables the device to boot. \r
+  To avoid requiring a connect on every boot, the front match is saved in a variable (the part point\r
+  to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ).\r
+  All successful history device paths\r
+  that point to the front part of the partition node will be saved.\r
 \r
   @param  HardDriveDevicePath    EFI Device Path to boot, if it starts with a hard\r
                                  drive media device path.\r