Enhance BMM to support changing FlowControl setting in Front Page.

[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / BdsDxe / BootMaint / BootMaint.h

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h
index 42449fb90d245ca57f405e21e3c7743b49e8fd66..67eaeec01114bc89f8d319894ec00ea929cb47da 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h
@@ -1,8 +1,8 @@
 /** @file\r
   Header file for boot maintenance module.\r
 \r
-Copyright (c) 2004 - 2009, Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>\r
+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
@@ -189,15 +189,14 @@ typedef enum _FILE_EXPLORER_DISPLAY_CONTEXT {
 #define CON_MODE_VAR_OFFSET             VAR_OFFSET (ConsoleOutMode)\r
 #define CON_DEVICE_VAR_OFFSET           VAR_OFFSET (ConsoleCheck)\r
 #define OPTION_ORDER_VAR_OFFSET         VAR_OFFSET (OptionOrder)\r
-#define DRIVER_OPTION_ORDER_VAR_OFFSET  VAR_OFFSET (DriverOptionToBeDeleted)\r
-#define BOOT_OPTION_DEL_VAR_OFFSET      VAR_OFFSET (BootOptionDel)\r
-#define DRIVER_OPTION_DEL_VAR_OFFSET    VAR_OFFSET (DriverOptionDel)\r
+#define OPTION_DEL_VAR_OFFSET           VAR_OFFSET (OptionDel)\r
 #define DRIVER_ADD_OPTION_VAR_OFFSET    VAR_OFFSET (DriverAddHandleOptionalData)\r
 #define COM_BAUD_RATE_VAR_OFFSET        VAR_OFFSET (COMBaudRate)\r
 #define COM_DATA_RATE_VAR_OFFSET        VAR_OFFSET (COMDataRate)\r
 #define COM_STOP_BITS_VAR_OFFSET        VAR_OFFSET (COMStopBits)\r
 #define COM_PARITY_VAR_OFFSET           VAR_OFFSET (COMParity)\r
 #define COM_TERMINAL_VAR_OFFSET         VAR_OFFSET (COMTerminalType)\r
+#define COM_FLOWCONTROL_VAR_OFFSET      VAR_OFFSET (COMFlowControl)\r
 #define LEGACY_FD_VAR_OFFSET            VAR_OFFSET (LegacyFD)\r
 #define LEGACY_HD_VAR_OFFSET            VAR_OFFSET (LegacyHD)\r
 #define LEGACY_CD_VAR_OFFSET            VAR_OFFSET (LegacyCD)\r
@@ -228,15 +227,14 @@ typedef enum _FILE_EXPLORER_DISPLAY_CONTEXT {
 #define CON_MODE_QUESTION_ID            QUESTION_ID (ConsoleOutMode)\r
 #define CON_DEVICE_QUESTION_ID          QUESTION_ID (ConsoleCheck)\r
 #define OPTION_ORDER_QUESTION_ID        QUESTION_ID (OptionOrder)\r
-#define DRIVER_OPTION_ORDER_QUESTION_ID QUESTION_ID (DriverOptionToBeDeleted)\r
-#define BOOT_OPTION_DEL_QUESTION_ID     QUESTION_ID (BootOptionDel)\r
-#define DRIVER_OPTION_DEL_QUESTION_ID   QUESTION_ID (DriverOptionDel)\r
+#define OPTION_DEL_QUESTION_ID          QUESTION_ID (OptionDel)\r
 #define DRIVER_ADD_OPTION_QUESTION_ID   QUESTION_ID (DriverAddHandleOptionalData)\r
 #define COM_BAUD_RATE_QUESTION_ID       QUESTION_ID (COMBaudRate)\r
 #define COM_DATA_RATE_QUESTION_ID       QUESTION_ID (COMDataRate)\r
 #define COM_STOP_BITS_QUESTION_ID       QUESTION_ID (COMStopBits)\r
 #define COM_PARITY_QUESTION_ID          QUESTION_ID (COMParity)\r
 #define COM_TERMINAL_QUESTION_ID        QUESTION_ID (COMTerminalType)\r
+#define COM_FLOWCONTROL_QUESTION_ID     QUESTION_ID (COMFlowControl)\r
 #define LEGACY_FD_QUESTION_ID           QUESTION_ID (LegacyFD)\r
 #define LEGACY_HD_QUESTION_ID           QUESTION_ID (LegacyHD)\r
 #define LEGACY_CD_QUESTION_ID           QUESTION_ID (LegacyCD)\r
@@ -256,13 +254,23 @@ typedef struct {
 } COM_ATTR;\r
 \r
 #pragma pack(1)\r
+///\r
+/// For each legacy boot option in BBS table, a corresponding Boot#### variables is created.\r
+/// The structure saves the mapping relationship between #### and the index in the BBS table.\r
+///\r
+typedef struct {\r
+  UINT16    BootOptionNumber;\r
+  UINT16    BbsIndex;\r
+  UINT16    BbsType;\r
+} BOOT_OPTION_BBS_MAPPING;\r
+\r
 typedef struct {\r
   BBS_TYPE  BbsType;\r
   ///\r
   /// Length = sizeof (UINT16) + SIZEOF (Data)\r
   ///\r
   UINT16    Length;\r
-  UINT16    *Data;\r
+  UINT16    Data[1];\r
 } BM_LEGACY_DEV_ORDER_CONTEXT;\r
 #pragma pack()\r
 \r
@@ -277,6 +285,8 @@ typedef struct {
   UINT8                     ParityIndex;\r
   UINT8                     StopBitsIndex;\r
 \r
+  UINT8                     FlowControl;\r
+\r
   UINT8                     IsConIn;\r
   UINT8                     IsConOut;\r
   UINT8                     IsStdErr;\r
@@ -308,10 +318,10 @@ typedef struct {
 } BM_LOAD_CONTEXT;\r
 \r
 typedef struct {\r
-  BBS_TABLE *BbsTable;\r
-  UINTN     Index;\r
-  UINTN     BbsCount;\r
-  UINT16    *Description;\r
+  BBS_TABLE *BbsEntry;\r
+  UINT16    BbsIndex;\r
+  UINT16    BbsCount;\r
+  CHAR16    *Description;\r
 } BM_LEGACY_DEVICE_CONTEXT;\r
 \r
 typedef struct {\r
@@ -591,6 +601,20 @@ BOpt_IsEfiApp (
 \r
   Get the Option Number that has not been allocated for use.\r
 \r
+  @param Type  The type of Option.\r
+\r
+  @return The available Option Number.\r
+\r
+**/\r
+UINT16\r
+BOpt_GetOptionNumber (\r
+  CHAR16        *Type\r
+  );\r
+\r
+/**\r
+\r
+  Get the Option Number for Boot#### that does not used.\r
+\r
   @return The available Option Number.\r
 \r
 **/\r
@@ -601,9 +625,9 @@ BOpt_GetBootOptionNumber (
 \r
 /**\r
 \r
-  Get the Option Number that is not in use.\r
+Get the Option Number for Driver#### that does not used.\r
 \r
-  @return The unused Option Number.\r
+@return The unused Option Number.\r
 \r
 **/\r
 UINT16\r
@@ -737,7 +761,7 @@ ChangeVariableDevicePath (
 **/\r
 EFI_STATUS\r
 ChangeTerminalDevicePath (\r
-  IN OUT EFI_DEVICE_PATH_PROTOCOL  *DevicePath,\r
+  IN OUT EFI_DEVICE_PATH_PROTOCOL  **DevicePath,\r
   IN BOOLEAN                   ChangeTerminal\r
   );\r
 \r
@@ -1543,7 +1567,8 @@ extern STRING_DEPOSITORY          *DriverOptionHelpStrDepository;
 extern STRING_DEPOSITORY          *TerminalStrDepository;\r
 extern EFI_DEVICE_PATH_PROTOCOL   EndDevicePath[];\r
 extern EFI_GUID                   EfiLegacyDevOrderGuid;\r
-\r
+extern UINT16                     mFlowControlType[2];\r
+extern UINT32                     mFlowControlValue[2];\r
 //\r
 // Shared IFR form update data\r
 //\r