linux/drivers/hwmon/ads1015.c
<<
>>
Prefs
   1/*
   2 * ads1015.c - lm_sensors driver for ads1015 12-bit 4-input ADC
   3 * (C) Copyright 2010
   4 * Dirk Eibach, Guntermann & Drunck GmbH <eibach@gdsys.de>
   5 *
   6 * Based on the ads7828 driver by Steve Hardy.
   7 *
   8 * Datasheet available at: http://focus.ti.com/lit/ds/symlink/ads1015.pdf
   9 *
  10 * This program is free software; you can redistribute it and/or modify
  11 * it under the terms of the GNU General Public License as published by
  12 * the Free Software Foundation; either version 2 of the License, or
  13 * (at your option) any later version.
  14 *
  15 * This program is distributed in the hope that it will be useful,
  16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 * GNU General Public License for more details.
  19 *
  20 * You should have received a copy of the GNU General Public License
  21 * along with this program; if not, write to the Free Software
  22 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23 */
  24
  25#include <linux/module.h>
  26#include <linux/init.h>
  27#include <linux/slab.h>
  28#include <linux/delay.h>
  29#include <linux/i2c.h>
  30#include <linux/hwmon.h>
  31#include <linux/hwmon-sysfs.h>
  32#include <linux/err.h>
  33#include <linux/mutex.h>
  34#include <linux/of_device.h>
  35#include <linux/of.h>
  36
  37#include <linux/platform_data/ads1015.h>
  38
  39/* ADS1015 registers */
  40enum {
  41        ADS1015_CONVERSION = 0,
  42        ADS1015_CONFIG = 1,
  43};
  44
  45/* PGA fullscale voltages in mV */
  46static const unsigned int fullscale_table[8] = {
  47        6144, 4096, 2048, 1024, 512, 256, 256, 256 };
  48
  49/* Data rates in samples per second */
  50static const unsigned int data_rate_table_1015[8] = {
  51        128, 250, 490, 920, 1600, 2400, 3300, 3300
  52};
  53
  54static const unsigned int data_rate_table_1115[8] = {
  55        8, 16, 32, 64, 128, 250, 475, 860
  56};
  57
  58#define ADS1015_DEFAULT_CHANNELS 0xff
  59#define ADS1015_DEFAULT_PGA 2
  60#define ADS1015_DEFAULT_DATA_RATE 4
  61
  62enum ads1015_chips {
  63        ads1015,
  64        ads1115,
  65};
  66
  67struct ads1015_data {
  68        struct device *hwmon_dev;
  69        struct mutex update_lock; /* mutex protect updates */
  70        struct ads1015_channel_data channel_data[ADS1015_CHANNELS];
  71        enum ads1015_chips id;
  72};
  73
  74static int ads1015_read_adc(struct i2c_client *client, unsigned int channel)
  75{
  76        u16 config;
  77        struct ads1015_data *data = i2c_get_clientdata(client);
  78        unsigned int pga = data->channel_data[channel].pga;
  79        unsigned int data_rate = data->channel_data[channel].data_rate;
  80        unsigned int conversion_time_ms;
  81        const unsigned int * const rate_table = data->id == ads1115 ?
  82                data_rate_table_1115 : data_rate_table_1015;
  83        int res;
  84
  85        mutex_lock(&data->update_lock);
  86
  87        /* get channel parameters */
  88        res = i2c_smbus_read_word_swapped(client, ADS1015_CONFIG);
  89        if (res < 0)
  90                goto err_unlock;
  91        config = res;
  92        conversion_time_ms = DIV_ROUND_UP(1000, rate_table[data_rate]);
  93
  94        /* setup and start single conversion */
  95        config &= 0x001f;
  96        config |= (1 << 15) | (1 << 8);
  97        config |= (channel & 0x0007) << 12;
  98        config |= (pga & 0x0007) << 9;
  99        config |= (data_rate & 0x0007) << 5;
 100
 101        res = i2c_smbus_write_word_swapped(client, ADS1015_CONFIG, config);
 102        if (res < 0)
 103                goto err_unlock;
 104
 105        /* wait until conversion finished */
 106        msleep(conversion_time_ms);
 107        res = i2c_smbus_read_word_swapped(client, ADS1015_CONFIG);
 108        if (res < 0)
 109                goto err_unlock;
 110        config = res;
 111        if (!(config & (1 << 15))) {
 112                /* conversion not finished in time */
 113                res = -EIO;
 114                goto err_unlock;
 115        }
 116
 117        res = i2c_smbus_read_word_swapped(client, ADS1015_CONVERSION);
 118
 119err_unlock:
 120        mutex_unlock(&data->update_lock);
 121        return res;
 122}
 123
 124static int ads1015_reg_to_mv(struct i2c_client *client, unsigned int channel,
 125                             s16 reg)
 126{
 127        struct ads1015_data *data = i2c_get_clientdata(client);
 128        unsigned int pga = data->channel_data[channel].pga;
 129        int fullscale = fullscale_table[pga];
 130        const int mask = data->id == ads1115 ? 0x7fff : 0x7ff0;
 131
 132        return DIV_ROUND_CLOSEST(reg * fullscale, mask);
 133}
 134
 135/* sysfs callback function */
 136static ssize_t in_show(struct device *dev, struct device_attribute *da,
 137                       char *buf)
 138{
 139        struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
 140        struct i2c_client *client = to_i2c_client(dev);
 141        int res;
 142        int index = attr->index;
 143
 144        res = ads1015_read_adc(client, index);
 145        if (res < 0)
 146                return res;
 147
 148        return sprintf(buf, "%d\n", ads1015_reg_to_mv(client, index, res));
 149}
 150
 151static const struct sensor_device_attribute ads1015_in[] = {
 152        SENSOR_ATTR_RO(in0_input, in, 0),
 153        SENSOR_ATTR_RO(in1_input, in, 1),
 154        SENSOR_ATTR_RO(in2_input, in, 2),
 155        SENSOR_ATTR_RO(in3_input, in, 3),
 156        SENSOR_ATTR_RO(in4_input, in, 4),
 157        SENSOR_ATTR_RO(in5_input, in, 5),
 158        SENSOR_ATTR_RO(in6_input, in, 6),
 159        SENSOR_ATTR_RO(in7_input, in, 7),
 160};
 161
 162/*
 163 * Driver interface
 164 */
 165
 166static int ads1015_remove(struct i2c_client *client)
 167{
 168        struct ads1015_data *data = i2c_get_clientdata(client);
 169        int k;
 170
 171        hwmon_device_unregister(data->hwmon_dev);
 172        for (k = 0; k < ADS1015_CHANNELS; ++k)
 173                device_remove_file(&client->dev, &ads1015_in[k].dev_attr);
 174        return 0;
 175}
 176
 177#ifdef CONFIG_OF
 178static int ads1015_get_channels_config_of(struct i2c_client *client)
 179{
 180        struct ads1015_data *data = i2c_get_clientdata(client);
 181        struct device_node *node;
 182
 183        if (!client->dev.of_node
 184            || !of_get_next_child(client->dev.of_node, NULL))
 185                return -EINVAL;
 186
 187        for_each_child_of_node(client->dev.of_node, node) {
 188                u32 pval;
 189                unsigned int channel;
 190                unsigned int pga = ADS1015_DEFAULT_PGA;
 191                unsigned int data_rate = ADS1015_DEFAULT_DATA_RATE;
 192
 193                if (of_property_read_u32(node, "reg", &pval)) {
 194                        dev_err(&client->dev, "invalid reg on %pOF\n", node);
 195                        continue;
 196                }
 197
 198                channel = pval;
 199                if (channel >= ADS1015_CHANNELS) {
 200                        dev_err(&client->dev,
 201                                "invalid channel index %d on %pOF\n",
 202                                channel, node);
 203                        continue;
 204                }
 205
 206                if (!of_property_read_u32(node, "ti,gain", &pval)) {
 207                        pga = pval;
 208                        if (pga > 6) {
 209                                dev_err(&client->dev, "invalid gain on %pOF\n",
 210                                        node);
 211                                return -EINVAL;
 212                        }
 213                }
 214
 215                if (!of_property_read_u32(node, "ti,datarate", &pval)) {
 216                        data_rate = pval;
 217                        if (data_rate > 7) {
 218                                dev_err(&client->dev,
 219                                        "invalid data_rate on %pOF\n", node);
 220                                return -EINVAL;
 221                        }
 222                }
 223
 224                data->channel_data[channel].enabled = true;
 225                data->channel_data[channel].pga = pga;
 226                data->channel_data[channel].data_rate = data_rate;
 227        }
 228
 229        return 0;
 230}
 231#endif
 232
 233static void ads1015_get_channels_config(struct i2c_client *client)
 234{
 235        unsigned int k;
 236        struct ads1015_data *data = i2c_get_clientdata(client);
 237        struct ads1015_platform_data *pdata = dev_get_platdata(&client->dev);
 238
 239        /* prefer platform data */
 240        if (pdata) {
 241                memcpy(data->channel_data, pdata->channel_data,
 242                       sizeof(data->channel_data));
 243                return;
 244        }
 245
 246#ifdef CONFIG_OF
 247        if (!ads1015_get_channels_config_of(client))
 248                return;
 249#endif
 250
 251        /* fallback on default configuration */
 252        for (k = 0; k < ADS1015_CHANNELS; ++k) {
 253                data->channel_data[k].enabled = true;
 254                data->channel_data[k].pga = ADS1015_DEFAULT_PGA;
 255                data->channel_data[k].data_rate = ADS1015_DEFAULT_DATA_RATE;
 256        }
 257}
 258
 259static int ads1015_probe(struct i2c_client *client,
 260                         const struct i2c_device_id *id)
 261{
 262        struct ads1015_data *data;
 263        int err;
 264        unsigned int k;
 265
 266        data = devm_kzalloc(&client->dev, sizeof(struct ads1015_data),
 267                            GFP_KERNEL);
 268        if (!data)
 269                return -ENOMEM;
 270
 271        if (client->dev.of_node)
 272                data->id = (enum ads1015_chips)
 273                        of_device_get_match_data(&client->dev);
 274        else
 275                data->id = id->driver_data;
 276        i2c_set_clientdata(client, data);
 277        mutex_init(&data->update_lock);
 278
 279        /* build sysfs attribute group */
 280        ads1015_get_channels_config(client);
 281        for (k = 0; k < ADS1015_CHANNELS; ++k) {
 282                if (!data->channel_data[k].enabled)
 283                        continue;
 284                err = device_create_file(&client->dev, &ads1015_in[k].dev_attr);
 285                if (err)
 286                        goto exit_remove;
 287        }
 288
 289        data->hwmon_dev = hwmon_device_register(&client->dev);
 290        if (IS_ERR(data->hwmon_dev)) {
 291                err = PTR_ERR(data->hwmon_dev);
 292                goto exit_remove;
 293        }
 294
 295        return 0;
 296
 297exit_remove:
 298        for (k = 0; k < ADS1015_CHANNELS; ++k)
 299                device_remove_file(&client->dev, &ads1015_in[k].dev_attr);
 300        return err;
 301}
 302
 303static const struct i2c_device_id ads1015_id[] = {
 304        { "ads1015",  ads1015},
 305        { "ads1115",  ads1115},
 306        { }
 307};
 308MODULE_DEVICE_TABLE(i2c, ads1015_id);
 309
 310static const struct of_device_id ads1015_of_match[] = {
 311        {
 312                .compatible = "ti,ads1015",
 313                .data = (void *)ads1015
 314        },
 315        {
 316                .compatible = "ti,ads1115",
 317                .data = (void *)ads1115
 318        },
 319        { },
 320};
 321MODULE_DEVICE_TABLE(of, ads1015_of_match);
 322
 323static struct i2c_driver ads1015_driver = {
 324        .driver = {
 325                .name = "ads1015",
 326                .of_match_table = of_match_ptr(ads1015_of_match),
 327        },
 328        .probe = ads1015_probe,
 329        .remove = ads1015_remove,
 330        .id_table = ads1015_id,
 331};
 332
 333module_i2c_driver(ads1015_driver);
 334
 335MODULE_AUTHOR("Dirk Eibach <eibach@gdsys.de>");
 336MODULE_DESCRIPTION("ADS1015 driver");
 337MODULE_LICENSE("GPL");
 338