xref: /openbmc/linux/drivers/hwmon/gsc-hwmon.c (revision 29c37341)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Driver for Gateworks System Controller Hardware Monitor module
4  *
5  * Copyright (C) 2020 Gateworks Corporation
6  */
7 #include <linux/hwmon.h>
8 #include <linux/hwmon-sysfs.h>
9 #include <linux/mfd/gsc.h>
10 #include <linux/module.h>
11 #include <linux/of.h>
12 #include <linux/platform_device.h>
13 #include <linux/regmap.h>
14 #include <linux/slab.h>
15 
16 #include <linux/platform_data/gsc_hwmon.h>
17 
18 #define GSC_HWMON_MAX_TEMP_CH	16
19 #define GSC_HWMON_MAX_IN_CH	16
20 
21 #define GSC_HWMON_RESOLUTION	12
22 #define GSC_HWMON_VREF		2500
23 
24 struct gsc_hwmon_data {
25 	struct gsc_dev *gsc;
26 	struct gsc_hwmon_platform_data *pdata;
27 	struct regmap *regmap;
28 	const struct gsc_hwmon_channel *temp_ch[GSC_HWMON_MAX_TEMP_CH];
29 	const struct gsc_hwmon_channel *in_ch[GSC_HWMON_MAX_IN_CH];
30 	u32 temp_config[GSC_HWMON_MAX_TEMP_CH + 1];
31 	u32 in_config[GSC_HWMON_MAX_IN_CH + 1];
32 	struct hwmon_channel_info temp_info;
33 	struct hwmon_channel_info in_info;
34 	const struct hwmon_channel_info *info[3];
35 	struct hwmon_chip_info chip;
36 };
37 
38 static struct regmap_bus gsc_hwmon_regmap_bus = {
39 	.reg_read = gsc_read,
40 	.reg_write = gsc_write,
41 };
42 
43 static const struct regmap_config gsc_hwmon_regmap_config = {
44 	.reg_bits = 8,
45 	.val_bits = 8,
46 	.cache_type = REGCACHE_NONE,
47 };
48 
49 static ssize_t pwm_auto_point_temp_show(struct device *dev,
50 					struct device_attribute *devattr,
51 					char *buf)
52 {
53 	struct gsc_hwmon_data *hwmon = dev_get_drvdata(dev);
54 	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
55 	u8 reg = hwmon->pdata->fan_base + (2 * attr->index);
56 	u8 regs[2];
57 	int ret;
58 
59 	ret = regmap_bulk_read(hwmon->regmap, reg, regs, 2);
60 	if (ret)
61 		return ret;
62 
63 	ret = regs[0] | regs[1] << 8;
64 	return sprintf(buf, "%d\n", ret * 10);
65 }
66 
67 static ssize_t pwm_auto_point_temp_store(struct device *dev,
68 					 struct device_attribute *devattr,
69 					 const char *buf, size_t count)
70 {
71 	struct gsc_hwmon_data *hwmon = dev_get_drvdata(dev);
72 	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
73 	u8 reg = hwmon->pdata->fan_base + (2 * attr->index);
74 	u8 regs[2];
75 	long temp;
76 	int err;
77 
78 	if (kstrtol(buf, 10, &temp))
79 		return -EINVAL;
80 
81 	temp = clamp_val(temp, 0, 10000);
82 	temp = DIV_ROUND_CLOSEST(temp, 10);
83 
84 	regs[0] = temp & 0xff;
85 	regs[1] = (temp >> 8) & 0xff;
86 	err = regmap_bulk_write(hwmon->regmap, reg, regs, 2);
87 	if (err)
88 		return err;
89 
90 	return count;
91 }
92 
93 static ssize_t pwm_auto_point_pwm_show(struct device *dev,
94 				       struct device_attribute *devattr,
95 				       char *buf)
96 {
97 	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
98 
99 	return sprintf(buf, "%d\n", 255 * (50 + (attr->index * 10)) / 100);
100 }
101 
102 static SENSOR_DEVICE_ATTR_RO(pwm1_auto_point1_pwm, pwm_auto_point_pwm, 0);
103 static SENSOR_DEVICE_ATTR_RW(pwm1_auto_point1_temp, pwm_auto_point_temp, 0);
104 
105 static SENSOR_DEVICE_ATTR_RO(pwm1_auto_point2_pwm, pwm_auto_point_pwm, 1);
106 static SENSOR_DEVICE_ATTR_RW(pwm1_auto_point2_temp, pwm_auto_point_temp, 1);
107 
108 static SENSOR_DEVICE_ATTR_RO(pwm1_auto_point3_pwm, pwm_auto_point_pwm, 2);
109 static SENSOR_DEVICE_ATTR_RW(pwm1_auto_point3_temp, pwm_auto_point_temp, 2);
110 
111 static SENSOR_DEVICE_ATTR_RO(pwm1_auto_point4_pwm, pwm_auto_point_pwm, 3);
112 static SENSOR_DEVICE_ATTR_RW(pwm1_auto_point4_temp, pwm_auto_point_temp, 3);
113 
114 static SENSOR_DEVICE_ATTR_RO(pwm1_auto_point5_pwm, pwm_auto_point_pwm, 4);
115 static SENSOR_DEVICE_ATTR_RW(pwm1_auto_point5_temp, pwm_auto_point_temp, 4);
116 
117 static SENSOR_DEVICE_ATTR_RO(pwm1_auto_point6_pwm, pwm_auto_point_pwm, 5);
118 static SENSOR_DEVICE_ATTR_RW(pwm1_auto_point6_temp, pwm_auto_point_temp, 5);
119 
120 static struct attribute *gsc_hwmon_attributes[] = {
121 	&sensor_dev_attr_pwm1_auto_point1_pwm.dev_attr.attr,
122 	&sensor_dev_attr_pwm1_auto_point1_temp.dev_attr.attr,
123 	&sensor_dev_attr_pwm1_auto_point2_pwm.dev_attr.attr,
124 	&sensor_dev_attr_pwm1_auto_point2_temp.dev_attr.attr,
125 	&sensor_dev_attr_pwm1_auto_point3_pwm.dev_attr.attr,
126 	&sensor_dev_attr_pwm1_auto_point3_temp.dev_attr.attr,
127 	&sensor_dev_attr_pwm1_auto_point4_pwm.dev_attr.attr,
128 	&sensor_dev_attr_pwm1_auto_point4_temp.dev_attr.attr,
129 	&sensor_dev_attr_pwm1_auto_point5_pwm.dev_attr.attr,
130 	&sensor_dev_attr_pwm1_auto_point5_temp.dev_attr.attr,
131 	&sensor_dev_attr_pwm1_auto_point6_pwm.dev_attr.attr,
132 	&sensor_dev_attr_pwm1_auto_point6_temp.dev_attr.attr,
133 	NULL
134 };
135 
136 static const struct attribute_group gsc_hwmon_group = {
137 	.attrs = gsc_hwmon_attributes,
138 };
139 __ATTRIBUTE_GROUPS(gsc_hwmon);
140 
141 static int
142 gsc_hwmon_read(struct device *dev, enum hwmon_sensor_types type, u32 attr,
143 	       int channel, long *val)
144 {
145 	struct gsc_hwmon_data *hwmon = dev_get_drvdata(dev);
146 	const struct gsc_hwmon_channel *ch;
147 	int sz, ret;
148 	long tmp;
149 	u8 buf[3];
150 
151 	switch (type) {
152 	case hwmon_in:
153 		ch = hwmon->in_ch[channel];
154 		break;
155 	case hwmon_temp:
156 		ch = hwmon->temp_ch[channel];
157 		break;
158 	default:
159 		return -EOPNOTSUPP;
160 	}
161 
162 	sz = (ch->mode == mode_voltage_24bit) ? 3 : 2;
163 	ret = regmap_bulk_read(hwmon->regmap, ch->reg, buf, sz);
164 	if (ret)
165 		return ret;
166 
167 	tmp = 0;
168 	while (sz-- > 0)
169 		tmp |= (buf[sz] << (8 * sz));
170 
171 	switch (ch->mode) {
172 	case mode_temperature:
173 		if (tmp > 0x8000)
174 			tmp -= 0xffff;
175 		break;
176 	case mode_voltage_raw:
177 		tmp = clamp_val(tmp, 0, BIT(GSC_HWMON_RESOLUTION));
178 		/* scale based on ref voltage and ADC resolution */
179 		tmp *= GSC_HWMON_VREF;
180 		tmp >>= GSC_HWMON_RESOLUTION;
181 		/* scale based on optional voltage divider */
182 		if (ch->vdiv[0] && ch->vdiv[1]) {
183 			tmp *= (ch->vdiv[0] + ch->vdiv[1]);
184 			tmp /= ch->vdiv[1];
185 		}
186 		/* adjust by uV offset */
187 		tmp += ch->mvoffset;
188 		break;
189 	case mode_voltage_24bit:
190 	case mode_voltage_16bit:
191 		/* no adjustment needed */
192 		break;
193 	}
194 
195 	*val = tmp;
196 
197 	return 0;
198 }
199 
200 static int
201 gsc_hwmon_read_string(struct device *dev, enum hwmon_sensor_types type,
202 		      u32 attr, int channel, const char **buf)
203 {
204 	struct gsc_hwmon_data *hwmon = dev_get_drvdata(dev);
205 
206 	switch (type) {
207 	case hwmon_in:
208 		*buf = hwmon->in_ch[channel]->name;
209 		break;
210 	case hwmon_temp:
211 		*buf = hwmon->temp_ch[channel]->name;
212 		break;
213 	default:
214 		return -ENOTSUPP;
215 	}
216 
217 	return 0;
218 }
219 
220 static umode_t
221 gsc_hwmon_is_visible(const void *_data, enum hwmon_sensor_types type, u32 attr,
222 		     int ch)
223 {
224 	return 0444;
225 }
226 
227 static const struct hwmon_ops gsc_hwmon_ops = {
228 	.is_visible = gsc_hwmon_is_visible,
229 	.read = gsc_hwmon_read,
230 	.read_string = gsc_hwmon_read_string,
231 };
232 
233 static struct gsc_hwmon_platform_data *
234 gsc_hwmon_get_devtree_pdata(struct device *dev)
235 {
236 	struct gsc_hwmon_platform_data *pdata;
237 	struct gsc_hwmon_channel *ch;
238 	struct fwnode_handle *child;
239 	struct device_node *fan;
240 	int nchannels;
241 
242 	nchannels = device_get_child_node_count(dev);
243 	if (nchannels == 0)
244 		return ERR_PTR(-ENODEV);
245 
246 	pdata = devm_kzalloc(dev,
247 			     sizeof(*pdata) + nchannels * sizeof(*ch),
248 			     GFP_KERNEL);
249 	if (!pdata)
250 		return ERR_PTR(-ENOMEM);
251 	ch = (struct gsc_hwmon_channel *)(pdata + 1);
252 	pdata->channels = ch;
253 	pdata->nchannels = nchannels;
254 
255 	/* fan controller base address */
256 	fan = of_find_compatible_node(dev->parent->of_node, NULL, "gw,gsc-fan");
257 	if (fan && of_property_read_u32(fan, "reg", &pdata->fan_base)) {
258 		dev_err(dev, "fan node without base\n");
259 		return ERR_PTR(-EINVAL);
260 	}
261 
262 	/* allocate structures for channels and count instances of each type */
263 	device_for_each_child_node(dev, child) {
264 		if (fwnode_property_read_string(child, "label", &ch->name)) {
265 			dev_err(dev, "channel without label\n");
266 			fwnode_handle_put(child);
267 			return ERR_PTR(-EINVAL);
268 		}
269 		if (fwnode_property_read_u32(child, "reg", &ch->reg)) {
270 			dev_err(dev, "channel without reg\n");
271 			fwnode_handle_put(child);
272 			return ERR_PTR(-EINVAL);
273 		}
274 		if (fwnode_property_read_u32(child, "gw,mode", &ch->mode)) {
275 			dev_err(dev, "channel without mode\n");
276 			fwnode_handle_put(child);
277 			return ERR_PTR(-EINVAL);
278 		}
279 		if (ch->mode > mode_max) {
280 			dev_err(dev, "invalid channel mode\n");
281 			fwnode_handle_put(child);
282 			return ERR_PTR(-EINVAL);
283 		}
284 
285 		if (!fwnode_property_read_u32(child,
286 					      "gw,voltage-offset-microvolt",
287 					      &ch->mvoffset))
288 			ch->mvoffset /= 1000;
289 		fwnode_property_read_u32_array(child,
290 					       "gw,voltage-divider-ohms",
291 					       ch->vdiv, ARRAY_SIZE(ch->vdiv));
292 		ch++;
293 	}
294 
295 	return pdata;
296 }
297 
298 static int gsc_hwmon_probe(struct platform_device *pdev)
299 {
300 	struct gsc_dev *gsc = dev_get_drvdata(pdev->dev.parent);
301 	struct device *dev = &pdev->dev;
302 	struct device *hwmon_dev;
303 	struct gsc_hwmon_platform_data *pdata = dev_get_platdata(dev);
304 	struct gsc_hwmon_data *hwmon;
305 	const struct attribute_group **groups;
306 	int i, i_in, i_temp;
307 
308 	if (!pdata) {
309 		pdata = gsc_hwmon_get_devtree_pdata(dev);
310 		if (IS_ERR(pdata))
311 			return PTR_ERR(pdata);
312 	}
313 
314 	hwmon = devm_kzalloc(dev, sizeof(*hwmon), GFP_KERNEL);
315 	if (!hwmon)
316 		return -ENOMEM;
317 	hwmon->gsc = gsc;
318 	hwmon->pdata = pdata;
319 
320 	hwmon->regmap = devm_regmap_init(dev, &gsc_hwmon_regmap_bus,
321 					 gsc->i2c_hwmon,
322 					 &gsc_hwmon_regmap_config);
323 	if (IS_ERR(hwmon->regmap))
324 		return PTR_ERR(hwmon->regmap);
325 
326 	for (i = 0, i_in = 0, i_temp = 0; i < hwmon->pdata->nchannels; i++) {
327 		const struct gsc_hwmon_channel *ch = &pdata->channels[i];
328 
329 		switch (ch->mode) {
330 		case mode_temperature:
331 			if (i_temp == GSC_HWMON_MAX_TEMP_CH) {
332 				dev_err(gsc->dev, "too many temp channels\n");
333 				return -EINVAL;
334 			}
335 			hwmon->temp_ch[i_temp] = ch;
336 			hwmon->temp_config[i_temp] = HWMON_T_INPUT |
337 						     HWMON_T_LABEL;
338 			i_temp++;
339 			break;
340 		case mode_voltage_24bit:
341 		case mode_voltage_16bit:
342 		case mode_voltage_raw:
343 			if (i_in == GSC_HWMON_MAX_IN_CH) {
344 				dev_err(gsc->dev, "too many input channels\n");
345 				return -EINVAL;
346 			}
347 			hwmon->in_ch[i_in] = ch;
348 			hwmon->in_config[i_in] =
349 				HWMON_I_INPUT | HWMON_I_LABEL;
350 			i_in++;
351 			break;
352 		default:
353 			dev_err(gsc->dev, "invalid mode: %d\n", ch->mode);
354 			return -EINVAL;
355 		}
356 	}
357 
358 	/* setup config structures */
359 	hwmon->chip.ops = &gsc_hwmon_ops;
360 	hwmon->chip.info = hwmon->info;
361 	hwmon->info[0] = &hwmon->temp_info;
362 	hwmon->info[1] = &hwmon->in_info;
363 	hwmon->temp_info.type = hwmon_temp;
364 	hwmon->temp_info.config = hwmon->temp_config;
365 	hwmon->in_info.type = hwmon_in;
366 	hwmon->in_info.config = hwmon->in_config;
367 
368 	groups = pdata->fan_base ? gsc_hwmon_groups : NULL;
369 	hwmon_dev = devm_hwmon_device_register_with_info(dev,
370 							 KBUILD_MODNAME, hwmon,
371 							 &hwmon->chip, groups);
372 	return PTR_ERR_OR_ZERO(hwmon_dev);
373 }
374 
375 static const struct of_device_id gsc_hwmon_of_match[] = {
376 	{ .compatible = "gw,gsc-adc", },
377 	{}
378 };
379 
380 static struct platform_driver gsc_hwmon_driver = {
381 	.driver = {
382 		.name = "gsc-hwmon",
383 		.of_match_table = gsc_hwmon_of_match,
384 	},
385 	.probe = gsc_hwmon_probe,
386 };
387 
388 module_platform_driver(gsc_hwmon_driver);
389 
390 MODULE_AUTHOR("Tim Harvey <tharvey@gateworks.com>");
391 MODULE_DESCRIPTION("GSC hardware monitor driver");
392 MODULE_LICENSE("GPL v2");
393