drivers/hwmon/tmp421.c

   1 /* tmp421.c
   2  *
   3  * Copyright (C) 2009 Andre Prendel <andre.prendel@gmx.de>
   4  * Preliminary support by:
   5  * Melvin Rook, Raymond Ng
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  */
  17
  18 /*
  19  * Driver for the Texas Instruments TMP421 SMBus temperature sensor IC.
  20  * Supported models: TMP421, TMP422, TMP423, TMP441, TMP442
  21  */
  22
  23 #include <linux/module.h>
  24 #include <linux/init.h>
  25 #include <linux/slab.h>
  26 #include <linux/jiffies.h>
  27 #include <linux/i2c.h>
  28 #include <linux/hwmon.h>
  29 #include <linux/hwmon-sysfs.h>
  30 #include <linux/err.h>
  31 #include <linux/mutex.h>
  32 #include <linux/of_device.h>
  33 #include <linux/sysfs.h>
  34
  35 /* Addresses to scan */
  36 static const unsigned short normal_i2c[] = { 0x2a, 0x4c, 0x4d, 0x4e, 0x4f,
  37                                              I2C_CLIENT_END };
  38
  39 enum chips { tmp421, tmp422, tmp423, tmp441, tmp442 };
  40
  41 /* The TMP421 registers */
  42 #define TMP421_STATUS_REG                       0x08
  43 #define TMP421_CONFIG_REG_1                     0x09
  44 #define TMP421_CONVERSION_RATE_REG              0x0B
  45 #define TMP421_MANUFACTURER_ID_REG              0xFE
  46 #define TMP421_DEVICE_ID_REG                    0xFF
  47
  48 static const u8 TMP421_TEMP_MSB[4]              = { 0x00, 0x01, 0x02, 0x03 };
  49 static const u8 TMP421_TEMP_LSB[4]              = { 0x10, 0x11, 0x12, 0x13 };
  50
  51 /* Flags */
  52 #define TMP421_CONFIG_SHUTDOWN                  0x40
  53 #define TMP421_CONFIG_RANGE                     0x04
  54
  55 /* Manufacturer / Device ID's */
  56 #define TMP421_MANUFACTURER_ID                  0x55
  57 #define TMP421_DEVICE_ID                        0x21
  58 #define TMP422_DEVICE_ID                        0x22
  59 #define TMP423_DEVICE_ID                        0x23
  60 #define TMP441_DEVICE_ID                        0x41
  61 #define TMP442_DEVICE_ID                        0x42
  62
  63 static const struct i2c_device_id tmp421_id[] = {
  64         { "tmp421", 2 },
  65         { "tmp422", 3 },
  66         { "tmp423", 4 },
  67         { "tmp441", 2 },
  68         { "tmp442", 3 },
  69         { }
  70 };
  71 MODULE_DEVICE_TABLE(i2c, tmp421_id);
  72
  73 static const struct of_device_id tmp421_of_match[] = {
  74         {
  75                 .compatible = "ti,tmp421",
  76                 .data = (void *)2
  77         },
  78         {
  79                 .compatible = "ti,tmp422",
  80                 .data = (void *)3
  81         },
  82         {
  83                 .compatible = "ti,tmp423",
  84                 .data = (void *)4
  85         },
  86         {
  87                 .compatible = "ti,tmp441",
  88                 .data = (void *)2
  89         },
  90         {
  91                 .compatible = "ti,tmp442",
  92                 .data = (void *)3
  93         },
  94         { },
  95 };
  96 MODULE_DEVICE_TABLE(of, tmp421_of_match);
  97
  98 struct tmp421_data {
  99         struct i2c_client *client;
 100         struct mutex update_lock;
 101         u32 temp_config[5];
 102         struct hwmon_channel_info temp_info;
 103         const struct hwmon_channel_info *info[2];
 104         struct hwmon_chip_info chip;
 105         char valid;
 106         unsigned long last_updated;
 107         unsigned long channels;
 108         u8 config;
 109         s16 temp[4];
 110 };
 111
 112 static int temp_from_raw(u16 reg, bool extended)
 113 {
 114         /* Mask out status bits */
 115         int temp = reg & ~0xf;
 116
 117         if (extended)
 118                 temp = temp - 64 * 256;
 119         else
 120                 temp = (s16)temp;
 121
 122         return DIV_ROUND_CLOSEST(temp * 1000, 256);
 123 }
 124
 125 static struct tmp421_data *tmp421_update_device(struct device *dev)
 126 {
 127         struct tmp421_data *data = dev_get_drvdata(dev);
 128         struct i2c_client *client = data->client;
 129         int i;
 130
 131         mutex_lock(&data->update_lock);
 132
 133         if (time_after(jiffies, data->last_updated + 2 * HZ) || !data->valid) {
 134                 data->config = i2c_smbus_read_byte_data(client,
 135                         TMP421_CONFIG_REG_1);
 136
 137                 for (i = 0; i < data->channels; i++) {
 138                         data->temp[i] = i2c_smbus_read_byte_data(client,
 139                                 TMP421_TEMP_MSB[i]) << 8;
 140                         data->temp[i] |= i2c_smbus_read_byte_data(client,
 141                                 TMP421_TEMP_LSB[i]);
 142                 }
 143                 data->last_updated = jiffies;
 144                 data->valid = 1;
 145         }
 146
 147         mutex_unlock(&data->update_lock);
 148
 149         return data;
 150 }
 151
 152 static int tmp421_read(struct device *dev, enum hwmon_sensor_types type,
 153                        u32 attr, int channel, long *val)
 154 {
 155         struct tmp421_data *tmp421 = tmp421_update_device(dev);
 156
 157         switch (attr) {
 158         case hwmon_temp_input:
 159                 *val = temp_from_raw(tmp421->temp[channel],
 160                                      tmp421->config & TMP421_CONFIG_RANGE);
 161                 return 0;
 162         case hwmon_temp_fault:
 163                 /*
 164                  * Any of OPEN or /PVLD bits indicate a hardware mulfunction
 165                  * and the conversion result may be incorrect
 166                  */
 167                 *val = !!(tmp421->temp[channel] & 0x03);
 168                 return 0;
 169         default:
 170                 return -EOPNOTSUPP;
 171         }
 172
 173 }
 174
 175 static umode_t tmp421_is_visible(const void *data, enum hwmon_sensor_types type,
 176                                  u32 attr, int channel)
 177 {
 178         switch (attr) {
 179         case hwmon_temp_fault:
 180         case hwmon_temp_input:
 181                 return 0444;
 182         default:
 183                 return 0;
 184         }
 185 }
 186
 187 static int tmp421_init_client(struct i2c_client *client)
 188 {
 189         int config, config_orig;
 190
 191         /* Set the conversion rate to 2 Hz */
 192         i2c_smbus_write_byte_data(client, TMP421_CONVERSION_RATE_REG, 0x05);
 193
 194         /* Start conversions (disable shutdown if necessary) */
 195         config = i2c_smbus_read_byte_data(client, TMP421_CONFIG_REG_1);
 196         if (config < 0) {
 197                 dev_err(&client->dev,
 198                         "Could not read configuration register (%d)\n", config);
 199                 return config;
 200         }
 201
 202         config_orig = config;
 203         config &= ~TMP421_CONFIG_SHUTDOWN;
 204
 205         if (config != config_orig) {
 206                 dev_info(&client->dev, "Enable monitoring chip\n");
 207                 i2c_smbus_write_byte_data(client, TMP421_CONFIG_REG_1, config);
 208         }
 209
 210         return 0;
 211 }
 212
 213 static int tmp421_detect(struct i2c_client *client,
 214                          struct i2c_board_info *info)
 215 {
 216         enum chips kind;
 217         struct i2c_adapter *adapter = client->adapter;
 218         const char * const names[] = { "TMP421", "TMP422", "TMP423",
 219                                        "TMP441", "TMP442" };
 220         int addr = client->addr;
 221         u8 reg;
 222
 223         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
 224                 return -ENODEV;
 225
 226         reg = i2c_smbus_read_byte_data(client, TMP421_MANUFACTURER_ID_REG);
 227         if (reg != TMP421_MANUFACTURER_ID)
 228                 return -ENODEV;
 229
 230         reg = i2c_smbus_read_byte_data(client, TMP421_CONVERSION_RATE_REG);
 231         if (reg & 0xf8)
 232                 return -ENODEV;
 233
 234         reg = i2c_smbus_read_byte_data(client, TMP421_STATUS_REG);
 235         if (reg & 0x7f)
 236                 return -ENODEV;
 237
 238         reg = i2c_smbus_read_byte_data(client, TMP421_DEVICE_ID_REG);
 239         switch (reg) {
 240         case TMP421_DEVICE_ID:
 241                 kind = tmp421;
 242                 break;
 243         case TMP422_DEVICE_ID:
 244                 if (addr == 0x2a)
 245                         return -ENODEV;
 246                 kind = tmp422;
 247                 break;
 248         case TMP423_DEVICE_ID:
 249                 if (addr != 0x4c && addr != 0x4d)
 250                         return -ENODEV;
 251                 kind = tmp423;
 252                 break;
 253         case TMP441_DEVICE_ID:
 254                 kind = tmp441;
 255                 break;
 256         case TMP442_DEVICE_ID:
 257                 if (addr != 0x4c && addr != 0x4d)
 258                         return -ENODEV;
 259                 kind = tmp442;
 260                 break;
 261         default:
 262                 return -ENODEV;
 263         }
 264
 265         strlcpy(info->type, tmp421_id[kind].name, I2C_NAME_SIZE);
 266         dev_info(&adapter->dev, "Detected TI %s chip at 0x%02x\n",
 267                  names[kind], client->addr);
 268
 269         return 0;
 270 }
 271
 272 static const struct hwmon_ops tmp421_ops = {
 273         .is_visible = tmp421_is_visible,
 274         .read = tmp421_read,
 275 };
 276
 277 static int tmp421_probe(struct i2c_client *client,
 278                         const struct i2c_device_id *id)
 279 {
 280         struct device *dev = &client->dev;
 281         struct device *hwmon_dev;
 282         struct tmp421_data *data;
 283         int i, err;
 284
 285         data = devm_kzalloc(dev, sizeof(struct tmp421_data), GFP_KERNEL);
 286         if (!data)
 287                 return -ENOMEM;
 288
 289         mutex_init(&data->update_lock);
 290         if (client->dev.of_node)
 291                 data->channels = (unsigned long)
 292                         of_device_get_match_data(&client->dev);
 293         else
 294                 data->channels = id->driver_data;
 295         data->client = client;
 296
 297         err = tmp421_init_client(client);
 298         if (err)
 299                 return err;
 300
 301         for (i = 0; i < data->channels; i++)
 302                 data->temp_config[i] = HWMON_T_INPUT | HWMON_T_FAULT;
 303
 304         data->chip.ops = &tmp421_ops;
 305         data->chip.info = data->info;
 306
 307         data->info[0] = &data->temp_info;
 308
 309         data->temp_info.type = hwmon_temp;
 310         data->temp_info.config = data->temp_config;
 311
 312         hwmon_dev = devm_hwmon_device_register_with_info(dev, client->name,
 313                                                          data,
 314                                                          &data->chip,
 315                                                          NULL);
 316         return PTR_ERR_OR_ZERO(hwmon_dev);
 317 }
 318
 319 static struct i2c_driver tmp421_driver = {
 320         .class = I2C_CLASS_HWMON,
 321         .driver = {
 322                 .name   = "tmp421",
 323                 .of_match_table = of_match_ptr(tmp421_of_match),
 324         },
 325         .probe = tmp421_probe,
 326         .id_table = tmp421_id,
 327         .detect = tmp421_detect,
 328         .address_list = normal_i2c,
 329 };
 330
 331 module_i2c_driver(tmp421_driver);
 332
 333 MODULE_AUTHOR("Andre Prendel <andre.prendel@gmx.de>");
 334 MODULE_DESCRIPTION("Texas Instruments TMP421/422/423/441/442 temperature sensor driver");
 335 MODULE_LICENSE("GPL");