xref: /OK3568_Linux_fs/kernel/drivers/media/rc/ir-spi.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun // SPI driven IR LED device driver
3*4882a593Smuzhiyun //
4*4882a593Smuzhiyun // Copyright (c) 2016 Samsung Electronics Co., Ltd.
5*4882a593Smuzhiyun // Copyright (c) Andi Shyti <andi@etezian.org>
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #include <linux/delay.h>
8*4882a593Smuzhiyun #include <linux/fs.h>
9*4882a593Smuzhiyun #include <linux/module.h>
10*4882a593Smuzhiyun #include <linux/mutex.h>
11*4882a593Smuzhiyun #include <linux/of_gpio.h>
12*4882a593Smuzhiyun #include <linux/regulator/consumer.h>
13*4882a593Smuzhiyun #include <linux/spi/spi.h>
14*4882a593Smuzhiyun #include <media/rc-core.h>
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun #define IR_SPI_DRIVER_NAME		"ir-spi"
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #define IR_SPI_DEFAULT_FREQUENCY	38000
19*4882a593Smuzhiyun #define IR_SPI_MAX_BUFSIZE		 4096
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun struct ir_spi_data {
22*4882a593Smuzhiyun 	u32 freq;
23*4882a593Smuzhiyun 	bool negated;
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun 	u16 tx_buf[IR_SPI_MAX_BUFSIZE];
26*4882a593Smuzhiyun 	u16 pulse;
27*4882a593Smuzhiyun 	u16 space;
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun 	struct rc_dev *rc;
30*4882a593Smuzhiyun 	struct spi_device *spi;
31*4882a593Smuzhiyun 	struct regulator *regulator;
32*4882a593Smuzhiyun };
33*4882a593Smuzhiyun 
ir_spi_tx(struct rc_dev * dev,unsigned int * buffer,unsigned int count)34*4882a593Smuzhiyun static int ir_spi_tx(struct rc_dev *dev,
35*4882a593Smuzhiyun 		     unsigned int *buffer, unsigned int count)
36*4882a593Smuzhiyun {
37*4882a593Smuzhiyun 	int i;
38*4882a593Smuzhiyun 	int ret;
39*4882a593Smuzhiyun 	unsigned int len = 0;
40*4882a593Smuzhiyun 	struct ir_spi_data *idata = dev->priv;
41*4882a593Smuzhiyun 	struct spi_transfer xfer;
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun 	/* convert the pulse/space signal to raw binary signal */
44*4882a593Smuzhiyun 	for (i = 0; i < count; i++) {
45*4882a593Smuzhiyun 		unsigned int periods;
46*4882a593Smuzhiyun 		int j;
47*4882a593Smuzhiyun 		u16 val;
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun 		periods = DIV_ROUND_CLOSEST(buffer[i] * idata->freq, 1000000);
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun 		if (len + periods >= IR_SPI_MAX_BUFSIZE)
52*4882a593Smuzhiyun 			return -EINVAL;
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun 		/*
55*4882a593Smuzhiyun 		 * the first value in buffer is a pulse, so that 0, 2, 4, ...
56*4882a593Smuzhiyun 		 * contain a pulse duration. On the contrary, 1, 3, 5, ...
57*4882a593Smuzhiyun 		 * contain a space duration.
58*4882a593Smuzhiyun 		 */
59*4882a593Smuzhiyun 		val = (i % 2) ? idata->space : idata->pulse;
60*4882a593Smuzhiyun 		for (j = 0; j < periods; j++)
61*4882a593Smuzhiyun 			idata->tx_buf[len++] = val;
62*4882a593Smuzhiyun 	}
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun 	memset(&xfer, 0, sizeof(xfer));
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun 	xfer.speed_hz = idata->freq * 16;
67*4882a593Smuzhiyun 	xfer.len = len * sizeof(*idata->tx_buf);
68*4882a593Smuzhiyun 	xfer.tx_buf = idata->tx_buf;
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun 	ret = regulator_enable(idata->regulator);
71*4882a593Smuzhiyun 	if (ret)
72*4882a593Smuzhiyun 		return ret;
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun 	ret = spi_sync_transfer(idata->spi, &xfer, 1);
75*4882a593Smuzhiyun 	if (ret)
76*4882a593Smuzhiyun 		dev_err(&idata->spi->dev, "unable to deliver the signal\n");
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun 	regulator_disable(idata->regulator);
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun 	return ret ? ret : count;
81*4882a593Smuzhiyun }
82*4882a593Smuzhiyun 
ir_spi_set_tx_carrier(struct rc_dev * dev,u32 carrier)83*4882a593Smuzhiyun static int ir_spi_set_tx_carrier(struct rc_dev *dev, u32 carrier)
84*4882a593Smuzhiyun {
85*4882a593Smuzhiyun 	struct ir_spi_data *idata = dev->priv;
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun 	if (!carrier)
88*4882a593Smuzhiyun 		return -EINVAL;
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun 	idata->freq = carrier;
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun 	return 0;
93*4882a593Smuzhiyun }
94*4882a593Smuzhiyun 
ir_spi_set_duty_cycle(struct rc_dev * dev,u32 duty_cycle)95*4882a593Smuzhiyun static int ir_spi_set_duty_cycle(struct rc_dev *dev, u32 duty_cycle)
96*4882a593Smuzhiyun {
97*4882a593Smuzhiyun 	struct ir_spi_data *idata = dev->priv;
98*4882a593Smuzhiyun 	int bits = (duty_cycle * 15) / 100;
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun 	idata->pulse = GENMASK(bits, 0);
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun 	if (idata->negated) {
103*4882a593Smuzhiyun 		idata->pulse = ~idata->pulse;
104*4882a593Smuzhiyun 		idata->space = 0xffff;
105*4882a593Smuzhiyun 	} else {
106*4882a593Smuzhiyun 		idata->space = 0;
107*4882a593Smuzhiyun 	}
108*4882a593Smuzhiyun 
109*4882a593Smuzhiyun 	return 0;
110*4882a593Smuzhiyun }
111*4882a593Smuzhiyun 
ir_spi_probe(struct spi_device * spi)112*4882a593Smuzhiyun static int ir_spi_probe(struct spi_device *spi)
113*4882a593Smuzhiyun {
114*4882a593Smuzhiyun 	int ret;
115*4882a593Smuzhiyun 	u8 dc;
116*4882a593Smuzhiyun 	struct ir_spi_data *idata;
117*4882a593Smuzhiyun 
118*4882a593Smuzhiyun 	idata = devm_kzalloc(&spi->dev, sizeof(*idata), GFP_KERNEL);
119*4882a593Smuzhiyun 	if (!idata)
120*4882a593Smuzhiyun 		return -ENOMEM;
121*4882a593Smuzhiyun 
122*4882a593Smuzhiyun 	idata->regulator = devm_regulator_get(&spi->dev, "irda_regulator");
123*4882a593Smuzhiyun 	if (IS_ERR(idata->regulator))
124*4882a593Smuzhiyun 		return PTR_ERR(idata->regulator);
125*4882a593Smuzhiyun 
126*4882a593Smuzhiyun 	idata->rc = devm_rc_allocate_device(&spi->dev, RC_DRIVER_IR_RAW_TX);
127*4882a593Smuzhiyun 	if (!idata->rc)
128*4882a593Smuzhiyun 		return -ENOMEM;
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun 	idata->rc->tx_ir           = ir_spi_tx;
131*4882a593Smuzhiyun 	idata->rc->s_tx_carrier    = ir_spi_set_tx_carrier;
132*4882a593Smuzhiyun 	idata->rc->s_tx_duty_cycle = ir_spi_set_duty_cycle;
133*4882a593Smuzhiyun 	idata->rc->device_name	   = "IR SPI";
134*4882a593Smuzhiyun 	idata->rc->driver_name     = IR_SPI_DRIVER_NAME;
135*4882a593Smuzhiyun 	idata->rc->priv            = idata;
136*4882a593Smuzhiyun 	idata->spi                 = spi;
137*4882a593Smuzhiyun 
138*4882a593Smuzhiyun 	idata->negated = of_property_read_bool(spi->dev.of_node,
139*4882a593Smuzhiyun 							"led-active-low");
140*4882a593Smuzhiyun 	ret = of_property_read_u8(spi->dev.of_node, "duty-cycle", &dc);
141*4882a593Smuzhiyun 	if (ret)
142*4882a593Smuzhiyun 		dc = 50;
143*4882a593Smuzhiyun 
144*4882a593Smuzhiyun 	/* ir_spi_set_duty_cycle cannot fail,
145*4882a593Smuzhiyun 	 * it returns int to be compatible with the
146*4882a593Smuzhiyun 	 * rc->s_tx_duty_cycle function
147*4882a593Smuzhiyun 	 */
148*4882a593Smuzhiyun 	ir_spi_set_duty_cycle(idata->rc, dc);
149*4882a593Smuzhiyun 
150*4882a593Smuzhiyun 	idata->freq = IR_SPI_DEFAULT_FREQUENCY;
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun 	return devm_rc_register_device(&spi->dev, idata->rc);
153*4882a593Smuzhiyun }
154*4882a593Smuzhiyun 
ir_spi_remove(struct spi_device * spi)155*4882a593Smuzhiyun static int ir_spi_remove(struct spi_device *spi)
156*4882a593Smuzhiyun {
157*4882a593Smuzhiyun 	return 0;
158*4882a593Smuzhiyun }
159*4882a593Smuzhiyun 
160*4882a593Smuzhiyun static const struct of_device_id ir_spi_of_match[] = {
161*4882a593Smuzhiyun 	{ .compatible = "ir-spi-led" },
162*4882a593Smuzhiyun 	{},
163*4882a593Smuzhiyun };
164*4882a593Smuzhiyun MODULE_DEVICE_TABLE(of, ir_spi_of_match);
165*4882a593Smuzhiyun 
166*4882a593Smuzhiyun static struct spi_driver ir_spi_driver = {
167*4882a593Smuzhiyun 	.probe = ir_spi_probe,
168*4882a593Smuzhiyun 	.remove = ir_spi_remove,
169*4882a593Smuzhiyun 	.driver = {
170*4882a593Smuzhiyun 		.name = IR_SPI_DRIVER_NAME,
171*4882a593Smuzhiyun 		.of_match_table = ir_spi_of_match,
172*4882a593Smuzhiyun 	},
173*4882a593Smuzhiyun };
174*4882a593Smuzhiyun 
175*4882a593Smuzhiyun module_spi_driver(ir_spi_driver);
176*4882a593Smuzhiyun 
177*4882a593Smuzhiyun MODULE_AUTHOR("Andi Shyti <andi@etezian.org>");
178*4882a593Smuzhiyun MODULE_DESCRIPTION("SPI IR LED");
179*4882a593Smuzhiyun MODULE_LICENSE("GPL v2");
180