Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
bab7614d EM |
2 | #ifndef _MATRIX_KEYPAD_H |
3 | #define _MATRIX_KEYPAD_H | |
4 | ||
5 | #include <linux/types.h> | |
d5f7638e AS |
6 | |
7 | struct device; | |
8 | struct input_dev; | |
bab7614d | 9 | |
cfaea567 TS |
10 | #define MATRIX_MAX_ROWS 32 |
11 | #define MATRIX_MAX_COLS 32 | |
bab7614d EM |
12 | |
13 | #define KEY(row, col, val) ((((row) & (MATRIX_MAX_ROWS - 1)) << 24) |\ | |
14 | (((col) & (MATRIX_MAX_COLS - 1)) << 16) |\ | |
da1f026b | 15 | ((val) & 0xffff)) |
bab7614d EM |
16 | |
17 | #define KEY_ROW(k) (((k) >> 24) & 0xff) | |
18 | #define KEY_COL(k) (((k) >> 16) & 0xff) | |
19 | #define KEY_VAL(k) ((k) & 0xffff) | |
20 | ||
d82f1c35 EM |
21 | #define MATRIX_SCAN_CODE(row, col, row_shift) (((row) << (row_shift)) + (col)) |
22 | ||
bab7614d EM |
23 | /** |
24 | * struct matrix_keymap_data - keymap for matrix keyboards | |
25 | * @keymap: pointer to array of uint32 values encoded with KEY() macro | |
26 | * representing keymap | |
27 | * @keymap_size: number of entries (initialized) in this keymap | |
bab7614d EM |
28 | * |
29 | * This structure is supposed to be used by platform code to supply | |
30 | * keymaps to drivers that implement matrix-like keypads/keyboards. | |
31 | */ | |
32 | struct matrix_keymap_data { | |
33 | const uint32_t *keymap; | |
34 | unsigned int keymap_size; | |
bab7614d EM |
35 | }; |
36 | ||
37 | /** | |
38 | * struct matrix_keypad_platform_data - platform-dependent keypad data | |
39 | * @keymap_data: pointer to &matrix_keymap_data | |
d82f1c35 EM |
40 | * @row_gpios: pointer to array of gpio numbers representing rows |
41 | * @col_gpios: pointer to array of gpio numbers reporesenting colums | |
bab7614d EM |
42 | * @num_row_gpios: actual number of row gpios used by device |
43 | * @num_col_gpios: actual number of col gpios used by device | |
44 | * @col_scan_delay_us: delay, measured in microseconds, that is | |
45 | * needed before we can keypad after activating column gpio | |
46 | * @debounce_ms: debounce interval in milliseconds | |
fb76dd10 LF |
47 | * @clustered_irq: may be specified if interrupts of all row/column GPIOs |
48 | * are bundled to one single irq | |
49 | * @clustered_irq_flags: flags that are needed for the clustered irq | |
d69249f4 DT |
50 | * @active_low: gpio polarity |
51 | * @wakeup: controls whether the device should be set up as wakeup | |
52 | * source | |
9d32c305 | 53 | * @no_autorepeat: disable key autorepeat |
aa0e26bb DR |
54 | * @drive_inactive_cols: drive inactive columns during scan, rather than |
55 | * making them inputs. | |
bab7614d EM |
56 | * |
57 | * This structure represents platform-specific data that use used by | |
58 | * matrix_keypad driver to perform proper initialization. | |
59 | */ | |
60 | struct matrix_keypad_platform_data { | |
61 | const struct matrix_keymap_data *keymap_data; | |
62 | ||
d82f1c35 EM |
63 | const unsigned int *row_gpios; |
64 | const unsigned int *col_gpios; | |
65 | ||
bab7614d EM |
66 | unsigned int num_row_gpios; |
67 | unsigned int num_col_gpios; | |
68 | ||
69 | unsigned int col_scan_delay_us; | |
70 | ||
71 | /* key debounce interval in milli-second */ | |
72 | unsigned int debounce_ms; | |
73 | ||
fb76dd10 LF |
74 | unsigned int clustered_irq; |
75 | unsigned int clustered_irq_flags; | |
76 | ||
bab7614d EM |
77 | bool active_low; |
78 | bool wakeup; | |
9d32c305 | 79 | bool no_autorepeat; |
aa0e26bb | 80 | bool drive_inactive_cols; |
bab7614d EM |
81 | }; |
82 | ||
1932811f DT |
83 | int matrix_keypad_build_keymap(const struct matrix_keymap_data *keymap_data, |
84 | const char *keymap_name, | |
85 | unsigned int rows, unsigned int cols, | |
86 | unsigned short *keymap, | |
87 | struct input_dev *input_dev); | |
aef01aad DT |
88 | int matrix_keypad_parse_properties(struct device *dev, |
89 | unsigned int *rows, unsigned int *cols); | |
77a53fd2 | 90 | |
aef01aad | 91 | #define matrix_keypad_parse_of_params matrix_keypad_parse_properties |
43840415 | 92 | |
bab7614d | 93 | #endif /* _MATRIX_KEYPAD_H */ |