drivers/iio/dac/mcp4922.c

   1 /*
   2  * mcp4922.c
   3  *
   4  * Driver for Microchip Digital to Analog Converters.
   5  * Supports MCP4902, MCP4912, and MCP4922.
   6  *
   7  * Copyright (c) 2014 EMAC Inc.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  */
  20
  21 #include <linux/module.h>
  22 #include <linux/init.h>
  23 #include <linux/spi/spi.h>
  24 #include <linux/iio/iio.h>
  25 #include <linux/iio/sysfs.h>
  26 #include <linux/regulator/consumer.h>
  27 #include <linux/bitops.h>
  28
  29 #define MCP4922_NUM_CHANNELS    2
  30
  31 enum mcp4922_supported_device_ids {
  32         ID_MCP4902,
  33         ID_MCP4912,
  34         ID_MCP4922,
  35 };
  36
  37 struct mcp4922_state {
  38         struct spi_device *spi;
  39         unsigned int value[MCP4922_NUM_CHANNELS];
  40         unsigned int vref_mv;
  41         struct regulator *vref_reg;
  42         u8 mosi[2] ____cacheline_aligned;
  43 };
  44
  45 #define MCP4922_CHAN(chan, bits) {                      \
  46         .type = IIO_VOLTAGE,                            \
  47         .output = 1,                                    \
  48         .indexed = 1,                                   \
  49         .channel = chan,                                \
  50         .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),   \
  51         .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),   \
  52         .scan_type = {                                  \
  53                 .sign = 'u',                            \
  54                 .realbits = (bits),                     \
  55                 .storagebits = 16,                      \
  56                 .shift = 12 - (bits),                   \
  57         },                                              \
  58 }
  59
  60 static int mcp4922_spi_write(struct mcp4922_state *state, u8 addr, u32 val)
  61 {
  62         state->mosi[1] = val & 0xff;
  63         state->mosi[0] = (addr == 0) ? 0x00 : 0x80;
  64         state->mosi[0] |= 0x30 | ((val >> 8) & 0x0f);
  65
  66         return spi_write(state->spi, state->mosi, 2);
  67 }
  68
  69 static int mcp4922_read_raw(struct iio_dev *indio_dev,
  70                 struct iio_chan_spec const *chan,
  71                 int *val,
  72                 int *val2,
  73                 long mask)
  74 {
  75         struct mcp4922_state *state = iio_priv(indio_dev);
  76
  77         switch (mask) {
  78         case IIO_CHAN_INFO_RAW:
  79                 *val = state->value[chan->channel];
  80                 return IIO_VAL_INT;
  81         case IIO_CHAN_INFO_SCALE:
  82                 *val = state->vref_mv;
  83                 *val2 = chan->scan_type.realbits;
  84                 return IIO_VAL_FRACTIONAL_LOG2;
  85         default:
  86                 return -EINVAL;
  87         }
  88 }
  89
  90 static int mcp4922_write_raw(struct iio_dev *indio_dev,
  91                 struct iio_chan_spec const *chan,
  92                 int val,
  93                 int val2,
  94                 long mask)
  95 {
  96         struct mcp4922_state *state = iio_priv(indio_dev);
  97         int ret;
  98
  99         if (val2 != 0)
 100                 return -EINVAL;
 101
 102         switch (mask) {
 103         case IIO_CHAN_INFO_RAW:
 104                 if (val < 0 || val > GENMASK(chan->scan_type.realbits - 1, 0))
 105                         return -EINVAL;
 106                 val <<= chan->scan_type.shift;
 107
 108                 ret = mcp4922_spi_write(state, chan->channel, val);
 109                 if (!ret)
 110                         state->value[chan->channel] = val;
 111                 return ret;
 112
 113         default:
 114                 return -EINVAL;
 115         }
 116 }
 117
 118 static const struct iio_chan_spec mcp4922_channels[3][MCP4922_NUM_CHANNELS] = {
 119         [ID_MCP4902] = { MCP4922_CHAN(0, 8),    MCP4922_CHAN(1, 8) },
 120         [ID_MCP4912] = { MCP4922_CHAN(0, 10),   MCP4922_CHAN(1, 10) },
 121         [ID_MCP4922] = { MCP4922_CHAN(0, 12),   MCP4922_CHAN(1, 12) },
 122 };
 123
 124 static const struct iio_info mcp4922_info = {
 125         .read_raw = &mcp4922_read_raw,
 126         .write_raw = &mcp4922_write_raw,
 127         .driver_module = THIS_MODULE,
 128 };
 129
 130 static int mcp4922_probe(struct spi_device *spi)
 131 {
 132         struct iio_dev *indio_dev;
 133         struct mcp4922_state *state;
 134         const struct spi_device_id *id;
 135         int ret;
 136
 137         indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*state));
 138         if (indio_dev == NULL)
 139                 return -ENOMEM;
 140
 141         state = iio_priv(indio_dev);
 142         state->spi = spi;
 143         state->vref_reg = devm_regulator_get(&spi->dev, "vref");
 144         if (IS_ERR(state->vref_reg)) {
 145                 dev_err(&spi->dev, "Vref regulator not specified\n");
 146                 return PTR_ERR(state->vref_reg);
 147         }
 148
 149         ret = regulator_enable(state->vref_reg);
 150         if (ret) {
 151                 dev_err(&spi->dev, "Failed to enable vref regulator: %d\n",
 152                                 ret);
 153                 return ret;
 154         }
 155
 156         ret = regulator_get_voltage(state->vref_reg);
 157         if (ret < 0) {
 158                 dev_err(&spi->dev, "Failed to read vref regulator: %d\n",
 159                                 ret);
 160                 goto error_disable_reg;
 161         }
 162         state->vref_mv = ret / 1000;
 163
 164         spi_set_drvdata(spi, indio_dev);
 165         id = spi_get_device_id(spi);
 166         indio_dev->dev.parent = &spi->dev;
 167         indio_dev->info = &mcp4922_info;
 168         indio_dev->modes = INDIO_DIRECT_MODE;
 169         indio_dev->channels = mcp4922_channels[id->driver_data];
 170         indio_dev->num_channels = MCP4922_NUM_CHANNELS;
 171         indio_dev->name = id->name;
 172
 173         ret = iio_device_register(indio_dev);
 174         if (ret) {
 175                 dev_err(&spi->dev, "Failed to register iio device: %d\n",
 176                                 ret);
 177                 goto error_disable_reg;
 178         }
 179
 180         return 0;
 181
 182 error_disable_reg:
 183         regulator_disable(state->vref_reg);
 184
 185         return ret;
 186 }
 187
 188 static int mcp4922_remove(struct spi_device *spi)
 189 {
 190         struct iio_dev *indio_dev = spi_get_drvdata(spi);
 191         struct mcp4922_state *state;
 192
 193         iio_device_unregister(indio_dev);
 194         state = iio_priv(indio_dev);
 195         regulator_disable(state->vref_reg);
 196
 197         return 0;
 198 }
 199
 200 static const struct spi_device_id mcp4922_id[] = {
 201         {"mcp4902", ID_MCP4902},
 202         {"mcp4912", ID_MCP4912},
 203         {"mcp4922", ID_MCP4922},
 204         {}
 205 };
 206 MODULE_DEVICE_TABLE(spi, mcp4922_id);
 207
 208 static struct spi_driver mcp4922_driver = {
 209         .driver = {
 210                    .name = "mcp4922",
 211                    },
 212         .probe = mcp4922_probe,
 213         .remove = mcp4922_remove,
 214         .id_table = mcp4922_id,
 215 };
 216 module_spi_driver(mcp4922_driver);
 217
 218 MODULE_AUTHOR("Michael Welling <mwelling@ieee.org>");
 219 MODULE_DESCRIPTION("Microchip MCP4902, MCP4912, MCP4922 DAC");
 220 MODULE_LICENSE("GPL v2");