Merged in the following trackers from EDK:

[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbKbDxe / keyboard.h

/** @file\r
Copyright (c) 2004 - 2005, 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
    Keyboard.h\r
\r
Abstract:\r
\r
    Function prototype for USB Keyboard Driver\r
\r
Revision History\r
\r
**/\r
\r
#ifndef _KEYBOARD_H\r
#define _KEYBOARD_H\r
\r
\r
#include "efikey.h"\r
\r
BOOLEAN\r
IsUSBKeyboard (\r
  IN  EFI_USB_IO_PROTOCOL       *UsbIo\r
  );\r
\r
EFI_STATUS\r
InitUSBKeyboard (\r
  IN USB_KB_DEV   *UsbKeyboardDevice\r
  );\r
\r
EFI_STATUS\r
InitKeyboardLayout (\r
  IN USB_KB_DEV   *UsbKeyboardDevice\r
  );\r
\r
VOID\r
ReleaseKeyboardLayoutResources (\r
  USB_KB_DEV  *UsbKeyboardDevice\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
KeyboardHandler (\r
  IN  VOID          *Data,\r
  IN  UINTN         DataLength,\r
  IN  VOID          *Context,\r
  IN  UINT32        Result\r
  );\r
\r
VOID\r
EFIAPI\r
USBKeyboardRecoveryHandler (\r
  IN    EFI_EVENT    Event,\r
  IN    VOID         *Context\r
  );\r
\r
EFI_STATUS\r
USBParseKey (\r
  IN OUT  USB_KB_DEV  *UsbKeyboardDevice,\r
  OUT     UINT8       *KeyChar\r
  );\r
\r
EFI_STATUS\r
USBKeyCodeToEFIScanCode (\r
  IN  USB_KB_DEV      *UsbKeyboardDevice,\r
  IN  UINT8           KeyChar,\r
  OUT EFI_INPUT_KEY   *Key\r
  );\r
\r
EFI_STATUS\r
InitUSBKeyBuffer (\r
  IN OUT  USB_KB_BUFFER   *KeyboardBuffer\r
  );\r
\r
BOOLEAN\r
IsUSBKeyboardBufferEmpty (\r
  IN  USB_KB_BUFFER   *KeyboardBuffer\r
  );\r
\r
BOOLEAN\r
IsUSBKeyboardBufferFull (\r
  IN  USB_KB_BUFFER   *KeyboardBuffer\r
  );\r
\r
EFI_STATUS\r
InsertKeyCode (\r
  IN OUT  USB_KB_BUFFER *KeyboardBuffer,\r
  IN      UINT8         Key,\r
  IN      UINT8         Down\r
  );\r
\r
EFI_STATUS\r
RemoveKeyCode (\r
  IN OUT  USB_KB_BUFFER *KeyboardBuffer,\r
  OUT     USB_KEY       *UsbKey\r
  );\r
\r
VOID\r
EFIAPI\r
USBKeyboardRepeatHandler (\r
  IN    EFI_EVENT    Event,\r
  IN    VOID         *Context\r
  );\r
\r
EFI_STATUS\r
SetKeyLED (\r
  IN  USB_KB_DEV    *UsbKeyboardDevice\r
  );\r
\r
#endif\r