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

#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
 *
 * 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;
};

#endif /* _MATRIX_KEYPAD_H */
Commit	Line	Data
bab7614d EM	1	#ifndef _MATRIX_KEYPAD_H
	2	#define _MATRIX_KEYPAD_H
	3
	4	#include <linux/types.h>
	5	#include <linux/input.h>
	6
	7	#define MATRIX_MAX_ROWS 16
	8	#define MATRIX_MAX_COLS 16
	9
	10	#define KEY(row, col, val) ((((row) & (MATRIX_MAX_ROWS - 1)) << 24) \|\
	11	(((col) & (MATRIX_MAX_COLS - 1)) << 16) \|\
	12	(val & 0xffff))
	13
	14	#define KEY_ROW(k) (((k) >> 24) & 0xff)
	15	#define KEY_COL(k) (((k) >> 16) & 0xff)
	16	#define KEY_VAL(k) ((k) & 0xffff)
	17
d82f1c35 EM	18	#define MATRIX_SCAN_CODE(row, col, row_shift) (((row) << (row_shift)) + (col))
d82f1c35 EM	19
bab7614d EM	20	/**
	21	* struct matrix_keymap_data - keymap for matrix keyboards
	22	* @keymap: pointer to array of uint32 values encoded with KEY() macro
	23	* representing keymap
	24	* @keymap_size: number of entries (initialized) in this keymap
bab7614d EM	25	*
	26	* This structure is supposed to be used by platform code to supply
	27	* keymaps to drivers that implement matrix-like keypads/keyboards.
	28	*/
	29	struct matrix_keymap_data {
	30	const uint32_t *keymap;
	31	unsigned int keymap_size;
bab7614d EM	32	};
	33
	34	/**
	35	* struct matrix_keypad_platform_data - platform-dependent keypad data
	36	* @keymap_data: pointer to &matrix_keymap_data
d82f1c35 EM	37	* @row_gpios: pointer to array of gpio numbers representing rows
d82f1c35 EM	38	* @col_gpios: pointer to array of gpio numbers reporesenting colums
bab7614d EM	39	* @num_row_gpios: actual number of row gpios used by device
	40	* @num_col_gpios: actual number of col gpios used by device
	41	* @col_scan_delay_us: delay, measured in microseconds, that is
	42	* needed before we can keypad after activating column gpio
	43	* @debounce_ms: debounce interval in milliseconds
	44	*
	45	* This structure represents platform-specific data that use used by
	46	* matrix_keypad driver to perform proper initialization.
	47	*/
	48	struct matrix_keypad_platform_data {
	49	const struct matrix_keymap_data *keymap_data;
	50
d82f1c35 EM	51	const unsigned int *row_gpios;
	52	const unsigned int *col_gpios;
	53
bab7614d EM	54	unsigned int num_row_gpios;
	55	unsigned int num_col_gpios;
	56
	57	unsigned int col_scan_delay_us;
	58
	59	/* key debounce interval in milli-second */
	60	unsigned int debounce_ms;
	61
	62	bool active_low;
	63	bool wakeup;
	64	};
	65
	66	#endif /* _MATRIX_KEYPAD_H */