summaryrefslogtreecommitdiff
path: root/MdeModulePkg/Universal/BdsDxe/Hotkey.h
diff options
context:
space:
mode:
Diffstat (limited to 'MdeModulePkg/Universal/BdsDxe/Hotkey.h')
-rw-r--r--MdeModulePkg/Universal/BdsDxe/Hotkey.h117
1 files changed, 117 insertions, 0 deletions
diff --git a/MdeModulePkg/Universal/BdsDxe/Hotkey.h b/MdeModulePkg/Universal/BdsDxe/Hotkey.h
new file mode 100644
index 0000000000..87059e12e0
--- /dev/null
+++ b/MdeModulePkg/Universal/BdsDxe/Hotkey.h
@@ -0,0 +1,117 @@
+/*++
+
+Copyright (c) 2007 - 2008, Intel Corporation
+All rights reserved. This program and the accompanying materials
+are licensed and made available under the terms and conditions of the BSD License
+which accompanies this distribution. The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+Module Name:
+
+ Hotkey.h
+
+Abstract:
+
+ Provides a way for 3rd party applications to register themselves for launch by the
+ Boot Manager based on hot key
+
+Revision History
+
+--*/
+
+#ifndef _HOTKEY_H
+#define _HOTKEY_H
+
+#include "Bds.h"
+#include "String.h"
+
+#define GET_KEY_CODE_COUNT(KeyOptions) (((KeyOptions) & EFI_KEY_CODE_COUNT) >> 8)
+
+#define BDS_HOTKEY_OPTION_SIGNATURE EFI_SIGNATURE_32 ('B', 'd', 'K', 'O')
+typedef struct {
+ UINTN Signature;
+ LIST_ENTRY Link;
+
+ EFI_HANDLE NotifyHandle;
+ UINT16 BootOptionNumber;
+ UINT8 CodeCount;
+ UINT8 WaitingKey;
+ EFI_KEY_DATA KeyData[3];
+} BDS_HOTKEY_OPTION;
+
+#define BDS_HOTKEY_OPTION_FROM_LINK(a) CR (a, BDS_HOTKEY_OPTION, Link, BDS_HOTKEY_OPTION_SIGNATURE)
+
+#define VarKeyOrder L"KeyOrder"
+
+EFI_STATUS
+RegisterHotkey (
+ IN EFI_KEY_OPTION *KeyOption,
+ OUT UINT16 *KeyOptionNumber
+)
+/*++
+
+Routine Description:
+
+ Create Key#### for the given hotkey.
+
+Arguments:
+
+ KeyOption - The Hot Key Option to be added.
+ KeyOptionNumber - The key option number for Key#### (optional).
+
+Returns:
+
+ EFI_SUCCESS - Register hotkey successfully.
+ EFI_INVALID_PARAMETER - The hotkey option is invalid.
+
+--*/
+;
+
+EFI_STATUS
+UnregisterHotkey (
+ IN UINT16 KeyOptionNumber
+)
+/*++
+
+Routine Description:
+
+ Delete Key#### for the given Key Option number.
+
+Arguments:
+
+ KeyOptionNumber - Key option number for Key####
+
+Returns:
+
+ EFI_SUCCESS - Unregister hotkey successfully.
+ EFI_NOT_FOUND - No Key#### is found for the given Key Option number.
+
+--*/
+;
+
+
+EFI_STATUS
+InitializeHotkeyService (
+ VOID
+ )
+/*++
+
+Routine Description:
+
+ Process all the "Key####" variables, associate Hotkeys with corresponding Boot Options.
+
+Arguments:
+
+ None
+
+Returns:
+
+ EFI_SUCCESS - Hotkey services successfully initialized.
+
+--*/
+;
+
+#endif