Unit Keyboard

From Ultibo.org
Jump to: navigation, search

Return to Unit Reference


Description


Ultibo Keyboard Interface unit

Keyboard Devices

This unit provides the Keyboard device interface and keyboard API to be used by both drivers and applications.

The API includes functions to create, register, locate, read, write, control and configure each connected keyboard device.

The API supports a global keyboard buffer so multiple devices can feed data into a common buffer as well as a buffer per device to allow each device to be used for a specific purpose. For example an application with two separate displays may choose to have a keyboard device to control each one individually.

Constants



[Expand]
Keyboard specific constants KEYBOARD_NAME_*


[Expand]
Keyboard device type KEYBOARD_TYPE_*


[Expand]
Keyboard device state KEYBOARD_STATE_*


[Expand]
Keyboard device flag KEYBOARD_FLAG_*


[Expand]
Keyboard device control code KEYBOARD_CONTROL_*


[Expand]
Keyboard device LED KEYBOARD_LED_*


[Expand]
Keyboard buffer size KEYBOARD_BUFFER_*


[Expand]
Keyboard sampling rate KEYBOARD_REPEAT_*


[Expand]
Keyboard data definition KEYBOARD_*


[Expand]
Keyboard logging KEYBOARD_LOG_*


[Expand]
USB keyboard specific constants USBKEYBOARD_*


[Expand]
USB HID interface subclass USB_HID_SUBCLASS_*


[Expand]
USB HID interface protocol USB_HID_BOOT_PROTOCOL_*


[Expand]
USB HID class descriptor USB_HID_DESCRIPTOR_*


[Expand]
USB HID request USB_HID_REQUEST_*


[Expand]
USB HID protocol USB_HID_PROTOCOL_*


[Expand]
USB HID report USB_HID_REPORT_*


[Expand]
USB HID report Ids USB_HID_REPORTID_*


[Expand]
USB HID boot protocol USB_HID_BOOT_LEFT_*, USB_HID_BOOT_RIGHT_*


[Expand]
USB HID boot protocol report data USB_HID_BOOT_REPORT_*


[Expand]
USB HID boot protocol output USB_HID_BOOT_*_LED


[Expand]
USB HID boot protocol output data USB_HID_BOOT_OUTPUT_*


Type definitions



Keyboard data

[Expand]

PKeyboardData = ^TKeyboardData;

TKeyboardData = record

Keyboard buffer

[Expand]

PKeyboardBuffer = ^TKeyboardBuffer;

TKeyboardBuffer = record

Keyboard enumeration callback

TKeyboardEnumerate = function(Keyboard:PKeyboardDevice; Data:Pointer):LongWord;

Keyboard notification callback

TKeyboardNotification = function(Device:PDevice;Data:Pointer;Notification:LongWord):LongWord;

Keyboard device get

TKeyboardDeviceGet = function(Keyboard:PKeyboardDevice; var KeyCode:Word):LongWord;

Keyboard device read

TKeyboardDeviceRead = function(Keyboard:PKeyboardDevice; Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;

Keyboard device control

TKeyboardDeviceControl = function(Keyboard:PKeyboardDevice; Request:Integer; Argument1:PtrUInt; var Argument2:PtrUInt):LongWord;

Keyboard device

[Expand]

PKeyboardDevice = ^TKeyboardDevice;

TKeyboardDevice = record

USB HID descriptor

[Expand]

PUSBHIDDescriptor = ^TUSBHIDDescriptor;

TUSBHIDDescriptor = packed record

USB keyboard report

[Expand]

PUSBKeyboardReport = ^TUSBKeyboardReport;

TUSBKeyboardReport = array[0..7] of Byte;

USB keyboard device

[Expand]

PUSBKeyboardDevice = ^TUSBKeyboardDevice;

TUSBKeyboardDevice = record


Public variables



Keyboard logging

KEYBOARD_DEFAULT_LOG_LEVEL:LongWord = KEYBOARD_LOG_LEVEL_DEBUG; Minimum level for Keyboard messages. Only messages with level greater than or equal to this will be printed.
KEYBOARD_LOG_ENABLED:Boolean;


Function declarations



Initialization functions

[Expand]
procedure KeyboardInit;
Description: Initialize the keyboard unit and device table


Keyboard functions

[Expand]
function KeyboardGet(var KeyCode:Word):LongWord;
Description: Get the first key code from the global keyboard buffer


[Expand]
function KeyboardPeek:LongWord;
Description: Peek at the global keyboard buffer to see if any data packets are ready


[Expand]
function KeyboardRead(Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord; inline;
Description: Read keyboard data packets from the global keyboard buffer


[Expand]
function KeyboardReadEx(Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;
Description: Read keyboard data packets from the global keyboard buffer


[Expand]
function KeyboardPut(ScanCode,KeyCode:Word; Modifiers:LongWord):LongWord;
Description: Put a scan code and key code in the global keyboard buffer


[Expand]
function KeyboardWrite(Buffer:Pointer; Size,Count:LongWord):LongWord;
Description: Write keyboard data packets to the global keyboard buffer


[Expand]
function KeyboardFlush:LongWord;
Description: Flush the contents of the global keyboard buffer


[Expand]
function KeyboardDeviceGet(Keyboard:PKeyboardDevice; var KeyCode:Word):LongWord;
Description: Get the first key code from the buffer of the specified keyboard


[Expand]
function KeyboardDeviceRead(Keyboard:PKeyboardDevice; Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Read keyboard data packets from the buffer of the specified keyboard


[Expand]
function KeyboardDeviceControl(Keyboard:PKeyboardDevice; Request:Integer; Argument1:PtrUInt; var Argument2:PtrUInt):LongWord;
Description: Perform a control request on the specified keyboard device


[Expand]
function KeyboardDeviceSetState(Keyboard:PKeyboardDevice; State:LongWord):LongWord;
Description: Set the state of the specified keyboard and send a notification


[Expand]
function KeyboardDeviceCreate:PKeyboardDevice;
Description: Create a new Keyboard device entry


[Expand]
function KeyboardDeviceCreateEx(Size:LongWord):PKeyboardDevice;
Description: Create a new Keyboard device entry


[Expand]
function KeyboardDeviceDestroy(Keyboard:PKeyboardDevice):LongWord;
Description: Destroy an existing Keyboard device entry


[Expand]
function KeyboardDeviceRegister(Keyboard:PKeyboardDevice):LongWord;
Description: Register a new Keyboard device in the Keyboard table


[Expand]
function KeyboardDeviceDeregister(Keyboard:PKeyboardDevice):LongWord;
Description: Deregister a Keyboard device from the Keyboard table


[Expand]
function KeyboardDeviceFind(KeyboardId:LongWord):PKeyboardDevice;
Description: Find a keyboard device by ID in the keyboard table


[Expand]
function KeyboardDeviceFindByName(const Name:String):PKeyboardDevice; inline;
Description: Find a keyboard device by name in the keyboard table


[Expand]
function KeyboardDeviceFindByDescription(const Description:String):PKeyboardDevice; inline;
Description: Find a keyboard device by description in the keyboard table


[Expand]
function KeyboardDeviceEnumerate(Callback:TKeyboardEnumerate; Data:Pointer):LongWord;
Description: Enumerate all keyboard devices in the keyboard table


[Expand]
function KeyboardDeviceNotification(Keyboard:PKeyboardDevice; Callback:TKeyboardNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: Register a notification for keyboard device changes


RTL console functions

[Expand]
function SysConsoleGetKey(var ACh:Char; AUserData:Pointer):Boolean;
Description: Handler for Platform ConsoleGetKey function


[Expand]
function SysConsolePeekKey(var ACh:Char; AUserData:Pointer):Boolean;
Description: Handler for Platform ConsolePeekKey function


[Expand]
function SysConsoleReadChar(var ACh:Char; AUserData:Pointer):Boolean;
Description: Handler for Platform ConsoleReadChar function


[Expand]
function SysConsoleReadWideChar(var ACh:WideChar; AUserData:Pointer):Boolean;
Description: Handler for Platform ConsoleReadWideChar function


Keyboard helper functions

[Expand]
function KeyboardGetCount:LongWord;
Description: Get the current keyboard count


[Expand]
function KeyboardDeviceCheck(Keyboard:PKeyboardDevice):PKeyboardDevice;
Description: Check if the supplied Keyboard is in the keyboard table


[Expand]
function KeyboardDeviceTypeToString(KeyboardType:LongWord):String;
Description: To be documented


[Expand]
function KeyboardDeviceStateToString(KeyboardState:LongWord):String;
Description: To be documented


[Expand]
function KeyboardDeviceStateToNotification(State:LongWord):LongWord;
Description: Convert a Keyboard state value into the notification code for device notifications


[Expand]
function KeyboardRemapCtrlCode(KeyCode,CharCode:Word):Word;
Description: Remap Ctrl-<Key> combinations to ASCII control codes


[Expand]
function KeyboardRemapKeyCode(ScanCode,KeyCode:Word; var CharCode:Byte; Modifiers:LongWord):Boolean;
Description: Remap the SCAN_CODE_* and KEY_CODE_* values to DOS compatible scan codes


[Expand]
function KeyboardRemapScanCode(ScanCode,KeyCode:Word; var CharCode:Byte; Modifiers:LongWord):Boolean;
Description: Remap the SCAN_CODE_* and KEY_CODE_* values to DOS compatible scan codes


[Expand]
function KeyboardInsertData(Keyboard:PKeyboardDevice; Data:PKeyboardData; Signal:Boolean):LongWord;
Description: Insert a TKeyboardData entry into the keyboard buffer (Direct or Global)


[Expand]
procedure KeyboardLog(Level:LongWord; Keyboard:PKeyboardDevice; const AText:String);
Description: To be documented


[Expand]
procedure KeyboardLogInfo(Keyboard:PKeyboardDevice; const AText:String); inline;
Description: To be documented


[Expand]
procedure KeyboardLogWarn(Keyboard:PKeyboardDevice; const AText:String); inline;
Description: To be documented


[Expand]
procedure KeyboardLogError(Keyboard:PKeyboardDevice; const AText:String); inline;
Description: To be documented


[Expand]
procedure KeyboardLogDebug(Keyboard:PKeyboardDevice; const AText:String); inline;
Description: To be documented


Return to Unit Reference