1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (c) 2011 Bosch Sensortec GmbH
4 * Copyright (c) 2011 Unixphere
6 * This driver adds support for Bosch Sensortec's digital acceleration
7 * sensors BMA150 and SMB380.
8 * The SMB380 is fully compatible with BMA150 and only differs in packaging.
10 * The datasheet for the BMA150 chip can be found here:
11 * http://www.bosch-sensortec.com/content/language1/downloads/BST-BMA150-DS000-07.pdf
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/i2c.h>
16 #include <linux/input.h>
17 #include <linux/input-polldev.h>
18 #include <linux/interrupt.h>
19 #include <linux/delay.h>
20 #include <linux/slab.h>
22 #include <linux/pm_runtime.h>
23 #include <linux/bma150.h>
25 #define ABSMAX_ACC_VAL 0x01FF
26 #define ABSMIN_ACC_VAL -(ABSMAX_ACC_VAL)
28 /* Each axis is represented by a 2-byte data word */
29 #define BMA150_XYZ_DATA_SIZE 6
31 /* Input poll interval in milliseconds */
32 #define BMA150_POLL_INTERVAL 10
33 #define BMA150_POLL_MAX 200
34 #define BMA150_POLL_MIN 0
36 #define BMA150_MODE_NORMAL 0
37 #define BMA150_MODE_SLEEP 2
38 #define BMA150_MODE_WAKE_UP 3
40 /* Data register addresses */
41 #define BMA150_DATA_0_REG 0x00
42 #define BMA150_DATA_1_REG 0x01
43 #define BMA150_DATA_2_REG 0x02
45 /* Control register addresses */
46 #define BMA150_CTRL_0_REG 0x0A
47 #define BMA150_CTRL_1_REG 0x0B
48 #define BMA150_CTRL_2_REG 0x14
49 #define BMA150_CTRL_3_REG 0x15
51 /* Configuration/Setting register addresses */
52 #define BMA150_CFG_0_REG 0x0C
53 #define BMA150_CFG_1_REG 0x0D
54 #define BMA150_CFG_2_REG 0x0E
55 #define BMA150_CFG_3_REG 0x0F
56 #define BMA150_CFG_4_REG 0x10
57 #define BMA150_CFG_5_REG 0x11
59 #define BMA150_CHIP_ID 2
60 #define BMA150_CHIP_ID_REG BMA150_DATA_0_REG
62 #define BMA150_ACC_X_LSB_REG BMA150_DATA_2_REG
64 #define BMA150_SLEEP_POS 0
65 #define BMA150_SLEEP_MSK 0x01
66 #define BMA150_SLEEP_REG BMA150_CTRL_0_REG
68 #define BMA150_BANDWIDTH_POS 0
69 #define BMA150_BANDWIDTH_MSK 0x07
70 #define BMA150_BANDWIDTH_REG BMA150_CTRL_2_REG
72 #define BMA150_RANGE_POS 3
73 #define BMA150_RANGE_MSK 0x18
74 #define BMA150_RANGE_REG BMA150_CTRL_2_REG
76 #define BMA150_WAKE_UP_POS 0
77 #define BMA150_WAKE_UP_MSK 0x01
78 #define BMA150_WAKE_UP_REG BMA150_CTRL_3_REG
80 #define BMA150_SW_RES_POS 1
81 #define BMA150_SW_RES_MSK 0x02
82 #define BMA150_SW_RES_REG BMA150_CTRL_0_REG
84 /* Any-motion interrupt register fields */
85 #define BMA150_ANY_MOTION_EN_POS 6
86 #define BMA150_ANY_MOTION_EN_MSK 0x40
87 #define BMA150_ANY_MOTION_EN_REG BMA150_CTRL_1_REG
89 #define BMA150_ANY_MOTION_DUR_POS 6
90 #define BMA150_ANY_MOTION_DUR_MSK 0xC0
91 #define BMA150_ANY_MOTION_DUR_REG BMA150_CFG_5_REG
93 #define BMA150_ANY_MOTION_THRES_REG BMA150_CFG_4_REG
95 /* Advanced interrupt register fields */
96 #define BMA150_ADV_INT_EN_POS 6
97 #define BMA150_ADV_INT_EN_MSK 0x40
98 #define BMA150_ADV_INT_EN_REG BMA150_CTRL_3_REG
100 /* High-G interrupt register fields */
101 #define BMA150_HIGH_G_EN_POS 1
102 #define BMA150_HIGH_G_EN_MSK 0x02
103 #define BMA150_HIGH_G_EN_REG BMA150_CTRL_1_REG
105 #define BMA150_HIGH_G_HYST_POS 3
106 #define BMA150_HIGH_G_HYST_MSK 0x38
107 #define BMA150_HIGH_G_HYST_REG BMA150_CFG_5_REG
109 #define BMA150_HIGH_G_DUR_REG BMA150_CFG_3_REG
110 #define BMA150_HIGH_G_THRES_REG BMA150_CFG_2_REG
112 /* Low-G interrupt register fields */
113 #define BMA150_LOW_G_EN_POS 0
114 #define BMA150_LOW_G_EN_MSK 0x01
115 #define BMA150_LOW_G_EN_REG BMA150_CTRL_1_REG
117 #define BMA150_LOW_G_HYST_POS 0
118 #define BMA150_LOW_G_HYST_MSK 0x07
119 #define BMA150_LOW_G_HYST_REG BMA150_CFG_5_REG
121 #define BMA150_LOW_G_DUR_REG BMA150_CFG_1_REG
122 #define BMA150_LOW_G_THRES_REG BMA150_CFG_0_REG
125 struct i2c_client *client;
126 struct input_polled_dev *input_polled;
127 struct input_dev *input;
132 * The settings for the given range, bandwidth and interrupt features
133 * are stated and verified by Bosch Sensortec where they are configured
134 * to provide a generic sensitivity performance.
136 static const struct bma150_cfg default_cfg = {
141 .any_motion_thres = 0,
148 .range = BMA150_RANGE_2G,
149 .bandwidth = BMA150_BW_50HZ
152 static int bma150_write_byte(struct i2c_client *client, u8 reg, u8 val)
156 /* As per specification, disable irq in between register writes */
158 disable_irq_nosync(client->irq);
160 ret = i2c_smbus_write_byte_data(client, reg, val);
163 enable_irq(client->irq);
168 static int bma150_set_reg_bits(struct i2c_client *client,
169 int val, int shift, u8 mask, u8 reg)
173 data = i2c_smbus_read_byte_data(client, reg);
177 data = (data & ~mask) | ((val << shift) & mask);
178 return bma150_write_byte(client, reg, data);
181 static int bma150_set_mode(struct bma150_data *bma150, u8 mode)
185 error = bma150_set_reg_bits(bma150->client, mode, BMA150_WAKE_UP_POS,
186 BMA150_WAKE_UP_MSK, BMA150_WAKE_UP_REG);
190 error = bma150_set_reg_bits(bma150->client, mode, BMA150_SLEEP_POS,
191 BMA150_SLEEP_MSK, BMA150_SLEEP_REG);
195 if (mode == BMA150_MODE_NORMAL)
196 usleep_range(2000, 2100);
202 static int bma150_soft_reset(struct bma150_data *bma150)
206 error = bma150_set_reg_bits(bma150->client, 1, BMA150_SW_RES_POS,
207 BMA150_SW_RES_MSK, BMA150_SW_RES_REG);
211 usleep_range(2000, 2100);
215 static int bma150_set_range(struct bma150_data *bma150, u8 range)
217 return bma150_set_reg_bits(bma150->client, range, BMA150_RANGE_POS,
218 BMA150_RANGE_MSK, BMA150_RANGE_REG);
221 static int bma150_set_bandwidth(struct bma150_data *bma150, u8 bw)
223 return bma150_set_reg_bits(bma150->client, bw, BMA150_BANDWIDTH_POS,
224 BMA150_BANDWIDTH_MSK, BMA150_BANDWIDTH_REG);
227 static int bma150_set_low_g_interrupt(struct bma150_data *bma150,
228 u8 enable, u8 hyst, u8 dur, u8 thres)
232 error = bma150_set_reg_bits(bma150->client, hyst,
233 BMA150_LOW_G_HYST_POS, BMA150_LOW_G_HYST_MSK,
234 BMA150_LOW_G_HYST_REG);
238 error = bma150_write_byte(bma150->client, BMA150_LOW_G_DUR_REG, dur);
242 error = bma150_write_byte(bma150->client, BMA150_LOW_G_THRES_REG, thres);
246 return bma150_set_reg_bits(bma150->client, !!enable,
247 BMA150_LOW_G_EN_POS, BMA150_LOW_G_EN_MSK,
248 BMA150_LOW_G_EN_REG);
251 static int bma150_set_high_g_interrupt(struct bma150_data *bma150,
252 u8 enable, u8 hyst, u8 dur, u8 thres)
256 error = bma150_set_reg_bits(bma150->client, hyst,
257 BMA150_HIGH_G_HYST_POS, BMA150_HIGH_G_HYST_MSK,
258 BMA150_HIGH_G_HYST_REG);
262 error = bma150_write_byte(bma150->client,
263 BMA150_HIGH_G_DUR_REG, dur);
267 error = bma150_write_byte(bma150->client,
268 BMA150_HIGH_G_THRES_REG, thres);
272 return bma150_set_reg_bits(bma150->client, !!enable,
273 BMA150_HIGH_G_EN_POS, BMA150_HIGH_G_EN_MSK,
274 BMA150_HIGH_G_EN_REG);
278 static int bma150_set_any_motion_interrupt(struct bma150_data *bma150,
279 u8 enable, u8 dur, u8 thres)
283 error = bma150_set_reg_bits(bma150->client, dur,
284 BMA150_ANY_MOTION_DUR_POS,
285 BMA150_ANY_MOTION_DUR_MSK,
286 BMA150_ANY_MOTION_DUR_REG);
290 error = bma150_write_byte(bma150->client,
291 BMA150_ANY_MOTION_THRES_REG, thres);
295 error = bma150_set_reg_bits(bma150->client, !!enable,
296 BMA150_ADV_INT_EN_POS, BMA150_ADV_INT_EN_MSK,
297 BMA150_ADV_INT_EN_REG);
301 return bma150_set_reg_bits(bma150->client, !!enable,
302 BMA150_ANY_MOTION_EN_POS,
303 BMA150_ANY_MOTION_EN_MSK,
304 BMA150_ANY_MOTION_EN_REG);
307 static void bma150_report_xyz(struct bma150_data *bma150)
309 u8 data[BMA150_XYZ_DATA_SIZE];
313 ret = i2c_smbus_read_i2c_block_data(bma150->client,
314 BMA150_ACC_X_LSB_REG, BMA150_XYZ_DATA_SIZE, data);
315 if (ret != BMA150_XYZ_DATA_SIZE)
318 x = ((0xc0 & data[0]) >> 6) | (data[1] << 2);
319 y = ((0xc0 & data[2]) >> 6) | (data[3] << 2);
320 z = ((0xc0 & data[4]) >> 6) | (data[5] << 2);
322 x = sign_extend32(x, 9);
323 y = sign_extend32(y, 9);
324 z = sign_extend32(z, 9);
326 input_report_abs(bma150->input, ABS_X, x);
327 input_report_abs(bma150->input, ABS_Y, y);
328 input_report_abs(bma150->input, ABS_Z, z);
329 input_sync(bma150->input);
332 static irqreturn_t bma150_irq_thread(int irq, void *dev)
334 bma150_report_xyz(dev);
339 static void bma150_poll(struct input_polled_dev *dev)
341 bma150_report_xyz(dev->private);
344 static int bma150_open(struct bma150_data *bma150)
348 error = pm_runtime_get_sync(&bma150->client->dev);
349 if (error < 0 && error != -ENOSYS)
353 * See if runtime PM woke up the device. If runtime PM
354 * is disabled we need to do it ourselves.
356 if (bma150->mode != BMA150_MODE_NORMAL) {
357 error = bma150_set_mode(bma150, BMA150_MODE_NORMAL);
365 static void bma150_close(struct bma150_data *bma150)
367 pm_runtime_put_sync(&bma150->client->dev);
369 if (bma150->mode != BMA150_MODE_SLEEP)
370 bma150_set_mode(bma150, BMA150_MODE_SLEEP);
373 static int bma150_irq_open(struct input_dev *input)
375 struct bma150_data *bma150 = input_get_drvdata(input);
377 return bma150_open(bma150);
380 static void bma150_irq_close(struct input_dev *input)
382 struct bma150_data *bma150 = input_get_drvdata(input);
384 bma150_close(bma150);
387 static void bma150_poll_open(struct input_polled_dev *ipoll_dev)
389 struct bma150_data *bma150 = ipoll_dev->private;
394 static void bma150_poll_close(struct input_polled_dev *ipoll_dev)
396 struct bma150_data *bma150 = ipoll_dev->private;
398 bma150_close(bma150);
401 static int bma150_initialize(struct bma150_data *bma150,
402 const struct bma150_cfg *cfg)
406 error = bma150_soft_reset(bma150);
410 error = bma150_set_bandwidth(bma150, cfg->bandwidth);
414 error = bma150_set_range(bma150, cfg->range);
418 if (bma150->client->irq) {
419 error = bma150_set_any_motion_interrupt(bma150,
422 cfg->any_motion_thres);
426 error = bma150_set_high_g_interrupt(bma150,
427 cfg->hg_int, cfg->hg_hyst,
428 cfg->hg_dur, cfg->hg_thres);
432 error = bma150_set_low_g_interrupt(bma150,
433 cfg->lg_int, cfg->lg_hyst,
434 cfg->lg_dur, cfg->lg_thres);
439 return bma150_set_mode(bma150, BMA150_MODE_SLEEP);
442 static void bma150_init_input_device(struct bma150_data *bma150,
443 struct input_dev *idev)
445 idev->name = BMA150_DRIVER;
446 idev->phys = BMA150_DRIVER "/input0";
447 idev->id.bustype = BUS_I2C;
448 idev->dev.parent = &bma150->client->dev;
450 idev->evbit[0] = BIT_MASK(EV_ABS);
451 input_set_abs_params(idev, ABS_X, ABSMIN_ACC_VAL, ABSMAX_ACC_VAL, 0, 0);
452 input_set_abs_params(idev, ABS_Y, ABSMIN_ACC_VAL, ABSMAX_ACC_VAL, 0, 0);
453 input_set_abs_params(idev, ABS_Z, ABSMIN_ACC_VAL, ABSMAX_ACC_VAL, 0, 0);
456 static int bma150_register_input_device(struct bma150_data *bma150)
458 struct input_dev *idev;
461 idev = input_allocate_device();
465 bma150_init_input_device(bma150, idev);
467 idev->open = bma150_irq_open;
468 idev->close = bma150_irq_close;
469 input_set_drvdata(idev, bma150);
471 bma150->input = idev;
473 error = input_register_device(idev);
475 input_free_device(idev);
482 static int bma150_register_polled_device(struct bma150_data *bma150)
484 struct input_polled_dev *ipoll_dev;
487 ipoll_dev = input_allocate_polled_device();
491 ipoll_dev->private = bma150;
492 ipoll_dev->open = bma150_poll_open;
493 ipoll_dev->close = bma150_poll_close;
494 ipoll_dev->poll = bma150_poll;
495 ipoll_dev->poll_interval = BMA150_POLL_INTERVAL;
496 ipoll_dev->poll_interval_min = BMA150_POLL_MIN;
497 ipoll_dev->poll_interval_max = BMA150_POLL_MAX;
499 bma150_init_input_device(bma150, ipoll_dev->input);
501 bma150->input_polled = ipoll_dev;
502 bma150->input = ipoll_dev->input;
504 error = input_register_polled_device(ipoll_dev);
506 input_free_polled_device(ipoll_dev);
513 static int bma150_probe(struct i2c_client *client,
514 const struct i2c_device_id *id)
516 const struct bma150_platform_data *pdata =
517 dev_get_platdata(&client->dev);
518 const struct bma150_cfg *cfg;
519 struct bma150_data *bma150;
523 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
524 dev_err(&client->dev, "i2c_check_functionality error\n");
528 chip_id = i2c_smbus_read_byte_data(client, BMA150_CHIP_ID_REG);
529 if (chip_id != BMA150_CHIP_ID) {
530 dev_err(&client->dev, "BMA150 chip id error: %d\n", chip_id);
534 bma150 = kzalloc(sizeof(struct bma150_data), GFP_KERNEL);
538 bma150->client = client;
541 if (pdata->irq_gpio_cfg) {
542 error = pdata->irq_gpio_cfg();
544 dev_err(&client->dev,
545 "IRQ GPIO conf. error %d, error %d\n",
555 error = bma150_initialize(bma150, cfg);
559 if (client->irq > 0) {
560 error = bma150_register_input_device(bma150);
564 error = request_threaded_irq(client->irq,
565 NULL, bma150_irq_thread,
566 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
567 BMA150_DRIVER, bma150);
569 dev_err(&client->dev,
570 "irq request failed %d, error %d\n",
572 input_unregister_device(bma150->input);
576 error = bma150_register_polled_device(bma150);
581 i2c_set_clientdata(client, bma150);
583 pm_runtime_enable(&client->dev);
592 static int bma150_remove(struct i2c_client *client)
594 struct bma150_data *bma150 = i2c_get_clientdata(client);
596 pm_runtime_disable(&client->dev);
598 if (client->irq > 0) {
599 free_irq(client->irq, bma150);
600 input_unregister_device(bma150->input);
602 input_unregister_polled_device(bma150->input_polled);
603 input_free_polled_device(bma150->input_polled);
612 static int bma150_suspend(struct device *dev)
614 struct i2c_client *client = to_i2c_client(dev);
615 struct bma150_data *bma150 = i2c_get_clientdata(client);
617 return bma150_set_mode(bma150, BMA150_MODE_SLEEP);
620 static int bma150_resume(struct device *dev)
622 struct i2c_client *client = to_i2c_client(dev);
623 struct bma150_data *bma150 = i2c_get_clientdata(client);
625 return bma150_set_mode(bma150, BMA150_MODE_NORMAL);
629 static UNIVERSAL_DEV_PM_OPS(bma150_pm, bma150_suspend, bma150_resume, NULL);
631 static const struct i2c_device_id bma150_id[] = {
638 MODULE_DEVICE_TABLE(i2c, bma150_id);
640 static struct i2c_driver bma150_driver = {
642 .name = BMA150_DRIVER,
645 .class = I2C_CLASS_HWMON,
646 .id_table = bma150_id,
647 .probe = bma150_probe,
648 .remove = bma150_remove,
651 module_i2c_driver(bma150_driver);
653 MODULE_AUTHOR("Albert Zhang <xu.zhang@bosch-sensortec.com>");
654 MODULE_DESCRIPTION("BMA150 driver");
655 MODULE_LICENSE("GPL");