drivers/iio/imu/adis.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * Common library for ADIS16XXX devices
   4  *
   5  * Copyright 2012 Analog Devices Inc.
   6  *   Author: Lars-Peter Clausen <[email protected]>
   7  */
   8
   9 #include <linux/delay.h>
  10 #include <linux/gpio/consumer.h>
  11 #include <linux/mutex.h>
  12 #include <linux/device.h>
  13 #include <linux/kernel.h>
  14 #include <linux/spi/spi.h>
  15 #include <linux/module.h>
  16 #include <asm/unaligned.h>
  17
  18 #include <linux/iio/iio.h>
  19 #include <linux/iio/imu/adis.h>
  20
  21 #define ADIS_MSC_CTRL_DATA_RDY_EN       BIT(2)
  22 #define ADIS_MSC_CTRL_DATA_RDY_POL_HIGH BIT(1)
  23 #define ADIS_MSC_CTRL_DATA_RDY_DIO2     BIT(0)
  24 #define ADIS_GLOB_CMD_SW_RESET          BIT(7)
  25
  26 /**
  27  * __adis_write_reg() - write N bytes to register (unlocked version)
  28  * @adis: The adis device
  29  * @reg: The address of the lower of the two registers
  30  * @value: The value to write to device (up to 4 bytes)
  31  * @size: The size of the @value (in bytes)
  32  */
  33 int __adis_write_reg(struct adis *adis, unsigned int reg,
  34         unsigned int value, unsigned int size)
  35 {
  36         unsigned int page = reg / ADIS_PAGE_SIZE;
  37         int ret, i;
  38         struct spi_message msg;
  39         struct spi_transfer xfers[] = {
  40                 {
  41                         .tx_buf = adis->tx,
  42                         .bits_per_word = 8,
  43                         .len = 2,
  44                         .cs_change = 1,
  45                         .delay.value = adis->data->write_delay,
  46                         .delay.unit = SPI_DELAY_UNIT_USECS,
  47                         .cs_change_delay.value = adis->data->cs_change_delay,
  48                         .cs_change_delay.unit = SPI_DELAY_UNIT_USECS,
  49                 }, {
  50                         .tx_buf = adis->tx + 2,
  51                         .bits_per_word = 8,
  52                         .len = 2,
  53                         .cs_change = 1,
  54                         .delay.value = adis->data->write_delay,
  55                         .delay.unit = SPI_DELAY_UNIT_USECS,
  56                         .cs_change_delay.value = adis->data->cs_change_delay,
  57                         .cs_change_delay.unit = SPI_DELAY_UNIT_USECS,
  58                 }, {
  59                         .tx_buf = adis->tx + 4,
  60                         .bits_per_word = 8,
  61                         .len = 2,
  62                         .cs_change = 1,
  63                         .delay.value = adis->data->write_delay,
  64                         .delay.unit = SPI_DELAY_UNIT_USECS,
  65                         .cs_change_delay.value = adis->data->cs_change_delay,
  66                         .cs_change_delay.unit = SPI_DELAY_UNIT_USECS,
  67                 }, {
  68                         .tx_buf = adis->tx + 6,
  69                         .bits_per_word = 8,
  70                         .len = 2,
  71                         .delay.value = adis->data->write_delay,
  72                         .delay.unit = SPI_DELAY_UNIT_USECS,
  73                 }, {
  74                         .tx_buf = adis->tx + 8,
  75                         .bits_per_word = 8,
  76                         .len = 2,
  77                         .delay.value = adis->data->write_delay,
  78                         .delay.unit = SPI_DELAY_UNIT_USECS,
  79                 },
  80         };
  81
  82         spi_message_init(&msg);
  83
  84         if (adis->current_page != page) {
  85                 adis->tx[0] = ADIS_WRITE_REG(ADIS_REG_PAGE_ID);
  86                 adis->tx[1] = page;
  87                 spi_message_add_tail(&xfers[0], &msg);
  88         }
  89
  90         switch (size) {
  91         case 4:
  92                 adis->tx[8] = ADIS_WRITE_REG(reg + 3);
  93                 adis->tx[9] = (value >> 24) & 0xff;
  94                 adis->tx[6] = ADIS_WRITE_REG(reg + 2);
  95                 adis->tx[7] = (value >> 16) & 0xff;
  96                 fallthrough;
  97         case 2:
  98                 adis->tx[4] = ADIS_WRITE_REG(reg + 1);
  99                 adis->tx[5] = (value >> 8) & 0xff;
 100                 fallthrough;
 101         case 1:
 102                 adis->tx[2] = ADIS_WRITE_REG(reg);
 103                 adis->tx[3] = value & 0xff;
 104                 break;
 105         default:
 106                 return -EINVAL;
 107         }
 108
 109         xfers[size].cs_change = 0;
 110
 111         for (i = 1; i <= size; i++)
 112                 spi_message_add_tail(&xfers[i], &msg);
 113
 114         ret = spi_sync(adis->spi, &msg);
 115         if (ret) {
 116                 dev_err(&adis->spi->dev, "Failed to write register 0x%02X: %d\n",
 117                                 reg, ret);
 118         } else {
 119                 adis->current_page = page;
 120         }
 121
 122         return ret;
 123 }
 124 EXPORT_SYMBOL_GPL(__adis_write_reg);
 125
 126 /**
 127  * __adis_read_reg() - read N bytes from register (unlocked version)
 128  * @adis: The adis device
 129  * @reg: The address of the lower of the two registers
 130  * @val: The value read back from the device
 131  * @size: The size of the @val buffer
 132  */
 133 int __adis_read_reg(struct adis *adis, unsigned int reg,
 134         unsigned int *val, unsigned int size)
 135 {
 136         unsigned int page = reg / ADIS_PAGE_SIZE;
 137         struct spi_message msg;
 138         int ret;
 139         struct spi_transfer xfers[] = {
 140                 {
 141                         .tx_buf = adis->tx,
 142                         .bits_per_word = 8,
 143                         .len = 2,
 144                         .cs_change = 1,
 145                         .delay.value = adis->data->write_delay,
 146                         .delay.unit = SPI_DELAY_UNIT_USECS,
 147                         .cs_change_delay.value = adis->data->cs_change_delay,
 148                         .cs_change_delay.unit = SPI_DELAY_UNIT_USECS,
 149                 }, {
 150                         .tx_buf = adis->tx + 2,
 151                         .bits_per_word = 8,
 152                         .len = 2,
 153                         .cs_change = 1,
 154                         .delay.value = adis->data->read_delay,
 155                         .delay.unit = SPI_DELAY_UNIT_USECS,
 156                         .cs_change_delay.value = adis->data->cs_change_delay,
 157                         .cs_change_delay.unit = SPI_DELAY_UNIT_USECS,
 158                 }, {
 159                         .tx_buf = adis->tx + 4,
 160                         .rx_buf = adis->rx,
 161                         .bits_per_word = 8,
 162                         .len = 2,
 163                         .cs_change = 1,
 164                         .delay.value = adis->data->read_delay,
 165                         .delay.unit = SPI_DELAY_UNIT_USECS,
 166                         .cs_change_delay.value = adis->data->cs_change_delay,
 167                         .cs_change_delay.unit = SPI_DELAY_UNIT_USECS,
 168                 }, {
 169                         .rx_buf = adis->rx + 2,
 170                         .bits_per_word = 8,
 171                         .len = 2,
 172                         .delay.value = adis->data->read_delay,
 173                         .delay.unit = SPI_DELAY_UNIT_USECS,
 174                 },
 175         };
 176
 177         spi_message_init(&msg);
 178
 179         if (adis->current_page != page) {
 180                 adis->tx[0] = ADIS_WRITE_REG(ADIS_REG_PAGE_ID);
 181                 adis->tx[1] = page;
 182                 spi_message_add_tail(&xfers[0], &msg);
 183         }
 184
 185         switch (size) {
 186         case 4:
 187                 adis->tx[2] = ADIS_READ_REG(reg + 2);
 188                 adis->tx[3] = 0;
 189                 spi_message_add_tail(&xfers[1], &msg);
 190                 fallthrough;
 191         case 2:
 192                 adis->tx[4] = ADIS_READ_REG(reg);
 193                 adis->tx[5] = 0;
 194                 spi_message_add_tail(&xfers[2], &msg);
 195                 spi_message_add_tail(&xfers[3], &msg);
 196                 break;
 197         default:
 198                 return -EINVAL;
 199         }
 200
 201         ret = spi_sync(adis->spi, &msg);
 202         if (ret) {
 203                 dev_err(&adis->spi->dev, "Failed to read register 0x%02X: %d\n",
 204                                 reg, ret);
 205                 return ret;
 206         } else {
 207                 adis->current_page = page;
 208         }
 209
 210         switch (size) {
 211         case 4:
 212                 *val = get_unaligned_be32(adis->rx);
 213                 break;
 214         case 2:
 215                 *val = get_unaligned_be16(adis->rx + 2);
 216                 break;
 217         }
 218
 219         return ret;
 220 }
 221 EXPORT_SYMBOL_GPL(__adis_read_reg);
 222 /**
 223  * __adis_update_bits_base() - ADIS Update bits function - Unlocked version
 224  * @adis: The adis device
 225  * @reg: The address of the lower of the two registers
 226  * @mask: Bitmask to change
 227  * @val: Value to be written
 228  * @size: Size of the register to update
 229  *
 230  * Updates the desired bits of @reg in accordance with @mask and @val.
 231  */
 232 int __adis_update_bits_base(struct adis *adis, unsigned int reg, const u32 mask,
 233                             const u32 val, u8 size)
 234 {
 235         int ret;
 236         u32 __val;
 237
 238         ret = __adis_read_reg(adis, reg, &__val, size);
 239         if (ret)
 240                 return ret;
 241
 242         __val = (__val & ~mask) | (val & mask);
 243
 244         return __adis_write_reg(adis, reg, __val, size);
 245 }
 246 EXPORT_SYMBOL_GPL(__adis_update_bits_base);
 247
 248 #ifdef CONFIG_DEBUG_FS
 249
 250 int adis_debugfs_reg_access(struct iio_dev *indio_dev,
 251         unsigned int reg, unsigned int writeval, unsigned int *readval)
 252 {
 253         struct adis *adis = iio_device_get_drvdata(indio_dev);
 254
 255         if (readval) {
 256                 uint16_t val16;
 257                 int ret;
 258
 259                 ret = adis_read_reg_16(adis, reg, &val16);
 260                 if (ret == 0)
 261                         *readval = val16;
 262
 263                 return ret;
 264         } else {
 265                 return adis_write_reg_16(adis, reg, writeval);
 266         }
 267 }
 268 EXPORT_SYMBOL(adis_debugfs_reg_access);
 269
 270 #endif
 271
 272 /**
 273  * adis_enable_irq() - Enable or disable data ready IRQ
 274  * @adis: The adis device
 275  * @enable: Whether to enable the IRQ
 276  *
 277  * Returns 0 on success, negative error code otherwise
 278  */
 279 int adis_enable_irq(struct adis *adis, bool enable)
 280 {
 281         int ret = 0;
 282         uint16_t msc;
 283
 284         mutex_lock(&adis->state_lock);
 285
 286         if (adis->data->enable_irq) {
 287                 ret = adis->data->enable_irq(adis, enable);
 288                 goto out_unlock;
 289         } else if (adis->data->unmasked_drdy) {
 290                 if (enable)
 291                         enable_irq(adis->spi->irq);
 292                 else
 293                         disable_irq(adis->spi->irq);
 294
 295                 goto out_unlock;
 296         }
 297
 298         ret = __adis_read_reg_16(adis, adis->data->msc_ctrl_reg, &msc);
 299         if (ret)
 300                 goto out_unlock;
 301
 302         msc |= ADIS_MSC_CTRL_DATA_RDY_POL_HIGH;
 303         msc &= ~ADIS_MSC_CTRL_DATA_RDY_DIO2;
 304         if (enable)
 305                 msc |= ADIS_MSC_CTRL_DATA_RDY_EN;
 306         else
 307                 msc &= ~ADIS_MSC_CTRL_DATA_RDY_EN;
 308
 309         ret = __adis_write_reg_16(adis, adis->data->msc_ctrl_reg, msc);
 310
 311 out_unlock:
 312         mutex_unlock(&adis->state_lock);
 313         return ret;
 314 }
 315 EXPORT_SYMBOL(adis_enable_irq);
 316
 317 /**
 318  * __adis_check_status() - Check the device for error conditions (unlocked)
 319  * @adis: The adis device
 320  *
 321  * Returns 0 on success, a negative error code otherwise
 322  */
 323 int __adis_check_status(struct adis *adis)
 324 {
 325         uint16_t status;
 326         int ret;
 327         int i;
 328
 329         ret = __adis_read_reg_16(adis, adis->data->diag_stat_reg, &status);
 330         if (ret)
 331                 return ret;
 332
 333         status &= adis->data->status_error_mask;
 334
 335         if (status == 0)
 336                 return 0;
 337
 338         for (i = 0; i < 16; ++i) {
 339                 if (status & BIT(i)) {
 340                         dev_err(&adis->spi->dev, "%s.\n",
 341                                 adis->data->status_error_msgs[i]);
 342                 }
 343         }
 344
 345         return -EIO;
 346 }
 347 EXPORT_SYMBOL_GPL(__adis_check_status);
 348
 349 /**
 350  * __adis_reset() - Reset the device (unlocked version)
 351  * @adis: The adis device
 352  *
 353  * Returns 0 on success, a negative error code otherwise
 354  */
 355 int __adis_reset(struct adis *adis)
 356 {
 357         int ret;
 358         const struct adis_timeout *timeouts = adis->data->timeouts;
 359
 360         ret = __adis_write_reg_8(adis, adis->data->glob_cmd_reg,
 361                         ADIS_GLOB_CMD_SW_RESET);
 362         if (ret) {
 363                 dev_err(&adis->spi->dev, "Failed to reset device: %d\n", ret);
 364                 return ret;
 365         }
 366
 367         msleep(timeouts->sw_reset_ms);
 368
 369         return 0;
 370 }
 371 EXPORT_SYMBOL_GPL(__adis_reset);
 372
 373 static int adis_self_test(struct adis *adis)
 374 {
 375         int ret;
 376         const struct adis_timeout *timeouts = adis->data->timeouts;
 377
 378         ret = __adis_write_reg_16(adis, adis->data->self_test_reg,
 379                                   adis->data->self_test_mask);
 380         if (ret) {
 381                 dev_err(&adis->spi->dev, "Failed to initiate self test: %d\n",
 382                         ret);
 383                 return ret;
 384         }
 385
 386         msleep(timeouts->self_test_ms);
 387
 388         ret = __adis_check_status(adis);
 389
 390         if (adis->data->self_test_no_autoclear)
 391                 __adis_write_reg_16(adis, adis->data->self_test_reg, 0x00);
 392
 393         return ret;
 394 }
 395
 396 /**
 397  * __adis_initial_startup() - Device initial setup
 398  * @adis: The adis device
 399  *
 400  * The function performs a HW reset via a reset pin that should be specified
 401  * via GPIOLIB. If no pin is configured a SW reset will be performed.
 402  * The RST pin for the ADIS devices should be configured as ACTIVE_LOW.
 403  *
 404  * After the self-test operation is performed, the function will also check
 405  * that the product ID is as expected. This assumes that drivers providing
 406  * 'prod_id_reg' will also provide the 'prod_id'.
 407  *
 408  * Returns 0 if the device is operational, a negative error code otherwise.
 409  *
 410  * This function should be called early on in the device initialization sequence
 411  * to ensure that the device is in a sane and known state and that it is usable.
 412  */
 413 int __adis_initial_startup(struct adis *adis)
 414 {
 415         const struct adis_timeout *timeouts = adis->data->timeouts;
 416         struct gpio_desc *gpio;
 417         uint16_t prod_id;
 418         int ret;
 419
 420         /* check if the device has rst pin low */
 421         gpio = devm_gpiod_get_optional(&adis->spi->dev, "reset", GPIOD_OUT_HIGH);
 422         if (IS_ERR(gpio))
 423                 return PTR_ERR(gpio);
 424
 425         if (gpio) {
 426                 msleep(10);
 427                 /* bring device out of reset */
 428                 gpiod_set_value_cansleep(gpio, 0);
 429                 msleep(timeouts->reset_ms);
 430         } else {
 431                 ret = __adis_reset(adis);
 432                 if (ret)
 433                         return ret;
 434         }
 435
 436         ret = adis_self_test(adis);
 437         if (ret)
 438                 return ret;
 439
 440         /*
 441          * don't bother calling this if we can't unmask the IRQ as in this case
 442          * the IRQ is most likely not yet requested and we will request it
 443          * with 'IRQF_NO_AUTOEN' anyways.
 444          */
 445         if (!adis->data->unmasked_drdy)
 446                 adis_enable_irq(adis, false);
 447
 448         if (!adis->data->prod_id_reg)
 449                 return 0;
 450
 451         ret = adis_read_reg_16(adis, adis->data->prod_id_reg, &prod_id);
 452         if (ret)
 453                 return ret;
 454
 455         if (prod_id != adis->data->prod_id)
 456                 dev_warn(&adis->spi->dev,
 457                          "Device ID(%u) and product ID(%u) do not match.\n",
 458                          adis->data->prod_id, prod_id);
 459
 460         return 0;
 461 }
 462 EXPORT_SYMBOL_GPL(__adis_initial_startup);
 463
 464 /**
 465  * adis_single_conversion() - Performs a single sample conversion
 466  * @indio_dev: The IIO device
 467  * @chan: The IIO channel
 468  * @error_mask: Mask for the error bit
 469  * @val: Result of the conversion
 470  *
 471  * Returns IIO_VAL_INT on success, a negative error code otherwise.
 472  *
 473  * The function performs a single conversion on a given channel and post
 474  * processes the value accordingly to the channel spec. If a error_mask is given
 475  * the function will check if the mask is set in the returned raw value. If it
 476  * is set the function will perform a self-check. If the device does not report
 477  * a error bit in the channels raw value set error_mask to 0.
 478  */
 479 int adis_single_conversion(struct iio_dev *indio_dev,
 480         const struct iio_chan_spec *chan, unsigned int error_mask, int *val)
 481 {
 482         struct adis *adis = iio_device_get_drvdata(indio_dev);
 483         unsigned int uval;
 484         int ret;
 485
 486         mutex_lock(&adis->state_lock);
 487
 488         ret = __adis_read_reg(adis, chan->address, &uval,
 489                         chan->scan_type.storagebits / 8);
 490         if (ret)
 491                 goto err_unlock;
 492
 493         if (uval & error_mask) {
 494                 ret = __adis_check_status(adis);
 495                 if (ret)
 496                         goto err_unlock;
 497         }
 498
 499         if (chan->scan_type.sign == 's')
 500                 *val = sign_extend32(uval, chan->scan_type.realbits - 1);
 501         else
 502                 *val = uval & ((1 << chan->scan_type.realbits) - 1);
 503
 504         ret = IIO_VAL_INT;
 505 err_unlock:
 506         mutex_unlock(&adis->state_lock);
 507         return ret;
 508 }
 509 EXPORT_SYMBOL_GPL(adis_single_conversion);
 510
 511 /**
 512  * adis_init() - Initialize adis device structure
 513  * @adis:       The adis device
 514  * @indio_dev:  The iio device
 515  * @spi:        The spi device
 516  * @data:       Chip specific data
 517  *
 518  * Returns 0 on success, a negative error code otherwise.
 519  *
 520  * This function must be called, before any other adis helper function may be
 521  * called.
 522  */
 523 int adis_init(struct adis *adis, struct iio_dev *indio_dev,
 524         struct spi_device *spi, const struct adis_data *data)
 525 {
 526         if (!data || !data->timeouts) {
 527                 dev_err(&spi->dev, "No config data or timeouts not defined!\n");
 528                 return -EINVAL;
 529         }
 530
 531         mutex_init(&adis->state_lock);
 532         adis->spi = spi;
 533         adis->data = data;
 534         iio_device_set_drvdata(indio_dev, adis);
 535
 536         if (data->has_paging) {
 537                 /* Need to set the page before first read/write */
 538                 adis->current_page = -1;
 539         } else {
 540                 /* Page will always be 0 */
 541                 adis->current_page = 0;
 542         }
 543
 544         return 0;
 545 }
 546 EXPORT_SYMBOL_GPL(adis_init);
 547
 548 MODULE_LICENSE("GPL");
 549 MODULE_AUTHOR("Lars-Peter Clausen <[email protected]>");
 550 MODULE_DESCRIPTION("Common library code for ADIS16XXX devices");