1 // SPDX-License-Identifier: GPL-2.0-only
29 	/* key debounce interval in milli-second */
51  * HiZ when de-activated to cause minmal side effect when scanning other
58 		gpiod_direction_output(keypad->col_gpios[col], 1);  in __activate_col()
60 		gpiod_set_value_cansleep(keypad->col_gpios[col], 0);  in __activate_col()
61 		if (!keypad->drive_inactive_cols)  in __activate_col()
62 			gpiod_direction_input(keypad->col_gpios[col]);  in __activate_col()
70 	if (on && keypad->col_scan_delay_us)  in activate_col()
71 		udelay(keypad->col_scan_delay_us);  in activate_col()
78 	for (col = 0; col < keypad->num_col_gpios; col++)  in activate_all_cols()
84 	return gpiod_get_value_cansleep(keypad->row_gpios[row]);  in row_asserted()
91 	for (i = 0; i < keypad->num_row_gpios; i++)  in enable_row_irqs()
92 		enable_irq(keypad->row_irqs[i]);  in enable_row_irqs()
99 	for (i = 0; i < keypad->num_row_gpios; i++)  in disable_row_irqs()
100 		disable_irq_nosync(keypad->row_irqs[i]);  in disable_row_irqs()
110 	struct input_dev *input_dev = keypad->input_dev;  in matrix_keypad_scan()
111 	const unsigned short *keycodes = input_dev->keycode;  in matrix_keypad_scan()
115 	/* de-activate all columns for scanning */  in matrix_keypad_scan()
120 	for (row = 0; row < keypad->num_row_gpios; row++)  in matrix_keypad_scan()
121 		gpiod_direction_input(keypad->row_gpios[row]);  in matrix_keypad_scan()
124 	for (col = 0; col < keypad->num_col_gpios; col++) {  in matrix_keypad_scan()
128 		for (row = 0; row < keypad->num_row_gpios; row++)  in matrix_keypad_scan()
135 	for (col = 0; col < keypad->num_col_gpios; col++) {  in matrix_keypad_scan()
138 		bits_changed = keypad->last_key_state[col] ^ new_state[col];  in matrix_keypad_scan()
142 		for (row = 0; row < keypad->num_row_gpios; row++) {  in matrix_keypad_scan()
146 			code = MATRIX_SCAN_CODE(row, col, keypad->row_shift);  in matrix_keypad_scan()
155 	memcpy(keypad->last_key_state, new_state, sizeof(new_state));  in matrix_keypad_scan()
160 	scoped_guard(spinlock_irq, &keypad->lock) {  in matrix_keypad_scan()
161 		keypad->scan_pending = false;  in matrix_keypad_scan()
170 	guard(spinlock_irqsave)(&keypad->lock);  in matrix_keypad_interrupt()
174 	 * scan already. In that case we should not try to  in matrix_keypad_interrupt()
177 	if (unlikely(keypad->scan_pending || keypad->stopped))  in matrix_keypad_interrupt()
181 	keypad->scan_pending = true;  in matrix_keypad_interrupt()
182 	schedule_delayed_work(&keypad->work,  in matrix_keypad_interrupt()
183 			      msecs_to_jiffies(keypad->debounce_ms));  in matrix_keypad_interrupt()
193 	keypad->stopped = false;  in matrix_keypad_start()
197 	 * Schedule an immediate key scan to capture current key state;  in matrix_keypad_start()
198 	 * columns will be activated and IRQs be enabled after the scan.  in matrix_keypad_start()
200 	schedule_delayed_work(&keypad->work, 0);  in matrix_keypad_start()
209 	scoped_guard(spinlock_irq, &keypad->lock) {  in matrix_keypad_stop()
210 		keypad->stopped = true;  in matrix_keypad_stop()
213 	flush_delayed_work(&keypad->work);  in matrix_keypad_stop()
225 	for_each_clear_bit(i, keypad->wakeup_enabled_irqs,  in matrix_keypad_enable_wakeup()
226 			   keypad->num_row_gpios)  in matrix_keypad_enable_wakeup()
227 		if (enable_irq_wake(keypad->row_irqs[i]) == 0)  in matrix_keypad_enable_wakeup()
228 			__set_bit(i, keypad->wakeup_enabled_irqs);  in matrix_keypad_enable_wakeup()
235 	for_each_set_bit(i, keypad->wakeup_enabled_irqs,  in matrix_keypad_disable_wakeup()
236 			 keypad->num_row_gpios) {  in matrix_keypad_disable_wakeup()
237 		disable_irq_wake(keypad->row_irqs[i]);  in matrix_keypad_disable_wakeup()
238 		__clear_bit(i, keypad->wakeup_enabled_irqs);  in matrix_keypad_disable_wakeup()
247 	matrix_keypad_stop(keypad->input_dev);  in matrix_keypad_suspend()
249 	if (device_may_wakeup(&pdev->dev))  in matrix_keypad_suspend()
260 	if (device_may_wakeup(&pdev->dev))  in matrix_keypad_resume()
263 	matrix_keypad_start(keypad->input_dev);  in matrix_keypad_resume()
279 	nrow = gpiod_count(&pdev->dev, "row");  in matrix_keypad_init_gpio()
280 	ncol = gpiod_count(&pdev->dev, "col");  in matrix_keypad_init_gpio()
282 		dev_err(&pdev->dev, "missing row or column GPIOs\n");  in matrix_keypad_init_gpio()
283 		return -EINVAL;  in matrix_keypad_init_gpio()
286 	keypad->num_row_gpios = nrow;  in matrix_keypad_init_gpio()
287 	keypad->num_col_gpios = ncol;  in matrix_keypad_init_gpio()
289 	active_low = device_property_read_bool(&pdev->dev, "gpio-activelow");  in matrix_keypad_init_gpio()
292 	for (i = 0; i < keypad->num_col_gpios; i++) {  in matrix_keypad_init_gpio()
293 		keypad->col_gpios[i] = devm_gpiod_get_index(&pdev->dev, "col",  in matrix_keypad_init_gpio()
295 		err = PTR_ERR_OR_ZERO(keypad->col_gpios[i]);  in matrix_keypad_init_gpio()
297 			dev_err(&pdev->dev,  in matrix_keypad_init_gpio()
303 		gpiod_set_consumer_name(keypad->col_gpios[i], "matrix_kbd_col");  in matrix_keypad_init_gpio()
305 		if (active_low ^ gpiod_is_active_low(keypad->col_gpios[i]))  in matrix_keypad_init_gpio()
306 			gpiod_toggle_active_low(keypad->col_gpios[i]);  in matrix_keypad_init_gpio()
308 		gpiod_direction_output(keypad->col_gpios[i], 1);  in matrix_keypad_init_gpio()
311 	for (i = 0; i < keypad->num_row_gpios; i++) {  in matrix_keypad_init_gpio()
312 		keypad->row_gpios[i] = devm_gpiod_get_index(&pdev->dev, "row",  in matrix_keypad_init_gpio()
314 		err = PTR_ERR_OR_ZERO(keypad->row_gpios[i]);  in matrix_keypad_init_gpio()
316 			dev_err(&pdev->dev,  in matrix_keypad_init_gpio()
322 		gpiod_set_consumer_name(keypad->row_gpios[i], "matrix_kbd_row");  in matrix_keypad_init_gpio()
324 		if (active_low ^ gpiod_is_active_low(keypad->row_gpios[i]))  in matrix_keypad_init_gpio()
325 			gpiod_toggle_active_low(keypad->row_gpios[i]);  in matrix_keypad_init_gpio()
338 	for (i = 0; i < keypad->num_row_gpios; i++) {  in matrix_keypad_setup_interrupts()
339 		irq = gpiod_to_irq(keypad->row_gpios[i]);  in matrix_keypad_setup_interrupts()
342 			dev_err(&pdev->dev,  in matrix_keypad_setup_interrupts()
348 		err = devm_request_any_context_irq(&pdev->dev, irq,  in matrix_keypad_setup_interrupts()
352 						   "matrix-keypad", keypad);  in matrix_keypad_setup_interrupts()
354 			dev_err(&pdev->dev,  in matrix_keypad_setup_interrupts()
360 		keypad->row_irqs[i] = irq;  in matrix_keypad_setup_interrupts()
363 	/* initialized as disabled - enabled by input->open */  in matrix_keypad_setup_interrupts()
376 	keypad = devm_kzalloc(&pdev->dev, sizeof(*keypad), GFP_KERNEL);  in matrix_keypad_probe()
378 		return -ENOMEM;  in matrix_keypad_probe()
380 	input_dev = devm_input_allocate_device(&pdev->dev);  in matrix_keypad_probe()
382 		return -ENOMEM;  in matrix_keypad_probe()
384 	keypad->input_dev = input_dev;  in matrix_keypad_probe()
385 	keypad->stopped = true;  in matrix_keypad_probe()
386 	INIT_DELAYED_WORK(&keypad->work, matrix_keypad_scan);  in matrix_keypad_probe()
387 	spin_lock_init(&keypad->lock);  in matrix_keypad_probe()
389 	keypad->drive_inactive_cols =  in matrix_keypad_probe()
390 		device_property_read_bool(&pdev->dev, "drive-inactive-cols");  in matrix_keypad_probe()
391 	device_property_read_u32(&pdev->dev, "debounce-delay-ms",  in matrix_keypad_probe()
392 				 &keypad->debounce_ms);  in matrix_keypad_probe()
393 	device_property_read_u32(&pdev->dev, "col-scan-delay-us",  in matrix_keypad_probe()
394 				 &keypad->col_scan_delay_us);  in matrix_keypad_probe()
400 	keypad->row_shift = get_count_order(keypad->num_col_gpios);  in matrix_keypad_probe()
406 	input_dev->name		= pdev->name;  in matrix_keypad_probe()
407 	input_dev->id.bustype	= BUS_HOST;  in matrix_keypad_probe()
408 	input_dev->open		= matrix_keypad_start;  in matrix_keypad_probe()
409 	input_dev->close	= matrix_keypad_stop;  in matrix_keypad_probe()
412 					 keypad->num_row_gpios,  in matrix_keypad_probe()
413 					 keypad->num_col_gpios,  in matrix_keypad_probe()
416 		dev_err(&pdev->dev, "failed to build keymap\n");  in matrix_keypad_probe()
417 		return -ENOMEM;  in matrix_keypad_probe()
420 	if (!device_property_read_bool(&pdev->dev, "linux,no-autorepeat"))  in matrix_keypad_probe()
421 		__set_bit(EV_REP, input_dev->evbit);  in matrix_keypad_probe()
426 	err = input_register_device(keypad->input_dev);  in matrix_keypad_probe()
430 	wakeup = device_property_read_bool(&pdev->dev, "wakeup-source") ||  in matrix_keypad_probe()
432 		 device_property_read_bool(&pdev->dev, "linux,wakeup");  in matrix_keypad_probe()
433 	device_init_wakeup(&pdev->dev, wakeup);  in matrix_keypad_probe()
442 	{ .compatible = "gpio-matrix-keypad" },
451 		.name	= "matrix-keypad",
461 MODULE_ALIAS("platform:matrix-keypad");