Difference between revisions of "Unit Keyboard"

Latest revision as of 04:48, 10 October 2023

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

Keyboard specific constants KEYBOARD_NAME_*

`KEYBOARD_NAME_PREFIX = 'Keyboard';`	Name prefix for Keyboard Devices

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;`

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;`

Keyboard device flag KEYBOARD_FLAG_*

`KEYBOARD_FLAG_NON_BLOCK = $00000001;`	If set device reads are non blocking (Also supported in Flags parameter of KeyboardReadEx)
`KEYBOARD_FLAG_DIRECT_READ = $00000002;`	If set device writes keyboard data to its local buffer which must be read using KeyboardDeviceRead
`KEYBOARD_FLAG_PEEK_BUFFER = $00000004;`	Peek at the buffer to see if any data is available, don't remove it (Used only in Flags parameter of KeyboardReadEx)
`KEYBOARD_FLAG_PEEK_BUFFER = $00000004;`

`KEYBOARD_FLAG_MASK = KEYBOARD_FLAG_NON_BLOCK or KEYBOARD_FLAG_DIRECT_READ or KEYBOARD_FLAG_PEEK_BUFFER;`

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

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;`

Keyboard buffer size KEYBOARD_BUFFER_*

`KEYBOARD_BUFFER_SIZE = 512;`

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

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)

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_WARN = LOG_LEVEL_WARN;`	Keyboard warning messages
`KEYBOARD_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;`	Keyboard error messages
`KEYBOARD_LOG_LEVEL_NONE = LOG_LEVEL_NONE;`	No Keyboard messages

USB keyboard specific constants USBKEYBOARD_*

Note: The following constants are duplicated with the USBKeyboard unit for backwards compatibility

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

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

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

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

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

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

USB HID report Ids USB_HID_REPORTID_*

See USB HID v1.11 specification

`USB_HID_REPORTID_NONE = 0;`	Section 7.2.1

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);`

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

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;`

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

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

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

Keyboard device

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 HID descriptor

PUSBHIDDescriptor = ^TUSBHIDDescriptor;

TUSBHIDDescriptor = packed record

`bLength:Byte;`
`bDescriptorType:Byte;`
`bcdHID:Word;`
`bCountryCode:Byte;`
`bNumDescriptors:Byte;`
`bHIDDescriptorType:Byte;`
`wHIDDescriptorLength:Word;`
Note: Up to two optional bHIDDescriptorType/wHIDDescriptorLength pairs after the Report descriptor details

USB keyboard report

PUSBKeyboardReport = ^TUSBKeyboardReport;

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

USB keyboard device

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
`HIDDescriptor:PUSBHIDDescriptor;`	USB HID Descriptor for keyboard
`ReportDescriptor:Pointer;`	USB HID Report Descriptor for keyboard
`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

procedure KeyboardInit;

Description: Initialize the keyboard unit and device table

Note	Called only during system startup

Keyboard functions

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()

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.

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

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

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

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

function KeyboardFlush:LongWord;

Description: Flush the contents of the global keyboard buffer

Return	ERROR_SUCCESS if completed or another error code on failure

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()

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

function KeyboardDeviceControl(Keyboard:PKeyboardDevice; Request:Integer; Argument1:PtrUInt; var Argument2:PtrUInt):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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Handler for Platform ConsoleGetKey function

Note	None documented

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

Description: Handler for Platform ConsolePeekKey function

Note	None documented

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

Description: Handler for Platform ConsoleReadChar function

Note	None documented

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

Description: Handler for Platform ConsoleReadWideChar function

Note	None documented

Keyboard helper functions

function KeyboardGetCount:LongWord;

Description: Get the current keyboard count

Note	None documented

function KeyboardDeviceCheck(Keyboard:PKeyboardDevice):PKeyboardDevice;

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

Note	None documented

function KeyboardDeviceTypeToString(KeyboardType:LongWord):String;

Description: To be documented

Note	None documented

function KeyboardDeviceStateToString(KeyboardState:LongWord):String;

Description: To be documented

Note	None documented

function KeyboardDeviceStateToNotification(State:LongWord):LongWord;

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

Note	None documented

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

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

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

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 available in the buffer
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Caller must hold the keyboard lock

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

Description: To be documented

Note	None documented

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

Description: To be documented

Note	None documented

procedure KeyboardLogWarn(Keyboard:PKeyboardDevice; const AText:String); inline;

Description: To be documented

Note	None documented

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

Description: To be documented

Note	None documented

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

Description: To be documented

Note	None documented

Return to Unit Reference

Difference between revisions of "Unit Keyboard"

Latest revision as of 04:48, 10 October 2023

Contents

Description

Constants

Type definitions

Public variables

Function declarations

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools

@@ Line 5: / Line 5: @@
 ----
-'''Ultibo Keyboard interface unit'''
+'''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).
+This unit provides the Keyboard device interface and keyboard API to be used by both drivers and applications.
-'''USB Keyboard Devices'''
+The API includes functions to create, register, locate, read, write, control and configure each connected keyboard device.
-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.
+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 ===
@@ Line 84: / Line 84: @@
 <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 {| class="wikitable" style="font-size: 14px; background: white;"
-|-
-| <code>KEYBOARD_FLAG_NONE = $00000000;</code>
-| style="width: 50%;"|&nbsp;
 |-
 | <code>KEYBOARD_FLAG_NON_BLOCK = $00000001;</code>
-| &nbsp;
+| If set device reads are non blocking (Also supported in Flags parameter of KeyboardReadEx)
 |-
 | <code>KEYBOARD_FLAG_DIRECT_READ = $00000002;</code>
-| &nbsp;
+| If set device writes keyboard data to its local buffer which must be read using KeyboardDeviceRead
+|-
+| <code>KEYBOARD_FLAG_PEEK_BUFFER = $00000004;</code>
+| Peek at the buffer to see if any data is available, don't remove it (Used only in Flags parameter of KeyboardReadEx)
 |-
 | <code>KEYBOARD_FLAG_PEEK_BUFFER = $00000004;</code>
@@ Line 294: / Line 294: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-| <code>USBKEYBOARD_DRIVER_NAME = 'USB Keyboard Driver (HID boot protocol)';</code>
+|colspan="2"|Note: The following constants are duplicated with the USBKeyboard unit for backwards compatibility
-| Name of USB keyboard driver
-|-
-| <code>USBKEYBOARD_KEYBOARD_DESCRIPTION = 'USB HID Keyboard';</code>
-| Description of USB keyboard device
 |-
 |}
@@ Line 636: / Line 632: @@
 {| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 |-
-| <code>TKeyboardDeviceControl = function(Keyboard:PKeyboardDevice; Request:Integer; Argument1:LongWord; var Argument2:LongWord):LongWord;</code>
+| <code>TKeyboardDeviceControl = function(Keyboard:PKeyboardDevice; Request:Integer; Argument1:PtrUInt; var Argument2:PtrUInt):LongWord;</code>
 | style="width: 40%;"|
 |-
@@ Line 848: / Line 844: @@
 <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 <pre style="border: 0; padding-bottom:0px;">procedure KeyboardInit;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Initialize the keyboard unit, device table and USB keyboard driver</div>
+<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Initialize the keyboard unit and device table</div>
 <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 {| class="wikitable" style="font-size: 14px; background: white;"
@@ Line 1,038: / Line 1,034: @@
 <br />
 <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function KeyboardDeviceControl(Keyboard:PKeyboardDevice; Request:Integer; Argument1:LongWord; var Argument2:LongWord):LongWord;</pre>
+<pre style="border: 0; padding-bottom:0px;">function KeyboardDeviceControl(Keyboard:PKeyboardDevice; Request:Integer; Argument1:PtrUInt; var Argument2:PtrUInt):LongWord;</pre>
 <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Perform a control request on the specified keyboard device</div>
 <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
@@ Line 1,285: / Line 1,281: @@
 ! Note
 | None documented
-|-
-|}
-</div></div>
-<br />
-'''USB keyboard functions'''
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function USBKeyboardDeviceRead(Keyboard:PKeyboardDevice; Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of KeyboardDeviceRead API for USB Keyboard</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! Note
-| Not intended to be called directly by applications, use KeyboardDeviceRead instead.
-|-
-|}
-</div></div>
-<br />
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function USBKeyboardDeviceControl(Keyboard:PKeyboardDevice; Request:Integer; Argument1:LongWord; var Argument2:LongWord):LongWord;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of KeyboardDeviceControl API for USB Keyboard</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! Note
-| Not intended to be called directly by applications, use KeyboardDeviceControl instead.
-|-
-|}
-</div></div>
-<br />
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function USBKeyboardDriverBind(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Bind the Keyboard driver to a USB device if it is suitable</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! Device
-| The USB device to attempt to bind to
-|-
-! Interrface
-| 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.
-|-
-|}
-</div></div>
-<br />
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function USBKeyboardDriverUnbind(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Unbind the Keyboard driver from a USB device</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! Device
-| The USB device to unbind from
-|-
-! Interrface
-| The USB interface to unbind from (or nil for whole device)
-|-
-! Return
-| USB_STATUS_SUCCESS if completed or another error code on failure
-|-
-|}
-</div></div>
-<br />
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">procedure USBKeyboardReportWorker(Request:PUSBRequest);</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Called (by a Worker thread) to process a completed USB request from a USB keyboard IN interrupt endpoint</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! Request
-| The USB request which has completed
-|-
-|}
-</div></div>
-<br />
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">procedure USBKeyboardReportComplete(Request:PUSBRequest);</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Called when a USB request from a USB keyboard IN interrupt endpoint completes</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! Request
-| The USB request which has completed
-|-
-! Note
-| Request is passed to worker thread for processing to prevent blocking the USB completion
 |-
 |}
@@ Line 1,383: / Line 1,289: @@
 <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function KeyboardGetCount:LongWord; inline;</pre>
+<pre style="border: 0; padding-bottom:0px;">function KeyboardGetCount:LongWord;</pre>
 <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current keyboard count</div>
 <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
@@ Line 1,505: / Line 1,411: @@
 |-
 ! Signal
-| If True then signal that new data is availale in the buffer
+| If True then signal that new data is available in the buffer
 |-
 ! Return
@@ Line 1,572: / Line 1,478: @@
 ! Note
 | None documented
-|-
-|}
-</div></div>
-<br />
-'''USB keyboard helper functions'''
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function USBKeyboardCheckDevice(Device:PUSBDevice):Boolean;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check if the supplied USB device is suitable for detection as a HID Keyboard Device</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! Device
-| The USB device to check
-|-
-! Return
-| True if the device is suitable or False if it is not
-|-
-|}
-</div></div>
-<br />
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function USBKeyboardInsertData(Keyboard:PUSBKeyboardDevice; Data:PKeyboardData):LongWord;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Insert a TKeyboardData entry into the keyboard buffer (Direct or Global)</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! 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
-|-
-|}
-</div></div>
-<br />
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function USBKeyboardCheckPressed(Keyboard:PUSBKeyboardDevice; ScanCode:Byte):Boolean;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check if the passed scan code has been pressed (True if not pressed in last report)</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! Keyboard
-| The USB keyboard device to check for
-|-
-! ScanCode
-| The keyboard scan code to check
-|-
-! Note
-| Caller must hold the keyboard lock
-|-
-|}
-</div></div>
-<br />
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function USBKeyboardCheckRepeated(Keyboard:PUSBKeyboardDevice; ScanCode:Byte):Boolean;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check if the passed scan code was the last key pressed and if the repeat delay has expired</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! Keyboard
-| The USB keyboard device to check for
-|-
-! ScanCode
-| The keyboard scan code to check
-|-
-! Note
-| Caller must hold the keyboard lock
-|-
-|}
-</div></div>
-<br />
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function USBKeyboardCheckReleased(Keyboard:PUSBKeyboardDevice; Report:PUSBKeyboardReport; ScanCode:Byte):Boolean;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check if the passed scan code has been released (True if not pressed in current report)</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! 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
-|-
-|}
-</div></div>
-<br />
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function USBKeyboardDeviceSetLEDs(Keyboard:PUSBKeyboardDevice; LEDs:Byte):LongWord;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the state of the LEDs for a USB keyboard device</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! 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
-|-
-|}
-</div></div>
-<br />
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function USBKeyboardDeviceSetIdle(Keyboard:PUSBKeyboardDevice; Duration,ReportId:Byte):LongWord;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the idle duration (Time between reports when no changes) for a USB keyboard device</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! 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
-|-
-|}
-</div></div>
-<br />
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function USBKeyboardDeviceSetProtocol(Keyboard:PUSBKeyboardDevice; Protocol:Byte):LongWord;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the report protocol for a USB keyboard device</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! 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
-|-
-|}
-</div></div>
-<br />
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function USBKeyboardDeviceGetHIDDescriptor(Keyboard:PUSBKeyboardDevice; Descriptor:PUSBHIDDescriptor):LongWord;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the HID Descriptor for a USB keyboard device</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! Keyboard
-| The USB keyboard device to get the descriptor for
-|-
-! Descriptor
-| Pointer to a USB HID Descriptor structure for the returned data
-|-
-! Return
-| USB_STATUS_SUCCESS if completed or another USB error code on failure
-|-
-|}
-</div></div>
-<br />
-<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
-<pre style="border: 0; padding-bottom:0px;">function USBKeyboardDeviceGetReportDescriptor(Keyboard:PUSBKeyboardDevice; Descriptor:Pointer; Size:LongWord):LongWord;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the Report Descriptor for a USB keyboard device</div>
-<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
-{| class="wikitable" style="font-size: 14px; background: white;"
-|-
-! Keyboard
-| The USB keyboard device to get the descriptor for
-|-
-! Descriptor
-| Pointer to a buffer to return the USB Report Descriptor
-|-
-! Size
-| The size in bytes of the buffer pointed to by Descriptor
-|-
-! Return
-| USB_STATUS_SUCCESS if completed or another USB error code on failure
 |-
 |}