[linux-2.6-block.git] / include / linux / input / matrix_keypad.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _MATRIX_KEYPAD_H
#define _MATRIX_KEYPAD_H

#include <linux/types.h>
#include <linux/input.h>
#include <linux/of.h>

#define MATRIX_MAX_ROWS		32
#define MATRIX_MAX_COLS		32

#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
 * @clustered_irq: may be specified if interrupts of all row/column GPIOs
 *	are bundled to one single irq
 * @clustered_irq_flags: flags that are needed for the clustered irq
 * @active_low: gpio polarity
 * @wakeup: controls whether the device should be set up as wakeup
 *	source
 * @no_autorepeat: disable key autorepeat
 * @drive_inactive_cols: drive inactive columns during scan, rather than
 *	making them inputs.
 *
 * 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;

	unsigned int	clustered_irq;
	unsigned int	clustered_irq_flags;

	bool		active_low;
	bool		wakeup;
	bool		no_autorepeat;
	bool		drive_inactive_cols;
};

int matrix_keypad_build_keymap(const struct matrix_keymap_data *keymap_data,
			       const char *keymap_name,
			       unsigned int rows, unsigned int cols,
			       unsigned short *keymap,
			       struct input_dev *input_dev);
int matrix_keypad_parse_properties(struct device *dev,
				   unsigned int *rows, unsigned int *cols);

#define matrix_keypad_parse_of_params matrix_keypad_parse_properties

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