1 /* 2 * thmc50.c - Part of lm_sensors, Linux kernel modules for hardware 3 * monitoring 4 * Copyright (C) 2007 Krzysztof Helt <krzysztof.h1@wp.pl> 5 * Based on 2.4 driver by Frodo Looijaard <frodol@dds.nl> and 6 * Philip Edelbrock <phil@netroedge.com> 7 * 8 * This program is free software; you can redistribute it and/or modify 9 * it under the terms of the GNU General Public License as published by 10 * the Free Software Foundation; either version 2 of the License, or 11 * (at your option) any later version. 12 * 13 * This program is distributed in the hope that it will be useful, 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 * GNU General Public License for more details. 17 * 18 * You should have received a copy of the GNU General Public License 19 * along with this program; if not, write to the Free Software 20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 21 */ 22 23 #include <linux/module.h> 24 #include <linux/init.h> 25 #include <linux/slab.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 #include <linux/jiffies.h> 32 33 MODULE_LICENSE("GPL"); 34 35 /* Addresses to scan */ 36 static const unsigned short normal_i2c[] = { 0x2c, 0x2d, 0x2e, I2C_CLIENT_END }; 37 38 /* Insmod parameters */ 39 enum chips { thmc50, adm1022 }; 40 41 static unsigned short adm1022_temp3[16]; 42 static unsigned int adm1022_temp3_num; 43 module_param_array(adm1022_temp3, ushort, &adm1022_temp3_num, 0); 44 MODULE_PARM_DESC(adm1022_temp3, 45 "List of adapter,address pairs to enable 3rd temperature (ADM1022 only)"); 46 47 /* Many THMC50 constants specified below */ 48 49 /* The THMC50 registers */ 50 #define THMC50_REG_CONF 0x40 51 #define THMC50_REG_COMPANY_ID 0x3E 52 #define THMC50_REG_DIE_CODE 0x3F 53 #define THMC50_REG_ANALOG_OUT 0x19 54 /* 55 * The mirror status register cannot be used as 56 * reading it does not clear alarms. 57 */ 58 #define THMC50_REG_INTR 0x41 59 60 static const u8 THMC50_REG_TEMP[] = { 0x27, 0x26, 0x20 }; 61 static const u8 THMC50_REG_TEMP_MIN[] = { 0x3A, 0x38, 0x2C }; 62 static const u8 THMC50_REG_TEMP_MAX[] = { 0x39, 0x37, 0x2B }; 63 static const u8 THMC50_REG_TEMP_CRITICAL[] = { 0x13, 0x14, 0x14 }; 64 static const u8 THMC50_REG_TEMP_DEFAULT[] = { 0x17, 0x18, 0x18 }; 65 66 #define THMC50_REG_CONF_nFANOFF 0x20 67 #define THMC50_REG_CONF_PROGRAMMED 0x08 68 69 /* Each client has this additional data */ 70 struct thmc50_data { 71 struct device *hwmon_dev; 72 73 struct mutex update_lock; 74 enum chips type; 75 unsigned long last_updated; /* In jiffies */ 76 char has_temp3; /* !=0 if it is ADM1022 in temp3 mode */ 77 char valid; /* !=0 if following fields are valid */ 78 79 /* Register values */ 80 s8 temp_input[3]; 81 s8 temp_max[3]; 82 s8 temp_min[3]; 83 s8 temp_critical[3]; 84 u8 analog_out; 85 u8 alarms; 86 }; 87 88 static int thmc50_detect(struct i2c_client *client, 89 struct i2c_board_info *info); 90 static int thmc50_probe(struct i2c_client *client, 91 const struct i2c_device_id *id); 92 static int thmc50_remove(struct i2c_client *client); 93 static void thmc50_init_client(struct i2c_client *client); 94 static struct thmc50_data *thmc50_update_device(struct device *dev); 95 96 static const struct i2c_device_id thmc50_id[] = { 97 { "adm1022", adm1022 }, 98 { "thmc50", thmc50 }, 99 { } 100 }; 101 MODULE_DEVICE_TABLE(i2c, thmc50_id); 102 103 static struct i2c_driver thmc50_driver = { 104 .class = I2C_CLASS_HWMON, 105 .driver = { 106 .name = "thmc50", 107 }, 108 .probe = thmc50_probe, 109 .remove = thmc50_remove, 110 .id_table = thmc50_id, 111 .detect = thmc50_detect, 112 .address_list = normal_i2c, 113 }; 114 115 static ssize_t show_analog_out(struct device *dev, 116 struct device_attribute *attr, char *buf) 117 { 118 struct thmc50_data *data = thmc50_update_device(dev); 119 return sprintf(buf, "%d\n", data->analog_out); 120 } 121 122 static ssize_t set_analog_out(struct device *dev, 123 struct device_attribute *attr, 124 const char *buf, size_t count) 125 { 126 struct i2c_client *client = to_i2c_client(dev); 127 struct thmc50_data *data = i2c_get_clientdata(client); 128 int config; 129 unsigned long tmp; 130 int err; 131 132 err = kstrtoul(buf, 10, &tmp); 133 if (err) 134 return err; 135 136 mutex_lock(&data->update_lock); 137 data->analog_out = clamp_val(tmp, 0, 255); 138 i2c_smbus_write_byte_data(client, THMC50_REG_ANALOG_OUT, 139 data->analog_out); 140 141 config = i2c_smbus_read_byte_data(client, THMC50_REG_CONF); 142 if (data->analog_out == 0) 143 config &= ~THMC50_REG_CONF_nFANOFF; 144 else 145 config |= THMC50_REG_CONF_nFANOFF; 146 i2c_smbus_write_byte_data(client, THMC50_REG_CONF, config); 147 148 mutex_unlock(&data->update_lock); 149 return count; 150 } 151 152 /* There is only one PWM mode = DC */ 153 static ssize_t show_pwm_mode(struct device *dev, struct device_attribute *attr, 154 char *buf) 155 { 156 return sprintf(buf, "0\n"); 157 } 158 159 /* Temperatures */ 160 static ssize_t show_temp(struct device *dev, struct device_attribute *attr, 161 char *buf) 162 { 163 int nr = to_sensor_dev_attr(attr)->index; 164 struct thmc50_data *data = thmc50_update_device(dev); 165 return sprintf(buf, "%d\n", data->temp_input[nr] * 1000); 166 } 167 168 static ssize_t show_temp_min(struct device *dev, struct device_attribute *attr, 169 char *buf) 170 { 171 int nr = to_sensor_dev_attr(attr)->index; 172 struct thmc50_data *data = thmc50_update_device(dev); 173 return sprintf(buf, "%d\n", data->temp_min[nr] * 1000); 174 } 175 176 static ssize_t set_temp_min(struct device *dev, struct device_attribute *attr, 177 const char *buf, size_t count) 178 { 179 int nr = to_sensor_dev_attr(attr)->index; 180 struct i2c_client *client = to_i2c_client(dev); 181 struct thmc50_data *data = i2c_get_clientdata(client); 182 long val; 183 int err; 184 185 err = kstrtol(buf, 10, &val); 186 if (err) 187 return err; 188 189 mutex_lock(&data->update_lock); 190 data->temp_min[nr] = clamp_val(val / 1000, -128, 127); 191 i2c_smbus_write_byte_data(client, THMC50_REG_TEMP_MIN[nr], 192 data->temp_min[nr]); 193 mutex_unlock(&data->update_lock); 194 return count; 195 } 196 197 static ssize_t show_temp_max(struct device *dev, struct device_attribute *attr, 198 char *buf) 199 { 200 int nr = to_sensor_dev_attr(attr)->index; 201 struct thmc50_data *data = thmc50_update_device(dev); 202 return sprintf(buf, "%d\n", data->temp_max[nr] * 1000); 203 } 204 205 static ssize_t set_temp_max(struct device *dev, struct device_attribute *attr, 206 const char *buf, size_t count) 207 { 208 int nr = to_sensor_dev_attr(attr)->index; 209 struct i2c_client *client = to_i2c_client(dev); 210 struct thmc50_data *data = i2c_get_clientdata(client); 211 long val; 212 int err; 213 214 err = kstrtol(buf, 10, &val); 215 if (err) 216 return err; 217 218 mutex_lock(&data->update_lock); 219 data->temp_max[nr] = clamp_val(val / 1000, -128, 127); 220 i2c_smbus_write_byte_data(client, THMC50_REG_TEMP_MAX[nr], 221 data->temp_max[nr]); 222 mutex_unlock(&data->update_lock); 223 return count; 224 } 225 226 static ssize_t show_temp_critical(struct device *dev, 227 struct device_attribute *attr, 228 char *buf) 229 { 230 int nr = to_sensor_dev_attr(attr)->index; 231 struct thmc50_data *data = thmc50_update_device(dev); 232 return sprintf(buf, "%d\n", data->temp_critical[nr] * 1000); 233 } 234 235 static ssize_t show_alarm(struct device *dev, struct device_attribute *attr, 236 char *buf) 237 { 238 int index = to_sensor_dev_attr(attr)->index; 239 struct thmc50_data *data = thmc50_update_device(dev); 240 241 return sprintf(buf, "%u\n", (data->alarms >> index) & 1); 242 } 243 244 #define temp_reg(offset) \ 245 static SENSOR_DEVICE_ATTR(temp##offset##_input, S_IRUGO, show_temp, \ 246 NULL, offset - 1); \ 247 static SENSOR_DEVICE_ATTR(temp##offset##_min, S_IRUGO | S_IWUSR, \ 248 show_temp_min, set_temp_min, offset - 1); \ 249 static SENSOR_DEVICE_ATTR(temp##offset##_max, S_IRUGO | S_IWUSR, \ 250 show_temp_max, set_temp_max, offset - 1); \ 251 static SENSOR_DEVICE_ATTR(temp##offset##_crit, S_IRUGO, \ 252 show_temp_critical, NULL, offset - 1); 253 254 temp_reg(1); 255 temp_reg(2); 256 temp_reg(3); 257 258 static SENSOR_DEVICE_ATTR(temp1_alarm, S_IRUGO, show_alarm, NULL, 0); 259 static SENSOR_DEVICE_ATTR(temp2_alarm, S_IRUGO, show_alarm, NULL, 5); 260 static SENSOR_DEVICE_ATTR(temp3_alarm, S_IRUGO, show_alarm, NULL, 1); 261 static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_alarm, NULL, 7); 262 static SENSOR_DEVICE_ATTR(temp3_fault, S_IRUGO, show_alarm, NULL, 2); 263 264 static SENSOR_DEVICE_ATTR(pwm1, S_IRUGO | S_IWUSR, show_analog_out, 265 set_analog_out, 0); 266 static SENSOR_DEVICE_ATTR(pwm1_mode, S_IRUGO, show_pwm_mode, NULL, 0); 267 268 static struct attribute *thmc50_attributes[] = { 269 &sensor_dev_attr_temp1_max.dev_attr.attr, 270 &sensor_dev_attr_temp1_min.dev_attr.attr, 271 &sensor_dev_attr_temp1_input.dev_attr.attr, 272 &sensor_dev_attr_temp1_crit.dev_attr.attr, 273 &sensor_dev_attr_temp1_alarm.dev_attr.attr, 274 &sensor_dev_attr_temp2_max.dev_attr.attr, 275 &sensor_dev_attr_temp2_min.dev_attr.attr, 276 &sensor_dev_attr_temp2_input.dev_attr.attr, 277 &sensor_dev_attr_temp2_crit.dev_attr.attr, 278 &sensor_dev_attr_temp2_alarm.dev_attr.attr, 279 &sensor_dev_attr_temp2_fault.dev_attr.attr, 280 &sensor_dev_attr_pwm1.dev_attr.attr, 281 &sensor_dev_attr_pwm1_mode.dev_attr.attr, 282 NULL 283 }; 284 285 static const struct attribute_group thmc50_group = { 286 .attrs = thmc50_attributes, 287 }; 288 289 /* for ADM1022 3rd temperature mode */ 290 static struct attribute *temp3_attributes[] = { 291 &sensor_dev_attr_temp3_max.dev_attr.attr, 292 &sensor_dev_attr_temp3_min.dev_attr.attr, 293 &sensor_dev_attr_temp3_input.dev_attr.attr, 294 &sensor_dev_attr_temp3_crit.dev_attr.attr, 295 &sensor_dev_attr_temp3_alarm.dev_attr.attr, 296 &sensor_dev_attr_temp3_fault.dev_attr.attr, 297 NULL 298 }; 299 300 static const struct attribute_group temp3_group = { 301 .attrs = temp3_attributes, 302 }; 303 304 /* Return 0 if detection is successful, -ENODEV otherwise */ 305 static int thmc50_detect(struct i2c_client *client, 306 struct i2c_board_info *info) 307 { 308 unsigned company; 309 unsigned revision; 310 unsigned config; 311 struct i2c_adapter *adapter = client->adapter; 312 const char *type_name; 313 314 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) { 315 pr_debug("thmc50: detect failed, smbus byte data not supported!\n"); 316 return -ENODEV; 317 } 318 319 pr_debug("thmc50: Probing for THMC50 at 0x%2X on bus %d\n", 320 client->addr, i2c_adapter_id(client->adapter)); 321 322 company = i2c_smbus_read_byte_data(client, THMC50_REG_COMPANY_ID); 323 revision = i2c_smbus_read_byte_data(client, THMC50_REG_DIE_CODE); 324 config = i2c_smbus_read_byte_data(client, THMC50_REG_CONF); 325 if (revision < 0xc0 || (config & 0x10)) 326 return -ENODEV; 327 328 if (company == 0x41) { 329 int id = i2c_adapter_id(client->adapter); 330 int i; 331 332 type_name = "adm1022"; 333 for (i = 0; i + 1 < adm1022_temp3_num; i += 2) 334 if (adm1022_temp3[i] == id && 335 adm1022_temp3[i + 1] == client->addr) { 336 /* enable 2nd remote temp */ 337 config |= (1 << 7); 338 i2c_smbus_write_byte_data(client, 339 THMC50_REG_CONF, 340 config); 341 break; 342 } 343 } else if (company == 0x49) { 344 type_name = "thmc50"; 345 } else { 346 pr_debug("thmc50: Detection of THMC50/ADM1022 failed\n"); 347 return -ENODEV; 348 } 349 350 pr_debug("thmc50: Detected %s (version %x, revision %x)\n", 351 type_name, (revision >> 4) - 0xc, revision & 0xf); 352 353 strlcpy(info->type, type_name, I2C_NAME_SIZE); 354 355 return 0; 356 } 357 358 static int thmc50_probe(struct i2c_client *client, 359 const struct i2c_device_id *id) 360 { 361 struct thmc50_data *data; 362 int err; 363 364 data = devm_kzalloc(&client->dev, sizeof(struct thmc50_data), 365 GFP_KERNEL); 366 if (!data) 367 return -ENOMEM; 368 369 i2c_set_clientdata(client, data); 370 data->type = id->driver_data; 371 mutex_init(&data->update_lock); 372 373 thmc50_init_client(client); 374 375 /* Register sysfs hooks */ 376 err = sysfs_create_group(&client->dev.kobj, &thmc50_group); 377 if (err) 378 return err; 379 380 /* Register ADM1022 sysfs hooks */ 381 if (data->has_temp3) { 382 err = sysfs_create_group(&client->dev.kobj, &temp3_group); 383 if (err) 384 goto exit_remove_sysfs_thmc50; 385 } 386 387 /* Register a new directory entry with module sensors */ 388 data->hwmon_dev = hwmon_device_register(&client->dev); 389 if (IS_ERR(data->hwmon_dev)) { 390 err = PTR_ERR(data->hwmon_dev); 391 goto exit_remove_sysfs; 392 } 393 394 return 0; 395 396 exit_remove_sysfs: 397 if (data->has_temp3) 398 sysfs_remove_group(&client->dev.kobj, &temp3_group); 399 exit_remove_sysfs_thmc50: 400 sysfs_remove_group(&client->dev.kobj, &thmc50_group); 401 return err; 402 } 403 404 static int thmc50_remove(struct i2c_client *client) 405 { 406 struct thmc50_data *data = i2c_get_clientdata(client); 407 408 hwmon_device_unregister(data->hwmon_dev); 409 sysfs_remove_group(&client->dev.kobj, &thmc50_group); 410 if (data->has_temp3) 411 sysfs_remove_group(&client->dev.kobj, &temp3_group); 412 413 return 0; 414 } 415 416 static void thmc50_init_client(struct i2c_client *client) 417 { 418 struct thmc50_data *data = i2c_get_clientdata(client); 419 int config; 420 421 data->analog_out = i2c_smbus_read_byte_data(client, 422 THMC50_REG_ANALOG_OUT); 423 /* set up to at least 1 */ 424 if (data->analog_out == 0) { 425 data->analog_out = 1; 426 i2c_smbus_write_byte_data(client, THMC50_REG_ANALOG_OUT, 427 data->analog_out); 428 } 429 config = i2c_smbus_read_byte_data(client, THMC50_REG_CONF); 430 config |= 0x1; /* start the chip if it is in standby mode */ 431 if (data->type == adm1022 && (config & (1 << 7))) 432 data->has_temp3 = 1; 433 i2c_smbus_write_byte_data(client, THMC50_REG_CONF, config); 434 } 435 436 static struct thmc50_data *thmc50_update_device(struct device *dev) 437 { 438 struct i2c_client *client = to_i2c_client(dev); 439 struct thmc50_data *data = i2c_get_clientdata(client); 440 int timeout = HZ / 5 + (data->type == thmc50 ? HZ : 0); 441 442 mutex_lock(&data->update_lock); 443 444 if (time_after(jiffies, data->last_updated + timeout) 445 || !data->valid) { 446 447 int temps = data->has_temp3 ? 3 : 2; 448 int i; 449 int prog = i2c_smbus_read_byte_data(client, THMC50_REG_CONF); 450 451 prog &= THMC50_REG_CONF_PROGRAMMED; 452 453 for (i = 0; i < temps; i++) { 454 data->temp_input[i] = i2c_smbus_read_byte_data(client, 455 THMC50_REG_TEMP[i]); 456 data->temp_max[i] = i2c_smbus_read_byte_data(client, 457 THMC50_REG_TEMP_MAX[i]); 458 data->temp_min[i] = i2c_smbus_read_byte_data(client, 459 THMC50_REG_TEMP_MIN[i]); 460 data->temp_critical[i] = 461 i2c_smbus_read_byte_data(client, 462 prog ? THMC50_REG_TEMP_CRITICAL[i] 463 : THMC50_REG_TEMP_DEFAULT[i]); 464 } 465 data->analog_out = 466 i2c_smbus_read_byte_data(client, THMC50_REG_ANALOG_OUT); 467 data->alarms = 468 i2c_smbus_read_byte_data(client, THMC50_REG_INTR); 469 data->last_updated = jiffies; 470 data->valid = 1; 471 } 472 473 mutex_unlock(&data->update_lock); 474 475 return data; 476 } 477 478 module_i2c_driver(thmc50_driver); 479 480 MODULE_AUTHOR("Krzysztof Helt <krzysztof.h1@wp.pl>"); 481 MODULE_DESCRIPTION("THMC50 driver"); 482