stk8ba50.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570
  1. /**
  2. * Sensortek STK8BA50 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. * STK8BA50 7-bit I2C address: 0x18.
  11. */
  12. #include <linux/acpi.h>
  13. #include <linux/i2c.h>
  14. #include <linux/interrupt.h>
  15. #include <linux/kernel.h>
  16. #include <linux/module.h>
  17. #include <linux/iio/buffer.h>
  18. #include <linux/iio/iio.h>
  19. #include <linux/iio/sysfs.h>
  20. #include <linux/iio/trigger.h>
  21. #include <linux/iio/triggered_buffer.h>
  22. #include <linux/iio/trigger_consumer.h>
  23. #define STK8BA50_REG_XOUT 0x02
  24. #define STK8BA50_REG_YOUT 0x04
  25. #define STK8BA50_REG_ZOUT 0x06
  26. #define STK8BA50_REG_RANGE 0x0F
  27. #define STK8BA50_REG_BWSEL 0x10
  28. #define STK8BA50_REG_POWMODE 0x11
  29. #define STK8BA50_REG_SWRST 0x14
  30. #define STK8BA50_REG_INTEN2 0x17
  31. #define STK8BA50_REG_INTMAP2 0x1A
  32. #define STK8BA50_MODE_NORMAL 0
  33. #define STK8BA50_MODE_SUSPEND 1
  34. #define STK8BA50_MODE_POWERBIT BIT(7)
  35. #define STK8BA50_DATA_SHIFT 6
  36. #define STK8BA50_RESET_CMD 0xB6
  37. #define STK8BA50_SR_1792HZ_IDX 7
  38. #define STK8BA50_DREADY_INT_MASK 0x10
  39. #define STK8BA50_DREADY_INT_MAP 0x81
  40. #define STK8BA50_ALL_CHANNEL_MASK 7
  41. #define STK8BA50_ALL_CHANNEL_SIZE 6
  42. #define STK8BA50_DRIVER_NAME "stk8ba50"
  43. #define STK8BA50_IRQ_NAME "stk8ba50_event"
  44. #define STK8BA50_SCALE_AVAIL "0.0384 0.0767 0.1534 0.3069"
  45. /*
  46. * The accelerometer has four measurement ranges:
  47. * +/-2g; +/-4g; +/-8g; +/-16g
  48. *
  49. * Acceleration values are 10-bit, 2's complement.
  50. * Scales are calculated as following:
  51. *
  52. * scale1 = (2 + 2) * 9.81 / (2^10 - 1) = 0.0384
  53. * scale2 = (4 + 4) * 9.81 / (2^10 - 1) = 0.0767
  54. * etc.
  55. *
  56. * Scales are stored in this format:
  57. * { <register value>, <scale value> }
  58. *
  59. * Locally, the range is stored as a table index.
  60. */
  61. static const struct {
  62. u8 reg_val;
  63. u32 scale_val;
  64. } stk8ba50_scale_table[] = {
  65. {3, 38400}, {5, 76700}, {8, 153400}, {12, 306900}
  66. };
  67. /* Sample rates are stored as { <register value>, <Hz value> } */
  68. static const struct {
  69. u8 reg_val;
  70. u16 samp_freq;
  71. } stk8ba50_samp_freq_table[] = {
  72. {0x08, 14}, {0x09, 25}, {0x0A, 56}, {0x0B, 112},
  73. {0x0C, 224}, {0x0D, 448}, {0x0E, 896}, {0x0F, 1792}
  74. };
  75. /* Used to map scan mask bits to their corresponding channel register. */
  76. static const int stk8ba50_channel_table[] = {
  77. STK8BA50_REG_XOUT,
  78. STK8BA50_REG_YOUT,
  79. STK8BA50_REG_ZOUT
  80. };
  81. struct stk8ba50_data {
  82. struct i2c_client *client;
  83. struct mutex lock;
  84. int range;
  85. u8 sample_rate_idx;
  86. struct iio_trigger *dready_trig;
  87. bool dready_trigger_on;
  88. /*
  89. * 3 x 16-bit channels (10-bit data, 6-bit padding) +
  90. * 1 x 16 padding +
  91. * 4 x 16 64-bit timestamp
  92. */
  93. s16 buffer[8];
  94. };
  95. #define STK8BA50_ACCEL_CHANNEL(index, reg, axis) { \
  96. .type = IIO_ACCEL, \
  97. .address = reg, \
  98. .modified = 1, \
  99. .channel2 = IIO_MOD_##axis, \
  100. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
  101. .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \
  102. BIT(IIO_CHAN_INFO_SAMP_FREQ), \
  103. .scan_index = index, \
  104. .scan_type = { \
  105. .sign = 's', \
  106. .realbits = 10, \
  107. .storagebits = 16, \
  108. .shift = STK8BA50_DATA_SHIFT, \
  109. .endianness = IIO_CPU, \
  110. }, \
  111. }
  112. static const struct iio_chan_spec stk8ba50_channels[] = {
  113. STK8BA50_ACCEL_CHANNEL(0, STK8BA50_REG_XOUT, X),
  114. STK8BA50_ACCEL_CHANNEL(1, STK8BA50_REG_YOUT, Y),
  115. STK8BA50_ACCEL_CHANNEL(2, STK8BA50_REG_ZOUT, Z),
  116. IIO_CHAN_SOFT_TIMESTAMP(3),
  117. };
  118. static IIO_CONST_ATTR(in_accel_scale_available, STK8BA50_SCALE_AVAIL);
  119. static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("14 25 56 112 224 448 896 1792");
  120. static struct attribute *stk8ba50_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. static const struct attribute_group stk8ba50_attribute_group = {
  126. .attrs = stk8ba50_attributes
  127. };
  128. static int stk8ba50_read_accel(struct stk8ba50_data *data, u8 reg)
  129. {
  130. int ret;
  131. struct i2c_client *client = data->client;
  132. ret = i2c_smbus_read_word_data(client, reg);
  133. if (ret < 0) {
  134. dev_err(&client->dev, "register read failed\n");
  135. return ret;
  136. }
  137. return ret;
  138. }
  139. static int stk8ba50_data_rdy_trigger_set_state(struct iio_trigger *trig,
  140. bool state)
  141. {
  142. struct iio_dev *indio_dev = iio_trigger_get_drvdata(trig);
  143. struct stk8ba50_data *data = iio_priv(indio_dev);
  144. int ret;
  145. if (state)
  146. ret = i2c_smbus_write_byte_data(data->client,
  147. STK8BA50_REG_INTEN2, STK8BA50_DREADY_INT_MASK);
  148. else
  149. ret = i2c_smbus_write_byte_data(data->client,
  150. STK8BA50_REG_INTEN2, 0x00);
  151. if (ret < 0)
  152. dev_err(&data->client->dev, "failed to set trigger state\n");
  153. else
  154. data->dready_trigger_on = state;
  155. return ret;
  156. }
  157. static const struct iio_trigger_ops stk8ba50_trigger_ops = {
  158. .set_trigger_state = stk8ba50_data_rdy_trigger_set_state,
  159. .owner = THIS_MODULE,
  160. };
  161. static int stk8ba50_set_power(struct stk8ba50_data *data, bool mode)
  162. {
  163. int ret;
  164. u8 masked_reg;
  165. struct i2c_client *client = data->client;
  166. ret = i2c_smbus_read_byte_data(client, STK8BA50_REG_POWMODE);
  167. if (ret < 0)
  168. goto exit_err;
  169. if (mode)
  170. masked_reg = ret | STK8BA50_MODE_POWERBIT;
  171. else
  172. masked_reg = ret & (~STK8BA50_MODE_POWERBIT);
  173. ret = i2c_smbus_write_byte_data(client, STK8BA50_REG_POWMODE,
  174. masked_reg);
  175. if (ret < 0)
  176. goto exit_err;
  177. return ret;
  178. exit_err:
  179. dev_err(&client->dev, "failed to change sensor mode\n");
  180. return ret;
  181. }
  182. static int stk8ba50_read_raw(struct iio_dev *indio_dev,
  183. struct iio_chan_spec const *chan,
  184. int *val, int *val2, long mask)
  185. {
  186. struct stk8ba50_data *data = iio_priv(indio_dev);
  187. int ret;
  188. switch (mask) {
  189. case IIO_CHAN_INFO_RAW:
  190. if (iio_buffer_enabled(indio_dev))
  191. return -EBUSY;
  192. mutex_lock(&data->lock);
  193. ret = stk8ba50_set_power(data, STK8BA50_MODE_NORMAL);
  194. if (ret < 0) {
  195. mutex_unlock(&data->lock);
  196. return -EINVAL;
  197. }
  198. ret = stk8ba50_read_accel(data, chan->address);
  199. if (ret < 0) {
  200. stk8ba50_set_power(data, STK8BA50_MODE_SUSPEND);
  201. mutex_unlock(&data->lock);
  202. return -EINVAL;
  203. }
  204. *val = sign_extend32(ret >> STK8BA50_DATA_SHIFT, 9);
  205. stk8ba50_set_power(data, STK8BA50_MODE_SUSPEND);
  206. mutex_unlock(&data->lock);
  207. return IIO_VAL_INT;
  208. case IIO_CHAN_INFO_SCALE:
  209. *val = 0;
  210. *val2 = stk8ba50_scale_table[data->range].scale_val;
  211. return IIO_VAL_INT_PLUS_MICRO;
  212. case IIO_CHAN_INFO_SAMP_FREQ:
  213. *val = stk8ba50_samp_freq_table
  214. [data->sample_rate_idx].samp_freq;
  215. *val2 = 0;
  216. return IIO_VAL_INT;
  217. }
  218. return -EINVAL;
  219. }
  220. static int stk8ba50_write_raw(struct iio_dev *indio_dev,
  221. struct iio_chan_spec const *chan,
  222. int val, int val2, long mask)
  223. {
  224. int ret;
  225. int i;
  226. int index = -1;
  227. struct stk8ba50_data *data = iio_priv(indio_dev);
  228. switch (mask) {
  229. case IIO_CHAN_INFO_SCALE:
  230. if (val != 0)
  231. return -EINVAL;
  232. for (i = 0; i < ARRAY_SIZE(stk8ba50_scale_table); i++)
  233. if (val2 == stk8ba50_scale_table[i].scale_val) {
  234. index = i;
  235. break;
  236. }
  237. if (index < 0)
  238. return -EINVAL;
  239. ret = i2c_smbus_write_byte_data(data->client,
  240. STK8BA50_REG_RANGE,
  241. stk8ba50_scale_table[index].reg_val);
  242. if (ret < 0)
  243. dev_err(&data->client->dev,
  244. "failed to set measurement range\n");
  245. else
  246. data->range = index;
  247. return ret;
  248. case IIO_CHAN_INFO_SAMP_FREQ:
  249. for (i = 0; i < ARRAY_SIZE(stk8ba50_samp_freq_table); i++)
  250. if (val == stk8ba50_samp_freq_table[i].samp_freq) {
  251. index = i;
  252. break;
  253. }
  254. if (index < 0)
  255. return -EINVAL;
  256. ret = i2c_smbus_write_byte_data(data->client,
  257. STK8BA50_REG_BWSEL,
  258. stk8ba50_samp_freq_table[index].reg_val);
  259. if (ret < 0)
  260. dev_err(&data->client->dev,
  261. "failed to set sampling rate\n");
  262. else
  263. data->sample_rate_idx = index;
  264. return ret;
  265. }
  266. return -EINVAL;
  267. }
  268. static const struct iio_info stk8ba50_info = {
  269. .driver_module = THIS_MODULE,
  270. .read_raw = stk8ba50_read_raw,
  271. .write_raw = stk8ba50_write_raw,
  272. .attrs = &stk8ba50_attribute_group,
  273. };
  274. static irqreturn_t stk8ba50_trigger_handler(int irq, void *p)
  275. {
  276. struct iio_poll_func *pf = p;
  277. struct iio_dev *indio_dev = pf->indio_dev;
  278. struct stk8ba50_data *data = iio_priv(indio_dev);
  279. int bit, ret, i = 0;
  280. mutex_lock(&data->lock);
  281. /*
  282. * Do a bulk read if all channels are requested,
  283. * from 0x02 (XOUT1) to 0x07 (ZOUT2)
  284. */
  285. if (*(indio_dev->active_scan_mask) == STK8BA50_ALL_CHANNEL_MASK) {
  286. ret = i2c_smbus_read_i2c_block_data(data->client,
  287. STK8BA50_REG_XOUT,
  288. STK8BA50_ALL_CHANNEL_SIZE,
  289. (u8 *)data->buffer);
  290. if (ret < STK8BA50_ALL_CHANNEL_SIZE) {
  291. dev_err(&data->client->dev, "register read failed\n");
  292. goto err;
  293. }
  294. } else {
  295. for_each_set_bit(bit, indio_dev->active_scan_mask,
  296. indio_dev->masklength) {
  297. ret = stk8ba50_read_accel(data,
  298. stk8ba50_channel_table[bit]);
  299. if (ret < 0)
  300. goto err;
  301. data->buffer[i++] = ret;
  302. }
  303. }
  304. iio_push_to_buffers_with_timestamp(indio_dev, data->buffer,
  305. pf->timestamp);
  306. err:
  307. mutex_unlock(&data->lock);
  308. iio_trigger_notify_done(indio_dev->trig);
  309. return IRQ_HANDLED;
  310. }
  311. static irqreturn_t stk8ba50_data_rdy_trig_poll(int irq, void *private)
  312. {
  313. struct iio_dev *indio_dev = private;
  314. struct stk8ba50_data *data = iio_priv(indio_dev);
  315. if (data->dready_trigger_on)
  316. iio_trigger_poll(data->dready_trig);
  317. return IRQ_HANDLED;
  318. }
  319. static int stk8ba50_buffer_preenable(struct iio_dev *indio_dev)
  320. {
  321. struct stk8ba50_data *data = iio_priv(indio_dev);
  322. return stk8ba50_set_power(data, STK8BA50_MODE_NORMAL);
  323. }
  324. static int stk8ba50_buffer_postdisable(struct iio_dev *indio_dev)
  325. {
  326. struct stk8ba50_data *data = iio_priv(indio_dev);
  327. return stk8ba50_set_power(data, STK8BA50_MODE_SUSPEND);
  328. }
  329. static const struct iio_buffer_setup_ops stk8ba50_buffer_setup_ops = {
  330. .preenable = stk8ba50_buffer_preenable,
  331. .postenable = iio_triggered_buffer_postenable,
  332. .predisable = iio_triggered_buffer_predisable,
  333. .postdisable = stk8ba50_buffer_postdisable,
  334. };
  335. static int stk8ba50_probe(struct i2c_client *client,
  336. const struct i2c_device_id *id)
  337. {
  338. int ret;
  339. struct iio_dev *indio_dev;
  340. struct stk8ba50_data *data;
  341. indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
  342. if (!indio_dev) {
  343. dev_err(&client->dev, "iio allocation failed!\n");
  344. return -ENOMEM;
  345. }
  346. data = iio_priv(indio_dev);
  347. data->client = client;
  348. i2c_set_clientdata(client, indio_dev);
  349. mutex_init(&data->lock);
  350. indio_dev->dev.parent = &client->dev;
  351. indio_dev->info = &stk8ba50_info;
  352. indio_dev->name = STK8BA50_DRIVER_NAME;
  353. indio_dev->modes = INDIO_DIRECT_MODE;
  354. indio_dev->channels = stk8ba50_channels;
  355. indio_dev->num_channels = ARRAY_SIZE(stk8ba50_channels);
  356. /* Reset all registers on startup */
  357. ret = i2c_smbus_write_byte_data(client,
  358. STK8BA50_REG_SWRST, STK8BA50_RESET_CMD);
  359. if (ret < 0) {
  360. dev_err(&client->dev, "failed to reset sensor\n");
  361. goto err_power_off;
  362. }
  363. /* The default range is +/-2g */
  364. data->range = 0;
  365. /* The default sampling rate is 1792 Hz (maximum) */
  366. data->sample_rate_idx = STK8BA50_SR_1792HZ_IDX;
  367. /* Set up interrupts */
  368. ret = i2c_smbus_write_byte_data(client,
  369. STK8BA50_REG_INTEN2, STK8BA50_DREADY_INT_MASK);
  370. if (ret < 0) {
  371. dev_err(&client->dev, "failed to set up interrupts\n");
  372. goto err_power_off;
  373. }
  374. ret = i2c_smbus_write_byte_data(client,
  375. STK8BA50_REG_INTMAP2, STK8BA50_DREADY_INT_MAP);
  376. if (ret < 0) {
  377. dev_err(&client->dev, "failed to set up interrupts\n");
  378. goto err_power_off;
  379. }
  380. if (client->irq > 0) {
  381. ret = devm_request_threaded_irq(&client->dev, client->irq,
  382. stk8ba50_data_rdy_trig_poll,
  383. NULL,
  384. IRQF_TRIGGER_RISING |
  385. IRQF_ONESHOT,
  386. STK8BA50_IRQ_NAME,
  387. indio_dev);
  388. if (ret < 0) {
  389. dev_err(&client->dev, "request irq %d failed\n",
  390. client->irq);
  391. goto err_power_off;
  392. }
  393. data->dready_trig = devm_iio_trigger_alloc(&client->dev,
  394. "%s-dev%d",
  395. indio_dev->name,
  396. indio_dev->id);
  397. if (!data->dready_trig) {
  398. ret = -ENOMEM;
  399. goto err_power_off;
  400. }
  401. data->dready_trig->dev.parent = &client->dev;
  402. data->dready_trig->ops = &stk8ba50_trigger_ops;
  403. iio_trigger_set_drvdata(data->dready_trig, indio_dev);
  404. ret = iio_trigger_register(data->dready_trig);
  405. if (ret) {
  406. dev_err(&client->dev, "iio trigger register failed\n");
  407. goto err_power_off;
  408. }
  409. }
  410. ret = iio_triggered_buffer_setup(indio_dev,
  411. iio_pollfunc_store_time,
  412. stk8ba50_trigger_handler,
  413. &stk8ba50_buffer_setup_ops);
  414. if (ret < 0) {
  415. dev_err(&client->dev, "iio triggered buffer setup failed\n");
  416. goto err_trigger_unregister;
  417. }
  418. ret = iio_device_register(indio_dev);
  419. if (ret < 0) {
  420. dev_err(&client->dev, "device_register failed\n");
  421. goto err_buffer_cleanup;
  422. }
  423. return ret;
  424. err_buffer_cleanup:
  425. iio_triggered_buffer_cleanup(indio_dev);
  426. err_trigger_unregister:
  427. if (data->dready_trig)
  428. iio_trigger_unregister(data->dready_trig);
  429. err_power_off:
  430. stk8ba50_set_power(data, STK8BA50_MODE_SUSPEND);
  431. return ret;
  432. }
  433. static int stk8ba50_remove(struct i2c_client *client)
  434. {
  435. struct iio_dev *indio_dev = i2c_get_clientdata(client);
  436. struct stk8ba50_data *data = iio_priv(indio_dev);
  437. iio_device_unregister(indio_dev);
  438. iio_triggered_buffer_cleanup(indio_dev);
  439. if (data->dready_trig)
  440. iio_trigger_unregister(data->dready_trig);
  441. return stk8ba50_set_power(data, STK8BA50_MODE_SUSPEND);
  442. }
  443. #ifdef CONFIG_PM_SLEEP
  444. static int stk8ba50_suspend(struct device *dev)
  445. {
  446. struct stk8ba50_data *data;
  447. data = iio_priv(i2c_get_clientdata(to_i2c_client(dev)));
  448. return stk8ba50_set_power(data, STK8BA50_MODE_SUSPEND);
  449. }
  450. static int stk8ba50_resume(struct device *dev)
  451. {
  452. struct stk8ba50_data *data;
  453. data = iio_priv(i2c_get_clientdata(to_i2c_client(dev)));
  454. return stk8ba50_set_power(data, STK8BA50_MODE_NORMAL);
  455. }
  456. static SIMPLE_DEV_PM_OPS(stk8ba50_pm_ops, stk8ba50_suspend, stk8ba50_resume);
  457. #define STK8BA50_PM_OPS (&stk8ba50_pm_ops)
  458. #else
  459. #define STK8BA50_PM_OPS NULL
  460. #endif
  461. static const struct i2c_device_id stk8ba50_i2c_id[] = {
  462. {"stk8ba50", 0},
  463. {}
  464. };
  465. MODULE_DEVICE_TABLE(i2c, stk8ba50_i2c_id);
  466. static const struct acpi_device_id stk8ba50_acpi_id[] = {
  467. {"STK8BA50", 0},
  468. {}
  469. };
  470. MODULE_DEVICE_TABLE(acpi, stk8ba50_acpi_id);
  471. static struct i2c_driver stk8ba50_driver = {
  472. .driver = {
  473. .name = "stk8ba50",
  474. .pm = STK8BA50_PM_OPS,
  475. .acpi_match_table = ACPI_PTR(stk8ba50_acpi_id),
  476. },
  477. .probe = stk8ba50_probe,
  478. .remove = stk8ba50_remove,
  479. .id_table = stk8ba50_i2c_id,
  480. };
  481. module_i2c_driver(stk8ba50_driver);
  482. MODULE_AUTHOR("Tiberiu Breana <tiberiu.a.breana@intel.com>");
  483. MODULE_DESCRIPTION("STK8BA50 3-Axis Accelerometer driver");
  484. MODULE_LICENSE("GPL v2");