]>
git.ipfire.org Git - people/ms/u-boot.git/blob - include/input.h
2 * Keyboard input helper functions (too small to be called a layer)
4 * Copyright (c) 2011 The Chromium OS Authors.
6 * SPDX-License-Identifier: GPL-2.0+
13 INPUT_MAX_MODIFIERS
= 4,
14 INPUT_BUFFER_LEN
= 16,
19 INPUT_LED_SCROLL
= 1 << 0,
20 INPUT_LED_NUM
= 1 << 1,
21 INPUT_LED_CAPS
= 1 << 2,
25 * This table translates key codes to ASCII. Most of the entries are ASCII
26 * codes, but entries after KEY_FIRST_MOD indicate that this key is a
27 * modifier key, like shift, ctrl. KEY_FIRST_MOD + MOD_SHIFT is the shift
30 struct input_key_xlate
{
31 /* keycode of the modifiers which select this table, -1 if none */
34 const uchar
*xlate
; /* keycode to ASCII table */
35 int num_entries
; /* number of entries in this table */
40 uchar fifo
[INPUT_BUFFER_LEN
];
41 int fifo_in
, fifo_out
;
43 /* Which modifiers are active (1 bit for each MOD_... value) */
45 uchar flags
; /* active state keys (FLAGS_...) */
46 uchar leds
; /* active LEDs (INPUT_LED_...) */
47 uchar leds_changed
; /* LEDs that just changed */
48 uchar num_tables
; /* number of modifier tables */
49 int prev_keycodes
[INPUT_BUFFER_LEN
]; /* keys held last time */
50 int num_prev_keycodes
; /* number of prev keys */
51 struct input_key_xlate table
[INPUT_MAX_MODIFIERS
];
54 * Function the input helper calls to scan the keyboard
56 * @param config Input state
57 * @return 0 if no keys read, otherwise number of keys read, or 1 if
60 int (*read_keys
)(struct input_config
*config
);
61 bool allow_repeats
; /* Don't filter out repeats */
62 unsigned int next_repeat_ms
; /* Next time we repeat a key */
63 unsigned int repeat_delay_ms
; /* Time before autorepeat starts */
64 unsigned int repeat_rate_ms
; /* Autorepeat rate in ms */
70 * Convert a list of key codes into ASCII and send them
72 * @param config Input state
73 * @param keycode List of key codes to examine
74 * @param num_keycodes Number of key codes
75 * @return number of ascii characters sent, or 0 if none, or -1 for an
78 int input_send_keycodes(struct input_config
*config
, int keycode
[], int count
);
81 * Add a new keycode to an existing list of keycodes
83 * This can be used to handle keyboards which do their own scanning. An
84 * internal list of depressed keys is maintained by the input library. Then
85 * this function is called to add a new key to the list (when a 'make code' is
86 * received), or remove a key (when a 'break code' is received).
88 * This function looks after maintenance of the list of active keys, and calls
89 * input_send_keycodes() with its updated list.
91 * @param config Input state
92 * @param new_keycode New keycode to add/remove
93 * @param release true if this key was released, false if depressed
94 * @return number of ascii characters sent, or 0 if none, or -1 for an
97 int input_add_keycode(struct input_config
*config
, int new_keycode
,
101 * Add a new key translation table to the input
103 * @param config Input state
104 * @param left_keycode Key to hold to get into this table
105 * @param right_keycode Another key to hold to get into this table
106 * @param xlate Conversion table from key codes to ASCII
107 * @param num_entries Number of entries in xlate table
109 int input_add_table(struct input_config
*config
, int left_keycode
,
110 int right_keycode
, const uchar
*xlate
, int num_entries
);
113 * Test if keys are available to be read
115 * @param config Input state
116 * @return 0 if no keys available, 1 if keys are available
118 int input_tstc(struct input_config
*config
);
123 * TODO: U-Boot wants 0 for no key, but Ctrl-@ is a valid key...
125 * @param config Input state
126 * @return key, or 0 if no key, or -1 if error
128 int input_getc(struct input_config
*config
);
131 * Register a new device with stdio and switch to it if wanted
133 * @param dev Pointer to device
134 * @return 0 if ok, -1 on error
136 int input_stdio_register(struct stdio_dev
*dev
);
139 * Set up the keyboard autorepeat delays
141 * @param repeat_delay_ms Delay before key auto-repeat starts (in ms)
142 * @param repeat_rate_ms Delay between successive key repeats (in ms)
144 void input_set_delays(struct input_config
*config
, int repeat_delay_ms
,
148 * Tell the input layer whether to allow the caller to determine repeats
150 * Generally the input library handles processing of a list of scanned keys.
151 * Repeated keys need to be generated based on a timer in this case, since all
152 * that is provided is a list of keys current depressed.
154 * Keyboards which do their own scanning will resend codes when they want to
155 * inject a repeating key. This function can be called at start-up to select
158 * @param config Input state
159 * @param allow_repeats true to repeat depressed keys every time
160 * input_send_keycodes() is called, false to do normal
161 * keyboard repeat processing with a timer.
163 void input_allow_repeats(struct input_config
*config
, bool allow_repeats
);
166 * Check if keyboard LEDs need to be updated
168 * This can be called after input_tstc() to see if keyboard LEDs need
171 * @param config Input state
172 * @return -1 if no LEDs need updating, other value if they do
174 int input_leds_changed(struct input_config
*config
);
177 * Set up the key map tables
179 * This must be called after input_init() or keycode decoding will not work.
181 * @param config Input state
182 * @param german true to use German keyboard layout, false for US
183 * @return 0 if ok, -1 on error
185 int input_add_tables(struct input_config
*config
, bool german
);
188 * Set up the input handler with basic key maps.
190 * @param config Input state
191 * @param leds Initial LED value (INPUT_LED_ mask), 0 suggested
192 * @return 0 if ok, -1 on error
194 int input_init(struct input_config
*config
, int leds
);
196 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
197 extern int overwrite_console(void);
198 #define OVERWRITE_CONSOLE overwrite_console()
200 #define OVERWRITE_CONSOLE 0
201 #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */