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