Dmitry Torokhov | 1932811 | 2012-05-10 22:37:08 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Helpers for matrix keyboard bindings |
| 3 | * |
| 4 | * Copyright (C) 2012 Google, Inc |
| 5 | * |
| 6 | * Author: |
| 7 | * Olof Johansson <olof@lixom.net> |
| 8 | * |
| 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. |
| 12 | * |
| 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. |
| 17 | * |
| 18 | */ |
| 19 | |
Dmitry Torokhov | b45c8f3 | 2012-05-10 22:37:15 -0700 | [diff] [blame] | 20 | #include <linux/device.h> |
Dmitry Torokhov | 5383116 | 2012-11-05 10:32:55 -0800 | [diff] [blame] | 21 | #include <linux/gfp.h> |
Dmitry Torokhov | 1932811 | 2012-05-10 22:37:08 -0700 | [diff] [blame] | 22 | #include <linux/kernel.h> |
| 23 | #include <linux/types.h> |
| 24 | #include <linux/input.h> |
| 25 | #include <linux/of.h> |
| 26 | #include <linux/export.h> |
Dmitry Torokhov | 1932811 | 2012-05-10 22:37:08 -0700 | [diff] [blame] | 27 | #include <linux/input/matrix_keypad.h> |
| 28 | |
Dmitry Torokhov | b45c8f3 | 2012-05-10 22:37:15 -0700 | [diff] [blame] | 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) |
| 32 | { |
Dmitry Torokhov | 8680917 | 2012-05-24 01:10:20 -0700 | [diff] [blame] | 33 | unsigned short *keymap = input_dev->keycode; |
Dmitry Torokhov | b45c8f3 | 2012-05-10 22:37:15 -0700 | [diff] [blame] | 34 | unsigned int row = KEY_ROW(key); |
| 35 | unsigned int col = KEY_COL(key); |
| 36 | unsigned short code = KEY_VAL(key); |
| 37 | |
| 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); |
| 42 | return false; |
| 43 | } |
| 44 | |
| 45 | keymap[MATRIX_SCAN_CODE(row, col, row_shift)] = code; |
| 46 | __set_bit(code, input_dev->keybit); |
| 47 | |
| 48 | return true; |
| 49 | } |
| 50 | |
| 51 | #ifdef CONFIG_OF |
| 52 | static int matrix_keypad_parse_of_keymap(const char *propname, |
| 53 | unsigned int rows, unsigned int cols, |
| 54 | struct input_dev *input_dev) |
| 55 | { |
| 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; |
| 61 | const __be32 *prop; |
| 62 | |
| 63 | if (!np) |
| 64 | return -ENOENT; |
| 65 | |
| 66 | if (!propname) |
| 67 | propname = "linux,keymap"; |
| 68 | |
| 69 | prop = of_get_property(np, propname, &proplen); |
| 70 | if (!prop) { |
| 71 | dev_err(dev, "OF: %s property not defined in %s\n", |
| 72 | propname, np->full_name); |
| 73 | return -ENOENT; |
| 74 | } |
| 75 | |
| 76 | if (proplen % sizeof(u32)) { |
| 77 | dev_err(dev, "OF: Malformed keycode property %s in %s\n", |
| 78 | propname, np->full_name); |
| 79 | return -EINVAL; |
| 80 | } |
| 81 | |
| 82 | size = proplen / sizeof(u32); |
| 83 | if (size > max_keys) { |
| 84 | dev_err(dev, "OF: %s size overflow\n", propname); |
| 85 | return -EINVAL; |
| 86 | } |
| 87 | |
| 88 | for (i = 0; i < size; i++) { |
| 89 | unsigned int key = be32_to_cpup(prop + i); |
| 90 | |
| 91 | if (!matrix_keypad_map_key(input_dev, rows, cols, |
| 92 | row_shift, key)) |
| 93 | return -EINVAL; |
| 94 | } |
| 95 | |
| 96 | return 0; |
| 97 | } |
| 98 | #else |
| 99 | static int matrix_keypad_parse_of_keymap(const char *propname, |
| 100 | unsigned int rows, unsigned int cols, |
| 101 | struct input_dev *input_dev) |
| 102 | { |
| 103 | return -ENOSYS; |
| 104 | } |
| 105 | #endif |
Dmitry Torokhov | 1932811 | 2012-05-10 22:37:08 -0700 | [diff] [blame] | 106 | |
| 107 | /** |
| 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 |
| 117 | * |
| 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. |
Dmitry Torokhov | b45c8f3 | 2012-05-10 22:37:15 -0700 | [diff] [blame] | 121 | * |
| 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). |
| 125 | * |
Dmitry Torokhov | 5383116 | 2012-11-05 10:32:55 -0800 | [diff] [blame] | 126 | * If @keymap is %NULL the function will automatically allocate managed |
| 127 | * block of memory to store the keymap. This memory will be associated with |
| 128 | * the parent device and automatically freed when device unbinds from the |
| 129 | * driver. |
| 130 | * |
Dmitry Torokhov | b45c8f3 | 2012-05-10 22:37:15 -0700 | [diff] [blame] | 131 | * Callers are expected to set up input_dev->dev.parent before calling this |
| 132 | * function. |
Dmitry Torokhov | 1932811 | 2012-05-10 22:37:08 -0700 | [diff] [blame] | 133 | */ |
| 134 | int matrix_keypad_build_keymap(const struct matrix_keymap_data *keymap_data, |
| 135 | const char *keymap_name, |
| 136 | unsigned int rows, unsigned int cols, |
| 137 | unsigned short *keymap, |
| 138 | struct input_dev *input_dev) |
| 139 | { |
| 140 | unsigned int row_shift = get_count_order(cols); |
Dmitry Torokhov | 5383116 | 2012-11-05 10:32:55 -0800 | [diff] [blame] | 141 | size_t max_keys = rows << row_shift; |
Dmitry Torokhov | 1932811 | 2012-05-10 22:37:08 -0700 | [diff] [blame] | 142 | int i; |
Dmitry Torokhov | b45c8f3 | 2012-05-10 22:37:15 -0700 | [diff] [blame] | 143 | int error; |
Dmitry Torokhov | 1932811 | 2012-05-10 22:37:08 -0700 | [diff] [blame] | 144 | |
Dmitry Torokhov | 5383116 | 2012-11-05 10:32:55 -0800 | [diff] [blame] | 145 | if (WARN_ON(!input_dev->dev.parent)) |
| 146 | return -EINVAL; |
| 147 | |
| 148 | if (!keymap) { |
| 149 | keymap = devm_kzalloc(input_dev->dev.parent, |
| 150 | max_keys * sizeof(*keymap), |
| 151 | GFP_KERNEL); |
| 152 | if (!keymap) { |
| 153 | dev_err(input_dev->dev.parent, |
| 154 | "Unable to allocate memory for keymap"); |
| 155 | return -ENOMEM; |
| 156 | } |
| 157 | } |
| 158 | |
Dmitry Torokhov | 1932811 | 2012-05-10 22:37:08 -0700 | [diff] [blame] | 159 | input_dev->keycode = keymap; |
| 160 | input_dev->keycodesize = sizeof(*keymap); |
Dmitry Torokhov | 5383116 | 2012-11-05 10:32:55 -0800 | [diff] [blame] | 161 | input_dev->keycodemax = max_keys; |
Dmitry Torokhov | 1932811 | 2012-05-10 22:37:08 -0700 | [diff] [blame] | 162 | |
| 163 | __set_bit(EV_KEY, input_dev->evbit); |
| 164 | |
Dmitry Torokhov | b45c8f3 | 2012-05-10 22:37:15 -0700 | [diff] [blame] | 165 | if (keymap_data) { |
| 166 | for (i = 0; i < keymap_data->keymap_size; i++) { |
| 167 | unsigned int key = keymap_data->keymap[i]; |
Dmitry Torokhov | 1932811 | 2012-05-10 22:37:08 -0700 | [diff] [blame] | 168 | |
Dmitry Torokhov | b45c8f3 | 2012-05-10 22:37:15 -0700 | [diff] [blame] | 169 | if (!matrix_keypad_map_key(input_dev, rows, cols, |
| 170 | row_shift, key)) |
| 171 | return -EINVAL; |
Dmitry Torokhov | 1932811 | 2012-05-10 22:37:08 -0700 | [diff] [blame] | 172 | } |
Dmitry Torokhov | b45c8f3 | 2012-05-10 22:37:15 -0700 | [diff] [blame] | 173 | } else { |
| 174 | error = matrix_keypad_parse_of_keymap(keymap_name, rows, cols, |
| 175 | input_dev); |
| 176 | if (error) |
| 177 | return error; |
Dmitry Torokhov | 1932811 | 2012-05-10 22:37:08 -0700 | [diff] [blame] | 178 | } |
Dmitry Torokhov | b45c8f3 | 2012-05-10 22:37:15 -0700 | [diff] [blame] | 179 | |
Dmitry Torokhov | 1932811 | 2012-05-10 22:37:08 -0700 | [diff] [blame] | 180 | __clear_bit(KEY_RESERVED, input_dev->keybit); |
| 181 | |
| 182 | return 0; |
| 183 | } |
| 184 | EXPORT_SYMBOL(matrix_keypad_build_keymap); |