drivers/iio/magnetometer/mag3110.c

   1 /*
   2  * mag3110.c - Support for Freescale MAG3110 magnetometer sensor
   3  *
   4  * Copyright (c) 2013 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 0x0e)
  11  *
  12  * TODO: irq, user offset, oversampling, continuous mode
  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 MAG3110_STATUS 0x00
  25 #define MAG3110_OUT_X 0x01 /* MSB first */
  26 #define MAG3110_OUT_Y 0x03
  27 #define MAG3110_OUT_Z 0x05
  28 #define MAG3110_WHO_AM_I 0x07
  29 #define MAG3110_OFF_X 0x09 /* MSB first */
  30 #define MAG3110_OFF_Y 0x0b
  31 #define MAG3110_OFF_Z 0x0d
  32 #define MAG3110_DIE_TEMP 0x0f
  33 #define MAG3110_CTRL_REG1 0x10
  34 #define MAG3110_CTRL_REG2 0x11
  35
  36 #define MAG3110_STATUS_DRDY (BIT(2) | BIT(1) | BIT(0))
  37
  38 #define MAG3110_CTRL_DR_MASK (BIT(7) | BIT(6) | BIT(5))
  39 #define MAG3110_CTRL_DR_SHIFT 5
  40 #define MAG3110_CTRL_DR_DEFAULT 0
  41
  42 #define MAG3110_CTRL_TM BIT(1) /* trigger single measurement */
  43 #define MAG3110_CTRL_AC BIT(0) /* continuous measurements */
  44
  45 #define MAG3110_CTRL_AUTO_MRST_EN BIT(7) /* magnetic auto-reset */
  46 #define MAG3110_CTRL_RAW BIT(5) /* measurements not user-offset corrected */
  47
  48 #define MAG3110_DEVICE_ID 0xc4
  49
  50 /* Each client has this additional data */
  51 struct mag3110_data {
  52         struct i2c_client *client;
  53         struct mutex lock;
  54         u8 ctrl_reg1;
  55         /* Ensure natural alignment of timestamp */
  56         struct {
  57                 __be16 channels[3];
  58                 u8 temperature;
  59                 s64 ts __aligned(8);
  60         } scan;
  61 };
  62
  63 static int mag3110_request(struct mag3110_data *data)
  64 {
  65         int ret, tries = 150;
  66
  67         /* trigger measurement */
  68         ret = i2c_smbus_write_byte_data(data->client, MAG3110_CTRL_REG1,
  69                 data->ctrl_reg1 | MAG3110_CTRL_TM);
  70         if (ret < 0)
  71                 return ret;
  72
  73         while (tries-- > 0) {
  74                 ret = i2c_smbus_read_byte_data(data->client, MAG3110_STATUS);
  75                 if (ret < 0)
  76                         return ret;
  77                 /* wait for data ready */
  78                 if ((ret & MAG3110_STATUS_DRDY) == MAG3110_STATUS_DRDY)
  79                         break;
  80                 msleep(20);
  81         }
  82
  83         if (tries < 0) {
  84                 dev_err(&data->client->dev, "data not ready\n");
  85                 return -EIO;
  86         }
  87
  88         return 0;
  89 }
  90
  91 static int mag3110_read(struct mag3110_data *data, __be16 buf[3])
  92 {
  93         int ret;
  94
  95         mutex_lock(&data->lock);
  96         ret = mag3110_request(data);
  97         if (ret < 0) {
  98                 mutex_unlock(&data->lock);
  99                 return ret;
 100         }
 101         ret = i2c_smbus_read_i2c_block_data(data->client,
 102                 MAG3110_OUT_X, 3 * sizeof(__be16), (u8 *) buf);
 103         mutex_unlock(&data->lock);
 104
 105         return ret;
 106 }
 107
 108 static ssize_t mag3110_show_int_plus_micros(char *buf,
 109         const int (*vals)[2], int n)
 110 {
 111         size_t len = 0;
 112
 113         while (n-- > 0)
 114                 len += scnprintf(buf + len, PAGE_SIZE - len,
 115                         "%d.%06d ", vals[n][0], vals[n][1]);
 116
 117         /* replace trailing space by newline */
 118         buf[len - 1] = '\n';
 119
 120         return len;
 121 }
 122
 123 static int mag3110_get_int_plus_micros_index(const int (*vals)[2], int n,
 124                                         int val, int val2)
 125 {
 126         while (n-- > 0)
 127                 if (val == vals[n][0] && val2 == vals[n][1])
 128                         return n;
 129
 130         return -EINVAL;
 131 }
 132
 133 static const int mag3110_samp_freq[8][2] = {
 134         {80, 0}, {40, 0}, {20, 0}, {10, 0}, {5, 0}, {2, 500000},
 135         {1, 250000}, {0, 625000}
 136 };
 137
 138 static ssize_t mag3110_show_samp_freq_avail(struct device *dev,
 139                                 struct device_attribute *attr, char *buf)
 140 {
 141         return mag3110_show_int_plus_micros(buf, mag3110_samp_freq, 8);
 142 }
 143
 144 static IIO_DEV_ATTR_SAMP_FREQ_AVAIL(mag3110_show_samp_freq_avail);
 145
 146 static int mag3110_get_samp_freq_index(struct mag3110_data *data,
 147         int val, int val2)
 148 {
 149         return mag3110_get_int_plus_micros_index(mag3110_samp_freq, 8, val,
 150                 val2);
 151 }
 152
 153 static int mag3110_read_raw(struct iio_dev *indio_dev,
 154                             struct iio_chan_spec const *chan,
 155                             int *val, int *val2, long mask)
 156 {
 157         struct mag3110_data *data = iio_priv(indio_dev);
 158         __be16 buffer[3];
 159         int i, ret;
 160
 161         switch (mask) {
 162         case IIO_CHAN_INFO_RAW:
 163                 if (iio_buffer_enabled(indio_dev))
 164                         return -EBUSY;
 165
 166                 switch (chan->type) {
 167                 case IIO_MAGN: /* in 0.1 uT / LSB */
 168                         ret = mag3110_read(data, buffer);
 169                         if (ret < 0)
 170                                 return ret;
 171                         *val = sign_extend32(
 172                                 be16_to_cpu(buffer[chan->scan_index]), 15);
 173                         return IIO_VAL_INT;
 174                 case IIO_TEMP: /* in 1 C / LSB */
 175                         mutex_lock(&data->lock);
 176                         ret = mag3110_request(data);
 177                         if (ret < 0) {
 178                                 mutex_unlock(&data->lock);
 179                                 return ret;
 180                         }
 181                         ret = i2c_smbus_read_byte_data(data->client,
 182                                 MAG3110_DIE_TEMP);
 183                         mutex_unlock(&data->lock);
 184                         if (ret < 0)
 185                                 return ret;
 186                         *val = sign_extend32(ret, 7);
 187                         return IIO_VAL_INT;
 188                 default:
 189                         return -EINVAL;
 190                 }
 191         case IIO_CHAN_INFO_SCALE:
 192                 switch (chan->type) {
 193                 case IIO_MAGN:
 194                         *val = 0;
 195                         *val2 = 1000;
 196                         return IIO_VAL_INT_PLUS_MICRO;
 197                 case IIO_TEMP:
 198                         *val = 1000;
 199                         return IIO_VAL_INT;
 200                 default:
 201                         return -EINVAL;
 202                 }
 203         case IIO_CHAN_INFO_SAMP_FREQ:
 204                 i = data->ctrl_reg1 >> MAG3110_CTRL_DR_SHIFT;
 205                 *val = mag3110_samp_freq[i][0];
 206                 *val2 = mag3110_samp_freq[i][1];
 207                 return IIO_VAL_INT_PLUS_MICRO;
 208         case IIO_CHAN_INFO_CALIBBIAS:
 209                 ret = i2c_smbus_read_word_swapped(data->client,
 210                         MAG3110_OFF_X + 2 * chan->scan_index);
 211                 if (ret < 0)
 212                         return ret;
 213                 *val = sign_extend32(ret >> 1, 14);
 214                 return IIO_VAL_INT;
 215         }
 216         return -EINVAL;
 217 }
 218
 219 static int mag3110_write_raw(struct iio_dev *indio_dev,
 220                              struct iio_chan_spec const *chan,
 221                              int val, int val2, long mask)
 222 {
 223         struct mag3110_data *data = iio_priv(indio_dev);
 224         int rate;
 225
 226         if (iio_buffer_enabled(indio_dev))
 227                 return -EBUSY;
 228
 229         switch (mask) {
 230         case IIO_CHAN_INFO_SAMP_FREQ:
 231                 rate = mag3110_get_samp_freq_index(data, val, val2);
 232                 if (rate < 0)
 233                         return -EINVAL;
 234
 235                 data->ctrl_reg1 &= ~MAG3110_CTRL_DR_MASK;
 236                 data->ctrl_reg1 |= rate << MAG3110_CTRL_DR_SHIFT;
 237                 return i2c_smbus_write_byte_data(data->client,
 238                         MAG3110_CTRL_REG1, data->ctrl_reg1);
 239         case IIO_CHAN_INFO_CALIBBIAS:
 240                 if (val < -10000 || val > 10000)
 241                         return -EINVAL;
 242                 return i2c_smbus_write_word_swapped(data->client,
 243                         MAG3110_OFF_X + 2 * chan->scan_index, val << 1);
 244         default:
 245                 return -EINVAL;
 246         }
 247 }
 248
 249 static irqreturn_t mag3110_trigger_handler(int irq, void *p)
 250 {
 251         struct iio_poll_func *pf = p;
 252         struct iio_dev *indio_dev = pf->indio_dev;
 253         struct mag3110_data *data = iio_priv(indio_dev);
 254         int ret;
 255
 256         ret = mag3110_read(data, data->scan.channels);
 257         if (ret < 0)
 258                 goto done;
 259
 260         if (test_bit(3, indio_dev->active_scan_mask)) {
 261                 ret = i2c_smbus_read_byte_data(data->client,
 262                         MAG3110_DIE_TEMP);
 263                 if (ret < 0)
 264                         goto done;
 265                 data->scan.temperature = ret;
 266         }
 267
 268         iio_push_to_buffers_with_timestamp(indio_dev, &data->scan,
 269                 iio_get_time_ns());
 270
 271 done:
 272         iio_trigger_notify_done(indio_dev->trig);
 273         return IRQ_HANDLED;
 274 }
 275
 276 #define MAG3110_CHANNEL(axis, idx) { \
 277         .type = IIO_MAGN, \
 278         .modified = 1, \
 279         .channel2 = IIO_MOD_##axis, \
 280         .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
 281                 BIT(IIO_CHAN_INFO_CALIBBIAS), \
 282         .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \
 283                 BIT(IIO_CHAN_INFO_SCALE), \
 284         .scan_index = idx, \
 285         .scan_type = { \
 286                 .sign = 's', \
 287                 .realbits = 16, \
 288                 .storagebits = 16, \
 289                 .endianness = IIO_BE, \
 290         }, \
 291 }
 292
 293 static const struct iio_chan_spec mag3110_channels[] = {
 294         MAG3110_CHANNEL(X, 0),
 295         MAG3110_CHANNEL(Y, 1),
 296         MAG3110_CHANNEL(Z, 2),
 297         {
 298                 .type = IIO_TEMP,
 299                 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
 300                         BIT(IIO_CHAN_INFO_SCALE),
 301                 .scan_index = 3,
 302                 .scan_type = {
 303                         .sign = 's',
 304                         .realbits = 8,
 305                         .storagebits = 8,
 306                         },
 307         },
 308         IIO_CHAN_SOFT_TIMESTAMP(4),
 309 };
 310
 311 static struct attribute *mag3110_attributes[] = {
 312         &iio_dev_attr_sampling_frequency_available.dev_attr.attr,
 313         NULL
 314 };
 315
 316 static const struct attribute_group mag3110_group = {
 317         .attrs = mag3110_attributes,
 318 };
 319
 320 static const struct iio_info mag3110_info = {
 321         .attrs = &mag3110_group,
 322         .read_raw = &mag3110_read_raw,
 323         .write_raw = &mag3110_write_raw,
 324         .driver_module = THIS_MODULE,
 325 };
 326
 327 static const unsigned long mag3110_scan_masks[] = {0x7, 0xf, 0};
 328
 329 static int mag3110_standby(struct mag3110_data *data)
 330 {
 331         return i2c_smbus_write_byte_data(data->client, MAG3110_CTRL_REG1,
 332                 data->ctrl_reg1 & ~MAG3110_CTRL_AC);
 333 }
 334
 335 static int mag3110_probe(struct i2c_client *client,
 336                          const struct i2c_device_id *id)
 337 {
 338         struct mag3110_data *data;
 339         struct iio_dev *indio_dev;
 340         int ret;
 341
 342         ret = i2c_smbus_read_byte_data(client, MAG3110_WHO_AM_I);
 343         if (ret < 0)
 344                 return ret;
 345         if (ret != MAG3110_DEVICE_ID)
 346                 return -ENODEV;
 347
 348         indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
 349         if (!indio_dev)
 350                 return -ENOMEM;
 351
 352         data = iio_priv(indio_dev);
 353         data->client = client;
 354         mutex_init(&data->lock);
 355
 356         i2c_set_clientdata(client, indio_dev);
 357         indio_dev->info = &mag3110_info;
 358         indio_dev->name = id->name;
 359         indio_dev->dev.parent = &client->dev;
 360         indio_dev->modes = INDIO_DIRECT_MODE;
 361         indio_dev->channels = mag3110_channels;
 362         indio_dev->num_channels = ARRAY_SIZE(mag3110_channels);
 363         indio_dev->available_scan_masks = mag3110_scan_masks;
 364
 365         data->ctrl_reg1 = MAG3110_CTRL_DR_DEFAULT << MAG3110_CTRL_DR_SHIFT;
 366         ret = i2c_smbus_write_byte_data(client, MAG3110_CTRL_REG1,
 367                 data->ctrl_reg1);
 368         if (ret < 0)
 369                 return ret;
 370
 371         ret = i2c_smbus_write_byte_data(client, MAG3110_CTRL_REG2,
 372                 MAG3110_CTRL_AUTO_MRST_EN);
 373         if (ret < 0)
 374                 goto standby_on_error;
 375
 376         ret = iio_triggered_buffer_setup(indio_dev, NULL,
 377                 mag3110_trigger_handler, NULL);
 378         if (ret < 0)
 379                 goto standby_on_error;
 380
 381         ret = iio_device_register(indio_dev);
 382         if (ret < 0)
 383                 goto buffer_cleanup;
 384         return 0;
 385
 386 buffer_cleanup:
 387         iio_triggered_buffer_cleanup(indio_dev);
 388 standby_on_error:
 389         mag3110_standby(iio_priv(indio_dev));
 390         return ret;
 391 }
 392
 393 static int mag3110_remove(struct i2c_client *client)
 394 {
 395         struct iio_dev *indio_dev = i2c_get_clientdata(client);
 396
 397         iio_device_unregister(indio_dev);
 398         iio_triggered_buffer_cleanup(indio_dev);
 399         mag3110_standby(iio_priv(indio_dev));
 400
 401         return 0;
 402 }
 403
 404 #ifdef CONFIG_PM_SLEEP
 405 static int mag3110_suspend(struct device *dev)
 406 {
 407         return mag3110_standby(iio_priv(i2c_get_clientdata(
 408                 to_i2c_client(dev))));
 409 }
 410
 411 static int mag3110_resume(struct device *dev)
 412 {
 413         struct mag3110_data *data = iio_priv(i2c_get_clientdata(
 414                 to_i2c_client(dev)));
 415
 416         return i2c_smbus_write_byte_data(data->client, MAG3110_CTRL_REG1,
 417                 data->ctrl_reg1);
 418 }
 419
 420 static SIMPLE_DEV_PM_OPS(mag3110_pm_ops, mag3110_suspend, mag3110_resume);
 421 #define MAG3110_PM_OPS (&mag3110_pm_ops)
 422 #else
 423 #define MAG3110_PM_OPS NULL
 424 #endif
 425
 426 static const struct i2c_device_id mag3110_id[] = {
 427         { "mag3110", 0 },
 428         { }
 429 };
 430 MODULE_DEVICE_TABLE(i2c, mag3110_id);
 431
 432 static struct i2c_driver mag3110_driver = {
 433         .driver = {
 434                 .name   = "mag3110",
 435                 .pm     = MAG3110_PM_OPS,
 436         },
 437         .probe = mag3110_probe,
 438         .remove = mag3110_remove,
 439         .id_table = mag3110_id,
 440 };
 441 module_i2c_driver(mag3110_driver);
 442
 443 MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>");
 444 MODULE_DESCRIPTION("Freescale MAG3110 magnetometer driver");
 445 MODULE_LICENSE("GPL");