Orange Pi5 kernel

^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   1) // SPDX-License-Identifier: GPL-2.0-only
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   3)  * rotary_encoder.c
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   4)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   5)  * (c) 2009 Daniel Mack <daniel@caiaq.de>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   6)  * Copyright (C) 2011 Johan Hovold <jhovold@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   7)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   8)  * state machine code inspired by code from Tim Ruetz
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   9)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  10)  * A generic driver for rotary encoders connected to GPIO lines.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  11)  * See file:Documentation/input/devices/rotary-encoder.rst for more information
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  12)  */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  13) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  14) #include <linux/kernel.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  15) #include <linux/module.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  16) #include <linux/interrupt.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  17) #include <linux/input.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  18) #include <linux/device.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  19) #include <linux/platform_device.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  20) #include <linux/gpio/consumer.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  21) #include <linux/slab.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  22) #include <linux/of.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  23) #include <linux/pm.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  24) #include <linux/property.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  25) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  26) #define DRV_NAME "rotary-encoder"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  27) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  28) enum rotary_encoder_encoding {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  29) 	ROTENC_GRAY,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  30) 	ROTENC_BINARY,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  31) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  32) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  33) struct rotary_encoder {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  34) 	struct input_dev *input;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  35) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  36) 	struct mutex access_mutex;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  37) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  38) 	u32 steps;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  39) 	u32 axis;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  40) 	bool relative_axis;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  41) 	bool rollover;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  42) 	enum rotary_encoder_encoding encoding;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  43) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  44) 	unsigned int pos;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  45) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  46) 	struct gpio_descs *gpios;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  47) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  48) 	unsigned int *irq;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  49) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  50) 	bool armed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  51) 	signed char dir;	/* 1 - clockwise, -1 - CCW */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  52) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  53) 	unsigned int last_stable;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  54) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  55) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  56) static unsigned int rotary_encoder_get_state(struct rotary_encoder *encoder)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  57) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  58) 	int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  59) 	unsigned int ret = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  60) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  61) 	for (i = 0; i < encoder->gpios->ndescs; ++i) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  62) 		int val = gpiod_get_value_cansleep(encoder->gpios->desc[i]);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  63) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  64) 		/* convert from gray encoding to normal */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  65) 		if (encoder->encoding == ROTENC_GRAY && ret & 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  66) 			val = !val;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  67) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  68) 		ret = ret << 1 | val;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  69) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  70) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  71) 	return ret & 3;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  72) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  73) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  74) static void rotary_encoder_report_event(struct rotary_encoder *encoder)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  75) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  76) 	if (encoder->relative_axis) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  77) 		input_report_rel(encoder->input,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  78) 				 encoder->axis, encoder->dir);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  79) 	} else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  80) 		unsigned int pos = encoder->pos;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  81) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  82) 		if (encoder->dir < 0) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  83) 			/* turning counter-clockwise */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  84) 			if (encoder->rollover)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  85) 				pos += encoder->steps;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  86) 			if (pos)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  87) 				pos--;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  88) 		} else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  89) 			/* turning clockwise */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  90) 			if (encoder->rollover || pos < encoder->steps)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  91) 				pos++;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  92) 		}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  93) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  94) 		if (encoder->rollover)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  95) 			pos %= encoder->steps;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  96) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  97) 		encoder->pos = pos;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  98) 		input_report_abs(encoder->input, encoder->axis, encoder->pos);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  99) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) 	input_sync(encoder->input);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) static irqreturn_t rotary_encoder_irq(int irq, void *dev_id)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) 	struct rotary_encoder *encoder = dev_id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) 	unsigned int state;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) 	mutex_lock(&encoder->access_mutex);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) 	state = rotary_encoder_get_state(encoder);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) 	switch (state) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) 	case 0x0:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) 		if (encoder->armed) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) 			rotary_encoder_report_event(encoder);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) 			encoder->armed = false;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) 		}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) 		break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) 	case 0x1:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) 	case 0x3:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) 		if (encoder->armed)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) 			encoder->dir = 2 - state;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) 		break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) 	case 0x2:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) 		encoder->armed = true;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) 		break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) 	mutex_unlock(&encoder->access_mutex);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) 	return IRQ_HANDLED;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) static irqreturn_t rotary_encoder_half_period_irq(int irq, void *dev_id)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) 	struct rotary_encoder *encoder = dev_id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) 	unsigned int state;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) 	mutex_lock(&encoder->access_mutex);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) 	state = rotary_encoder_get_state(encoder);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) 	if (state & 1) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) 		encoder->dir = ((encoder->last_stable - state + 1) % 4) - 1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) 	} else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) 		if (state != encoder->last_stable) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) 			rotary_encoder_report_event(encoder);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) 			encoder->last_stable = state;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) 		}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) 	mutex_unlock(&encoder->access_mutex);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) 	return IRQ_HANDLED;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) static irqreturn_t rotary_encoder_quarter_period_irq(int irq, void *dev_id)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) 	struct rotary_encoder *encoder = dev_id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) 	unsigned int state;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) 	mutex_lock(&encoder->access_mutex);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) 	state = rotary_encoder_get_state(encoder);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) 	if ((encoder->last_stable + 1) % 4 == state)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) 		encoder->dir = 1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) 	else if (encoder->last_stable == (state + 1) % 4)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) 		encoder->dir = -1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) 	else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) 		goto out;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) 	rotary_encoder_report_event(encoder);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) out:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) 	encoder->last_stable = state;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) 	mutex_unlock(&encoder->access_mutex);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) 	return IRQ_HANDLED;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) static int rotary_encoder_probe(struct platform_device *pdev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) 	struct device *dev = &pdev->dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) 	struct rotary_encoder *encoder;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) 	struct input_dev *input;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) 	irq_handler_t handler;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) 	u32 steps_per_period;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) 	unsigned int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) 	int err;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) 	encoder = devm_kzalloc(dev, sizeof(struct rotary_encoder), GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) 	if (!encoder)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) 		return -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) 	mutex_init(&encoder->access_mutex);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) 	device_property_read_u32(dev, "rotary-encoder,steps", &encoder->steps);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) 	err = device_property_read_u32(dev, "rotary-encoder,steps-per-period",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) 				       &steps_per_period);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) 	if (err) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) 		/*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) 		 * The 'half-period' property has been deprecated, you must
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) 		 * use 'steps-per-period' and set an appropriate value, but
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) 		 * we still need to parse it to maintain compatibility. If
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) 		 * neither property is present we fall back to the one step
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) 		 * per period behavior.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) 		 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) 		steps_per_period = device_property_read_bool(dev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) 					"rotary-encoder,half-period") ? 2 : 1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) 	encoder->rollover =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218) 		device_property_read_bool(dev, "rotary-encoder,rollover");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220) 	if (!device_property_present(dev, "rotary-encoder,encoding") ||
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221) 	    !device_property_match_string(dev, "rotary-encoder,encoding",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222) 					  "gray")) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223) 		dev_info(dev, "gray");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224) 		encoder->encoding = ROTENC_GRAY;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225) 	} else if (!device_property_match_string(dev, "rotary-encoder,encoding",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226) 						 "binary")) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227) 		dev_info(dev, "binary");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228) 		encoder->encoding = ROTENC_BINARY;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229) 	} else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 230) 		dev_err(dev, "unknown encoding setting\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 231) 		return -EINVAL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 232) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 233) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 234) 	device_property_read_u32(dev, "linux,axis", &encoder->axis);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 235) 	encoder->relative_axis =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 236) 		device_property_read_bool(dev, "rotary-encoder,relative-axis");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 237) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 238) 	encoder->gpios = devm_gpiod_get_array(dev, NULL, GPIOD_IN);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 239) 	if (IS_ERR(encoder->gpios)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 240) 		err = PTR_ERR(encoder->gpios);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 241) 		if (err != -EPROBE_DEFER)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 242) 			dev_err(dev, "unable to get gpios: %d\n", err);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 243) 		return err;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 244) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 245) 	if (encoder->gpios->ndescs < 2) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 246) 		dev_err(dev, "not enough gpios found\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 247) 		return -EINVAL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 248) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 249) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 250) 	input = devm_input_allocate_device(dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 251) 	if (!input)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 252) 		return -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 253) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 254) 	encoder->input = input;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 255) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 256) 	input->name = pdev->name;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 257) 	input->id.bustype = BUS_HOST;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 258) 	input->dev.parent = dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 259) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 260) 	if (encoder->relative_axis)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 261) 		input_set_capability(input, EV_REL, encoder->axis);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 262) 	else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 263) 		input_set_abs_params(input,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 264) 				     encoder->axis, 0, encoder->steps, 0, 1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 265) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 266) 	switch (steps_per_period >> (encoder->gpios->ndescs - 2)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 267) 	case 4:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 268) 		handler = &rotary_encoder_quarter_period_irq;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 269) 		encoder->last_stable = rotary_encoder_get_state(encoder);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 270) 		break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 271) 	case 2:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 272) 		handler = &rotary_encoder_half_period_irq;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 273) 		encoder->last_stable = rotary_encoder_get_state(encoder);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 274) 		break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 275) 	case 1:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 276) 		handler = &rotary_encoder_irq;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 277) 		break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 278) 	default:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 279) 		dev_err(dev, "'%d' is not a valid steps-per-period value\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 280) 			steps_per_period);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 281) 		return -EINVAL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 282) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 283) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 284) 	encoder->irq =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 285) 		devm_kcalloc(dev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 286) 			     encoder->gpios->ndescs, sizeof(*encoder->irq),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 287) 			     GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 288) 	if (!encoder->irq)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 289) 		return -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 290) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 291) 	for (i = 0; i < encoder->gpios->ndescs; ++i) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 292) 		encoder->irq[i] = gpiod_to_irq(encoder->gpios->desc[i]);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 293) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 294) 		err = devm_request_threaded_irq(dev, encoder->irq[i],
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 295) 				NULL, handler,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 296) 				IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 297) 				IRQF_ONESHOT,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 298) 				DRV_NAME, encoder);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 299) 		if (err) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 300) 			dev_err(dev, "unable to request IRQ %d (gpio#%d)\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 301) 				encoder->irq[i], i);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 302) 			return err;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 303) 		}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 304) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 305) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 306) 	err = input_register_device(input);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 307) 	if (err) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 308) 		dev_err(dev, "failed to register input device\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 309) 		return err;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 310) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 311) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 312) 	device_init_wakeup(dev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 313) 			   device_property_read_bool(dev, "wakeup-source"));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 314) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 315) 	platform_set_drvdata(pdev, encoder);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 316) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 317) 	return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 318) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 319) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 320) static int __maybe_unused rotary_encoder_suspend(struct device *dev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 321) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 322) 	struct rotary_encoder *encoder = dev_get_drvdata(dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 323) 	unsigned int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 324) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 325) 	if (device_may_wakeup(dev)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 326) 		for (i = 0; i < encoder->gpios->ndescs; ++i)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 327) 			enable_irq_wake(encoder->irq[i]);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 328) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 329) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 330) 	return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 331) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 332) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 333) static int __maybe_unused rotary_encoder_resume(struct device *dev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 334) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 335) 	struct rotary_encoder *encoder = dev_get_drvdata(dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 336) 	unsigned int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 337) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 338) 	if (device_may_wakeup(dev)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 339) 		for (i = 0; i < encoder->gpios->ndescs; ++i)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 340) 			disable_irq_wake(encoder->irq[i]);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 341) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 342) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 343) 	return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 344) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 345) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 346) static SIMPLE_DEV_PM_OPS(rotary_encoder_pm_ops,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 347) 			 rotary_encoder_suspend, rotary_encoder_resume);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 348) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 349) #ifdef CONFIG_OF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 350) static const struct of_device_id rotary_encoder_of_match[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 351) 	{ .compatible = "rotary-encoder", },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 352) 	{ },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 353) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 354) MODULE_DEVICE_TABLE(of, rotary_encoder_of_match);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 355) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 356) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 357) static struct platform_driver rotary_encoder_driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 358) 	.probe		= rotary_encoder_probe,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 359) 	.driver		= {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 360) 		.name	= DRV_NAME,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 361) 		.pm	= &rotary_encoder_pm_ops,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 362) 		.of_match_table = of_match_ptr(rotary_encoder_of_match),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 363) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 364) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 365) module_platform_driver(rotary_encoder_driver);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 366) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 367) MODULE_ALIAS("platform:" DRV_NAME);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 368) MODULE_DESCRIPTION("GPIO rotary encoder driver");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 369) MODULE_AUTHOR("Daniel Mack <daniel@caiaq.de>, Johan Hovold");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 370) MODULE_LICENSE("GPL v2");