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