Linux 4.19.133
[linux/fpc-iii.git] / drivers / hwmon / hwmon.c
blobd34de21d43adb9b03d38db6fd76bd7db698e4e40
1 /*
2 * hwmon.c - part of lm_sensors, Linux kernel modules for hardware monitoring
4 * This file defines the sysfs class "hwmon", for use by sensors drivers.
6 * Copyright (C) 2005 Mark M. Hoffman <mhoffman@lightlink.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; version 2 of the License.
13 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15 #include <linux/bitops.h>
16 #include <linux/device.h>
17 #include <linux/err.h>
18 #include <linux/gfp.h>
19 #include <linux/hwmon.h>
20 #include <linux/idr.h>
21 #include <linux/module.h>
22 #include <linux/pci.h>
23 #include <linux/slab.h>
24 #include <linux/string.h>
25 #include <linux/thermal.h>
27 #define HWMON_ID_PREFIX "hwmon"
28 #define HWMON_ID_FORMAT HWMON_ID_PREFIX "%d"
30 struct hwmon_device {
31 const char *name;
32 struct device dev;
33 const struct hwmon_chip_info *chip;
35 struct attribute_group group;
36 const struct attribute_group **groups;
39 #define to_hwmon_device(d) container_of(d, struct hwmon_device, dev)
41 #define MAX_SYSFS_ATTR_NAME_LENGTH 32
43 struct hwmon_device_attribute {
44 struct device_attribute dev_attr;
45 const struct hwmon_ops *ops;
46 enum hwmon_sensor_types type;
47 u32 attr;
48 int index;
49 char name[MAX_SYSFS_ATTR_NAME_LENGTH];
52 #define to_hwmon_attr(d) \
53 container_of(d, struct hwmon_device_attribute, dev_attr)
54 #define to_dev_attr(a) container_of(a, struct device_attribute, attr)
57 * Thermal zone information
58 * In addition to the reference to the hwmon device,
59 * also provides the sensor index.
61 struct hwmon_thermal_data {
62 struct device *dev; /* Reference to hwmon device */
63 int index; /* sensor index */
66 static ssize_t
67 name_show(struct device *dev, struct device_attribute *attr, char *buf)
69 return sprintf(buf, "%s\n", to_hwmon_device(dev)->name);
71 static DEVICE_ATTR_RO(name);
73 static struct attribute *hwmon_dev_attrs[] = {
74 &dev_attr_name.attr,
75 NULL
78 static umode_t hwmon_dev_name_is_visible(struct kobject *kobj,
79 struct attribute *attr, int n)
81 struct device *dev = container_of(kobj, struct device, kobj);
83 if (to_hwmon_device(dev)->name == NULL)
84 return 0;
86 return attr->mode;
89 static const struct attribute_group hwmon_dev_attr_group = {
90 .attrs = hwmon_dev_attrs,
91 .is_visible = hwmon_dev_name_is_visible,
94 static const struct attribute_group *hwmon_dev_attr_groups[] = {
95 &hwmon_dev_attr_group,
96 NULL
99 static void hwmon_free_attrs(struct attribute **attrs)
101 int i;
103 for (i = 0; attrs[i]; i++) {
104 struct device_attribute *dattr = to_dev_attr(attrs[i]);
105 struct hwmon_device_attribute *hattr = to_hwmon_attr(dattr);
107 kfree(hattr);
109 kfree(attrs);
112 static void hwmon_dev_release(struct device *dev)
114 struct hwmon_device *hwdev = to_hwmon_device(dev);
116 if (hwdev->group.attrs)
117 hwmon_free_attrs(hwdev->group.attrs);
118 kfree(hwdev->groups);
119 kfree(hwdev);
122 static struct class hwmon_class = {
123 .name = "hwmon",
124 .owner = THIS_MODULE,
125 .dev_groups = hwmon_dev_attr_groups,
126 .dev_release = hwmon_dev_release,
129 static DEFINE_IDA(hwmon_ida);
131 /* Thermal zone handling */
134 * The complex conditional is necessary to avoid a cyclic dependency
135 * between hwmon and thermal_sys modules.
137 #if IS_REACHABLE(CONFIG_THERMAL) && defined(CONFIG_THERMAL_OF) && \
138 (!defined(CONFIG_THERMAL_HWMON) || \
139 !(defined(MODULE) && IS_MODULE(CONFIG_THERMAL)))
140 static int hwmon_thermal_get_temp(void *data, int *temp)
142 struct hwmon_thermal_data *tdata = data;
143 struct hwmon_device *hwdev = to_hwmon_device(tdata->dev);
144 int ret;
145 long t;
147 ret = hwdev->chip->ops->read(tdata->dev, hwmon_temp, hwmon_temp_input,
148 tdata->index, &t);
149 if (ret < 0)
150 return ret;
152 *temp = t;
154 return 0;
157 static const struct thermal_zone_of_device_ops hwmon_thermal_ops = {
158 .get_temp = hwmon_thermal_get_temp,
161 static int hwmon_thermal_add_sensor(struct device *dev, int index)
163 struct hwmon_thermal_data *tdata;
164 struct thermal_zone_device *tzd;
166 tdata = devm_kzalloc(dev, sizeof(*tdata), GFP_KERNEL);
167 if (!tdata)
168 return -ENOMEM;
170 tdata->dev = dev;
171 tdata->index = index;
173 tzd = devm_thermal_zone_of_sensor_register(dev, index, tdata,
174 &hwmon_thermal_ops);
176 * If CONFIG_THERMAL_OF is disabled, this returns -ENODEV,
177 * so ignore that error but forward any other error.
179 if (IS_ERR(tzd) && (PTR_ERR(tzd) != -ENODEV))
180 return PTR_ERR(tzd);
182 return 0;
184 #else
185 static int hwmon_thermal_add_sensor(struct device *dev, int index)
187 return 0;
189 #endif /* IS_REACHABLE(CONFIG_THERMAL) && ... */
191 /* sysfs attribute management */
193 static ssize_t hwmon_attr_show(struct device *dev,
194 struct device_attribute *devattr, char *buf)
196 struct hwmon_device_attribute *hattr = to_hwmon_attr(devattr);
197 long val;
198 int ret;
200 ret = hattr->ops->read(dev, hattr->type, hattr->attr, hattr->index,
201 &val);
202 if (ret < 0)
203 return ret;
205 return sprintf(buf, "%ld\n", val);
208 static ssize_t hwmon_attr_show_string(struct device *dev,
209 struct device_attribute *devattr,
210 char *buf)
212 struct hwmon_device_attribute *hattr = to_hwmon_attr(devattr);
213 const char *s;
214 int ret;
216 ret = hattr->ops->read_string(dev, hattr->type, hattr->attr,
217 hattr->index, &s);
218 if (ret < 0)
219 return ret;
221 return sprintf(buf, "%s\n", s);
224 static ssize_t hwmon_attr_store(struct device *dev,
225 struct device_attribute *devattr,
226 const char *buf, size_t count)
228 struct hwmon_device_attribute *hattr = to_hwmon_attr(devattr);
229 long val;
230 int ret;
232 ret = kstrtol(buf, 10, &val);
233 if (ret < 0)
234 return ret;
236 ret = hattr->ops->write(dev, hattr->type, hattr->attr, hattr->index,
237 val);
238 if (ret < 0)
239 return ret;
241 return count;
244 static int hwmon_attr_base(enum hwmon_sensor_types type)
246 if (type == hwmon_in)
247 return 0;
248 return 1;
251 static bool is_string_attr(enum hwmon_sensor_types type, u32 attr)
253 return (type == hwmon_temp && attr == hwmon_temp_label) ||
254 (type == hwmon_in && attr == hwmon_in_label) ||
255 (type == hwmon_curr && attr == hwmon_curr_label) ||
256 (type == hwmon_power && attr == hwmon_power_label) ||
257 (type == hwmon_energy && attr == hwmon_energy_label) ||
258 (type == hwmon_humidity && attr == hwmon_humidity_label) ||
259 (type == hwmon_fan && attr == hwmon_fan_label);
262 static struct attribute *hwmon_genattr(const void *drvdata,
263 enum hwmon_sensor_types type,
264 u32 attr,
265 int index,
266 const char *template,
267 const struct hwmon_ops *ops)
269 struct hwmon_device_attribute *hattr;
270 struct device_attribute *dattr;
271 struct attribute *a;
272 umode_t mode;
273 char *name;
274 bool is_string = is_string_attr(type, attr);
276 /* The attribute is invisible if there is no template string */
277 if (!template)
278 return ERR_PTR(-ENOENT);
280 mode = ops->is_visible(drvdata, type, attr, index);
281 if (!mode)
282 return ERR_PTR(-ENOENT);
284 if ((mode & S_IRUGO) && ((is_string && !ops->read_string) ||
285 (!is_string && !ops->read)))
286 return ERR_PTR(-EINVAL);
287 if ((mode & S_IWUGO) && !ops->write)
288 return ERR_PTR(-EINVAL);
290 hattr = kzalloc(sizeof(*hattr), GFP_KERNEL);
291 if (!hattr)
292 return ERR_PTR(-ENOMEM);
294 if (type == hwmon_chip) {
295 name = (char *)template;
296 } else {
297 scnprintf(hattr->name, sizeof(hattr->name), template,
298 index + hwmon_attr_base(type));
299 name = hattr->name;
302 hattr->type = type;
303 hattr->attr = attr;
304 hattr->index = index;
305 hattr->ops = ops;
307 dattr = &hattr->dev_attr;
308 dattr->show = is_string ? hwmon_attr_show_string : hwmon_attr_show;
309 dattr->store = hwmon_attr_store;
311 a = &dattr->attr;
312 sysfs_attr_init(a);
313 a->name = name;
314 a->mode = mode;
316 return a;
320 * Chip attributes are not attribute templates but actual sysfs attributes.
321 * See hwmon_genattr() for special handling.
323 static const char * const hwmon_chip_attrs[] = {
324 [hwmon_chip_temp_reset_history] = "temp_reset_history",
325 [hwmon_chip_in_reset_history] = "in_reset_history",
326 [hwmon_chip_curr_reset_history] = "curr_reset_history",
327 [hwmon_chip_power_reset_history] = "power_reset_history",
328 [hwmon_chip_update_interval] = "update_interval",
329 [hwmon_chip_alarms] = "alarms",
332 static const char * const hwmon_temp_attr_templates[] = {
333 [hwmon_temp_input] = "temp%d_input",
334 [hwmon_temp_type] = "temp%d_type",
335 [hwmon_temp_lcrit] = "temp%d_lcrit",
336 [hwmon_temp_lcrit_hyst] = "temp%d_lcrit_hyst",
337 [hwmon_temp_min] = "temp%d_min",
338 [hwmon_temp_min_hyst] = "temp%d_min_hyst",
339 [hwmon_temp_max] = "temp%d_max",
340 [hwmon_temp_max_hyst] = "temp%d_max_hyst",
341 [hwmon_temp_crit] = "temp%d_crit",
342 [hwmon_temp_crit_hyst] = "temp%d_crit_hyst",
343 [hwmon_temp_emergency] = "temp%d_emergency",
344 [hwmon_temp_emergency_hyst] = "temp%d_emergency_hyst",
345 [hwmon_temp_alarm] = "temp%d_alarm",
346 [hwmon_temp_lcrit_alarm] = "temp%d_lcrit_alarm",
347 [hwmon_temp_min_alarm] = "temp%d_min_alarm",
348 [hwmon_temp_max_alarm] = "temp%d_max_alarm",
349 [hwmon_temp_crit_alarm] = "temp%d_crit_alarm",
350 [hwmon_temp_emergency_alarm] = "temp%d_emergency_alarm",
351 [hwmon_temp_fault] = "temp%d_fault",
352 [hwmon_temp_offset] = "temp%d_offset",
353 [hwmon_temp_label] = "temp%d_label",
354 [hwmon_temp_lowest] = "temp%d_lowest",
355 [hwmon_temp_highest] = "temp%d_highest",
356 [hwmon_temp_reset_history] = "temp%d_reset_history",
359 static const char * const hwmon_in_attr_templates[] = {
360 [hwmon_in_input] = "in%d_input",
361 [hwmon_in_min] = "in%d_min",
362 [hwmon_in_max] = "in%d_max",
363 [hwmon_in_lcrit] = "in%d_lcrit",
364 [hwmon_in_crit] = "in%d_crit",
365 [hwmon_in_average] = "in%d_average",
366 [hwmon_in_lowest] = "in%d_lowest",
367 [hwmon_in_highest] = "in%d_highest",
368 [hwmon_in_reset_history] = "in%d_reset_history",
369 [hwmon_in_label] = "in%d_label",
370 [hwmon_in_alarm] = "in%d_alarm",
371 [hwmon_in_min_alarm] = "in%d_min_alarm",
372 [hwmon_in_max_alarm] = "in%d_max_alarm",
373 [hwmon_in_lcrit_alarm] = "in%d_lcrit_alarm",
374 [hwmon_in_crit_alarm] = "in%d_crit_alarm",
377 static const char * const hwmon_curr_attr_templates[] = {
378 [hwmon_curr_input] = "curr%d_input",
379 [hwmon_curr_min] = "curr%d_min",
380 [hwmon_curr_max] = "curr%d_max",
381 [hwmon_curr_lcrit] = "curr%d_lcrit",
382 [hwmon_curr_crit] = "curr%d_crit",
383 [hwmon_curr_average] = "curr%d_average",
384 [hwmon_curr_lowest] = "curr%d_lowest",
385 [hwmon_curr_highest] = "curr%d_highest",
386 [hwmon_curr_reset_history] = "curr%d_reset_history",
387 [hwmon_curr_label] = "curr%d_label",
388 [hwmon_curr_alarm] = "curr%d_alarm",
389 [hwmon_curr_min_alarm] = "curr%d_min_alarm",
390 [hwmon_curr_max_alarm] = "curr%d_max_alarm",
391 [hwmon_curr_lcrit_alarm] = "curr%d_lcrit_alarm",
392 [hwmon_curr_crit_alarm] = "curr%d_crit_alarm",
395 static const char * const hwmon_power_attr_templates[] = {
396 [hwmon_power_average] = "power%d_average",
397 [hwmon_power_average_interval] = "power%d_average_interval",
398 [hwmon_power_average_interval_max] = "power%d_interval_max",
399 [hwmon_power_average_interval_min] = "power%d_interval_min",
400 [hwmon_power_average_highest] = "power%d_average_highest",
401 [hwmon_power_average_lowest] = "power%d_average_lowest",
402 [hwmon_power_average_max] = "power%d_average_max",
403 [hwmon_power_average_min] = "power%d_average_min",
404 [hwmon_power_input] = "power%d_input",
405 [hwmon_power_input_highest] = "power%d_input_highest",
406 [hwmon_power_input_lowest] = "power%d_input_lowest",
407 [hwmon_power_reset_history] = "power%d_reset_history",
408 [hwmon_power_accuracy] = "power%d_accuracy",
409 [hwmon_power_cap] = "power%d_cap",
410 [hwmon_power_cap_hyst] = "power%d_cap_hyst",
411 [hwmon_power_cap_max] = "power%d_cap_max",
412 [hwmon_power_cap_min] = "power%d_cap_min",
413 [hwmon_power_min] = "power%d_min",
414 [hwmon_power_max] = "power%d_max",
415 [hwmon_power_lcrit] = "power%d_lcrit",
416 [hwmon_power_crit] = "power%d_crit",
417 [hwmon_power_label] = "power%d_label",
418 [hwmon_power_alarm] = "power%d_alarm",
419 [hwmon_power_cap_alarm] = "power%d_cap_alarm",
420 [hwmon_power_min_alarm] = "power%d_min_alarm",
421 [hwmon_power_max_alarm] = "power%d_max_alarm",
422 [hwmon_power_lcrit_alarm] = "power%d_lcrit_alarm",
423 [hwmon_power_crit_alarm] = "power%d_crit_alarm",
426 static const char * const hwmon_energy_attr_templates[] = {
427 [hwmon_energy_input] = "energy%d_input",
428 [hwmon_energy_label] = "energy%d_label",
431 static const char * const hwmon_humidity_attr_templates[] = {
432 [hwmon_humidity_input] = "humidity%d_input",
433 [hwmon_humidity_label] = "humidity%d_label",
434 [hwmon_humidity_min] = "humidity%d_min",
435 [hwmon_humidity_min_hyst] = "humidity%d_min_hyst",
436 [hwmon_humidity_max] = "humidity%d_max",
437 [hwmon_humidity_max_hyst] = "humidity%d_max_hyst",
438 [hwmon_humidity_alarm] = "humidity%d_alarm",
439 [hwmon_humidity_fault] = "humidity%d_fault",
442 static const char * const hwmon_fan_attr_templates[] = {
443 [hwmon_fan_input] = "fan%d_input",
444 [hwmon_fan_label] = "fan%d_label",
445 [hwmon_fan_min] = "fan%d_min",
446 [hwmon_fan_max] = "fan%d_max",
447 [hwmon_fan_div] = "fan%d_div",
448 [hwmon_fan_pulses] = "fan%d_pulses",
449 [hwmon_fan_target] = "fan%d_target",
450 [hwmon_fan_alarm] = "fan%d_alarm",
451 [hwmon_fan_min_alarm] = "fan%d_min_alarm",
452 [hwmon_fan_max_alarm] = "fan%d_max_alarm",
453 [hwmon_fan_fault] = "fan%d_fault",
456 static const char * const hwmon_pwm_attr_templates[] = {
457 [hwmon_pwm_input] = "pwm%d",
458 [hwmon_pwm_enable] = "pwm%d_enable",
459 [hwmon_pwm_mode] = "pwm%d_mode",
460 [hwmon_pwm_freq] = "pwm%d_freq",
463 static const char * const *__templates[] = {
464 [hwmon_chip] = hwmon_chip_attrs,
465 [hwmon_temp] = hwmon_temp_attr_templates,
466 [hwmon_in] = hwmon_in_attr_templates,
467 [hwmon_curr] = hwmon_curr_attr_templates,
468 [hwmon_power] = hwmon_power_attr_templates,
469 [hwmon_energy] = hwmon_energy_attr_templates,
470 [hwmon_humidity] = hwmon_humidity_attr_templates,
471 [hwmon_fan] = hwmon_fan_attr_templates,
472 [hwmon_pwm] = hwmon_pwm_attr_templates,
475 static const int __templates_size[] = {
476 [hwmon_chip] = ARRAY_SIZE(hwmon_chip_attrs),
477 [hwmon_temp] = ARRAY_SIZE(hwmon_temp_attr_templates),
478 [hwmon_in] = ARRAY_SIZE(hwmon_in_attr_templates),
479 [hwmon_curr] = ARRAY_SIZE(hwmon_curr_attr_templates),
480 [hwmon_power] = ARRAY_SIZE(hwmon_power_attr_templates),
481 [hwmon_energy] = ARRAY_SIZE(hwmon_energy_attr_templates),
482 [hwmon_humidity] = ARRAY_SIZE(hwmon_humidity_attr_templates),
483 [hwmon_fan] = ARRAY_SIZE(hwmon_fan_attr_templates),
484 [hwmon_pwm] = ARRAY_SIZE(hwmon_pwm_attr_templates),
487 static int hwmon_num_channel_attrs(const struct hwmon_channel_info *info)
489 int i, n;
491 for (i = n = 0; info->config[i]; i++)
492 n += hweight32(info->config[i]);
494 return n;
497 static int hwmon_genattrs(const void *drvdata,
498 struct attribute **attrs,
499 const struct hwmon_ops *ops,
500 const struct hwmon_channel_info *info)
502 const char * const *templates;
503 int template_size;
504 int i, aindex = 0;
506 if (info->type >= ARRAY_SIZE(__templates))
507 return -EINVAL;
509 templates = __templates[info->type];
510 template_size = __templates_size[info->type];
512 for (i = 0; info->config[i]; i++) {
513 u32 attr_mask = info->config[i];
514 u32 attr;
516 while (attr_mask) {
517 struct attribute *a;
519 attr = __ffs(attr_mask);
520 attr_mask &= ~BIT(attr);
521 if (attr >= template_size)
522 return -EINVAL;
523 a = hwmon_genattr(drvdata, info->type, attr, i,
524 templates[attr], ops);
525 if (IS_ERR(a)) {
526 if (PTR_ERR(a) != -ENOENT)
527 return PTR_ERR(a);
528 continue;
530 attrs[aindex++] = a;
533 return aindex;
536 static struct attribute **
537 __hwmon_create_attrs(const void *drvdata, const struct hwmon_chip_info *chip)
539 int ret, i, aindex = 0, nattrs = 0;
540 struct attribute **attrs;
542 for (i = 0; chip->info[i]; i++)
543 nattrs += hwmon_num_channel_attrs(chip->info[i]);
545 if (nattrs == 0)
546 return ERR_PTR(-EINVAL);
548 attrs = kcalloc(nattrs + 1, sizeof(*attrs), GFP_KERNEL);
549 if (!attrs)
550 return ERR_PTR(-ENOMEM);
552 for (i = 0; chip->info[i]; i++) {
553 ret = hwmon_genattrs(drvdata, &attrs[aindex], chip->ops,
554 chip->info[i]);
555 if (ret < 0) {
556 hwmon_free_attrs(attrs);
557 return ERR_PTR(ret);
559 aindex += ret;
562 return attrs;
565 static struct device *
566 __hwmon_device_register(struct device *dev, const char *name, void *drvdata,
567 const struct hwmon_chip_info *chip,
568 const struct attribute_group **groups)
570 struct hwmon_device *hwdev;
571 struct device *hdev;
572 int i, j, err, id;
574 /* Complain about invalid characters in hwmon name attribute */
575 if (name && (!strlen(name) || strpbrk(name, "-* \t\n")))
576 dev_warn(dev,
577 "hwmon: '%s' is not a valid name attribute, please fix\n",
578 name);
580 id = ida_simple_get(&hwmon_ida, 0, 0, GFP_KERNEL);
581 if (id < 0)
582 return ERR_PTR(id);
584 hwdev = kzalloc(sizeof(*hwdev), GFP_KERNEL);
585 if (hwdev == NULL) {
586 err = -ENOMEM;
587 goto ida_remove;
590 hdev = &hwdev->dev;
592 if (chip) {
593 struct attribute **attrs;
594 int ngroups = 2; /* terminating NULL plus &hwdev->groups */
596 if (groups)
597 for (i = 0; groups[i]; i++)
598 ngroups++;
600 hwdev->groups = kcalloc(ngroups, sizeof(*groups), GFP_KERNEL);
601 if (!hwdev->groups) {
602 err = -ENOMEM;
603 goto free_hwmon;
606 attrs = __hwmon_create_attrs(drvdata, chip);
607 if (IS_ERR(attrs)) {
608 err = PTR_ERR(attrs);
609 goto free_hwmon;
612 hwdev->group.attrs = attrs;
613 ngroups = 0;
614 hwdev->groups[ngroups++] = &hwdev->group;
616 if (groups) {
617 for (i = 0; groups[i]; i++)
618 hwdev->groups[ngroups++] = groups[i];
621 hdev->groups = hwdev->groups;
622 } else {
623 hdev->groups = groups;
626 hwdev->name = name;
627 hdev->class = &hwmon_class;
628 hdev->parent = dev;
629 hdev->of_node = dev ? dev->of_node : NULL;
630 hwdev->chip = chip;
631 dev_set_drvdata(hdev, drvdata);
632 dev_set_name(hdev, HWMON_ID_FORMAT, id);
633 err = device_register(hdev);
634 if (err)
635 goto free_hwmon;
637 if (dev && dev->of_node && chip && chip->ops->read &&
638 chip->info[0]->type == hwmon_chip &&
639 (chip->info[0]->config[0] & HWMON_C_REGISTER_TZ)) {
640 const struct hwmon_channel_info **info = chip->info;
642 for (i = 1; info[i]; i++) {
643 if (info[i]->type != hwmon_temp)
644 continue;
646 for (j = 0; info[i]->config[j]; j++) {
647 if (!chip->ops->is_visible(drvdata, hwmon_temp,
648 hwmon_temp_input, j))
649 continue;
650 if (info[i]->config[j] & HWMON_T_INPUT) {
651 err = hwmon_thermal_add_sensor(hdev, j);
652 if (err) {
653 device_unregister(hdev);
654 goto ida_remove;
661 return hdev;
663 free_hwmon:
664 hwmon_dev_release(hdev);
665 ida_remove:
666 ida_simple_remove(&hwmon_ida, id);
667 return ERR_PTR(err);
671 * hwmon_device_register_with_groups - register w/ hwmon
672 * @dev: the parent device
673 * @name: hwmon name attribute
674 * @drvdata: driver data to attach to created device
675 * @groups: List of attribute groups to create
677 * hwmon_device_unregister() must be called when the device is no
678 * longer needed.
680 * Returns the pointer to the new device.
682 struct device *
683 hwmon_device_register_with_groups(struct device *dev, const char *name,
684 void *drvdata,
685 const struct attribute_group **groups)
687 if (!name)
688 return ERR_PTR(-EINVAL);
690 return __hwmon_device_register(dev, name, drvdata, NULL, groups);
692 EXPORT_SYMBOL_GPL(hwmon_device_register_with_groups);
695 * hwmon_device_register_with_info - register w/ hwmon
696 * @dev: the parent device
697 * @name: hwmon name attribute
698 * @drvdata: driver data to attach to created device
699 * @chip: pointer to hwmon chip information
700 * @extra_groups: pointer to list of additional non-standard attribute groups
702 * hwmon_device_unregister() must be called when the device is no
703 * longer needed.
705 * Returns the pointer to the new device.
707 struct device *
708 hwmon_device_register_with_info(struct device *dev, const char *name,
709 void *drvdata,
710 const struct hwmon_chip_info *chip,
711 const struct attribute_group **extra_groups)
713 if (!name)
714 return ERR_PTR(-EINVAL);
716 if (chip && (!chip->ops || !chip->ops->is_visible || !chip->info))
717 return ERR_PTR(-EINVAL);
719 if (chip && !dev)
720 return ERR_PTR(-EINVAL);
722 return __hwmon_device_register(dev, name, drvdata, chip, extra_groups);
724 EXPORT_SYMBOL_GPL(hwmon_device_register_with_info);
727 * hwmon_device_register - register w/ hwmon
728 * @dev: the device to register
730 * hwmon_device_unregister() must be called when the device is no
731 * longer needed.
733 * Returns the pointer to the new device.
735 struct device *hwmon_device_register(struct device *dev)
737 dev_warn(dev,
738 "hwmon_device_register() is deprecated. Please convert the driver to use hwmon_device_register_with_info().\n");
740 return __hwmon_device_register(dev, NULL, NULL, NULL, NULL);
742 EXPORT_SYMBOL_GPL(hwmon_device_register);
745 * hwmon_device_unregister - removes the previously registered class device
747 * @dev: the class device to destroy
749 void hwmon_device_unregister(struct device *dev)
751 int id;
753 if (likely(sscanf(dev_name(dev), HWMON_ID_FORMAT, &id) == 1)) {
754 device_unregister(dev);
755 ida_simple_remove(&hwmon_ida, id);
756 } else
757 dev_dbg(dev->parent,
758 "hwmon_device_unregister() failed: bad class ID!\n");
760 EXPORT_SYMBOL_GPL(hwmon_device_unregister);
762 static void devm_hwmon_release(struct device *dev, void *res)
764 struct device *hwdev = *(struct device **)res;
766 hwmon_device_unregister(hwdev);
770 * devm_hwmon_device_register_with_groups - register w/ hwmon
771 * @dev: the parent device
772 * @name: hwmon name attribute
773 * @drvdata: driver data to attach to created device
774 * @groups: List of attribute groups to create
776 * Returns the pointer to the new device. The new device is automatically
777 * unregistered with the parent device.
779 struct device *
780 devm_hwmon_device_register_with_groups(struct device *dev, const char *name,
781 void *drvdata,
782 const struct attribute_group **groups)
784 struct device **ptr, *hwdev;
786 if (!dev)
787 return ERR_PTR(-EINVAL);
789 ptr = devres_alloc(devm_hwmon_release, sizeof(*ptr), GFP_KERNEL);
790 if (!ptr)
791 return ERR_PTR(-ENOMEM);
793 hwdev = hwmon_device_register_with_groups(dev, name, drvdata, groups);
794 if (IS_ERR(hwdev))
795 goto error;
797 *ptr = hwdev;
798 devres_add(dev, ptr);
799 return hwdev;
801 error:
802 devres_free(ptr);
803 return hwdev;
805 EXPORT_SYMBOL_GPL(devm_hwmon_device_register_with_groups);
808 * devm_hwmon_device_register_with_info - register w/ hwmon
809 * @dev: the parent device
810 * @name: hwmon name attribute
811 * @drvdata: driver data to attach to created device
812 * @chip: pointer to hwmon chip information
813 * @groups: pointer to list of driver specific attribute groups
815 * Returns the pointer to the new device. The new device is automatically
816 * unregistered with the parent device.
818 struct device *
819 devm_hwmon_device_register_with_info(struct device *dev, const char *name,
820 void *drvdata,
821 const struct hwmon_chip_info *chip,
822 const struct attribute_group **groups)
824 struct device **ptr, *hwdev;
826 if (!dev)
827 return ERR_PTR(-EINVAL);
829 ptr = devres_alloc(devm_hwmon_release, sizeof(*ptr), GFP_KERNEL);
830 if (!ptr)
831 return ERR_PTR(-ENOMEM);
833 hwdev = hwmon_device_register_with_info(dev, name, drvdata, chip,
834 groups);
835 if (IS_ERR(hwdev))
836 goto error;
838 *ptr = hwdev;
839 devres_add(dev, ptr);
841 return hwdev;
843 error:
844 devres_free(ptr);
845 return hwdev;
847 EXPORT_SYMBOL_GPL(devm_hwmon_device_register_with_info);
849 static int devm_hwmon_match(struct device *dev, void *res, void *data)
851 struct device **hwdev = res;
853 return *hwdev == data;
857 * devm_hwmon_device_unregister - removes a previously registered hwmon device
859 * @dev: the parent device of the device to unregister
861 void devm_hwmon_device_unregister(struct device *dev)
863 WARN_ON(devres_release(dev, devm_hwmon_release, devm_hwmon_match, dev));
865 EXPORT_SYMBOL_GPL(devm_hwmon_device_unregister);
867 static void __init hwmon_pci_quirks(void)
869 #if defined CONFIG_X86 && defined CONFIG_PCI
870 struct pci_dev *sb;
871 u16 base;
872 u8 enable;
874 /* Open access to 0x295-0x296 on MSI MS-7031 */
875 sb = pci_get_device(PCI_VENDOR_ID_ATI, 0x436c, NULL);
876 if (sb) {
877 if (sb->subsystem_vendor == 0x1462 && /* MSI */
878 sb->subsystem_device == 0x0031) { /* MS-7031 */
879 pci_read_config_byte(sb, 0x48, &enable);
880 pci_read_config_word(sb, 0x64, &base);
882 if (base == 0 && !(enable & BIT(2))) {
883 dev_info(&sb->dev,
884 "Opening wide generic port at 0x295\n");
885 pci_write_config_word(sb, 0x64, 0x295);
886 pci_write_config_byte(sb, 0x48,
887 enable | BIT(2));
890 pci_dev_put(sb);
892 #endif
895 static int __init hwmon_init(void)
897 int err;
899 hwmon_pci_quirks();
901 err = class_register(&hwmon_class);
902 if (err) {
903 pr_err("couldn't register hwmon sysfs class\n");
904 return err;
906 return 0;
909 static void __exit hwmon_exit(void)
911 class_unregister(&hwmon_class);
914 subsys_initcall(hwmon_init);
915 module_exit(hwmon_exit);
917 MODULE_AUTHOR("Mark M. Hoffman <mhoffman@lightlink.com>");
918 MODULE_DESCRIPTION("hardware monitoring sysfs/class support");
919 MODULE_LICENSE("GPL");