xref: /linux/drivers/hwmon/nct7363.c (revision b50ecc5aca4d18f1f0c4942f5c797bc85edef144)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Copyright (c) 2023 Nuvoton Technology corporation.
4  */
5 
6 #include <linux/bitfield.h>
7 #include <linux/bits.h>
8 #include <linux/err.h>
9 #include <linux/hwmon.h>
10 #include <linux/hwmon-sysfs.h>
11 #include <linux/i2c.h>
12 #include <linux/module.h>
13 #include <linux/mutex.h>
14 #include <linux/regmap.h>
15 #include <linux/slab.h>
16 
17 #define NCT7363_REG_FUNC_CFG_BASE(x)	(0x20 + (x))
18 #define NCT7363_REG_LSRS(x)		(0x34 + ((x) / 8))
19 #define NCT7363_REG_PWMEN_BASE(x)	(0x38 + (x))
20 #define NCT7363_REG_FANINEN_BASE(x)	(0x41 + (x))
21 #define NCT7363_REG_FANINX_HVAL(x)	(0x48 + ((x) * 2))
22 #define NCT7363_REG_FANINX_LVAL(x)	(0x49 + ((x) * 2))
23 #define NCT7363_REG_FANINX_HL(x)	(0x6C + ((x) * 2))
24 #define NCT7363_REG_FANINX_LL(x)	(0x6D + ((x) * 2))
25 #define NCT7363_REG_FSCPXDUTY(x)	(0x90 + ((x) * 2))
26 #define NCT7363_REG_FSCPXDIV(x)		(0x91 + ((x) * 2))
27 
28 #define PWM_SEL(x)			(BIT(0) << ((x) * 2))
29 #define FANIN_SEL(_x)			({typeof(_x) (x) = (_x); \
30 					 BIT(1) << (((x) < 8) ? \
31 					 (((x) + 8) * 2) : \
32 					 (((x) % 8) * 2)); })
33 #define ALARM_SEL(x, y)			((x) & (BIT((y) % 8)))
34 #define VALUE_TO_REG(x, y)		(((x) >> ((y) * 8)) & 0xFF)
35 
36 #define NCT7363_FANINX_LVAL_MASK	GENMASK(4, 0)
37 #define NCT7363_FANIN_MASK		GENMASK(12, 0)
38 
39 #define NCT7363_PWM_COUNT		16
40 
41 static inline unsigned int fan_from_reg(u16 val)
42 {
43 	if (val == NCT7363_FANIN_MASK || val == 0)
44 		return 0;
45 
46 	return (1350000UL / val);
47 }
48 
49 static const struct of_device_id nct7363_of_match[] = {
50 	{ .compatible = "nuvoton,nct7363", },
51 	{ .compatible = "nuvoton,nct7362", },
52 	{ }
53 };
54 MODULE_DEVICE_TABLE(of, nct7363_of_match);
55 
56 struct nct7363_data {
57 	struct regmap		*regmap;
58 
59 	u16			fanin_mask;
60 	u16			pwm_mask;
61 };
62 
63 static int nct7363_read_fan(struct device *dev, u32 attr, int channel,
64 			    long *val)
65 {
66 	struct nct7363_data *data = dev_get_drvdata(dev);
67 	unsigned int reg;
68 	u8 regval[2];
69 	int ret;
70 	u16 cnt;
71 
72 	switch (attr) {
73 	case hwmon_fan_input:
74 		/*
75 		 * High-byte register should be read first to latch
76 		 * synchronous low-byte value
77 		 */
78 		ret = regmap_bulk_read(data->regmap,
79 				       NCT7363_REG_FANINX_HVAL(channel),
80 				       &regval, 2);
81 		if (ret)
82 			return ret;
83 
84 		cnt = (regval[0] << 5) | (regval[1] & NCT7363_FANINX_LVAL_MASK);
85 		*val = fan_from_reg(cnt);
86 		return 0;
87 	case hwmon_fan_min:
88 		ret = regmap_bulk_read(data->regmap,
89 				       NCT7363_REG_FANINX_HL(channel),
90 				       &regval, 2);
91 		if (ret)
92 			return ret;
93 
94 		cnt = (regval[0] << 5) | (regval[1] & NCT7363_FANINX_LVAL_MASK);
95 		*val = fan_from_reg(cnt);
96 		return 0;
97 	case hwmon_fan_alarm:
98 		ret = regmap_read(data->regmap,
99 				  NCT7363_REG_LSRS(channel), &reg);
100 		if (ret)
101 			return ret;
102 
103 		*val = (long)ALARM_SEL(reg, channel) > 0 ? 1 : 0;
104 		return 0;
105 	default:
106 		return -EOPNOTSUPP;
107 	}
108 }
109 
110 static int nct7363_write_fan(struct device *dev, u32 attr, int channel,
111 			     long val)
112 {
113 	struct nct7363_data *data = dev_get_drvdata(dev);
114 	u8 regval[2];
115 	int ret;
116 
117 	if (val <= 0)
118 		return -EINVAL;
119 
120 	switch (attr) {
121 	case hwmon_fan_min:
122 		val = clamp_val(DIV_ROUND_CLOSEST(1350000, val),
123 				1, NCT7363_FANIN_MASK);
124 		regval[0] = val >> 5;
125 		regval[1] = val & NCT7363_FANINX_LVAL_MASK;
126 
127 		ret = regmap_bulk_write(data->regmap,
128 					NCT7363_REG_FANINX_HL(channel),
129 					regval, 2);
130 		return ret;
131 	default:
132 		return -EOPNOTSUPP;
133 	}
134 }
135 
136 static umode_t nct7363_fan_is_visible(const void *_data, u32 attr, int channel)
137 {
138 	const struct nct7363_data *data = _data;
139 
140 	switch (attr) {
141 	case hwmon_fan_input:
142 	case hwmon_fan_alarm:
143 		if (data->fanin_mask & BIT(channel))
144 			return 0444;
145 		break;
146 	case hwmon_fan_min:
147 		if (data->fanin_mask & BIT(channel))
148 			return 0644;
149 		break;
150 	default:
151 		break;
152 	}
153 
154 	return 0;
155 }
156 
157 static int nct7363_read_pwm(struct device *dev, u32 attr, int channel,
158 			    long *val)
159 {
160 	struct nct7363_data *data = dev_get_drvdata(dev);
161 	unsigned int regval;
162 	int ret;
163 
164 	switch (attr) {
165 	case hwmon_pwm_input:
166 		ret = regmap_read(data->regmap,
167 				  NCT7363_REG_FSCPXDUTY(channel), &regval);
168 		if (ret)
169 			return ret;
170 
171 		*val = (long)regval;
172 		return 0;
173 	default:
174 		return -EOPNOTSUPP;
175 	}
176 }
177 
178 static int nct7363_write_pwm(struct device *dev, u32 attr, int channel,
179 			     long val)
180 {
181 	struct nct7363_data *data = dev_get_drvdata(dev);
182 	int ret;
183 
184 	switch (attr) {
185 	case hwmon_pwm_input:
186 		if (val < 0 || val > 255)
187 			return -EINVAL;
188 
189 		ret = regmap_write(data->regmap,
190 				   NCT7363_REG_FSCPXDUTY(channel), val);
191 
192 		return ret;
193 
194 	default:
195 		return -EOPNOTSUPP;
196 	}
197 }
198 
199 static umode_t nct7363_pwm_is_visible(const void *_data, u32 attr, int channel)
200 {
201 	const struct nct7363_data *data = _data;
202 
203 	switch (attr) {
204 	case hwmon_pwm_input:
205 		if (data->pwm_mask & BIT(channel))
206 			return 0644;
207 		break;
208 	default:
209 		break;
210 	}
211 
212 	return 0;
213 }
214 
215 static int nct7363_read(struct device *dev, enum hwmon_sensor_types type,
216 			u32 attr, int channel, long *val)
217 {
218 	switch (type) {
219 	case hwmon_fan:
220 		return nct7363_read_fan(dev, attr, channel, val);
221 	case hwmon_pwm:
222 		return nct7363_read_pwm(dev, attr, channel, val);
223 	default:
224 		return -EOPNOTSUPP;
225 	}
226 }
227 
228 static int nct7363_write(struct device *dev, enum hwmon_sensor_types type,
229 			 u32 attr, int channel, long val)
230 {
231 	switch (type) {
232 	case hwmon_fan:
233 		return nct7363_write_fan(dev, attr, channel, val);
234 	case hwmon_pwm:
235 		return nct7363_write_pwm(dev, attr, channel, val);
236 	default:
237 		return -EOPNOTSUPP;
238 	}
239 }
240 
241 static umode_t nct7363_is_visible(const void *data,
242 				  enum hwmon_sensor_types type,
243 				  u32 attr, int channel)
244 {
245 	switch (type) {
246 	case hwmon_fan:
247 		return nct7363_fan_is_visible(data, attr, channel);
248 	case hwmon_pwm:
249 		return nct7363_pwm_is_visible(data, attr, channel);
250 	default:
251 		return 0;
252 	}
253 }
254 
255 static const struct hwmon_channel_info *nct7363_info[] = {
256 	HWMON_CHANNEL_INFO(fan,
257 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
258 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
259 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
260 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
261 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
262 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
263 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
264 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
265 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
266 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
267 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
268 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
269 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
270 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
271 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM,
272 			   HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_ALARM),
273 	HWMON_CHANNEL_INFO(pwm,
274 			   HWMON_PWM_INPUT,
275 			   HWMON_PWM_INPUT,
276 			   HWMON_PWM_INPUT,
277 			   HWMON_PWM_INPUT,
278 			   HWMON_PWM_INPUT,
279 			   HWMON_PWM_INPUT,
280 			   HWMON_PWM_INPUT,
281 			   HWMON_PWM_INPUT,
282 			   HWMON_PWM_INPUT,
283 			   HWMON_PWM_INPUT,
284 			   HWMON_PWM_INPUT,
285 			   HWMON_PWM_INPUT,
286 			   HWMON_PWM_INPUT,
287 			   HWMON_PWM_INPUT,
288 			   HWMON_PWM_INPUT,
289 			   HWMON_PWM_INPUT),
290 	NULL
291 };
292 
293 static const struct hwmon_ops nct7363_hwmon_ops = {
294 	.is_visible = nct7363_is_visible,
295 	.read = nct7363_read,
296 	.write = nct7363_write,
297 };
298 
299 static const struct hwmon_chip_info nct7363_chip_info = {
300 	.ops = &nct7363_hwmon_ops,
301 	.info = nct7363_info,
302 };
303 
304 static int nct7363_init_chip(struct nct7363_data *data)
305 {
306 	u32 func_config = 0;
307 	int i, ret;
308 
309 	/* Pin Function Configuration */
310 	for (i = 0; i < NCT7363_PWM_COUNT; i++) {
311 		if (data->pwm_mask & BIT(i))
312 			func_config |= PWM_SEL(i);
313 		if (data->fanin_mask & BIT(i))
314 			func_config |= FANIN_SEL(i);
315 	}
316 
317 	for (i = 0; i < 4; i++) {
318 		ret = regmap_write(data->regmap, NCT7363_REG_FUNC_CFG_BASE(i),
319 				   VALUE_TO_REG(func_config, i));
320 		if (ret < 0)
321 			return ret;
322 	}
323 
324 	/* PWM and FANIN Monitoring Enable */
325 	for (i = 0; i < 2; i++) {
326 		ret = regmap_write(data->regmap, NCT7363_REG_PWMEN_BASE(i),
327 				   VALUE_TO_REG(data->pwm_mask, i));
328 		if (ret < 0)
329 			return ret;
330 
331 		ret = regmap_write(data->regmap, NCT7363_REG_FANINEN_BASE(i),
332 				   VALUE_TO_REG(data->fanin_mask, i));
333 		if (ret < 0)
334 			return ret;
335 	}
336 
337 	return 0;
338 }
339 
340 static int nct7363_present_pwm_fanin(struct device *dev,
341 				     struct device_node *child,
342 				     struct nct7363_data *data)
343 {
344 	u8 fanin_ch[NCT7363_PWM_COUNT];
345 	struct of_phandle_args args;
346 	int ret, fanin_cnt;
347 	u8 ch, index;
348 
349 	ret = of_parse_phandle_with_args(child, "pwms", "#pwm-cells",
350 					 0, &args);
351 	if (ret)
352 		return ret;
353 
354 	if (args.args[0] >= NCT7363_PWM_COUNT)
355 		return -EINVAL;
356 	data->pwm_mask |= BIT(args.args[0]);
357 
358 	fanin_cnt = of_property_count_u8_elems(child, "tach-ch");
359 	if (fanin_cnt < 1 || fanin_cnt > NCT7363_PWM_COUNT)
360 		return -EINVAL;
361 
362 	ret = of_property_read_u8_array(child, "tach-ch", fanin_ch, fanin_cnt);
363 	if (ret)
364 		return ret;
365 
366 	for (ch = 0; ch < fanin_cnt; ch++) {
367 		index = fanin_ch[ch];
368 		if (index >= NCT7363_PWM_COUNT)
369 			return -EINVAL;
370 		data->fanin_mask |= BIT(index);
371 	}
372 
373 	return 0;
374 }
375 
376 static bool nct7363_regmap_is_volatile(struct device *dev, unsigned int reg)
377 {
378 	switch (reg) {
379 	case NCT7363_REG_LSRS(0) ... NCT7363_REG_LSRS(15):
380 	case NCT7363_REG_FANINX_HVAL(0) ... NCT7363_REG_FANINX_LVAL(15):
381 	case NCT7363_REG_FANINX_HL(0) ... NCT7363_REG_FANINX_LL(15):
382 	case NCT7363_REG_FSCPXDUTY(0) ... NCT7363_REG_FSCPXDIV(15):
383 		return true;
384 	default:
385 		return false;
386 	}
387 }
388 
389 static const struct regmap_config nct7363_regmap_config = {
390 	.reg_bits = 8,
391 	.val_bits = 8,
392 	.use_single_read = true,
393 	.use_single_write = true,
394 	.cache_type = REGCACHE_RBTREE,
395 	.volatile_reg = nct7363_regmap_is_volatile,
396 };
397 
398 static int nct7363_probe(struct i2c_client *client)
399 {
400 	struct device *dev = &client->dev;
401 	struct device_node *child;
402 	struct nct7363_data *data;
403 	struct device *hwmon_dev;
404 	int ret;
405 
406 	data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
407 	if (!data)
408 		return -ENOMEM;
409 
410 	data->regmap = devm_regmap_init_i2c(client, &nct7363_regmap_config);
411 	if (IS_ERR(data->regmap))
412 		return PTR_ERR(data->regmap);
413 
414 	for_each_child_of_node(dev->of_node, child) {
415 		ret = nct7363_present_pwm_fanin(dev, child, data);
416 		if (ret) {
417 			of_node_put(child);
418 			return ret;
419 		}
420 	}
421 
422 	/* Initialize the chip */
423 	ret = nct7363_init_chip(data);
424 	if (ret)
425 		return ret;
426 
427 	hwmon_dev =
428 		devm_hwmon_device_register_with_info(dev, client->name, data,
429 						     &nct7363_chip_info, NULL);
430 	return PTR_ERR_OR_ZERO(hwmon_dev);
431 }
432 
433 static struct i2c_driver nct7363_driver = {
434 	.class = I2C_CLASS_HWMON,
435 	.driver = {
436 		.name = "nct7363",
437 		.of_match_table = nct7363_of_match,
438 	},
439 	.probe = nct7363_probe,
440 };
441 
442 module_i2c_driver(nct7363_driver);
443 
444 MODULE_AUTHOR("CW Ho <cwho@nuvoton.com>");
445 MODULE_AUTHOR("Ban Feng <kcfeng0@nuvoton.com>");
446 MODULE_DESCRIPTION("NCT7363 Hardware Monitoring Driver");
447 MODULE_LICENSE("GPL");
448