iio: refactor info mask and ext_info attribute creation.
[linux-2.6-block.git] / drivers / iio / dac / ad5446.c
CommitLineData
b5a49481
MH
1/*
2 * AD5446 SPI DAC driver
3 *
4 * Copyright 2010 Analog Devices Inc.
5 *
6 * Licensed under the GPL-2 or later.
7 */
8
9#include <linux/interrupt.h>
10#include <linux/workqueue.h>
11#include <linux/device.h>
12#include <linux/kernel.h>
13#include <linux/slab.h>
14#include <linux/sysfs.h>
15#include <linux/list.h>
16#include <linux/spi/spi.h>
3ec36a2c 17#include <linux/i2c.h>
b5a49481
MH
18#include <linux/regulator/consumer.h>
19#include <linux/err.h>
99c97852 20#include <linux/module.h>
b5a49481 21
06458e27
JC
22#include <linux/iio/iio.h>
23#include <linux/iio/sysfs.h>
b5a49481 24
2e15c903
JFD
25#define MODE_PWRDWN_1k 0x1
26#define MODE_PWRDWN_100k 0x2
27#define MODE_PWRDWN_TRISTATE 0x3
28
29/**
30 * struct ad5446_state - driver instance specific data
31 * @spi: spi_device
32 * @chip_info: chip model specific constants, available modes etc
33 * @reg: supply regulator
34 * @vref_mv: actual reference voltage used
35 */
36
37struct ad5446_state {
38 struct device *dev;
39 const struct ad5446_chip_info *chip_info;
40 struct regulator *reg;
41 unsigned short vref_mv;
42 unsigned cached_val;
43 unsigned pwr_down_mode;
44 unsigned pwr_down;
45};
46
47/**
48 * struct ad5446_chip_info - chip specific information
49 * @channel: channel spec for the DAC
50 * @int_vref_mv: AD5620/40/60: the internal reference voltage
51 * @write: chip specific helper function to write to the register
52 */
53
54struct ad5446_chip_info {
55 struct iio_chan_spec channel;
56 u16 int_vref_mv;
57 int (*write)(struct ad5446_state *st, unsigned val);
58};
b5a49481 59
83f0f572 60static const char * const ad5446_powerdown_modes[] = {
09d48aa9 61 "1kohm_to_gnd", "100kohm_to_gnd", "three_state"
83f0f572
LPC
62};
63
09d48aa9
LPC
64static int ad5446_set_powerdown_mode(struct iio_dev *indio_dev,
65 const struct iio_chan_spec *chan, unsigned int mode)
bbed4dc7 66{
638e59fc 67 struct ad5446_state *st = iio_priv(indio_dev);
83f0f572 68
09d48aa9 69 st->pwr_down_mode = mode + 1;
bbed4dc7 70
09d48aa9 71 return 0;
bbed4dc7
MH
72}
73
09d48aa9
LPC
74static int ad5446_get_powerdown_mode(struct iio_dev *indio_dev,
75 const struct iio_chan_spec *chan)
bbed4dc7 76{
638e59fc 77 struct ad5446_state *st = iio_priv(indio_dev);
bbed4dc7 78
09d48aa9 79 return st->pwr_down_mode - 1;
bbed4dc7
MH
80}
81
09d48aa9
LPC
82static const struct iio_enum ad5446_powerdown_mode_enum = {
83 .items = ad5446_powerdown_modes,
84 .num_items = ARRAY_SIZE(ad5446_powerdown_modes),
85 .get = ad5446_get_powerdown_mode,
86 .set = ad5446_set_powerdown_mode,
87};
88
83f0f572 89static ssize_t ad5446_read_dac_powerdown(struct iio_dev *indio_dev,
fc6d1139 90 uintptr_t private,
83f0f572 91 const struct iio_chan_spec *chan,
bbed4dc7
MH
92 char *buf)
93{
638e59fc 94 struct ad5446_state *st = iio_priv(indio_dev);
bbed4dc7
MH
95
96 return sprintf(buf, "%d\n", st->pwr_down);
97}
98
83f0f572 99static ssize_t ad5446_write_dac_powerdown(struct iio_dev *indio_dev,
fc6d1139 100 uintptr_t private,
83f0f572 101 const struct iio_chan_spec *chan,
bbed4dc7
MH
102 const char *buf, size_t len)
103{
638e59fc 104 struct ad5446_state *st = iio_priv(indio_dev);
cae329e0
LPC
105 unsigned int shift;
106 unsigned int val;
83f0f572 107 bool powerdown;
bbed4dc7
MH
108 int ret;
109
83f0f572 110 ret = strtobool(buf, &powerdown);
bbed4dc7
MH
111 if (ret)
112 return ret;
113
638e59fc 114 mutex_lock(&indio_dev->mlock);
83f0f572 115 st->pwr_down = powerdown;
bbed4dc7 116
cae329e0
LPC
117 if (st->pwr_down) {
118 shift = chan->scan_type.realbits + chan->scan_type.shift;
119 val = st->pwr_down_mode << shift;
120 } else {
121 val = st->cached_val;
122 }
bbed4dc7 123
cae329e0 124 ret = st->chip_info->write(st, val);
638e59fc 125 mutex_unlock(&indio_dev->mlock);
bbed4dc7
MH
126
127 return ret ? ret : len;
128}
129
3ec36a2c 130static const struct iio_chan_spec_ext_info ad5446_ext_info_powerdown[] = {
83f0f572
LPC
131 {
132 .name = "powerdown",
133 .read = ad5446_read_dac_powerdown,
134 .write = ad5446_write_dac_powerdown,
3704432f 135 .shared = IIO_SEPARATE,
83f0f572 136 },
3704432f 137 IIO_ENUM("powerdown_mode", IIO_SEPARATE, &ad5446_powerdown_mode_enum),
09d48aa9 138 IIO_ENUM_AVAILABLE("powerdown_mode", &ad5446_powerdown_mode_enum),
83f0f572 139 { },
b5a49481
MH
140};
141
83f0f572 142#define _AD5446_CHANNEL(bits, storage, shift, ext) { \
33ad6b21
LPC
143 .type = IIO_VOLTAGE, \
144 .indexed = 1, \
145 .output = 1, \
146 .channel = 0, \
2f6a4a44
JC
147 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
148 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \
83f0f572
LPC
149 .scan_type = IIO_ST('u', (bits), (storage), (shift)), \
150 .ext_info = (ext), \
33ad6b21
LPC
151}
152
83f0f572
LPC
153#define AD5446_CHANNEL(bits, storage, shift) \
154 _AD5446_CHANNEL(bits, storage, shift, NULL)
155
156#define AD5446_CHANNEL_POWERDOWN(bits, storage, shift) \
3ec36a2c 157 _AD5446_CHANNEL(bits, storage, shift, ad5446_ext_info_powerdown)
b5a49481 158
33ad6b21
LPC
159static int ad5446_read_raw(struct iio_dev *indio_dev,
160 struct iio_chan_spec const *chan,
161 int *val,
162 int *val2,
163 long m)
164{
165 struct ad5446_state *st = iio_priv(indio_dev);
166 unsigned long scale_uv;
167
168 switch (m) {
5e06bdfb
LPC
169 case IIO_CHAN_INFO_RAW:
170 *val = st->cached_val;
171 return IIO_VAL_INT;
33ad6b21
LPC
172 case IIO_CHAN_INFO_SCALE:
173 scale_uv = (st->vref_mv * 1000) >> chan->scan_type.realbits;
174 *val = scale_uv / 1000;
175 *val2 = (scale_uv % 1000) * 1000;
176 return IIO_VAL_INT_PLUS_MICRO;
177
178 }
179 return -EINVAL;
180}
181
182static int ad5446_write_raw(struct iio_dev *indio_dev,
183 struct iio_chan_spec const *chan,
184 int val,
185 int val2,
186 long mask)
187{
188 struct ad5446_state *st = iio_priv(indio_dev);
07ffd0d0 189 int ret = 0;
33ad6b21
LPC
190
191 switch (mask) {
09f4eb40 192 case IIO_CHAN_INFO_RAW:
33ad6b21
LPC
193 if (val >= (1 << chan->scan_type.realbits) || val < 0)
194 return -EINVAL;
195
196 val <<= chan->scan_type.shift;
197 mutex_lock(&indio_dev->mlock);
198 st->cached_val = val;
af836d9a 199 if (!st->pwr_down)
cae329e0 200 ret = st->chip_info->write(st, val);
33ad6b21
LPC
201 mutex_unlock(&indio_dev->mlock);
202 break;
203 default:
204 ret = -EINVAL;
205 }
206
207 return ret;
208}
209
6fe8135f 210static const struct iio_info ad5446_info = {
7389266c
JC
211 .read_raw = ad5446_read_raw,
212 .write_raw = ad5446_write_raw,
213 .driver_module = THIS_MODULE,
214};
215
fc52692c
GKH
216static int ad5446_probe(struct device *dev, const char *name,
217 const struct ad5446_chip_info *chip_info)
b5a49481
MH
218{
219 struct ad5446_state *st;
86729fc4
JC
220 struct iio_dev *indio_dev;
221 struct regulator *reg;
b5a49481
MH
222 int ret, voltage_uv = 0;
223
ba727295 224 reg = devm_regulator_get(dev, "vcc");
86729fc4
JC
225 if (!IS_ERR(reg)) {
226 ret = regulator_enable(reg);
b5a49481 227 if (ret)
ba727295 228 return ret;
b5a49481 229
13e57ee2
AL
230 ret = regulator_get_voltage(reg);
231 if (ret < 0)
232 goto error_disable_reg;
233
234 voltage_uv = ret;
b5a49481
MH
235 }
236
ba727295 237 indio_dev = devm_iio_device_alloc(dev, sizeof(*st));
86729fc4
JC
238 if (indio_dev == NULL) {
239 ret = -ENOMEM;
240 goto error_disable_reg;
241 }
242 st = iio_priv(indio_dev);
3ec36a2c 243 st->chip_info = chip_info;
b5a49481 244
3ec36a2c 245 dev_set_drvdata(dev, indio_dev);
86729fc4 246 st->reg = reg;
3ec36a2c 247 st->dev = dev;
b5a49481 248
3ec36a2c
JFD
249 /* Establish that the iio_dev is a child of the device */
250 indio_dev->dev.parent = dev;
251 indio_dev->name = name;
83f0f572 252 indio_dev->info = &ad5446_info;
86729fc4 253 indio_dev->modes = INDIO_DIRECT_MODE;
33ad6b21
LPC
254 indio_dev->channels = &st->chip_info->channel;
255 indio_dev->num_channels = 1;
b5a49481 256
09d48aa9
LPC
257 st->pwr_down_mode = MODE_PWRDWN_1k;
258
4e5d3f92 259 if (st->chip_info->int_vref_mv)
bbed4dc7 260 st->vref_mv = st->chip_info->int_vref_mv;
4e5d3f92
LPC
261 else if (voltage_uv)
262 st->vref_mv = voltage_uv / 1000;
263 else
3ec36a2c 264 dev_warn(dev, "reference voltage unspecified\n");
b5a49481 265
86729fc4 266 ret = iio_device_register(indio_dev);
b5a49481 267 if (ret)
ba727295 268 goto error_disable_reg;
b5a49481
MH
269
270 return 0;
271
b5a49481 272error_disable_reg:
86729fc4
JC
273 if (!IS_ERR(reg))
274 regulator_disable(reg);
b5a49481
MH
275 return ret;
276}
277
3ec36a2c 278static int ad5446_remove(struct device *dev)
b5a49481 279{
3ec36a2c 280 struct iio_dev *indio_dev = dev_get_drvdata(dev);
86729fc4 281 struct ad5446_state *st = iio_priv(indio_dev);
b5a49481
MH
282
283 iio_device_unregister(indio_dev);
ba727295 284 if (!IS_ERR(st->reg))
d2fffd6c 285 regulator_disable(st->reg);
d2fffd6c 286
b5a49481
MH
287 return 0;
288}
289
3ec36a2c
JFD
290#if IS_ENABLED(CONFIG_SPI_MASTER)
291
292static int ad5446_write(struct ad5446_state *st, unsigned val)
293{
294 struct spi_device *spi = to_spi_device(st->dev);
295 __be16 data = cpu_to_be16(val);
296
297 return spi_write(spi, &data, sizeof(data));
298}
299
300static int ad5660_write(struct ad5446_state *st, unsigned val)
301{
302 struct spi_device *spi = to_spi_device(st->dev);
303 uint8_t data[3];
304
305 data[0] = (val >> 16) & 0xFF;
306 data[1] = (val >> 8) & 0xFF;
307 data[2] = val & 0xFF;
308
309 return spi_write(spi, data, sizeof(data));
310}
311
312/**
313 * ad5446_supported_spi_device_ids:
314 * The AD5620/40/60 parts are available in different fixed internal reference
315 * voltage options. The actual part numbers may look differently
316 * (and a bit cryptic), however this style is used to make clear which
317 * parts are supported here.
318 */
319enum ad5446_supported_spi_device_ids {
2fafbce2
LPC
320 ID_AD5300,
321 ID_AD5310,
322 ID_AD5320,
3ec36a2c
JFD
323 ID_AD5444,
324 ID_AD5446,
325 ID_AD5450,
326 ID_AD5451,
327 ID_AD5541A,
328 ID_AD5512A,
329 ID_AD5553,
330 ID_AD5601,
331 ID_AD5611,
332 ID_AD5621,
333 ID_AD5620_2500,
334 ID_AD5620_1250,
335 ID_AD5640_2500,
336 ID_AD5640_1250,
337 ID_AD5660_2500,
338 ID_AD5660_1250,
339 ID_AD5662,
340};
341
342static const struct ad5446_chip_info ad5446_spi_chip_info[] = {
2fafbce2
LPC
343 [ID_AD5300] = {
344 .channel = AD5446_CHANNEL_POWERDOWN(8, 16, 4),
345 .write = ad5446_write,
346 },
347 [ID_AD5310] = {
348 .channel = AD5446_CHANNEL_POWERDOWN(10, 16, 2),
349 .write = ad5446_write,
350 },
351 [ID_AD5320] = {
352 .channel = AD5446_CHANNEL_POWERDOWN(12, 16, 0),
353 .write = ad5446_write,
354 },
3ec36a2c
JFD
355 [ID_AD5444] = {
356 .channel = AD5446_CHANNEL(12, 16, 2),
357 .write = ad5446_write,
358 },
359 [ID_AD5446] = {
360 .channel = AD5446_CHANNEL(14, 16, 0),
361 .write = ad5446_write,
362 },
363 [ID_AD5450] = {
364 .channel = AD5446_CHANNEL(8, 16, 6),
365 .write = ad5446_write,
366 },
367 [ID_AD5451] = {
368 .channel = AD5446_CHANNEL(10, 16, 4),
369 .write = ad5446_write,
370 },
371 [ID_AD5541A] = {
372 .channel = AD5446_CHANNEL(16, 16, 0),
373 .write = ad5446_write,
374 },
375 [ID_AD5512A] = {
376 .channel = AD5446_CHANNEL(12, 16, 4),
377 .write = ad5446_write,
378 },
379 [ID_AD5553] = {
380 .channel = AD5446_CHANNEL(14, 16, 0),
381 .write = ad5446_write,
382 },
383 [ID_AD5601] = {
384 .channel = AD5446_CHANNEL_POWERDOWN(8, 16, 6),
385 .write = ad5446_write,
386 },
387 [ID_AD5611] = {
388 .channel = AD5446_CHANNEL_POWERDOWN(10, 16, 4),
389 .write = ad5446_write,
390 },
391 [ID_AD5621] = {
392 .channel = AD5446_CHANNEL_POWERDOWN(12, 16, 2),
393 .write = ad5446_write,
394 },
395 [ID_AD5620_2500] = {
396 .channel = AD5446_CHANNEL_POWERDOWN(12, 16, 2),
397 .int_vref_mv = 2500,
398 .write = ad5446_write,
399 },
400 [ID_AD5620_1250] = {
401 .channel = AD5446_CHANNEL_POWERDOWN(12, 16, 2),
402 .int_vref_mv = 1250,
403 .write = ad5446_write,
404 },
405 [ID_AD5640_2500] = {
406 .channel = AD5446_CHANNEL_POWERDOWN(14, 16, 0),
407 .int_vref_mv = 2500,
408 .write = ad5446_write,
409 },
410 [ID_AD5640_1250] = {
411 .channel = AD5446_CHANNEL_POWERDOWN(14, 16, 0),
412 .int_vref_mv = 1250,
413 .write = ad5446_write,
414 },
415 [ID_AD5660_2500] = {
416 .channel = AD5446_CHANNEL_POWERDOWN(16, 16, 0),
417 .int_vref_mv = 2500,
418 .write = ad5660_write,
419 },
420 [ID_AD5660_1250] = {
421 .channel = AD5446_CHANNEL_POWERDOWN(16, 16, 0),
422 .int_vref_mv = 1250,
423 .write = ad5660_write,
424 },
425 [ID_AD5662] = {
426 .channel = AD5446_CHANNEL_POWERDOWN(16, 16, 0),
427 .write = ad5660_write,
428 },
429};
430
431static const struct spi_device_id ad5446_spi_ids[] = {
2fafbce2
LPC
432 {"ad5300", ID_AD5300},
433 {"ad5310", ID_AD5310},
434 {"ad5320", ID_AD5320},
b5a49481
MH
435 {"ad5444", ID_AD5444},
436 {"ad5446", ID_AD5446},
779c0c46
LPC
437 {"ad5450", ID_AD5450},
438 {"ad5451", ID_AD5451},
439 {"ad5452", ID_AD5444}, /* ad5452 is compatible to the ad5444 */
440 {"ad5453", ID_AD5446}, /* ad5453 is compatible to the ad5446 */
b5a49481 441 {"ad5512a", ID_AD5512A},
67d1c1f4 442 {"ad5541a", ID_AD5541A},
11a7df48
LPC
443 {"ad5542a", ID_AD5541A}, /* ad5541a and ad5542a are compatible */
444 {"ad5543", ID_AD5541A}, /* ad5541a and ad5543 are compatible */
bd51c0b0 445 {"ad5553", ID_AD5553},
2b61535a
MH
446 {"ad5601", ID_AD5601},
447 {"ad5611", ID_AD5611},
448 {"ad5621", ID_AD5621},
d846263d
MH
449 {"ad5620-2500", ID_AD5620_2500}, /* AD5620/40/60: */
450 {"ad5620-1250", ID_AD5620_1250}, /* part numbers may look differently */
451 {"ad5640-2500", ID_AD5640_2500},
452 {"ad5640-1250", ID_AD5640_1250},
453 {"ad5660-2500", ID_AD5660_2500},
454 {"ad5660-1250", ID_AD5660_1250},
18e5ab31 455 {"ad5662", ID_AD5662},
b5a49481
MH
456 {}
457};
3ec36a2c
JFD
458MODULE_DEVICE_TABLE(spi, ad5446_spi_ids);
459
fc52692c 460static int ad5446_spi_probe(struct spi_device *spi)
3ec36a2c
JFD
461{
462 const struct spi_device_id *id = spi_get_device_id(spi);
463
464 return ad5446_probe(&spi->dev, id->name,
465 &ad5446_spi_chip_info[id->driver_data]);
466}
b5a49481 467
fc52692c 468static int ad5446_spi_remove(struct spi_device *spi)
3ec36a2c
JFD
469{
470 return ad5446_remove(&spi->dev);
471}
472
473static struct spi_driver ad5446_spi_driver = {
b5a49481
MH
474 .driver = {
475 .name = "ad5446",
b5a49481
MH
476 .owner = THIS_MODULE,
477 },
3ec36a2c 478 .probe = ad5446_spi_probe,
fc52692c 479 .remove = ad5446_spi_remove,
3ec36a2c
JFD
480 .id_table = ad5446_spi_ids,
481};
482
483static int __init ad5446_spi_register_driver(void)
484{
485 return spi_register_driver(&ad5446_spi_driver);
486}
487
488static void ad5446_spi_unregister_driver(void)
489{
490 spi_unregister_driver(&ad5446_spi_driver);
491}
492
493#else
494
495static inline int ad5446_spi_register_driver(void) { return 0; }
496static inline void ad5446_spi_unregister_driver(void) { }
497
498#endif
499
500#if IS_ENABLED(CONFIG_I2C)
501
502static int ad5622_write(struct ad5446_state *st, unsigned val)
503{
504 struct i2c_client *client = to_i2c_client(st->dev);
505 __be16 data = cpu_to_be16(val);
506
507 return i2c_master_send(client, (char *)&data, sizeof(data));
508}
509
510/**
511 * ad5446_supported_i2c_device_ids:
512 * The AD5620/40/60 parts are available in different fixed internal reference
513 * voltage options. The actual part numbers may look differently
514 * (and a bit cryptic), however this style is used to make clear which
515 * parts are supported here.
516 */
517enum ad5446_supported_i2c_device_ids {
518 ID_AD5602,
519 ID_AD5612,
520 ID_AD5622,
521};
522
523static const struct ad5446_chip_info ad5446_i2c_chip_info[] = {
524 [ID_AD5602] = {
525 .channel = AD5446_CHANNEL_POWERDOWN(8, 16, 4),
526 .write = ad5622_write,
527 },
528 [ID_AD5612] = {
529 .channel = AD5446_CHANNEL_POWERDOWN(10, 16, 2),
530 .write = ad5622_write,
531 },
532 [ID_AD5622] = {
533 .channel = AD5446_CHANNEL_POWERDOWN(12, 16, 0),
534 .write = ad5622_write,
535 },
b5a49481 536};
3ec36a2c 537
fc52692c
GKH
538static int ad5446_i2c_probe(struct i2c_client *i2c,
539 const struct i2c_device_id *id)
3ec36a2c
JFD
540{
541 return ad5446_probe(&i2c->dev, id->name,
542 &ad5446_i2c_chip_info[id->driver_data]);
543}
544
fc52692c 545static int ad5446_i2c_remove(struct i2c_client *i2c)
3ec36a2c
JFD
546{
547 return ad5446_remove(&i2c->dev);
548}
549
550static const struct i2c_device_id ad5446_i2c_ids[] = {
bf832380
LPC
551 {"ad5301", ID_AD5602},
552 {"ad5311", ID_AD5612},
553 {"ad5321", ID_AD5622},
3ec36a2c
JFD
554 {"ad5602", ID_AD5602},
555 {"ad5612", ID_AD5612},
556 {"ad5622", ID_AD5622},
557 {}
558};
559MODULE_DEVICE_TABLE(i2c, ad5446_i2c_ids);
560
561static struct i2c_driver ad5446_i2c_driver = {
562 .driver = {
563 .name = "ad5446",
564 .owner = THIS_MODULE,
565 },
566 .probe = ad5446_i2c_probe,
fc52692c 567 .remove = ad5446_i2c_remove,
3ec36a2c
JFD
568 .id_table = ad5446_i2c_ids,
569};
570
571static int __init ad5446_i2c_register_driver(void)
572{
573 return i2c_add_driver(&ad5446_i2c_driver);
574}
575
576static void __exit ad5446_i2c_unregister_driver(void)
577{
578 i2c_del_driver(&ad5446_i2c_driver);
579}
580
581#else
582
583static inline int ad5446_i2c_register_driver(void) { return 0; }
584static inline void ad5446_i2c_unregister_driver(void) { }
585
586#endif
587
588static int __init ad5446_init(void)
589{
590 int ret;
591
592 ret = ad5446_spi_register_driver();
593 if (ret)
594 return ret;
595
596 ret = ad5446_i2c_register_driver();
597 if (ret) {
598 ad5446_spi_unregister_driver();
599 return ret;
600 }
601
602 return 0;
603}
604module_init(ad5446_init);
605
606static void __exit ad5446_exit(void)
607{
608 ad5446_i2c_unregister_driver();
609 ad5446_spi_unregister_driver();
610}
611module_exit(ad5446_exit);
b5a49481
MH
612
613MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>");
614MODULE_DESCRIPTION("Analog Devices AD5444/AD5446 DAC");
615MODULE_LICENSE("GPL v2");