d69249f4b6
Make sure that polled input device and matrix keypad APIs are included with the rest of input API when generating kernel documentation. Also description of absres was missing as well. Signed-off-by: Dmitry Torokhov <dtor@mail.ru>
102 lines
3.2 KiB
C
102 lines
3.2 KiB
C
#ifndef _MATRIX_KEYPAD_H
|
|
#define _MATRIX_KEYPAD_H
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/input.h>
|
|
|
|
#define MATRIX_MAX_ROWS 16
|
|
#define MATRIX_MAX_COLS 16
|
|
|
|
#define KEY(row, col, val) ((((row) & (MATRIX_MAX_ROWS - 1)) << 24) |\
|
|
(((col) & (MATRIX_MAX_COLS - 1)) << 16) |\
|
|
(val & 0xffff))
|
|
|
|
#define KEY_ROW(k) (((k) >> 24) & 0xff)
|
|
#define KEY_COL(k) (((k) >> 16) & 0xff)
|
|
#define KEY_VAL(k) ((k) & 0xffff)
|
|
|
|
#define MATRIX_SCAN_CODE(row, col, row_shift) (((row) << (row_shift)) + (col))
|
|
|
|
/**
|
|
* struct matrix_keymap_data - keymap for matrix keyboards
|
|
* @keymap: pointer to array of uint32 values encoded with KEY() macro
|
|
* representing keymap
|
|
* @keymap_size: number of entries (initialized) in this keymap
|
|
*
|
|
* This structure is supposed to be used by platform code to supply
|
|
* keymaps to drivers that implement matrix-like keypads/keyboards.
|
|
*/
|
|
struct matrix_keymap_data {
|
|
const uint32_t *keymap;
|
|
unsigned int keymap_size;
|
|
};
|
|
|
|
/**
|
|
* struct matrix_keypad_platform_data - platform-dependent keypad data
|
|
* @keymap_data: pointer to &matrix_keymap_data
|
|
* @row_gpios: pointer to array of gpio numbers representing rows
|
|
* @col_gpios: pointer to array of gpio numbers reporesenting colums
|
|
* @num_row_gpios: actual number of row gpios used by device
|
|
* @num_col_gpios: actual number of col gpios used by device
|
|
* @col_scan_delay_us: delay, measured in microseconds, that is
|
|
* needed before we can keypad after activating column gpio
|
|
* @debounce_ms: debounce interval in milliseconds
|
|
* @active_low: gpio polarity
|
|
* @wakeup: controls whether the device should be set up as wakeup
|
|
* source
|
|
*
|
|
* This structure represents platform-specific data that use used by
|
|
* matrix_keypad driver to perform proper initialization.
|
|
*/
|
|
struct matrix_keypad_platform_data {
|
|
const struct matrix_keymap_data *keymap_data;
|
|
|
|
const unsigned int *row_gpios;
|
|
const unsigned int *col_gpios;
|
|
|
|
unsigned int num_row_gpios;
|
|
unsigned int num_col_gpios;
|
|
|
|
unsigned int col_scan_delay_us;
|
|
|
|
/* key debounce interval in milli-second */
|
|
unsigned int debounce_ms;
|
|
|
|
bool active_low;
|
|
bool wakeup;
|
|
};
|
|
|
|
/**
|
|
* matrix_keypad_build_keymap - convert platform keymap into matrix keymap
|
|
* @keymap_data: keymap supplied by the platform code
|
|
* @row_shift: number of bits to shift row value by to advance to the next
|
|
* line in the keymap
|
|
* @keymap: expanded version of keymap that is suitable for use by
|
|
* matrix keyboad driver
|
|
* @keybit: pointer to bitmap of keys supported by input device
|
|
*
|
|
* This function converts platform keymap (encoded with KEY() macro) into
|
|
* an array of keycodes that is suitable for using in a standard matrix
|
|
* keyboard driver that uses row and col as indices.
|
|
*/
|
|
static inline void
|
|
matrix_keypad_build_keymap(const struct matrix_keymap_data *keymap_data,
|
|
unsigned int row_shift,
|
|
unsigned short *keymap, unsigned long *keybit)
|
|
{
|
|
int i;
|
|
|
|
for (i = 0; i < keymap_data->keymap_size; i++) {
|
|
unsigned int key = keymap_data->keymap[i];
|
|
unsigned int row = KEY_ROW(key);
|
|
unsigned int col = KEY_COL(key);
|
|
unsigned short code = KEY_VAL(key);
|
|
|
|
keymap[MATRIX_SCAN_CODE(row, col, row_shift)] = code;
|
|
__set_bit(code, keybit);
|
|
}
|
|
__clear_bit(KEY_RESERVED, keybit);
|
|
}
|
|
|
|
#endif /* _MATRIX_KEYPAD_H */
|