drivers/input/matrix-keymap.c

   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
  20 #include <linux/device.h>
  21 #include <linux/gfp.h>
  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>
  27 #include <linux/module.h>
  28 #include <linux/input/matrix_keypad.h>
  29
  30 static bool matrix_keypad_map_key(struct input_dev *input_dev,
  31                                   unsigned int rows, unsigned int cols,
  32                                   unsigned int row_shift, unsigned int key)
  33 {
  34         unsigned short *keymap = input_dev->keycode;
  35         unsigned int row = KEY_ROW(key);
  36         unsigned int col = KEY_COL(key);
  37         unsigned short code = KEY_VAL(key);
  38
  39         if (row >= rows || col >= cols) {
  40                 dev_err(input_dev->dev.parent,
  41                         "%s: invalid keymap entry 0x%x (row: %d, col: %d, rows: %d, cols: %d)\n",
  42                         __func__, key, row, col, rows, cols);
  43                 return false;
  44         }
  45
  46         keymap[MATRIX_SCAN_CODE(row, col, row_shift)] = code;
  47         __set_bit(code, input_dev->keybit);
  48
  49         return true;
  50 }
  51
  52 #ifdef CONFIG_OF
  53 int matrix_keypad_parse_of_params(struct device *dev,
  54                                   unsigned int *rows, unsigned int *cols)
  55 {
  56         struct device_node *np = dev->of_node;
  57
  58         if (!np) {
  59                 dev_err(dev, "missing DT data");
  60                 return -EINVAL;
  61         }
  62         of_property_read_u32(np, "keypad,num-rows", rows);
  63         of_property_read_u32(np, "keypad,num-columns", cols);
  64         if (!*rows || !*cols) {
  65                 dev_err(dev, "number of keypad rows/columns not specified\n");
  66                 return -EINVAL;
  67         }
  68
  69         return 0;
  70 }
  71
  72 static int matrix_keypad_parse_of_keymap(const char *propname,
  73                                          unsigned int rows, unsigned int cols,
  74                                          struct input_dev *input_dev)
  75 {
  76         struct device *dev = input_dev->dev.parent;
  77         struct device_node *np = dev->of_node;
  78         unsigned int row_shift = get_count_order(cols);
  79         unsigned int max_keys = rows << row_shift;
  80         unsigned int proplen, i, size;
  81         const __be32 *prop;
  82
  83         if (!np)
  84                 return -ENOENT;
  85
  86         if (!propname)
  87                 propname = "linux,keymap";
  88
  89         prop = of_get_property(np, propname, &proplen);
  90         if (!prop) {
  91                 dev_err(dev, "OF: %s property not defined in %s\n",
  92                         propname, np->full_name);
  93                 return -ENOENT;
  94         }
  95
  96         if (proplen % sizeof(u32)) {
  97                 dev_err(dev, "OF: Malformed keycode property %s in %s\n",
  98                         propname, np->full_name);
  99                 return -EINVAL;
 100         }
 101
 102         size = proplen / sizeof(u32);
 103         if (size > max_keys) {
 104                 dev_err(dev, "OF: %s size overflow\n", propname);
 105                 return -EINVAL;
 106         }
 107
 108         for (i = 0; i < size; i++) {
 109                 unsigned int key = be32_to_cpup(prop + i);
 110
 111                 if (!matrix_keypad_map_key(input_dev, rows, cols,
 112                                            row_shift, key))
 113                         return -EINVAL;
 114         }
 115
 116         return 0;
 117 }
 118 #else
 119 static int matrix_keypad_parse_of_keymap(const char *propname,
 120                                          unsigned int rows, unsigned int cols,
 121                                          struct input_dev *input_dev)
 122 {
 123         return -ENOSYS;
 124 }
 125 #endif
 126
 127 /**
 128  * matrix_keypad_build_keymap - convert platform keymap into matrix keymap
 129  * @keymap_data: keymap supplied by the platform code
 130  * @keymap_name: name of device tree property containing keymap (if device
 131  *      tree support is enabled).
 132  * @rows: number of rows in target keymap array
 133  * @cols: number of cols in target keymap array
 134  * @keymap: expanded version of keymap that is suitable for use by
 135  * matrix keyboard driver
 136  * @input_dev: input devices for which we are setting up the keymap
 137  *
 138  * This function converts platform keymap (encoded with KEY() macro) into
 139  * an array of keycodes that is suitable for using in a standard matrix
 140  * keyboard driver that uses row and col as indices.
 141  *
 142  * If @keymap_data is not supplied and device tree support is enabled
 143  * it will attempt load the keymap from property specified by @keymap_name
 144  * argument (or "linux,keymap" if @keymap_name is %NULL).
 145  *
 146  * If @keymap is %NULL the function will automatically allocate managed
 147  * block of memory to store the keymap. This memory will be associated with
 148  * the parent device and automatically freed when device unbinds from the
 149  * driver.
 150  *
 151  * Callers are expected to set up input_dev->dev.parent before calling this
 152  * function.
 153  */
 154 int matrix_keypad_build_keymap(const struct matrix_keymap_data *keymap_data,
 155                                const char *keymap_name,
 156                                unsigned int rows, unsigned int cols,
 157                                unsigned short *keymap,
 158                                struct input_dev *input_dev)
 159 {
 160         unsigned int row_shift = get_count_order(cols);
 161         size_t max_keys = rows << row_shift;
 162         int i;
 163         int error;
 164
 165         if (WARN_ON(!input_dev->dev.parent))
 166                 return -EINVAL;
 167
 168         if (!keymap) {
 169                 keymap = devm_kzalloc(input_dev->dev.parent,
 170                                       max_keys * sizeof(*keymap),
 171                                       GFP_KERNEL);
 172                 if (!keymap) {
 173                         dev_err(input_dev->dev.parent,
 174                                 "Unable to allocate memory for keymap");
 175                         return -ENOMEM;
 176                 }
 177         }
 178
 179         input_dev->keycode = keymap;
 180         input_dev->keycodesize = sizeof(*keymap);
 181         input_dev->keycodemax = max_keys;
 182
 183         __set_bit(EV_KEY, input_dev->evbit);
 184
 185         if (keymap_data) {
 186                 for (i = 0; i < keymap_data->keymap_size; i++) {
 187                         unsigned int key = keymap_data->keymap[i];
 188
 189                         if (!matrix_keypad_map_key(input_dev, rows, cols,
 190                                                    row_shift, key))
 191                                 return -EINVAL;
 192                 }
 193         } else {
 194                 error = matrix_keypad_parse_of_keymap(keymap_name, rows, cols,
 195                                                       input_dev);
 196                 if (error)
 197                         return error;
 198         }
 199
 200         __clear_bit(KEY_RESERVED, input_dev->keybit);
 201
 202         return 0;
 203 }
 204 EXPORT_SYMBOL(matrix_keypad_build_keymap);
 205
 206 MODULE_LICENSE("GPL");