1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Copyright (C) 2022 MediaTek Inc. 4 * Author Fengping Yu <fengping.yu@mediatek.com> 5 */ 6 #include <linux/bitops.h> 7 #include <linux/clk.h> 8 #include <linux/input/matrix_keypad.h> 9 #include <linux/interrupt.h> 10 #include <linux/module.h> 11 #include <linux/property.h> 12 #include <linux/platform_device.h> 13 #include <linux/regmap.h> 14 15 #define MTK_KPD_NAME "mt6779-keypad" 16 #define MTK_KPD_MEM 0x0004 17 #define MTK_KPD_DEBOUNCE 0x0018 18 #define MTK_KPD_DEBOUNCE_MASK GENMASK(13, 0) 19 #define MTK_KPD_DEBOUNCE_MAX_MS 256 20 #define MTK_KPD_SEL 0x0020 21 #define MTK_KPD_SEL_DOUBLE_KP_MODE BIT(0) 22 #define MTK_KPD_SEL_COL GENMASK(15, 10) 23 #define MTK_KPD_SEL_ROW GENMASK(9, 4) 24 #define MTK_KPD_SEL_COLMASK(c) GENMASK((c) + 9, 10) 25 #define MTK_KPD_SEL_ROWMASK(r) GENMASK((r) + 3, 4) 26 #define MTK_KPD_NUM_MEMS 5 27 #define MTK_KPD_NUM_BITS 136 /* 4*32+8 MEM5 only use 8 BITS */ 28 29 struct mt6779_keypad { 30 struct regmap *regmap; 31 struct input_dev *input_dev; 32 struct clk *clk; 33 u32 n_rows; 34 u32 n_cols; 35 void (*calc_row_col)(unsigned int key, 36 unsigned int *row, unsigned int *col); 37 DECLARE_BITMAP(keymap_state, MTK_KPD_NUM_BITS); 38 }; 39 40 static const struct regmap_config mt6779_keypad_regmap_cfg = { 41 .reg_bits = 32, 42 .val_bits = 32, 43 .reg_stride = sizeof(u32), 44 .max_register = 36, 45 }; 46 47 static irqreturn_t mt6779_keypad_irq_handler(int irq, void *dev_id) 48 { 49 struct mt6779_keypad *keypad = dev_id; 50 const unsigned short *keycode = keypad->input_dev->keycode; 51 DECLARE_BITMAP(new_state, MTK_KPD_NUM_BITS); 52 DECLARE_BITMAP(change, MTK_KPD_NUM_BITS); 53 unsigned int bit_nr, key; 54 unsigned int row, col; 55 unsigned int scancode; 56 unsigned int row_shift = get_count_order(keypad->n_cols); 57 bool pressed; 58 59 regmap_bulk_read(keypad->regmap, MTK_KPD_MEM, 60 new_state, MTK_KPD_NUM_MEMS); 61 62 bitmap_xor(change, new_state, keypad->keymap_state, MTK_KPD_NUM_BITS); 63 64 for_each_set_bit(bit_nr, change, MTK_KPD_NUM_BITS) { 65 /* 66 * Registers are 32bits, but only bits [15:0] are used to 67 * indicate key status. 68 */ 69 if (bit_nr % 32 >= 16) 70 continue; 71 72 key = bit_nr / 32 * 16 + bit_nr % 32; 73 keypad->calc_row_col(key, &row, &col); 74 75 scancode = MATRIX_SCAN_CODE(row, col, row_shift); 76 /* 1: not pressed, 0: pressed */ 77 pressed = !test_bit(bit_nr, new_state); 78 dev_dbg(&keypad->input_dev->dev, "%s", 79 pressed ? "pressed" : "released"); 80 81 input_event(keypad->input_dev, EV_MSC, MSC_SCAN, scancode); 82 input_report_key(keypad->input_dev, keycode[scancode], pressed); 83 input_sync(keypad->input_dev); 84 85 dev_dbg(&keypad->input_dev->dev, 86 "report Linux keycode = %d\n", keycode[scancode]); 87 } 88 89 bitmap_copy(keypad->keymap_state, new_state, MTK_KPD_NUM_BITS); 90 91 return IRQ_HANDLED; 92 } 93 94 static void mt6779_keypad_clk_disable(void *data) 95 { 96 clk_disable_unprepare(data); 97 } 98 99 static void mt6779_keypad_calc_row_col_single(unsigned int key, 100 unsigned int *row, 101 unsigned int *col) 102 { 103 *row = key / 9; 104 *col = key % 9; 105 } 106 107 static void mt6779_keypad_calc_row_col_double(unsigned int key, 108 unsigned int *row, 109 unsigned int *col) 110 { 111 *row = key / 13; 112 *col = (key % 13) / 2; 113 } 114 115 static int mt6779_keypad_pdrv_probe(struct platform_device *pdev) 116 { 117 struct mt6779_keypad *keypad; 118 void __iomem *base; 119 int irq; 120 u32 debounce; 121 u32 keys_per_group; 122 bool wakeup; 123 int error; 124 125 keypad = devm_kzalloc(&pdev->dev, sizeof(*keypad), GFP_KERNEL); 126 if (!keypad) 127 return -ENOMEM; 128 129 base = devm_platform_ioremap_resource(pdev, 0); 130 if (IS_ERR(base)) 131 return PTR_ERR(base); 132 133 keypad->regmap = devm_regmap_init_mmio(&pdev->dev, base, 134 &mt6779_keypad_regmap_cfg); 135 if (IS_ERR(keypad->regmap)) { 136 dev_err(&pdev->dev, 137 "regmap init failed:%pe\n", keypad->regmap); 138 return PTR_ERR(keypad->regmap); 139 } 140 141 bitmap_fill(keypad->keymap_state, MTK_KPD_NUM_BITS); 142 143 keypad->input_dev = devm_input_allocate_device(&pdev->dev); 144 if (!keypad->input_dev) { 145 dev_err(&pdev->dev, "Failed to allocate input dev\n"); 146 return -ENOMEM; 147 } 148 149 keypad->input_dev->name = MTK_KPD_NAME; 150 keypad->input_dev->id.bustype = BUS_HOST; 151 152 error = matrix_keypad_parse_properties(&pdev->dev, &keypad->n_rows, 153 &keypad->n_cols); 154 if (error) { 155 dev_err(&pdev->dev, "Failed to parse keypad params\n"); 156 return error; 157 } 158 159 if (device_property_read_u32(&pdev->dev, "debounce-delay-ms", 160 &debounce)) 161 debounce = 16; 162 163 if (debounce > MTK_KPD_DEBOUNCE_MAX_MS) { 164 dev_err(&pdev->dev, 165 "Debounce time exceeds the maximum allowed time %dms\n", 166 MTK_KPD_DEBOUNCE_MAX_MS); 167 return -EINVAL; 168 } 169 170 if (device_property_read_u32(&pdev->dev, "mediatek,keys-per-group", 171 &keys_per_group)) 172 keys_per_group = 1; 173 174 switch (keys_per_group) { 175 case 1: 176 keypad->calc_row_col = mt6779_keypad_calc_row_col_single; 177 break; 178 case 2: 179 keypad->calc_row_col = mt6779_keypad_calc_row_col_double; 180 break; 181 default: 182 dev_err(&pdev->dev, 183 "Invalid keys-per-group: %d\n", keys_per_group); 184 return -EINVAL; 185 } 186 187 wakeup = device_property_read_bool(&pdev->dev, "wakeup-source"); 188 189 dev_dbg(&pdev->dev, "n_row=%d n_col=%d debounce=%d\n", 190 keypad->n_rows, keypad->n_cols, debounce); 191 192 error = matrix_keypad_build_keymap(NULL, NULL, 193 keypad->n_rows, keypad->n_cols, 194 NULL, keypad->input_dev); 195 if (error) { 196 dev_err(&pdev->dev, "Failed to build keymap\n"); 197 return error; 198 } 199 200 input_set_capability(keypad->input_dev, EV_MSC, MSC_SCAN); 201 202 regmap_write(keypad->regmap, MTK_KPD_DEBOUNCE, 203 (debounce * (1 << 5)) & MTK_KPD_DEBOUNCE_MASK); 204 205 if (keys_per_group == 2) 206 regmap_update_bits(keypad->regmap, MTK_KPD_SEL, 207 MTK_KPD_SEL_DOUBLE_KP_MODE, 208 MTK_KPD_SEL_DOUBLE_KP_MODE); 209 210 regmap_update_bits(keypad->regmap, MTK_KPD_SEL, MTK_KPD_SEL_ROW, 211 MTK_KPD_SEL_ROWMASK(keypad->n_rows)); 212 regmap_update_bits(keypad->regmap, MTK_KPD_SEL, MTK_KPD_SEL_COL, 213 MTK_KPD_SEL_COLMASK(keypad->n_cols)); 214 215 keypad->clk = devm_clk_get(&pdev->dev, "kpd"); 216 if (IS_ERR(keypad->clk)) 217 return PTR_ERR(keypad->clk); 218 219 error = clk_prepare_enable(keypad->clk); 220 if (error) { 221 dev_err(&pdev->dev, "cannot prepare/enable keypad clock\n"); 222 return error; 223 } 224 225 error = devm_add_action_or_reset(&pdev->dev, mt6779_keypad_clk_disable, 226 keypad->clk); 227 if (error) 228 return error; 229 230 irq = platform_get_irq(pdev, 0); 231 if (irq < 0) 232 return irq; 233 234 error = devm_request_threaded_irq(&pdev->dev, irq, 235 NULL, mt6779_keypad_irq_handler, 236 IRQF_ONESHOT, MTK_KPD_NAME, keypad); 237 if (error) { 238 dev_err(&pdev->dev, "Failed to request IRQ#%d: %d\n", 239 irq, error); 240 return error; 241 } 242 243 error = input_register_device(keypad->input_dev); 244 if (error) { 245 dev_err(&pdev->dev, "Failed to register device\n"); 246 return error; 247 } 248 249 error = device_init_wakeup(&pdev->dev, wakeup); 250 if (error) 251 dev_warn(&pdev->dev, "device_init_wakeup() failed: %d\n", 252 error); 253 254 return 0; 255 } 256 257 static const struct of_device_id mt6779_keypad_of_match[] = { 258 { .compatible = "mediatek,mt6779-keypad" }, 259 { .compatible = "mediatek,mt6873-keypad" }, 260 { /* sentinel */ } 261 }; 262 263 static struct platform_driver mt6779_keypad_pdrv = { 264 .probe = mt6779_keypad_pdrv_probe, 265 .driver = { 266 .name = MTK_KPD_NAME, 267 .of_match_table = mt6779_keypad_of_match, 268 }, 269 }; 270 module_platform_driver(mt6779_keypad_pdrv); 271 272 MODULE_AUTHOR("Mediatek Corporation"); 273 MODULE_DESCRIPTION("MTK Keypad (KPD) Driver"); 274 MODULE_LICENSE("GPL"); 275