edk2/MdeModulePkg/Universal/BdsDxe/BootMaint/BootOption.c:

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

/*++\r
\r
Copyright (c) 2007 - 2008, 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
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
  Hotkey.h\r
\r
Abstract:\r
\r
  Provides a way for 3rd party applications to register themselves for launch by the\r
  Boot Manager based on hot key\r
\r
Revision History\r
\r
--*/\r
\r
#ifndef _HOTKEY_H\r
#define _HOTKEY_H\r
\r
#include "Bds.h"\r
#include "String.h"\r
\r
#define GET_KEY_CODE_COUNT(KeyOptions)      (((KeyOptions) & EFI_KEY_CODE_COUNT) >> 8)\r
\r
#define BDS_HOTKEY_OPTION_SIGNATURE EFI_SIGNATURE_32 ('B', 'd', 'K', 'O')\r
typedef struct {\r
  UINTN                     Signature;\r
  LIST_ENTRY                Link;\r
\r
  EFI_HANDLE                NotifyHandle;\r
  UINT16                    BootOptionNumber;\r
  UINT8                     CodeCount;\r
  UINT8                     WaitingKey;\r
  EFI_KEY_DATA              KeyData[3];\r
} BDS_HOTKEY_OPTION;\r
\r
#define BDS_HOTKEY_OPTION_FROM_LINK(a) CR (a, BDS_HOTKEY_OPTION, Link, BDS_HOTKEY_OPTION_SIGNATURE)\r
\r
#define VarKeyOrder       L"KeyOrder"\r
\r
EFI_STATUS\r
RegisterHotkey (\r
  IN EFI_KEY_OPTION     *KeyOption,\r
  OUT UINT16            *KeyOptionNumber\r
)\r
/*++\r
\r
Routine Description:\r
\r
  Create Key#### for the given hotkey.\r
\r
Arguments:\r
\r
  KeyOption             - The Hot Key Option to be added.\r
  KeyOptionNumber       - The key option number for Key#### (optional).\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Register hotkey successfully.\r
  EFI_INVALID_PARAMETER - The hotkey option is invalid.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
UnregisterHotkey (\r
  IN UINT16             KeyOptionNumber\r
)\r
/*++\r
\r
Routine Description:\r
\r
  Delete Key#### for the given Key Option number.\r
\r
Arguments:\r
\r
  KeyOptionNumber       - Key option number for Key####\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Unregister hotkey successfully.\r
  EFI_NOT_FOUND         - No Key#### is found for the given Key Option number.\r
\r
--*/\r
;\r
\r
\r
EFI_STATUS\r
InitializeHotkeyService (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Process all the "Key####" variables, associate Hotkeys with corresponding Boot Options.\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  EFI_SUCCESS   - Hotkey services successfully initialized.\r
\r
--*/\r
;\r
\r
#endif\r