linux/drivers/iio/accel/mxc4005.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0-only
   2/*
   3 * 3-axis accelerometer driver for MXC4005XC Memsic sensor
   4 *
   5 * Copyright (c) 2014, Intel Corporation.
   6 */
   7
   8#include <linux/module.h>
   9#include <linux/i2c.h>
  10#include <linux/iio/iio.h>
  11#include <linux/acpi.h>
  12#include <linux/regmap.h>
  13#include <linux/iio/sysfs.h>
  14#include <linux/iio/trigger.h>
  15#include <linux/iio/buffer.h>
  16#include <linux/iio/triggered_buffer.h>
  17#include <linux/iio/trigger_consumer.h>
  18
  19#define MXC4005_DRV_NAME                "mxc4005"
  20#define MXC4005_IRQ_NAME                "mxc4005_event"
  21#define MXC4005_REGMAP_NAME             "mxc4005_regmap"
  22
  23#define MXC4005_REG_XOUT_UPPER          0x03
  24#define MXC4005_REG_XOUT_LOWER          0x04
  25#define MXC4005_REG_YOUT_UPPER          0x05
  26#define MXC4005_REG_YOUT_LOWER          0x06
  27#define MXC4005_REG_ZOUT_UPPER          0x07
  28#define MXC4005_REG_ZOUT_LOWER          0x08
  29
  30#define MXC4005_REG_INT_MASK1           0x0B
  31#define MXC4005_REG_INT_MASK1_BIT_DRDYE 0x01
  32
  33#define MXC4005_REG_INT_CLR1            0x01
  34#define MXC4005_REG_INT_CLR1_BIT_DRDYC  0x01
  35
  36#define MXC4005_REG_CONTROL             0x0D
  37#define MXC4005_REG_CONTROL_MASK_FSR    GENMASK(6, 5)
  38#define MXC4005_CONTROL_FSR_SHIFT       5
  39
  40#define MXC4005_REG_DEVICE_ID           0x0E
  41
  42enum mxc4005_axis {
  43        AXIS_X,
  44        AXIS_Y,
  45        AXIS_Z,
  46};
  47
  48enum mxc4005_range {
  49        MXC4005_RANGE_2G,
  50        MXC4005_RANGE_4G,
  51        MXC4005_RANGE_8G,
  52};
  53
  54struct mxc4005_data {
  55        struct device *dev;
  56        struct mutex mutex;
  57        struct regmap *regmap;
  58        struct iio_trigger *dready_trig;
  59        /* Ensure timestamp is naturally aligned */
  60        struct {
  61                __be16 chans[3];
  62                s64 timestamp __aligned(8);
  63        } scan;
  64        bool trigger_enabled;
  65};
  66
  67/*
  68 * MXC4005 can operate in the following ranges:
  69 * +/- 2G, 4G, 8G (the default +/-2G)
  70 *
  71 * (2 + 2) * 9.81 / (2^12 - 1) = 0.009582
  72 * (4 + 4) * 9.81 / (2^12 - 1) = 0.019164
  73 * (8 + 8) * 9.81 / (2^12 - 1) = 0.038329
  74 */
  75static const struct {
  76        u8 range;
  77        int scale;
  78} mxc4005_scale_table[] = {
  79        {MXC4005_RANGE_2G, 9582},
  80        {MXC4005_RANGE_4G, 19164},
  81        {MXC4005_RANGE_8G, 38329},
  82};
  83
  84
  85static IIO_CONST_ATTR(in_accel_scale_available, "0.009582 0.019164 0.038329");
  86
  87static struct attribute *mxc4005_attributes[] = {
  88        &iio_const_attr_in_accel_scale_available.dev_attr.attr,
  89        NULL,
  90};
  91
  92static const struct attribute_group mxc4005_attrs_group = {
  93        .attrs = mxc4005_attributes,
  94};
  95
  96static bool mxc4005_is_readable_reg(struct device *dev, unsigned int reg)
  97{
  98        switch (reg) {
  99        case MXC4005_REG_XOUT_UPPER:
 100        case MXC4005_REG_XOUT_LOWER:
 101        case MXC4005_REG_YOUT_UPPER:
 102        case MXC4005_REG_YOUT_LOWER:
 103        case MXC4005_REG_ZOUT_UPPER:
 104        case MXC4005_REG_ZOUT_LOWER:
 105        case MXC4005_REG_DEVICE_ID:
 106        case MXC4005_REG_CONTROL:
 107                return true;
 108        default:
 109                return false;
 110        }
 111}
 112
 113static bool mxc4005_is_writeable_reg(struct device *dev, unsigned int reg)
 114{
 115        switch (reg) {
 116        case MXC4005_REG_INT_CLR1:
 117        case MXC4005_REG_INT_MASK1:
 118        case MXC4005_REG_CONTROL:
 119                return true;
 120        default:
 121                return false;
 122        }
 123}
 124
 125static const struct regmap_config mxc4005_regmap_config = {
 126        .name = MXC4005_REGMAP_NAME,
 127
 128        .reg_bits = 8,
 129        .val_bits = 8,
 130
 131        .max_register = MXC4005_REG_DEVICE_ID,
 132
 133        .readable_reg = mxc4005_is_readable_reg,
 134        .writeable_reg = mxc4005_is_writeable_reg,
 135};
 136
 137static int mxc4005_read_xyz(struct mxc4005_data *data)
 138{
 139        int ret;
 140
 141        ret = regmap_bulk_read(data->regmap, MXC4005_REG_XOUT_UPPER,
 142                               data->scan.chans, sizeof(data->scan.chans));
 143        if (ret < 0) {
 144                dev_err(data->dev, "failed to read axes\n");
 145                return ret;
 146        }
 147
 148        return 0;
 149}
 150
 151static int mxc4005_read_axis(struct mxc4005_data *data,
 152                             unsigned int addr)
 153{
 154        __be16 reg;
 155        int ret;
 156
 157        ret = regmap_bulk_read(data->regmap, addr, &reg, sizeof(reg));
 158        if (ret < 0) {
 159                dev_err(data->dev, "failed to read reg %02x\n", addr);
 160                return ret;
 161        }
 162
 163        return be16_to_cpu(reg);
 164}
 165
 166static int mxc4005_read_scale(struct mxc4005_data *data)
 167{
 168        unsigned int reg;
 169        int ret;
 170        int i;
 171
 172        ret = regmap_read(data->regmap, MXC4005_REG_CONTROL, &reg);
 173        if (ret < 0) {
 174                dev_err(data->dev, "failed to read reg_control\n");
 175                return ret;
 176        }
 177
 178        i = reg >> MXC4005_CONTROL_FSR_SHIFT;
 179
 180        if (i < 0 || i >= ARRAY_SIZE(mxc4005_scale_table))
 181                return -EINVAL;
 182
 183        return mxc4005_scale_table[i].scale;
 184}
 185
 186static int mxc4005_set_scale(struct mxc4005_data *data, int val)
 187{
 188        unsigned int reg;
 189        int i;
 190        int ret;
 191
 192        for (i = 0; i < ARRAY_SIZE(mxc4005_scale_table); i++) {
 193                if (mxc4005_scale_table[i].scale == val) {
 194                        reg = i << MXC4005_CONTROL_FSR_SHIFT;
 195                        ret = regmap_update_bits(data->regmap,
 196                                                 MXC4005_REG_CONTROL,
 197                                                 MXC4005_REG_CONTROL_MASK_FSR,
 198                                                 reg);
 199                        if (ret < 0)
 200                                dev_err(data->dev,
 201                                        "failed to write reg_control\n");
 202                        return ret;
 203                }
 204        }
 205
 206        return -EINVAL;
 207}
 208
 209static int mxc4005_read_raw(struct iio_dev *indio_dev,
 210                            struct iio_chan_spec const *chan,
 211                            int *val, int *val2, long mask)
 212{
 213        struct mxc4005_data *data = iio_priv(indio_dev);
 214        int ret;
 215
 216        switch (mask) {
 217        case IIO_CHAN_INFO_RAW:
 218                switch (chan->type) {
 219                case IIO_ACCEL:
 220                        if (iio_buffer_enabled(indio_dev))
 221                                return -EBUSY;
 222
 223                        ret = mxc4005_read_axis(data, chan->address);
 224                        if (ret < 0)
 225                                return ret;
 226                        *val = sign_extend32(ret >> chan->scan_type.shift,
 227                                             chan->scan_type.realbits - 1);
 228                        return IIO_VAL_INT;
 229                default:
 230                        return -EINVAL;
 231                }
 232        case IIO_CHAN_INFO_SCALE:
 233                ret = mxc4005_read_scale(data);
 234                if (ret < 0)
 235                        return ret;
 236
 237                *val = 0;
 238                *val2 = ret;
 239                return IIO_VAL_INT_PLUS_MICRO;
 240        default:
 241                return -EINVAL;
 242        }
 243}
 244
 245static int mxc4005_write_raw(struct iio_dev *indio_dev,
 246                             struct iio_chan_spec const *chan,
 247                             int val, int val2, long mask)
 248{
 249        struct mxc4005_data *data = iio_priv(indio_dev);
 250
 251        switch (mask) {
 252        case IIO_CHAN_INFO_SCALE:
 253                if (val != 0)
 254                        return -EINVAL;
 255
 256                return mxc4005_set_scale(data, val2);
 257        default:
 258                return -EINVAL;
 259        }
 260}
 261
 262static const struct iio_info mxc4005_info = {
 263        .read_raw       = mxc4005_read_raw,
 264        .write_raw      = mxc4005_write_raw,
 265        .attrs          = &mxc4005_attrs_group,
 266};
 267
 268static const unsigned long mxc4005_scan_masks[] = {
 269        BIT(AXIS_X) | BIT(AXIS_Y) | BIT(AXIS_Z),
 270        0
 271};
 272
 273#define MXC4005_CHANNEL(_axis, _addr) {                         \
 274        .type = IIO_ACCEL,                                      \
 275        .modified = 1,                                          \
 276        .channel2 = IIO_MOD_##_axis,                            \
 277        .address = _addr,                                       \
 278        .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),           \
 279        .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),   \
 280        .scan_index = AXIS_##_axis,                             \
 281        .scan_type = {                                          \
 282                .sign = 's',                                    \
 283                .realbits = 12,                                 \
 284                .storagebits = 16,                              \
 285                .shift = 4,                                     \
 286                .endianness = IIO_BE,                           \
 287        },                                                      \
 288}
 289
 290static const struct iio_chan_spec mxc4005_channels[] = {
 291        MXC4005_CHANNEL(X, MXC4005_REG_XOUT_UPPER),
 292        MXC4005_CHANNEL(Y, MXC4005_REG_YOUT_UPPER),
 293        MXC4005_CHANNEL(Z, MXC4005_REG_ZOUT_UPPER),
 294        IIO_CHAN_SOFT_TIMESTAMP(3),
 295};
 296
 297static irqreturn_t mxc4005_trigger_handler(int irq, void *private)
 298{
 299        struct iio_poll_func *pf = private;
 300        struct iio_dev *indio_dev = pf->indio_dev;
 301        struct mxc4005_data *data = iio_priv(indio_dev);
 302        int ret;
 303
 304        ret = mxc4005_read_xyz(data);
 305        if (ret < 0)
 306                goto err;
 307
 308        iio_push_to_buffers_with_timestamp(indio_dev, &data->scan,
 309                                           pf->timestamp);
 310
 311err:
 312        iio_trigger_notify_done(indio_dev->trig);
 313
 314        return IRQ_HANDLED;
 315}
 316
 317static void mxc4005_clr_intr(struct mxc4005_data *data)
 318{
 319        int ret;
 320
 321        /* clear interrupt */
 322        ret = regmap_write(data->regmap, MXC4005_REG_INT_CLR1,
 323                           MXC4005_REG_INT_CLR1_BIT_DRDYC);
 324        if (ret < 0)
 325                dev_err(data->dev, "failed to write to reg_int_clr1\n");
 326}
 327
 328static int mxc4005_set_trigger_state(struct iio_trigger *trig,
 329                                     bool state)
 330{
 331        struct iio_dev *indio_dev = iio_trigger_get_drvdata(trig);
 332        struct mxc4005_data *data = iio_priv(indio_dev);
 333        int ret;
 334
 335        mutex_lock(&data->mutex);
 336        if (state) {
 337                ret = regmap_write(data->regmap, MXC4005_REG_INT_MASK1,
 338                                   MXC4005_REG_INT_MASK1_BIT_DRDYE);
 339        } else {
 340                ret = regmap_write(data->regmap, MXC4005_REG_INT_MASK1,
 341                                   ~MXC4005_REG_INT_MASK1_BIT_DRDYE);
 342        }
 343
 344        if (ret < 0) {
 345                mutex_unlock(&data->mutex);
 346                dev_err(data->dev, "failed to update reg_int_mask1");
 347                return ret;
 348        }
 349
 350        data->trigger_enabled = state;
 351        mutex_unlock(&data->mutex);
 352
 353        return 0;
 354}
 355
 356static void mxc4005_trigger_reen(struct iio_trigger *trig)
 357{
 358        struct iio_dev *indio_dev = iio_trigger_get_drvdata(trig);
 359        struct mxc4005_data *data = iio_priv(indio_dev);
 360
 361        if (!data->dready_trig)
 362                return;
 363
 364        mxc4005_clr_intr(data);
 365}
 366
 367static const struct iio_trigger_ops mxc4005_trigger_ops = {
 368        .set_trigger_state = mxc4005_set_trigger_state,
 369        .reenable = mxc4005_trigger_reen,
 370};
 371
 372static int mxc4005_chip_init(struct mxc4005_data *data)
 373{
 374        int ret;
 375        unsigned int reg;
 376
 377        ret = regmap_read(data->regmap, MXC4005_REG_DEVICE_ID, &reg);
 378        if (ret < 0) {
 379                dev_err(data->dev, "failed to read chip id\n");
 380                return ret;
 381        }
 382
 383        dev_dbg(data->dev, "MXC4005 chip id %02x\n", reg);
 384
 385        return 0;
 386}
 387
 388static int mxc4005_probe(struct i2c_client *client,
 389                         const struct i2c_device_id *id)
 390{
 391        struct mxc4005_data *data;
 392        struct iio_dev *indio_dev;
 393        struct regmap *regmap;
 394        int ret;
 395
 396        indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
 397        if (!indio_dev)
 398                return -ENOMEM;
 399
 400        regmap = devm_regmap_init_i2c(client, &mxc4005_regmap_config);
 401        if (IS_ERR(regmap)) {
 402                dev_err(&client->dev, "failed to initialize regmap\n");
 403                return PTR_ERR(regmap);
 404        }
 405
 406        data = iio_priv(indio_dev);
 407        i2c_set_clientdata(client, indio_dev);
 408        data->dev = &client->dev;
 409        data->regmap = regmap;
 410
 411        ret = mxc4005_chip_init(data);
 412        if (ret < 0) {
 413                dev_err(&client->dev, "failed to initialize chip\n");
 414                return ret;
 415        }
 416
 417        mutex_init(&data->mutex);
 418
 419        indio_dev->channels = mxc4005_channels;
 420        indio_dev->num_channels = ARRAY_SIZE(mxc4005_channels);
 421        indio_dev->available_scan_masks = mxc4005_scan_masks;
 422        indio_dev->name = MXC4005_DRV_NAME;
 423        indio_dev->modes = INDIO_DIRECT_MODE;
 424        indio_dev->info = &mxc4005_info;
 425
 426        ret = devm_iio_triggered_buffer_setup(&client->dev, indio_dev,
 427                                         iio_pollfunc_store_time,
 428                                         mxc4005_trigger_handler,
 429                                         NULL);
 430        if (ret < 0) {
 431                dev_err(&client->dev,
 432                        "failed to setup iio triggered buffer\n");
 433                return ret;
 434        }
 435
 436        if (client->irq > 0) {
 437                data->dready_trig = devm_iio_trigger_alloc(&client->dev,
 438                                                           "%s-dev%d",
 439                                                           indio_dev->name,
 440                                                           iio_device_id(indio_dev));
 441                if (!data->dready_trig)
 442                        return -ENOMEM;
 443
 444                ret = devm_request_threaded_irq(&client->dev, client->irq,
 445                                                iio_trigger_generic_data_rdy_poll,
 446                                                NULL,
 447                                                IRQF_TRIGGER_FALLING |
 448                                                IRQF_ONESHOT,
 449                                                MXC4005_IRQ_NAME,
 450                                                data->dready_trig);
 451                if (ret) {
 452                        dev_err(&client->dev,
 453                                "failed to init threaded irq\n");
 454                        return ret;
 455                }
 456
 457                data->dready_trig->ops = &mxc4005_trigger_ops;
 458                iio_trigger_set_drvdata(data->dready_trig, indio_dev);
 459                indio_dev->trig = data->dready_trig;
 460                iio_trigger_get(indio_dev->trig);
 461                ret = devm_iio_trigger_register(&client->dev,
 462                                                data->dready_trig);
 463                if (ret) {
 464                        dev_err(&client->dev,
 465                                "failed to register trigger\n");
 466                        return ret;
 467                }
 468        }
 469
 470        return devm_iio_device_register(&client->dev, indio_dev);
 471}
 472
 473static const struct acpi_device_id mxc4005_acpi_match[] = {
 474        {"MXC4005",     0},
 475        {"MXC6655",     0},
 476        { },
 477};
 478MODULE_DEVICE_TABLE(acpi, mxc4005_acpi_match);
 479
 480static const struct i2c_device_id mxc4005_id[] = {
 481        {"mxc4005",     0},
 482        {"mxc6655",     0},
 483        { },
 484};
 485MODULE_DEVICE_TABLE(i2c, mxc4005_id);
 486
 487static struct i2c_driver mxc4005_driver = {
 488        .driver = {
 489                .name = MXC4005_DRV_NAME,
 490                .acpi_match_table = ACPI_PTR(mxc4005_acpi_match),
 491        },
 492        .probe          = mxc4005_probe,
 493        .id_table       = mxc4005_id,
 494};
 495
 496module_i2c_driver(mxc4005_driver);
 497
 498MODULE_AUTHOR("Teodora Baluta <teodora.baluta@intel.com>");
 499MODULE_LICENSE("GPL v2");
 500MODULE_DESCRIPTION("MXC4005 3-axis accelerometer driver");
 501