adm1021.c 14 KB

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