drivers/iio/accel/mma8452.c

   1 /*
   2  * mma8452.c - Support for Freescale MMA8452Q 3-axis 12-bit accelerometer
   3  *
   4  * Copyright 2014 Peter Meerwald <pmeerw@pmeerw.net>
   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  * 7-bit I2C slave address 0x1c/0x1d (pin selectable)
  11  *
  12  * TODO: interrupt, thresholding, orientation / freefall events, autosleep
  13  */
  14
  15 #include <linux/module.h>
  16 #include <linux/i2c.h>
  17 #include <linux/iio/iio.h>
  18 #include <linux/iio/sysfs.h>
  19 #include <linux/iio/trigger_consumer.h>
  20 #include <linux/iio/buffer.h>
  21 #include <linux/iio/triggered_buffer.h>
  22 #include <linux/delay.h>
  23
  24 #define MMA8452_STATUS 0x00
  25 #define MMA8452_OUT_X 0x01 /* MSB first, 12-bit  */
  26 #define MMA8452_OUT_Y 0x03
  27 #define MMA8452_OUT_Z 0x05
  28 #define MMA8452_WHO_AM_I 0x0d
  29 #define MMA8452_DATA_CFG 0x0e
  30 #define MMA8452_OFF_X 0x2f
  31 #define MMA8452_OFF_Y 0x30
  32 #define MMA8452_OFF_Z 0x31
  33 #define MMA8452_CTRL_REG1 0x2a
  34 #define MMA8452_CTRL_REG2 0x2b
  35 #define MMA8452_CTRL_REG2_RST           BIT(6)
  36
  37 #define MMA8452_STATUS_DRDY (BIT(2) | BIT(1) | BIT(0))
  38
  39 #define MMA8452_CTRL_DR_MASK (BIT(5) | BIT(4) | BIT(3))
  40 #define MMA8452_CTRL_DR_SHIFT 3
  41 #define MMA8452_CTRL_DR_DEFAULT 0x4 /* 50 Hz sample frequency */
  42 #define MMA8452_CTRL_ACTIVE BIT(0)
  43
  44 #define MMA8452_DATA_CFG_FS_MASK (BIT(1) | BIT(0))
  45 #define MMA8452_DATA_CFG_FS_2G 0
  46 #define MMA8452_DATA_CFG_FS_4G 1
  47 #define MMA8452_DATA_CFG_FS_8G 2
  48
  49 #define MMA8452_DEVICE_ID 0x2a
  50
  51 struct mma8452_data {
  52         struct i2c_client *client;
  53         struct mutex lock;
  54         u8 ctrl_reg1;
  55         u8 data_cfg;
  56 };
  57
  58 static int mma8452_drdy(struct mma8452_data *data)
  59 {
  60         int tries = 150;
  61
  62         while (tries-- > 0) {
  63                 int ret = i2c_smbus_read_byte_data(data->client,
  64                         MMA8452_STATUS);
  65                 if (ret < 0)
  66                         return ret;
  67                 if ((ret & MMA8452_STATUS_DRDY) == MMA8452_STATUS_DRDY)
  68                         return 0;
  69                 msleep(20);
  70         }
  71
  72         dev_err(&data->client->dev, "data not ready\n");
  73         return -EIO;
  74 }
  75
  76 static int mma8452_read(struct mma8452_data *data, __be16 buf[3])
  77 {
  78         int ret = mma8452_drdy(data);
  79         if (ret < 0)
  80                 return ret;
  81         return i2c_smbus_read_i2c_block_data(data->client,
  82                 MMA8452_OUT_X, 3 * sizeof(__be16), (u8 *) buf);
  83 }
  84
  85 static ssize_t mma8452_show_int_plus_micros(char *buf,
  86         const int (*vals)[2], int n)
  87 {
  88         size_t len = 0;
  89
  90         while (n-- > 0)
  91                 len += scnprintf(buf + len, PAGE_SIZE - len,
  92                         "%d.%06d ", vals[n][0], vals[n][1]);
  93
  94         /* replace trailing space by newline */
  95         buf[len - 1] = '\n';
  96
  97         return len;
  98 }
  99
 100 static int mma8452_get_int_plus_micros_index(const int (*vals)[2], int n,
 101                                         int val, int val2)
 102 {
 103         while (n-- > 0)
 104                 if (val == vals[n][0] && val2 == vals[n][1])
 105                         return n;
 106
 107         return -EINVAL;
 108 }
 109
 110 static const int mma8452_samp_freq[8][2] = {
 111         {800, 0}, {400, 0}, {200, 0}, {100, 0}, {50, 0}, {12, 500000},
 112         {6, 250000}, {1, 560000}
 113 };
 114
 115 /*
 116  * Hardware has fullscale of -2G, -4G, -8G corresponding to raw value -2048
 117  * The userspace interface uses m/s^2 and we declare micro units
 118  * So scale factor is given by:
 119  *      g * N * 1000000 / 2048 for N = 2, 4, 8 and g=9.80665
 120  */
 121 static const int mma8452_scales[3][2] = {
 122         {0, 9577}, {0, 19154}, {0, 38307}
 123 };
 124
 125 static ssize_t mma8452_show_samp_freq_avail(struct device *dev,
 126                                 struct device_attribute *attr, char *buf)
 127 {
 128         return mma8452_show_int_plus_micros(buf, mma8452_samp_freq,
 129                 ARRAY_SIZE(mma8452_samp_freq));
 130 }
 131
 132 static ssize_t mma8452_show_scale_avail(struct device *dev,
 133                                 struct device_attribute *attr, char *buf)
 134 {
 135         return mma8452_show_int_plus_micros(buf, mma8452_scales,
 136                 ARRAY_SIZE(mma8452_scales));
 137 }
 138
 139 static IIO_DEV_ATTR_SAMP_FREQ_AVAIL(mma8452_show_samp_freq_avail);
 140 static IIO_DEVICE_ATTR(in_accel_scale_available, S_IRUGO,
 141         mma8452_show_scale_avail, NULL, 0);
 142
 143 static int mma8452_get_samp_freq_index(struct mma8452_data *data,
 144         int val, int val2)
 145 {
 146         return mma8452_get_int_plus_micros_index(mma8452_samp_freq,
 147                 ARRAY_SIZE(mma8452_samp_freq), val, val2);
 148 }
 149
 150 static int mma8452_get_scale_index(struct mma8452_data *data,
 151         int val, int val2)
 152 {
 153         return mma8452_get_int_plus_micros_index(mma8452_scales,
 154                 ARRAY_SIZE(mma8452_scales), val, val2);
 155 }
 156
 157 static int mma8452_read_raw(struct iio_dev *indio_dev,
 158                             struct iio_chan_spec const *chan,
 159                             int *val, int *val2, long mask)
 160 {
 161         struct mma8452_data *data = iio_priv(indio_dev);
 162         __be16 buffer[3];
 163         int i, ret;
 164
 165         switch (mask) {
 166         case IIO_CHAN_INFO_RAW:
 167                 if (iio_buffer_enabled(indio_dev))
 168                         return -EBUSY;
 169
 170                 mutex_lock(&data->lock);
 171                 ret = mma8452_read(data, buffer);
 172                 mutex_unlock(&data->lock);
 173                 if (ret < 0)
 174                         return ret;
 175                 *val = sign_extend32(
 176                         be16_to_cpu(buffer[chan->scan_index]) >> 4, 11);
 177                 return IIO_VAL_INT;
 178         case IIO_CHAN_INFO_SCALE:
 179                 i = data->data_cfg & MMA8452_DATA_CFG_FS_MASK;
 180                 *val = mma8452_scales[i][0];
 181                 *val2 = mma8452_scales[i][1];
 182                 return IIO_VAL_INT_PLUS_MICRO;
 183         case IIO_CHAN_INFO_SAMP_FREQ:
 184                 i = (data->ctrl_reg1 & MMA8452_CTRL_DR_MASK) >>
 185                         MMA8452_CTRL_DR_SHIFT;
 186                 *val = mma8452_samp_freq[i][0];
 187                 *val2 = mma8452_samp_freq[i][1];
 188                 return IIO_VAL_INT_PLUS_MICRO;
 189         case IIO_CHAN_INFO_CALIBBIAS:
 190                 ret = i2c_smbus_read_byte_data(data->client, MMA8452_OFF_X +
 191                         chan->scan_index);
 192                 if (ret < 0)
 193                         return ret;
 194                 *val = sign_extend32(ret, 7);
 195                 return IIO_VAL_INT;
 196         }
 197         return -EINVAL;
 198 }
 199
 200 static int mma8452_standby(struct mma8452_data *data)
 201 {
 202         return i2c_smbus_write_byte_data(data->client, MMA8452_CTRL_REG1,
 203                 data->ctrl_reg1 & ~MMA8452_CTRL_ACTIVE);
 204 }
 205
 206 static int mma8452_active(struct mma8452_data *data)
 207 {
 208         return i2c_smbus_write_byte_data(data->client, MMA8452_CTRL_REG1,
 209                 data->ctrl_reg1);
 210 }
 211
 212 static int mma8452_change_config(struct mma8452_data *data, u8 reg, u8 val)
 213 {
 214         int ret;
 215
 216         mutex_lock(&data->lock);
 217
 218         /* config can only be changed when in standby */
 219         ret = mma8452_standby(data);
 220         if (ret < 0)
 221                 goto fail;
 222
 223         ret = i2c_smbus_write_byte_data(data->client, reg, val);
 224         if (ret < 0)
 225                 goto fail;
 226
 227         ret = mma8452_active(data);
 228         if (ret < 0)
 229                 goto fail;
 230
 231         ret = 0;
 232 fail:
 233         mutex_unlock(&data->lock);
 234         return ret;
 235 }
 236
 237 static int mma8452_write_raw(struct iio_dev *indio_dev,
 238                              struct iio_chan_spec const *chan,
 239                              int val, int val2, long mask)
 240 {
 241         struct mma8452_data *data = iio_priv(indio_dev);
 242         int i;
 243
 244         if (iio_buffer_enabled(indio_dev))
 245                 return -EBUSY;
 246
 247         switch (mask) {
 248         case IIO_CHAN_INFO_SAMP_FREQ:
 249                 i = mma8452_get_samp_freq_index(data, val, val2);
 250                 if (i < 0)
 251                         return -EINVAL;
 252
 253                 data->ctrl_reg1 &= ~MMA8452_CTRL_DR_MASK;
 254                 data->ctrl_reg1 |= i << MMA8452_CTRL_DR_SHIFT;
 255                 return mma8452_change_config(data, MMA8452_CTRL_REG1,
 256                         data->ctrl_reg1);
 257         case IIO_CHAN_INFO_SCALE:
 258                 i = mma8452_get_scale_index(data, val, val2);
 259                 if (i < 0)
 260                         return -EINVAL;
 261                 data->data_cfg &= ~MMA8452_DATA_CFG_FS_MASK;
 262                 data->data_cfg |= i;
 263                 return mma8452_change_config(data, MMA8452_DATA_CFG,
 264                         data->data_cfg);
 265         case IIO_CHAN_INFO_CALIBBIAS:
 266                 if (val < -128 || val > 127)
 267                         return -EINVAL;
 268                 return mma8452_change_config(data, MMA8452_OFF_X +
 269                         chan->scan_index, val);
 270         default:
 271                 return -EINVAL;
 272         }
 273 }
 274
 275 static irqreturn_t mma8452_trigger_handler(int irq, void *p)
 276 {
 277         struct iio_poll_func *pf = p;
 278         struct iio_dev *indio_dev = pf->indio_dev;
 279         struct mma8452_data *data = iio_priv(indio_dev);
 280         u8 buffer[16]; /* 3 16-bit channels + padding + ts */
 281         int ret;
 282
 283         ret = mma8452_read(data, (__be16 *) buffer);
 284         if (ret < 0)
 285                 goto done;
 286
 287         iio_push_to_buffers_with_timestamp(indio_dev, buffer,
 288                 iio_get_time_ns());
 289
 290 done:
 291         iio_trigger_notify_done(indio_dev->trig);
 292         return IRQ_HANDLED;
 293 }
 294
 295 #define MMA8452_CHANNEL(axis, idx) { \
 296         .type = IIO_ACCEL, \
 297         .modified = 1, \
 298         .channel2 = IIO_MOD_##axis, \
 299         .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
 300                 BIT(IIO_CHAN_INFO_CALIBBIAS), \
 301         .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \
 302                 BIT(IIO_CHAN_INFO_SCALE), \
 303         .scan_index = idx, \
 304         .scan_type = { \
 305                 .sign = 's', \
 306                 .realbits = 12, \
 307                 .storagebits = 16, \
 308                 .shift = 4, \
 309                 .endianness = IIO_BE, \
 310         }, \
 311 }
 312
 313 static const struct iio_chan_spec mma8452_channels[] = {
 314         MMA8452_CHANNEL(X, 0),
 315         MMA8452_CHANNEL(Y, 1),
 316         MMA8452_CHANNEL(Z, 2),
 317         IIO_CHAN_SOFT_TIMESTAMP(3),
 318 };
 319
 320 static struct attribute *mma8452_attributes[] = {
 321         &iio_dev_attr_sampling_frequency_available.dev_attr.attr,
 322         &iio_dev_attr_in_accel_scale_available.dev_attr.attr,
 323         NULL
 324 };
 325
 326 static const struct attribute_group mma8452_group = {
 327         .attrs = mma8452_attributes,
 328 };
 329
 330 static const struct iio_info mma8452_info = {
 331         .attrs = &mma8452_group,
 332         .read_raw = &mma8452_read_raw,
 333         .write_raw = &mma8452_write_raw,
 334         .driver_module = THIS_MODULE,
 335 };
 336
 337 static const unsigned long mma8452_scan_masks[] = {0x7, 0};
 338
 339 static int mma8452_reset(struct i2c_client *client)
 340 {
 341         int i;
 342         int ret;
 343
 344         ret = i2c_smbus_write_byte_data(client, MMA8452_CTRL_REG2,
 345                                         MMA8452_CTRL_REG2_RST);
 346         if (ret < 0)
 347                 return ret;
 348
 349         for (i = 0; i < 10; i++) {
 350                 usleep_range(100, 200);
 351                 ret = i2c_smbus_read_byte_data(client, MMA8452_CTRL_REG2);
 352                 if (ret == -EIO)
 353                         continue; /* I2C comm reset */
 354                 if (ret < 0)
 355                         return ret;
 356                 if (!(ret & MMA8452_CTRL_REG2_RST))
 357                         return 0;
 358         }
 359
 360         return -ETIMEDOUT;
 361 }
 362
 363 static int mma8452_probe(struct i2c_client *client,
 364                          const struct i2c_device_id *id)
 365 {
 366         struct mma8452_data *data;
 367         struct iio_dev *indio_dev;
 368         int ret;
 369
 370         ret = i2c_smbus_read_byte_data(client, MMA8452_WHO_AM_I);
 371         if (ret < 0)
 372                 return ret;
 373         if (ret != MMA8452_DEVICE_ID)
 374                 return -ENODEV;
 375
 376         indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
 377         if (!indio_dev)
 378                 return -ENOMEM;
 379
 380         data = iio_priv(indio_dev);
 381         data->client = client;
 382         mutex_init(&data->lock);
 383
 384         i2c_set_clientdata(client, indio_dev);
 385         indio_dev->info = &mma8452_info;
 386         indio_dev->name = id->name;
 387         indio_dev->dev.parent = &client->dev;
 388         indio_dev->modes = INDIO_DIRECT_MODE;
 389         indio_dev->channels = mma8452_channels;
 390         indio_dev->num_channels = ARRAY_SIZE(mma8452_channels);
 391         indio_dev->available_scan_masks = mma8452_scan_masks;
 392
 393         ret = mma8452_reset(client);
 394         if (ret < 0)
 395                 return ret;
 396
 397         data->data_cfg = MMA8452_DATA_CFG_FS_2G;
 398         ret = i2c_smbus_write_byte_data(client, MMA8452_DATA_CFG,
 399                 data->data_cfg);
 400         if (ret < 0)
 401                 return ret;
 402
 403         data->ctrl_reg1 = MMA8452_CTRL_ACTIVE |
 404                 (MMA8452_CTRL_DR_DEFAULT << MMA8452_CTRL_DR_SHIFT);
 405         ret = i2c_smbus_write_byte_data(client, MMA8452_CTRL_REG1,
 406                                         data->ctrl_reg1);
 407         if (ret < 0)
 408                 return ret;
 409
 410         ret = iio_triggered_buffer_setup(indio_dev, NULL,
 411                 mma8452_trigger_handler, NULL);
 412         if (ret < 0)
 413                 return ret;
 414
 415         ret = iio_device_register(indio_dev);
 416         if (ret < 0)
 417                 goto buffer_cleanup;
 418         return 0;
 419
 420 buffer_cleanup:
 421         iio_triggered_buffer_cleanup(indio_dev);
 422         return ret;
 423 }
 424
 425 static int mma8452_remove(struct i2c_client *client)
 426 {
 427         struct iio_dev *indio_dev = i2c_get_clientdata(client);
 428
 429         iio_device_unregister(indio_dev);
 430         iio_triggered_buffer_cleanup(indio_dev);
 431         mma8452_standby(iio_priv(indio_dev));
 432
 433         return 0;
 434 }
 435
 436 #ifdef CONFIG_PM_SLEEP
 437 static int mma8452_suspend(struct device *dev)
 438 {
 439         return mma8452_standby(iio_priv(i2c_get_clientdata(
 440                 to_i2c_client(dev))));
 441 }
 442
 443 static int mma8452_resume(struct device *dev)
 444 {
 445         return mma8452_active(iio_priv(i2c_get_clientdata(
 446                 to_i2c_client(dev))));
 447 }
 448
 449 static SIMPLE_DEV_PM_OPS(mma8452_pm_ops, mma8452_suspend, mma8452_resume);
 450 #define MMA8452_PM_OPS (&mma8452_pm_ops)
 451 #else
 452 #define MMA8452_PM_OPS NULL
 453 #endif
 454
 455 static const struct i2c_device_id mma8452_id[] = {
 456         { "mma8452", 0 },
 457         { }
 458 };
 459 MODULE_DEVICE_TABLE(i2c, mma8452_id);
 460
 461 static const struct of_device_id mma8452_dt_ids[] = {
 462         { .compatible = "fsl,mma8452" },
 463         { }
 464 };
 465
 466 static struct i2c_driver mma8452_driver = {
 467         .driver = {
 468                 .name   = "mma8452",
 469                 .of_match_table = of_match_ptr(mma8452_dt_ids),
 470                 .pm     = MMA8452_PM_OPS,
 471         },
 472         .probe = mma8452_probe,
 473         .remove = mma8452_remove,
 474         .id_table = mma8452_id,
 475 };
 476 module_i2c_driver(mma8452_driver);
 477
 478 MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>");
 479 MODULE_DESCRIPTION("Freescale MMA8452 accelerometer driver");
 480 MODULE_LICENSE("GPL");