/drivers/hwmon/lm83.c

http://github.com/mirrors/linux · C · 376 lines · 263 code · 54 blank · 59 comment · 12 complexity · 48a115bd1b2a1db16f82345ca5a298bb MD5 · raw file

  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * lm83.c - Part of lm_sensors, Linux kernel modules for hardware
  4. * monitoring
  5. * Copyright (C) 2003-2009 Jean Delvare <jdelvare@suse.de>
  6. *
  7. * Heavily inspired from the lm78, lm75 and adm1021 drivers. The LM83 is
  8. * a sensor chip made by National Semiconductor. It reports up to four
  9. * temperatures (its own plus up to three external ones) with a 1 deg
  10. * resolution and a 3-4 deg accuracy. Complete datasheet can be obtained
  11. * from National's website at:
  12. * http://www.national.com/pf/LM/LM83.html
  13. * Since the datasheet omits to give the chip stepping code, I give it
  14. * here: 0x03 (at register 0xff).
  15. *
  16. * Also supports the LM82 temp sensor, which is basically a stripped down
  17. * model of the LM83. Datasheet is here:
  18. * http://www.national.com/pf/LM/LM82.html
  19. */
  20. #include <linux/module.h>
  21. #include <linux/init.h>
  22. #include <linux/slab.h>
  23. #include <linux/jiffies.h>
  24. #include <linux/i2c.h>
  25. #include <linux/hwmon-sysfs.h>
  26. #include <linux/hwmon.h>
  27. #include <linux/err.h>
  28. #include <linux/mutex.h>
  29. #include <linux/sysfs.h>
  30. /*
  31. * Addresses to scan
  32. * Address is selected using 2 three-level pins, resulting in 9 possible
  33. * addresses.
  34. */
  35. static const unsigned short normal_i2c[] = {
  36. 0x18, 0x19, 0x1a, 0x29, 0x2a, 0x2b, 0x4c, 0x4d, 0x4e, I2C_CLIENT_END };
  37. enum chips { lm83, lm82 };
  38. /*
  39. * The LM83 registers
  40. * Manufacturer ID is 0x01 for National Semiconductor.
  41. */
  42. #define LM83_REG_R_MAN_ID 0xFE
  43. #define LM83_REG_R_CHIP_ID 0xFF
  44. #define LM83_REG_R_CONFIG 0x03
  45. #define LM83_REG_W_CONFIG 0x09
  46. #define LM83_REG_R_STATUS1 0x02
  47. #define LM83_REG_R_STATUS2 0x35
  48. #define LM83_REG_R_LOCAL_TEMP 0x00
  49. #define LM83_REG_R_LOCAL_HIGH 0x05
  50. #define LM83_REG_W_LOCAL_HIGH 0x0B
  51. #define LM83_REG_R_REMOTE1_TEMP 0x30
  52. #define LM83_REG_R_REMOTE1_HIGH 0x38
  53. #define LM83_REG_W_REMOTE1_HIGH 0x50
  54. #define LM83_REG_R_REMOTE2_TEMP 0x01
  55. #define LM83_REG_R_REMOTE2_HIGH 0x07
  56. #define LM83_REG_W_REMOTE2_HIGH 0x0D
  57. #define LM83_REG_R_REMOTE3_TEMP 0x31
  58. #define LM83_REG_R_REMOTE3_HIGH 0x3A
  59. #define LM83_REG_W_REMOTE3_HIGH 0x52
  60. #define LM83_REG_R_TCRIT 0x42
  61. #define LM83_REG_W_TCRIT 0x5A
  62. /*
  63. * Conversions and various macros
  64. * The LM83 uses signed 8-bit values with LSB = 1 degree Celsius.
  65. */
  66. #define TEMP_FROM_REG(val) ((val) * 1000)
  67. #define TEMP_TO_REG(val) ((val) <= -128000 ? -128 : \
  68. (val) >= 127000 ? 127 : \
  69. (val) < 0 ? ((val) - 500) / 1000 : \
  70. ((val) + 500) / 1000)
  71. static const u8 LM83_REG_R_TEMP[] = {
  72. LM83_REG_R_LOCAL_TEMP,
  73. LM83_REG_R_REMOTE1_TEMP,
  74. LM83_REG_R_REMOTE2_TEMP,
  75. LM83_REG_R_REMOTE3_TEMP,
  76. LM83_REG_R_LOCAL_HIGH,
  77. LM83_REG_R_REMOTE1_HIGH,
  78. LM83_REG_R_REMOTE2_HIGH,
  79. LM83_REG_R_REMOTE3_HIGH,
  80. LM83_REG_R_TCRIT,
  81. };
  82. static const u8 LM83_REG_W_HIGH[] = {
  83. LM83_REG_W_LOCAL_HIGH,
  84. LM83_REG_W_REMOTE1_HIGH,
  85. LM83_REG_W_REMOTE2_HIGH,
  86. LM83_REG_W_REMOTE3_HIGH,
  87. LM83_REG_W_TCRIT,
  88. };
  89. /*
  90. * Client data (each client gets its own)
  91. */
  92. struct lm83_data {
  93. struct i2c_client *client;
  94. const struct attribute_group *groups[3];
  95. struct mutex update_lock;
  96. char valid; /* zero until following fields are valid */
  97. unsigned long last_updated; /* in jiffies */
  98. /* registers values */
  99. s8 temp[9]; /* 0..3: input 1-4,
  100. 4..7: high limit 1-4,
  101. 8 : critical limit */
  102. u16 alarms; /* bitvector, combined */
  103. };
  104. static struct lm83_data *lm83_update_device(struct device *dev)
  105. {
  106. struct lm83_data *data = dev_get_drvdata(dev);
  107. struct i2c_client *client = data->client;
  108. mutex_lock(&data->update_lock);
  109. if (time_after(jiffies, data->last_updated + HZ * 2) || !data->valid) {
  110. int nr;
  111. dev_dbg(&client->dev, "Updating lm83 data.\n");
  112. for (nr = 0; nr < 9; nr++) {
  113. data->temp[nr] =
  114. i2c_smbus_read_byte_data(client,
  115. LM83_REG_R_TEMP[nr]);
  116. }
  117. data->alarms =
  118. i2c_smbus_read_byte_data(client, LM83_REG_R_STATUS1)
  119. + (i2c_smbus_read_byte_data(client, LM83_REG_R_STATUS2)
  120. << 8);
  121. data->last_updated = jiffies;
  122. data->valid = 1;
  123. }
  124. mutex_unlock(&data->update_lock);
  125. return data;
  126. }
  127. /*
  128. * Sysfs stuff
  129. */
  130. static ssize_t temp_show(struct device *dev, struct device_attribute *devattr,
  131. char *buf)
  132. {
  133. struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
  134. struct lm83_data *data = lm83_update_device(dev);
  135. return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[attr->index]));
  136. }
  137. static ssize_t temp_store(struct device *dev,
  138. struct device_attribute *devattr, const char *buf,
  139. size_t count)
  140. {
  141. struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
  142. struct lm83_data *data = dev_get_drvdata(dev);
  143. struct i2c_client *client = data->client;
  144. long val;
  145. int nr = attr->index;
  146. int err;
  147. err = kstrtol(buf, 10, &val);
  148. if (err < 0)
  149. return err;
  150. mutex_lock(&data->update_lock);
  151. data->temp[nr] = TEMP_TO_REG(val);
  152. i2c_smbus_write_byte_data(client, LM83_REG_W_HIGH[nr - 4],
  153. data->temp[nr]);
  154. mutex_unlock(&data->update_lock);
  155. return count;
  156. }
  157. static ssize_t alarms_show(struct device *dev, struct device_attribute *dummy,
  158. char *buf)
  159. {
  160. struct lm83_data *data = lm83_update_device(dev);
  161. return sprintf(buf, "%d\n", data->alarms);
  162. }
  163. static ssize_t alarm_show(struct device *dev,
  164. struct device_attribute *devattr, char *buf)
  165. {
  166. struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
  167. struct lm83_data *data = lm83_update_device(dev);
  168. int bitnr = attr->index;
  169. return sprintf(buf, "%d\n", (data->alarms >> bitnr) & 1);
  170. }
  171. static SENSOR_DEVICE_ATTR_RO(temp1_input, temp, 0);
  172. static SENSOR_DEVICE_ATTR_RO(temp2_input, temp, 1);
  173. static SENSOR_DEVICE_ATTR_RO(temp3_input, temp, 2);
  174. static SENSOR_DEVICE_ATTR_RO(temp4_input, temp, 3);
  175. static SENSOR_DEVICE_ATTR_RW(temp1_max, temp, 4);
  176. static SENSOR_DEVICE_ATTR_RW(temp2_max, temp, 5);
  177. static SENSOR_DEVICE_ATTR_RW(temp3_max, temp, 6);
  178. static SENSOR_DEVICE_ATTR_RW(temp4_max, temp, 7);
  179. static SENSOR_DEVICE_ATTR_RO(temp1_crit, temp, 8);
  180. static SENSOR_DEVICE_ATTR_RO(temp2_crit, temp, 8);
  181. static SENSOR_DEVICE_ATTR_RW(temp3_crit, temp, 8);
  182. static SENSOR_DEVICE_ATTR_RO(temp4_crit, temp, 8);
  183. /* Individual alarm files */
  184. static SENSOR_DEVICE_ATTR_RO(temp1_crit_alarm, alarm, 0);
  185. static SENSOR_DEVICE_ATTR_RO(temp3_crit_alarm, alarm, 1);
  186. static SENSOR_DEVICE_ATTR_RO(temp3_fault, alarm, 2);
  187. static SENSOR_DEVICE_ATTR_RO(temp3_max_alarm, alarm, 4);
  188. static SENSOR_DEVICE_ATTR_RO(temp1_max_alarm, alarm, 6);
  189. static SENSOR_DEVICE_ATTR_RO(temp2_crit_alarm, alarm, 8);
  190. static SENSOR_DEVICE_ATTR_RO(temp4_crit_alarm, alarm, 9);
  191. static SENSOR_DEVICE_ATTR_RO(temp4_fault, alarm, 10);
  192. static SENSOR_DEVICE_ATTR_RO(temp4_max_alarm, alarm, 12);
  193. static SENSOR_DEVICE_ATTR_RO(temp2_fault, alarm, 13);
  194. static SENSOR_DEVICE_ATTR_RO(temp2_max_alarm, alarm, 15);
  195. /* Raw alarm file for compatibility */
  196. static DEVICE_ATTR_RO(alarms);
  197. static struct attribute *lm83_attributes[] = {
  198. &sensor_dev_attr_temp1_input.dev_attr.attr,
  199. &sensor_dev_attr_temp3_input.dev_attr.attr,
  200. &sensor_dev_attr_temp1_max.dev_attr.attr,
  201. &sensor_dev_attr_temp3_max.dev_attr.attr,
  202. &sensor_dev_attr_temp1_crit.dev_attr.attr,
  203. &sensor_dev_attr_temp3_crit.dev_attr.attr,
  204. &sensor_dev_attr_temp1_crit_alarm.dev_attr.attr,
  205. &sensor_dev_attr_temp3_crit_alarm.dev_attr.attr,
  206. &sensor_dev_attr_temp3_fault.dev_attr.attr,
  207. &sensor_dev_attr_temp3_max_alarm.dev_attr.attr,
  208. &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
  209. &dev_attr_alarms.attr,
  210. NULL
  211. };
  212. static const struct attribute_group lm83_group = {
  213. .attrs = lm83_attributes,
  214. };
  215. static struct attribute *lm83_attributes_opt[] = {
  216. &sensor_dev_attr_temp2_input.dev_attr.attr,
  217. &sensor_dev_attr_temp4_input.dev_attr.attr,
  218. &sensor_dev_attr_temp2_max.dev_attr.attr,
  219. &sensor_dev_attr_temp4_max.dev_attr.attr,
  220. &sensor_dev_attr_temp2_crit.dev_attr.attr,
  221. &sensor_dev_attr_temp4_crit.dev_attr.attr,
  222. &sensor_dev_attr_temp2_crit_alarm.dev_attr.attr,
  223. &sensor_dev_attr_temp4_crit_alarm.dev_attr.attr,
  224. &sensor_dev_attr_temp4_fault.dev_attr.attr,
  225. &sensor_dev_attr_temp4_max_alarm.dev_attr.attr,
  226. &sensor_dev_attr_temp2_fault.dev_attr.attr,
  227. &sensor_dev_attr_temp2_max_alarm.dev_attr.attr,
  228. NULL
  229. };
  230. static const struct attribute_group lm83_group_opt = {
  231. .attrs = lm83_attributes_opt,
  232. };
  233. /*
  234. * Real code
  235. */
  236. /* Return 0 if detection is successful, -ENODEV otherwise */
  237. static int lm83_detect(struct i2c_client *new_client,
  238. struct i2c_board_info *info)
  239. {
  240. struct i2c_adapter *adapter = new_client->adapter;
  241. const char *name;
  242. u8 man_id, chip_id;
  243. if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
  244. return -ENODEV;
  245. /* Detection */
  246. if ((i2c_smbus_read_byte_data(new_client, LM83_REG_R_STATUS1) & 0xA8) ||
  247. (i2c_smbus_read_byte_data(new_client, LM83_REG_R_STATUS2) & 0x48) ||
  248. (i2c_smbus_read_byte_data(new_client, LM83_REG_R_CONFIG) & 0x41)) {
  249. dev_dbg(&adapter->dev, "LM83 detection failed at 0x%02x\n",
  250. new_client->addr);
  251. return -ENODEV;
  252. }
  253. /* Identification */
  254. man_id = i2c_smbus_read_byte_data(new_client, LM83_REG_R_MAN_ID);
  255. if (man_id != 0x01) /* National Semiconductor */
  256. return -ENODEV;
  257. chip_id = i2c_smbus_read_byte_data(new_client, LM83_REG_R_CHIP_ID);
  258. switch (chip_id) {
  259. case 0x03:
  260. name = "lm83";
  261. break;
  262. case 0x01:
  263. name = "lm82";
  264. break;
  265. default:
  266. /* identification failed */
  267. dev_info(&adapter->dev,
  268. "Unsupported chip (man_id=0x%02X, chip_id=0x%02X)\n",
  269. man_id, chip_id);
  270. return -ENODEV;
  271. }
  272. strlcpy(info->type, name, I2C_NAME_SIZE);
  273. return 0;
  274. }
  275. static int lm83_probe(struct i2c_client *new_client,
  276. const struct i2c_device_id *id)
  277. {
  278. struct device *hwmon_dev;
  279. struct lm83_data *data;
  280. data = devm_kzalloc(&new_client->dev, sizeof(struct lm83_data),
  281. GFP_KERNEL);
  282. if (!data)
  283. return -ENOMEM;
  284. data->client = new_client;
  285. mutex_init(&data->update_lock);
  286. /*
  287. * Register sysfs hooks
  288. * The LM82 can only monitor one external diode which is
  289. * at the same register as the LM83 temp3 entry - so we
  290. * declare 1 and 3 common, and then 2 and 4 only for the LM83.
  291. */
  292. data->groups[0] = &lm83_group;
  293. if (id->driver_data == lm83)
  294. data->groups[1] = &lm83_group_opt;
  295. hwmon_dev = devm_hwmon_device_register_with_groups(&new_client->dev,
  296. new_client->name,
  297. data, data->groups);
  298. return PTR_ERR_OR_ZERO(hwmon_dev);
  299. }
  300. /*
  301. * Driver data (common to all clients)
  302. */
  303. static const struct i2c_device_id lm83_id[] = {
  304. { "lm83", lm83 },
  305. { "lm82", lm82 },
  306. { }
  307. };
  308. MODULE_DEVICE_TABLE(i2c, lm83_id);
  309. static struct i2c_driver lm83_driver = {
  310. .class = I2C_CLASS_HWMON,
  311. .driver = {
  312. .name = "lm83",
  313. },
  314. .probe = lm83_probe,
  315. .id_table = lm83_id,
  316. .detect = lm83_detect,
  317. .address_list = normal_i2c,
  318. };
  319. module_i2c_driver(lm83_driver);
  320. MODULE_AUTHOR("Jean Delvare <jdelvare@suse.de>");
  321. MODULE_DESCRIPTION("LM83 driver");
  322. MODULE_LICENSE("GPL");