IBM Personal Computer/2 ports. More...

Modules
	PS/2 Keyboard Driver
	PS/2 Keyboard Driver.

	PS/2 Mouse Driver
	PS/2 Mouse Driver.

	PS/2 Scanmap
	PS/2 Scanmap.

Data Structures
struct	ps2_device_info_t
	PS/2 device information structure. More...

Macros
#define	PS2_WAIT_TIMEOUT (CLOCKS_PER_SEC / 2)
	Wait timeout for PS/2 controller.

#define	PS2_SMALL_DELAY (CLOCKS_PER_SEC / 100)
	Small delay for various operations.

#define	PS2_LARGE_DELAY (CLOCKS_PER_SEC / 5)
	Large delay for various operations.

#define	PS2_COMMAND_RETRIES 3
	Number of retries for commands.

#define	PS2_READ(data)
	Read data from PS/2 controller.

#define	PS2_WRITE(data)
	Write data to PS/2 controller.

#define	PS2_CMD(command)
	Send a command to the PS/2 controller without reading response.

#define	PS2_CMD_AND_READ(command, data)
	Send a command to the PS/2 controller and read response.

#define	PS2_CMD_AND_WRITE(command, data)
	Send a command to the PS/2 controller and write data.

#define	PS2_DEV_CMD(device, command)
	Send a command to a PS/2 device without reading response.

#define	PS2_DEV_CMD_AND_READ(device, command, data)
	Send a command to a PS/2 device and read response.

#define	PS2_DEV_SUB_CMD(device, command, subCommand)
	Send a command and a subcommand to a PS/2 device.

#define	PS2_WAIT_TIMEOUT (CLOCKS_PER_SEC / 2)
	Wait timeout for PS/2 controller.

#define	PS2_SMALL_DELAY (CLOCKS_PER_SEC / 100)
	Small delay for various operations.

#define	PS2_LARGE_DELAY (CLOCKS_PER_SEC / 5)
	Large delay for various operations.

#define	PS2_COMMAND_RETRIES 3
	Number of retries for commands.

#define	PS2_READ(data)
	Read data from PS/2 controller.

#define	PS2_WRITE(data)
	Write data to PS/2 controller.

#define	PS2_CMD(command)
	Send a command to the PS/2 controller without reading response.

#define	PS2_CMD_AND_READ(command, data)
	Send a command to the PS/2 controller and read response.

#define	PS2_CMD_AND_WRITE(command, data)
	Send a command to the PS/2 controller and write data.

#define	PS2_DEV_CMD(device, command)
	Send a command to a PS/2 device without reading response.

#define	PS2_DEV_CMD_AND_READ(device, command, data)
	Send a command to a PS/2 device and read response.

#define	PS2_DEV_SUB_CMD(device, command, subCommand)
	Send a command and a subcommand to a PS/2 device.

Enumerations
enum	ps2_port_t { PS2_PORT_DATA = 0x60 , PS2_PORT_STATUS = 0x64 , PS2_PORT_CMD = 0x64 }
	PS/2 controller I/O ports. More...

enum	ps2_cmd_t { 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 }
	PS/2 controller commands. More...

enum	ps2_status_bits_t { 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) }
	PS/2 controller status register bits. More...

enum	ps2_config_bits_t { 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) }
	PS/2 controller configuration bits. More...

enum	ps2_device_cmd_t { 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 }
	PS/2 device commands. More...

enum	ps2_device_t { PS2_DEV_NONE = -1 , PS2_DEV_FIRST = 0 , PS2_DEV_SECOND = 1 , PS2_DEV_COUNT = 2 }
	PS/2 device identifiers. More...

enum	ps2_device_type_t { PS2_DEV_TYPE_UNKNOWN , PS2_DEV_TYPE_KEYBOARD , PS2_DEV_TYPE_MOUSE_STANDARD , PS2_DEV_TYPE_MOUSE_SCROLL , PS2_DEV_TYPE_MOUSE_5BUTTON }
	PS/2 device types. More...

enum	ps2_self_test_response_t { PS2_SELF_TEST_PASS = 0x55 , PS2_SELF_TEST_FAIL = 0xFC }
	PS/2 controller self-test responses. More...

enum	ps2_device_test_response_t { 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 }
	PS/2 device test responses. More...

enum	ps2_device_response_t { 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 }
	PS/2 device command responses. More...

enum	ps2_port_t { PS2_PORT_DATA = 0x60 , PS2_PORT_STATUS = 0x64 , PS2_PORT_CMD = 0x64 }
	PS/2 controller I/O ports. More...

enum	ps2_cmd_t { 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 }
	PS/2 controller commands. More...

enum	ps2_status_bits_t { 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) }
	PS/2 controller status register bits. More...

enum	ps2_config_bits_t { 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) }
	PS/2 controller configuration bits. More...

enum	ps2_device_cmd_t { 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 }
	PS/2 device commands. More...

enum	ps2_device_t { PS2_DEV_NONE = -1 , PS2_DEV_FIRST = 0 , PS2_DEV_SECOND = 1 , PS2_DEV_COUNT = 2 }
	PS/2 device identifiers. More...

enum	ps2_device_type_t { PS2_DEV_TYPE_UNKNOWN , PS2_DEV_TYPE_KEYBOARD , PS2_DEV_TYPE_MOUSE_STANDARD , PS2_DEV_TYPE_MOUSE_SCROLL , PS2_DEV_TYPE_MOUSE_5BUTTON }
	PS/2 device types. More...

enum	ps2_self_test_response_t { PS2_SELF_TEST_PASS = 0x55 , PS2_SELF_TEST_FAIL = 0xFC }
	PS/2 controller self-test responses. More...

enum	ps2_device_test_response_t { 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 }
	PS/2 device test responses. More...

enum	ps2_device_response_t { 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 }
	PS/2 device command responses. More...

Functions
void	ps2_init (void)
	Initialize the PS/2 controller.

void	ps2_drain (void)
	Drain the PS/2 output buffer.

uint64_t	ps2_wait_until_set (ps2_status_bits_t status)
	Wait until status bit(s) is set.

uint64_t	ps2_wait_until_clear (ps2_status_bits_t status)
	Wait until status bit(s) is clear.

uint64_t	ps2_send_cmd (ps2_cmd_t command)
	Send a command to the PS/2 controller.

uint64_t	ps2_send_device_cmd (ps2_device_t device, ps2_device_cmd_t command)
	Send a command to a PS/2 device.

Detailed Description

IBM Personal Computer/2 ports.

Patchwork attempts to implement a comprehensive PS/2 driver, even if certain details would be completely irrelevant on modern hardware. For example, most implementations assume that the first PS2 device is always a keyboard and the second a mouse, however this is, as far as I'm aware, just a very commonly agreed convention and not actually specified anywhere, even if all modern hardware appears to follow this convention, they technically don't have to.

The reason for this is because PS/2 appears to be frequently neglected in hobby projects, so I wish to create a publically available and easy to understand "proper" implementation. Even if its overkill and of course becouse its fun.

Note that in the future once proper device detection is implemented, this will need to be redone.

See also: https://wiki.osdev.org/I8042_PS/2_Controller; https://www-ug.eecg.toronto.edu/msl/nios_devices/datasheets/PS2%20Keyboard%20Protocol.htm

Macro Definition Documentation

◆ PS2_CMD [1/2]

#define PS2_CMD ( command )

Value:

    ({ \
        uint64_t result = ps2_send_cmd(command); \
        result; \
    })

Send a command to the PS/2 controller without reading response.

Parameters

command Command to send.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 232 of file ps2.h.

◆ PS2_CMD [2/2]

#define PS2_CMD ( command )

Value:

    ({ \
        uint64_t result = ps2_send_cmd(command); \
        result; \
    })

Send a command to the PS/2 controller without reading response.

Parameters

command Command to send.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 232 of file ps2.h.

◆ PS2_CMD_AND_READ [1/2]

#define PS2_CMD_AND_READ	(	command,
		data
	)

Value:

    ({ \
        uint64_t result = ps2_send_cmd(command); \
        if (result != ERR) \
        { \
            result = PS2_READ(data); \
        } \
        result; \
    })

Send a command to the PS/2 controller and read response.

Parameters

command	Command to send.
data	Pointer to store the response byte

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 245 of file ps2.h.

◆ PS2_CMD_AND_READ [2/2]

#define PS2_CMD_AND_READ	(	command,
		data
	)

Value:

    ({ \
        uint64_t result = ps2_send_cmd(command); \
        if (result != ERR) \
        { \
            result = PS2_READ(data); \
        } \
        result; \
    })

Send a command to the PS/2 controller and read response.

Parameters

command	Command to send.
data	Pointer to store the response byte

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 245 of file ps2.h.

◆ PS2_CMD_AND_WRITE [1/2]

#define PS2_CMD_AND_WRITE	(	command,
		data
	)

Value:

    ({ \
        uint64_t result = ps2_send_cmd(command); \
        if (result != ERR) \
        { \
            result = PS2_WRITE(data); \
        } \
        result; \
    })

Send a command to the PS/2 controller and write data.

Parameters

command	Command to send.
data	Data to write.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 262 of file ps2.h.

◆ PS2_CMD_AND_WRITE [2/2]

#define PS2_CMD_AND_WRITE	(	command,
		data
	)

Value:

    ({ \
        uint64_t result = ps2_send_cmd(command); \
        if (result != ERR) \
        { \
            result = PS2_WRITE(data); \
        } \
        result; \
    })

Send a command to the PS/2 controller and write data.

Parameters

command	Command to send.
data	Data to write.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 262 of file ps2.h.

◆ PS2_COMMAND_RETRIES [1/2]

#define PS2_COMMAND_RETRIES 3

Number of retries for commands.

Definition at line 47 of file ps2.h.

◆ PS2_COMMAND_RETRIES [2/2]

#define PS2_COMMAND_RETRIES 3

Number of retries for commands.

Definition at line 47 of file ps2.h.

◆ PS2_DEV_CMD [1/2]

#define PS2_DEV_CMD	(	device,
		command
	)

Value:

    ({ \
        uint64_t result = ps2_send_device_cmd(device, command); \
        result; \
    })

Send a command to a PS/2 device without reading response.

Parameters

device	Device to send command to, specified by its port.
command	Command to send.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 279 of file ps2.h.

◆ PS2_DEV_CMD [2/2]

#define PS2_DEV_CMD	(	device,
		command
	)

Value:

    ({ \
        uint64_t result = ps2_send_device_cmd(device, command); \
        result; \
    })

Send a command to a PS/2 device without reading response.

Parameters

device	Device to send command to, specified by its port.
command	Command to send.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 279 of file ps2.h.

◆ PS2_DEV_CMD_AND_READ [1/2]

#define PS2_DEV_CMD_AND_READ	(	device,
		command,
		data
	)

Value:

    ({ \
        uint64_t result = ps2_send_device_cmd(device, command); \
        if (result != ERR) \
        { \
            result = PS2_READ(data); \
        } \
        result; \
    })

Send a command to a PS/2 device and read response.

Parameters

device	Device to send command to, specified by its port.
command	Command to send.
data	Pointer to store the response byte

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 293 of file ps2.h.

◆ PS2_DEV_CMD_AND_READ [2/2]

#define PS2_DEV_CMD_AND_READ	(	device,
		command,
		data
	)

Value:

    ({ \
        uint64_t result = ps2_send_device_cmd(device, command); \
        if (result != ERR) \
        { \
            result = PS2_READ(data); \
        } \
        result; \
    })

Send a command to a PS/2 device and read response.

Parameters

device	Device to send command to, specified by its port.
command	Command to send.
data	Pointer to store the response byte

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 293 of file ps2.h.

◆ PS2_DEV_SUB_CMD [1/2]

#define PS2_DEV_SUB_CMD	(	device,
		command,
		subCommand
	)

Value:

    ({ \
        uint64_t result = PS2_DEV_CMD(device, command); \
        if (result != ERR) \
        { \
            result = PS2_DEV_CMD(device, subCommand); \
        } \
        result; \
    })

Send a command and a subcommand to a PS/2 device.

Parameters

device	Device to send command to, specified by its port.
command	Command to send.
subCommand	Subcommand to send.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 311 of file ps2.h.

◆ PS2_DEV_SUB_CMD [2/2]

#define PS2_DEV_SUB_CMD	(	device,
		command,
		subCommand
	)

Value:

    ({ \
        uint64_t result = PS2_DEV_CMD(device, command); \
        if (result != ERR) \
        { \
            result = PS2_DEV_CMD(device, subCommand); \
        } \
        result; \
    })

Send a command and a subcommand to a PS/2 device.

Parameters

device	Device to send command to, specified by its port.
command	Command to send.
subCommand	Subcommand to send.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 311 of file ps2.h.

◆ PS2_LARGE_DELAY [1/2]

#define PS2_LARGE_DELAY (CLOCKS_PER_SEC / 5)

Large delay for various operations.

Definition at line 42 of file ps2.h.

◆ PS2_LARGE_DELAY [2/2]

#define PS2_LARGE_DELAY (CLOCKS_PER_SEC / 5)

Large delay for various operations.

Definition at line 42 of file ps2.h.

◆ PS2_READ [1/2]

#define PS2_READ ( data )

Value:

    ({ \
        uint64_t result = ps2_wait_until_set(PS2_STATUS_OUT_FULL); \
        if (result != ERR) \
        { \
            *(data) = port_inb(PS2_PORT_DATA); \
        } \
        result; \
    })

Read data from PS/2 controller.

Waits for the output buffer to be full, then reads a byte from the data port.

Parameters

data	Pointer to store the read byte.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 198 of file ps2.h.

◆ PS2_READ [2/2]

#define PS2_READ ( data )

Value:

    ({ \
        uint64_t result = ps2_wait_until_set(PS2_STATUS_OUT_FULL); \
        if (result != ERR) \
        { \
            *(data) = port_inb(PS2_PORT_DATA); \
        } \
        result; \
    })

Read data from PS/2 controller.

Waits for the output buffer to be full, then reads a byte from the data port.

Parameters

data	Pointer to store the read byte.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 198 of file ps2.h.

◆ PS2_SMALL_DELAY [1/2]

#define PS2_SMALL_DELAY (CLOCKS_PER_SEC / 100)

Small delay for various operations.

Definition at line 37 of file ps2.h.

◆ PS2_SMALL_DELAY [2/2]

#define PS2_SMALL_DELAY (CLOCKS_PER_SEC / 100)

Small delay for various operations.

Definition at line 37 of file ps2.h.

◆ PS2_WAIT_TIMEOUT [1/2]

#define PS2_WAIT_TIMEOUT (CLOCKS_PER_SEC / 2)

Wait timeout for PS/2 controller.

Definition at line 32 of file ps2.h.

◆ PS2_WAIT_TIMEOUT [2/2]

#define PS2_WAIT_TIMEOUT (CLOCKS_PER_SEC / 2)

Wait timeout for PS/2 controller.

Definition at line 32 of file ps2.h.

◆ PS2_WRITE [1/2]

#define PS2_WRITE ( data )

Value:

    ({ \
        uint64_t result = ps2_wait_until_clear(PS2_STATUS_IN_FULL); \
        if (result != ERR) \
        { \
            port_outb(PS2_PORT_DATA, data); \
        } \
        result; \
    })

Write data to PS/2 controller.

Waits for the input buffer to be empty, then writes a byte to the data port.

Parameters

data	Byte to write.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 216 of file ps2.h.

◆ PS2_WRITE [2/2]

#define PS2_WRITE ( data )

Value:

    ({ \
        uint64_t result = ps2_wait_until_clear(PS2_STATUS_IN_FULL); \
        if (result != ERR) \
        { \
            port_outb(PS2_PORT_DATA, data); \
        } \
        result; \
    })

Write data to PS/2 controller.

Waits for the input buffer to be empty, then writes a byte to the data port.

Parameters

data	Byte to write.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 216 of file ps2.h.

Enumeration Type Documentation

◆ ps2_cmd_t [1/2]

enum ps2_cmd_t

PS/2 controller commands.

Enumerator
PS2_CMD_CFG_READ
PS2_CMD_CFG_WRITE
PS2_CMD_SECOND_DISABLE
PS2_CMD_SECOND_ENABLE
PS2_CMD_FIRST_DISABLE
PS2_CMD_FIRST_ENABLE
PS2_CMD_SECOND_TEST
PS2_CMD_SELF_TEST
PS2_CMD_FIRST_TEST
PS2_CMD_DUMP
PS2_CMD_SECOND_WRITE

Definition at line 62 of file ps2.h.

◆ ps2_cmd_t [2/2]

enum ps2_cmd_t

PS/2 controller commands.

Enumerator
PS2_CMD_CFG_READ
PS2_CMD_CFG_WRITE
PS2_CMD_SECOND_DISABLE
PS2_CMD_SECOND_ENABLE
PS2_CMD_FIRST_DISABLE
PS2_CMD_FIRST_ENABLE
PS2_CMD_SECOND_TEST
PS2_CMD_SELF_TEST
PS2_CMD_FIRST_TEST
PS2_CMD_DUMP
PS2_CMD_SECOND_WRITE

Definition at line 62 of file ps2.h.

◆ ps2_config_bits_t [1/2]

enum ps2_config_bits_t

PS/2 controller configuration bits.

Enumerator
PS2_CFG_FIRST_IRQ	First PS/2 port interrupt enable.
PS2_CFG_SECOND_IRQ	Second PS/2 port interrupt enable.
PS2_CFG_SYSTEM_FLAG	System flag (POST passed)
PS2_CFG_RESERVED_3	Should be zero.
PS2_CFG_FIRST_CLOCK_DISABLE	First PS/2 port clock disable.
PS2_CFG_SECOND_CLOCK_DISABLE	Second PS/2 port clock disable.
PS2_CFG_FIRST_TRANSLATION	First PS/2 port translation enable.
PS2_CFG_RESERVED_7	Should be zero.

Definition at line 93 of file ps2.h.

◆ ps2_config_bits_t [2/2]

enum ps2_config_bits_t

PS/2 controller configuration bits.

Enumerator
PS2_CFG_FIRST_IRQ	First PS/2 port interrupt enable.
PS2_CFG_SECOND_IRQ	Second PS/2 port interrupt enable.
PS2_CFG_SYSTEM_FLAG	System flag (POST passed)
PS2_CFG_RESERVED_3	Should be zero.
PS2_CFG_FIRST_CLOCK_DISABLE	First PS/2 port clock disable.
PS2_CFG_SECOND_CLOCK_DISABLE	Second PS/2 port clock disable.
PS2_CFG_FIRST_TRANSLATION	First PS/2 port translation enable.
PS2_CFG_RESERVED_7	Should be zero.

Definition at line 93 of file ps2.h.

◆ ps2_device_cmd_t [1/2]

enum ps2_device_cmd_t

PS/2 device commands.

Enumerator
PS2_DEV_CMD_ECHO
PS2_DEV_CMD_SET_LEDS
PS2_DEV_CMD_SET_SCANCODE_SET
PS2_DEV_CMD_IDENTIFY
PS2_DEV_CMD_SET_TYPEMATIC
PS2_DEV_CMD_ENABLE_SCANNING
PS2_DEV_CMD_DISABLE_SCANNING
PS2_DEV_CMD_SET_DEFAULTS
PS2_DEV_CMD_RESEND
PS2_DEV_CMD_RESET

Definition at line 108 of file ps2.h.

◆ ps2_device_cmd_t [2/2]

enum ps2_device_cmd_t

PS/2 device commands.

Enumerator
PS2_DEV_CMD_ECHO
PS2_DEV_CMD_SET_LEDS
PS2_DEV_CMD_SET_SCANCODE_SET
PS2_DEV_CMD_IDENTIFY
PS2_DEV_CMD_SET_TYPEMATIC
PS2_DEV_CMD_ENABLE_SCANNING
PS2_DEV_CMD_DISABLE_SCANNING
PS2_DEV_CMD_SET_DEFAULTS
PS2_DEV_CMD_RESEND
PS2_DEV_CMD_RESET

Definition at line 108 of file ps2.h.

◆ ps2_device_response_t [1/2]

enum ps2_device_response_t

PS/2 device command responses.

Enumerator
PS2_DEV_RESPONSE_ACK
PS2_DEV_RESPONSE_RESEND
PS2_DEV_RESPONSE_BAT_OK
PS2_DEV_RESPONSE_KBD_EXTENDED	Indicates that the following byte is an extended scancode.
PS2_DEV_RESPONSE_KBD_RELEASE	Indicates that the following byte is a key release code.

Definition at line 181 of file ps2.h.

◆ ps2_device_response_t [2/2]

enum ps2_device_response_t

PS/2 device command responses.

Enumerator
PS2_DEV_RESPONSE_ACK
PS2_DEV_RESPONSE_RESEND
PS2_DEV_RESPONSE_BAT_OK
PS2_DEV_RESPONSE_KBD_EXTENDED	Indicates that the following byte is an extended scancode.
PS2_DEV_RESPONSE_KBD_RELEASE	Indicates that the following byte is a key release code.

Definition at line 181 of file ps2.h.

◆ ps2_device_t [1/2]

enum ps2_device_t

PS/2 device identifiers.

Enumerator
PS2_DEV_NONE	No device.
PS2_DEV_FIRST	First PS/2 port.
PS2_DEV_SECOND	Second PS/2 port.
PS2_DEV_COUNT	Total number of ports.

Definition at line 125 of file ps2.h.

◆ ps2_device_t [2/2]

enum ps2_device_t

PS/2 device identifiers.

Enumerator
PS2_DEV_NONE	No device.
PS2_DEV_FIRST	First PS/2 port.
PS2_DEV_SECOND	Second PS/2 port.
PS2_DEV_COUNT	Total number of ports.

Definition at line 125 of file ps2.h.

◆ ps2_device_test_response_t [1/2]

enum ps2_device_test_response_t

PS/2 device test responses.

Enumerator
PS2_DEV_TEST_PASS
PS2_DEV_TEST_CLOCK_STUCK_LOW
PS2_DEV_TEST_CLOCK_STUCK_HIGH
PS2_DEV_TEST_DATA_STUCK_LOW
PS2_DEV_TEST_DATA_STUCK_HIGH

Definition at line 169 of file ps2.h.

◆ ps2_device_test_response_t [2/2]

enum ps2_device_test_response_t

PS/2 device test responses.

Enumerator
PS2_DEV_TEST_PASS
PS2_DEV_TEST_CLOCK_STUCK_LOW
PS2_DEV_TEST_CLOCK_STUCK_HIGH
PS2_DEV_TEST_DATA_STUCK_LOW
PS2_DEV_TEST_DATA_STUCK_HIGH

Definition at line 169 of file ps2.h.

◆ ps2_device_type_t [1/2]

enum ps2_device_type_t

PS/2 device types.

Enumerator
PS2_DEV_TYPE_UNKNOWN
PS2_DEV_TYPE_KEYBOARD
PS2_DEV_TYPE_MOUSE_STANDARD
PS2_DEV_TYPE_MOUSE_SCROLL
PS2_DEV_TYPE_MOUSE_5BUTTON

Definition at line 136 of file ps2.h.

◆ ps2_device_type_t [2/2]

enum ps2_device_type_t

PS/2 device types.

Enumerator
PS2_DEV_TYPE_UNKNOWN
PS2_DEV_TYPE_KEYBOARD
PS2_DEV_TYPE_MOUSE_STANDARD
PS2_DEV_TYPE_MOUSE_SCROLL
PS2_DEV_TYPE_MOUSE_5BUTTON

Definition at line 136 of file ps2.h.

◆ ps2_port_t [1/2]

enum ps2_port_t

PS/2 controller I/O ports.

Enumerator
PS2_PORT_DATA
PS2_PORT_STATUS
PS2_PORT_CMD

Definition at line 52 of file ps2.h.

◆ ps2_port_t [2/2]

enum ps2_port_t

PS/2 controller I/O ports.

Enumerator
PS2_PORT_DATA
PS2_PORT_STATUS
PS2_PORT_CMD

Definition at line 52 of file ps2.h.

◆ ps2_self_test_response_t [1/2]

enum ps2_self_test_response_t

PS/2 controller self-test responses.

Enumerator
PS2_SELF_TEST_PASS
PS2_SELF_TEST_FAIL

Definition at line 160 of file ps2.h.

◆ ps2_self_test_response_t [2/2]

enum ps2_self_test_response_t

PS/2 controller self-test responses.

Enumerator
PS2_SELF_TEST_PASS
PS2_SELF_TEST_FAIL

Definition at line 160 of file ps2.h.

◆ ps2_status_bits_t [1/2]

enum ps2_status_bits_t

PS/2 controller status register bits.

Enumerator
PS2_STATUS_OUT_FULL	Output buffer status (0 = empty, 1 = full)
PS2_STATUS_IN_FULL	Input buffer status (0 = empty, 1 = full)
PS2_STATUS_SYSTEM_FLAG
PS2_STATUS_CMD_DATA	Command(1) or Data(0)
PS2_STATUS_TIMEOUT_ERROR
PS2_STATUS_PARITY_ERROR

Definition at line 80 of file ps2.h.

◆ ps2_status_bits_t [2/2]

enum ps2_status_bits_t

PS/2 controller status register bits.

Enumerator
PS2_STATUS_OUT_FULL	Output buffer status (0 = empty, 1 = full)
PS2_STATUS_IN_FULL	Input buffer status (0 = empty, 1 = full)
PS2_STATUS_SYSTEM_FLAG
PS2_STATUS_CMD_DATA	Command(1) or Data(0)
PS2_STATUS_TIMEOUT_ERROR
PS2_STATUS_PARITY_ERROR

Definition at line 80 of file ps2.h.

Function Documentation

◆ ps2_drain()

void ps2_drain ( void )

Drain the PS/2 output buffer.

Reads and discards any data in the PS/2 output buffer.

Definition at line 414 of file ps2.c.

References hpet_wait(), port_inb(), PS2_PORT_DATA, PS2_PORT_STATUS, PS2_SMALL_DELAY, and PS2_STATUS_OUT_FULL.

Referenced by ps2_device_init(), and ps2_init().

◆ ps2_init()

void ps2_init ( void )

Initialize the PS/2 controller.

Performs controller initialization including self-test, device detection, and device initialization.

Definition at line 324 of file ps2.c.

References fadt_t::bootArchFlags, devices, ERR, FADT_BOOT_ARCH_PS2_EXISTS, FADT_GET, LOG_INFO, NULL, panic(), PS2_CFG_FIRST_CLOCK_DISABLE, PS2_CFG_FIRST_IRQ, PS2_CFG_SECOND_CLOCK_DISABLE, PS2_CFG_SECOND_IRQ, ps2_check_if_dual_channel(), PS2_CMD, PS2_CMD_AND_WRITE, PS2_CMD_CFG_WRITE, PS2_CMD_FIRST_DISABLE, PS2_CMD_FIRST_ENABLE, PS2_CMD_SECOND_DISABLE, PS2_CMD_SECOND_ENABLE, PS2_DEV_FIRST, PS2_DEV_SECOND, ps2_device_init(), ps2_devices_test(), ps2_drain(), ps2_self_test(), ps2_send_cmd(), and ps2_set_initial_config().

Referenced by init_finalize().

◆ ps2_send_cmd()

uint64_t ps2_send_cmd ( ps2_cmd_t command )

Send a command to the PS/2 controller.

Parameters

command Command to send.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 454 of file ps2.c.

References ERR, port_outb(), PS2_PORT_CMD, PS2_STATUS_IN_FULL, and ps2_wait_until_clear().

Referenced by ps2_check_if_dual_channel(), ps2_init(), and ps2_send_device_cmd().

◆ ps2_send_device_cmd()

uint64_t ps2_send_device_cmd	(	ps2_device_t	device,
		ps2_device_cmd_t	command
	)

Send a command to a PS/2 device.

Parameters

device	Device to send command to, specified by its port.
command	Command to send.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 464 of file ps2.c.

References ERR, LOG_ERR, LOG_WARN, PS2_CMD_SECOND_WRITE, PS2_COMMAND_RETRIES, PS2_DEV_RESPONSE_ACK, PS2_DEV_RESPONSE_RESEND, PS2_DEV_SECOND, ps2_device_to_string(), PS2_READ, ps2_send_cmd(), and PS2_WRITE.

◆ ps2_wait_until_clear()

uint64_t ps2_wait_until_clear ( ps2_status_bits_t status )

Wait until status bit(s) is clear.

Parameters

status Status bit(s) to wait for.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 439 of file ps2.c.

References ERR, errno, ETIMEDOUT, port_inb(), PS2_PORT_STATUS, PS2_WAIT_TIMEOUT, startTime, and timer_uptime().

Referenced by ps2_send_cmd().

◆ ps2_wait_until_set()

uint64_t ps2_wait_until_set ( ps2_status_bits_t status )

Wait until status bit(s) is set.

Parameters

status Status bit(s) to wait for.

Returns: On success, 0. On failure, ERR and errno is set to ETIMEOUT if timeout occurs.

Definition at line 424 of file ps2.c.

References ERR, errno, ETIMEDOUT, port_inb(), PS2_PORT_STATUS, PS2_WAIT_TIMEOUT, startTime, and timer_uptime().

Modules

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ PS2_CMD [1/2]

◆ PS2_CMD [2/2]

◆ PS2_CMD_AND_READ [1/2]

◆ PS2_CMD_AND_READ [2/2]

◆ PS2_CMD_AND_WRITE [1/2]

◆ PS2_CMD_AND_WRITE [2/2]

◆ PS2_COMMAND_RETRIES [1/2]

◆ PS2_COMMAND_RETRIES [2/2]

◆ PS2_DEV_CMD [1/2]

◆ PS2_DEV_CMD [2/2]

◆ PS2_DEV_CMD_AND_READ [1/2]

◆ PS2_DEV_CMD_AND_READ [2/2]

◆ PS2_DEV_SUB_CMD [1/2]

◆ PS2_DEV_SUB_CMD [2/2]

◆ PS2_LARGE_DELAY [1/2]

◆ PS2_LARGE_DELAY [2/2]

◆ PS2_READ [1/2]

◆ PS2_READ [2/2]

◆ PS2_SMALL_DELAY [1/2]

◆ PS2_SMALL_DELAY [2/2]

◆ PS2_WAIT_TIMEOUT [1/2]

◆ PS2_WAIT_TIMEOUT [2/2]

◆ PS2_WRITE [1/2]

◆ PS2_WRITE [2/2]

Enumeration Type Documentation

◆ ps2_cmd_t [1/2]

◆ ps2_cmd_t [2/2]

◆ ps2_config_bits_t [1/2]

◆ ps2_config_bits_t [2/2]

◆ ps2_device_cmd_t [1/2]

◆ ps2_device_cmd_t [2/2]

◆ ps2_device_response_t [1/2]

◆ ps2_device_response_t [2/2]

◆ ps2_device_t [1/2]

◆ ps2_device_t [2/2]

◆ ps2_device_test_response_t [1/2]

◆ ps2_device_test_response_t [2/2]

◆ ps2_device_type_t [1/2]

◆ ps2_device_type_t [2/2]

◆ ps2_port_t [1/2]

◆ ps2_port_t [2/2]

◆ ps2_self_test_response_t [1/2]

◆ ps2_self_test_response_t [2/2]

◆ ps2_status_bits_t [1/2]

◆ ps2_status_bits_t [2/2]

Function Documentation

◆ ps2_drain()

◆ ps2_init()

◆ ps2_send_cmd()

◆ ps2_send_device_cmd()

◆ ps2_wait_until_clear()

◆ ps2_wait_until_set()