ps2.h

Go to the documentation of this file.

/*
 * This file is part of the Ultibo project, https://ultibo.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2026 Garry Wood <garry@softoz.com.au>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef _ULTIBO_PS2_H
#define _ULTIBO_PS2_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/globalconst.h"

#define PS2_KEYBOARD_COMMAND_SET_LEDS   0xED 
#define PS2_KEYBOARD_COMMAND_ECHO   0xEE 
#define PS2_KEYBOARD_COMMAND_SCANCODE   0xF0 
#define PS2_KEYBOARD_COMMAND_IDENTIFY   0xF2 
#define PS2_KEYBOARD_COMMAND_SET_RATE_DELAY 0xF3 
#define PS2_KEYBOARD_COMMAND_ENABLE_SCAN    0xF4 
#define PS2_KEYBOARD_COMMAND_DISABLE_SCAN   0xF5 
#define PS2_KEYBOARD_COMMAND_SET_DEFAULTS   0xF6 
#define PS2_KEYBOARD_COMMAND_SET_ALL_TYPEMATIC_ONLY 0xF7 
#define PS2_KEYBOARD_COMMAND_SET_ALL_MAKE_RELEASE   0xF8 
#define PS2_KEYBOARD_COMMAND_SET_ALL_MAKE_ONLY  0xF9 
#define PS2_KEYBOARD_COMMAND_SET_ALL_MAKE_TYPEMATIC 0xFA 
#define PS2_KEYBOARD_COMMAND_SET_TYPEMATIC_ONLY 0xFB 
#define PS2_KEYBOARD_COMMAND_SET_MAKE_RELEASE   0xFC 
#define PS2_KEYBOARD_COMMAND_SET_MAKE_ONLY  0xFD 
#define PS2_KEYBOARD_COMMAND_RESEND 0xFE 
#define PS2_KEYBOARD_COMMAND_RESET  0xFF 
 
#define PS2_KEYBOARD_SET_LEDS_SCROLLLOCK    (1 << 0) 
#define PS2_KEYBOARD_SET_LEDS_NUMLOCK   (1 << 1) 
#define PS2_KEYBOARD_SET_LEDS_CAPSLOCK  (1 << 2) 
 
#define PS2_KEYBOARD_SCANCODE_GET   0 
#define PS2_KEYBOARD_SCANCODE_SET1  1 
#define PS2_KEYBOARD_SCANCODE_SET2  2 
#define PS2_KEYBOARD_SCANCODE_SET3  3 
 
#define PS2_KEYBOARD_SET_REPEAT_RATE_MASK   0x0F 
#define PS2_KEYBOARD_SET_DELAY_MASK 0x70 
 
#define PS2_KEYBOARD_SET_REPEAT_RATE_30_0   0x00 
#define PS2_KEYBOARD_SET_REPEAT_RATE_26_7   0x01 
#define PS2_KEYBOARD_SET_REPEAT_RATE_24_0   0x02 
#define PS2_KEYBOARD_SET_REPEAT_RATE_21_8   0x03 
#define PS2_KEYBOARD_SET_REPEAT_RATE_20_7   0x04 
#define PS2_KEYBOARD_SET_REPEAT_RATE_18_5   0x05 
#define PS2_KEYBOARD_SET_REPEAT_RATE_17_1   0x06 
#define PS2_KEYBOARD_SET_REPEAT_RATE_16_0   0x07 
#define PS2_KEYBOARD_SET_REPEAT_RATE_15_0   0x08 
#define PS2_KEYBOARD_SET_REPEAT_RATE_13_3   0x09 
#define PS2_KEYBOARD_SET_REPEAT_RATE_12_0   0x0A 
#define PS2_KEYBOARD_SET_REPEAT_RATE_10_9   0x0B 
#define PS2_KEYBOARD_SET_REPEAT_RATE_10_0   0x0C 
#define PS2_KEYBOARD_SET_REPEAT_RATE_9_2    0x0D 
#define PS2_KEYBOARD_SET_REPEAT_RATE_8_6    0x0E 
#define PS2_KEYBOARD_SET_REPEAT_RATE_8_0    0x0F 
#define PS2_KEYBOARD_SET_REPEAT_RATE_7_5    0x10 
#define PS2_KEYBOARD_SET_REPEAT_RATE_6_7    0x11 
#define PS2_KEYBOARD_SET_REPEAT_RATE_6_0    0x12 
#define PS2_KEYBOARD_SET_REPEAT_RATE_5_5    0x13 
#define PS2_KEYBOARD_SET_REPEAT_RATE_5_0    0x14 
#define PS2_KEYBOARD_SET_REPEAT_RATE_4_6    0x15 
#define PS2_KEYBOARD_SET_REPEAT_RATE_4_3    0x16 
#define PS2_KEYBOARD_SET_REPEAT_RATE_4_0    0x17 
#define PS2_KEYBOARD_SET_REPEAT_RATE_3_7    0x18 
#define PS2_KEYBOARD_SET_REPEAT_RATE_3_3    0x19 
#define PS2_KEYBOARD_SET_REPEAT_RATE_3_0    0x1A 
#define PS2_KEYBOARD_SET_REPEAT_RATE_2_7    0x1B 
#define PS2_KEYBOARD_SET_REPEAT_RATE_2_5    0x1C 
#define PS2_KEYBOARD_SET_REPEAT_RATE_2_3    0x1D 
#define PS2_KEYBOARD_SET_REPEAT_RATE_2_1    0x1E 
#define PS2_KEYBOARD_SET_REPEAT_RATE_2_0    0x1F 
 
#define PS2_KEYBOARD_SET_DELAY_250  0x00 
#define PS2_KEYBOARD_SET_DELAY_500  0x10 
#define PS2_KEYBOARD_SET_DELAY_750  0x20 
#define PS2_KEYBOARD_SET_DELAY_1000 0x30 

#define PS2_MOUSE_COMMAND_RESET 0xFF 
#define PS2_MOUSE_COMMAND_RESEND    0xFE 
#define PS2_MOUSE_COMMAND_SET_DEFAULTS  0xF6 
#define PS2_MOUSE_COMMAND_DISABLE_REPORT    0xF5 
#define PS2_MOUSE_COMMAND_ENABLE_REPORT 0xF4 
#define PS2_MOUSE_COMMAND_SET_SAMPLE_RATE   0xF3 
#define PS2_MOUSE_COMMAND_GET_DEVICE_ID 0xF2 
#define PS2_MOUSE_COMMAND_SET_REMOTE_MODE   0xF0 
#define PS2_MOUSE_COMMAND_SET_WRAP_MODE 0xEE 
#define PS2_MOUSE_COMMAND_RESET_WRAP_MODE   0xEC 
#define PS2_MOUSE_COMMAND_READ_DATA 0xEB 
#define PS2_MOUSE_COMMAND_SET_STREAM_MODE   0xEA 
#define PS2_MOUSE_COMMAND_STATUS_REQUEST    0xE9 
#define PS2_MOUSE_COMMAND_SET_RESOLUTION    0xE8 
 
#define PS2_MOUSE_COMMAND_SAMPLE_RATE_10    10 
#define PS2_MOUSE_COMMAND_SAMPLE_RATE_20    20 
#define PS2_MOUSE_COMMAND_SAMPLE_RATE_40    40 
#define PS2_MOUSE_COMMAND_SAMPLE_RATE_60    60 
#define PS2_MOUSE_COMMAND_SAMPLE_RATE_80    80 
#define PS2_MOUSE_COMMAND_SAMPLE_RATE_100   100 
#define PS2_MOUSE_COMMAND_SAMPLE_RATE_200   200 
 
#define PS2_MOUSE_COMMAND_RESOLUTION_1  0x00 
#define PS2_MOUSE_COMMAND_RESOLUTION_2  0x01 
#define PS2_MOUSE_COMMAND_RESOLUTION_4  0x02 
#define PS2_MOUSE_COMMAND_RESOLUTION_5  0x03 

#define PS2_RESPONSE_NONE   0x00 
#define PS2_RESPONSE_SELF_TEST_PASS 0xAA 
#define PS2_RESPONSE_ECHO   0xEE 
#define PS2_RESPONSE_ACK    0xFA 
#define PS2_RESPONSE_SELFTEST_FAIL1 0xFC 
#define PS2_RESPONSE_SELFTEST_FAIL2 0xFD 
#define PS2_RESPONSE_RESEND 0xFE 
#define PS2_RESPONSE_ERROR  0xFF 

#define PS2_MOUSE_BITS_YO   (1 << 7) 
#define PS2_MOUSE_BITS_XO   (1 << 6) 
#define PS2_MOUSE_BITS_YS   (1 << 5) 
#define PS2_MOUSE_BITS_XS   (1 << 4) 
#define PS2_MOUSE_BITS_AO   (1 << 3) 
#define PS2_MOUSE_BITS_BM   (1 << 2) 
#define PS2_MOUSE_BITS_BR   (1 << 1) 
#define PS2_MOUSE_BITS_BL   (1 << 0) 

#define PS2_SCANCODE_MAKE   0 
#define PS2_SCANCODE_BREAK  1 

#define PS2_SCANCODE_PC104_COUNT    104
#define PS2_SCANCODE_ACPI_COUNT 3
#define PS2_SCANCODE_MULTIMEDIA_COUNT   18
#define PS2_SCANCODE_COUNT  PS2_SCANCODE_PC104_COUNT + PS2_SCANCODE_ACPI_COUNT + PS2_SCANCODE_MULTIMEDIA_COUNT

typedef uint8_t PS2_SCANCODE_DATA[PS2_SCANCODE_COUNT * 2][10];

typedef struct _PS2_KEYBOARD_SCANCODE PS2_KEYBOARD_SCANCODE;
struct _PS2_KEYBOARD_SCANCODE
{
    uint8_t scancodeset;
    uint8_t scancode[8];
};
 

typedef struct _PS2_MOUSE_PACKET PS2_MOUSE_PACKET;
struct _PS2_MOUSE_PACKET
{
    uint8_t mousebits; 
    uint8_t mousex; 
    uint8_t mousey; 
};


uint32_t STDCALL keyboard_leds_to_ps2_leds(uint32_t leds, uint8_t *ps2leds);

uint32_t STDCALL keyboard_rate_and_delay_to_ps2_typematic(uint32_t rate, uint32_t delay, uint8_t *ps2typematic);

uint32_t STDCALL ps2_keyboard_scancode_match(PS2_KEYBOARD_SCANCODE *keyboardscancode, int32_t *index);

uint32_t STDCALL ps2_keyboard_scancode_to_scan_code(PS2_KEYBOARD_SCANCODE *keyboardscancode, int32_t index, uint16_t *scancode);

uint32_t STDCALL ps2_keyboard_scancode_to_modifiers(PS2_KEYBOARD_SCANCODE *keyboardscancode, int32_t index, uint32_t *modifiers);

uint32_t STDCALL mouse_sample_rate_to_ps2_sample_rate(uint32_t rate, uint8_t *ps2rate);

uint32_t STDCALL ps2_mouse_packet_to_mouse_data(PS2_MOUSE_PACKET *mousepacket, MOUSE_DATA *mousedata, uint32_t flags, uint32_t rotation);
 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_PS2_H