ps2.h

Go to the documentation of this file.

#pragma once
 
#include <kernel/cpu/port.h>
 
#include <stdbool.h>
#include <stdint.h>
 
#define PS2_WAIT_TIMEOUT (CLOCKS_PER_SEC / 2)
 
#define PS2_SMALL_DELAY (CLOCKS_PER_SEC / 100)
 
#define PS2_LARGE_DELAY (CLOCKS_PER_SEC / 5)
 
#define PS2_COMMAND_RETRIES 3
 
typedef enum
{
    PS2_PORT_DATA = 0x60,
    PS2_PORT_STATUS = 0x64,
    PS2_PORT_CMD = 0x64
} ps2_port_t;
 
typedef enum
{
    PS2_CMD_CFG_READ = 0x20,
    PS2_CMD_CFG_WRITE = 0x60,
    PS2_CMD_SECOND_DISABLE = 0xA7,
    PS2_CMD_SECOND_ENABLE = 0xA8,
    PS2_CMD_FIRST_DISABLE = 0xAD,
    PS2_CMD_FIRST_ENABLE = 0xAE,
    PS2_CMD_SECOND_TEST = 0xA9,
    PS2_CMD_SELF_TEST = 0xAA,
    PS2_CMD_FIRST_TEST = 0xAB,
    PS2_CMD_DUMP = 0xAC,
    PS2_CMD_SECOND_WRITE = 0xD4,
} ps2_cmd_t;
 
typedef enum
{
    PS2_STATUS_OUT_FULL = (1 << 0), 
    PS2_STATUS_IN_FULL = (1 << 1),  
    PS2_STATUS_SYSTEM_FLAG = (1 << 2),
    PS2_STATUS_CMD_DATA = (1 << 3), 
    PS2_STATUS_TIMEOUT_ERROR = (1 << 6),
    PS2_STATUS_PARITY_ERROR = (1 << 7)
} ps2_status_bits_t;
 
typedef enum
{
    PS2_CFG_FIRST_IRQ = (1 << 0),            
    PS2_CFG_SECOND_IRQ = (1 << 1),           
    PS2_CFG_SYSTEM_FLAG = (1 << 2),          
    PS2_CFG_RESERVED_3 = (1 << 3),           
    PS2_CFG_FIRST_CLOCK_DISABLE = (1 << 4),  
    PS2_CFG_SECOND_CLOCK_DISABLE = (1 << 5), 
    PS2_CFG_FIRST_TRANSLATION = (1 << 6),    
    PS2_CFG_RESERVED_7 = (1 << 7)            
} ps2_config_bits_t;
 
typedef enum
{
    PS2_DEV_CMD_ECHO = 0xEE,
    PS2_DEV_CMD_SET_LEDS = 0xED,
    PS2_DEV_CMD_SET_SCANCODE_SET = 0xF0,
    PS2_DEV_CMD_IDENTIFY = 0xF2,
    PS2_DEV_CMD_SET_TYPEMATIC = 0xF3,
    PS2_DEV_CMD_ENABLE_SCANNING = 0xF4,
    PS2_DEV_CMD_DISABLE_SCANNING = 0xF5,
    PS2_DEV_CMD_SET_DEFAULTS = 0xF6,
    PS2_DEV_CMD_RESEND = 0xFE,
    PS2_DEV_CMD_RESET = 0xFF,
} ps2_device_cmd_t;
 
typedef enum
{
    PS2_DEV_NONE = -1,  
    PS2_DEV_FIRST = 0,  
    PS2_DEV_SECOND = 1, 
    PS2_DEV_COUNT = 2   
} ps2_device_t;
 
typedef enum
{
    PS2_DEV_TYPE_UNKNOWN,
    PS2_DEV_TYPE_KEYBOARD,
    PS2_DEV_TYPE_MOUSE_STANDARD,
    PS2_DEV_TYPE_MOUSE_SCROLL,
    PS2_DEV_TYPE_MOUSE_5BUTTON,
} ps2_device_type_t;
 
typedef struct
{
    ps2_device_t device;
    uint8_t firstIdByte;
    const char* name;
    ps2_device_type_t type;
    bool active;
} ps2_device_info_t;
 
typedef enum
{
    PS2_SELF_TEST_PASS = 0x55,
    PS2_SELF_TEST_FAIL = 0xFC,
} ps2_self_test_response_t;
 
typedef enum
{
    PS2_DEV_TEST_PASS = 0x00,
    PS2_DEV_TEST_CLOCK_STUCK_LOW = 0x01,
    PS2_DEV_TEST_CLOCK_STUCK_HIGH = 0x02,
    PS2_DEV_TEST_DATA_STUCK_LOW = 0x03,
    PS2_DEV_TEST_DATA_STUCK_HIGH = 0x04,
} ps2_device_test_response_t;
 
typedef enum
{
    PS2_DEV_RESPONSE_ACK = 0xFA,
    PS2_DEV_RESPONSE_RESEND = 0xFE,
    PS2_DEV_RESPONSE_BAT_OK = 0xAA,
    PS2_DEV_RESPONSE_KBD_EXTENDED = 0xE0, 
    PS2_DEV_RESPONSE_KBD_RELEASE = 0xF0,  
} ps2_device_response_t;
 
#define PS2_READ(data) \
    ({ \
        uint64_t result = ps2_wait_until_set(PS2_STATUS_OUT_FULL); \
        if (result != ERR) \
        { \
            *(data) = port_inb(PS2_PORT_DATA); \
        } \
        result; \
    })
 
#define PS2_WRITE(data) \
    ({ \
        uint64_t result = ps2_wait_until_clear(PS2_STATUS_IN_FULL); \
        if (result != ERR) \
        { \
            port_outb(PS2_PORT_DATA, data); \
        } \
        result; \
    })
 
#define PS2_CMD(command) \
    ({ \
        uint64_t result = ps2_send_cmd(command); \
        result; \
    })
 
#define PS2_CMD_AND_READ(command, data) \
    ({ \
        uint64_t result = ps2_send_cmd(command); \
        if (result != ERR) \
        { \
            result = PS2_READ(data); \
        } \
        result; \
    })
 
#define PS2_CMD_AND_WRITE(command, data) \
    ({ \
        uint64_t result = ps2_send_cmd(command); \
        if (result != ERR) \
        { \
            result = PS2_WRITE(data); \
        } \
        result; \
    })
 
#define PS2_DEV_CMD(device, command) \
    ({ \
        uint64_t result = ps2_send_device_cmd(device, command); \
        result; \
    })
 
#define PS2_DEV_CMD_AND_READ(device, command, data) \
    ({ \
        uint64_t result = ps2_send_device_cmd(device, command); \
        if (result != ERR) \
        { \
            result = PS2_READ(data); \
        } \
        result; \
    })
 
#define PS2_DEV_SUB_CMD(device, command, subCommand) \
    ({ \
        uint64_t result = PS2_DEV_CMD(device, command); \
        if (result != ERR) \
        { \
            result = PS2_DEV_CMD(device, subCommand); \
        } \
        result; \
    })
 
void ps2_init(void);
 
void ps2_drain(void);
 
uint64_t ps2_wait_until_set(ps2_status_bits_t status);
 
uint64_t ps2_wait_until_clear(ps2_status_bits_t status);
 
uint64_t ps2_send_cmd(ps2_cmd_t command);
 
uint64_t ps2_send_device_cmd(ps2_device_t device, ps2_device_cmd_t command);