2 * Analog devices AD5360, AD5361, AD5362, AD5363, AD5370, AD5371, AD5373
3 * multi-channel Digital to Analog Converters driver
5 * Copyright 2011 Analog Devices Inc.
7 * Licensed under the GPL-2.
10 #include <linux/device.h>
11 #include <linux/err.h>
12 #include <linux/module.h>
13 #include <linux/kernel.h>
14 #include <linux/spi/spi.h>
15 #include <linux/slab.h>
16 #include <linux/sysfs.h>
17 #include <linux/regulator/consumer.h>
19 #include <linux/iio/iio.h>
20 #include <linux/iio/sysfs.h>
22 #define AD5360_CMD(x) ((x) << 22)
23 #define AD5360_ADDR(x) ((x) << 16)
25 #define AD5360_READBACK_TYPE(x) ((x) << 13)
26 #define AD5360_READBACK_ADDR(x) ((x) << 7)
28 #define AD5360_CHAN_ADDR(chan) ((chan) + 0x8)
30 #define AD5360_CMD_WRITE_DATA 0x3
31 #define AD5360_CMD_WRITE_OFFSET 0x2
32 #define AD5360_CMD_WRITE_GAIN 0x1
33 #define AD5360_CMD_SPECIAL_FUNCTION 0x0
35 /* Special function register addresses */
36 #define AD5360_REG_SF_NOP 0x0
37 #define AD5360_REG_SF_CTRL 0x1
38 #define AD5360_REG_SF_OFS(x) (0x2 + (x))
39 #define AD5360_REG_SF_READBACK 0x5
41 #define AD5360_SF_CTRL_PWR_DOWN BIT(0)
43 #define AD5360_READBACK_X1A 0x0
44 #define AD5360_READBACK_X1B 0x1
45 #define AD5360_READBACK_OFFSET 0x2
46 #define AD5360_READBACK_GAIN 0x3
47 #define AD5360_READBACK_SF 0x4
51 * struct ad5360_chip_info - chip specific information
52 * @channel_template: channel specification template
53 * @num_channels: number of channels
54 * @channels_per_group: number of channels per group
55 * @num_vrefs: number of vref supplies for the chip
58 struct ad5360_chip_info
{
59 struct iio_chan_spec channel_template
;
60 unsigned int num_channels
;
61 unsigned int channels_per_group
;
62 unsigned int num_vrefs
;
66 * struct ad5360_state - driver instance specific data
68 * @chip_info: chip model specific constants, available modes etc
69 * @vref_reg: vref supply regulators
70 * @ctrl: control register cache
71 * @data: spi transfer buffers
75 struct spi_device
*spi
;
76 const struct ad5360_chip_info
*chip_info
;
77 struct regulator_bulk_data vref_reg
[3];
81 * DMA (thus cache coherency maintenance) requires the
82 * transfer buffers to live in their own cache lines.
87 } data
[2] ____cacheline_aligned
;
101 #define AD5360_CHANNEL(bits) { \
102 .type = IIO_VOLTAGE, \
105 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
106 BIT(IIO_CHAN_INFO_SCALE) | \
107 BIT(IIO_CHAN_INFO_OFFSET) | \
108 BIT(IIO_CHAN_INFO_CALIBSCALE) | \
109 BIT(IIO_CHAN_INFO_CALIBBIAS), \
112 .realbits = (bits), \
114 .shift = 16 - (bits), \
118 static const struct ad5360_chip_info ad5360_chip_info_tbl
[] = {
120 .channel_template
= AD5360_CHANNEL(16),
122 .channels_per_group
= 8,
126 .channel_template
= AD5360_CHANNEL(14),
128 .channels_per_group
= 8,
132 .channel_template
= AD5360_CHANNEL(16),
134 .channels_per_group
= 4,
138 .channel_template
= AD5360_CHANNEL(14),
140 .channels_per_group
= 4,
144 .channel_template
= AD5360_CHANNEL(16),
146 .channels_per_group
= 8,
150 .channel_template
= AD5360_CHANNEL(14),
152 .channels_per_group
= 8,
156 .channel_template
= AD5360_CHANNEL(16),
158 .channels_per_group
= 8,
162 .channel_template
= AD5360_CHANNEL(14),
164 .channels_per_group
= 8,
169 static unsigned int ad5360_get_channel_vref_index(struct ad5360_state
*st
,
170 unsigned int channel
)
174 /* The first groups have their own vref, while the remaining groups
175 * share the last vref */
176 i
= channel
/ st
->chip_info
->channels_per_group
;
177 if (i
>= st
->chip_info
->num_vrefs
)
178 i
= st
->chip_info
->num_vrefs
- 1;
183 static int ad5360_get_channel_vref(struct ad5360_state
*st
,
184 unsigned int channel
)
186 unsigned int i
= ad5360_get_channel_vref_index(st
, channel
);
188 return regulator_get_voltage(st
->vref_reg
[i
].consumer
);
192 static int ad5360_write_unlocked(struct iio_dev
*indio_dev
,
193 unsigned int cmd
, unsigned int addr
, unsigned int val
,
196 struct ad5360_state
*st
= iio_priv(indio_dev
);
199 val
|= AD5360_CMD(cmd
) | AD5360_ADDR(addr
);
200 st
->data
[0].d32
= cpu_to_be32(val
);
202 return spi_write(st
->spi
, &st
->data
[0].d8
[1], 3);
205 static int ad5360_write(struct iio_dev
*indio_dev
, unsigned int cmd
,
206 unsigned int addr
, unsigned int val
, unsigned int shift
)
210 mutex_lock(&indio_dev
->mlock
);
211 ret
= ad5360_write_unlocked(indio_dev
, cmd
, addr
, val
, shift
);
212 mutex_unlock(&indio_dev
->mlock
);
217 static int ad5360_read(struct iio_dev
*indio_dev
, unsigned int type
,
220 struct ad5360_state
*st
= iio_priv(indio_dev
);
222 struct spi_transfer t
[] = {
224 .tx_buf
= &st
->data
[0].d8
[1],
228 .rx_buf
= &st
->data
[1].d8
[1],
233 mutex_lock(&indio_dev
->mlock
);
235 st
->data
[0].d32
= cpu_to_be32(AD5360_CMD(AD5360_CMD_SPECIAL_FUNCTION
) |
236 AD5360_ADDR(AD5360_REG_SF_READBACK
) |
237 AD5360_READBACK_TYPE(type
) |
238 AD5360_READBACK_ADDR(addr
));
240 ret
= spi_sync_transfer(st
->spi
, t
, ARRAY_SIZE(t
));
242 ret
= be32_to_cpu(st
->data
[1].d32
) & 0xffff;
244 mutex_unlock(&indio_dev
->mlock
);
249 static ssize_t
ad5360_read_dac_powerdown(struct device
*dev
,
250 struct device_attribute
*attr
,
253 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
254 struct ad5360_state
*st
= iio_priv(indio_dev
);
256 return sprintf(buf
, "%d\n", (bool)(st
->ctrl
& AD5360_SF_CTRL_PWR_DOWN
));
259 static int ad5360_update_ctrl(struct iio_dev
*indio_dev
, unsigned int set
,
262 struct ad5360_state
*st
= iio_priv(indio_dev
);
265 mutex_lock(&indio_dev
->mlock
);
270 ret
= ad5360_write_unlocked(indio_dev
, AD5360_CMD_SPECIAL_FUNCTION
,
271 AD5360_REG_SF_CTRL
, st
->ctrl
, 0);
273 mutex_unlock(&indio_dev
->mlock
);
278 static ssize_t
ad5360_write_dac_powerdown(struct device
*dev
,
279 struct device_attribute
*attr
, const char *buf
, size_t len
)
281 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
285 ret
= strtobool(buf
, &pwr_down
);
290 ret
= ad5360_update_ctrl(indio_dev
, AD5360_SF_CTRL_PWR_DOWN
, 0);
292 ret
= ad5360_update_ctrl(indio_dev
, 0, AD5360_SF_CTRL_PWR_DOWN
);
294 return ret
? ret
: len
;
297 static IIO_DEVICE_ATTR(out_voltage_powerdown
,
299 ad5360_read_dac_powerdown
,
300 ad5360_write_dac_powerdown
, 0);
302 static struct attribute
*ad5360_attributes
[] = {
303 &iio_dev_attr_out_voltage_powerdown
.dev_attr
.attr
,
307 static const struct attribute_group ad5360_attribute_group
= {
308 .attrs
= ad5360_attributes
,
311 static int ad5360_write_raw(struct iio_dev
*indio_dev
,
312 struct iio_chan_spec
const *chan
,
317 struct ad5360_state
*st
= iio_priv(indio_dev
);
318 int max_val
= (1 << chan
->scan_type
.realbits
);
319 unsigned int ofs_index
;
322 case IIO_CHAN_INFO_RAW
:
323 if (val
>= max_val
|| val
< 0)
326 return ad5360_write(indio_dev
, AD5360_CMD_WRITE_DATA
,
327 chan
->address
, val
, chan
->scan_type
.shift
);
329 case IIO_CHAN_INFO_CALIBBIAS
:
330 if (val
>= max_val
|| val
< 0)
333 return ad5360_write(indio_dev
, AD5360_CMD_WRITE_OFFSET
,
334 chan
->address
, val
, chan
->scan_type
.shift
);
336 case IIO_CHAN_INFO_CALIBSCALE
:
337 if (val
>= max_val
|| val
< 0)
340 return ad5360_write(indio_dev
, AD5360_CMD_WRITE_GAIN
,
341 chan
->address
, val
, chan
->scan_type
.shift
);
343 case IIO_CHAN_INFO_OFFSET
:
344 if (val
<= -max_val
|| val
> 0)
349 /* offset is supposed to have the same scale as raw, but it
350 * is always 14bits wide, so on a chip where the raw value has
351 * more bits, we need to shift offset. */
352 val
>>= (chan
->scan_type
.realbits
- 14);
354 /* There is one DAC offset register per vref. Changing one
355 * channels offset will also change the offset for all other
356 * channels which share the same vref supply. */
357 ofs_index
= ad5360_get_channel_vref_index(st
, chan
->channel
);
358 return ad5360_write(indio_dev
, AD5360_CMD_SPECIAL_FUNCTION
,
359 AD5360_REG_SF_OFS(ofs_index
), val
, 0);
367 static int ad5360_read_raw(struct iio_dev
*indio_dev
,
368 struct iio_chan_spec
const *chan
,
373 struct ad5360_state
*st
= iio_priv(indio_dev
);
374 unsigned int ofs_index
;
379 case IIO_CHAN_INFO_RAW
:
380 ret
= ad5360_read(indio_dev
, AD5360_READBACK_X1A
,
384 *val
= ret
>> chan
->scan_type
.shift
;
386 case IIO_CHAN_INFO_SCALE
:
387 scale_uv
= ad5360_get_channel_vref(st
, chan
->channel
);
391 /* vout = 4 * vref * dac_code */
392 *val
= scale_uv
* 4 / 1000;
393 *val2
= chan
->scan_type
.realbits
;
394 return IIO_VAL_FRACTIONAL_LOG2
;
395 case IIO_CHAN_INFO_CALIBBIAS
:
396 ret
= ad5360_read(indio_dev
, AD5360_READBACK_OFFSET
,
402 case IIO_CHAN_INFO_CALIBSCALE
:
403 ret
= ad5360_read(indio_dev
, AD5360_READBACK_GAIN
,
409 case IIO_CHAN_INFO_OFFSET
:
410 ofs_index
= ad5360_get_channel_vref_index(st
, chan
->channel
);
411 ret
= ad5360_read(indio_dev
, AD5360_READBACK_SF
,
412 AD5360_REG_SF_OFS(ofs_index
));
416 ret
<<= (chan
->scan_type
.realbits
- 14);
424 static const struct iio_info ad5360_info
= {
425 .read_raw
= ad5360_read_raw
,
426 .write_raw
= ad5360_write_raw
,
427 .attrs
= &ad5360_attribute_group
,
430 static const char * const ad5360_vref_name
[] = {
431 "vref0", "vref1", "vref2"
434 static int ad5360_alloc_channels(struct iio_dev
*indio_dev
)
436 struct ad5360_state
*st
= iio_priv(indio_dev
);
437 struct iio_chan_spec
*channels
;
440 channels
= kcalloc(st
->chip_info
->num_channels
,
441 sizeof(struct iio_chan_spec
), GFP_KERNEL
);
446 for (i
= 0; i
< st
->chip_info
->num_channels
; ++i
) {
447 channels
[i
] = st
->chip_info
->channel_template
;
448 channels
[i
].channel
= i
;
449 channels
[i
].address
= AD5360_CHAN_ADDR(i
);
452 indio_dev
->channels
= channels
;
457 static int ad5360_probe(struct spi_device
*spi
)
459 enum ad5360_type type
= spi_get_device_id(spi
)->driver_data
;
460 struct iio_dev
*indio_dev
;
461 struct ad5360_state
*st
;
465 indio_dev
= devm_iio_device_alloc(&spi
->dev
, sizeof(*st
));
466 if (indio_dev
== NULL
) {
467 dev_err(&spi
->dev
, "Failed to allocate iio device\n");
471 st
= iio_priv(indio_dev
);
472 spi_set_drvdata(spi
, indio_dev
);
474 st
->chip_info
= &ad5360_chip_info_tbl
[type
];
477 indio_dev
->dev
.parent
= &spi
->dev
;
478 indio_dev
->name
= spi_get_device_id(spi
)->name
;
479 indio_dev
->info
= &ad5360_info
;
480 indio_dev
->modes
= INDIO_DIRECT_MODE
;
481 indio_dev
->num_channels
= st
->chip_info
->num_channels
;
483 ret
= ad5360_alloc_channels(indio_dev
);
485 dev_err(&spi
->dev
, "Failed to allocate channel spec: %d\n", ret
);
489 for (i
= 0; i
< st
->chip_info
->num_vrefs
; ++i
)
490 st
->vref_reg
[i
].supply
= ad5360_vref_name
[i
];
492 ret
= devm_regulator_bulk_get(&st
->spi
->dev
, st
->chip_info
->num_vrefs
,
495 dev_err(&spi
->dev
, "Failed to request vref regulators: %d\n", ret
);
496 goto error_free_channels
;
499 ret
= regulator_bulk_enable(st
->chip_info
->num_vrefs
, st
->vref_reg
);
501 dev_err(&spi
->dev
, "Failed to enable vref regulators: %d\n", ret
);
502 goto error_free_channels
;
505 ret
= iio_device_register(indio_dev
);
507 dev_err(&spi
->dev
, "Failed to register iio device: %d\n", ret
);
508 goto error_disable_reg
;
514 regulator_bulk_disable(st
->chip_info
->num_vrefs
, st
->vref_reg
);
516 kfree(indio_dev
->channels
);
521 static int ad5360_remove(struct spi_device
*spi
)
523 struct iio_dev
*indio_dev
= spi_get_drvdata(spi
);
524 struct ad5360_state
*st
= iio_priv(indio_dev
);
526 iio_device_unregister(indio_dev
);
528 kfree(indio_dev
->channels
);
530 regulator_bulk_disable(st
->chip_info
->num_vrefs
, st
->vref_reg
);
535 static const struct spi_device_id ad5360_ids
[] = {
536 { "ad5360", ID_AD5360
},
537 { "ad5361", ID_AD5361
},
538 { "ad5362", ID_AD5362
},
539 { "ad5363", ID_AD5363
},
540 { "ad5370", ID_AD5370
},
541 { "ad5371", ID_AD5371
},
542 { "ad5372", ID_AD5372
},
543 { "ad5373", ID_AD5373
},
546 MODULE_DEVICE_TABLE(spi
, ad5360_ids
);
548 static struct spi_driver ad5360_driver
= {
552 .probe
= ad5360_probe
,
553 .remove
= ad5360_remove
,
554 .id_table
= ad5360_ids
,
556 module_spi_driver(ad5360_driver
);
558 MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
559 MODULE_DESCRIPTION("Analog Devices AD5360/61/62/63/70/71/72/73 DAC");
560 MODULE_LICENSE("GPL v2");