iio:bma180: Use bool instead of int for state
[firefly-linux-kernel-4.4.55.git] / drivers / iio / accel / bma180.c
1 /*
2  * bma180.c - IIO driver for Bosch BMA180 triaxial acceleration sensor
3  *
4  * Copyright 2013 Oleksandr Kravchenko <x0199363@ti.com>
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
11 #include <linux/module.h>
12 #include <linux/i2c.h>
13 #include <linux/interrupt.h>
14 #include <linux/delay.h>
15 #include <linux/of.h>
16 #include <linux/bitops.h>
17 #include <linux/slab.h>
18 #include <linux/string.h>
19 #include <linux/iio/iio.h>
20 #include <linux/iio/sysfs.h>
21 #include <linux/iio/buffer.h>
22 #include <linux/iio/trigger.h>
23 #include <linux/iio/trigger_consumer.h>
24 #include <linux/iio/triggered_buffer.h>
25
26 #define BMA180_DRV_NAME "bma180"
27 #define BMA180_IRQ_NAME "bma180_event"
28
29 /* Register set */
30 #define BMA180_CHIP_ID          0x00 /* Need to distinguish BMA180 from other */
31 #define BMA180_ACC_X_LSB        0x02 /* First of 6 registers of accel data */
32 #define BMA180_CTRL_REG0        0x0d
33 #define BMA180_RESET            0x10
34 #define BMA180_BW_TCS           0x20
35 #define BMA180_CTRL_REG3        0x21
36 #define BMA180_TCO_Z            0x30
37 #define BMA180_OFFSET_LSB1      0x35
38
39 /* BMA180_CTRL_REG0 bits */
40 #define BMA180_DIS_WAKE_UP      BIT(0) /* Disable wake up mode */
41 #define BMA180_SLEEP            BIT(1) /* 1 - chip will sleep */
42 #define BMA180_EE_W             BIT(4) /* Unlock writing to addr from 0x20 */
43 #define BMA180_RESET_INT        BIT(6) /* Reset pending interrupts */
44
45 /* BMA180_CTRL_REG3 bits */
46 #define BMA180_NEW_DATA_INT     BIT(1) /* Intr every new accel data is ready */
47
48 /* BMA180_OFFSET_LSB1 skipping mode bit */
49 #define BMA180_SMP_SKIP         BIT(0)
50
51 /* Bit masks for registers bit fields */
52 #define BMA180_RANGE            0x0e /* Range of measured accel values */
53 #define BMA180_BW               0xf0 /* Accel bandwidth */
54 #define BMA180_MODE_CONFIG      0x03 /* Config operation modes */
55
56 /* We have to write this value in reset register to do soft reset */
57 #define BMA180_RESET_VAL        0xb6
58
59 #define BMA180_ID_REG_VAL       0x03
60
61 /* Chip power modes */
62 #define BMA180_LOW_NOISE        0x00
63 #define BMA180_LOW_POWER        0x03
64
65 /* Defaults values */
66 #define BMA180_DEF_PMODE        false
67 #define BMA180_DEF_BW           20
68 #define BMA180_DEF_SCALE        2452
69
70 /* Available values for sysfs */
71 #define BMA180_FLP_FREQ_AVAILABLE \
72         "10 20 40 75 150 300"
73 #define BMA180_SCALE_AVAILABLE \
74         "0.001275 0.001863 0.002452 0.003727 0.004903 0.009709 0.019417"
75
76 struct bma180_data {
77         struct i2c_client *client;
78         struct iio_trigger *trig;
79         struct mutex mutex;
80         bool sleep_state;
81         int scale;
82         int bw;
83         bool pmode;
84         char *buff;
85 };
86
87 enum bma180_axis {
88         AXIS_X,
89         AXIS_Y,
90         AXIS_Z,
91 };
92
93 static int bma180_bw_table[] = { 10, 20, 40, 75, 150, 300 }; /* Hz */
94 static int bma180_scale_table[] = { 1275, 1863, 2452, 3727, 4903, 9709, 19417 };
95
96 static int bma180_get_acc_reg(struct bma180_data *data, enum bma180_axis axis)
97 {
98         u8 reg = BMA180_ACC_X_LSB + axis * 2;
99         int ret;
100
101         if (data->sleep_state)
102                 return -EBUSY;
103
104         ret = i2c_smbus_read_word_data(data->client, reg);
105         if (ret < 0)
106                 dev_err(&data->client->dev,
107                         "failed to read accel_%c register\n", 'x' + axis);
108
109         return ret;
110 }
111
112 static int bma180_set_bits(struct bma180_data *data, u8 reg, u8 mask, u8 val)
113 {
114         int ret = i2c_smbus_read_byte_data(data->client, reg);
115         u8 reg_val = (ret & ~mask) | (val << (ffs(mask) - 1));
116
117         if (ret < 0)
118                 return ret;
119
120         return i2c_smbus_write_byte_data(data->client, reg, reg_val);
121 }
122
123 static int bma180_reset_intr(struct bma180_data *data)
124 {
125         int ret = bma180_set_bits(data, BMA180_CTRL_REG0, BMA180_RESET_INT, 1);
126
127         if (ret)
128                 dev_err(&data->client->dev, "failed to reset interrupt\n");
129
130         return ret;
131 }
132
133 static int bma180_set_new_data_intr_state(struct bma180_data *data, bool state)
134 {
135         u8 reg_val = state ? BMA180_NEW_DATA_INT : 0x00;
136         int ret = i2c_smbus_write_byte_data(data->client, BMA180_CTRL_REG3,
137                         reg_val);
138
139         if (ret)
140                 goto err;
141         ret = bma180_reset_intr(data);
142         if (ret)
143                 goto err;
144
145         return 0;
146
147 err:
148         dev_err(&data->client->dev,
149                 "failed to set new data interrupt state %d\n", state);
150         return ret;
151 }
152
153 static int bma180_set_sleep_state(struct bma180_data *data, bool state)
154 {
155         int ret = bma180_set_bits(data, BMA180_CTRL_REG0, BMA180_SLEEP, state);
156
157         if (ret) {
158                 dev_err(&data->client->dev,
159                         "failed to set sleep state %d\n", state);
160                 return ret;
161         }
162         data->sleep_state = state;
163
164         return 0;
165 }
166
167 static int bma180_set_ee_writing_state(struct bma180_data *data, bool state)
168 {
169         int ret = bma180_set_bits(data, BMA180_CTRL_REG0, BMA180_EE_W, state);
170
171         if (ret)
172                 dev_err(&data->client->dev,
173                         "failed to set ee writing state %d\n", state);
174
175         return ret;
176 }
177
178 static int bma180_set_bw(struct bma180_data *data, int val)
179 {
180         int ret, i;
181
182         if (data->sleep_state)
183                 return -EBUSY;
184
185         for (i = 0; i < ARRAY_SIZE(bma180_bw_table); ++i) {
186                 if (bma180_bw_table[i] == val) {
187                         ret = bma180_set_bits(data,
188                                         BMA180_BW_TCS, BMA180_BW, i);
189                         if (ret) {
190                                 dev_err(&data->client->dev,
191                                         "failed to set bandwidth\n");
192                                 return ret;
193                         }
194                         data->bw = val;
195                         return 0;
196                 }
197         }
198
199         return -EINVAL;
200 }
201
202 static int bma180_set_scale(struct bma180_data *data, int val)
203 {
204         int ret, i;
205
206         if (data->sleep_state)
207                 return -EBUSY;
208
209         for (i = 0; i < ARRAY_SIZE(bma180_scale_table); ++i)
210                 if (bma180_scale_table[i] == val) {
211                         ret = bma180_set_bits(data,
212                                         BMA180_OFFSET_LSB1, BMA180_RANGE, i);
213                         if (ret) {
214                                 dev_err(&data->client->dev,
215                                         "failed to set scale\n");
216                                 return ret;
217                         }
218                         data->scale = val;
219                         return 0;
220                 }
221
222         return -EINVAL;
223 }
224
225 static int bma180_set_pmode(struct bma180_data *data, bool mode)
226 {
227         u8 reg_val = mode ? BMA180_LOW_POWER : BMA180_LOW_NOISE;
228         int ret = bma180_set_bits(data, BMA180_TCO_Z, BMA180_MODE_CONFIG,
229                         reg_val);
230
231         if (ret) {
232                 dev_err(&data->client->dev, "failed to set power mode\n");
233                 return ret;
234         }
235         data->pmode = mode;
236
237         return 0;
238 }
239
240 static int bma180_soft_reset(struct bma180_data *data)
241 {
242         int ret = i2c_smbus_write_byte_data(data->client,
243                         BMA180_RESET, BMA180_RESET_VAL);
244
245         if (ret)
246                 dev_err(&data->client->dev, "failed to reset the chip\n");
247
248         return ret;
249 }
250
251 static int bma180_chip_init(struct bma180_data *data)
252 {
253         /* Try to read chip_id register. It must return 0x03. */
254         int ret = i2c_smbus_read_byte_data(data->client, BMA180_CHIP_ID);
255
256         if (ret < 0)
257                 goto err;
258         if (ret != BMA180_ID_REG_VAL) {
259                 ret = -ENODEV;
260                 goto err;
261         }
262
263         ret = bma180_soft_reset(data);
264         if (ret)
265                 goto err;
266         /*
267          * No serial transaction should occur within minimum 10 us
268          * after soft_reset command
269          */
270         msleep(20);
271
272         ret = bma180_set_bits(data, BMA180_CTRL_REG0, BMA180_DIS_WAKE_UP, 1);
273         if (ret)
274                 goto err;
275         ret = bma180_set_ee_writing_state(data, true);
276         if (ret)
277                 goto err;
278         ret = bma180_set_new_data_intr_state(data, false);
279         if (ret)
280                 goto err;
281         ret = bma180_set_bits(data, BMA180_OFFSET_LSB1, BMA180_SMP_SKIP, 1);
282         if (ret)
283                 goto err;
284         ret = bma180_set_pmode(data, BMA180_DEF_PMODE);
285         if (ret)
286                 goto err;
287         ret = bma180_set_bw(data, BMA180_DEF_BW);
288         if (ret)
289                 goto err;
290         ret = bma180_set_scale(data, BMA180_DEF_SCALE);
291         if (ret)
292                 goto err;
293
294         return 0;
295
296 err:
297         dev_err(&data->client->dev, "failed to init the chip\n");
298         return ret;
299 }
300
301 static void bma180_chip_disable(struct bma180_data *data)
302 {
303         if (bma180_set_new_data_intr_state(data, false))
304                 goto err;
305         if (bma180_set_ee_writing_state(data, false))
306                 goto err;
307         if (bma180_set_sleep_state(data, true))
308                 goto err;
309
310         return;
311
312 err:
313         dev_err(&data->client->dev, "failed to disable the chip\n");
314 }
315
316 static IIO_CONST_ATTR(in_accel_filter_low_pass_3db_frequency_available,
317                 BMA180_FLP_FREQ_AVAILABLE);
318 static IIO_CONST_ATTR(in_accel_scale_available, BMA180_SCALE_AVAILABLE);
319
320 static struct attribute *bma180_attributes[] = {
321         &iio_const_attr_in_accel_filter_low_pass_3db_frequency_available.dev_attr.attr,
322         &iio_const_attr_in_accel_scale_available.dev_attr.attr,
323         NULL,
324 };
325
326 static const struct attribute_group bma180_attrs_group = {
327         .attrs = bma180_attributes,
328 };
329
330 static int bma180_read_raw(struct iio_dev *indio_dev,
331                 struct iio_chan_spec const *chan, int *val, int *val2,
332                 long mask)
333 {
334         struct bma180_data *data = iio_priv(indio_dev);
335         int ret;
336
337         switch (mask) {
338         case IIO_CHAN_INFO_RAW:
339                 mutex_lock(&data->mutex);
340                 if (iio_buffer_enabled(indio_dev))
341                         ret = -EBUSY;
342                 else
343                         ret = bma180_get_acc_reg(data, chan->scan_index);
344                 mutex_unlock(&data->mutex);
345                 if (ret < 0)
346                         return ret;
347                 *val = (s16)ret >> chan->scan_type.shift;
348                 return IIO_VAL_INT;
349         case IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY:
350                 *val = data->bw;
351                 return IIO_VAL_INT;
352         case IIO_CHAN_INFO_SCALE:
353                 *val = 0;
354                 *val2 = data->scale;
355                 return IIO_VAL_INT_PLUS_MICRO;
356         default:
357                 return -EINVAL;
358         }
359 }
360
361 static int bma180_write_raw(struct iio_dev *indio_dev,
362                 struct iio_chan_spec const *chan, int val, int val2, long mask)
363 {
364         struct bma180_data *data = iio_priv(indio_dev);
365         int ret;
366
367         switch (mask) {
368         case IIO_CHAN_INFO_SCALE:
369                 if (val)
370                         return -EINVAL;
371                 mutex_lock(&data->mutex);
372                 ret = bma180_set_scale(data, val2);
373                 mutex_unlock(&data->mutex);
374                 return ret;
375         case IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY:
376                 if (val2)
377                         return -EINVAL;
378                 mutex_lock(&data->mutex);
379                 ret = bma180_set_bw(data, val);
380                 mutex_unlock(&data->mutex);
381                 return ret;
382         default:
383                 return -EINVAL;
384         }
385 }
386
387 static int bma180_update_scan_mode(struct iio_dev *indio_dev,
388                 const unsigned long *scan_mask)
389 {
390         struct bma180_data *data = iio_priv(indio_dev);
391
392         if (data->buff)
393                 devm_kfree(&indio_dev->dev, data->buff);
394         data->buff = devm_kzalloc(&indio_dev->dev,
395                         indio_dev->scan_bytes, GFP_KERNEL);
396         if (!data->buff)
397                 return -ENOMEM;
398
399         return 0;
400 }
401
402 static const struct iio_info bma180_info = {
403         .attrs                  = &bma180_attrs_group,
404         .read_raw               = bma180_read_raw,
405         .write_raw              = bma180_write_raw,
406         .update_scan_mode       = bma180_update_scan_mode,
407         .driver_module          = THIS_MODULE,
408 };
409
410 static const char * const bma180_power_modes[] = { "low_noise", "low_power" };
411
412 static int bma180_get_power_mode(struct iio_dev *indio_dev,
413                 const struct iio_chan_spec *chan)
414 {
415         struct bma180_data *data = iio_priv(indio_dev);
416
417         return data->pmode;
418 }
419
420 static int bma180_set_power_mode(struct iio_dev *indio_dev,
421                 const struct iio_chan_spec *chan, unsigned int mode)
422 {
423         struct bma180_data *data = iio_priv(indio_dev);
424         int ret;
425
426         mutex_lock(&data->mutex);
427         ret = bma180_set_pmode(data, mode);
428         mutex_unlock(&data->mutex);
429
430         return ret;
431 }
432
433 static const struct iio_enum bma180_power_mode_enum = {
434         .items = bma180_power_modes,
435         .num_items = ARRAY_SIZE(bma180_power_modes),
436         .get = bma180_get_power_mode,
437         .set = bma180_set_power_mode,
438 };
439
440 static const struct iio_chan_spec_ext_info bma180_ext_info[] = {
441         IIO_ENUM("power_mode", true, &bma180_power_mode_enum),
442         IIO_ENUM_AVAILABLE("power_mode", &bma180_power_mode_enum),
443         { },
444 };
445
446 #define BMA180_CHANNEL(_axis) {                                 \
447         .type = IIO_ACCEL,                                              \
448         .modified = 1,                                                  \
449         .channel2 = IIO_MOD_##_axis,                                    \
450         .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),                   \
451         .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE) |          \
452                 BIT(IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY),       \
453         .scan_index = AXIS_##_axis,                                     \
454         .scan_type = {                                                  \
455                 .sign = 's',                                            \
456                 .realbits = 14,                                         \
457                 .storagebits = 16,                                      \
458                 .shift = 2,                                             \
459         },                                                              \
460         .ext_info = bma180_ext_info,                                    \
461 }
462
463 static const struct iio_chan_spec bma180_channels[] = {
464         BMA180_CHANNEL(X),
465         BMA180_CHANNEL(Y),
466         BMA180_CHANNEL(Z),
467         IIO_CHAN_SOFT_TIMESTAMP(3),
468 };
469
470 static irqreturn_t bma180_trigger_handler(int irq, void *p)
471 {
472         struct iio_poll_func *pf = p;
473         struct iio_dev *indio_dev = pf->indio_dev;
474         struct bma180_data *data = iio_priv(indio_dev);
475         int64_t time_ns = iio_get_time_ns();
476         int bit, ret, i = 0;
477
478         mutex_lock(&data->mutex);
479
480         for_each_set_bit(bit, indio_dev->buffer->scan_mask,
481                          indio_dev->masklength) {
482                 ret = bma180_get_acc_reg(data, bit);
483                 if (ret < 0) {
484                         mutex_unlock(&data->mutex);
485                         goto err;
486                 }
487                 ((s16 *)data->buff)[i++] = ret;
488         }
489         mutex_unlock(&data->mutex);
490
491         iio_push_to_buffers_with_timestamp(indio_dev, data->buff, time_ns);
492 err:
493         iio_trigger_notify_done(indio_dev->trig);
494
495         return IRQ_HANDLED;
496 }
497
498 static int bma180_data_rdy_trigger_set_state(struct iio_trigger *trig,
499                 bool state)
500 {
501         struct iio_dev *indio_dev = iio_trigger_get_drvdata(trig);
502         struct bma180_data *data = iio_priv(indio_dev);
503
504         return bma180_set_new_data_intr_state(data, state);
505 }
506
507 static int bma180_trig_try_reen(struct iio_trigger *trig)
508 {
509         struct iio_dev *indio_dev = iio_trigger_get_drvdata(trig);
510         struct bma180_data *data = iio_priv(indio_dev);
511
512         return bma180_reset_intr(data);
513 }
514
515 static const struct iio_trigger_ops bma180_trigger_ops = {
516         .set_trigger_state = bma180_data_rdy_trigger_set_state,
517         .try_reenable = bma180_trig_try_reen,
518         .owner = THIS_MODULE,
519 };
520
521 static int bma180_probe(struct i2c_client *client,
522                 const struct i2c_device_id *id)
523 {
524         struct bma180_data *data;
525         struct iio_dev *indio_dev;
526         int ret;
527
528         indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
529         if (!indio_dev)
530                 return -ENOMEM;
531
532         data = iio_priv(indio_dev);
533         i2c_set_clientdata(client, indio_dev);
534         data->client = client;
535
536         ret = bma180_chip_init(data);
537         if (ret < 0)
538                 goto err_chip_disable;
539
540         mutex_init(&data->mutex);
541
542         indio_dev->dev.parent = &client->dev;
543         indio_dev->channels = bma180_channels;
544         indio_dev->num_channels = ARRAY_SIZE(bma180_channels);
545         indio_dev->name = BMA180_DRV_NAME;
546         indio_dev->modes = INDIO_DIRECT_MODE;
547         indio_dev->info = &bma180_info;
548
549         if (client->irq > 0) {
550                 data->trig = iio_trigger_alloc("%s-dev%d", indio_dev->name,
551                         indio_dev->id);
552                 if (!data->trig) {
553                         ret = -ENOMEM;
554                         goto err_chip_disable;
555                 }
556
557                 ret = devm_request_irq(&client->dev, client->irq,
558                         iio_trigger_generic_data_rdy_poll, IRQF_TRIGGER_RISING,
559                         BMA180_IRQ_NAME, data->trig);
560                 if (ret) {
561                         dev_err(&client->dev, "unable to request IRQ\n");
562                         goto err_trigger_free;
563                 }
564
565                 data->trig->dev.parent = &client->dev;
566                 data->trig->ops = &bma180_trigger_ops;
567                 iio_trigger_set_drvdata(data->trig, indio_dev);
568                 indio_dev->trig = data->trig;
569
570                 ret = iio_trigger_register(data->trig);
571                 if (ret)
572                         goto err_trigger_free;
573         }
574
575         ret = iio_triggered_buffer_setup(indio_dev, NULL,
576                         bma180_trigger_handler, NULL);
577         if (ret < 0) {
578                 dev_err(&client->dev, "unable to setup iio triggered buffer\n");
579                 goto err_trigger_unregister;
580         }
581
582         ret = iio_device_register(indio_dev);
583         if (ret < 0) {
584                 dev_err(&client->dev, "unable to register iio device\n");
585                 goto err_buffer_cleanup;
586         }
587
588         return 0;
589
590 err_buffer_cleanup:
591         iio_triggered_buffer_cleanup(indio_dev);
592 err_trigger_unregister:
593         if (data->trig)
594                 iio_trigger_unregister(data->trig);
595 err_trigger_free:
596         iio_trigger_free(data->trig);
597 err_chip_disable:
598         bma180_chip_disable(data);
599
600         return ret;
601 }
602
603 static int bma180_remove(struct i2c_client *client)
604 {
605         struct iio_dev *indio_dev = i2c_get_clientdata(client);
606         struct bma180_data *data = iio_priv(indio_dev);
607
608         iio_device_unregister(indio_dev);
609         iio_triggered_buffer_cleanup(indio_dev);
610         if (data->trig) {
611                 iio_trigger_unregister(data->trig);
612                 iio_trigger_free(data->trig);
613         }
614
615         mutex_lock(&data->mutex);
616         bma180_chip_disable(data);
617         mutex_unlock(&data->mutex);
618
619         return 0;
620 }
621
622 #ifdef CONFIG_PM_SLEEP
623 static int bma180_suspend(struct device *dev)
624 {
625         struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
626         struct bma180_data *data = iio_priv(indio_dev);
627         int ret;
628
629         mutex_lock(&data->mutex);
630         ret = bma180_set_sleep_state(data, true);
631         mutex_unlock(&data->mutex);
632
633         return ret;
634 }
635
636 static int bma180_resume(struct device *dev)
637 {
638         struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
639         struct bma180_data *data = iio_priv(indio_dev);
640         int ret;
641
642         mutex_lock(&data->mutex);
643         ret = bma180_set_sleep_state(data, false);
644         mutex_unlock(&data->mutex);
645
646         return ret;
647 }
648
649 static SIMPLE_DEV_PM_OPS(bma180_pm_ops, bma180_suspend, bma180_resume);
650 #define BMA180_PM_OPS (&bma180_pm_ops)
651 #else
652 #define BMA180_PM_OPS NULL
653 #endif
654
655 static struct i2c_device_id bma180_id[] = {
656         { BMA180_DRV_NAME, 0 },
657         { }
658 };
659
660 MODULE_DEVICE_TABLE(i2c, bma180_id);
661
662 static struct i2c_driver bma180_driver = {
663         .driver = {
664                 .name   = BMA180_DRV_NAME,
665                 .owner  = THIS_MODULE,
666                 .pm     = BMA180_PM_OPS,
667         },
668         .probe          = bma180_probe,
669         .remove         = bma180_remove,
670         .id_table       = bma180_id,
671 };
672
673 module_i2c_driver(bma180_driver);
674
675 MODULE_AUTHOR("Kravchenko Oleksandr <x0199363@ti.com>");
676 MODULE_AUTHOR("Texas Instruments, Inc.");
677 MODULE_DESCRIPTION("Bosch BMA180 triaxial acceleration sensor");
678 MODULE_LICENSE("GPL");