1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * adm1029.c - Part of lm_sensors, Linux kernel modules for hardware monitoring 4 * 5 * Copyright (C) 2006 Corentin LABBE <clabbe.montjoie@gmail.com> 6 * 7 * Based on LM83 Driver by Jean Delvare <jdelvare@suse.de> 8 * 9 * Give only processor, motherboard temperatures and fan tachs 10 * Very rare chip please let me know if you use it 11 * 12 * http://www.analog.com/UploadedFiles/Data_Sheets/ADM1029.pdf 13 */ 14 15 #include <linux/module.h> 16 #include <linux/init.h> 17 #include <linux/slab.h> 18 #include <linux/jiffies.h> 19 #include <linux/i2c.h> 20 #include <linux/hwmon-sysfs.h> 21 #include <linux/hwmon.h> 22 #include <linux/err.h> 23 #include <linux/mutex.h> 24 25 /* 26 * Addresses to scan 27 */ 28 29 static const unsigned short normal_i2c[] = { 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 30 0x2e, 0x2f, I2C_CLIENT_END 31 }; 32 33 /* 34 * The ADM1029 registers 35 * Manufacturer ID is 0x41 for Analog Devices 36 */ 37 38 #define ADM1029_REG_MAN_ID 0x0D 39 #define ADM1029_REG_CHIP_ID 0x0E 40 #define ADM1029_REG_CONFIG 0x01 41 #define ADM1029_REG_NB_FAN_SUPPORT 0x02 42 43 #define ADM1029_REG_TEMP_DEVICES_INSTALLED 0x06 44 45 #define ADM1029_REG_LOCAL_TEMP 0xA0 46 #define ADM1029_REG_REMOTE1_TEMP 0xA1 47 #define ADM1029_REG_REMOTE2_TEMP 0xA2 48 49 #define ADM1029_REG_LOCAL_TEMP_HIGH 0x90 50 #define ADM1029_REG_REMOTE1_TEMP_HIGH 0x91 51 #define ADM1029_REG_REMOTE2_TEMP_HIGH 0x92 52 53 #define ADM1029_REG_LOCAL_TEMP_LOW 0x98 54 #define ADM1029_REG_REMOTE1_TEMP_LOW 0x99 55 #define ADM1029_REG_REMOTE2_TEMP_LOW 0x9A 56 57 #define ADM1029_REG_FAN1 0x70 58 #define ADM1029_REG_FAN2 0x71 59 60 #define ADM1029_REG_FAN1_MIN 0x78 61 #define ADM1029_REG_FAN2_MIN 0x79 62 63 #define ADM1029_REG_FAN1_CONFIG 0x68 64 #define ADM1029_REG_FAN2_CONFIG 0x69 65 66 #define TEMP_FROM_REG(val) ((val) * 1000) 67 68 #define DIV_FROM_REG(val) (1 << (((val) >> 6) - 1)) 69 70 /* Registers to be checked by adm1029_update_device() */ 71 static const u8 ADM1029_REG_TEMP[] = { 72 ADM1029_REG_LOCAL_TEMP, 73 ADM1029_REG_REMOTE1_TEMP, 74 ADM1029_REG_REMOTE2_TEMP, 75 ADM1029_REG_LOCAL_TEMP_HIGH, 76 ADM1029_REG_REMOTE1_TEMP_HIGH, 77 ADM1029_REG_REMOTE2_TEMP_HIGH, 78 ADM1029_REG_LOCAL_TEMP_LOW, 79 ADM1029_REG_REMOTE1_TEMP_LOW, 80 ADM1029_REG_REMOTE2_TEMP_LOW, 81 }; 82 83 static const u8 ADM1029_REG_FAN[] = { 84 ADM1029_REG_FAN1, 85 ADM1029_REG_FAN2, 86 ADM1029_REG_FAN1_MIN, 87 ADM1029_REG_FAN2_MIN, 88 }; 89 90 static const u8 ADM1029_REG_FAN_DIV[] = { 91 ADM1029_REG_FAN1_CONFIG, 92 ADM1029_REG_FAN2_CONFIG, 93 }; 94 95 /* 96 * Client data (each client gets its own) 97 */ 98 99 struct adm1029_data { 100 struct i2c_client *client; 101 struct mutex update_lock; /* protect register access */ 102 bool valid; /* false until following fields are valid */ 103 unsigned long last_updated; /* in jiffies */ 104 105 /* registers values, signed for temperature, unsigned for other stuff */ 106 s8 temp[ARRAY_SIZE(ADM1029_REG_TEMP)]; 107 u8 fan[ARRAY_SIZE(ADM1029_REG_FAN)]; 108 u8 fan_div[ARRAY_SIZE(ADM1029_REG_FAN_DIV)]; 109 }; 110 111 /* 112 * function that update the status of the chips (temperature for example) 113 */ 114 static struct adm1029_data *adm1029_update_device(struct device *dev) 115 { 116 struct adm1029_data *data = dev_get_drvdata(dev); 117 struct i2c_client *client = data->client; 118 119 mutex_lock(&data->update_lock); 120 /* 121 * Use the "cache" Luke, don't recheck values 122 * if there are already checked not a long time later 123 */ 124 if (time_after(jiffies, data->last_updated + HZ * 2) || !data->valid) { 125 int nr; 126 127 dev_dbg(&client->dev, "Updating adm1029 data\n"); 128 129 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_TEMP); nr++) { 130 data->temp[nr] = 131 i2c_smbus_read_byte_data(client, 132 ADM1029_REG_TEMP[nr]); 133 } 134 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_FAN); nr++) { 135 data->fan[nr] = 136 i2c_smbus_read_byte_data(client, 137 ADM1029_REG_FAN[nr]); 138 } 139 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_FAN_DIV); nr++) { 140 data->fan_div[nr] = 141 i2c_smbus_read_byte_data(client, 142 ADM1029_REG_FAN_DIV[nr]); 143 } 144 145 data->last_updated = jiffies; 146 data->valid = true; 147 } 148 149 mutex_unlock(&data->update_lock); 150 151 return data; 152 } 153 154 /* 155 * Sysfs stuff 156 */ 157 158 static ssize_t 159 temp_show(struct device *dev, struct device_attribute *devattr, char *buf) 160 { 161 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); 162 struct adm1029_data *data = adm1029_update_device(dev); 163 164 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[attr->index])); 165 } 166 167 static ssize_t 168 fan_show(struct device *dev, struct device_attribute *devattr, char *buf) 169 { 170 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); 171 struct adm1029_data *data = adm1029_update_device(dev); 172 u16 val; 173 174 mutex_lock(&data->update_lock); 175 if (data->fan[attr->index] == 0 || 176 (data->fan_div[attr->index] & 0xC0) == 0 || 177 data->fan[attr->index] == 255) { 178 mutex_unlock(&data->update_lock); 179 return sprintf(buf, "0\n"); 180 } 181 182 val = 1880 * 120 / DIV_FROM_REG(data->fan_div[attr->index]) 183 / data->fan[attr->index]; 184 mutex_unlock(&data->update_lock); 185 return sprintf(buf, "%d\n", val); 186 } 187 188 static ssize_t 189 fan_div_show(struct device *dev, struct device_attribute *devattr, char *buf) 190 { 191 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); 192 struct adm1029_data *data = adm1029_update_device(dev); 193 194 if ((data->fan_div[attr->index] & 0xC0) == 0) 195 return sprintf(buf, "0\n"); 196 return sprintf(buf, "%d\n", DIV_FROM_REG(data->fan_div[attr->index])); 197 } 198 199 static ssize_t fan_div_store(struct device *dev, 200 struct device_attribute *devattr, 201 const char *buf, size_t count) 202 { 203 struct adm1029_data *data = dev_get_drvdata(dev); 204 struct i2c_client *client = data->client; 205 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); 206 u8 reg; 207 long val; 208 int ret = kstrtol(buf, 10, &val); 209 210 if (ret < 0) 211 return ret; 212 213 mutex_lock(&data->update_lock); 214 215 /*Read actual config */ 216 reg = i2c_smbus_read_byte_data(client, 217 ADM1029_REG_FAN_DIV[attr->index]); 218 219 switch (val) { 220 case 1: 221 val = 1; 222 break; 223 case 2: 224 val = 2; 225 break; 226 case 4: 227 val = 3; 228 break; 229 default: 230 mutex_unlock(&data->update_lock); 231 dev_err(&client->dev, 232 "fan_div value %ld not supported. Choose one of 1, 2 or 4!\n", 233 val); 234 return -EINVAL; 235 } 236 /* Update the value */ 237 reg = (reg & 0x3F) | (val << 6); 238 239 /* Update the cache */ 240 data->fan_div[attr->index] = reg; 241 242 /* Write value */ 243 i2c_smbus_write_byte_data(client, 244 ADM1029_REG_FAN_DIV[attr->index], reg); 245 mutex_unlock(&data->update_lock); 246 247 return count; 248 } 249 250 /* Access rights on sysfs. */ 251 static SENSOR_DEVICE_ATTR_RO(temp1_input, temp, 0); 252 static SENSOR_DEVICE_ATTR_RO(temp2_input, temp, 1); 253 static SENSOR_DEVICE_ATTR_RO(temp3_input, temp, 2); 254 255 static SENSOR_DEVICE_ATTR_RO(temp1_max, temp, 3); 256 static SENSOR_DEVICE_ATTR_RO(temp2_max, temp, 4); 257 static SENSOR_DEVICE_ATTR_RO(temp3_max, temp, 5); 258 259 static SENSOR_DEVICE_ATTR_RO(temp1_min, temp, 6); 260 static SENSOR_DEVICE_ATTR_RO(temp2_min, temp, 7); 261 static SENSOR_DEVICE_ATTR_RO(temp3_min, temp, 8); 262 263 static SENSOR_DEVICE_ATTR_RO(fan1_input, fan, 0); 264 static SENSOR_DEVICE_ATTR_RO(fan2_input, fan, 1); 265 266 static SENSOR_DEVICE_ATTR_RO(fan1_min, fan, 2); 267 static SENSOR_DEVICE_ATTR_RO(fan2_min, fan, 3); 268 269 static SENSOR_DEVICE_ATTR_RW(fan1_div, fan_div, 0); 270 static SENSOR_DEVICE_ATTR_RW(fan2_div, fan_div, 1); 271 272 static struct attribute *adm1029_attrs[] = { 273 &sensor_dev_attr_temp1_input.dev_attr.attr, 274 &sensor_dev_attr_temp1_min.dev_attr.attr, 275 &sensor_dev_attr_temp1_max.dev_attr.attr, 276 &sensor_dev_attr_temp2_input.dev_attr.attr, 277 &sensor_dev_attr_temp2_min.dev_attr.attr, 278 &sensor_dev_attr_temp2_max.dev_attr.attr, 279 &sensor_dev_attr_temp3_input.dev_attr.attr, 280 &sensor_dev_attr_temp3_min.dev_attr.attr, 281 &sensor_dev_attr_temp3_max.dev_attr.attr, 282 &sensor_dev_attr_fan1_input.dev_attr.attr, 283 &sensor_dev_attr_fan2_input.dev_attr.attr, 284 &sensor_dev_attr_fan1_min.dev_attr.attr, 285 &sensor_dev_attr_fan2_min.dev_attr.attr, 286 &sensor_dev_attr_fan1_div.dev_attr.attr, 287 &sensor_dev_attr_fan2_div.dev_attr.attr, 288 NULL 289 }; 290 291 ATTRIBUTE_GROUPS(adm1029); 292 293 /* 294 * Real code 295 */ 296 297 /* Return 0 if detection is successful, -ENODEV otherwise */ 298 static int adm1029_detect(struct i2c_client *client, 299 struct i2c_board_info *info) 300 { 301 struct i2c_adapter *adapter = client->adapter; 302 u8 man_id, chip_id, temp_devices_installed, nb_fan_support; 303 304 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) 305 return -ENODEV; 306 307 /* 308 * ADM1029 doesn't have CHIP ID, check just MAN ID 309 * For better detection we check also ADM1029_TEMP_DEVICES_INSTALLED, 310 * ADM1029_REG_NB_FAN_SUPPORT and compare it with possible values 311 * documented 312 */ 313 314 man_id = i2c_smbus_read_byte_data(client, ADM1029_REG_MAN_ID); 315 chip_id = i2c_smbus_read_byte_data(client, ADM1029_REG_CHIP_ID); 316 temp_devices_installed = i2c_smbus_read_byte_data(client, 317 ADM1029_REG_TEMP_DEVICES_INSTALLED); 318 nb_fan_support = i2c_smbus_read_byte_data(client, 319 ADM1029_REG_NB_FAN_SUPPORT); 320 /* 0x41 is Analog Devices */ 321 if (man_id != 0x41 || (temp_devices_installed & 0xf9) != 0x01 || 322 nb_fan_support != 0x03) 323 return -ENODEV; 324 325 if ((chip_id & 0xF0) != 0x00) { 326 /* 327 * There are no "official" CHIP ID, so actually 328 * we use Major/Minor revision for that 329 */ 330 pr_info("Unknown major revision %x, please let us know\n", 331 chip_id); 332 return -ENODEV; 333 } 334 335 strscpy(info->type, "adm1029", I2C_NAME_SIZE); 336 337 return 0; 338 } 339 340 static int adm1029_init_client(struct i2c_client *client) 341 { 342 u8 config; 343 344 config = i2c_smbus_read_byte_data(client, ADM1029_REG_CONFIG); 345 if ((config & 0x10) == 0) { 346 i2c_smbus_write_byte_data(client, ADM1029_REG_CONFIG, 347 config | 0x10); 348 } 349 /* recheck config */ 350 config = i2c_smbus_read_byte_data(client, ADM1029_REG_CONFIG); 351 if ((config & 0x10) == 0) { 352 dev_err(&client->dev, "Initialization failed!\n"); 353 return 0; 354 } 355 return 1; 356 } 357 358 static int adm1029_probe(struct i2c_client *client) 359 { 360 struct device *dev = &client->dev; 361 struct adm1029_data *data; 362 struct device *hwmon_dev; 363 364 data = devm_kzalloc(dev, sizeof(struct adm1029_data), GFP_KERNEL); 365 if (!data) 366 return -ENOMEM; 367 368 data->client = client; 369 mutex_init(&data->update_lock); 370 371 /* 372 * Initialize the ADM1029 chip 373 * Check config register 374 */ 375 if (adm1029_init_client(client) == 0) 376 return -ENODEV; 377 378 hwmon_dev = devm_hwmon_device_register_with_groups(dev, client->name, 379 data, 380 adm1029_groups); 381 return PTR_ERR_OR_ZERO(hwmon_dev); 382 } 383 384 static const struct i2c_device_id adm1029_id[] = { 385 { "adm1029" }, 386 { } 387 }; 388 MODULE_DEVICE_TABLE(i2c, adm1029_id); 389 390 static struct i2c_driver adm1029_driver = { 391 .class = I2C_CLASS_HWMON, 392 .driver = { 393 .name = "adm1029", 394 }, 395 .probe = adm1029_probe, 396 .id_table = adm1029_id, 397 .detect = adm1029_detect, 398 .address_list = normal_i2c, 399 }; 400 401 module_i2c_driver(adm1029_driver); 402 403 MODULE_AUTHOR("Corentin LABBE <clabbe.montjoie@gmail.com>"); 404 MODULE_DESCRIPTION("adm1029 driver"); 405 MODULE_LICENSE("GPL v2"); 406