19bc590e5SSimon Glass /* 29bc590e5SSimon Glass * Keyboard input helper functions (too small to be called a layer) 39bc590e5SSimon Glass * 49bc590e5SSimon Glass * Copyright (c) 2011 The Chromium OS Authors. 59bc590e5SSimon Glass * 61a459660SWolfgang Denk * SPDX-License-Identifier: GPL-2.0+ 79bc590e5SSimon Glass */ 89bc590e5SSimon Glass 99bc590e5SSimon Glass #ifndef _INPUT_H 109bc590e5SSimon Glass #define _INPUT_H 119bc590e5SSimon Glass 129bc590e5SSimon Glass enum { 139bc590e5SSimon Glass INPUT_MAX_MODIFIERS = 4, 149bc590e5SSimon Glass INPUT_BUFFER_LEN = 16, 159bc590e5SSimon Glass }; 169bc590e5SSimon Glass 179bc590e5SSimon Glass enum { 189bc590e5SSimon Glass /* Keyboard LEDs */ 199bc590e5SSimon Glass INPUT_LED_SCROLL = 1 << 0, 209bc590e5SSimon Glass INPUT_LED_CAPS = 1 << 1, 219bc590e5SSimon Glass INPUT_LED_NUM = 1 << 2, 229bc590e5SSimon Glass }; 239bc590e5SSimon Glass 249bc590e5SSimon Glass /* 259bc590e5SSimon Glass * This table translates key codes to ASCII. Most of the entries are ASCII 269bc590e5SSimon Glass * codes, but entries after KEY_FIRST_MOD indicate that this key is a 279bc590e5SSimon Glass * modifier key, like shift, ctrl. KEY_FIRST_MOD + MOD_SHIFT is the shift 289bc590e5SSimon Glass * key, for example. 299bc590e5SSimon Glass */ 309bc590e5SSimon Glass struct input_key_xlate { 319bc590e5SSimon Glass /* keycode of the modifiers which select this table, -1 if none */ 329bc590e5SSimon Glass int left_keycode; 339bc590e5SSimon Glass int right_keycode; 349bc590e5SSimon Glass const uchar *xlate; /* keycode to ASCII table */ 359bc590e5SSimon Glass int num_entries; /* number of entries in this table */ 369bc590e5SSimon Glass }; 379bc590e5SSimon Glass 389bc590e5SSimon Glass struct input_config { 39c9cac4cdSSimon Glass struct udevice *dev; 409bc590e5SSimon Glass uchar fifo[INPUT_BUFFER_LEN]; 419bc590e5SSimon Glass int fifo_in, fifo_out; 429bc590e5SSimon Glass 439bc590e5SSimon Glass /* Which modifiers are active (1 bit for each MOD_... value) */ 449bc590e5SSimon Glass uchar modifiers; 459bc590e5SSimon Glass uchar flags; /* active state keys (FLAGS_...) */ 46*3b5f6f50SSimon Glass uchar leds; /* active LEDs (INPUT_LED_...) */ 47*3b5f6f50SSimon Glass uchar leds_changed; /* LEDs that just changed */ 489bc590e5SSimon Glass uchar num_tables; /* number of modifier tables */ 499bc590e5SSimon Glass int prev_keycodes[INPUT_BUFFER_LEN]; /* keys held last time */ 509bc590e5SSimon Glass int num_prev_keycodes; /* number of prev keys */ 519bc590e5SSimon Glass struct input_key_xlate table[INPUT_MAX_MODIFIERS]; 529bc590e5SSimon Glass 539bc590e5SSimon Glass /** 549bc590e5SSimon Glass * Function the input helper calls to scan the keyboard 559bc590e5SSimon Glass * 569bc590e5SSimon Glass * @param config Input state 579bc590e5SSimon Glass * @return 0 if no keys read, otherwise number of keys read, or 1 if 589bc590e5SSimon Glass * unknown 599bc590e5SSimon Glass */ 609bc590e5SSimon Glass int (*read_keys)(struct input_config *config); 610b186c08SSimon Glass bool allow_repeats; /* Don't filter out repeats */ 629bc590e5SSimon Glass unsigned int next_repeat_ms; /* Next time we repeat a key */ 639bc590e5SSimon Glass unsigned int repeat_delay_ms; /* Time before autorepeat starts */ 649bc590e5SSimon Glass unsigned int repeat_rate_ms; /* Autorepeat rate in ms */ 659bc590e5SSimon Glass }; 669bc590e5SSimon Glass 679bc590e5SSimon Glass struct stdio_dev; 689bc590e5SSimon Glass 699bc590e5SSimon Glass /** 709bc590e5SSimon Glass * Convert a list of key codes into ASCII and send them 719bc590e5SSimon Glass * 729bc590e5SSimon Glass * @param config Input state 739bc590e5SSimon Glass * @param keycode List of key codes to examine 749bc590e5SSimon Glass * @param num_keycodes Number of key codes 7544abe47dSHung-Te Lin * @return number of ascii characters sent, or 0 if none, or -1 for an 7644abe47dSHung-Te Lin * internal error 779bc590e5SSimon Glass */ 789bc590e5SSimon Glass int input_send_keycodes(struct input_config *config, int keycode[], int count); 799bc590e5SSimon Glass 809bc590e5SSimon Glass /** 813a85e436SSimon Glass * Add a new keycode to an existing list of keycodes 823a85e436SSimon Glass * 833a85e436SSimon Glass * This can be used to handle keyboards which do their own scanning. An 843a85e436SSimon Glass * internal list of depressed keys is maintained by the input library. Then 853a85e436SSimon Glass * this function is called to add a new key to the list (when a 'make code' is 863a85e436SSimon Glass * received), or remove a key (when a 'break code' is received). 873a85e436SSimon Glass * 883a85e436SSimon Glass * This function looks after maintenance of the list of active keys, and calls 893a85e436SSimon Glass * input_send_keycodes() with its updated list. 903a85e436SSimon Glass * 913a85e436SSimon Glass * @param config Input state 923a85e436SSimon Glass * @param new_keycode New keycode to add/remove 933a85e436SSimon Glass * @param release true if this key was released, false if depressed 943a85e436SSimon Glass * @return number of ascii characters sent, or 0 if none, or -1 for an 953a85e436SSimon Glass * internal error 963a85e436SSimon Glass */ 973a85e436SSimon Glass int input_add_keycode(struct input_config *config, int new_keycode, 983a85e436SSimon Glass bool release); 993a85e436SSimon Glass 1003a85e436SSimon Glass /** 1019bc590e5SSimon Glass * Add a new key translation table to the input 1029bc590e5SSimon Glass * 1039bc590e5SSimon Glass * @param config Input state 1049bc590e5SSimon Glass * @param left_keycode Key to hold to get into this table 1059bc590e5SSimon Glass * @param right_keycode Another key to hold to get into this table 1069bc590e5SSimon Glass * @param xlate Conversion table from key codes to ASCII 1079bc590e5SSimon Glass * @param num_entries Number of entries in xlate table 1089bc590e5SSimon Glass */ 1099bc590e5SSimon Glass int input_add_table(struct input_config *config, int left_keycode, 1109bc590e5SSimon Glass int right_keycode, const uchar *xlate, int num_entries); 1119bc590e5SSimon Glass 1129bc590e5SSimon Glass /** 1139bc590e5SSimon Glass * Test if keys are available to be read 1149bc590e5SSimon Glass * 1159bc590e5SSimon Glass * @param config Input state 1169bc590e5SSimon Glass * @return 0 if no keys available, 1 if keys are available 1179bc590e5SSimon Glass */ 1189bc590e5SSimon Glass int input_tstc(struct input_config *config); 1199bc590e5SSimon Glass 1209bc590e5SSimon Glass /** 1219bc590e5SSimon Glass * Read a key 1229bc590e5SSimon Glass * 1239bc590e5SSimon Glass * TODO: U-Boot wants 0 for no key, but Ctrl-@ is a valid key... 1249bc590e5SSimon Glass * 1259bc590e5SSimon Glass * @param config Input state 1269bc590e5SSimon Glass * @return key, or 0 if no key, or -1 if error 1279bc590e5SSimon Glass */ 1289bc590e5SSimon Glass int input_getc(struct input_config *config); 1299bc590e5SSimon Glass 1309bc590e5SSimon Glass /** 1319bc590e5SSimon Glass * Register a new device with stdio and switch to it if wanted 1329bc590e5SSimon Glass * 1339bc590e5SSimon Glass * @param dev Pointer to device 1349bc590e5SSimon Glass * @return 0 if ok, -1 on error 1359bc590e5SSimon Glass */ 1369bc590e5SSimon Glass int input_stdio_register(struct stdio_dev *dev); 1379bc590e5SSimon Glass 1389bc590e5SSimon Glass /** 1391b1d3e64SSimon Glass * Set up the keyboard autorepeat delays 1401b1d3e64SSimon Glass * 1411b1d3e64SSimon Glass * @param repeat_delay_ms Delay before key auto-repeat starts (in ms) 1421b1d3e64SSimon Glass * @param repeat_rate_ms Delay between successive key repeats (in ms) 1431b1d3e64SSimon Glass */ 1441b1d3e64SSimon Glass void input_set_delays(struct input_config *config, int repeat_delay_ms, 1451b1d3e64SSimon Glass int repeat_rate_ms); 1461b1d3e64SSimon Glass 1471b1d3e64SSimon Glass /** 1480b186c08SSimon Glass * Tell the input layer whether to allow the caller to determine repeats 1490b186c08SSimon Glass * 1500b186c08SSimon Glass * Generally the input library handles processing of a list of scanned keys. 1510b186c08SSimon Glass * Repeated keys need to be generated based on a timer in this case, since all 1520b186c08SSimon Glass * that is provided is a list of keys current depressed. 1530b186c08SSimon Glass * 1540b186c08SSimon Glass * Keyboards which do their own scanning will resend codes when they want to 1550b186c08SSimon Glass * inject a repeating key. This function can be called at start-up to select 1560b186c08SSimon Glass * this behaviour. 1570b186c08SSimon Glass * 1580b186c08SSimon Glass * @param config Input state 1590b186c08SSimon Glass * @param allow_repeats true to repeat depressed keys every time 1600b186c08SSimon Glass * input_send_keycodes() is called, false to do normal 1610b186c08SSimon Glass * keyboard repeat processing with a timer. 1620b186c08SSimon Glass */ 1630b186c08SSimon Glass void input_allow_repeats(struct input_config *config, bool allow_repeats); 1640b186c08SSimon Glass 1650b186c08SSimon Glass /** 166*3b5f6f50SSimon Glass * Check if keyboard LEDs need to be updated 167*3b5f6f50SSimon Glass * 168*3b5f6f50SSimon Glass * This can be called after input_tstc() to see if keyboard LEDs need 169*3b5f6f50SSimon Glass * updating. 170*3b5f6f50SSimon Glass * 171*3b5f6f50SSimon Glass * @param config Input state 172*3b5f6f50SSimon Glass * @return -1 if no LEDs need updating, other value if they do 173*3b5f6f50SSimon Glass */ 174*3b5f6f50SSimon Glass int input_leds_changed(struct input_config *config); 175*3b5f6f50SSimon Glass 176*3b5f6f50SSimon Glass /** 17766877b0fSSimon Glass * Set up the key map tables 17866877b0fSSimon Glass * 17966877b0fSSimon Glass * This must be called after input_init() or keycode decoding will not work. 18066877b0fSSimon Glass * 18166877b0fSSimon Glass * @param config Input state 182b1d7a187SSimon Glass * @param german true to use German keyboard layout, false for US 18366877b0fSSimon Glass * @return 0 if ok, -1 on error 18466877b0fSSimon Glass */ 185b1d7a187SSimon Glass int input_add_tables(struct input_config *config, bool german); 18666877b0fSSimon Glass 18766877b0fSSimon Glass /** 1889bc590e5SSimon Glass * Set up the input handler with basic key maps. 1899bc590e5SSimon Glass * 1909bc590e5SSimon Glass * @param config Input state 1919bc590e5SSimon Glass * @param leds Initial LED value (INPUT_LED_ mask), 0 suggested 1929bc590e5SSimon Glass * @return 0 if ok, -1 on error 1939bc590e5SSimon Glass */ 1941b1d3e64SSimon Glass int input_init(struct input_config *config, int leds); 1959bc590e5SSimon Glass 1969bc590e5SSimon Glass #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 1979bc590e5SSimon Glass extern int overwrite_console(void); 1989bc590e5SSimon Glass #define OVERWRITE_CONSOLE overwrite_console() 1999bc590e5SSimon Glass #else 2009bc590e5SSimon Glass #define OVERWRITE_CONSOLE 0 2019bc590e5SSimon Glass #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */ 2029bc590e5SSimon Glass 2039bc590e5SSimon Glass #endif 204