xref: /OK3568_Linux_fs/kernel/drivers/iio/light/tsl4531.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * tsl4531.c - Support for TAOS TSL4531 ambient light sensor
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright 2013 Peter Meerwald <pmeerw@pmeerw.net>
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * IIO driver for the TSL4531x family
8*4882a593Smuzhiyun  *   TSL45311/TSL45313: 7-bit I2C slave address 0x39
9*4882a593Smuzhiyun  *   TSL45315/TSL45317: 7-bit I2C slave address 0x29
10*4882a593Smuzhiyun  *
11*4882a593Smuzhiyun  * TODO: single cycle measurement
12*4882a593Smuzhiyun  */
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #include <linux/module.h>
15*4882a593Smuzhiyun #include <linux/i2c.h>
16*4882a593Smuzhiyun #include <linux/err.h>
17*4882a593Smuzhiyun #include <linux/delay.h>
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun #include <linux/iio/iio.h>
20*4882a593Smuzhiyun #include <linux/iio/sysfs.h>
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun #define TSL4531_DRV_NAME "tsl4531"
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun #define TSL4531_COMMAND BIT(7)
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun #define TSL4531_CONTROL (TSL4531_COMMAND | 0x00)
27*4882a593Smuzhiyun #define TSL4531_CONFIG (TSL4531_COMMAND | 0x01)
28*4882a593Smuzhiyun #define TSL4531_DATA (TSL4531_COMMAND | 0x04)
29*4882a593Smuzhiyun #define TSL4531_ID (TSL4531_COMMAND | 0x0a)
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun /* operating modes in control register */
32*4882a593Smuzhiyun #define TSL4531_MODE_POWERDOWN 0x00
33*4882a593Smuzhiyun #define TSL4531_MODE_SINGLE_ADC 0x02
34*4882a593Smuzhiyun #define TSL4531_MODE_NORMAL 0x03
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun /* integration time control in config register */
37*4882a593Smuzhiyun #define TSL4531_TCNTRL_400MS 0x00
38*4882a593Smuzhiyun #define TSL4531_TCNTRL_200MS 0x01
39*4882a593Smuzhiyun #define TSL4531_TCNTRL_100MS 0x02
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun /* part number in id register */
42*4882a593Smuzhiyun #define TSL45311_ID 0x8
43*4882a593Smuzhiyun #define TSL45313_ID 0x9
44*4882a593Smuzhiyun #define TSL45315_ID 0xa
45*4882a593Smuzhiyun #define TSL45317_ID 0xb
46*4882a593Smuzhiyun #define TSL4531_ID_SHIFT 4
47*4882a593Smuzhiyun 
48*4882a593Smuzhiyun struct tsl4531_data {
49*4882a593Smuzhiyun 	struct i2c_client *client;
50*4882a593Smuzhiyun 	struct mutex lock;
51*4882a593Smuzhiyun 	int int_time;
52*4882a593Smuzhiyun };
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun static IIO_CONST_ATTR_INT_TIME_AVAIL("0.1 0.2 0.4");
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun static struct attribute *tsl4531_attributes[] = {
57*4882a593Smuzhiyun 	&iio_const_attr_integration_time_available.dev_attr.attr,
58*4882a593Smuzhiyun 	NULL
59*4882a593Smuzhiyun };
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun static const struct attribute_group tsl4531_attribute_group = {
62*4882a593Smuzhiyun 	.attrs = tsl4531_attributes,
63*4882a593Smuzhiyun };
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun static const struct iio_chan_spec tsl4531_channels[] = {
66*4882a593Smuzhiyun 	{
67*4882a593Smuzhiyun 		.type = IIO_LIGHT,
68*4882a593Smuzhiyun 		.info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
69*4882a593Smuzhiyun 			BIT(IIO_CHAN_INFO_SCALE) |
70*4882a593Smuzhiyun 			BIT(IIO_CHAN_INFO_INT_TIME)
71*4882a593Smuzhiyun 	}
72*4882a593Smuzhiyun };
73*4882a593Smuzhiyun 
tsl4531_read_raw(struct iio_dev * indio_dev,struct iio_chan_spec const * chan,int * val,int * val2,long mask)74*4882a593Smuzhiyun static int tsl4531_read_raw(struct iio_dev *indio_dev,
75*4882a593Smuzhiyun 				struct iio_chan_spec const *chan,
76*4882a593Smuzhiyun 				int *val, int *val2, long mask)
77*4882a593Smuzhiyun {
78*4882a593Smuzhiyun 	struct tsl4531_data *data = iio_priv(indio_dev);
79*4882a593Smuzhiyun 	int ret;
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 	switch (mask) {
82*4882a593Smuzhiyun 	case IIO_CHAN_INFO_RAW:
83*4882a593Smuzhiyun 		ret = i2c_smbus_read_word_data(data->client,
84*4882a593Smuzhiyun 			TSL4531_DATA);
85*4882a593Smuzhiyun 		if (ret < 0)
86*4882a593Smuzhiyun 			return ret;
87*4882a593Smuzhiyun 		*val = ret;
88*4882a593Smuzhiyun 		return IIO_VAL_INT;
89*4882a593Smuzhiyun 	case IIO_CHAN_INFO_SCALE:
90*4882a593Smuzhiyun 		/* 0.. 1x, 1 .. 2x, 2 .. 4x */
91*4882a593Smuzhiyun 		*val = 1 << data->int_time;
92*4882a593Smuzhiyun 		return IIO_VAL_INT;
93*4882a593Smuzhiyun 	case IIO_CHAN_INFO_INT_TIME:
94*4882a593Smuzhiyun 		if (data->int_time == 0)
95*4882a593Smuzhiyun 			*val2 = 400000;
96*4882a593Smuzhiyun 		else if (data->int_time == 1)
97*4882a593Smuzhiyun 			*val2 = 200000;
98*4882a593Smuzhiyun 		else if (data->int_time == 2)
99*4882a593Smuzhiyun 			*val2 = 100000;
100*4882a593Smuzhiyun 		else
101*4882a593Smuzhiyun 			return -EINVAL;
102*4882a593Smuzhiyun 		*val = 0;
103*4882a593Smuzhiyun 		return IIO_VAL_INT_PLUS_MICRO;
104*4882a593Smuzhiyun 	default:
105*4882a593Smuzhiyun 		return -EINVAL;
106*4882a593Smuzhiyun 	}
107*4882a593Smuzhiyun }
108*4882a593Smuzhiyun 
tsl4531_write_raw(struct iio_dev * indio_dev,struct iio_chan_spec const * chan,int val,int val2,long mask)109*4882a593Smuzhiyun static int tsl4531_write_raw(struct iio_dev *indio_dev,
110*4882a593Smuzhiyun 			     struct iio_chan_spec const *chan,
111*4882a593Smuzhiyun 			     int val, int val2, long mask)
112*4882a593Smuzhiyun {
113*4882a593Smuzhiyun 	struct tsl4531_data *data = iio_priv(indio_dev);
114*4882a593Smuzhiyun 	int int_time, ret;
115*4882a593Smuzhiyun 
116*4882a593Smuzhiyun 	switch (mask) {
117*4882a593Smuzhiyun 	case IIO_CHAN_INFO_INT_TIME:
118*4882a593Smuzhiyun 		if (val != 0)
119*4882a593Smuzhiyun 			return -EINVAL;
120*4882a593Smuzhiyun 		if (val2 == 400000)
121*4882a593Smuzhiyun 			int_time = 0;
122*4882a593Smuzhiyun 		else if (val2 == 200000)
123*4882a593Smuzhiyun 			int_time = 1;
124*4882a593Smuzhiyun 		else if (val2 == 100000)
125*4882a593Smuzhiyun 			int_time = 2;
126*4882a593Smuzhiyun 		else
127*4882a593Smuzhiyun 			return -EINVAL;
128*4882a593Smuzhiyun 		mutex_lock(&data->lock);
129*4882a593Smuzhiyun 		ret = i2c_smbus_write_byte_data(data->client,
130*4882a593Smuzhiyun 			TSL4531_CONFIG, int_time);
131*4882a593Smuzhiyun 		if (ret >= 0)
132*4882a593Smuzhiyun 			data->int_time = int_time;
133*4882a593Smuzhiyun 		mutex_unlock(&data->lock);
134*4882a593Smuzhiyun 		return ret;
135*4882a593Smuzhiyun 	default:
136*4882a593Smuzhiyun 		return -EINVAL;
137*4882a593Smuzhiyun 	}
138*4882a593Smuzhiyun }
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun static const struct iio_info tsl4531_info = {
141*4882a593Smuzhiyun 	.read_raw = tsl4531_read_raw,
142*4882a593Smuzhiyun 	.write_raw = tsl4531_write_raw,
143*4882a593Smuzhiyun 	.attrs = &tsl4531_attribute_group,
144*4882a593Smuzhiyun };
145*4882a593Smuzhiyun 
tsl4531_check_id(struct i2c_client * client)146*4882a593Smuzhiyun static int tsl4531_check_id(struct i2c_client *client)
147*4882a593Smuzhiyun {
148*4882a593Smuzhiyun 	int ret = i2c_smbus_read_byte_data(client, TSL4531_ID);
149*4882a593Smuzhiyun 	if (ret < 0)
150*4882a593Smuzhiyun 		return ret;
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun 	switch (ret >> TSL4531_ID_SHIFT) {
153*4882a593Smuzhiyun 	case TSL45311_ID:
154*4882a593Smuzhiyun 	case TSL45313_ID:
155*4882a593Smuzhiyun 	case TSL45315_ID:
156*4882a593Smuzhiyun 	case TSL45317_ID:
157*4882a593Smuzhiyun 		return 0;
158*4882a593Smuzhiyun 	default:
159*4882a593Smuzhiyun 		return -ENODEV;
160*4882a593Smuzhiyun 	}
161*4882a593Smuzhiyun }
162*4882a593Smuzhiyun 
tsl4531_probe(struct i2c_client * client,const struct i2c_device_id * id)163*4882a593Smuzhiyun static int tsl4531_probe(struct i2c_client *client,
164*4882a593Smuzhiyun 			  const struct i2c_device_id *id)
165*4882a593Smuzhiyun {
166*4882a593Smuzhiyun 	struct tsl4531_data *data;
167*4882a593Smuzhiyun 	struct iio_dev *indio_dev;
168*4882a593Smuzhiyun 	int ret;
169*4882a593Smuzhiyun 
170*4882a593Smuzhiyun 	indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
171*4882a593Smuzhiyun 	if (!indio_dev)
172*4882a593Smuzhiyun 		return -ENOMEM;
173*4882a593Smuzhiyun 
174*4882a593Smuzhiyun 	data = iio_priv(indio_dev);
175*4882a593Smuzhiyun 	i2c_set_clientdata(client, indio_dev);
176*4882a593Smuzhiyun 	data->client = client;
177*4882a593Smuzhiyun 	mutex_init(&data->lock);
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun 	ret = tsl4531_check_id(client);
180*4882a593Smuzhiyun 	if (ret) {
181*4882a593Smuzhiyun 		dev_err(&client->dev, "no TSL4531 sensor\n");
182*4882a593Smuzhiyun 		return ret;
183*4882a593Smuzhiyun 	}
184*4882a593Smuzhiyun 
185*4882a593Smuzhiyun 	ret = i2c_smbus_write_byte_data(data->client, TSL4531_CONTROL,
186*4882a593Smuzhiyun 		TSL4531_MODE_NORMAL);
187*4882a593Smuzhiyun 	if (ret < 0)
188*4882a593Smuzhiyun 		return ret;
189*4882a593Smuzhiyun 
190*4882a593Smuzhiyun 	ret = i2c_smbus_write_byte_data(data->client, TSL4531_CONFIG,
191*4882a593Smuzhiyun 		TSL4531_TCNTRL_400MS);
192*4882a593Smuzhiyun 	if (ret < 0)
193*4882a593Smuzhiyun 		return ret;
194*4882a593Smuzhiyun 
195*4882a593Smuzhiyun 	indio_dev->info = &tsl4531_info;
196*4882a593Smuzhiyun 	indio_dev->channels = tsl4531_channels;
197*4882a593Smuzhiyun 	indio_dev->num_channels = ARRAY_SIZE(tsl4531_channels);
198*4882a593Smuzhiyun 	indio_dev->name = TSL4531_DRV_NAME;
199*4882a593Smuzhiyun 	indio_dev->modes = INDIO_DIRECT_MODE;
200*4882a593Smuzhiyun 
201*4882a593Smuzhiyun 	return iio_device_register(indio_dev);
202*4882a593Smuzhiyun }
203*4882a593Smuzhiyun 
tsl4531_powerdown(struct i2c_client * client)204*4882a593Smuzhiyun static int tsl4531_powerdown(struct i2c_client *client)
205*4882a593Smuzhiyun {
206*4882a593Smuzhiyun 	return i2c_smbus_write_byte_data(client, TSL4531_CONTROL,
207*4882a593Smuzhiyun 		TSL4531_MODE_POWERDOWN);
208*4882a593Smuzhiyun }
209*4882a593Smuzhiyun 
tsl4531_remove(struct i2c_client * client)210*4882a593Smuzhiyun static int tsl4531_remove(struct i2c_client *client)
211*4882a593Smuzhiyun {
212*4882a593Smuzhiyun 	iio_device_unregister(i2c_get_clientdata(client));
213*4882a593Smuzhiyun 	tsl4531_powerdown(client);
214*4882a593Smuzhiyun 
215*4882a593Smuzhiyun 	return 0;
216*4882a593Smuzhiyun }
217*4882a593Smuzhiyun 
218*4882a593Smuzhiyun #ifdef CONFIG_PM_SLEEP
tsl4531_suspend(struct device * dev)219*4882a593Smuzhiyun static int tsl4531_suspend(struct device *dev)
220*4882a593Smuzhiyun {
221*4882a593Smuzhiyun 	return tsl4531_powerdown(to_i2c_client(dev));
222*4882a593Smuzhiyun }
223*4882a593Smuzhiyun 
tsl4531_resume(struct device * dev)224*4882a593Smuzhiyun static int tsl4531_resume(struct device *dev)
225*4882a593Smuzhiyun {
226*4882a593Smuzhiyun 	return i2c_smbus_write_byte_data(to_i2c_client(dev), TSL4531_CONTROL,
227*4882a593Smuzhiyun 		TSL4531_MODE_NORMAL);
228*4882a593Smuzhiyun }
229*4882a593Smuzhiyun 
230*4882a593Smuzhiyun static SIMPLE_DEV_PM_OPS(tsl4531_pm_ops, tsl4531_suspend, tsl4531_resume);
231*4882a593Smuzhiyun #define TSL4531_PM_OPS (&tsl4531_pm_ops)
232*4882a593Smuzhiyun #else
233*4882a593Smuzhiyun #define TSL4531_PM_OPS NULL
234*4882a593Smuzhiyun #endif
235*4882a593Smuzhiyun 
236*4882a593Smuzhiyun static const struct i2c_device_id tsl4531_id[] = {
237*4882a593Smuzhiyun 	{ "tsl4531", 0 },
238*4882a593Smuzhiyun 	{ }
239*4882a593Smuzhiyun };
240*4882a593Smuzhiyun MODULE_DEVICE_TABLE(i2c, tsl4531_id);
241*4882a593Smuzhiyun 
242*4882a593Smuzhiyun static struct i2c_driver tsl4531_driver = {
243*4882a593Smuzhiyun 	.driver = {
244*4882a593Smuzhiyun 		.name   = TSL4531_DRV_NAME,
245*4882a593Smuzhiyun 		.pm	= TSL4531_PM_OPS,
246*4882a593Smuzhiyun 	},
247*4882a593Smuzhiyun 	.probe  = tsl4531_probe,
248*4882a593Smuzhiyun 	.remove = tsl4531_remove,
249*4882a593Smuzhiyun 	.id_table = tsl4531_id,
250*4882a593Smuzhiyun };
251*4882a593Smuzhiyun 
252*4882a593Smuzhiyun module_i2c_driver(tsl4531_driver);
253*4882a593Smuzhiyun 
254*4882a593Smuzhiyun MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>");
255*4882a593Smuzhiyun MODULE_DESCRIPTION("TAOS TSL4531 ambient light sensors driver");
256*4882a593Smuzhiyun MODULE_LICENSE("GPL");
257