1 /* 2 * adm1021.c - Part of lm_sensors, Linux kernel modules for hardware 3 * monitoring 4 * Copyright (c) 1998, 1999 Frodo Looijaard <frodol@dds.nl> and 5 * Philip Edelbrock <phil@netroedge.com> 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 * You should have received a copy of the GNU General Public License 18 * along with this program; if not, write to the Free Software 19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 20 */ 21 22 #include <linux/module.h> 23 #include <linux/init.h> 24 #include <linux/slab.h> 25 #include <linux/jiffies.h> 26 #include <linux/i2c.h> 27 #include <linux/hwmon.h> 28 #include <linux/hwmon-sysfs.h> 29 #include <linux/err.h> 30 #include <linux/mutex.h> 31 32 33 /* Addresses to scan */ 34 static const unsigned short normal_i2c[] = { 35 0x18, 0x19, 0x1a, 0x29, 0x2a, 0x2b, 0x4c, 0x4d, 0x4e, I2C_CLIENT_END }; 36 37 enum chips { 38 adm1021, adm1023, max1617, max1617a, thmc10, lm84, gl523sm, mc1066 }; 39 40 /* adm1021 constants specified below */ 41 42 /* The adm1021 registers */ 43 /* Read-only */ 44 /* For nr in 0-1 */ 45 #define ADM1021_REG_TEMP(nr) (nr) 46 #define ADM1021_REG_STATUS 0x02 47 /* 0x41 = AD, 0x49 = TI, 0x4D = Maxim, 0x23 = Genesys , 0x54 = Onsemi */ 48 #define ADM1021_REG_MAN_ID 0xFE 49 /* ADM1021 = 0x0X, ADM1023 = 0x3X */ 50 #define ADM1021_REG_DEV_ID 0xFF 51 /* These use different addresses for reading/writing */ 52 #define ADM1021_REG_CONFIG_R 0x03 53 #define ADM1021_REG_CONFIG_W 0x09 54 #define ADM1021_REG_CONV_RATE_R 0x04 55 #define ADM1021_REG_CONV_RATE_W 0x0A 56 /* These are for the ADM1023's additional precision on the remote temp sensor */ 57 #define ADM1023_REG_REM_TEMP_PREC 0x10 58 #define ADM1023_REG_REM_OFFSET 0x11 59 #define ADM1023_REG_REM_OFFSET_PREC 0x12 60 #define ADM1023_REG_REM_TOS_PREC 0x13 61 #define ADM1023_REG_REM_THYST_PREC 0x14 62 /* limits */ 63 /* For nr in 0-1 */ 64 #define ADM1021_REG_TOS_R(nr) (0x05 + 2 * (nr)) 65 #define ADM1021_REG_TOS_W(nr) (0x0B + 2 * (nr)) 66 #define ADM1021_REG_THYST_R(nr) (0x06 + 2 * (nr)) 67 #define ADM1021_REG_THYST_W(nr) (0x0C + 2 * (nr)) 68 /* write-only */ 69 #define ADM1021_REG_ONESHOT 0x0F 70 71 /* Initial values */ 72 73 /* 74 * Note: Even though I left the low and high limits named os and hyst, 75 * they don't quite work like a thermostat the way the LM75 does. I.e., 76 * a lower temp than THYST actually triggers an alarm instead of 77 * clearing it. Weird, ey? --Phil 78 */ 79 80 /* Each client has this additional data */ 81 struct adm1021_data { 82 struct i2c_client *client; 83 enum chips type; 84 85 const struct attribute_group *groups[3]; 86 87 struct mutex update_lock; 88 char valid; /* !=0 if following fields are valid */ 89 char low_power; /* !=0 if device in low power mode */ 90 unsigned long last_updated; /* In jiffies */ 91 92 int temp_max[2]; /* Register values */ 93 int temp_min[2]; 94 int temp[2]; 95 u8 alarms; 96 /* Special values for ADM1023 only */ 97 u8 remote_temp_offset; 98 u8 remote_temp_offset_prec; 99 }; 100 101 static int adm1021_probe(struct i2c_client *client, 102 const struct i2c_device_id *id); 103 static int adm1021_detect(struct i2c_client *client, 104 struct i2c_board_info *info); 105 static void adm1021_init_client(struct i2c_client *client); 106 static struct adm1021_data *adm1021_update_device(struct device *dev); 107 108 /* (amalysh) read only mode, otherwise any limit's writing confuse BIOS */ 109 static bool read_only; 110 111 112 static const struct i2c_device_id adm1021_id[] = { 113 { "adm1021", adm1021 }, 114 { "adm1023", adm1023 }, 115 { "max1617", max1617 }, 116 { "max1617a", max1617a }, 117 { "thmc10", thmc10 }, 118 { "lm84", lm84 }, 119 { "gl523sm", gl523sm }, 120 { "mc1066", mc1066 }, 121 { } 122 }; 123 MODULE_DEVICE_TABLE(i2c, adm1021_id); 124 125 /* This is the driver that will be inserted */ 126 static struct i2c_driver adm1021_driver = { 127 .class = I2C_CLASS_HWMON, 128 .driver = { 129 .name = "adm1021", 130 }, 131 .probe = adm1021_probe, 132 .id_table = adm1021_id, 133 .detect = adm1021_detect, 134 .address_list = normal_i2c, 135 }; 136 137 static ssize_t show_temp(struct device *dev, 138 struct device_attribute *devattr, char *buf) 139 { 140 int index = to_sensor_dev_attr(devattr)->index; 141 struct adm1021_data *data = adm1021_update_device(dev); 142 143 return sprintf(buf, "%d\n", data->temp[index]); 144 } 145 146 static ssize_t show_temp_max(struct device *dev, 147 struct device_attribute *devattr, char *buf) 148 { 149 int index = to_sensor_dev_attr(devattr)->index; 150 struct adm1021_data *data = adm1021_update_device(dev); 151 152 return sprintf(buf, "%d\n", data->temp_max[index]); 153 } 154 155 static ssize_t show_temp_min(struct device *dev, 156 struct device_attribute *devattr, char *buf) 157 { 158 int index = to_sensor_dev_attr(devattr)->index; 159 struct adm1021_data *data = adm1021_update_device(dev); 160 161 return sprintf(buf, "%d\n", data->temp_min[index]); 162 } 163 164 static ssize_t show_alarm(struct device *dev, struct device_attribute *attr, 165 char *buf) 166 { 167 int index = to_sensor_dev_attr(attr)->index; 168 struct adm1021_data *data = adm1021_update_device(dev); 169 return sprintf(buf, "%u\n", (data->alarms >> index) & 1); 170 } 171 172 static ssize_t show_alarms(struct device *dev, 173 struct device_attribute *attr, 174 char *buf) 175 { 176 struct adm1021_data *data = adm1021_update_device(dev); 177 return sprintf(buf, "%u\n", data->alarms); 178 } 179 180 static ssize_t set_temp_max(struct device *dev, 181 struct device_attribute *devattr, 182 const char *buf, size_t count) 183 { 184 int index = to_sensor_dev_attr(devattr)->index; 185 struct adm1021_data *data = dev_get_drvdata(dev); 186 struct i2c_client *client = data->client; 187 long temp; 188 int err; 189 190 err = kstrtol(buf, 10, &temp); 191 if (err) 192 return err; 193 temp /= 1000; 194 195 mutex_lock(&data->update_lock); 196 data->temp_max[index] = clamp_val(temp, -128, 127); 197 if (!read_only) 198 i2c_smbus_write_byte_data(client, ADM1021_REG_TOS_W(index), 199 data->temp_max[index]); 200 mutex_unlock(&data->update_lock); 201 202 return count; 203 } 204 205 static ssize_t set_temp_min(struct device *dev, 206 struct device_attribute *devattr, 207 const char *buf, size_t count) 208 { 209 int index = to_sensor_dev_attr(devattr)->index; 210 struct adm1021_data *data = dev_get_drvdata(dev); 211 struct i2c_client *client = data->client; 212 long temp; 213 int err; 214 215 err = kstrtol(buf, 10, &temp); 216 if (err) 217 return err; 218 temp /= 1000; 219 220 mutex_lock(&data->update_lock); 221 data->temp_min[index] = clamp_val(temp, -128, 127); 222 if (!read_only) 223 i2c_smbus_write_byte_data(client, ADM1021_REG_THYST_W(index), 224 data->temp_min[index]); 225 mutex_unlock(&data->update_lock); 226 227 return count; 228 } 229 230 static ssize_t show_low_power(struct device *dev, 231 struct device_attribute *devattr, char *buf) 232 { 233 struct adm1021_data *data = adm1021_update_device(dev); 234 return sprintf(buf, "%d\n", data->low_power); 235 } 236 237 static ssize_t set_low_power(struct device *dev, 238 struct device_attribute *devattr, 239 const char *buf, size_t count) 240 { 241 struct adm1021_data *data = dev_get_drvdata(dev); 242 struct i2c_client *client = data->client; 243 char low_power; 244 unsigned long val; 245 int err; 246 247 err = kstrtoul(buf, 10, &val); 248 if (err) 249 return err; 250 low_power = val != 0; 251 252 mutex_lock(&data->update_lock); 253 if (low_power != data->low_power) { 254 int config = i2c_smbus_read_byte_data( 255 client, ADM1021_REG_CONFIG_R); 256 data->low_power = low_power; 257 i2c_smbus_write_byte_data(client, ADM1021_REG_CONFIG_W, 258 (config & 0xBF) | (low_power << 6)); 259 } 260 mutex_unlock(&data->update_lock); 261 262 return count; 263 } 264 265 266 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0); 267 static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp_max, 268 set_temp_max, 0); 269 static SENSOR_DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO, show_temp_min, 270 set_temp_min, 0); 271 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 1); 272 static SENSOR_DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp_max, 273 set_temp_max, 1); 274 static SENSOR_DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp_min, 275 set_temp_min, 1); 276 static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, 6); 277 static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO, show_alarm, NULL, 5); 278 static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_alarm, NULL, 4); 279 static SENSOR_DEVICE_ATTR(temp2_min_alarm, S_IRUGO, show_alarm, NULL, 3); 280 static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_alarm, NULL, 2); 281 282 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL); 283 static DEVICE_ATTR(low_power, S_IWUSR | S_IRUGO, show_low_power, set_low_power); 284 285 static struct attribute *adm1021_attributes[] = { 286 &sensor_dev_attr_temp1_max.dev_attr.attr, 287 &sensor_dev_attr_temp1_input.dev_attr.attr, 288 &sensor_dev_attr_temp2_max.dev_attr.attr, 289 &sensor_dev_attr_temp2_input.dev_attr.attr, 290 &sensor_dev_attr_temp1_max_alarm.dev_attr.attr, 291 &sensor_dev_attr_temp2_max_alarm.dev_attr.attr, 292 &sensor_dev_attr_temp2_fault.dev_attr.attr, 293 &dev_attr_alarms.attr, 294 &dev_attr_low_power.attr, 295 NULL 296 }; 297 298 static const struct attribute_group adm1021_group = { 299 .attrs = adm1021_attributes, 300 }; 301 302 static struct attribute *adm1021_min_attributes[] = { 303 &sensor_dev_attr_temp1_min.dev_attr.attr, 304 &sensor_dev_attr_temp2_min.dev_attr.attr, 305 &sensor_dev_attr_temp1_min_alarm.dev_attr.attr, 306 &sensor_dev_attr_temp2_min_alarm.dev_attr.attr, 307 NULL 308 }; 309 310 static const struct attribute_group adm1021_min_group = { 311 .attrs = adm1021_min_attributes, 312 }; 313 314 /* Return 0 if detection is successful, -ENODEV otherwise */ 315 static int adm1021_detect(struct i2c_client *client, 316 struct i2c_board_info *info) 317 { 318 struct i2c_adapter *adapter = client->adapter; 319 const char *type_name; 320 int conv_rate, status, config, man_id, dev_id; 321 322 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) { 323 pr_debug("detect failed, smbus byte data not supported!\n"); 324 return -ENODEV; 325 } 326 327 status = i2c_smbus_read_byte_data(client, ADM1021_REG_STATUS); 328 conv_rate = i2c_smbus_read_byte_data(client, 329 ADM1021_REG_CONV_RATE_R); 330 config = i2c_smbus_read_byte_data(client, ADM1021_REG_CONFIG_R); 331 332 /* Check unused bits */ 333 if ((status & 0x03) || (config & 0x3F) || (conv_rate & 0xF8)) { 334 pr_debug("detect failed, chip not detected!\n"); 335 return -ENODEV; 336 } 337 338 /* Determine the chip type. */ 339 man_id = i2c_smbus_read_byte_data(client, ADM1021_REG_MAN_ID); 340 dev_id = i2c_smbus_read_byte_data(client, ADM1021_REG_DEV_ID); 341 342 if (man_id < 0 || dev_id < 0) 343 return -ENODEV; 344 345 if (man_id == 0x4d && dev_id == 0x01) 346 type_name = "max1617a"; 347 else if (man_id == 0x41) { 348 if ((dev_id & 0xF0) == 0x30) 349 type_name = "adm1023"; 350 else if ((dev_id & 0xF0) == 0x00) 351 type_name = "adm1021"; 352 else 353 return -ENODEV; 354 } else if (man_id == 0x49) 355 type_name = "thmc10"; 356 else if (man_id == 0x23) 357 type_name = "gl523sm"; 358 else if (man_id == 0x54) 359 type_name = "mc1066"; 360 else { 361 int lte, rte, lhi, rhi, llo, rlo; 362 363 /* extra checks for LM84 and MAX1617 to avoid misdetections */ 364 365 llo = i2c_smbus_read_byte_data(client, ADM1021_REG_THYST_R(0)); 366 rlo = i2c_smbus_read_byte_data(client, ADM1021_REG_THYST_R(1)); 367 368 /* fail if any of the additional register reads failed */ 369 if (llo < 0 || rlo < 0) 370 return -ENODEV; 371 372 lte = i2c_smbus_read_byte_data(client, ADM1021_REG_TEMP(0)); 373 rte = i2c_smbus_read_byte_data(client, ADM1021_REG_TEMP(1)); 374 lhi = i2c_smbus_read_byte_data(client, ADM1021_REG_TOS_R(0)); 375 rhi = i2c_smbus_read_byte_data(client, ADM1021_REG_TOS_R(1)); 376 377 /* 378 * Fail for negative temperatures and negative high limits. 379 * This check also catches read errors on the tested registers. 380 */ 381 if ((s8)lte < 0 || (s8)rte < 0 || (s8)lhi < 0 || (s8)rhi < 0) 382 return -ENODEV; 383 384 /* fail if all registers hold the same value */ 385 if (lte == rte && lte == lhi && lte == rhi && lte == llo 386 && lte == rlo) 387 return -ENODEV; 388 389 /* 390 * LM84 Mfr ID is in a different place, 391 * and it has more unused bits. 392 */ 393 if (conv_rate == 0x00 394 && (config & 0x7F) == 0x00 395 && (status & 0xAB) == 0x00) { 396 type_name = "lm84"; 397 } else { 398 /* fail if low limits are larger than high limits */ 399 if ((s8)llo > lhi || (s8)rlo > rhi) 400 return -ENODEV; 401 type_name = "max1617"; 402 } 403 } 404 405 pr_debug("Detected chip %s at adapter %d, address 0x%02x.\n", 406 type_name, i2c_adapter_id(adapter), client->addr); 407 strlcpy(info->type, type_name, I2C_NAME_SIZE); 408 409 return 0; 410 } 411 412 static int adm1021_probe(struct i2c_client *client, 413 const struct i2c_device_id *id) 414 { 415 struct device *dev = &client->dev; 416 struct adm1021_data *data; 417 struct device *hwmon_dev; 418 419 data = devm_kzalloc(dev, sizeof(struct adm1021_data), GFP_KERNEL); 420 if (!data) 421 return -ENOMEM; 422 423 data->client = client; 424 data->type = id->driver_data; 425 mutex_init(&data->update_lock); 426 427 /* Initialize the ADM1021 chip */ 428 if (data->type != lm84 && !read_only) 429 adm1021_init_client(client); 430 431 data->groups[0] = &adm1021_group; 432 if (data->type != lm84) 433 data->groups[1] = &adm1021_min_group; 434 435 hwmon_dev = devm_hwmon_device_register_with_groups(dev, client->name, 436 data, data->groups); 437 438 return PTR_ERR_OR_ZERO(hwmon_dev); 439 } 440 441 static void adm1021_init_client(struct i2c_client *client) 442 { 443 /* Enable ADC and disable suspend mode */ 444 i2c_smbus_write_byte_data(client, ADM1021_REG_CONFIG_W, 445 i2c_smbus_read_byte_data(client, ADM1021_REG_CONFIG_R) & 0xBF); 446 /* Set Conversion rate to 1/sec (this can be tinkered with) */ 447 i2c_smbus_write_byte_data(client, ADM1021_REG_CONV_RATE_W, 0x04); 448 } 449 450 static struct adm1021_data *adm1021_update_device(struct device *dev) 451 { 452 struct adm1021_data *data = dev_get_drvdata(dev); 453 struct i2c_client *client = data->client; 454 455 mutex_lock(&data->update_lock); 456 457 if (time_after(jiffies, data->last_updated + HZ + HZ / 2) 458 || !data->valid) { 459 int i; 460 461 dev_dbg(dev, "Starting adm1021 update\n"); 462 463 for (i = 0; i < 2; i++) { 464 data->temp[i] = 1000 * 465 (s8) i2c_smbus_read_byte_data( 466 client, ADM1021_REG_TEMP(i)); 467 data->temp_max[i] = 1000 * 468 (s8) i2c_smbus_read_byte_data( 469 client, ADM1021_REG_TOS_R(i)); 470 if (data->type != lm84) { 471 data->temp_min[i] = 1000 * 472 (s8) i2c_smbus_read_byte_data(client, 473 ADM1021_REG_THYST_R(i)); 474 } 475 } 476 data->alarms = i2c_smbus_read_byte_data(client, 477 ADM1021_REG_STATUS) & 0x7c; 478 if (data->type == adm1023) { 479 /* 480 * The ADM1023 provides 3 extra bits of precision for 481 * the remote sensor in extra registers. 482 */ 483 data->temp[1] += 125 * (i2c_smbus_read_byte_data( 484 client, ADM1023_REG_REM_TEMP_PREC) >> 5); 485 data->temp_max[1] += 125 * (i2c_smbus_read_byte_data( 486 client, ADM1023_REG_REM_TOS_PREC) >> 5); 487 data->temp_min[1] += 125 * (i2c_smbus_read_byte_data( 488 client, ADM1023_REG_REM_THYST_PREC) >> 5); 489 data->remote_temp_offset = 490 i2c_smbus_read_byte_data(client, 491 ADM1023_REG_REM_OFFSET); 492 data->remote_temp_offset_prec = 493 i2c_smbus_read_byte_data(client, 494 ADM1023_REG_REM_OFFSET_PREC); 495 } 496 data->last_updated = jiffies; 497 data->valid = 1; 498 } 499 500 mutex_unlock(&data->update_lock); 501 502 return data; 503 } 504 505 module_i2c_driver(adm1021_driver); 506 507 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl> and " 508 "Philip Edelbrock <phil@netroedge.com>"); 509 MODULE_DESCRIPTION("adm1021 driver"); 510 MODULE_LICENSE("GPL"); 511 512 module_param(read_only, bool, 0); 513 MODULE_PARM_DESC(read_only, "Don't set any values, read only mode"); 514