Unit Keyboard

Return to Unit Reference

Description

---

Ultibo Keyboard interface unit

Keyboard Devices

This unit provides both the Keyboard device interface and the generic USB HID keyboard driver. The keyboard unit also provides the STDIN interface for the Run Time Library (RTL).

USB Keyboard Devices

This driver currently uses HID Boot Protocol only and could be redesigned in future to use the HID Report Protocol instead to allow for greater language support etc.

Constants

---

[Expand]

Keyboard specific constants KEYBOARD_NAME_*

KEYBOARD_NAME_PREFIX = 'Keyboard';

Name prefix for Keyboard Devices

[Expand]

Keyboard device type KEYBOARD_TYPE_*

KEYBOARD_TYPE_NONE = 0;
KEYBOARD_TYPE_USB = 1;
KEYBOARD_TYPE_PS2 = 2;
KEYBOARD_TYPE_SERIAL = 3;
KEYBOARD_TYPE_MAX = 3;

[Expand]

Keyboard device state KEYBOARD_STATE_*

KEYBOARD_STATE_DETACHED = 0;
KEYBOARD_STATE_DETACHING = 1;
KEYBOARD_STATE_ATTACHING = 2;
KEYBOARD_STATE_ATTACHED = 3;
KEYBOARD_STATE_MAX = 3;

[Expand]

Keyboard device flag KEYBOARD_FLAG_*

KEYBOARD_FLAG_NONE = $00000000;
KEYBOARD_FLAG_NON_BLOCK = $00000001;
KEYBOARD_FLAG_DIRECT_READ = $00000002;
KEYBOARD_FLAG_PEEK_BUFFER = $00000004;
KEYBOARD_FLAG_MASK = KEYBOARD_FLAG_NON_BLOCK or KEYBOARD_FLAG_DIRECT_READ or KEYBOARD_FLAG_PEEK_BUFFER;

[Expand]

Keyboard device control code KEYBOARD_CONTROL_*

KEYBOARD_CONTROL_GET_FLAG = 1;	Get Flag
KEYBOARD_CONTROL_SET_FLAG = 2;	Set Flag
KEYBOARD_CONTROL_CLEAR_FLAG = 3;	Clear Flag
KEYBOARD_CONTROL_FLUSH_BUFFER = 4;	Flush Buffer
KEYBOARD_CONTROL_GET_LED = 5;	Get LED
KEYBOARD_CONTROL_SET_LED = 6;	Set LED
KEYBOARD_CONTROL_CLEAR_LED = 7;	Clear LED
KEYBOARD_CONTROL_GET_REPEAT_RATE = 8;	Get Repeat Rate
KEYBOARD_CONTROL_SET_REPEAT_RATE = 9;	Set Repeat Rate
KEYBOARD_CONTROL_GET_REPEAT_DELAY = 10;	Get Repeat Delay
KEYBOARD_CONTROL_SET_REPEAT_DELAY = 11;	Set Repeat Delay

[Expand]

Keyboard device LED KEYBOARD_LED_*

KEYBOARD_LED_NONE = $00000000;
KEYBOARD_LED_NUMLOCK = $00000001;
KEYBOARD_LED_CAPSLOCK = $00000002;
KEYBOARD_LED_SCROLLLOCK = $00000004;
KEYBOARD_LED_COMPOSE = $00000008;
KEYBOARD_LED_KANA = $00000010;
KEYBOARD_LED_MASK = KEYBOARD_LED_NUMLOCK or KEYBOARD_LED_CAPSLOCK or KEYBOARD_LED_SCROLLLOCK or KEYBOARD_LED_COMPOSE or KEYBOARD_LED_KANA;

[Expand]

Keyboard buffer size KEYBOARD_BUFFER_*

KEYBOARD_BUFFER_SIZE = 512;

[Expand]

Keyboard sampling rate KEYBOARD_REPEAT_*

KEYBOARD_REPEAT_RATE = 40;	40msec -> 25cps
KEYBOARD_REPEAT_DELAY = 10;	10 x KEYBOARD_REPEAT_RATE = 400msec initial delay before repeat

[Expand]

Keyboard data definition KEYBOARD_*

Values for TKeyboardData.Modifiers
KEYBOARD_LEFT_CTRL = $00000001;	The Left Control key is pressed
KEYBOARD_LEFT_SHIFT = $00000002;	The Left Shift key is pressed
KEYBOARD_LEFT_ALT = $00000004;	The Left Alt key is pressed
KEYBOARD_LEFT_GUI = $00000008;	The Left GUI (or Windows) key is pressed
KEYBOARD_RIGHT_CTRL = $00000010;	The Right Control key is pressed
KEYBOARD_RIGHT_SHIFT = $00000020;	The Right Shift key is pressed
KEYBOARD_RIGHT_ALT = $00000040;	The Right Alt key is pressed
KEYBOARD_RIGHT_GUI = $00000080;	The Right GUI (or Windows) key is pressed
KEYBOARD_NUM_LOCK = $00000100;	Num Lock is currently on
KEYBOARD_CAPS_LOCK = $00000200;	Caps Lock is currently on
KEYBOARD_SCROLL_LOCK = $00000400;	Scroll Lock is currently on
KEYBOARD_COMPOSE = $00000800;	Compose is currently on
KEYBOARD_KANA = $00001000;	Kana is currently on
KEYBOARD_KEYUP = $00002000;	The key state changed to up
KEYBOARD_KEYDOWN = $00004000;	The key state changed to down
KEYBOARD_KEYREPEAT = $00008000;	The key is being repeated
KEYBOARD_DEADKEY = $00010000;	The key is a being handled as a deadkey}
KEYBOARD_ALTGR = $00020000;	The AltGr key is pressed (Normally also Right Alt but may be Ctrl-Alt)

[Expand]

Keyboard logging KEYBOARD_LOG_*

KEYBOARD_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG;	Keyboard debugging messages
KEYBOARD_LOG_LEVEL_INFO = LOG_LEVEL_INFO;	Keyboard informational messages, such as a device being attached or detached
KEYBOARD_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;	Keyboard error messages
KEYBOARD_LOG_LEVEL_NONE = LOG_LEVEL_NONE;	No Keyboard messages

[Expand]

USB keyboard specific constants USBKEYBOARD_*

USBKEYBOARD_DRIVER_NAME = 'USB Keyboard Driver (HID boot protocol)';	Name of USB keyboard driver
USBKEYBOARD_KEYBOARD_DESCRIPTION = 'USB HID Keyboard';	Description of USB keyboard device

[Expand]

USB HID interface subclass USB_HID_SUBCLASS_*

See USB HID v1.11 specification
USB_HID_SUBCLASS_NONE = 0;	Section 4.2
USB_HID_SUBCLASS_BOOT = 1;	Section 4.2

[Expand]

USB HID interface protocol USB_HID_BOOT_PROTOCOL_*

See USB HID v1.11 specification
USB_HID_BOOT_PROTOCOL_NONE = 0;	Section 4.3
USB_HID_BOOT_PROTOCOL_KEYBOARD = 1;	Section 4.3
USB_HID_BOOT_PROTOCOL_MOUSE = 2;	Section 4.3

[Expand]

USB HID class descriptor USB_HID_DESCRIPTOR_*

See USB HID v1.11 specification
USB_HID_DESCRIPTOR_TYPE_HID = $21;	Section 7.1
USB_HID_DESCRIPTOR_TYPE_REPORT = $22;	Section 7.1
USB_HID_DESCRIPTOR_TYPE_PHYSICAL_DESCRIPTOR = $23;	Section 7.1

[Expand]

USB HID request USB_HID_REQUEST_*

See USB HID v1.11 specification
USB_HID_REQUEST_GET_REPORT = $01;	Section 7.2
USB_HID_REQUEST_GET_IDLE = $02;	Section 7.2
USB_HID_REQUEST_GET_PROTOCOL = $03;	Section 7.2
USB_HID_REQUEST_SET_REPORT = $09;	Section 7.2
USB_HID_REQUEST_SET_IDLE = $0A;	Section 7.2
USB_HID_REQUEST_SET_PROTOCOL = $0B;	Section 7.2

[Expand]

USB HID protocol USB_HID_PROTOCOL_*

See USB HID v1.11 specification
USB_HID_PROTOCOL_BOOT = 0;	Section 7.2.5
USB_HID_PROTOCOL_REPORT = 1;	Section 7.2.5

[Expand]

USB HID report USB_HID_REPORT_*

See USB HID v1.11 specification
USB_HID_REPORT_INPUT = 1;	Section 7.2.1
USB_HID_REPORT_OUTPUT = 2;	Section 7.2.1
USB_HID_REPORT_FEATURE = 3;	Section 7.2.1

[Expand]

USB HID report Ids USB_HID_REPORTID_*

See USB HID v1.11 specification
USB_HID_REPORTID_NONE = 0;	Section 7.2.1

[Expand]

USB HID boot protocol USB_HID_BOOT_LEFT_*, USB_HID_BOOT_RIGHT_*

USB_HID_BOOT_LEFT_CTRL = (1 shl 0);
USB_HID_BOOT_LEFT_SHIFT = (1 shl 1);
USB_HID_BOOT_LEFT_ALT = (1 shl 2);
USB_HID_BOOT_LEFT_GUI = (1 shl 3);
USB_HID_BOOT_RIGHT_CTRL = (1 shl 4);
USB_HID_BOOT_RIGHT_SHIFT = (1 shl 5);
USB_HID_BOOT_RIGHT_ALT = (1 shl 6);
USB_HID_BOOT_RIGHT_GUI = (1 shl 7);

[Expand]

USB HID boot protocol report data USB_HID_BOOT_REPORT_*

USB_HID_BOOT_REPORT_SIZE = 8;

Appendix B of HID Device Class Definition 1.11

[Expand]

USB HID boot protocol output USB_HID_BOOT_*_LED

USB_HID_BOOT_NUMLOCK_LED = (1 shl 0);
USB_HID_BOOT_CAPSLOCK_LED = (1 shl 1);
USB_HID_BOOT_SCROLLLOCK_LED = (1 shl 2);
USB_HID_BOOT_COMPOSE_LED = (1 shl 3);
USB_HID_BOOT_KANA_LED = (1 shl 4);
USB_HID_BOOT_LEDMASK = USB_HID_BOOT_NUMLOCK_LED or USB_HID_BOOT_CAPSLOCK_LED or USB_HID_BOOT_SCROLLLOCK_LED or USB_HID_BOOT_COMPOSE_LED or USB_HID_BOOT_KANA_LED;

[Expand]

USB HID boot protocol output data USB_HID_BOOT_OUTPUT_*

USB_HID_BOOT_OUTPUT_SIZE = 1;	Appendix B of HID Device Class Definition 1.11
USB_HID_BOOT_USAGE_NUMLOCK = SCAN_CODE_NUMLOCK;	83
USB_HID_BOOT_USAGE_CAPSLOCK = SCAN_CODE_CAPSLOCK;	57
USB_HID_BOOT_USAGE_SCROLLLOCK = SCAN_CODE_SCROLLLOCK;	71

Type definitions

---

Keyboard data

[Expand]

PKeyboardData = ^TKeyboardData;

TKeyboardData = record

Modifiers:LongWord;	Keyboard modifier flags for Shift, Alt, Control etc (eg KEYBOARD_LEFT_CTRL)
ScanCode:Word;	Untranslated scan code value from keyboard (See SCAN_CODE_* constants)
KeyCode:Word;	Translated key code value from keyboard (See KEY_CODE_* constants)
CharCode:Char;	ANSI character representing the translated key code
CharUnicode:WideChar;	Unicode character representing the translated key code

Keyboard buffer

[Expand]

PKeyboardBuffer = ^TKeyboardBuffer;

TKeyboardBuffer = record

Wait:TSemaphoreHandle;	Data ready semaphore
Start:LongWord;	Index of first buffer ready
Count:LongWord;	Number of messages ready in buffer
Buffer:array[0..(KEYBOARD_BUFFER_SIZE - 1)] of TKeyboardData;

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:LongWord; var Argument2:LongWord):LongWord;

Keyboard device

[Expand]

PKeyboardDevice = ^TKeyboardDevice;

TKeyboardDevice = record

Device Properties
Device:TDevice;	The Device entry for this Keyboard
Keyboard Properties
KeyboardId:LongWord;	Unique Id of this Keyboard in the Keyboard table
KeyboardState:LongWord;	Keyboard state (eg KEYBOARD_STATE_ATTACHED)
KeyboardLEDs:LongWord;	Keyboard LEDs (eg KEYBOARD_LED_NUMLOCK)
KeyboardRate:LongWord;	Keyboard repeat rate (Milliseconds)
KeyboardDelay:LongWord;	Keyboard repeat delay (Number of KeyboardRate intervals before first repeat)
DeviceGet:TKeyboardDeviceGet;	A Device specific DeviceGet method implementing a standard Keyboard device interface (Or nil if the default method is suitable)
DeviceRead:TKeyboardDeviceRead;	A Device specific DeviceRead method implementing a standard Keyboard device interface (Or nil if the default method is suitable)
DeviceControl:TKeyboardDeviceControl;	A Device specific DeviceControl method implementing a standard Keyboard device interface (Or nil if the default method is suitable)
Driver Properties
Lock:TMutexHandle;	Keyboard lock
Code:Word;	Scan code of current deadkey (If Applicable)
Index:Word;	Index state for current deadkey (If Applicable)
Modifiers:LongWord;	Modifier state for current deadkey (If Applicable)
Buffer:TKeyboardBuffer;	Keyboard input buffer
Statistics Properties
ReceiveCount:LongWord;
ReceiveErrors:LongWord;
BufferOverruns:LongWord;
Internal Properties
Prev:PKeyboardDevice;	Previous entry in Keyboard table
Next:PKeyboardDevice;	Next entry in Keyboard table

USB keyboard report

[Expand]

PUSBKeyboardReport = ^TUSBKeyboardReport;

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

USB keyboard device

[Expand]

PUSBKeyboardDevice = ^TUSBKeyboardDevice;

TUSBKeyboardDevice = record

Keyboard Properties
Keyboard:TKeyboardDevice;
USB Properties
HIDInterface:PUSBInterface;	USB HID Keyboard Interface
ReportRequest:PUSBRequest;	USB request for keyboard report data
ReportEndpoint:PUSBEndpointDescriptor;	USB Keyboard Interrupt IN Endpoint
LastCode:Word;	The scan code of the last key pressed
LastCount:LongWord;	The repeat count of the last key pressed
LastReport:TUSBKeyboardReport;	The last keyboard report received
PendingCount:LongWord;	Number of USB requests pending for this keyboard
WaiterThread:TThreadId;	Thread waiting for pending requests to complete (for keyboard detachment)

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, device table and USB keyboard driver

Note	Called only during system startup

Keyboard functions

[Expand]

function KeyboardGet(var KeyCode:Word):LongWord;

Description: Get the first key code from the global keyboard buffer

KeyCode	The returned key code read from the buffer (eg KEY_CODE_A)
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Key code is the value translated from the scan code using the current keymap it may not be a character code and it may include non printable characters. To translate a key code to a character call KeymapGetCharCode()

[Expand]

function KeyboardPeek:LongWord;

Description: Peek at the global keyboard buffer to see if any data packets are ready

Return	ERROR_SUCCESS if packets are ready, ERROR_NO_MORE_ITEMS if not or another error code on failure

[Expand]

function KeyboardRead(Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord; inline;

Description: Read keyboard data packets from the global keyboard buffer

Buffer	Pointer to a buffer to copy the keyboard data packets to
Size	The size of the buffer in bytes (Must be at least TKeyboardData or greater)
Count	The number of keyboard data packets copied to the buffer
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function KeyboardReadEx(Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;

Description: Read keyboard data packets from the global keyboard buffer

Buffer	Pointer to a buffer to copy the keyboard data packets to
Size	TThe size of the buffer in bytes (Must be at least TKeyboardData or greater)
Flags	The flags to use for the read (eg KEYBOARD_FLAG_NON_BLOCK)
Count	The number of keyboard data packets copied to the buffer
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function KeyboardPut(ScanCode,KeyCode:Word; Modifiers:LongWord):LongWord;

Description: Put a scan code and key code in the global keyboard buffer

ScanCode	The scan code to write to the buffer (eg SCAN_CODE_A)
KeyCode	The key code to write to the buffer (eg KEY_CODE_A)
Modifiers	The modifier keys to write to the buffer (eg KEYBOARD_LEFT_CTRL)
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function KeyboardWrite(Buffer:Pointer; Size,Count:LongWord):LongWord;

Description: Write keyboard data packets to the global keyboard buffer

Buffer	Pointer to a buffer to copy the keyboard data packets from
Size	The size of the buffer in bytes (Must be at least TKeyboardData or greater)
Count	The number of keyboard data packets to copy from the buffer
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function KeyboardFlush:LongWord;

Description: Flush the contents of the global keyboard buffer

Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function KeyboardDeviceGet(Keyboard:PKeyboardDevice; var KeyCode:Word):LongWord;

Description: Get the first key code from the buffer of the specified keyboard

Keyboard	The keyboard device to get from
Keycode	The returned key code read from the buffer (eg KEY_CODE_A)
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Key code is the value translated from the scan code using the current keymap it may not be a character code and it may include non printable characters. To translate a key code to a character call KeymapGetCharCode()

[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

Keyboard	The keyboard device to read from
Buffer	Pointer to a buffer to copy the keyboard data packets to
Size	The size of the buffer in bytes (Must be at least TKeyboardData or greater)
Count	The number of keyboard data packets copied to the buffer
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function KeyboardDeviceControl(Keyboard:PKeyboardDevice; Request:Integer; Argument1:LongWord; var Argument2:LongWord):LongWord;

Description: Perform a control request on the specified keyboard device

Keyboard	The keyboard device to control
Request	The request code for the operation (eg KEYBOARD_CONTROL_GET_FLAG)
Argument1	The first argument for the operation (Dependent on request code)
Argument2	The second argument for the operation (Dependent on request code)
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function KeyboardDeviceSetState(Keyboard:PKeyboardDevice; State:LongWord):LongWord;

Description: Set the state of the specified keyboard and send a notification

Keyboard	The keyboard to set the state for
State	The new state to set and notify
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function KeyboardDeviceCreate:PKeyboardDevice;

Description: Create a new Keyboard device entry

Return	Pointer to new Keyboard device entry or nil if keyboard could not be created

[Expand]

function KeyboardDeviceCreateEx(Size:LongWord):PKeyboardDevice;

Description: Create a new Keyboard device entry

Size	Size in bytes to allocate for new keyboard (Including the keyboard device entry)
Return	Pointer to new Keyboard device entry or nil if keyboard could not be created

[Expand]

function KeyboardDeviceDestroy(Keyboard:PKeyboardDevice):LongWord;

Description: Destroy an existing Keyboard device entry

Keyboard	The keyboard device to destroy
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function KeyboardDeviceRegister(Keyboard:PKeyboardDevice):LongWord;

Description: Register a new Keyboard device in the Keyboard table

Keyboard	The keyboard device to register
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function KeyboardDeviceDeregister(Keyboard:PKeyboardDevice):LongWord;

Description: Deregister a Keyboard device from the Keyboard table

Keyboard	The keyboard device to deregister
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function KeyboardDeviceFind(KeyboardId:LongWord):PKeyboardDevice;

Description: Find a keyboard device by ID in the keyboard table

KeyboardId	The ID number of the keyboard to find
Return	Pointer to keyboard device entry or nil if not found

[Expand]

function KeyboardDeviceFindByName(const Name:String):PKeyboardDevice; inline;

Description: Find a keyboard device by name in the keyboard table

Name	The name of the keyboard to find (eg Keyboard0)
Return	Pointer to keyboard device entry or nil if not found

[Expand]

function KeyboardDeviceFindByDescription(const Description:String):PKeyboardDevice; inline;

Description: Find a keyboard device by description in the keyboard table

Description	The description of the keyboard to find (eg USB HID Keyboard)
Return	Pointer to keyboard device entry or nil if not found

[Expand]

function KeyboardDeviceEnumerate(Callback:TKeyboardEnumerate; Data:Pointer):LongWord;

Description: Enumerate all keyboard devices in the keyboard table

Callback	The callback function to call for each keyboard in the table
Data	A private data pointer to pass to callback for each keyboard in the table
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function KeyboardDeviceNotification(Keyboard:PKeyboardDevice; Callback:TKeyboardNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;

Description: Register a notification for keyboard device changes

Keyboard	The keyboard device to notify changes for (Optional, pass nil for all keyboards)
Callback	The function to call when a notification event occurs
Data	A private data pointer to pass to callback when a notification event occurs
Notification	The events to register for notification of (eg DEVICE_NOTIFICATION_REGISTER)
Flags	The flags to control the notification (eg NOTIFIER_FLAG_WORKER)

RTL console functions

[Expand]

function SysConsoleGetKey(var ACh:Char; AUserData:Pointer):Boolean;

Description: Handler for Platform ConsoleGetKey function

Note	None documented

[Expand]

function SysConsolePeekKey(var ACh:Char; AUserData:Pointer):Boolean;

Description: Handler for Platform ConsolePeekKey function

Note	None documented

[Expand]

function SysConsoleReadChar(var ACh:Char; AUserData:Pointer):Boolean;

Description: Handler for Platform ConsoleReadChar function

Note	None documented

[Expand]

function SysConsoleReadWideChar(var ACh:WideChar; AUserData:Pointer):Boolean;

Description: Handler for Platform ConsoleReadWideChar function

Note	None documented

USB keyboard functions

[Expand]

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

Description: Implementation of KeyboardDeviceRead API for USB Keyboard

Note	Not intended to be called directly by applications, use KeyboardDeviceRead instead

[Expand]

function USBKeyboardDeviceControl(Keyboard:PKeyboardDevice; Request:Integer; Argument1:LongWord; var Argument2:LongWord):LongWord;

Description: Implementation of KeyboardDeviceControl API for USB Keyboard

Note	Not intended to be called directly by applications, use KeyboardDeviceControl instead

[Expand]

function USBKeyboardDriverBind(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;

Description: Bind the Keyboard driver to a USB device if it is suitable

Device	The USB device to attempt to bind to
Interface	The USB interface to attempt to bind to (or nil for whole device)
Return	USB_STATUS_SUCCESS if completed, USB_STATUS_DEVICE_UNSUPPORTED if unsupported or another error code on failure

[Expand]

function USBKeyboardDriverUnbind(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;

Description: Unbind the Keyboard driver from a USB device

Device	The USB device to unbind from
Interface	The USB interface to unbind from (or nil for whole device)
Return	USB_STATUS_SUCCESS if completed or another error code on failure

[Expand]

procedure USBKeyboardReportWorker(Request:PUSBRequest);

Description: Called (by a Worker thread) to process a completed USB request from a USB keyboard IN interrupt endpoint

Request	The USB request which has completed

[Expand]

procedure USBKeyboardReportComplete(Request:PUSBRequest);

Description: Called when a USB request from a USB keyboard IN interrupt endpoint completes

Request	The USB request which has completed
Note	Request is passed to worker thread for processing to prevent blocking the USB completion

Keyboard helper functions

[Expand]

function KeyboardGetCount:LongWord; inline;

Description: Get the current keyboard count

Note	None documented

[Expand]

function KeyboardDeviceCheck(Keyboard:PKeyboardDevice):PKeyboardDevice;

Description: Check if the supplied Keyboard is in the keyboard table

Note	None documented

[Expand]

function KeyboardDeviceTypeToString(KeyboardType:LongWord):String;

Description: To be documented

Note	None documented

[Expand]

function KeyboardDeviceStateToString(KeyboardState:LongWord):String;

Description: To be documented

Note	None documented

[Expand]

function KeyboardDeviceStateToNotification(State:LongWord):LongWord;

Description: Convert a Keyboard state value into the notification code for device notifications

Note	None documented

[Expand]

function KeyboardRemapCtrlCode(KeyCode,CharCode:Word):Word;

Description: Remap Ctrl-<Key> combinations to ASCII control codes

Note	Caller must check for Left-Ctrl or Right-Ctrl modifiers

[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

Return	Returns True if the key was remapped, False if it was not
See	http://www.freepascal.org/docs-html/rtl/keyboard/kbdscancode.html See also: \source\packages\rtl-console\src\inc\keyscan.inc
Note	See below for a version that uses SCAN_CODE_* values instead of translated KEY_CODE_* values

[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

Return	Returns True if the key was remapped, False if it was not
See	http://www.freepascal.org/docs-html/rtl/keyboard/kbdscancode.html See also: \source\packages\rtl-console\src\inc\keyscan.inc
Note	Same as above except using SCAN_CODE_* values instead of translated KEY_CODE_* values

[Expand]

function KeyboardInsertData(Keyboard:PKeyboardDevice; Data:PKeyboardData; Signal:Boolean):LongWord;

Description: Insert a TKeyboardData entry into the keyboard buffer (Direct or Global)

Keyboard	The keyboard device to insert data for
Data	The TKeyboardData entry to insert
Signal	If True then signal that new data is availale in the buffer
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Caller must hold the keyboard lock

[Expand]

procedure KeyboardLog(Level:LongWord; Keyboard:PKeyboardDevice; const AText:String);

Description: To be documented

Note	None documented

[Expand]

procedure KeyboardLogInfo(Keyboard:PKeyboardDevice; const AText:String);

Description: To be documented

Note	None documented

[Expand]

procedure KeyboardLogError(Keyboard:PKeyboardDevice; const AText:String);

Description: To be documented

Note	None documented

[Expand]

procedure KeyboardLogDebug(Keyboard:PKeyboardDevice; const AText:String);

Description: To be documented

Note	None documented

USB keyboard helper functions

[Expand]

function USBKeyboardInsertData(Keyboard:PUSBKeyboardDevice; Data:PKeyboardData):LongWord;

Description: Insert a TKeyboardData entry into the keyboard buffer (Direct or Global)

Keyboard	The USB keyboard device to insert data for
Data	The TKeyboardData entry to insert
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Caller must hold the keyboard lock

[Expand]

function USBKeyboardCheckPressed(Keyboard:PUSBKeyboardDevice; ScanCode:Byte):Boolean;

Description: Check if the passed scan code has been pressed (True if not pressed in last report)

Keyboard	The USB keyboard device to check for
ScanCode	The keyboard scan code to check
Note	Caller must hold the keyboard lock

[Expand]

function USBKeyboardCheckRepeated(Keyboard:PUSBKeyboardDevice; ScanCode:Byte):Boolean;

Description: Check if the passed scan code was the last key pressed and if the repeat delay has expired

Keyboard	The USB keyboard device to check for
ScanCode	The keyboard scan code to check
Note	Caller must hold the keyboard lock

[Expand]

function USBKeyboardCheckReleased(Keyboard:PUSBKeyboardDevice; Report:PUSBKeyboardReport; ScanCode:Byte):Boolean;

Description: Check if the passed scan code has been released (True if not pressed in current report)

Keyboard	The USB keyboard device to check for
Report	The USB keyboard report to compare against (Current)
ScanCode	The keyboard scan code to check
Note	Caller must hold the keyboard lock

[Expand]

function USBKeyboardDeviceSetLEDs(Keyboard:PUSBKeyboardDevice; LEDs:Byte):LongWord;

Description: Set the state of the LEDs for a USB keyboard device

Keyboard	The USB keyboard device to set the LEDs for
LEDs	The LED state to set (eg KEYBOARD_LED_NUMLOCK)
Return	USB_STATUS_SUCCESS if completed or another USB error code on failure

[Expand]

function USBKeyboardDeviceSetIdle(Keyboard:PUSBKeyboardDevice; Duration,ReportId:Byte):LongWord;

Description: Set the idle duration (Time between reports when no changes) for a USB keyboard device

Keyboard	The USB keyboard device to set the idle duration for
Duration	The idle duration to set (Milliseconds divided by 4)
ReportId	The report Id to set the idle duration for (eg USB_HID_REPORTID_NONE)
Return	USB_STATUS_SUCCESS if completed or another USB error code on failure

[Expand]

function USBKeyboardDeviceSetProtocol(Keyboard:PUSBKeyboardDevice; Protocol:Byte):LongWord;

Description: Set the report protocol for a USB keyboard device

Keyboard	The USB keyboard device to set the report protocol for
Protocol	The report protocol to set (eg USB_HID_PROTOCOL_BOOT)
Return	USB_STATUS_SUCCESS if completed or another USB error code on failure

Return to Unit Reference