Change the EFI_BOOT_KEY_DATA definition to use macro instead of bit fields.

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

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/Hotkey.h b/IntelFrameworkModulePkg/Universal/BdsDxe/Hotkey.h
index f2c964e0c53318ccddcbe1fe40f6a373582617da..5df601441949ec7a245d1039ecd6f3c91d504d26 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/Hotkey.h
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/Hotkey.h
@@ -19,13 +19,89 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "Bds.h"\r
 #include "String.h"\r
 \r
-#define GET_BOOT_OPTION_SUPPORT_KEY_COUNT(a) (((a) & EFI_BOOT_OPTION_SUPPORT_COUNT) >> 8)\r
 #define SET_BOOT_OPTION_SUPPORT_KEY_COUNT(a, c) {  \\r
-      (a) = ((a) & ~EFI_BOOT_OPTION_SUPPORT_COUNT) | (((c) << 8) & EFI_BOOT_OPTION_SUPPORT_COUNT); \\r
+      (a) = ((a) & ~EFI_BOOT_OPTION_SUPPORT_COUNT) | (((c) << LowBitSet32 (EFI_BOOT_OPTION_SUPPORT_COUNT)) & EFI_BOOT_OPTION_SUPPORT_COUNT); \\r
       }\r
 \r
 #define BDS_HOTKEY_OPTION_SIGNATURE SIGNATURE_32 ('B', 'd', 'K', 'O')\r
 \r
+/**\r
+  Get the revision of the EFI_KEY_OPTION structure.\r
+\r
+  @param   KeyOption  Pointer to the EFI_KEY_OPTION structure. \r
+\r
+  @return  Revision.\r
+**/\r
+#define KEY_OPTION_REVISION(KeyOption)           ((KeyOption)->KeyData & EFI_KEY_OPTION_REVISION_MASK)\r
+\r
+/**\r
+  Get the actual number of entries in EFI_KEY_OPTION.Keys, from 0-3.\r
+\r
+  @param   KeyOption  Pointer to the EFI_KEY_OPTION structure. \r
+\r
+  @return  Actual number of entries in EFI_KEY_OPTION.Keys.\r
+**/\r
+#define KEY_OPTION_INPUT_KEY_COUNT(KeyOption)    (((KeyOption)->KeyData & EFI_KEY_OPTION_INPUT_KEY_COUNT_MASK) >> LowBitSet32 (EFI_KEY_OPTION_INPUT_KEY_COUNT_MASK))\r
+\r
+/**\r
+  Return whether the Shift key needs pressed.\r
+\r
+  @param   KeyOption  Pointer to the EFI_KEY_OPTION structure. \r
+\r
+  @retval  TRUE  Shift key needs pressed.\r
+  @retval  FALSE Shift key needn't pressed.\r
+**/\r
+#define KEY_OPTION_SHIFT_PRESSED(KeyOption)      (BOOLEAN) (((KeyOption)->KeyData & EFI_KEY_OPTION_SHIFT_PRESSED_MASK) != 0)\r
+\r
+/**\r
+  Return whether the Control key needs pressed.\r
+\r
+  @param   KeyOption  Pointer to the EFI_KEY_OPTION structure. \r
+\r
+  @retval  TRUE  Control key needs pressed.\r
+  @retval  FALSE Control key needn't pressed.\r
+**/\r
+#define KEY_OPTION_CONTROL_PRESSED(KeyOption)    (BOOLEAN) (((KeyOption)->KeyData & EFI_KEY_OPTION_CONTROL_PRESSED_MASK) != 0)\r
+\r
+/**\r
+  Return whether the Alt key needs pressed.\r
+\r
+  @param   KeyOption  Pointer to the EFI_KEY_OPTION structure. \r
+\r
+  @retval  TRUE  Alt key needs pressed.\r
+  @retval  FALSE Alt key needn't pressed.\r
+**/\r
+#define KEY_OPTION_ALT_PRESSED(KeyOption)        (BOOLEAN) (((KeyOption)->KeyData & EFI_KEY_OPTION_ALT_PRESSED_MASK) != 0)\r
+\r
+/**\r
+  Return whether the Logo key needs pressed.\r
+\r
+  @param   KeyOption  Pointer to the EFI_KEY_OPTION structure. \r
+\r
+  @retval  TRUE  Logo key needs pressed.\r
+  @retval  FALSE Logo key needn't pressed.\r
+**/\r
+#define KEY_OPTION_LOGO_PRESSED(KeyOption)       (BOOLEAN) (((KeyOption)->KeyData & EFI_KEY_OPTION_LOGO_PRESSED_MASK) != 0)\r
+\r
+/**\r
+  Return whether the Menu key needs pressed.\r
+\r
+  @param   KeyOption  Pointer to the EFI_KEY_OPTION structure. \r
+\r
+  @retval  TRUE  Menu key needs pressed.\r
+  @retval  FALSE Menu key needn't pressed.\r
+**/\r
+#define KEY_OPTION_MENU_PRESSED(KeyOption)       (BOOLEAN) (((KeyOption)->KeyData & EFI_KEY_OPTION_MENU_PRESSED_MASK) != 0)\r
+\r
+/**\r
+  Return whether the SysReq key needs pressed.\r
+\r
+  @param   KeyOption  Pointer to the EFI_KEY_OPTION structure. \r
+\r
+  @retval  TRUE  SysReq key needs pressed.\r
+  @retval  FALSE SysReq key needn't pressed.\r
+**/\r
+#define KEY_OPTION_SYS_REQ_PRESSED(KeyOption)    (BOOLEAN) (((KeyOption)->KeyData & EFI_KEY_OPTION_SYS_REQ_PRESSED_MASK) != 0)\r
 \r
 typedef struct {\r
   UINTN                     Signature;\r