2 * ad2s1210.c support for the ADI Resolver to Digital Converters: AD2S1210
4 * Copyright (c) 2010-2010 Analog Devices Inc.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
11 #include <linux/types.h>
12 #include <linux/mutex.h>
13 #include <linux/device.h>
14 #include <linux/spi/spi.h>
15 #include <linux/slab.h>
16 #include <linux/sysfs.h>
17 #include <linux/delay.h>
18 #include <linux/gpio.h>
19 #include <linux/module.h>
21 #include <linux/iio/iio.h>
22 #include <linux/iio/sysfs.h>
25 #define DRV_NAME "ad2s1210"
27 #define AD2S1210_DEF_CONTROL 0x7E
29 #define AD2S1210_MSB_IS_HIGH 0x80
30 #define AD2S1210_MSB_IS_LOW 0x7F
31 #define AD2S1210_PHASE_LOCK_RANGE_44 0x20
32 #define AD2S1210_ENABLE_HYSTERESIS 0x10
33 #define AD2S1210_SET_ENRES1 0x08
34 #define AD2S1210_SET_ENRES0 0x04
35 #define AD2S1210_SET_RES1 0x02
36 #define AD2S1210_SET_RES0 0x01
38 #define AD2S1210_SET_ENRESOLUTION (AD2S1210_SET_ENRES1 | \
40 #define AD2S1210_SET_RESOLUTION (AD2S1210_SET_RES1 | AD2S1210_SET_RES0)
42 #define AD2S1210_REG_POSITION 0x80
43 #define AD2S1210_REG_VELOCITY 0x82
44 #define AD2S1210_REG_LOS_THRD 0x88
45 #define AD2S1210_REG_DOS_OVR_THRD 0x89
46 #define AD2S1210_REG_DOS_MIS_THRD 0x8A
47 #define AD2S1210_REG_DOS_RST_MAX_THRD 0x8B
48 #define AD2S1210_REG_DOS_RST_MIN_THRD 0x8C
49 #define AD2S1210_REG_LOT_HIGH_THRD 0x8D
50 #define AD2S1210_REG_LOT_LOW_THRD 0x8E
51 #define AD2S1210_REG_EXCIT_FREQ 0x91
52 #define AD2S1210_REG_CONTROL 0x92
53 #define AD2S1210_REG_SOFT_RESET 0xF0
54 #define AD2S1210_REG_FAULT 0xFF
56 /* pin SAMPLE, A0, A1, RES0, RES1, is controlled by driver */
57 #define AD2S1210_SAA 3
58 #define AD2S1210_PN (AD2S1210_SAA + AD2S1210_RES)
60 #define AD2S1210_MIN_CLKIN 6144000
61 #define AD2S1210_MAX_CLKIN 10240000
62 #define AD2S1210_MIN_EXCIT 2000
63 #define AD2S1210_MAX_EXCIT 20000
64 #define AD2S1210_MIN_FCW 0x4
65 #define AD2S1210_MAX_FCW 0x50
67 /* default input clock on serial interface */
68 #define AD2S1210_DEF_CLKIN 8192000
69 /* clock period in nano second */
70 #define AD2S1210_DEF_TCK (1000000000/AD2S1210_DEF_CLKIN)
71 #define AD2S1210_DEF_EXCIT 10000
80 static const unsigned int ad2s1210_resolution_value[] = { 10, 12, 14, 16 };
82 struct ad2s1210_state {
83 const struct ad2s1210_platform_data *pdata;
85 struct spi_device *sdev;
91 enum ad2s1210_mode mode;
92 u8 rx[2] ____cacheline_aligned;
93 u8 tx[2] ____cacheline_aligned;
96 static const int ad2s1210_mode_vals[4][2] = {
99 [MOD_CONFIG] = { 1, 0 },
101 static inline void ad2s1210_set_mode(enum ad2s1210_mode mode,
102 struct ad2s1210_state *st)
104 gpio_set_value(st->pdata->a[0], ad2s1210_mode_vals[mode][0]);
105 gpio_set_value(st->pdata->a[1], ad2s1210_mode_vals[mode][1]);
109 /* write 1 bytes (address or data) to the chip */
110 static int ad2s1210_config_write(struct ad2s1210_state *st, u8 data)
114 ad2s1210_set_mode(MOD_CONFIG, st);
116 ret = spi_write(st->sdev, st->tx, 1);
124 /* read value from one of the registers */
125 static int ad2s1210_config_read(struct ad2s1210_state *st,
126 unsigned char address)
128 struct spi_transfer xfer = {
135 ad2s1210_set_mode(MOD_CONFIG, st);
136 st->tx[0] = address | AD2S1210_MSB_IS_HIGH;
137 st->tx[1] = AD2S1210_REG_FAULT;
138 ret = spi_sync_transfer(st->sdev, &xfer, 1);
147 int ad2s1210_update_frequency_control_word(struct ad2s1210_state *st)
152 fcw = (unsigned char)(st->fexcit * (1 << 15) / st->fclkin);
153 if (fcw < AD2S1210_MIN_FCW || fcw > AD2S1210_MAX_FCW) {
154 pr_err("ad2s1210: FCW out of range\n");
158 ret = ad2s1210_config_write(st, AD2S1210_REG_EXCIT_FREQ);
162 return ad2s1210_config_write(st, fcw);
165 static unsigned char ad2s1210_read_resolution_pin(struct ad2s1210_state *st)
167 return ad2s1210_resolution_value[
168 (gpio_get_value(st->pdata->res[0]) << 1) |
169 gpio_get_value(st->pdata->res[1])];
172 static const int ad2s1210_res_pins[4][2] = {
173 { 0, 0 }, {0, 1}, {1, 0}, {1, 1}
176 static inline void ad2s1210_set_resolution_pin(struct ad2s1210_state *st)
178 gpio_set_value(st->pdata->res[0],
179 ad2s1210_res_pins[(st->resolution - 10)/2][0]);
180 gpio_set_value(st->pdata->res[1],
181 ad2s1210_res_pins[(st->resolution - 10)/2][1]);
184 static inline int ad2s1210_soft_reset(struct ad2s1210_state *st)
188 ret = ad2s1210_config_write(st, AD2S1210_REG_SOFT_RESET);
192 return ad2s1210_config_write(st, 0x0);
195 static ssize_t ad2s1210_show_fclkin(struct device *dev,
196 struct device_attribute *attr,
199 struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
201 return sprintf(buf, "%d\n", st->fclkin);
204 static ssize_t ad2s1210_store_fclkin(struct device *dev,
205 struct device_attribute *attr,
209 struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
213 ret = kstrtouint(buf, 10, &fclkin);
216 if (fclkin < AD2S1210_MIN_CLKIN || fclkin > AD2S1210_MAX_CLKIN) {
217 pr_err("ad2s1210: fclkin out of range\n");
221 mutex_lock(&st->lock);
224 ret = ad2s1210_update_frequency_control_word(st);
227 ret = ad2s1210_soft_reset(st);
229 mutex_unlock(&st->lock);
231 return ret < 0 ? ret : len;
234 static ssize_t ad2s1210_show_fexcit(struct device *dev,
235 struct device_attribute *attr,
238 struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
240 return sprintf(buf, "%d\n", st->fexcit);
243 static ssize_t ad2s1210_store_fexcit(struct device *dev,
244 struct device_attribute *attr,
245 const char *buf, size_t len)
247 struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
251 ret = kstrtouint(buf, 10, &fexcit);
254 if (fexcit < AD2S1210_MIN_EXCIT || fexcit > AD2S1210_MAX_EXCIT) {
255 pr_err("ad2s1210: excitation frequency out of range\n");
258 mutex_lock(&st->lock);
260 ret = ad2s1210_update_frequency_control_word(st);
263 ret = ad2s1210_soft_reset(st);
265 mutex_unlock(&st->lock);
267 return ret < 0 ? ret : len;
270 static ssize_t ad2s1210_show_control(struct device *dev,
271 struct device_attribute *attr,
274 struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
277 mutex_lock(&st->lock);
278 ret = ad2s1210_config_read(st, AD2S1210_REG_CONTROL);
279 mutex_unlock(&st->lock);
280 return ret < 0 ? ret : sprintf(buf, "0x%x\n", ret);
283 static ssize_t ad2s1210_store_control(struct device *dev,
284 struct device_attribute *attr,
285 const char *buf, size_t len)
287 struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
292 ret = kstrtou8(buf, 16, &udata);
296 mutex_lock(&st->lock);
297 ret = ad2s1210_config_write(st, AD2S1210_REG_CONTROL);
300 data = udata & AD2S1210_MSB_IS_LOW;
301 ret = ad2s1210_config_write(st, data);
305 ret = ad2s1210_config_read(st, AD2S1210_REG_CONTROL);
308 if (ret & AD2S1210_MSB_IS_HIGH) {
310 pr_err("ad2s1210: write control register fail\n");
314 = ad2s1210_resolution_value[data & AD2S1210_SET_RESOLUTION];
315 if (st->pdata->gpioin) {
316 data = ad2s1210_read_resolution_pin(st);
317 if (data != st->resolution)
318 pr_warn("ad2s1210: resolution settings not match\n");
320 ad2s1210_set_resolution_pin(st);
323 st->hysteresis = !!(data & AD2S1210_ENABLE_HYSTERESIS);
326 mutex_unlock(&st->lock);
330 static ssize_t ad2s1210_show_resolution(struct device *dev,
331 struct device_attribute *attr, char *buf)
333 struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
335 return sprintf(buf, "%d\n", st->resolution);
338 static ssize_t ad2s1210_store_resolution(struct device *dev,
339 struct device_attribute *attr,
340 const char *buf, size_t len)
342 struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
347 ret = kstrtou8(buf, 10, &udata);
348 if (ret || udata < 10 || udata > 16) {
349 pr_err("ad2s1210: resolution out of range\n");
352 mutex_lock(&st->lock);
353 ret = ad2s1210_config_read(st, AD2S1210_REG_CONTROL);
357 data &= ~AD2S1210_SET_RESOLUTION;
358 data |= (udata - 10) >> 1;
359 ret = ad2s1210_config_write(st, AD2S1210_REG_CONTROL);
362 ret = ad2s1210_config_write(st, data & AD2S1210_MSB_IS_LOW);
365 ret = ad2s1210_config_read(st, AD2S1210_REG_CONTROL);
369 if (data & AD2S1210_MSB_IS_HIGH) {
371 pr_err("ad2s1210: setting resolution fail\n");
375 = ad2s1210_resolution_value[data & AD2S1210_SET_RESOLUTION];
376 if (st->pdata->gpioin) {
377 data = ad2s1210_read_resolution_pin(st);
378 if (data != st->resolution)
379 pr_warn("ad2s1210: resolution settings not match\n");
381 ad2s1210_set_resolution_pin(st);
384 mutex_unlock(&st->lock);
388 /* read the fault register since last sample */
389 static ssize_t ad2s1210_show_fault(struct device *dev,
390 struct device_attribute *attr, char *buf)
392 struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
395 mutex_lock(&st->lock);
396 ret = ad2s1210_config_read(st, AD2S1210_REG_FAULT);
397 mutex_unlock(&st->lock);
399 return ret ? ret : sprintf(buf, "0x%x\n", ret);
402 static ssize_t ad2s1210_clear_fault(struct device *dev,
403 struct device_attribute *attr,
407 struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
410 mutex_lock(&st->lock);
411 gpio_set_value(st->pdata->sample, 0);
412 /* delay (2 * tck + 20) nano seconds */
414 gpio_set_value(st->pdata->sample, 1);
415 ret = ad2s1210_config_read(st, AD2S1210_REG_FAULT);
418 gpio_set_value(st->pdata->sample, 0);
419 gpio_set_value(st->pdata->sample, 1);
421 mutex_unlock(&st->lock);
423 return ret < 0 ? ret : len;
426 static ssize_t ad2s1210_show_reg(struct device *dev,
427 struct device_attribute *attr,
430 struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
431 struct iio_dev_attr *iattr = to_iio_dev_attr(attr);
434 mutex_lock(&st->lock);
435 ret = ad2s1210_config_read(st, iattr->address);
436 mutex_unlock(&st->lock);
438 return ret < 0 ? ret : sprintf(buf, "%d\n", ret);
441 static ssize_t ad2s1210_store_reg(struct device *dev,
442 struct device_attribute *attr, const char *buf, size_t len)
444 struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
447 struct iio_dev_attr *iattr = to_iio_dev_attr(attr);
449 ret = kstrtou8(buf, 10, &data);
452 mutex_lock(&st->lock);
453 ret = ad2s1210_config_write(st, iattr->address);
456 ret = ad2s1210_config_write(st, data & AD2S1210_MSB_IS_LOW);
458 mutex_unlock(&st->lock);
459 return ret < 0 ? ret : len;
462 static int ad2s1210_read_raw(struct iio_dev *indio_dev,
463 struct iio_chan_spec const *chan,
468 struct ad2s1210_state *st = iio_priv(indio_dev);
474 mutex_lock(&st->lock);
475 gpio_set_value(st->pdata->sample, 0);
476 /* delay (6 * tck + 20) nano seconds */
479 switch (chan->type) {
481 ad2s1210_set_mode(MOD_POS, st);
484 ad2s1210_set_mode(MOD_VEL, st);
492 ret = spi_read(st->sdev, st->rx, 2);
496 switch (chan->type) {
498 pos = be16_to_cpup((__be16 *) st->rx);
500 pos >>= 16 - st->resolution;
505 negative = st->rx[0] & 0x80;
506 vel = be16_to_cpup((__be16 *) st->rx);
507 vel >>= 16 - st->resolution;
509 negative = (0xffff >> st->resolution) << st->resolution;
516 mutex_unlock(&st->lock);
521 gpio_set_value(st->pdata->sample, 1);
522 /* delay (2 * tck + 20) nano seconds */
524 mutex_unlock(&st->lock);
528 static IIO_DEVICE_ATTR(fclkin, S_IRUGO | S_IWUSR,
529 ad2s1210_show_fclkin, ad2s1210_store_fclkin, 0);
530 static IIO_DEVICE_ATTR(fexcit, S_IRUGO | S_IWUSR,
531 ad2s1210_show_fexcit, ad2s1210_store_fexcit, 0);
532 static IIO_DEVICE_ATTR(control, S_IRUGO | S_IWUSR,
533 ad2s1210_show_control, ad2s1210_store_control, 0);
534 static IIO_DEVICE_ATTR(bits, S_IRUGO | S_IWUSR,
535 ad2s1210_show_resolution, ad2s1210_store_resolution, 0);
536 static IIO_DEVICE_ATTR(fault, S_IRUGO | S_IWUSR,
537 ad2s1210_show_fault, ad2s1210_clear_fault, 0);
539 static IIO_DEVICE_ATTR(los_thrd, S_IRUGO | S_IWUSR,
540 ad2s1210_show_reg, ad2s1210_store_reg,
541 AD2S1210_REG_LOS_THRD);
542 static IIO_DEVICE_ATTR(dos_ovr_thrd, S_IRUGO | S_IWUSR,
543 ad2s1210_show_reg, ad2s1210_store_reg,
544 AD2S1210_REG_DOS_OVR_THRD);
545 static IIO_DEVICE_ATTR(dos_mis_thrd, S_IRUGO | S_IWUSR,
546 ad2s1210_show_reg, ad2s1210_store_reg,
547 AD2S1210_REG_DOS_MIS_THRD);
548 static IIO_DEVICE_ATTR(dos_rst_max_thrd, S_IRUGO | S_IWUSR,
549 ad2s1210_show_reg, ad2s1210_store_reg,
550 AD2S1210_REG_DOS_RST_MAX_THRD);
551 static IIO_DEVICE_ATTR(dos_rst_min_thrd, S_IRUGO | S_IWUSR,
552 ad2s1210_show_reg, ad2s1210_store_reg,
553 AD2S1210_REG_DOS_RST_MIN_THRD);
554 static IIO_DEVICE_ATTR(lot_high_thrd, S_IRUGO | S_IWUSR,
555 ad2s1210_show_reg, ad2s1210_store_reg,
556 AD2S1210_REG_LOT_HIGH_THRD);
557 static IIO_DEVICE_ATTR(lot_low_thrd, S_IRUGO | S_IWUSR,
558 ad2s1210_show_reg, ad2s1210_store_reg,
559 AD2S1210_REG_LOT_LOW_THRD);
562 static const struct iio_chan_spec ad2s1210_channels[] = {
567 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
569 .type = IIO_ANGL_VEL,
572 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
576 static struct attribute *ad2s1210_attributes[] = {
577 &iio_dev_attr_fclkin.dev_attr.attr,
578 &iio_dev_attr_fexcit.dev_attr.attr,
579 &iio_dev_attr_control.dev_attr.attr,
580 &iio_dev_attr_bits.dev_attr.attr,
581 &iio_dev_attr_fault.dev_attr.attr,
582 &iio_dev_attr_los_thrd.dev_attr.attr,
583 &iio_dev_attr_dos_ovr_thrd.dev_attr.attr,
584 &iio_dev_attr_dos_mis_thrd.dev_attr.attr,
585 &iio_dev_attr_dos_rst_max_thrd.dev_attr.attr,
586 &iio_dev_attr_dos_rst_min_thrd.dev_attr.attr,
587 &iio_dev_attr_lot_high_thrd.dev_attr.attr,
588 &iio_dev_attr_lot_low_thrd.dev_attr.attr,
592 static const struct attribute_group ad2s1210_attribute_group = {
593 .attrs = ad2s1210_attributes,
596 static int ad2s1210_initial(struct ad2s1210_state *st)
601 mutex_lock(&st->lock);
602 if (st->pdata->gpioin)
603 st->resolution = ad2s1210_read_resolution_pin(st);
605 ad2s1210_set_resolution_pin(st);
607 ret = ad2s1210_config_write(st, AD2S1210_REG_CONTROL);
610 data = AD2S1210_DEF_CONTROL & ~(AD2S1210_SET_RESOLUTION);
611 data |= (st->resolution - 10) >> 1;
612 ret = ad2s1210_config_write(st, data);
615 ret = ad2s1210_config_read(st, AD2S1210_REG_CONTROL);
619 if (ret & AD2S1210_MSB_IS_HIGH) {
624 ret = ad2s1210_update_frequency_control_word(st);
627 ret = ad2s1210_soft_reset(st);
629 mutex_unlock(&st->lock);
633 static const struct iio_info ad2s1210_info = {
634 .read_raw = &ad2s1210_read_raw,
635 .attrs = &ad2s1210_attribute_group,
636 .driver_module = THIS_MODULE,
639 static int ad2s1210_setup_gpios(struct ad2s1210_state *st)
641 unsigned long flags = st->pdata->gpioin ? GPIOF_DIR_IN : GPIOF_DIR_OUT;
642 struct gpio ad2s1210_gpios[] = {
643 { st->pdata->sample, GPIOF_DIR_IN, "sample" },
644 { st->pdata->a[0], flags, "a0" },
645 { st->pdata->a[1], flags, "a1" },
646 { st->pdata->res[0], flags, "res0" },
647 { st->pdata->res[0], flags, "res1" },
650 return gpio_request_array(ad2s1210_gpios, ARRAY_SIZE(ad2s1210_gpios));
653 static void ad2s1210_free_gpios(struct ad2s1210_state *st)
655 unsigned long flags = st->pdata->gpioin ? GPIOF_DIR_IN : GPIOF_DIR_OUT;
656 struct gpio ad2s1210_gpios[] = {
657 { st->pdata->sample, GPIOF_DIR_IN, "sample" },
658 { st->pdata->a[0], flags, "a0" },
659 { st->pdata->a[1], flags, "a1" },
660 { st->pdata->res[0], flags, "res0" },
661 { st->pdata->res[0], flags, "res1" },
664 gpio_free_array(ad2s1210_gpios, ARRAY_SIZE(ad2s1210_gpios));
667 static int ad2s1210_probe(struct spi_device *spi)
669 struct iio_dev *indio_dev;
670 struct ad2s1210_state *st;
673 if (spi->dev.platform_data == NULL)
676 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
679 st = iio_priv(indio_dev);
680 st->pdata = spi->dev.platform_data;
681 ret = ad2s1210_setup_gpios(st);
685 spi_set_drvdata(spi, indio_dev);
687 mutex_init(&st->lock);
689 st->hysteresis = true;
690 st->mode = MOD_CONFIG;
692 st->fexcit = AD2S1210_DEF_EXCIT;
694 indio_dev->dev.parent = &spi->dev;
695 indio_dev->info = &ad2s1210_info;
696 indio_dev->modes = INDIO_DIRECT_MODE;
697 indio_dev->channels = ad2s1210_channels;
698 indio_dev->num_channels = ARRAY_SIZE(ad2s1210_channels);
699 indio_dev->name = spi_get_device_id(spi)->name;
701 ret = iio_device_register(indio_dev);
703 goto error_free_gpios;
705 st->fclkin = spi->max_speed_hz;
706 spi->mode = SPI_MODE_3;
708 ad2s1210_initial(st);
713 ad2s1210_free_gpios(st);
717 static int ad2s1210_remove(struct spi_device *spi)
719 struct iio_dev *indio_dev = spi_get_drvdata(spi);
721 iio_device_unregister(indio_dev);
722 ad2s1210_free_gpios(iio_priv(indio_dev));
727 static const struct spi_device_id ad2s1210_id[] = {
731 MODULE_DEVICE_TABLE(spi, ad2s1210_id);
733 static struct spi_driver ad2s1210_driver = {
736 .owner = THIS_MODULE,
738 .probe = ad2s1210_probe,
739 .remove = ad2s1210_remove,
740 .id_table = ad2s1210_id,
742 module_spi_driver(ad2s1210_driver);
745 MODULE_DESCRIPTION("Analog Devices AD2S1210 Resolver to Digital SPI driver");
746 MODULE_LICENSE("GPL v2");