Line data Source code
1 : // SPDX-License-Identifier: GPL-2.0-only
2 : /*
3 : * hwmon.c - part of lm_sensors, Linux kernel modules for hardware monitoring
4 : *
5 : * This file defines the sysfs class "hwmon", for use by sensors drivers.
6 : *
7 : * Copyright (C) 2005 Mark M. Hoffman <mhoffman@lightlink.com>
8 : */
9 :
10 : #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11 :
12 : #include <linux/bitops.h>
13 : #include <linux/device.h>
14 : #include <linux/err.h>
15 : #include <linux/gfp.h>
16 : #include <linux/hwmon.h>
17 : #include <linux/idr.h>
18 : #include <linux/kstrtox.h>
19 : #include <linux/list.h>
20 : #include <linux/module.h>
21 : #include <linux/pci.h>
22 : #include <linux/property.h>
23 : #include <linux/slab.h>
24 : #include <linux/string.h>
25 : #include <linux/thermal.h>
26 :
27 : #define CREATE_TRACE_POINTS
28 : #include <trace/events/hwmon.h>
29 :
30 : #define HWMON_ID_PREFIX "hwmon"
31 : #define HWMON_ID_FORMAT HWMON_ID_PREFIX "%d"
32 :
33 : struct hwmon_device {
34 : const char *name;
35 : const char *label;
36 : struct device dev;
37 : const struct hwmon_chip_info *chip;
38 : struct list_head tzdata;
39 : struct attribute_group group;
40 : const struct attribute_group **groups;
41 : };
42 :
43 : #define to_hwmon_device(d) container_of(d, struct hwmon_device, dev)
44 :
45 : #define MAX_SYSFS_ATTR_NAME_LENGTH 32
46 :
47 : struct hwmon_device_attribute {
48 : struct device_attribute dev_attr;
49 : const struct hwmon_ops *ops;
50 : enum hwmon_sensor_types type;
51 : u32 attr;
52 : int index;
53 : char name[MAX_SYSFS_ATTR_NAME_LENGTH];
54 : };
55 :
56 : #define to_hwmon_attr(d) \
57 : container_of(d, struct hwmon_device_attribute, dev_attr)
58 : #define to_dev_attr(a) container_of(a, struct device_attribute, attr)
59 :
60 : /*
61 : * Thermal zone information
62 : */
63 : struct hwmon_thermal_data {
64 : struct list_head node; /* hwmon tzdata list entry */
65 : struct device *dev; /* Reference to hwmon device */
66 : int index; /* sensor index */
67 : struct thermal_zone_device *tzd;/* thermal zone device */
68 : };
69 :
70 : static ssize_t
71 0 : name_show(struct device *dev, struct device_attribute *attr, char *buf)
72 : {
73 0 : return sprintf(buf, "%s\n", to_hwmon_device(dev)->name);
74 : }
75 : static DEVICE_ATTR_RO(name);
76 :
77 : static ssize_t
78 0 : label_show(struct device *dev, struct device_attribute *attr, char *buf)
79 : {
80 0 : return sysfs_emit(buf, "%s\n", to_hwmon_device(dev)->label);
81 : }
82 : static DEVICE_ATTR_RO(label);
83 :
84 : static struct attribute *hwmon_dev_attrs[] = {
85 : &dev_attr_name.attr,
86 : &dev_attr_label.attr,
87 : NULL
88 : };
89 :
90 0 : static umode_t hwmon_dev_attr_is_visible(struct kobject *kobj,
91 : struct attribute *attr, int n)
92 : {
93 0 : struct device *dev = kobj_to_dev(kobj);
94 0 : struct hwmon_device *hdev = to_hwmon_device(dev);
95 :
96 0 : if (attr == &dev_attr_name.attr && hdev->name == NULL)
97 : return 0;
98 :
99 0 : if (attr == &dev_attr_label.attr && hdev->label == NULL)
100 : return 0;
101 :
102 0 : return attr->mode;
103 : }
104 :
105 : static const struct attribute_group hwmon_dev_attr_group = {
106 : .attrs = hwmon_dev_attrs,
107 : .is_visible = hwmon_dev_attr_is_visible,
108 : };
109 :
110 : static const struct attribute_group *hwmon_dev_attr_groups[] = {
111 : &hwmon_dev_attr_group,
112 : NULL
113 : };
114 :
115 0 : static void hwmon_free_attrs(struct attribute **attrs)
116 : {
117 : int i;
118 :
119 0 : for (i = 0; attrs[i]; i++) {
120 0 : struct device_attribute *dattr = to_dev_attr(attrs[i]);
121 0 : struct hwmon_device_attribute *hattr = to_hwmon_attr(dattr);
122 :
123 0 : kfree(hattr);
124 : }
125 0 : kfree(attrs);
126 0 : }
127 :
128 0 : static void hwmon_dev_release(struct device *dev)
129 : {
130 0 : struct hwmon_device *hwdev = to_hwmon_device(dev);
131 :
132 0 : if (hwdev->group.attrs)
133 0 : hwmon_free_attrs(hwdev->group.attrs);
134 0 : kfree(hwdev->groups);
135 0 : kfree(hwdev->label);
136 0 : kfree(hwdev);
137 0 : }
138 :
139 : static struct class hwmon_class = {
140 : .name = "hwmon",
141 : .dev_groups = hwmon_dev_attr_groups,
142 : .dev_release = hwmon_dev_release,
143 : };
144 :
145 : static DEFINE_IDA(hwmon_ida);
146 :
147 : /* Thermal zone handling */
148 :
149 : /*
150 : * The complex conditional is necessary to avoid a cyclic dependency
151 : * between hwmon and thermal_sys modules.
152 : */
153 : #ifdef CONFIG_THERMAL_OF
154 : static int hwmon_thermal_get_temp(struct thermal_zone_device *tz, int *temp)
155 : {
156 : struct hwmon_thermal_data *tdata = thermal_zone_device_priv(tz);
157 : struct hwmon_device *hwdev = to_hwmon_device(tdata->dev);
158 : int ret;
159 : long t;
160 :
161 : ret = hwdev->chip->ops->read(tdata->dev, hwmon_temp, hwmon_temp_input,
162 : tdata->index, &t);
163 : if (ret < 0)
164 : return ret;
165 :
166 : *temp = t;
167 :
168 : return 0;
169 : }
170 :
171 : static int hwmon_thermal_set_trips(struct thermal_zone_device *tz, int low, int high)
172 : {
173 : struct hwmon_thermal_data *tdata = thermal_zone_device_priv(tz);
174 : struct hwmon_device *hwdev = to_hwmon_device(tdata->dev);
175 : const struct hwmon_chip_info *chip = hwdev->chip;
176 : const struct hwmon_channel_info * const *info = chip->info;
177 : unsigned int i;
178 : int err;
179 :
180 : if (!chip->ops->write)
181 : return 0;
182 :
183 : for (i = 0; info[i] && info[i]->type != hwmon_temp; i++)
184 : continue;
185 :
186 : if (!info[i])
187 : return 0;
188 :
189 : if (info[i]->config[tdata->index] & HWMON_T_MIN) {
190 : err = chip->ops->write(tdata->dev, hwmon_temp,
191 : hwmon_temp_min, tdata->index, low);
192 : if (err && err != -EOPNOTSUPP)
193 : return err;
194 : }
195 :
196 : if (info[i]->config[tdata->index] & HWMON_T_MAX) {
197 : err = chip->ops->write(tdata->dev, hwmon_temp,
198 : hwmon_temp_max, tdata->index, high);
199 : if (err && err != -EOPNOTSUPP)
200 : return err;
201 : }
202 :
203 : return 0;
204 : }
205 :
206 : static const struct thermal_zone_device_ops hwmon_thermal_ops = {
207 : .get_temp = hwmon_thermal_get_temp,
208 : .set_trips = hwmon_thermal_set_trips,
209 : };
210 :
211 : static void hwmon_thermal_remove_sensor(void *data)
212 : {
213 : list_del(data);
214 : }
215 :
216 : static int hwmon_thermal_add_sensor(struct device *dev, int index)
217 : {
218 : struct hwmon_device *hwdev = to_hwmon_device(dev);
219 : struct hwmon_thermal_data *tdata;
220 : struct thermal_zone_device *tzd;
221 : int err;
222 :
223 : tdata = devm_kzalloc(dev, sizeof(*tdata), GFP_KERNEL);
224 : if (!tdata)
225 : return -ENOMEM;
226 :
227 : tdata->dev = dev;
228 : tdata->index = index;
229 :
230 : tzd = devm_thermal_of_zone_register(dev, index, tdata,
231 : &hwmon_thermal_ops);
232 : if (IS_ERR(tzd)) {
233 : if (PTR_ERR(tzd) != -ENODEV)
234 : return PTR_ERR(tzd);
235 : dev_info(dev, "temp%d_input not attached to any thermal zone\n",
236 : index + 1);
237 : devm_kfree(dev, tdata);
238 : return 0;
239 : }
240 :
241 : err = devm_add_action(dev, hwmon_thermal_remove_sensor, &tdata->node);
242 : if (err)
243 : return err;
244 :
245 : tdata->tzd = tzd;
246 : list_add(&tdata->node, &hwdev->tzdata);
247 :
248 : return 0;
249 : }
250 :
251 : static int hwmon_thermal_register_sensors(struct device *dev)
252 : {
253 : struct hwmon_device *hwdev = to_hwmon_device(dev);
254 : const struct hwmon_chip_info *chip = hwdev->chip;
255 : const struct hwmon_channel_info * const *info = chip->info;
256 : void *drvdata = dev_get_drvdata(dev);
257 : int i;
258 :
259 : for (i = 1; info[i]; i++) {
260 : int j;
261 :
262 : if (info[i]->type != hwmon_temp)
263 : continue;
264 :
265 : for (j = 0; info[i]->config[j]; j++) {
266 : int err;
267 :
268 : if (!(info[i]->config[j] & HWMON_T_INPUT) ||
269 : !chip->ops->is_visible(drvdata, hwmon_temp,
270 : hwmon_temp_input, j))
271 : continue;
272 :
273 : err = hwmon_thermal_add_sensor(dev, j);
274 : if (err)
275 : return err;
276 : }
277 : }
278 :
279 : return 0;
280 : }
281 :
282 : static void hwmon_thermal_notify(struct device *dev, int index)
283 : {
284 : struct hwmon_device *hwdev = to_hwmon_device(dev);
285 : struct hwmon_thermal_data *tzdata;
286 :
287 : list_for_each_entry(tzdata, &hwdev->tzdata, node) {
288 : if (tzdata->index == index) {
289 : thermal_zone_device_update(tzdata->tzd,
290 : THERMAL_EVENT_UNSPECIFIED);
291 : }
292 : }
293 : }
294 :
295 : #else
296 : static int hwmon_thermal_register_sensors(struct device *dev)
297 : {
298 : return 0;
299 : }
300 :
301 : static void hwmon_thermal_notify(struct device *dev, int index) { }
302 :
303 : #endif /* IS_REACHABLE(CONFIG_THERMAL) && ... */
304 :
305 : static int hwmon_attr_base(enum hwmon_sensor_types type)
306 : {
307 0 : if (type == hwmon_in || type == hwmon_intrusion)
308 : return 0;
309 : return 1;
310 : }
311 :
312 : /* sysfs attribute management */
313 :
314 0 : static ssize_t hwmon_attr_show(struct device *dev,
315 : struct device_attribute *devattr, char *buf)
316 : {
317 0 : struct hwmon_device_attribute *hattr = to_hwmon_attr(devattr);
318 : long val;
319 : int ret;
320 :
321 0 : ret = hattr->ops->read(dev, hattr->type, hattr->attr, hattr->index,
322 : &val);
323 0 : if (ret < 0)
324 0 : return ret;
325 :
326 0 : trace_hwmon_attr_show(hattr->index + hwmon_attr_base(hattr->type),
327 0 : hattr->name, val);
328 :
329 0 : return sprintf(buf, "%ld\n", val);
330 : }
331 :
332 0 : static ssize_t hwmon_attr_show_string(struct device *dev,
333 : struct device_attribute *devattr,
334 : char *buf)
335 : {
336 0 : struct hwmon_device_attribute *hattr = to_hwmon_attr(devattr);
337 0 : enum hwmon_sensor_types type = hattr->type;
338 : const char *s;
339 : int ret;
340 :
341 0 : ret = hattr->ops->read_string(dev, hattr->type, hattr->attr,
342 : hattr->index, &s);
343 0 : if (ret < 0)
344 0 : return ret;
345 :
346 0 : trace_hwmon_attr_show_string(hattr->index + hwmon_attr_base(type),
347 0 : hattr->name, s);
348 :
349 0 : return sprintf(buf, "%s\n", s);
350 : }
351 :
352 0 : static ssize_t hwmon_attr_store(struct device *dev,
353 : struct device_attribute *devattr,
354 : const char *buf, size_t count)
355 : {
356 0 : struct hwmon_device_attribute *hattr = to_hwmon_attr(devattr);
357 : long val;
358 : int ret;
359 :
360 0 : ret = kstrtol(buf, 10, &val);
361 0 : if (ret < 0)
362 0 : return ret;
363 :
364 0 : ret = hattr->ops->write(dev, hattr->type, hattr->attr, hattr->index,
365 : val);
366 0 : if (ret < 0)
367 0 : return ret;
368 :
369 0 : trace_hwmon_attr_store(hattr->index + hwmon_attr_base(hattr->type),
370 0 : hattr->name, val);
371 :
372 0 : return count;
373 : }
374 :
375 0 : static bool is_string_attr(enum hwmon_sensor_types type, u32 attr)
376 : {
377 0 : return (type == hwmon_temp && attr == hwmon_temp_label) ||
378 0 : (type == hwmon_in && attr == hwmon_in_label) ||
379 0 : (type == hwmon_curr && attr == hwmon_curr_label) ||
380 0 : (type == hwmon_power && attr == hwmon_power_label) ||
381 0 : (type == hwmon_energy && attr == hwmon_energy_label) ||
382 0 : (type == hwmon_humidity && attr == hwmon_humidity_label) ||
383 0 : (type == hwmon_fan && attr == hwmon_fan_label);
384 : }
385 :
386 0 : static struct attribute *hwmon_genattr(const void *drvdata,
387 : enum hwmon_sensor_types type,
388 : u32 attr,
389 : int index,
390 : const char *template,
391 : const struct hwmon_ops *ops)
392 : {
393 : struct hwmon_device_attribute *hattr;
394 : struct device_attribute *dattr;
395 : struct attribute *a;
396 : umode_t mode;
397 : const char *name;
398 0 : bool is_string = is_string_attr(type, attr);
399 :
400 : /* The attribute is invisible if there is no template string */
401 0 : if (!template)
402 : return ERR_PTR(-ENOENT);
403 :
404 0 : mode = ops->is_visible(drvdata, type, attr, index);
405 0 : if (!mode)
406 : return ERR_PTR(-ENOENT);
407 :
408 0 : if ((mode & 0444) && ((is_string && !ops->read_string) ||
409 0 : (!is_string && !ops->read)))
410 : return ERR_PTR(-EINVAL);
411 0 : if ((mode & 0222) && !ops->write)
412 : return ERR_PTR(-EINVAL);
413 :
414 0 : hattr = kzalloc(sizeof(*hattr), GFP_KERNEL);
415 0 : if (!hattr)
416 : return ERR_PTR(-ENOMEM);
417 :
418 0 : if (type == hwmon_chip) {
419 : name = template;
420 : } else {
421 0 : scnprintf(hattr->name, sizeof(hattr->name), template,
422 0 : index + hwmon_attr_base(type));
423 0 : name = hattr->name;
424 : }
425 :
426 0 : hattr->type = type;
427 0 : hattr->attr = attr;
428 0 : hattr->index = index;
429 0 : hattr->ops = ops;
430 :
431 0 : dattr = &hattr->dev_attr;
432 0 : dattr->show = is_string ? hwmon_attr_show_string : hwmon_attr_show;
433 0 : dattr->store = hwmon_attr_store;
434 :
435 0 : a = &dattr->attr;
436 : sysfs_attr_init(a);
437 0 : a->name = name;
438 0 : a->mode = mode;
439 :
440 0 : return a;
441 : }
442 :
443 : /*
444 : * Chip attributes are not attribute templates but actual sysfs attributes.
445 : * See hwmon_genattr() for special handling.
446 : */
447 : static const char * const hwmon_chip_attrs[] = {
448 : [hwmon_chip_temp_reset_history] = "temp_reset_history",
449 : [hwmon_chip_in_reset_history] = "in_reset_history",
450 : [hwmon_chip_curr_reset_history] = "curr_reset_history",
451 : [hwmon_chip_power_reset_history] = "power_reset_history",
452 : [hwmon_chip_update_interval] = "update_interval",
453 : [hwmon_chip_alarms] = "alarms",
454 : [hwmon_chip_samples] = "samples",
455 : [hwmon_chip_curr_samples] = "curr_samples",
456 : [hwmon_chip_in_samples] = "in_samples",
457 : [hwmon_chip_power_samples] = "power_samples",
458 : [hwmon_chip_temp_samples] = "temp_samples",
459 : };
460 :
461 : static const char * const hwmon_temp_attr_templates[] = {
462 : [hwmon_temp_enable] = "temp%d_enable",
463 : [hwmon_temp_input] = "temp%d_input",
464 : [hwmon_temp_type] = "temp%d_type",
465 : [hwmon_temp_lcrit] = "temp%d_lcrit",
466 : [hwmon_temp_lcrit_hyst] = "temp%d_lcrit_hyst",
467 : [hwmon_temp_min] = "temp%d_min",
468 : [hwmon_temp_min_hyst] = "temp%d_min_hyst",
469 : [hwmon_temp_max] = "temp%d_max",
470 : [hwmon_temp_max_hyst] = "temp%d_max_hyst",
471 : [hwmon_temp_crit] = "temp%d_crit",
472 : [hwmon_temp_crit_hyst] = "temp%d_crit_hyst",
473 : [hwmon_temp_emergency] = "temp%d_emergency",
474 : [hwmon_temp_emergency_hyst] = "temp%d_emergency_hyst",
475 : [hwmon_temp_alarm] = "temp%d_alarm",
476 : [hwmon_temp_lcrit_alarm] = "temp%d_lcrit_alarm",
477 : [hwmon_temp_min_alarm] = "temp%d_min_alarm",
478 : [hwmon_temp_max_alarm] = "temp%d_max_alarm",
479 : [hwmon_temp_crit_alarm] = "temp%d_crit_alarm",
480 : [hwmon_temp_emergency_alarm] = "temp%d_emergency_alarm",
481 : [hwmon_temp_fault] = "temp%d_fault",
482 : [hwmon_temp_offset] = "temp%d_offset",
483 : [hwmon_temp_label] = "temp%d_label",
484 : [hwmon_temp_lowest] = "temp%d_lowest",
485 : [hwmon_temp_highest] = "temp%d_highest",
486 : [hwmon_temp_reset_history] = "temp%d_reset_history",
487 : [hwmon_temp_rated_min] = "temp%d_rated_min",
488 : [hwmon_temp_rated_max] = "temp%d_rated_max",
489 : };
490 :
491 : static const char * const hwmon_in_attr_templates[] = {
492 : [hwmon_in_enable] = "in%d_enable",
493 : [hwmon_in_input] = "in%d_input",
494 : [hwmon_in_min] = "in%d_min",
495 : [hwmon_in_max] = "in%d_max",
496 : [hwmon_in_lcrit] = "in%d_lcrit",
497 : [hwmon_in_crit] = "in%d_crit",
498 : [hwmon_in_average] = "in%d_average",
499 : [hwmon_in_lowest] = "in%d_lowest",
500 : [hwmon_in_highest] = "in%d_highest",
501 : [hwmon_in_reset_history] = "in%d_reset_history",
502 : [hwmon_in_label] = "in%d_label",
503 : [hwmon_in_alarm] = "in%d_alarm",
504 : [hwmon_in_min_alarm] = "in%d_min_alarm",
505 : [hwmon_in_max_alarm] = "in%d_max_alarm",
506 : [hwmon_in_lcrit_alarm] = "in%d_lcrit_alarm",
507 : [hwmon_in_crit_alarm] = "in%d_crit_alarm",
508 : [hwmon_in_rated_min] = "in%d_rated_min",
509 : [hwmon_in_rated_max] = "in%d_rated_max",
510 : };
511 :
512 : static const char * const hwmon_curr_attr_templates[] = {
513 : [hwmon_curr_enable] = "curr%d_enable",
514 : [hwmon_curr_input] = "curr%d_input",
515 : [hwmon_curr_min] = "curr%d_min",
516 : [hwmon_curr_max] = "curr%d_max",
517 : [hwmon_curr_lcrit] = "curr%d_lcrit",
518 : [hwmon_curr_crit] = "curr%d_crit",
519 : [hwmon_curr_average] = "curr%d_average",
520 : [hwmon_curr_lowest] = "curr%d_lowest",
521 : [hwmon_curr_highest] = "curr%d_highest",
522 : [hwmon_curr_reset_history] = "curr%d_reset_history",
523 : [hwmon_curr_label] = "curr%d_label",
524 : [hwmon_curr_alarm] = "curr%d_alarm",
525 : [hwmon_curr_min_alarm] = "curr%d_min_alarm",
526 : [hwmon_curr_max_alarm] = "curr%d_max_alarm",
527 : [hwmon_curr_lcrit_alarm] = "curr%d_lcrit_alarm",
528 : [hwmon_curr_crit_alarm] = "curr%d_crit_alarm",
529 : [hwmon_curr_rated_min] = "curr%d_rated_min",
530 : [hwmon_curr_rated_max] = "curr%d_rated_max",
531 : };
532 :
533 : static const char * const hwmon_power_attr_templates[] = {
534 : [hwmon_power_enable] = "power%d_enable",
535 : [hwmon_power_average] = "power%d_average",
536 : [hwmon_power_average_interval] = "power%d_average_interval",
537 : [hwmon_power_average_interval_max] = "power%d_interval_max",
538 : [hwmon_power_average_interval_min] = "power%d_interval_min",
539 : [hwmon_power_average_highest] = "power%d_average_highest",
540 : [hwmon_power_average_lowest] = "power%d_average_lowest",
541 : [hwmon_power_average_max] = "power%d_average_max",
542 : [hwmon_power_average_min] = "power%d_average_min",
543 : [hwmon_power_input] = "power%d_input",
544 : [hwmon_power_input_highest] = "power%d_input_highest",
545 : [hwmon_power_input_lowest] = "power%d_input_lowest",
546 : [hwmon_power_reset_history] = "power%d_reset_history",
547 : [hwmon_power_accuracy] = "power%d_accuracy",
548 : [hwmon_power_cap] = "power%d_cap",
549 : [hwmon_power_cap_hyst] = "power%d_cap_hyst",
550 : [hwmon_power_cap_max] = "power%d_cap_max",
551 : [hwmon_power_cap_min] = "power%d_cap_min",
552 : [hwmon_power_min] = "power%d_min",
553 : [hwmon_power_max] = "power%d_max",
554 : [hwmon_power_lcrit] = "power%d_lcrit",
555 : [hwmon_power_crit] = "power%d_crit",
556 : [hwmon_power_label] = "power%d_label",
557 : [hwmon_power_alarm] = "power%d_alarm",
558 : [hwmon_power_cap_alarm] = "power%d_cap_alarm",
559 : [hwmon_power_min_alarm] = "power%d_min_alarm",
560 : [hwmon_power_max_alarm] = "power%d_max_alarm",
561 : [hwmon_power_lcrit_alarm] = "power%d_lcrit_alarm",
562 : [hwmon_power_crit_alarm] = "power%d_crit_alarm",
563 : [hwmon_power_rated_min] = "power%d_rated_min",
564 : [hwmon_power_rated_max] = "power%d_rated_max",
565 : };
566 :
567 : static const char * const hwmon_energy_attr_templates[] = {
568 : [hwmon_energy_enable] = "energy%d_enable",
569 : [hwmon_energy_input] = "energy%d_input",
570 : [hwmon_energy_label] = "energy%d_label",
571 : };
572 :
573 : static const char * const hwmon_humidity_attr_templates[] = {
574 : [hwmon_humidity_enable] = "humidity%d_enable",
575 : [hwmon_humidity_input] = "humidity%d_input",
576 : [hwmon_humidity_label] = "humidity%d_label",
577 : [hwmon_humidity_min] = "humidity%d_min",
578 : [hwmon_humidity_min_hyst] = "humidity%d_min_hyst",
579 : [hwmon_humidity_max] = "humidity%d_max",
580 : [hwmon_humidity_max_hyst] = "humidity%d_max_hyst",
581 : [hwmon_humidity_alarm] = "humidity%d_alarm",
582 : [hwmon_humidity_fault] = "humidity%d_fault",
583 : [hwmon_humidity_rated_min] = "humidity%d_rated_min",
584 : [hwmon_humidity_rated_max] = "humidity%d_rated_max",
585 : };
586 :
587 : static const char * const hwmon_fan_attr_templates[] = {
588 : [hwmon_fan_enable] = "fan%d_enable",
589 : [hwmon_fan_input] = "fan%d_input",
590 : [hwmon_fan_label] = "fan%d_label",
591 : [hwmon_fan_min] = "fan%d_min",
592 : [hwmon_fan_max] = "fan%d_max",
593 : [hwmon_fan_div] = "fan%d_div",
594 : [hwmon_fan_pulses] = "fan%d_pulses",
595 : [hwmon_fan_target] = "fan%d_target",
596 : [hwmon_fan_alarm] = "fan%d_alarm",
597 : [hwmon_fan_min_alarm] = "fan%d_min_alarm",
598 : [hwmon_fan_max_alarm] = "fan%d_max_alarm",
599 : [hwmon_fan_fault] = "fan%d_fault",
600 : };
601 :
602 : static const char * const hwmon_pwm_attr_templates[] = {
603 : [hwmon_pwm_input] = "pwm%d",
604 : [hwmon_pwm_enable] = "pwm%d_enable",
605 : [hwmon_pwm_mode] = "pwm%d_mode",
606 : [hwmon_pwm_freq] = "pwm%d_freq",
607 : [hwmon_pwm_auto_channels_temp] = "pwm%d_auto_channels_temp",
608 : };
609 :
610 : static const char * const hwmon_intrusion_attr_templates[] = {
611 : [hwmon_intrusion_alarm] = "intrusion%d_alarm",
612 : [hwmon_intrusion_beep] = "intrusion%d_beep",
613 : };
614 :
615 : static const char * const *__templates[] = {
616 : [hwmon_chip] = hwmon_chip_attrs,
617 : [hwmon_temp] = hwmon_temp_attr_templates,
618 : [hwmon_in] = hwmon_in_attr_templates,
619 : [hwmon_curr] = hwmon_curr_attr_templates,
620 : [hwmon_power] = hwmon_power_attr_templates,
621 : [hwmon_energy] = hwmon_energy_attr_templates,
622 : [hwmon_humidity] = hwmon_humidity_attr_templates,
623 : [hwmon_fan] = hwmon_fan_attr_templates,
624 : [hwmon_pwm] = hwmon_pwm_attr_templates,
625 : [hwmon_intrusion] = hwmon_intrusion_attr_templates,
626 : };
627 :
628 : static const int __templates_size[] = {
629 : [hwmon_chip] = ARRAY_SIZE(hwmon_chip_attrs),
630 : [hwmon_temp] = ARRAY_SIZE(hwmon_temp_attr_templates),
631 : [hwmon_in] = ARRAY_SIZE(hwmon_in_attr_templates),
632 : [hwmon_curr] = ARRAY_SIZE(hwmon_curr_attr_templates),
633 : [hwmon_power] = ARRAY_SIZE(hwmon_power_attr_templates),
634 : [hwmon_energy] = ARRAY_SIZE(hwmon_energy_attr_templates),
635 : [hwmon_humidity] = ARRAY_SIZE(hwmon_humidity_attr_templates),
636 : [hwmon_fan] = ARRAY_SIZE(hwmon_fan_attr_templates),
637 : [hwmon_pwm] = ARRAY_SIZE(hwmon_pwm_attr_templates),
638 : [hwmon_intrusion] = ARRAY_SIZE(hwmon_intrusion_attr_templates),
639 : };
640 :
641 0 : int hwmon_notify_event(struct device *dev, enum hwmon_sensor_types type,
642 : u32 attr, int channel)
643 : {
644 : char event[MAX_SYSFS_ATTR_NAME_LENGTH + 5];
645 : char sattr[MAX_SYSFS_ATTR_NAME_LENGTH];
646 0 : char *envp[] = { event, NULL };
647 : const char * const *templates;
648 : const char *template;
649 : int base;
650 :
651 0 : if (type >= ARRAY_SIZE(__templates))
652 : return -EINVAL;
653 0 : if (attr >= __templates_size[type])
654 : return -EINVAL;
655 :
656 0 : templates = __templates[type];
657 0 : template = templates[attr];
658 :
659 0 : base = hwmon_attr_base(type);
660 :
661 0 : scnprintf(sattr, MAX_SYSFS_ATTR_NAME_LENGTH, template, base + channel);
662 0 : scnprintf(event, sizeof(event), "NAME=%s", sattr);
663 0 : sysfs_notify(&dev->kobj, NULL, sattr);
664 0 : kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp);
665 :
666 : if (type == hwmon_temp)
667 : hwmon_thermal_notify(dev, channel);
668 :
669 0 : return 0;
670 : }
671 : EXPORT_SYMBOL_GPL(hwmon_notify_event);
672 :
673 0 : static int hwmon_num_channel_attrs(const struct hwmon_channel_info *info)
674 : {
675 : int i, n;
676 :
677 0 : for (i = n = 0; info->config[i]; i++)
678 0 : n += hweight32(info->config[i]);
679 :
680 0 : return n;
681 : }
682 :
683 0 : static int hwmon_genattrs(const void *drvdata,
684 : struct attribute **attrs,
685 : const struct hwmon_ops *ops,
686 : const struct hwmon_channel_info *info)
687 : {
688 : const char * const *templates;
689 : int template_size;
690 0 : int i, aindex = 0;
691 :
692 0 : if (info->type >= ARRAY_SIZE(__templates))
693 : return -EINVAL;
694 :
695 0 : templates = __templates[info->type];
696 0 : template_size = __templates_size[info->type];
697 :
698 0 : for (i = 0; info->config[i]; i++) {
699 : u32 attr_mask = info->config[i];
700 : u32 attr;
701 :
702 0 : while (attr_mask) {
703 : struct attribute *a;
704 :
705 0 : attr = __ffs(attr_mask);
706 0 : attr_mask &= ~BIT(attr);
707 0 : if (attr >= template_size)
708 : return -EINVAL;
709 0 : a = hwmon_genattr(drvdata, info->type, attr, i,
710 0 : templates[attr], ops);
711 0 : if (IS_ERR(a)) {
712 0 : if (PTR_ERR(a) != -ENOENT)
713 0 : return PTR_ERR(a);
714 0 : continue;
715 : }
716 0 : attrs[aindex++] = a;
717 : }
718 : }
719 : return aindex;
720 : }
721 :
722 : static struct attribute **
723 0 : __hwmon_create_attrs(const void *drvdata, const struct hwmon_chip_info *chip)
724 : {
725 0 : int ret, i, aindex = 0, nattrs = 0;
726 : struct attribute **attrs;
727 :
728 0 : for (i = 0; chip->info[i]; i++)
729 0 : nattrs += hwmon_num_channel_attrs(chip->info[i]);
730 :
731 0 : if (nattrs == 0)
732 : return ERR_PTR(-EINVAL);
733 :
734 0 : attrs = kcalloc(nattrs + 1, sizeof(*attrs), GFP_KERNEL);
735 0 : if (!attrs)
736 : return ERR_PTR(-ENOMEM);
737 :
738 0 : for (i = 0; chip->info[i]; i++) {
739 0 : ret = hwmon_genattrs(drvdata, &attrs[aindex], chip->ops,
740 : chip->info[i]);
741 0 : if (ret < 0) {
742 0 : hwmon_free_attrs(attrs);
743 0 : return ERR_PTR(ret);
744 : }
745 0 : aindex += ret;
746 : }
747 :
748 : return attrs;
749 : }
750 :
751 : static struct device *
752 0 : __hwmon_device_register(struct device *dev, const char *name, void *drvdata,
753 : const struct hwmon_chip_info *chip,
754 : const struct attribute_group **groups)
755 : {
756 : struct hwmon_device *hwdev;
757 : const char *label;
758 : struct device *hdev;
759 0 : struct device *tdev = dev;
760 : int i, err, id;
761 :
762 : /* Complain about invalid characters in hwmon name attribute */
763 0 : if (name && (!strlen(name) || strpbrk(name, "-* \t\n")))
764 0 : dev_warn(dev,
765 : "hwmon: '%s' is not a valid name attribute, please fix\n",
766 : name);
767 :
768 0 : id = ida_alloc(&hwmon_ida, GFP_KERNEL);
769 0 : if (id < 0)
770 0 : return ERR_PTR(id);
771 :
772 0 : hwdev = kzalloc(sizeof(*hwdev), GFP_KERNEL);
773 0 : if (hwdev == NULL) {
774 : err = -ENOMEM;
775 : goto ida_remove;
776 : }
777 :
778 0 : hdev = &hwdev->dev;
779 :
780 0 : if (chip) {
781 : struct attribute **attrs;
782 0 : int ngroups = 2; /* terminating NULL plus &hwdev->groups */
783 :
784 0 : if (groups)
785 0 : for (i = 0; groups[i]; i++)
786 0 : ngroups++;
787 :
788 0 : hwdev->groups = kcalloc(ngroups, sizeof(*groups), GFP_KERNEL);
789 0 : if (!hwdev->groups) {
790 : err = -ENOMEM;
791 : goto free_hwmon;
792 : }
793 :
794 0 : attrs = __hwmon_create_attrs(drvdata, chip);
795 0 : if (IS_ERR(attrs)) {
796 0 : err = PTR_ERR(attrs);
797 0 : goto free_hwmon;
798 : }
799 :
800 0 : hwdev->group.attrs = attrs;
801 0 : ngroups = 0;
802 0 : hwdev->groups[ngroups++] = &hwdev->group;
803 :
804 0 : if (groups) {
805 0 : for (i = 0; groups[i]; i++)
806 0 : hwdev->groups[ngroups++] = groups[i];
807 : }
808 :
809 0 : hdev->groups = hwdev->groups;
810 : } else {
811 0 : hdev->groups = groups;
812 : }
813 :
814 0 : if (dev && device_property_present(dev, "label")) {
815 0 : err = device_property_read_string(dev, "label", &label);
816 0 : if (err < 0)
817 : goto free_hwmon;
818 :
819 0 : hwdev->label = kstrdup(label, GFP_KERNEL);
820 0 : if (hwdev->label == NULL) {
821 : err = -ENOMEM;
822 : goto free_hwmon;
823 : }
824 : }
825 :
826 0 : hwdev->name = name;
827 0 : hdev->class = &hwmon_class;
828 0 : hdev->parent = dev;
829 0 : while (tdev && !tdev->of_node)
830 0 : tdev = tdev->parent;
831 0 : hdev->of_node = tdev ? tdev->of_node : NULL;
832 0 : hwdev->chip = chip;
833 0 : dev_set_drvdata(hdev, drvdata);
834 0 : dev_set_name(hdev, HWMON_ID_FORMAT, id);
835 0 : err = device_register(hdev);
836 0 : if (err) {
837 0 : put_device(hdev);
838 0 : goto ida_remove;
839 : }
840 :
841 0 : INIT_LIST_HEAD(&hwdev->tzdata);
842 :
843 0 : if (hdev->of_node && chip && chip->ops->read &&
844 0 : chip->info[0]->type == hwmon_chip &&
845 : (chip->info[0]->config[0] & HWMON_C_REGISTER_TZ)) {
846 : err = hwmon_thermal_register_sensors(hdev);
847 : if (err) {
848 : device_unregister(hdev);
849 : /*
850 : * Don't worry about hwdev; hwmon_dev_release(), called
851 : * from device_unregister(), will free it.
852 : */
853 : goto ida_remove;
854 : }
855 : }
856 :
857 : return hdev;
858 :
859 : free_hwmon:
860 0 : hwmon_dev_release(hdev);
861 : ida_remove:
862 0 : ida_free(&hwmon_ida, id);
863 0 : return ERR_PTR(err);
864 : }
865 :
866 : /**
867 : * hwmon_device_register_with_groups - register w/ hwmon
868 : * @dev: the parent device
869 : * @name: hwmon name attribute
870 : * @drvdata: driver data to attach to created device
871 : * @groups: List of attribute groups to create
872 : *
873 : * hwmon_device_unregister() must be called when the device is no
874 : * longer needed.
875 : *
876 : * Returns the pointer to the new device.
877 : */
878 : struct device *
879 0 : hwmon_device_register_with_groups(struct device *dev, const char *name,
880 : void *drvdata,
881 : const struct attribute_group **groups)
882 : {
883 0 : if (!name)
884 : return ERR_PTR(-EINVAL);
885 :
886 0 : return __hwmon_device_register(dev, name, drvdata, NULL, groups);
887 : }
888 : EXPORT_SYMBOL_GPL(hwmon_device_register_with_groups);
889 :
890 : /**
891 : * hwmon_device_register_with_info - register w/ hwmon
892 : * @dev: the parent device (mandatory)
893 : * @name: hwmon name attribute (mandatory)
894 : * @drvdata: driver data to attach to created device (optional)
895 : * @chip: pointer to hwmon chip information (mandatory)
896 : * @extra_groups: pointer to list of additional non-standard attribute groups
897 : * (optional)
898 : *
899 : * hwmon_device_unregister() must be called when the device is no
900 : * longer needed.
901 : *
902 : * Returns the pointer to the new device.
903 : */
904 : struct device *
905 0 : hwmon_device_register_with_info(struct device *dev, const char *name,
906 : void *drvdata,
907 : const struct hwmon_chip_info *chip,
908 : const struct attribute_group **extra_groups)
909 : {
910 0 : if (!dev || !name || !chip)
911 : return ERR_PTR(-EINVAL);
912 :
913 0 : if (!chip->ops || !chip->ops->is_visible || !chip->info)
914 : return ERR_PTR(-EINVAL);
915 :
916 0 : return __hwmon_device_register(dev, name, drvdata, chip, extra_groups);
917 : }
918 : EXPORT_SYMBOL_GPL(hwmon_device_register_with_info);
919 :
920 : /**
921 : * hwmon_device_register_for_thermal - register hwmon device for thermal subsystem
922 : * @dev: the parent device
923 : * @name: hwmon name attribute
924 : * @drvdata: driver data to attach to created device
925 : *
926 : * The use of this function is restricted. It is provided for legacy reasons
927 : * and must only be called from the thermal subsystem.
928 : *
929 : * hwmon_device_unregister() must be called when the device is no
930 : * longer needed.
931 : *
932 : * Returns the pointer to the new device.
933 : */
934 : struct device *
935 0 : hwmon_device_register_for_thermal(struct device *dev, const char *name,
936 : void *drvdata)
937 : {
938 0 : if (!name || !dev)
939 : return ERR_PTR(-EINVAL);
940 :
941 0 : return __hwmon_device_register(dev, name, drvdata, NULL, NULL);
942 : }
943 : EXPORT_SYMBOL_NS_GPL(hwmon_device_register_for_thermal, HWMON_THERMAL);
944 :
945 : /**
946 : * hwmon_device_register - register w/ hwmon
947 : * @dev: the device to register
948 : *
949 : * hwmon_device_unregister() must be called when the device is no
950 : * longer needed.
951 : *
952 : * Returns the pointer to the new device.
953 : */
954 0 : struct device *hwmon_device_register(struct device *dev)
955 : {
956 0 : dev_warn(dev,
957 : "hwmon_device_register() is deprecated. Please convert the driver to use hwmon_device_register_with_info().\n");
958 :
959 0 : return __hwmon_device_register(dev, NULL, NULL, NULL, NULL);
960 : }
961 : EXPORT_SYMBOL_GPL(hwmon_device_register);
962 :
963 : /**
964 : * hwmon_device_unregister - removes the previously registered class device
965 : *
966 : * @dev: the class device to destroy
967 : */
968 0 : void hwmon_device_unregister(struct device *dev)
969 : {
970 : int id;
971 :
972 0 : if (likely(sscanf(dev_name(dev), HWMON_ID_FORMAT, &id) == 1)) {
973 0 : device_unregister(dev);
974 0 : ida_free(&hwmon_ida, id);
975 : } else
976 : dev_dbg(dev->parent,
977 : "hwmon_device_unregister() failed: bad class ID!\n");
978 0 : }
979 : EXPORT_SYMBOL_GPL(hwmon_device_unregister);
980 :
981 0 : static void devm_hwmon_release(struct device *dev, void *res)
982 : {
983 0 : struct device *hwdev = *(struct device **)res;
984 :
985 0 : hwmon_device_unregister(hwdev);
986 0 : }
987 :
988 : /**
989 : * devm_hwmon_device_register_with_groups - register w/ hwmon
990 : * @dev: the parent device
991 : * @name: hwmon name attribute
992 : * @drvdata: driver data to attach to created device
993 : * @groups: List of attribute groups to create
994 : *
995 : * Returns the pointer to the new device. The new device is automatically
996 : * unregistered with the parent device.
997 : */
998 : struct device *
999 0 : devm_hwmon_device_register_with_groups(struct device *dev, const char *name,
1000 : void *drvdata,
1001 : const struct attribute_group **groups)
1002 : {
1003 : struct device **ptr, *hwdev;
1004 :
1005 0 : if (!dev)
1006 : return ERR_PTR(-EINVAL);
1007 :
1008 0 : ptr = devres_alloc(devm_hwmon_release, sizeof(*ptr), GFP_KERNEL);
1009 0 : if (!ptr)
1010 : return ERR_PTR(-ENOMEM);
1011 :
1012 0 : hwdev = hwmon_device_register_with_groups(dev, name, drvdata, groups);
1013 0 : if (IS_ERR(hwdev))
1014 : goto error;
1015 :
1016 0 : *ptr = hwdev;
1017 0 : devres_add(dev, ptr);
1018 0 : return hwdev;
1019 :
1020 : error:
1021 0 : devres_free(ptr);
1022 0 : return hwdev;
1023 : }
1024 : EXPORT_SYMBOL_GPL(devm_hwmon_device_register_with_groups);
1025 :
1026 : /**
1027 : * devm_hwmon_device_register_with_info - register w/ hwmon
1028 : * @dev: the parent device
1029 : * @name: hwmon name attribute
1030 : * @drvdata: driver data to attach to created device
1031 : * @chip: pointer to hwmon chip information
1032 : * @groups: pointer to list of driver specific attribute groups
1033 : *
1034 : * Returns the pointer to the new device. The new device is automatically
1035 : * unregistered with the parent device.
1036 : */
1037 : struct device *
1038 0 : devm_hwmon_device_register_with_info(struct device *dev, const char *name,
1039 : void *drvdata,
1040 : const struct hwmon_chip_info *chip,
1041 : const struct attribute_group **groups)
1042 : {
1043 : struct device **ptr, *hwdev;
1044 :
1045 0 : if (!dev)
1046 : return ERR_PTR(-EINVAL);
1047 :
1048 0 : ptr = devres_alloc(devm_hwmon_release, sizeof(*ptr), GFP_KERNEL);
1049 0 : if (!ptr)
1050 : return ERR_PTR(-ENOMEM);
1051 :
1052 0 : hwdev = hwmon_device_register_with_info(dev, name, drvdata, chip,
1053 : groups);
1054 0 : if (IS_ERR(hwdev))
1055 : goto error;
1056 :
1057 0 : *ptr = hwdev;
1058 0 : devres_add(dev, ptr);
1059 :
1060 0 : return hwdev;
1061 :
1062 : error:
1063 0 : devres_free(ptr);
1064 0 : return hwdev;
1065 : }
1066 : EXPORT_SYMBOL_GPL(devm_hwmon_device_register_with_info);
1067 :
1068 0 : static int devm_hwmon_match(struct device *dev, void *res, void *data)
1069 : {
1070 0 : struct device **hwdev = res;
1071 :
1072 0 : return *hwdev == data;
1073 : }
1074 :
1075 : /**
1076 : * devm_hwmon_device_unregister - removes a previously registered hwmon device
1077 : *
1078 : * @dev: the parent device of the device to unregister
1079 : */
1080 0 : void devm_hwmon_device_unregister(struct device *dev)
1081 : {
1082 0 : WARN_ON(devres_release(dev, devm_hwmon_release, devm_hwmon_match, dev));
1083 0 : }
1084 : EXPORT_SYMBOL_GPL(devm_hwmon_device_unregister);
1085 :
1086 0 : static char *__hwmon_sanitize_name(struct device *dev, const char *old_name)
1087 : {
1088 : char *name, *p;
1089 :
1090 0 : if (dev)
1091 0 : name = devm_kstrdup(dev, old_name, GFP_KERNEL);
1092 : else
1093 0 : name = kstrdup(old_name, GFP_KERNEL);
1094 0 : if (!name)
1095 : return ERR_PTR(-ENOMEM);
1096 :
1097 0 : for (p = name; *p; p++)
1098 0 : if (hwmon_is_bad_char(*p))
1099 0 : *p = '_';
1100 :
1101 : return name;
1102 : }
1103 :
1104 : /**
1105 : * hwmon_sanitize_name - Replaces invalid characters in a hwmon name
1106 : * @name: NUL-terminated name
1107 : *
1108 : * Allocates a new string where any invalid characters will be replaced
1109 : * by an underscore. It is the responsibility of the caller to release
1110 : * the memory.
1111 : *
1112 : * Returns newly allocated name, or ERR_PTR on error.
1113 : */
1114 0 : char *hwmon_sanitize_name(const char *name)
1115 : {
1116 0 : return __hwmon_sanitize_name(NULL, name);
1117 : }
1118 : EXPORT_SYMBOL_GPL(hwmon_sanitize_name);
1119 :
1120 : /**
1121 : * devm_hwmon_sanitize_name - resource managed hwmon_sanitize_name()
1122 : * @dev: device to allocate memory for
1123 : * @name: NUL-terminated name
1124 : *
1125 : * Allocates a new string where any invalid characters will be replaced
1126 : * by an underscore.
1127 : *
1128 : * Returns newly allocated name, or ERR_PTR on error.
1129 : */
1130 0 : char *devm_hwmon_sanitize_name(struct device *dev, const char *name)
1131 : {
1132 0 : if (!dev)
1133 : return ERR_PTR(-EINVAL);
1134 :
1135 0 : return __hwmon_sanitize_name(dev, name);
1136 : }
1137 : EXPORT_SYMBOL_GPL(devm_hwmon_sanitize_name);
1138 :
1139 : static void __init hwmon_pci_quirks(void)
1140 : {
1141 : #if defined CONFIG_X86 && defined CONFIG_PCI
1142 : struct pci_dev *sb;
1143 : u16 base;
1144 : u8 enable;
1145 :
1146 : /* Open access to 0x295-0x296 on MSI MS-7031 */
1147 : sb = pci_get_device(PCI_VENDOR_ID_ATI, 0x436c, NULL);
1148 : if (sb) {
1149 : if (sb->subsystem_vendor == 0x1462 && /* MSI */
1150 : sb->subsystem_device == 0x0031) { /* MS-7031 */
1151 : pci_read_config_byte(sb, 0x48, &enable);
1152 : pci_read_config_word(sb, 0x64, &base);
1153 :
1154 : if (base == 0 && !(enable & BIT(2))) {
1155 : dev_info(&sb->dev,
1156 : "Opening wide generic port at 0x295\n");
1157 : pci_write_config_word(sb, 0x64, 0x295);
1158 : pci_write_config_byte(sb, 0x48,
1159 : enable | BIT(2));
1160 : }
1161 : }
1162 : pci_dev_put(sb);
1163 : }
1164 : #endif
1165 : }
1166 :
1167 1 : static int __init hwmon_init(void)
1168 : {
1169 : int err;
1170 :
1171 : hwmon_pci_quirks();
1172 :
1173 1 : err = class_register(&hwmon_class);
1174 1 : if (err) {
1175 0 : pr_err("couldn't register hwmon sysfs class\n");
1176 0 : return err;
1177 : }
1178 : return 0;
1179 : }
1180 :
1181 0 : static void __exit hwmon_exit(void)
1182 : {
1183 0 : class_unregister(&hwmon_class);
1184 0 : }
1185 :
1186 : subsys_initcall(hwmon_init);
1187 : module_exit(hwmon_exit);
1188 :
1189 : MODULE_AUTHOR("Mark M. Hoffman <mhoffman@lightlink.com>");
1190 : MODULE_DESCRIPTION("hardware monitoring sysfs/class support");
1191 : MODULE_LICENSE("GPL");
1192 :
|
