xref: /rk3399_rockchip-uboot/drivers/input/key-uclass.c (revision c2e7a0d48362ac5b8288265bb0bcebd6dc80e187)
1b398a9a7SJoseph Chen /*
2b398a9a7SJoseph Chen  * (C) Copyright 2017 Rockchip Electronics Co., Ltd
3b398a9a7SJoseph Chen  *
4b398a9a7SJoseph Chen  * SPDX-License-Identifier:     GPL-2.0+
5b398a9a7SJoseph Chen  */
6b398a9a7SJoseph Chen 
764048c53SJoseph Chen #include <common.h>
864048c53SJoseph Chen #include <adc.h>
9b398a9a7SJoseph Chen #include <dm.h>
10b398a9a7SJoseph Chen #include <key.h>
115a54baa7SJoseph Chen #include <dm/lists.h>
125a54baa7SJoseph Chen #include <irq-generic.h>
1364048c53SJoseph Chen 
145a54baa7SJoseph Chen #define KEY_WARN(fmt, args...)	printf("Key Warn: "fmt, ##args)
155a54baa7SJoseph Chen #define KEY_ERR(fmt, args...)	printf("Key Error: "fmt, ##args)
165a54baa7SJoseph Chen #define KEY_DBG(fmt, args...)	 debug("Key Debug: "fmt, ##args)
17adba3792SJoseph Chen 
18a2df9606SJoseph Chen static inline uint64_t arch_counter_get_cntpct(void)
19a2df9606SJoseph Chen {
20a2df9606SJoseph Chen 	uint64_t cval = 0;
21a2df9606SJoseph Chen 
22a2df9606SJoseph Chen 	isb();
23a2df9606SJoseph Chen #ifdef CONFIG_ARM64
24a2df9606SJoseph Chen 	asm volatile("mrs %0, cntpct_el0" : "=r" (cval));
25a2df9606SJoseph Chen #else
26a2df9606SJoseph Chen 	asm volatile("mrrc p15, 0, %Q0, %R0, c14" : "=r" (cval));
27a2df9606SJoseph Chen #endif
28a2df9606SJoseph Chen 	return cval;
29a2df9606SJoseph Chen }
30a2df9606SJoseph Chen 
3164048c53SJoseph Chen uint64_t key_timer(uint64_t base)
32a2df9606SJoseph Chen {
33a2df9606SJoseph Chen 	uint64_t cntpct;
34a2df9606SJoseph Chen 
35a2df9606SJoseph Chen 	cntpct = arch_counter_get_cntpct() / 24000UL;
36a2df9606SJoseph Chen 	return (cntpct > base) ? (cntpct - base) : 0;
37a2df9606SJoseph Chen }
38a2df9606SJoseph Chen 
395a54baa7SJoseph Chen static int key_adc_event(struct dm_key_uclass_platdata *uc_key, int adcval)
40a2df9606SJoseph Chen {
415a54baa7SJoseph Chen 	return (adcval <= uc_key->max && adcval >= uc_key->min) ?
425a54baa7SJoseph Chen 		KEY_PRESS_DOWN : KEY_PRESS_NONE;
433fb84000SJoseph Chen }
443fb84000SJoseph Chen 
455a54baa7SJoseph Chen static int key_gpio_event(struct dm_key_uclass_platdata *uc_key)
463fb84000SJoseph Chen {
475a54baa7SJoseph Chen 	if (!dm_gpio_is_valid(&uc_key->gpio)) {
485a54baa7SJoseph Chen 		KEY_ERR("'%s' Invalid gpio\n", uc_key->name);
4964048c53SJoseph Chen 		return KEY_PRESS_NONE;
5064048c53SJoseph Chen 	}
5164048c53SJoseph Chen 
525a54baa7SJoseph Chen 	return dm_gpio_get_value(&uc_key->gpio) ?
535a54baa7SJoseph Chen 	       KEY_PRESS_DOWN : KEY_PRESS_NONE;
5464048c53SJoseph Chen }
5564048c53SJoseph Chen 
565a54baa7SJoseph Chen static int key_gpio_interrupt_event(struct dm_key_uclass_platdata *uc_key)
5764048c53SJoseph Chen {
585a54baa7SJoseph Chen 	int event;
593fb84000SJoseph Chen 
603fb84000SJoseph Chen 	debug("%s: %s: up=%llu, down=%llu, delta=%llu\n",
615a54baa7SJoseph Chen 	      __func__, uc_key->name, uc_key->rise_ms, uc_key->fall_ms,
625a54baa7SJoseph Chen 	      uc_key->rise_ms - uc_key->fall_ms);
633fb84000SJoseph Chen 
643fb84000SJoseph Chen 	/* Possible this is machine power-on long pressed, so ignore this */
655a54baa7SJoseph Chen 	if (uc_key->fall_ms == 0 && uc_key->rise_ms != 0) {
665a54baa7SJoseph Chen 		event = KEY_PRESS_NONE;
673fb84000SJoseph Chen 		goto out;
683fb84000SJoseph Chen 	}
693fb84000SJoseph Chen 
705a54baa7SJoseph Chen 	if ((uc_key->rise_ms > uc_key->fall_ms) &&
715a54baa7SJoseph Chen 	    (uc_key->rise_ms - uc_key->fall_ms) >= KEY_LONG_DOWN_MS) {
725a54baa7SJoseph Chen 		uc_key->rise_ms = 0;
735a54baa7SJoseph Chen 		uc_key->fall_ms = 0;
745a54baa7SJoseph Chen 		event = KEY_PRESS_LONG_DOWN;
755a54baa7SJoseph Chen 		KEY_DBG("%s key long pressed..\n", uc_key->name);
765a54baa7SJoseph Chen 	} else if (uc_key->fall_ms &&
775a54baa7SJoseph Chen 		   key_timer(uc_key->fall_ms) >= KEY_LONG_DOWN_MS) {
785a54baa7SJoseph Chen 		uc_key->rise_ms = 0;
795a54baa7SJoseph Chen 		uc_key->fall_ms = 0;
805a54baa7SJoseph Chen 		event = KEY_PRESS_LONG_DOWN;
815a54baa7SJoseph Chen 		KEY_DBG("%s key long pressed(hold)..\n", uc_key->name);
825a54baa7SJoseph Chen 	} else if ((uc_key->rise_ms > uc_key->fall_ms) &&
835a54baa7SJoseph Chen 		   (uc_key->rise_ms - uc_key->fall_ms) < KEY_LONG_DOWN_MS) {
845a54baa7SJoseph Chen 		uc_key->rise_ms = 0;
855a54baa7SJoseph Chen 		uc_key->fall_ms = 0;
865a54baa7SJoseph Chen 		event = KEY_PRESS_DOWN;
875a54baa7SJoseph Chen 		KEY_DBG("%s key short pressed..\n", uc_key->name);
8864048c53SJoseph Chen 	/* Possible in charge animation, we enable irq after fuel gauge updated */
895a54baa7SJoseph Chen 	} else if (uc_key->rise_ms && uc_key->fall_ms &&
905a54baa7SJoseph Chen 		   (uc_key->rise_ms == uc_key->fall_ms)) {
915a54baa7SJoseph Chen 		uc_key->rise_ms = 0;
925a54baa7SJoseph Chen 		uc_key->fall_ms = 0;
935a54baa7SJoseph Chen 		event = KEY_PRESS_DOWN;
945a54baa7SJoseph Chen 		KEY_DBG("%s key short pressed..\n", uc_key->name);
953fb84000SJoseph Chen 	} else {
965a54baa7SJoseph Chen 		event = KEY_PRESS_NONE;
973fb84000SJoseph Chen 	}
983fb84000SJoseph Chen 
993fb84000SJoseph Chen out:
1005a54baa7SJoseph Chen 	return event;
10164048c53SJoseph Chen }
10264048c53SJoseph Chen 
1035a54baa7SJoseph Chen int key_is_pressed(int event)
10464048c53SJoseph Chen {
1055a54baa7SJoseph Chen 	return (event == KEY_PRESS_DOWN || event == KEY_PRESS_LONG_DOWN);
10664048c53SJoseph Chen }
10764048c53SJoseph Chen 
1085a54baa7SJoseph Chen static int key_core_read(struct dm_key_uclass_platdata *uc_key)
10964048c53SJoseph Chen {
11064048c53SJoseph Chen 	unsigned int adcval;
11164048c53SJoseph Chen 
1125a54baa7SJoseph Chen 	if (uc_key->type == ADC_KEY) {
1135a54baa7SJoseph Chen 		if (adc_channel_single_shot("saradc",
1145a54baa7SJoseph Chen 					    uc_key->channel, &adcval)) {
1155a54baa7SJoseph Chen 			KEY_ERR("%s failed to read saradc\n", uc_key->name);
1165a54baa7SJoseph Chen 			return KEY_NOT_EXIST;
11764048c53SJoseph Chen 		}
11864048c53SJoseph Chen 
1195a54baa7SJoseph Chen 		return key_adc_event(uc_key, adcval);
1205a54baa7SJoseph Chen 	}
12164048c53SJoseph Chen 
1225a54baa7SJoseph Chen 	return (uc_key->code == KEY_POWER) ?
1235a54baa7SJoseph Chen 		key_gpio_interrupt_event(uc_key) :
1245a54baa7SJoseph Chen 		key_gpio_event(uc_key);
1259f1dd9dfSJoseph Chen }
1269f1dd9dfSJoseph Chen 
1279f1dd9dfSJoseph Chen int key_read(int code)
1289f1dd9dfSJoseph Chen {
1295a54baa7SJoseph Chen 	struct dm_key_uclass_platdata *uc_key;
1309f1dd9dfSJoseph Chen 	struct udevice *dev;
1315a54baa7SJoseph Chen 	struct uclass *uc;
1325a54baa7SJoseph Chen 	bool allow_pre_reloc = false;
1335a54baa7SJoseph Chen 	int ret, event = KEY_NOT_EXIST;
1349f1dd9dfSJoseph Chen 
1355a54baa7SJoseph Chen 	ret = uclass_get(UCLASS_KEY, &uc);
1365a54baa7SJoseph Chen 	if (ret)
1375a54baa7SJoseph Chen 		return ret;
1385a54baa7SJoseph Chen 
1395a54baa7SJoseph Chen try_again:
1409f1dd9dfSJoseph Chen 	for (uclass_first_device(UCLASS_KEY, &dev);
1419f1dd9dfSJoseph Chen 	     dev;
1429f1dd9dfSJoseph Chen 	     uclass_next_device(&dev)) {
1435a54baa7SJoseph Chen 		uc_key = dev_get_uclass_platdata(dev);
1449f1dd9dfSJoseph Chen 
1455a54baa7SJoseph Chen 		if (!allow_pre_reloc && uc_key->pre_reloc)
1469f1dd9dfSJoseph Chen 			continue;
1479f1dd9dfSJoseph Chen 
1485a54baa7SJoseph Chen 		if (uc_key->code != code)
1499f1dd9dfSJoseph Chen 			continue;
1509f1dd9dfSJoseph Chen 
1515a54baa7SJoseph Chen 		event = key_core_read(uc_key);
1525a54baa7SJoseph Chen 		if (key_is_pressed(event))
1535a54baa7SJoseph Chen 			return event;
1545a54baa7SJoseph Chen 	}
1555a54baa7SJoseph Chen 
1565a54baa7SJoseph Chen 	/* If not find valid key node from kernel, try from u-boot */
1575a54baa7SJoseph Chen 	if (event == KEY_NOT_EXIST && !allow_pre_reloc) {
1585a54baa7SJoseph Chen 		allow_pre_reloc = true;
1595a54baa7SJoseph Chen 		goto try_again;
1605a54baa7SJoseph Chen 	}
1615a54baa7SJoseph Chen 
1625a54baa7SJoseph Chen 	return event;
1635a54baa7SJoseph Chen }
1645a54baa7SJoseph Chen 
1655a54baa7SJoseph Chen #ifdef CONFIG_IRQ
1665a54baa7SJoseph Chen static void gpio_irq_handler(int irq, void *data)
1675a54baa7SJoseph Chen {
168*c2e7a0d4SJoseph Chen 	struct udevice *dev = data;
169*c2e7a0d4SJoseph Chen 	struct dm_key_uclass_platdata *uc_key = dev_get_uclass_platdata(dev);
1705a54baa7SJoseph Chen 
1715a54baa7SJoseph Chen 	if (uc_key->irq != irq)
1725a54baa7SJoseph Chen 		return;
1735a54baa7SJoseph Chen 
174*c2e7a0d4SJoseph Chen 	if (uc_key->irq_thread) {
175*c2e7a0d4SJoseph Chen 		uc_key->irq_thread(irq, data);
176*c2e7a0d4SJoseph Chen 	} else {
1775a54baa7SJoseph Chen 		if (irq_get_gpio_level(irq)) {
1785a54baa7SJoseph Chen 			uc_key->rise_ms = key_timer(0);
179*c2e7a0d4SJoseph Chen 			KEY_DBG("%s: key dn: %llu ms\n",
180*c2e7a0d4SJoseph Chen 				uc_key->name, uc_key->fall_ms);
1815a54baa7SJoseph Chen 		} else {
1825a54baa7SJoseph Chen 			uc_key->fall_ms = key_timer(0);
183*c2e7a0d4SJoseph Chen 			KEY_DBG("%s: key up: %llu ms\n",
184*c2e7a0d4SJoseph Chen 				uc_key->name, uc_key->rise_ms);
1855a54baa7SJoseph Chen 		}
1865a54baa7SJoseph Chen 
1875a54baa7SJoseph Chen 		/* Must delay */
1885a54baa7SJoseph Chen 		mdelay(10);
1895a54baa7SJoseph Chen 		irq_revert_irq_type(irq);
1905a54baa7SJoseph Chen 	}
191*c2e7a0d4SJoseph Chen }
1925a54baa7SJoseph Chen #endif
1935a54baa7SJoseph Chen 
1945a54baa7SJoseph Chen int key_bind_children(struct udevice *dev, const char *drv_name)
1955a54baa7SJoseph Chen {
1965a54baa7SJoseph Chen 	const char *name;
1975a54baa7SJoseph Chen 	ofnode node;
1985a54baa7SJoseph Chen 	int ret;
1995a54baa7SJoseph Chen 
2005a54baa7SJoseph Chen 	dev_for_each_subnode(node, dev) {
2015a54baa7SJoseph Chen 		/*
2025a54baa7SJoseph Chen 		 * If this node has "compatible" property, this is not
2035a54baa7SJoseph Chen 		 * a amp subnode, but a normal device. skip.
2045a54baa7SJoseph Chen 		 */
2055a54baa7SJoseph Chen 		ofnode_get_property(node, "compatible", &ret);
2065a54baa7SJoseph Chen 		if (ret >= 0)
2075a54baa7SJoseph Chen 			continue;
2085a54baa7SJoseph Chen 
2095a54baa7SJoseph Chen 		if (ret != -FDT_ERR_NOTFOUND)
2105a54baa7SJoseph Chen 			return ret;
2115a54baa7SJoseph Chen 
2125a54baa7SJoseph Chen 		name = ofnode_get_name(node);
2135a54baa7SJoseph Chen 		if (!name)
2145a54baa7SJoseph Chen 			return -EINVAL;
2155a54baa7SJoseph Chen 		ret = device_bind_driver_to_node(dev, drv_name, name,
2165a54baa7SJoseph Chen 						 node, NULL);
2175a54baa7SJoseph Chen 		if (ret)
2185a54baa7SJoseph Chen 			return ret;
2195a54baa7SJoseph Chen 	}
2205a54baa7SJoseph Chen 
2215a54baa7SJoseph Chen 	return 0;
2225a54baa7SJoseph Chen }
2235a54baa7SJoseph Chen 
2245a54baa7SJoseph Chen static int key_post_probe(struct udevice *dev)
2255a54baa7SJoseph Chen {
2265a54baa7SJoseph Chen 	struct dm_key_uclass_platdata *uc_key;
2275a54baa7SJoseph Chen 	int margin = 30;
2285a54baa7SJoseph Chen 	int ret;
2295a54baa7SJoseph Chen 
2305a54baa7SJoseph Chen 	uc_key = dev_get_uclass_platdata(dev);
2315a54baa7SJoseph Chen 	if (!uc_key)
2325a54baa7SJoseph Chen 		return -ENXIO;
2335a54baa7SJoseph Chen 
2345a54baa7SJoseph Chen 	/* True from U-Boot key node */
2355a54baa7SJoseph Chen 	uc_key->pre_reloc = dev_read_bool(dev, "u-boot,dm-pre-reloc");
2365a54baa7SJoseph Chen 
2375a54baa7SJoseph Chen 	if (uc_key->type == ADC_KEY) {
2385a54baa7SJoseph Chen 		uc_key->max = uc_key->adcval + margin;
2395a54baa7SJoseph Chen 		uc_key->min = uc_key->adcval > margin ?
2405a54baa7SJoseph Chen 					uc_key->adcval - margin : 0;
2415a54baa7SJoseph Chen 	} else {
2425a54baa7SJoseph Chen 		if (uc_key->code == KEY_POWER) {
2435a54baa7SJoseph Chen #ifdef CONFIG_IRQ
2445a54baa7SJoseph Chen 			int irq;
2455a54baa7SJoseph Chen 
2465a54baa7SJoseph Chen 			irq = phandle_gpio_to_irq(uc_key->gpios[0],
2475a54baa7SJoseph Chen 						  uc_key->gpios[1]);
2485a54baa7SJoseph Chen 			if (irq < 0) {
2495a54baa7SJoseph Chen 				KEY_ERR("%s: failed to request irq, ret=%d\n",
2505a54baa7SJoseph Chen 					uc_key->name, irq);
2515a54baa7SJoseph Chen 				return irq;
2525a54baa7SJoseph Chen 			}
2535a54baa7SJoseph Chen 
254*c2e7a0d4SJoseph Chen 			if (uc_key->code != KEY_POWER && uc_key->irq_thread) {
255*c2e7a0d4SJoseph Chen 				KEY_WARN("%s: only power key can request irq thread\n",
256*c2e7a0d4SJoseph Chen 					 uc_key->name);
257*c2e7a0d4SJoseph Chen 				return -EINVAL;
258*c2e7a0d4SJoseph Chen 			}
259*c2e7a0d4SJoseph Chen 
2605a54baa7SJoseph Chen 			uc_key->irq = irq;
261*c2e7a0d4SJoseph Chen 			irq_install_handler(irq, gpio_irq_handler, dev);
2625a54baa7SJoseph Chen 			irq_set_irq_type(irq, IRQ_TYPE_EDGE_FALLING);
2635a54baa7SJoseph Chen 			irq_handler_enable(irq);
2645a54baa7SJoseph Chen #else
2655a54baa7SJoseph Chen 			KEY_WARN("%s: no IRQ framework available\n", uc_key->name);
2665a54baa7SJoseph Chen #endif
2675a54baa7SJoseph Chen 		} else {
2685a54baa7SJoseph Chen 			ret = gpio_request_by_name(dev, "gpios", 0,
2695a54baa7SJoseph Chen 						   &uc_key->gpio, GPIOD_IS_IN);
2705a54baa7SJoseph Chen 			if (ret) {
2715a54baa7SJoseph Chen 				KEY_ERR("%s: failed to request gpio, ret=%d\n",
2725a54baa7SJoseph Chen 					uc_key->name, ret);
2735a54baa7SJoseph Chen 				return ret;
2745a54baa7SJoseph Chen 			}
2759f1dd9dfSJoseph Chen 		}
276adba3792SJoseph Chen 	}
277adba3792SJoseph Chen 
2785a54baa7SJoseph Chen #ifdef DEBUG
2795a54baa7SJoseph Chen 	printf("[%s] (%s, %s, %s):\n", uc_key->name,
2805a54baa7SJoseph Chen 	       uc_key->type == ADC_KEY ? "ADC" : "GPIO",
2815a54baa7SJoseph Chen 	       uc_key->pre_reloc ? "U-Boot" : "Kernel",
2825a54baa7SJoseph Chen 	       dev->parent->name);
2835a54baa7SJoseph Chen 
2845a54baa7SJoseph Chen 	if (uc_key->type == ADC_KEY) {
2855a54baa7SJoseph Chen 		printf("    adcval: %d (%d, %d)\n", uc_key->adcval,
2865a54baa7SJoseph Chen 		       uc_key->min, uc_key->max);
2875a54baa7SJoseph Chen 		printf("   channel: %d\n\n", uc_key->channel);
2885a54baa7SJoseph Chen 	} else {
2895a54baa7SJoseph Chen 		const char *gpio_name =
2905a54baa7SJoseph Chen 		     ofnode_get_name(ofnode_get_by_phandle(uc_key->gpios[0]));
2915a54baa7SJoseph Chen 
2925a54baa7SJoseph Chen 		printf("       irq: %d\n", uc_key->irq);
2935a54baa7SJoseph Chen 		printf("   gpio[0]: %s\n", gpio_name);
2945a54baa7SJoseph Chen 		printf("   gpio[1]: %d\n\n", uc_key->gpios[1]);
2955a54baa7SJoseph Chen 	}
2965a54baa7SJoseph Chen #endif
2975a54baa7SJoseph Chen 
2985a54baa7SJoseph Chen 	return 0;
2993fb84000SJoseph Chen }
3003fb84000SJoseph Chen 
301b398a9a7SJoseph Chen UCLASS_DRIVER(key) = {
302b398a9a7SJoseph Chen 	.id		= UCLASS_KEY,
303b398a9a7SJoseph Chen 	.name		= "key",
3045a54baa7SJoseph Chen 	.post_probe	= key_post_probe,
3055a54baa7SJoseph Chen 	.per_device_platdata_auto_alloc_size =
3065a54baa7SJoseph Chen 			sizeof(struct dm_key_uclass_platdata),
307b398a9a7SJoseph Chen };
308