2 * Helpers for matrix keyboard bindings
4 * Copyright (C) 2012 Google, Inc
7 * Olof Johansson <olof@lixom.net>
9 * This software is licensed under the terms of the GNU General Public
10 * License version 2, as published by the Free Software Foundation, and
11 * may be copied, distributed, and modified under those terms.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
20 #include <linux/device.h>
21 #include <linux/kernel.h>
22 #include <linux/types.h>
23 #include <linux/input.h>
25 #include <linux/export.h>
26 #include <linux/module.h>
27 #include <linux/input/matrix_keypad.h>
29 static bool matrix_keypad_map_key(struct input_dev *input_dev,
30 unsigned int rows, unsigned int cols,
31 unsigned int row_shift, unsigned int key)
33 unsigned short *keymap = input_dev->keycode;
34 unsigned int row = KEY_ROW(key);
35 unsigned int col = KEY_COL(key);
36 unsigned short code = KEY_VAL(key);
38 if (row >= rows || col >= cols) {
39 dev_err(input_dev->dev.parent,
40 "%s: invalid keymap entry 0x%x (row: %d, col: %d, rows: %d, cols: %d)\n",
41 __func__, key, row, col, rows, cols);
45 keymap[MATRIX_SCAN_CODE(row, col, row_shift)] = code;
46 __set_bit(code, input_dev->keybit);
52 static int matrix_keypad_parse_of_keymap(const char *propname,
53 unsigned int rows, unsigned int cols,
54 struct input_dev *input_dev)
56 struct device *dev = input_dev->dev.parent;
57 struct device_node *np = dev->of_node;
58 unsigned int row_shift = get_count_order(cols);
59 unsigned int max_keys = rows << row_shift;
60 unsigned int proplen, i, size;
67 propname = "linux,keymap";
69 prop = of_get_property(np, propname, &proplen);
71 dev_err(dev, "OF: %s property not defined in %s\n",
72 propname, np->full_name);
76 if (proplen % sizeof(u32)) {
77 dev_err(dev, "OF: Malformed keycode property %s in %s\n",
78 propname, np->full_name);
82 size = proplen / sizeof(u32);
83 if (size > max_keys) {
84 dev_err(dev, "OF: %s size overflow\n", propname);
88 for (i = 0; i < size; i++) {
89 unsigned int key = be32_to_cpup(prop + i);
91 if (!matrix_keypad_map_key(input_dev, rows, cols,
99 static int matrix_keypad_parse_of_keymap(const char *propname,
100 unsigned int rows, unsigned int cols,
101 struct input_dev *input_dev)
108 * matrix_keypad_build_keymap - convert platform keymap into matrix keymap
109 * @keymap_data: keymap supplied by the platform code
110 * @keymap_name: name of device tree property containing keymap (if device
111 * tree support is enabled).
112 * @rows: number of rows in target keymap array
113 * @cols: number of cols in target keymap array
114 * @keymap: expanded version of keymap that is suitable for use by
115 * matrix keyboard driver
116 * @input_dev: input devices for which we are setting up the keymap
118 * This function converts platform keymap (encoded with KEY() macro) into
119 * an array of keycodes that is suitable for using in a standard matrix
120 * keyboard driver that uses row and col as indices.
122 * If @keymap_data is not supplied and device tree support is enabled
123 * it will attempt load the keymap from property specified by @keymap_name
124 * argument (or "linux,keymap" if @keymap_name is %NULL).
126 * Callers are expected to set up input_dev->dev.parent before calling this
129 int matrix_keypad_build_keymap(const struct matrix_keymap_data *keymap_data,
130 const char *keymap_name,
131 unsigned int rows, unsigned int cols,
132 unsigned short *keymap,
133 struct input_dev *input_dev)
135 unsigned int row_shift = get_count_order(cols);
139 input_dev->keycode = keymap;
140 input_dev->keycodesize = sizeof(*keymap);
141 input_dev->keycodemax = rows << row_shift;
143 __set_bit(EV_KEY, input_dev->evbit);
146 for (i = 0; i < keymap_data->keymap_size; i++) {
147 unsigned int key = keymap_data->keymap[i];
149 if (!matrix_keypad_map_key(input_dev, rows, cols,
154 error = matrix_keypad_parse_of_keymap(keymap_name, rows, cols,
160 __clear_bit(KEY_RESERVED, input_dev->keybit);
164 EXPORT_SYMBOL(matrix_keypad_build_keymap);
166 MODULE_LICENSE("GPL");