1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2017 IBM Corp.
5 * Driver for the Nuvoton W83773G SMBus temperature sensor IC.
6 * Supported models: W83773G
9 #include <linux/module.h>
10 #include <linux/init.h>
11 #include <linux/i2c.h>
12 #include <linux/hwmon.h>
13 #include <linux/hwmon-sysfs.h>
14 #include <linux/err.h>
15 #include <linux/of_device.h>
16 #include <linux/regmap.h>
18 /* W83773 has 3 channels */
19 #define W83773_CHANNELS 3
21 /* The W83773 registers */
22 #define W83773_CONVERSION_RATE_REG_READ 0x04
23 #define W83773_CONVERSION_RATE_REG_WRITE 0x0A
24 #define W83773_MANUFACTURER_ID_REG 0xFE
25 #define W83773_LOCAL_TEMP 0x00
27 static const u8 W83773_STATUS
[2] = { 0x02, 0x17 };
29 static const u8 W83773_TEMP_LSB
[2] = { 0x10, 0x25 };
30 static const u8 W83773_TEMP_MSB
[2] = { 0x01, 0x24 };
32 static const u8 W83773_OFFSET_LSB
[2] = { 0x12, 0x16 };
33 static const u8 W83773_OFFSET_MSB
[2] = { 0x11, 0x15 };
35 /* this is the number of sensors in the device */
36 static const struct i2c_device_id w83773_id
[] = {
41 MODULE_DEVICE_TABLE(i2c
, w83773_id
);
43 static const struct of_device_id __maybe_unused w83773_of_match
[] = {
45 .compatible
= "nuvoton,w83773g"
49 MODULE_DEVICE_TABLE(of
, w83773_of_match
);
51 static inline long temp_of_local(s8 reg
)
56 static inline long temp_of_remote(s8 hb
, u8 lb
)
58 return (hb
<< 3 | lb
>> 5) * 125;
61 static int get_local_temp(struct regmap
*regmap
, long *val
)
66 ret
= regmap_read(regmap
, W83773_LOCAL_TEMP
, ®val
);
70 *val
= temp_of_local(regval
);
74 static int get_remote_temp(struct regmap
*regmap
, int index
, long *val
)
76 unsigned int regval_high
;
77 unsigned int regval_low
;
80 ret
= regmap_read(regmap
, W83773_TEMP_MSB
[index
], ®val_high
);
84 ret
= regmap_read(regmap
, W83773_TEMP_LSB
[index
], ®val_low
);
88 *val
= temp_of_remote(regval_high
, regval_low
);
92 static int get_fault(struct regmap
*regmap
, int index
, long *val
)
97 ret
= regmap_read(regmap
, W83773_STATUS
[index
], ®val
);
101 *val
= (regval
& 0x04) >> 2;
105 static int get_offset(struct regmap
*regmap
, int index
, long *val
)
107 unsigned int regval_high
;
108 unsigned int regval_low
;
111 ret
= regmap_read(regmap
, W83773_OFFSET_MSB
[index
], ®val_high
);
115 ret
= regmap_read(regmap
, W83773_OFFSET_LSB
[index
], ®val_low
);
119 *val
= temp_of_remote(regval_high
, regval_low
);
123 static int set_offset(struct regmap
*regmap
, int index
, long val
)
129 val
= clamp_val(val
, -127825, 127825);
130 /* offset value equals to (high_byte << 3 | low_byte >> 5) * 125 */
132 high_byte
= val
>> 3;
133 low_byte
= (val
& 0x07) << 5;
135 ret
= regmap_write(regmap
, W83773_OFFSET_MSB
[index
], high_byte
);
139 return regmap_write(regmap
, W83773_OFFSET_LSB
[index
], low_byte
);
142 static int get_update_interval(struct regmap
*regmap
, long *val
)
147 ret
= regmap_read(regmap
, W83773_CONVERSION_RATE_REG_READ
, ®val
);
151 *val
= 16000 >> regval
;
155 static int set_update_interval(struct regmap
*regmap
, long val
)
160 * For valid rates, interval can be calculated as
161 * interval = (1 << (8 - rate)) * 62.5;
162 * Rounded rate is therefore
163 * rate = 8 - __fls(interval * 8 / (62.5 * 7));
164 * Use clamp_val() to avoid overflows, and to ensure valid input
167 val
= clamp_val(val
, 62, 16000) * 10;
168 rate
= 8 - __fls((val
* 8 / (625 * 7)));
169 return regmap_write(regmap
, W83773_CONVERSION_RATE_REG_WRITE
, rate
);
172 static int w83773_read(struct device
*dev
, enum hwmon_sensor_types type
,
173 u32 attr
, int channel
, long *val
)
175 struct regmap
*regmap
= dev_get_drvdata(dev
);
177 if (type
== hwmon_chip
) {
178 if (attr
== hwmon_chip_update_interval
)
179 return get_update_interval(regmap
, val
);
184 case hwmon_temp_input
:
186 return get_local_temp(regmap
, val
);
187 return get_remote_temp(regmap
, channel
- 1, val
);
188 case hwmon_temp_fault
:
189 return get_fault(regmap
, channel
- 1, val
);
190 case hwmon_temp_offset
:
191 return get_offset(regmap
, channel
- 1, val
);
197 static int w83773_write(struct device
*dev
, enum hwmon_sensor_types type
,
198 u32 attr
, int channel
, long val
)
200 struct regmap
*regmap
= dev_get_drvdata(dev
);
202 if (type
== hwmon_chip
&& attr
== hwmon_chip_update_interval
)
203 return set_update_interval(regmap
, val
);
205 if (type
== hwmon_temp
&& attr
== hwmon_temp_offset
)
206 return set_offset(regmap
, channel
- 1, val
);
211 static umode_t
w83773_is_visible(const void *data
, enum hwmon_sensor_types type
,
212 u32 attr
, int channel
)
217 case hwmon_chip_update_interval
:
223 case hwmon_temp_input
:
224 case hwmon_temp_fault
:
226 case hwmon_temp_offset
:
236 static const struct hwmon_channel_info
*w83773_info
[] = {
237 HWMON_CHANNEL_INFO(chip
,
238 HWMON_C_REGISTER_TZ
| HWMON_C_UPDATE_INTERVAL
),
239 HWMON_CHANNEL_INFO(temp
,
241 HWMON_T_INPUT
| HWMON_T_FAULT
| HWMON_T_OFFSET
,
242 HWMON_T_INPUT
| HWMON_T_FAULT
| HWMON_T_OFFSET
),
246 static const struct hwmon_ops w83773_ops
= {
247 .is_visible
= w83773_is_visible
,
249 .write
= w83773_write
,
252 static const struct hwmon_chip_info w83773_chip_info
= {
257 static const struct regmap_config w83773_regmap_config
= {
262 static int w83773_probe(struct i2c_client
*client
)
264 struct device
*dev
= &client
->dev
;
265 struct device
*hwmon_dev
;
266 struct regmap
*regmap
;
269 regmap
= devm_regmap_init_i2c(client
, &w83773_regmap_config
);
270 if (IS_ERR(regmap
)) {
271 dev_err(dev
, "failed to allocate register map\n");
272 return PTR_ERR(regmap
);
275 /* Set the conversion rate to 2 Hz */
276 ret
= regmap_write(regmap
, W83773_CONVERSION_RATE_REG_WRITE
, 0x05);
278 dev_err(&client
->dev
, "error writing config rate register\n");
282 i2c_set_clientdata(client
, regmap
);
284 hwmon_dev
= devm_hwmon_device_register_with_info(dev
,
289 return PTR_ERR_OR_ZERO(hwmon_dev
);
292 static struct i2c_driver w83773_driver
= {
293 .class = I2C_CLASS_HWMON
,
296 .of_match_table
= of_match_ptr(w83773_of_match
),
298 .probe_new
= w83773_probe
,
299 .id_table
= w83773_id
,
302 module_i2c_driver(w83773_driver
);
304 MODULE_AUTHOR("Lei YU <mine260309@gmail.com>");
305 MODULE_DESCRIPTION("W83773G temperature sensor driver");
306 MODULE_LICENSE("GPL");