Revision 58
more changes
| kbc.h | ||
|---|---|---|
| 1 |
#ifndef _KBC_H_ |
|
| 2 |
#define _KBC_H_ |
|
| 1 |
#ifndef _KBC_FUNC_H_
|
|
| 2 |
#define _KBC_FUNC_H_
|
|
| 3 | 3 |
|
| 4 |
/* KBC IRQ Line */
|
|
| 4 |
#include <stdint.h>
|
|
| 5 | 5 |
|
| 6 |
#define KBC_IRQ 1 /* @brief KBC Controller IRQ Line */
|
|
| 7 |
#define MOUSE_IRQ 12 /* @brief Mouse IRQ Line */
|
|
| 6 |
#define GET 0 /* @brief Argument to get counter without incrementing */
|
|
| 7 |
#define INCREMENT 1 /* @brief Argument for incrementing counter */
|
|
| 8 | 8 |
|
| 9 |
/* Delay for KBC */ |
|
| 10 |
#define DELAY 20000 /* @brief KBC Response Delay */ |
|
| 11 |
#define KBC_NUM_TRIES 10 /* @brief Number of tries to issue command before timeout */ |
|
| 9 |
/** |
|
| 10 |
* @brief Subscribes KBC Interrupts and disables Minix Default Keyboard IH |
|
| 11 |
* @param interrupt_bit Bit of Interrupt Vector that will be set when KBC Interrupt is pending |
|
| 12 |
* @param interrupt_id KBC Interrupt ID to specify the KBC Interrupt in other calls |
|
| 13 |
* @return Whether operation was sucessful or not |
|
| 14 |
*/ |
|
| 15 |
int (subscribe_kbc_interrupt)(uint8_t interrupt_bit, int *interrupt_id); |
|
| 12 | 16 |
|
| 13 |
/* I/O Ports Addresses */ |
|
| 17 |
/** |
|
| 18 |
* @brief Unsubcribes Interrupts |
|
| 19 |
* @param interrupt_id Interrupt ID, value via arguments on subscription of the interrupt_id |
|
| 20 |
* @see subscribe_kbc_interrupt, subscribe_timer_interrupt |
|
| 21 |
* @return Whether operation was sucessful or not |
|
| 22 |
*/ |
|
| 23 |
int (unsubscribe_interrupt)(int *interrupt_id); |
|
| 14 | 24 |
|
| 15 |
#define KBC_CMD 0x64 /* @brief Address to send commands to KBC */ |
|
| 16 |
#define KBC_CMD_ARG 0x60 /* @brief Address to write KBC Command Arguments */ |
|
| 17 |
#define STATUS_REG 0x64 /* @brief KBC Status Register address */ |
|
| 25 |
/** |
|
| 26 |
* @brief KBC Interrupt Handler |
|
| 27 |
*/ |
|
| 28 |
void (kbc_ih)(void); |
|
| 18 | 29 |
|
| 19 |
#define OUTPUT_BUF 0x60 /* @brief Address of Output Buffer of KBC */ |
|
| 30 |
/** |
|
| 31 |
* @brief High-level function that polls keyboard for scancode |
|
| 32 |
* High-level function that polls keyboard for scancode of up to 2 bytes. If |
|
| 33 |
* scancode has only 1 byte, the second byte is set to 0x00. |
|
| 34 |
* @param bytes Array of at least 2 bytes to store scancode |
|
| 35 |
* @param size Size of scancode in bytes |
|
| 36 |
* @return 0 if operation was successful, 1 otherwise |
|
| 37 |
*/ |
|
| 38 |
int (kbd_poll)(uint8_t bytes[], uint8_t *size); |
|
| 20 | 39 |
|
| 21 |
/* KBC Commands */ |
|
| 22 |
#define READ_KBC_CMD 0x20 /* @brief Read KBC Command Byte */ |
|
| 23 |
#define WRITE_KBC_CMD 0x60 /* @brief Write KBC Command Byte */ |
|
| 24 |
#define KBC_SELF_TEST 0xAA /* @brief KBC Diagnostic Tests */ |
|
| 25 |
#define KBC_INT_TEST 0xAB /* @brief Tests Keyboard Clock and Data lines */ |
|
| 26 |
#define KBC_INT_DISABLE 0xAD /* @brief Disable KBC Interface */ |
|
| 27 |
#define KBC_INT_ENABLE 0xAE /* @brief Enable KBC Interface */ |
|
| 28 |
#define MOUSE_DISABLE 0xA7 /* @brief Disable Mouse */ |
|
| 29 |
#define MOUSE_ENABLE 0xA8 /* @brief Enable Mouse */ |
|
| 30 |
#define MOUSE_INT_TEST 0xA9 /* @brief Tests Mouse data line */ |
|
| 31 |
#define MOUSE_WRITE_B 0xD4 /* @brief Write a byte directly to the mouse */ |
|
| 40 |
/** |
|
| 41 |
* @brief High-level function that reads the command byte of the KBC |
|
| 42 |
* @param cmd Pointer to variable where command byte read from KBC will be stored |
|
| 43 |
* @return 0 if operation was successful, 1 otherwise |
|
| 44 |
*/ |
|
| 45 |
int (kbc_read_cmd)(uint8_t *cmd); |
|
| 32 | 46 |
|
| 33 |
/* Status Byte Masking */ |
|
| 47 |
/** |
|
| 48 |
* @brief High-level function that changes the command byte of the KBC |
|
| 49 |
* @param cmd New value for command byte of KBC |
|
| 50 |
* @return 0 if operation was successful, 1 otherwise |
|
| 51 |
*/ |
|
| 52 |
int (kbc_change_cmd)(uint8_t cmd); |
|
| 34 | 53 |
|
| 35 |
#define OUT_BUF_FUL BIT(0) /* @brief Output Buffer State */
|
|
| 36 |
#define IN_BUF_FULL BIT(1) /* @brief Input Buffer State */
|
|
| 37 |
#define SYS_FLAG BIT(2) /* @brief System Flag */
|
|
| 38 |
#define DATA_CMD_WRITE BIT(3) /* @brief Identifier of type of byte in input buffer */
|
|
| 39 |
#define INH_FLAG BIT(4) /* @brief Keyboard inihibited */
|
|
| 40 |
#define AUX_MOUSE BIT(5) /* @brief Mouse Data */
|
|
| 41 |
#define TIME_OUT_REC BIT(6) /* @brief Time Out Error - Invalid Data */
|
|
| 42 |
#define PARITY_ERROR BIT(7) /* @brief Parity Error - Invalid Data */
|
|
| 54 |
/**
|
|
| 55 |
* @brief High-level function that restores KBC to normal state
|
|
| 56 |
* High-level function that restores KBC to normal state, because lcf_start
|
|
| 57 |
* changes the command byte of KBC. If this function is not used, there is a
|
|
| 58 |
* chance that the keyboard and keyboard interrupts remain disabled.
|
|
| 59 |
* @return 1 if operation was successful, 1 otherwise
|
|
| 60 |
*/ |
|
| 61 |
int (kbc_restore_kbd)();
|
|
| 43 | 62 |
|
| 44 |
/* Scancode Constants */ |
|
| 63 |
/** |
|
| 64 |
* @brief Low-level function to issue a command to keyboard |
|
| 65 |
* @param cmd command to be issued |
|
| 66 |
* @return 0 if operation was successful, 1 otherwise |
|
| 67 |
*/ |
|
| 68 |
int (kbc_issue_cmd)(uint8_t cmd); |
|
| 45 | 69 |
|
| 46 |
#define ESC_BREAK_CODE 0x81 /* @brief ESC Break Code */ |
|
| 47 |
#define TWO_BYTE_CODE 0xE0 /* @brief First byte of a two byte Scancode */ |
|
| 48 |
#define BREAK_CODE_BIT BIT(7) /* @brief Bit to distinguish between Make code and Break code */ |
|
| 70 |
/** |
|
| 71 |
* @brief Low-level function for reading byte from keyboard |
|
| 72 |
* Low-level function for reading byte from keyboard. Waits until output buffer |
|
| 73 |
* is full |
|
| 74 |
* @param value Pointer to variable where byte read from keyboard will be stored |
|
| 75 |
* @return 0 if operation was successful, 1 otherwise |
|
| 76 |
*/ |
|
| 77 |
int (kbc_read_byte)(uint8_t *byte); |
|
| 49 | 78 |
|
| 50 |
/* Command byte masks */ |
|
| 51 |
#define INT_KBD BIT(0) /* @brief Enable Keyboard Interrupts */ |
|
| 52 |
#define INT_MOU BIT(1) /* @brief Enable Mouse Interrupts */ |
|
| 53 |
#define DIS_KBD BIT(4) /* @brief Disable Keyboard */ |
|
| 54 |
#define DIS_MOU BIT(5) /* @brief Disable Mouse */ |
|
| 55 | 79 |
|
| 56 | 80 |
#endif |
Also available in: Unified diff