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"
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 struct hwmon_device_attribute {
42 struct device_attribute dev_attr;
43 const struct hwmon_ops *ops;
44 enum hwmon_sensor_types type;
49 #define to_hwmon_attr(d) \
50 container_of(d, struct hwmon_device_attribute, dev_attr)
53 * Thermal zone information
54 * In addition to the reference to the hwmon device,
55 * also provides the sensor index.
57 struct hwmon_thermal_data {
58 struct hwmon_device *hwdev; /* Reference to hwmon device */
59 int index; /* sensor index */
63 show_name(struct device *dev, struct device_attribute *attr, char *buf)
65 return sprintf(buf, "%s\n", to_hwmon_device(dev)->name);
67 static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
69 static struct attribute *hwmon_dev_attrs[] = {
74 static umode_t hwmon_dev_name_is_visible(struct kobject *kobj,
75 struct attribute *attr, int n)
77 struct device *dev = container_of(kobj, struct device, kobj);
79 if (to_hwmon_device(dev)->name == NULL)
85 static struct attribute_group hwmon_dev_attr_group = {
86 .attrs = hwmon_dev_attrs,
87 .is_visible = hwmon_dev_name_is_visible,
90 static const struct attribute_group *hwmon_dev_attr_groups[] = {
91 &hwmon_dev_attr_group,
95 static void hwmon_dev_release(struct device *dev)
97 kfree(to_hwmon_device(dev));
100 static struct class hwmon_class = {
102 .owner = THIS_MODULE,
103 .dev_groups = hwmon_dev_attr_groups,
104 .dev_release = hwmon_dev_release,
107 static DEFINE_IDA(hwmon_ida);
109 /* Thermal zone handling */
111 #if IS_REACHABLE(CONFIG_THERMAL) && defined(CONFIG_THERMAL_OF)
112 static int hwmon_thermal_get_temp(void *data, int *temp)
114 struct hwmon_thermal_data *tdata = data;
115 struct hwmon_device *hwdev = tdata->hwdev;
119 ret = hwdev->chip->ops->read(&hwdev->dev, hwmon_temp, hwmon_temp_input,
129 static struct thermal_zone_of_device_ops hwmon_thermal_ops = {
130 .get_temp = hwmon_thermal_get_temp,
133 static int hwmon_thermal_add_sensor(struct device *dev,
134 struct hwmon_device *hwdev, int index)
136 struct hwmon_thermal_data *tdata;
138 tdata = devm_kzalloc(dev, sizeof(*tdata), GFP_KERNEL);
142 tdata->hwdev = hwdev;
143 tdata->index = index;
145 devm_thermal_zone_of_sensor_register(&hwdev->dev, index, tdata,
151 static int hwmon_thermal_add_sensor(struct device *dev,
152 struct hwmon_device *hwdev, int index)
156 #endif /* IS_REACHABLE(CONFIG_THERMAL) && defined(CONFIG_THERMAL_OF) */
158 /* sysfs attribute management */
160 static ssize_t hwmon_attr_show(struct device *dev,
161 struct device_attribute *devattr, char *buf)
163 struct hwmon_device_attribute *hattr = to_hwmon_attr(devattr);
167 ret = hattr->ops->read(dev, hattr->type, hattr->attr, hattr->index,
172 return sprintf(buf, "%ld\n", val);
175 static ssize_t hwmon_attr_store(struct device *dev,
176 struct device_attribute *devattr,
177 const char *buf, size_t count)
179 struct hwmon_device_attribute *hattr = to_hwmon_attr(devattr);
183 ret = kstrtol(buf, 10, &val);
187 ret = hattr->ops->write(dev, hattr->type, hattr->attr, hattr->index,
195 static int hwmon_attr_base(enum hwmon_sensor_types type)
197 if (type == hwmon_in)
202 static struct attribute *hwmon_genattr(struct device *dev,
204 enum hwmon_sensor_types type,
207 const char *template,
208 const struct hwmon_ops *ops)
210 struct hwmon_device_attribute *hattr;
211 struct device_attribute *dattr;
216 /* The attribute is invisible if there is no template string */
218 return ERR_PTR(-ENOENT);
220 mode = ops->is_visible(drvdata, type, attr, index);
222 return ERR_PTR(-ENOENT);
224 if ((mode & S_IRUGO) && !ops->read)
225 return ERR_PTR(-EINVAL);
226 if ((mode & S_IWUGO) && !ops->write)
227 return ERR_PTR(-EINVAL);
229 if (type == hwmon_chip) {
230 name = (char *)template;
232 name = devm_kzalloc(dev, strlen(template) + 16, GFP_KERNEL);
234 return ERR_PTR(-ENOMEM);
235 scnprintf(name, strlen(template) + 16, template,
236 index + hwmon_attr_base(type));
239 hattr = devm_kzalloc(dev, sizeof(*hattr), GFP_KERNEL);
241 return ERR_PTR(-ENOMEM);
245 hattr->index = index;
248 dattr = &hattr->dev_attr;
249 dattr->show = hwmon_attr_show;
250 dattr->store = hwmon_attr_store;
260 static const char * const hwmon_chip_attr_templates[] = {
261 [hwmon_chip_temp_reset_history] = "temp_reset_history",
262 [hwmon_chip_in_reset_history] = "in_reset_history",
263 [hwmon_chip_curr_reset_history] = "curr_reset_history",
264 [hwmon_chip_update_interval] = "update_interval",
265 [hwmon_chip_alarms] = "alarms",
268 static const char * const hwmon_temp_attr_templates[] = {
269 [hwmon_temp_input] = "temp%d_input",
270 [hwmon_temp_type] = "temp%d_type",
271 [hwmon_temp_lcrit] = "temp%d_lcrit",
272 [hwmon_temp_lcrit_hyst] = "temp%d_lcrit_hyst",
273 [hwmon_temp_min] = "temp%d_min",
274 [hwmon_temp_min_hyst] = "temp%d_min_hyst",
275 [hwmon_temp_max] = "temp%d_max",
276 [hwmon_temp_max_hyst] = "temp%d_max_hyst",
277 [hwmon_temp_crit] = "temp%d_crit",
278 [hwmon_temp_crit_hyst] = "temp%d_crit_hyst",
279 [hwmon_temp_emergency] = "temp%d_emergency",
280 [hwmon_temp_emergency_hyst] = "temp%d_emergency_hyst",
281 [hwmon_temp_alarm] = "temp%d_alarm",
282 [hwmon_temp_lcrit_alarm] = "temp%d_lcrit_alarm",
283 [hwmon_temp_min_alarm] = "temp%d_min_alarm",
284 [hwmon_temp_max_alarm] = "temp%d_max_alarm",
285 [hwmon_temp_crit_alarm] = "temp%d_crit_alarm",
286 [hwmon_temp_emergency_alarm] = "temp%d_emergency_alarm",
287 [hwmon_temp_fault] = "temp%d_fault",
288 [hwmon_temp_offset] = "temp%d_offset",
289 [hwmon_temp_label] = "temp%d_label",
290 [hwmon_temp_lowest] = "temp%d_lowest",
291 [hwmon_temp_highest] = "temp%d_highest",
292 [hwmon_temp_reset_history] = "temp%d_reset_history",
295 static const char * const hwmon_in_attr_templates[] = {
296 [hwmon_in_input] = "in%d_input",
297 [hwmon_in_min] = "in%d_min",
298 [hwmon_in_max] = "in%d_max",
299 [hwmon_in_lcrit] = "in%d_lcrit",
300 [hwmon_in_crit] = "in%d_crit",
301 [hwmon_in_average] = "in%d_average",
302 [hwmon_in_lowest] = "in%d_lowest",
303 [hwmon_in_highest] = "in%d_highest",
304 [hwmon_in_reset_history] = "in%d_reset_history",
305 [hwmon_in_label] = "in%d_label",
306 [hwmon_in_alarm] = "in%d_alarm",
307 [hwmon_in_min_alarm] = "in%d_min_alarm",
308 [hwmon_in_max_alarm] = "in%d_max_alarm",
309 [hwmon_in_lcrit_alarm] = "in%d_lcrit_alarm",
310 [hwmon_in_crit_alarm] = "in%d_crit_alarm",
313 static const char * const hwmon_curr_attr_templates[] = {
314 [hwmon_curr_input] = "curr%d_input",
315 [hwmon_curr_min] = "curr%d_min",
316 [hwmon_curr_max] = "curr%d_max",
317 [hwmon_curr_lcrit] = "curr%d_lcrit",
318 [hwmon_curr_crit] = "curr%d_crit",
319 [hwmon_curr_average] = "curr%d_average",
320 [hwmon_curr_lowest] = "curr%d_lowest",
321 [hwmon_curr_highest] = "curr%d_highest",
322 [hwmon_curr_reset_history] = "curr%d_reset_history",
323 [hwmon_curr_label] = "curr%d_label",
324 [hwmon_curr_alarm] = "curr%d_alarm",
325 [hwmon_curr_min_alarm] = "curr%d_min_alarm",
326 [hwmon_curr_max_alarm] = "curr%d_max_alarm",
327 [hwmon_curr_lcrit_alarm] = "curr%d_lcrit_alarm",
328 [hwmon_curr_crit_alarm] = "curr%d_crit_alarm",
331 static const char * const *__templates[] = {
332 [hwmon_chip] = hwmon_chip_attr_templates,
333 [hwmon_temp] = hwmon_temp_attr_templates,
334 [hwmon_in] = hwmon_in_attr_templates,
335 [hwmon_curr] = hwmon_curr_attr_templates,
338 static const int __templates_size[] = {
339 [hwmon_chip] = ARRAY_SIZE(hwmon_chip_attr_templates),
340 [hwmon_temp] = ARRAY_SIZE(hwmon_temp_attr_templates),
341 [hwmon_in] = ARRAY_SIZE(hwmon_in_attr_templates),
342 [hwmon_curr] = ARRAY_SIZE(hwmon_curr_attr_templates),
345 static int hwmon_num_channel_attrs(const struct hwmon_channel_info *info)
349 for (i = n = 0; info->config[i]; i++)
350 n += hweight32(info->config[i]);
355 static int hwmon_genattrs(struct device *dev,
357 struct attribute **attrs,
358 const struct hwmon_ops *ops,
359 const struct hwmon_channel_info *info)
361 const char * const *templates;
365 if (info->type >= ARRAY_SIZE(__templates))
368 templates = __templates[info->type];
369 template_size = __templates_size[info->type];
371 for (i = 0; info->config[i]; i++) {
372 u32 attr_mask = info->config[i];
378 attr = __ffs(attr_mask);
379 attr_mask &= ~BIT(attr);
380 if (attr >= template_size)
382 a = hwmon_genattr(dev, drvdata, info->type, attr, i,
383 templates[attr], ops);
385 if (PTR_ERR(a) != -ENOENT)
395 static struct attribute **
396 __hwmon_create_attrs(struct device *dev, const void *drvdata,
397 const struct hwmon_chip_info *chip)
399 int ret, i, aindex = 0, nattrs = 0;
400 struct attribute **attrs;
402 for (i = 0; chip->info[i]; i++)
403 nattrs += hwmon_num_channel_attrs(chip->info[i]);
406 return ERR_PTR(-EINVAL);
408 attrs = devm_kcalloc(dev, nattrs + 1, sizeof(*attrs), GFP_KERNEL);
410 return ERR_PTR(-ENOMEM);
412 for (i = 0; chip->info[i]; i++) {
413 ret = hwmon_genattrs(dev, drvdata, &attrs[aindex], chip->ops,
423 static struct device *
424 __hwmon_device_register(struct device *dev, const char *name, void *drvdata,
425 const struct hwmon_chip_info *chip,
426 const struct attribute_group **groups)
428 struct hwmon_device *hwdev;
432 /* Do not accept invalid characters in hwmon name attribute */
433 if (name && (!strlen(name) || strpbrk(name, "-* \t\n")))
434 return ERR_PTR(-EINVAL);
436 id = ida_simple_get(&hwmon_ida, 0, 0, GFP_KERNEL);
440 hwdev = kzalloc(sizeof(*hwdev), GFP_KERNEL);
448 if (chip && chip->ops->is_visible) {
449 struct attribute **attrs;
453 for (i = 0; groups[i]; i++)
456 hwdev->groups = devm_kcalloc(dev, ngroups, sizeof(*groups),
459 return ERR_PTR(-ENOMEM);
461 attrs = __hwmon_create_attrs(dev, drvdata, chip);
463 err = PTR_ERR(attrs);
467 hwdev->group.attrs = attrs;
469 hwdev->groups[ngroups++] = &hwdev->group;
472 for (i = 0; groups[i]; i++)
473 hwdev->groups[ngroups++] = groups[i];
476 hdev->groups = hwdev->groups;
478 hdev->groups = groups;
482 hdev->class = &hwmon_class;
484 hdev->of_node = dev ? dev->of_node : NULL;
486 dev_set_drvdata(hdev, drvdata);
487 dev_set_name(hdev, HWMON_ID_FORMAT, id);
488 err = device_register(hdev);
492 if (chip && chip->ops->is_visible && chip->ops->read &&
493 chip->info[0]->type == hwmon_chip &&
494 (chip->info[0]->config[0] & HWMON_C_REGISTER_TZ)) {
495 const struct hwmon_channel_info **info = chip->info;
497 for (i = 1; info[i]; i++) {
498 if (info[i]->type != hwmon_temp)
501 for (j = 0; info[i]->config[j]; j++) {
502 if (!chip->ops->is_visible(drvdata, hwmon_temp,
503 hwmon_temp_input, j))
505 if (info[i]->config[j] & HWMON_T_INPUT)
506 hwmon_thermal_add_sensor(dev, hwdev, j);
516 ida_simple_remove(&hwmon_ida, id);
521 * hwmon_device_register_with_groups - register w/ hwmon
522 * @dev: the parent device
523 * @name: hwmon name attribute
524 * @drvdata: driver data to attach to created device
525 * @groups: List of attribute groups to create
527 * hwmon_device_unregister() must be called when the device is no
530 * Returns the pointer to the new device.
533 hwmon_device_register_with_groups(struct device *dev, const char *name,
535 const struct attribute_group **groups)
537 return __hwmon_device_register(dev, name, drvdata, NULL, groups);
539 EXPORT_SYMBOL_GPL(hwmon_device_register_with_groups);
542 * hwmon_device_register_with_info - register w/ hwmon
543 * @dev: the parent device
544 * @name: hwmon name attribute
545 * @drvdata: driver data to attach to created device
546 * @info: Pointer to hwmon chip information
547 * @groups - pointer to list of driver specific attribute groups
549 * hwmon_device_unregister() must be called when the device is no
552 * Returns the pointer to the new device.
555 hwmon_device_register_with_info(struct device *dev, const char *name,
557 const struct hwmon_chip_info *chip,
558 const struct attribute_group **groups)
560 if (chip && (!chip->ops || !chip->info))
561 return ERR_PTR(-EINVAL);
563 return __hwmon_device_register(dev, name, drvdata, chip, groups);
565 EXPORT_SYMBOL_GPL(hwmon_device_register_with_info);
568 * hwmon_device_register - register w/ hwmon
569 * @dev: the device to register
571 * hwmon_device_unregister() must be called when the device is no
574 * Returns the pointer to the new device.
576 struct device *hwmon_device_register(struct device *dev)
578 return hwmon_device_register_with_groups(dev, NULL, NULL, NULL);
580 EXPORT_SYMBOL_GPL(hwmon_device_register);
583 * hwmon_device_unregister - removes the previously registered class device
585 * @dev: the class device to destroy
587 void hwmon_device_unregister(struct device *dev)
591 if (likely(sscanf(dev_name(dev), HWMON_ID_FORMAT, &id) == 1)) {
592 device_unregister(dev);
593 ida_simple_remove(&hwmon_ida, id);
596 "hwmon_device_unregister() failed: bad class ID!\n");
598 EXPORT_SYMBOL_GPL(hwmon_device_unregister);
600 static void devm_hwmon_release(struct device *dev, void *res)
602 struct device *hwdev = *(struct device **)res;
604 hwmon_device_unregister(hwdev);
608 * devm_hwmon_device_register_with_groups - register w/ hwmon
609 * @dev: the parent device
610 * @name: hwmon name attribute
611 * @drvdata: driver data to attach to created device
612 * @groups: List of attribute groups to create
614 * Returns the pointer to the new device. The new device is automatically
615 * unregistered with the parent device.
618 devm_hwmon_device_register_with_groups(struct device *dev, const char *name,
620 const struct attribute_group **groups)
622 struct device **ptr, *hwdev;
625 return ERR_PTR(-EINVAL);
627 ptr = devres_alloc(devm_hwmon_release, sizeof(*ptr), GFP_KERNEL);
629 return ERR_PTR(-ENOMEM);
631 hwdev = hwmon_device_register_with_groups(dev, name, drvdata, groups);
636 devres_add(dev, ptr);
643 EXPORT_SYMBOL_GPL(devm_hwmon_device_register_with_groups);
646 * devm_hwmon_device_register_with_info - register w/ hwmon
647 * @dev: the parent device
648 * @name: hwmon name attribute
649 * @drvdata: driver data to attach to created device
650 * @info: Pointer to hwmon chip information
651 * @groups - pointer to list of driver specific attribute groups
653 * Returns the pointer to the new device. The new device is automatically
654 * unregistered with the parent device.
657 devm_hwmon_device_register_with_info(struct device *dev, const char *name,
659 const struct hwmon_chip_info *chip,
660 const struct attribute_group **groups)
662 struct device **ptr, *hwdev;
665 return ERR_PTR(-EINVAL);
667 ptr = devres_alloc(devm_hwmon_release, sizeof(*ptr), GFP_KERNEL);
669 return ERR_PTR(-ENOMEM);
671 hwdev = hwmon_device_register_with_info(dev, name, drvdata, chip,
677 devres_add(dev, ptr);
685 EXPORT_SYMBOL_GPL(devm_hwmon_device_register_with_info);
687 static int devm_hwmon_match(struct device *dev, void *res, void *data)
689 struct device **hwdev = res;
691 return *hwdev == data;
695 * devm_hwmon_device_unregister - removes a previously registered hwmon device
697 * @dev: the parent device of the device to unregister
699 void devm_hwmon_device_unregister(struct device *dev)
701 WARN_ON(devres_release(dev, devm_hwmon_release, devm_hwmon_match, dev));
703 EXPORT_SYMBOL_GPL(devm_hwmon_device_unregister);
705 static void __init hwmon_pci_quirks(void)
707 #if defined CONFIG_X86 && defined CONFIG_PCI
712 /* Open access to 0x295-0x296 on MSI MS-7031 */
713 sb = pci_get_device(PCI_VENDOR_ID_ATI, 0x436c, NULL);
715 if (sb->subsystem_vendor == 0x1462 && /* MSI */
716 sb->subsystem_device == 0x0031) { /* MS-7031 */
717 pci_read_config_byte(sb, 0x48, &enable);
718 pci_read_config_word(sb, 0x64, &base);
720 if (base == 0 && !(enable & BIT(2))) {
722 "Opening wide generic port at 0x295\n");
723 pci_write_config_word(sb, 0x64, 0x295);
724 pci_write_config_byte(sb, 0x48,
733 static int __init hwmon_init(void)
739 err = class_register(&hwmon_class);
741 pr_err("couldn't register hwmon sysfs class\n");
747 static void __exit hwmon_exit(void)
749 class_unregister(&hwmon_class);
752 subsys_initcall(hwmon_init);
753 module_exit(hwmon_exit);
755 MODULE_AUTHOR("Mark M. Hoffman <mhoffman@lightlink.com>");
756 MODULE_DESCRIPTION("hardware monitoring sysfs/class support");
757 MODULE_LICENSE("GPL");