1 // SPDX-License-Identifier: GPL-2.0-only
3  *  GPIO driven matrix keyboard driver
18 #include <linux/gpio.h>
41  * NOTE: If drive_inactive_cols is false, then the GPIO has to be put into
42  * HiZ when de-activated to cause minmal side effect when scanning other
49 	bool level_on = !pdata->active_low;  in __activate_col()
52 		gpio_direction_output(pdata->col_gpios[col], level_on);  in __activate_col()
54 		gpio_set_value_cansleep(pdata->col_gpios[col], !level_on);  in __activate_col()
55 		if (!pdata->drive_inactive_cols)  in __activate_col()
56 			gpio_direction_input(pdata->col_gpios[col]);  in __activate_col()
65 	if (on && pdata->col_scan_delay_us)  in activate_col()
66 		udelay(pdata->col_scan_delay_us);  in activate_col()
74 	for (col = 0; col < pdata->num_col_gpios; col++)  in activate_all_cols()
81 	return gpio_get_value_cansleep(pdata->row_gpios[row]) ?  in row_asserted()
82 			!pdata->active_low : pdata->active_low;  in row_asserted()
87 	const struct matrix_keypad_platform_data *pdata = keypad->pdata;  in enable_row_irqs()
90 	if (pdata->clustered_irq > 0)  in enable_row_irqs()
91 		enable_irq(pdata->clustered_irq);  in enable_row_irqs()
93 		for (i = 0; i < pdata->num_row_gpios; i++)  in enable_row_irqs()
94 			enable_irq(gpio_to_irq(pdata->row_gpios[i]));  in enable_row_irqs()
100 	const struct matrix_keypad_platform_data *pdata = keypad->pdata;  in disable_row_irqs()
103 	if (pdata->clustered_irq > 0)  in disable_row_irqs()
104 		disable_irq_nosync(pdata->clustered_irq);  in disable_row_irqs()
106 		for (i = 0; i < pdata->num_row_gpios; i++)  in disable_row_irqs()
107 			disable_irq_nosync(gpio_to_irq(pdata->row_gpios[i]));  in disable_row_irqs()
118 	struct input_dev *input_dev = keypad->input_dev;  in matrix_keypad_scan()
119 	const unsigned short *keycodes = input_dev->keycode;  in matrix_keypad_scan()
120 	const struct matrix_keypad_platform_data *pdata = keypad->pdata;  in matrix_keypad_scan()
124 	/* de-activate all columns for scanning */  in matrix_keypad_scan()
130 	for (col = 0; col < pdata->num_col_gpios; col++) {  in matrix_keypad_scan()
134 		for (row = 0; row < pdata->num_row_gpios; row++)  in matrix_keypad_scan()
141 	for (col = 0; col < pdata->num_col_gpios; col++) {  in matrix_keypad_scan()
144 		bits_changed = keypad->last_key_state[col] ^ new_state[col];  in matrix_keypad_scan()
148 		for (row = 0; row < pdata->num_row_gpios; row++) {  in matrix_keypad_scan()
152 			code = MATRIX_SCAN_CODE(row, col, keypad->row_shift);  in matrix_keypad_scan()
161 	memcpy(keypad->last_key_state, new_state, sizeof(new_state));  in matrix_keypad_scan()
166 	spin_lock_irq(&keypad->lock);  in matrix_keypad_scan()
167 	keypad->scan_pending = false;  in matrix_keypad_scan()
169 	spin_unlock_irq(&keypad->lock);  in matrix_keypad_scan()
177 	spin_lock_irqsave(&keypad->lock, flags);  in matrix_keypad_interrupt()
184 	if (unlikely(keypad->scan_pending || keypad->stopped))  in matrix_keypad_interrupt()
188 	keypad->scan_pending = true;  in matrix_keypad_interrupt()
189 	schedule_delayed_work(&keypad->work,  in matrix_keypad_interrupt()
190 		msecs_to_jiffies(keypad->pdata->debounce_ms));  in matrix_keypad_interrupt()
193 	spin_unlock_irqrestore(&keypad->lock, flags);  in matrix_keypad_interrupt()
201 	keypad->stopped = false;  in matrix_keypad_start()
208 	schedule_delayed_work(&keypad->work, 0);  in matrix_keypad_start()
217 	spin_lock_irq(&keypad->lock);  in matrix_keypad_stop()
218 	keypad->stopped = true;  in matrix_keypad_stop()
219 	spin_unlock_irq(&keypad->lock);  in matrix_keypad_stop()
221 	flush_delayed_work(&keypad->work);  in matrix_keypad_stop()
232 	const struct matrix_keypad_platform_data *pdata = keypad->pdata;  in matrix_keypad_enable_wakeup()
233 	unsigned int gpio;  in matrix_keypad_enable_wakeup()  local
236 	if (pdata->clustered_irq > 0) {  in matrix_keypad_enable_wakeup()
237 		if (enable_irq_wake(pdata->clustered_irq) == 0)  in matrix_keypad_enable_wakeup()
238 			keypad->gpio_all_disabled = true;  in matrix_keypad_enable_wakeup()
241 		for (i = 0; i < pdata->num_row_gpios; i++) {  in matrix_keypad_enable_wakeup()
242 			if (!test_bit(i, keypad->disabled_gpios)) {  in matrix_keypad_enable_wakeup()
243 				gpio = pdata->row_gpios[i];  in matrix_keypad_enable_wakeup()
245 				if (enable_irq_wake(gpio_to_irq(gpio)) == 0)  in matrix_keypad_enable_wakeup()
246 					__set_bit(i, keypad->disabled_gpios);  in matrix_keypad_enable_wakeup()
254 	const struct matrix_keypad_platform_data *pdata = keypad->pdata;  in matrix_keypad_disable_wakeup()
255 	unsigned int gpio;  in matrix_keypad_disable_wakeup()  local
258 	if (pdata->clustered_irq > 0) {  in matrix_keypad_disable_wakeup()
259 		if (keypad->gpio_all_disabled) {  in matrix_keypad_disable_wakeup()
260 			disable_irq_wake(pdata->clustered_irq);  in matrix_keypad_disable_wakeup()
261 			keypad->gpio_all_disabled = false;  in matrix_keypad_disable_wakeup()
264 		for (i = 0; i < pdata->num_row_gpios; i++) {  in matrix_keypad_disable_wakeup()
265 			if (test_and_clear_bit(i, keypad->disabled_gpios)) {  in matrix_keypad_disable_wakeup()
266 				gpio = pdata->row_gpios[i];  in matrix_keypad_disable_wakeup()
267 				disable_irq_wake(gpio_to_irq(gpio));  in matrix_keypad_disable_wakeup()
278 	matrix_keypad_stop(keypad->input_dev);  in matrix_keypad_suspend()
280 	if (device_may_wakeup(&pdev->dev))  in matrix_keypad_suspend()
291 	if (device_may_wakeup(&pdev->dev))  in matrix_keypad_resume()
294 	matrix_keypad_start(keypad->input_dev);  in matrix_keypad_resume()
306 	const struct matrix_keypad_platform_data *pdata = keypad->pdata;  in matrix_keypad_init_gpio()
310 	for (i = 0; i < pdata->num_col_gpios; i++) {  in matrix_keypad_init_gpio()
311 		err = gpio_request(pdata->col_gpios[i], "matrix_kbd_col");  in matrix_keypad_init_gpio()
313 			dev_err(&pdev->dev,  in matrix_keypad_init_gpio()
314 				"failed to request GPIO%d for COL%d\n",  in matrix_keypad_init_gpio()
315 				pdata->col_gpios[i], i);  in matrix_keypad_init_gpio()
319 		gpio_direction_output(pdata->col_gpios[i], !pdata->active_low);  in matrix_keypad_init_gpio()
322 	for (i = 0; i < pdata->num_row_gpios; i++) {  in matrix_keypad_init_gpio()
323 		err = gpio_request(pdata->row_gpios[i], "matrix_kbd_row");  in matrix_keypad_init_gpio()
325 			dev_err(&pdev->dev,  in matrix_keypad_init_gpio()
326 				"failed to request GPIO%d for ROW%d\n",  in matrix_keypad_init_gpio()
327 				pdata->row_gpios[i], i);  in matrix_keypad_init_gpio()
331 		gpio_direction_input(pdata->row_gpios[i]);  in matrix_keypad_init_gpio()
334 	if (pdata->clustered_irq > 0) {  in matrix_keypad_init_gpio()
335 		err = request_any_context_irq(pdata->clustered_irq,  in matrix_keypad_init_gpio()
337 				pdata->clustered_irq_flags,  in matrix_keypad_init_gpio()
338 				"matrix-keypad", keypad);  in matrix_keypad_init_gpio()
340 			dev_err(&pdev->dev,  in matrix_keypad_init_gpio()
345 		for (i = 0; i < pdata->num_row_gpios; i++) {  in matrix_keypad_init_gpio()
347 					gpio_to_irq(pdata->row_gpios[i]),  in matrix_keypad_init_gpio()
351 					"matrix-keypad", keypad);  in matrix_keypad_init_gpio()
353 				dev_err(&pdev->dev,  in matrix_keypad_init_gpio()
354 					"Unable to acquire interrupt for GPIO line %i\n",  in matrix_keypad_init_gpio()
355 					pdata->row_gpios[i]);  in matrix_keypad_init_gpio()
361 	/* initialized as disabled - enabled by input->open */  in matrix_keypad_init_gpio()
366 	while (--i >= 0)  in matrix_keypad_init_gpio()
367 		free_irq(gpio_to_irq(pdata->row_gpios[i]), keypad);  in matrix_keypad_init_gpio()
368 	i = pdata->num_row_gpios;  in matrix_keypad_init_gpio()
370 	while (--i >= 0)  in matrix_keypad_init_gpio()
371 		gpio_free(pdata->row_gpios[i]);  in matrix_keypad_init_gpio()
372 	i = pdata->num_col_gpios;  in matrix_keypad_init_gpio()
374 	while (--i >= 0)  in matrix_keypad_init_gpio()
375 		gpio_free(pdata->col_gpios[i]);  in matrix_keypad_init_gpio()
382 	const struct matrix_keypad_platform_data *pdata = keypad->pdata;  in matrix_keypad_free_gpio()
385 	if (pdata->clustered_irq > 0) {  in matrix_keypad_free_gpio()
386 		free_irq(pdata->clustered_irq, keypad);  in matrix_keypad_free_gpio()
388 		for (i = 0; i < pdata->num_row_gpios; i++)  in matrix_keypad_free_gpio()
389 			free_irq(gpio_to_irq(pdata->row_gpios[i]), keypad);  in matrix_keypad_free_gpio()
392 	for (i = 0; i < pdata->num_row_gpios; i++)  in matrix_keypad_free_gpio()
393 		gpio_free(pdata->row_gpios[i]);  in matrix_keypad_free_gpio()
395 	for (i = 0; i < pdata->num_col_gpios; i++)  in matrix_keypad_free_gpio()
396 		gpio_free(pdata->col_gpios[i]);  in matrix_keypad_free_gpio()
404 	struct device_node *np = dev->of_node;  in matrix_keypad_parse_dt()
410 		return ERR_PTR(-ENODEV);  in matrix_keypad_parse_dt()
416 		return ERR_PTR(-ENOMEM);  in matrix_keypad_parse_dt()
419 	pdata->num_row_gpios = nrow = of_gpio_named_count(np, "row-gpios");  in matrix_keypad_parse_dt()
420 	pdata->num_col_gpios = ncol = of_gpio_named_count(np, "col-gpios");  in matrix_keypad_parse_dt()
423 		return ERR_PTR(-EINVAL);  in matrix_keypad_parse_dt()
426 	if (of_get_property(np, "linux,no-autorepeat", NULL))  in matrix_keypad_parse_dt()
427 		pdata->no_autorepeat = true;  in matrix_keypad_parse_dt()
429 	pdata->wakeup = of_property_read_bool(np, "wakeup-source") ||  in matrix_keypad_parse_dt()
432 	if (of_get_property(np, "gpio-activelow", NULL))  in matrix_keypad_parse_dt()
433 		pdata->active_low = true;  in matrix_keypad_parse_dt()
435 	pdata->drive_inactive_cols =  in matrix_keypad_parse_dt()
436 		of_property_read_bool(np, "drive-inactive-cols");  in matrix_keypad_parse_dt()
438 	of_property_read_u32(np, "debounce-delay-ms", &pdata->debounce_ms);  in matrix_keypad_parse_dt()
439 	of_property_read_u32(np, "col-scan-delay-us",  in matrix_keypad_parse_dt()
440 						&pdata->col_scan_delay_us);  in matrix_keypad_parse_dt()
443 			     pdata->num_row_gpios + pdata->num_col_gpios,  in matrix_keypad_parse_dt()
448 		return ERR_PTR(-ENOMEM);  in matrix_keypad_parse_dt()
452 		ret = of_get_named_gpio(np, "row-gpios", i);  in matrix_keypad_parse_dt()
459 		ret = of_get_named_gpio(np, "col-gpios", i);  in matrix_keypad_parse_dt()
465 	pdata->row_gpios = gpios;  in matrix_keypad_parse_dt()
466 	pdata->col_gpios = &gpios[pdata->num_row_gpios];  in matrix_keypad_parse_dt()
476 	return ERR_PTR(-EINVAL);  in matrix_keypad_parse_dt()
487 	pdata = dev_get_platdata(&pdev->dev);  in matrix_keypad_probe()
489 		pdata = matrix_keypad_parse_dt(&pdev->dev);  in matrix_keypad_probe()
492 	} else if (!pdata->keymap_data) {  in matrix_keypad_probe()
493 		dev_err(&pdev->dev, "no keymap data defined\n");  in matrix_keypad_probe()
494 		return -EINVAL;  in matrix_keypad_probe()
500 		err = -ENOMEM;  in matrix_keypad_probe()
504 	keypad->input_dev = input_dev;  in matrix_keypad_probe()
505 	keypad->pdata = pdata;  in matrix_keypad_probe()
506 	keypad->row_shift = get_count_order(pdata->num_col_gpios);  in matrix_keypad_probe()
507 	keypad->stopped = true;  in matrix_keypad_probe()
508 	INIT_DELAYED_WORK(&keypad->work, matrix_keypad_scan);  in matrix_keypad_probe()
509 	spin_lock_init(&keypad->lock);  in matrix_keypad_probe()
511 	input_dev->name		= pdev->name;  in matrix_keypad_probe()
512 	input_dev->id.bustype	= BUS_HOST;  in matrix_keypad_probe()
513 	input_dev->dev.parent	= &pdev->dev;  in matrix_keypad_probe()
514 	input_dev->open		= matrix_keypad_start;  in matrix_keypad_probe()
515 	input_dev->close	= matrix_keypad_stop;  in matrix_keypad_probe()
517 	err = matrix_keypad_build_keymap(pdata->keymap_data, NULL,  in matrix_keypad_probe()
518 					 pdata->num_row_gpios,  in matrix_keypad_probe()
519 					 pdata->num_col_gpios,  in matrix_keypad_probe()
522 		dev_err(&pdev->dev, "failed to build keymap\n");  in matrix_keypad_probe()
526 	if (!pdata->no_autorepeat)  in matrix_keypad_probe()
527 		__set_bit(EV_REP, input_dev->evbit);  in matrix_keypad_probe()
535 	err = input_register_device(keypad->input_dev);  in matrix_keypad_probe()
539 	device_init_wakeup(&pdev->dev, pdata->wakeup);  in matrix_keypad_probe()
557 	input_unregister_device(keypad->input_dev);  in matrix_keypad_remove()
565 	{ .compatible = "gpio-matrix-keypad" },
575 		.name	= "matrix-keypad",
583 MODULE_DESCRIPTION("GPIO Driven Matrix Keypad Driver");
585 MODULE_ALIAS("platform:matrix-keypad");