GNU Linux-libre 4.19.264-gnu1
[releases.git] / drivers / iio / accel / stk8312.c
1 /**
2  * Sensortek STK8312 3-Axis Accelerometer
3  *
4  * Copyright (c) 2015, Intel Corporation.
5  *
6  * This file is subject to the terms and conditions of version 2 of
7  * the GNU General Public License. See the file COPYING in the main
8  * directory of this archive for more details.
9  *
10  * IIO driver for STK8312; 7-bit I2C address: 0x3D.
11  */
12
13 #include <linux/acpi.h>
14 #include <linux/i2c.h>
15 #include <linux/interrupt.h>
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/delay.h>
19 #include <linux/iio/buffer.h>
20 #include <linux/iio/iio.h>
21 #include <linux/iio/sysfs.h>
22 #include <linux/iio/trigger.h>
23 #include <linux/iio/triggered_buffer.h>
24 #include <linux/iio/trigger_consumer.h>
25
26 #define STK8312_REG_XOUT                0x00
27 #define STK8312_REG_YOUT                0x01
28 #define STK8312_REG_ZOUT                0x02
29 #define STK8312_REG_INTSU               0x06
30 #define STK8312_REG_MODE                0x07
31 #define STK8312_REG_SR                  0x08
32 #define STK8312_REG_STH                 0x13
33 #define STK8312_REG_RESET               0x20
34 #define STK8312_REG_AFECTRL             0x24
35 #define STK8312_REG_OTPADDR             0x3D
36 #define STK8312_REG_OTPDATA             0x3E
37 #define STK8312_REG_OTPCTRL             0x3F
38
39 #define STK8312_MODE_ACTIVE             BIT(0)
40 #define STK8312_MODE_STANDBY            0x00
41 #define STK8312_MODE_INT_AH_PP          0xC0    /* active-high, push-pull */
42 #define STK8312_DREADY_BIT              BIT(4)
43 #define STK8312_RNG_6G                  1
44 #define STK8312_RNG_SHIFT               6
45 #define STK8312_RNG_MASK                GENMASK(7, 6)
46 #define STK8312_SR_MASK                 GENMASK(2, 0)
47 #define STK8312_SR_400HZ_IDX            0
48 #define STK8312_ALL_CHANNEL_MASK        GENMASK(2, 0)
49 #define STK8312_ALL_CHANNEL_SIZE        3
50
51 #define STK8312_DRIVER_NAME             "stk8312"
52 #define STK8312_IRQ_NAME                "stk8312_event"
53
54 /*
55  * The accelerometer has two measurement ranges:
56  *
57  * -6g - +6g (8-bit, signed)
58  * -16g - +16g (8-bit, signed)
59  *
60  * scale1 = (6 + 6) * 9.81 / (2^8 - 1)     = 0.4616
61  * scale2 = (16 + 16) * 9.81 / (2^8 - 1)   = 1.2311
62  */
63 #define STK8312_SCALE_AVAIL             "0.4616 1.2311"
64
65 static const int stk8312_scale_table[][2] = {
66         {0, 461600}, {1, 231100}
67 };
68
69 static const struct {
70         int val;
71         int val2;
72 } stk8312_samp_freq_table[] = {
73         {400, 0}, {200, 0}, {100, 0}, {50, 0}, {25, 0},
74         {12, 500000}, {6, 250000}, {3, 125000}
75 };
76
77 #define STK8312_ACCEL_CHANNEL(index, reg, axis) {                       \
78         .type = IIO_ACCEL,                                              \
79         .address = reg,                                                 \
80         .modified = 1,                                                  \
81         .channel2 = IIO_MOD_##axis,                                     \
82         .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),                   \
83         .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE) |          \
84                                     BIT(IIO_CHAN_INFO_SAMP_FREQ),       \
85         .scan_index = index,                                            \
86         .scan_type = {                                                  \
87                 .sign = 's',                                            \
88                 .realbits = 8,                                          \
89                 .storagebits = 8,                                       \
90                 .endianness = IIO_CPU,                                  \
91         },                                                              \
92 }
93
94 static const struct iio_chan_spec stk8312_channels[] = {
95         STK8312_ACCEL_CHANNEL(0, STK8312_REG_XOUT, X),
96         STK8312_ACCEL_CHANNEL(1, STK8312_REG_YOUT, Y),
97         STK8312_ACCEL_CHANNEL(2, STK8312_REG_ZOUT, Z),
98         IIO_CHAN_SOFT_TIMESTAMP(3),
99 };
100
101 struct stk8312_data {
102         struct i2c_client *client;
103         struct mutex lock;
104         u8 range;
105         u8 sample_rate_idx;
106         u8 mode;
107         struct iio_trigger *dready_trig;
108         bool dready_trigger_on;
109         /* Ensure timestamp is naturally aligned */
110         struct {
111                 s8 chans[3];
112                 s64 timestamp __aligned(8);
113         } scan;
114 };
115
116 static IIO_CONST_ATTR(in_accel_scale_available, STK8312_SCALE_AVAIL);
117
118 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("3.125 6.25 12.5 25 50 100 200 400");
119
120 static struct attribute *stk8312_attributes[] = {
121         &iio_const_attr_in_accel_scale_available.dev_attr.attr,
122         &iio_const_attr_sampling_frequency_available.dev_attr.attr,
123         NULL,
124 };
125
126 static const struct attribute_group stk8312_attribute_group = {
127         .attrs = stk8312_attributes
128 };
129
130 static int stk8312_otp_init(struct stk8312_data *data)
131 {
132         int ret;
133         int count = 10;
134         struct i2c_client *client = data->client;
135
136         ret = i2c_smbus_write_byte_data(client, STK8312_REG_OTPADDR, 0x70);
137         if (ret < 0)
138                 goto exit_err;
139         ret = i2c_smbus_write_byte_data(client, STK8312_REG_OTPCTRL, 0x02);
140         if (ret < 0)
141                 goto exit_err;
142
143         do {
144                 usleep_range(1000, 5000);
145                 ret = i2c_smbus_read_byte_data(client, STK8312_REG_OTPCTRL);
146                 if (ret < 0)
147                         goto exit_err;
148                 count--;
149         } while (!(ret & BIT(7)) && count > 0);
150
151         if (count == 0) {
152                 ret = -ETIMEDOUT;
153                 goto exit_err;
154         }
155
156         ret = i2c_smbus_read_byte_data(client, STK8312_REG_OTPDATA);
157         if (ret == 0)
158                 ret = -EINVAL;
159         if (ret < 0)
160                 goto exit_err;
161
162         ret = i2c_smbus_write_byte_data(data->client, STK8312_REG_AFECTRL, ret);
163         if (ret < 0)
164                 goto exit_err;
165         msleep(150);
166
167         return 0;
168
169 exit_err:
170         dev_err(&client->dev, "failed to initialize sensor\n");
171         return ret;
172 }
173
174 static int stk8312_set_mode(struct stk8312_data *data, u8 mode)
175 {
176         int ret;
177         struct i2c_client *client = data->client;
178
179         if (mode == data->mode)
180                 return 0;
181
182         ret = i2c_smbus_write_byte_data(client, STK8312_REG_MODE, mode);
183         if (ret < 0) {
184                 dev_err(&client->dev, "failed to change sensor mode\n");
185                 return ret;
186         }
187
188         data->mode = mode;
189         if (mode & STK8312_MODE_ACTIVE) {
190                 /* Need to run OTP sequence before entering active mode */
191                 usleep_range(1000, 5000);
192                 ret = stk8312_otp_init(data);
193         }
194
195         return ret;
196 }
197
198 static int stk8312_set_interrupts(struct stk8312_data *data, u8 int_mask)
199 {
200         int ret;
201         u8 mode;
202         struct i2c_client *client = data->client;
203
204         mode = data->mode;
205         /* We need to go in standby mode to modify registers */
206         ret = stk8312_set_mode(data, STK8312_MODE_STANDBY);
207         if (ret < 0)
208                 return ret;
209
210         ret = i2c_smbus_write_byte_data(client, STK8312_REG_INTSU, int_mask);
211         if (ret < 0) {
212                 dev_err(&client->dev, "failed to set interrupts\n");
213                 stk8312_set_mode(data, mode);
214                 return ret;
215         }
216
217         return stk8312_set_mode(data, mode);
218 }
219
220 static int stk8312_data_rdy_trigger_set_state(struct iio_trigger *trig,
221                                               bool state)
222 {
223         struct iio_dev *indio_dev = iio_trigger_get_drvdata(trig);
224         struct stk8312_data *data = iio_priv(indio_dev);
225         int ret;
226
227         if (state)
228                 ret = stk8312_set_interrupts(data, STK8312_DREADY_BIT);
229         else
230                 ret = stk8312_set_interrupts(data, 0x00);
231
232         if (ret < 0) {
233                 dev_err(&data->client->dev, "failed to set trigger state\n");
234                 return ret;
235         }
236
237         data->dready_trigger_on = state;
238
239         return 0;
240 }
241
242 static const struct iio_trigger_ops stk8312_trigger_ops = {
243         .set_trigger_state = stk8312_data_rdy_trigger_set_state,
244 };
245
246 static int stk8312_set_sample_rate(struct stk8312_data *data, u8 rate)
247 {
248         int ret;
249         u8 masked_reg;
250         u8 mode;
251         struct i2c_client *client = data->client;
252
253         if (rate == data->sample_rate_idx)
254                 return 0;
255
256         mode = data->mode;
257         /* We need to go in standby mode to modify registers */
258         ret = stk8312_set_mode(data, STK8312_MODE_STANDBY);
259         if (ret < 0)
260                 return ret;
261
262         ret = i2c_smbus_read_byte_data(client, STK8312_REG_SR);
263         if (ret < 0)
264                 goto err_activate;
265
266         masked_reg = (ret & (~STK8312_SR_MASK)) | rate;
267
268         ret = i2c_smbus_write_byte_data(client, STK8312_REG_SR, masked_reg);
269         if (ret < 0)
270                 goto err_activate;
271
272         data->sample_rate_idx = rate;
273
274         return stk8312_set_mode(data, mode);
275
276 err_activate:
277         dev_err(&client->dev, "failed to set sampling rate\n");
278         stk8312_set_mode(data, mode);
279
280         return ret;
281 }
282
283 static int stk8312_set_range(struct stk8312_data *data, u8 range)
284 {
285         int ret;
286         u8 masked_reg;
287         u8 mode;
288         struct i2c_client *client = data->client;
289
290         if (range != 1 && range != 2)
291                 return -EINVAL;
292         else if (range == data->range)
293                 return 0;
294
295         mode = data->mode;
296         /* We need to go in standby mode to modify registers */
297         ret = stk8312_set_mode(data, STK8312_MODE_STANDBY);
298         if (ret < 0)
299                 return ret;
300
301         ret = i2c_smbus_read_byte_data(client, STK8312_REG_STH);
302         if (ret < 0)
303                 goto err_activate;
304
305         masked_reg = ret & (~STK8312_RNG_MASK);
306         masked_reg |= range << STK8312_RNG_SHIFT;
307
308         ret = i2c_smbus_write_byte_data(client, STK8312_REG_STH, masked_reg);
309         if (ret < 0)
310                 goto err_activate;
311
312         data->range = range;
313
314         return stk8312_set_mode(data, mode);
315
316 err_activate:
317         dev_err(&client->dev, "failed to change sensor range\n");
318         stk8312_set_mode(data, mode);
319
320         return ret;
321 }
322
323 static int stk8312_read_accel(struct stk8312_data *data, u8 address)
324 {
325         int ret;
326         struct i2c_client *client = data->client;
327
328         if (address > 2)
329                 return -EINVAL;
330
331         ret = i2c_smbus_read_byte_data(client, address);
332         if (ret < 0)
333                 dev_err(&client->dev, "register read failed\n");
334
335         return ret;
336 }
337
338 static int stk8312_read_raw(struct iio_dev *indio_dev,
339                             struct iio_chan_spec const *chan,
340                             int *val, int *val2, long mask)
341 {
342         struct stk8312_data *data = iio_priv(indio_dev);
343         int ret;
344
345         switch (mask) {
346         case IIO_CHAN_INFO_RAW:
347                 if (iio_buffer_enabled(indio_dev))
348                         return -EBUSY;
349                 mutex_lock(&data->lock);
350                 ret = stk8312_set_mode(data, data->mode | STK8312_MODE_ACTIVE);
351                 if (ret < 0) {
352                         mutex_unlock(&data->lock);
353                         return ret;
354                 }
355                 ret = stk8312_read_accel(data, chan->address);
356                 if (ret < 0) {
357                         stk8312_set_mode(data,
358                                          data->mode & (~STK8312_MODE_ACTIVE));
359                         mutex_unlock(&data->lock);
360                         return ret;
361                 }
362                 *val = sign_extend32(ret, 7);
363                 ret = stk8312_set_mode(data,
364                                        data->mode & (~STK8312_MODE_ACTIVE));
365                 mutex_unlock(&data->lock);
366                 if (ret < 0)
367                         return ret;
368                 return IIO_VAL_INT;
369         case IIO_CHAN_INFO_SCALE:
370                 *val = stk8312_scale_table[data->range - 1][0];
371                 *val2 = stk8312_scale_table[data->range - 1][1];
372                 return IIO_VAL_INT_PLUS_MICRO;
373         case IIO_CHAN_INFO_SAMP_FREQ:
374                 *val = stk8312_samp_freq_table[data->sample_rate_idx].val;
375                 *val2 = stk8312_samp_freq_table[data->sample_rate_idx].val2;
376                 return IIO_VAL_INT_PLUS_MICRO;
377         }
378
379         return -EINVAL;
380 }
381
382 static int stk8312_write_raw(struct iio_dev *indio_dev,
383                              struct iio_chan_spec const *chan,
384                              int val, int val2, long mask)
385 {
386         int i;
387         int index = -1;
388         int ret;
389         struct stk8312_data *data = iio_priv(indio_dev);
390
391         switch (mask) {
392         case IIO_CHAN_INFO_SCALE:
393                 for (i = 0; i < ARRAY_SIZE(stk8312_scale_table); i++)
394                         if (val == stk8312_scale_table[i][0] &&
395                             val2 == stk8312_scale_table[i][1]) {
396                                 index = i + 1;
397                                 break;
398                         }
399                 if (index < 0)
400                         return -EINVAL;
401
402                 mutex_lock(&data->lock);
403                 ret = stk8312_set_range(data, index);
404                 mutex_unlock(&data->lock);
405
406                 return ret;
407         case IIO_CHAN_INFO_SAMP_FREQ:
408                 for (i = 0; i < ARRAY_SIZE(stk8312_samp_freq_table); i++)
409                         if (val == stk8312_samp_freq_table[i].val &&
410                             val2 == stk8312_samp_freq_table[i].val2) {
411                                 index = i;
412                                 break;
413                         }
414                 if (index < 0)
415                         return -EINVAL;
416                 mutex_lock(&data->lock);
417                 ret = stk8312_set_sample_rate(data, index);
418                 mutex_unlock(&data->lock);
419
420                 return ret;
421         }
422
423         return -EINVAL;
424 }
425
426 static const struct iio_info stk8312_info = {
427         .read_raw               = stk8312_read_raw,
428         .write_raw              = stk8312_write_raw,
429         .attrs                  = &stk8312_attribute_group,
430 };
431
432 static irqreturn_t stk8312_trigger_handler(int irq, void *p)
433 {
434         struct iio_poll_func *pf = p;
435         struct iio_dev *indio_dev = pf->indio_dev;
436         struct stk8312_data *data = iio_priv(indio_dev);
437         int bit, ret, i = 0;
438
439         mutex_lock(&data->lock);
440         /*
441          * Do a bulk read if all channels are requested,
442          * from 0x00 (XOUT) to 0x02 (ZOUT)
443          */
444         if (*(indio_dev->active_scan_mask) == STK8312_ALL_CHANNEL_MASK) {
445                 ret = i2c_smbus_read_i2c_block_data(data->client,
446                                                     STK8312_REG_XOUT,
447                                                     STK8312_ALL_CHANNEL_SIZE,
448                                                     data->scan.chans);
449                 if (ret < STK8312_ALL_CHANNEL_SIZE) {
450                         dev_err(&data->client->dev, "register read failed\n");
451                         mutex_unlock(&data->lock);
452                         goto err;
453                 }
454         } else {
455                 for_each_set_bit(bit, indio_dev->active_scan_mask,
456                                  indio_dev->masklength) {
457                         ret = stk8312_read_accel(data, bit);
458                         if (ret < 0) {
459                                 mutex_unlock(&data->lock);
460                                 goto err;
461                         }
462                         data->scan.chans[i++] = ret;
463                 }
464         }
465         mutex_unlock(&data->lock);
466
467         iio_push_to_buffers_with_timestamp(indio_dev, &data->scan,
468                                            pf->timestamp);
469 err:
470         iio_trigger_notify_done(indio_dev->trig);
471
472         return IRQ_HANDLED;
473 }
474
475 static irqreturn_t stk8312_data_rdy_trig_poll(int irq, void *private)
476 {
477         struct iio_dev *indio_dev = private;
478         struct stk8312_data *data = iio_priv(indio_dev);
479
480         if (data->dready_trigger_on)
481                 iio_trigger_poll(data->dready_trig);
482
483         return IRQ_HANDLED;
484 }
485
486 static int stk8312_buffer_preenable(struct iio_dev *indio_dev)
487 {
488         struct stk8312_data *data = iio_priv(indio_dev);
489
490         return stk8312_set_mode(data, data->mode | STK8312_MODE_ACTIVE);
491 }
492
493 static int stk8312_buffer_postdisable(struct iio_dev *indio_dev)
494 {
495         struct stk8312_data *data = iio_priv(indio_dev);
496
497         return stk8312_set_mode(data, data->mode & (~STK8312_MODE_ACTIVE));
498 }
499
500 static const struct iio_buffer_setup_ops stk8312_buffer_setup_ops = {
501         .preenable   = stk8312_buffer_preenable,
502         .postenable  = iio_triggered_buffer_postenable,
503         .predisable  = iio_triggered_buffer_predisable,
504         .postdisable = stk8312_buffer_postdisable,
505 };
506
507 static int stk8312_probe(struct i2c_client *client,
508                          const struct i2c_device_id *id)
509 {
510         int ret;
511         struct iio_dev *indio_dev;
512         struct stk8312_data *data;
513
514         indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
515         if (!indio_dev) {
516                 dev_err(&client->dev, "iio allocation failed!\n");
517                 return -ENOMEM;
518         }
519
520         data = iio_priv(indio_dev);
521         data->client = client;
522         i2c_set_clientdata(client, indio_dev);
523         mutex_init(&data->lock);
524
525         indio_dev->dev.parent = &client->dev;
526         indio_dev->info = &stk8312_info;
527         indio_dev->name = STK8312_DRIVER_NAME;
528         indio_dev->modes = INDIO_DIRECT_MODE;
529         indio_dev->channels = stk8312_channels;
530         indio_dev->num_channels = ARRAY_SIZE(stk8312_channels);
531
532         /* A software reset is recommended at power-on */
533         ret = i2c_smbus_write_byte_data(data->client, STK8312_REG_RESET, 0x00);
534         if (ret < 0) {
535                 dev_err(&client->dev, "failed to reset sensor\n");
536                 return ret;
537         }
538         data->sample_rate_idx = STK8312_SR_400HZ_IDX;
539         ret = stk8312_set_range(data, STK8312_RNG_6G);
540         if (ret < 0)
541                 return ret;
542
543         ret = stk8312_set_mode(data,
544                                STK8312_MODE_INT_AH_PP | STK8312_MODE_ACTIVE);
545         if (ret < 0)
546                 return ret;
547
548         if (client->irq > 0) {
549                 ret = devm_request_threaded_irq(&client->dev, client->irq,
550                                                 stk8312_data_rdy_trig_poll,
551                                                 NULL,
552                                                 IRQF_TRIGGER_RISING |
553                                                 IRQF_ONESHOT,
554                                                 STK8312_IRQ_NAME,
555                                                 indio_dev);
556                 if (ret < 0) {
557                         dev_err(&client->dev, "request irq %d failed\n",
558                                 client->irq);
559                         goto err_power_off;
560                 }
561
562                 data->dready_trig = devm_iio_trigger_alloc(&client->dev,
563                                                            "%s-dev%d",
564                                                            indio_dev->name,
565                                                            indio_dev->id);
566                 if (!data->dready_trig) {
567                         ret = -ENOMEM;
568                         goto err_power_off;
569                 }
570
571                 data->dready_trig->dev.parent = &client->dev;
572                 data->dready_trig->ops = &stk8312_trigger_ops;
573                 iio_trigger_set_drvdata(data->dready_trig, indio_dev);
574                 ret = iio_trigger_register(data->dready_trig);
575                 if (ret) {
576                         dev_err(&client->dev, "iio trigger register failed\n");
577                         goto err_power_off;
578                 }
579         }
580
581         ret = iio_triggered_buffer_setup(indio_dev,
582                                          iio_pollfunc_store_time,
583                                          stk8312_trigger_handler,
584                                          &stk8312_buffer_setup_ops);
585         if (ret < 0) {
586                 dev_err(&client->dev, "iio triggered buffer setup failed\n");
587                 goto err_trigger_unregister;
588         }
589
590         ret = iio_device_register(indio_dev);
591         if (ret < 0) {
592                 dev_err(&client->dev, "device_register failed\n");
593                 goto err_buffer_cleanup;
594         }
595
596         return 0;
597
598 err_buffer_cleanup:
599         iio_triggered_buffer_cleanup(indio_dev);
600 err_trigger_unregister:
601         if (data->dready_trig)
602                 iio_trigger_unregister(data->dready_trig);
603 err_power_off:
604         stk8312_set_mode(data, STK8312_MODE_STANDBY);
605         return ret;
606 }
607
608 static int stk8312_remove(struct i2c_client *client)
609 {
610         struct iio_dev *indio_dev = i2c_get_clientdata(client);
611         struct stk8312_data *data = iio_priv(indio_dev);
612
613         iio_device_unregister(indio_dev);
614         iio_triggered_buffer_cleanup(indio_dev);
615
616         if (data->dready_trig)
617                 iio_trigger_unregister(data->dready_trig);
618
619         return stk8312_set_mode(data, STK8312_MODE_STANDBY);
620 }
621
622 #ifdef CONFIG_PM_SLEEP
623 static int stk8312_suspend(struct device *dev)
624 {
625         struct stk8312_data *data;
626
627         data = iio_priv(i2c_get_clientdata(to_i2c_client(dev)));
628
629         return stk8312_set_mode(data, data->mode & (~STK8312_MODE_ACTIVE));
630 }
631
632 static int stk8312_resume(struct device *dev)
633 {
634         struct stk8312_data *data;
635
636         data = iio_priv(i2c_get_clientdata(to_i2c_client(dev)));
637
638         return stk8312_set_mode(data, data->mode | STK8312_MODE_ACTIVE);
639 }
640
641 static SIMPLE_DEV_PM_OPS(stk8312_pm_ops, stk8312_suspend, stk8312_resume);
642
643 #define STK8312_PM_OPS (&stk8312_pm_ops)
644 #else
645 #define STK8312_PM_OPS NULL
646 #endif
647
648 static const struct i2c_device_id stk8312_i2c_id[] = {
649         {"STK8312", 0},
650         {}
651 };
652 MODULE_DEVICE_TABLE(i2c, stk8312_i2c_id);
653
654 static const struct acpi_device_id stk8312_acpi_id[] = {
655         {"STK8312", 0},
656         {}
657 };
658
659 MODULE_DEVICE_TABLE(acpi, stk8312_acpi_id);
660
661 static struct i2c_driver stk8312_driver = {
662         .driver = {
663                 .name = STK8312_DRIVER_NAME,
664                 .pm = STK8312_PM_OPS,
665                 .acpi_match_table = ACPI_PTR(stk8312_acpi_id),
666         },
667         .probe =            stk8312_probe,
668         .remove =           stk8312_remove,
669         .id_table =         stk8312_i2c_id,
670 };
671
672 module_i2c_driver(stk8312_driver);
673
674 MODULE_AUTHOR("Tiberiu Breana <tiberiu.a.breana@intel.com>");
675 MODULE_DESCRIPTION("STK8312 3-Axis Accelerometer driver");
676 MODULE_LICENSE("GPL v2");