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