drivers/hwmon/hwmon.c

   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 <[email protected]>
   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 name_show(struct device *dev, struct device_attribute *attr, char *buf)
  72 {
  73         return sprintf(buf, "%s\n", to_hwmon_device(dev)->name);
  74 }
  75 static DEVICE_ATTR_RO(name);
  76
  77 static ssize_t
  78 label_show(struct device *dev, struct device_attribute *attr, char *buf)
  79 {
  80         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 static umode_t hwmon_dev_attr_is_visible(struct kobject *kobj,
  91                                          struct attribute *attr, int n)
  92 {
  93         struct device *dev = kobj_to_dev(kobj);
  94         struct hwmon_device *hdev = to_hwmon_device(dev);
  95
  96         if (attr == &dev_attr_name.attr && hdev->name == NULL)
  97                 return 0;
  98
  99         if (attr == &dev_attr_label.attr && hdev->label == NULL)
 100                 return 0;
 101
 102         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 static void hwmon_free_attrs(struct attribute **attrs)
 116 {
 117         int i;
 118
 119         for (i = 0; attrs[i]; i++) {
 120                 struct device_attribute *dattr = to_dev_attr(attrs[i]);
 121                 struct hwmon_device_attribute *hattr = to_hwmon_attr(dattr);
 122
 123                 kfree(hattr);
 124         }
 125         kfree(attrs);
 126 }
 127
 128 static void hwmon_dev_release(struct device *dev)
 129 {
 130         struct hwmon_device *hwdev = to_hwmon_device(dev);
 131
 132         if (hwdev->group.attrs)
 133                 hwmon_free_attrs(hwdev->group.attrs);
 134         kfree(hwdev->groups);
 135         kfree(hwdev->label);
 136         kfree(hwdev);
 137 }
 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 * const *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 * const *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         if (type == hwmon_in || type == hwmon_intrusion)
 309                 return 0;
 310         return 1;
 311 }
 312
 313 /* sysfs attribute management */
 314
 315 static ssize_t hwmon_attr_show(struct device *dev,
 316                                struct device_attribute *devattr, char *buf)
 317 {
 318         struct hwmon_device_attribute *hattr = to_hwmon_attr(devattr);
 319         long val;
 320         int ret;
 321
 322         ret = hattr->ops->read(dev, hattr->type, hattr->attr, hattr->index,
 323                                &val);
 324         if (ret < 0)
 325                 return ret;
 326
 327         trace_hwmon_attr_show(hattr->index + hwmon_attr_base(hattr->type),
 328                               hattr->name, val);
 329
 330         return sprintf(buf, "%ld\n", val);
 331 }
 332
 333 static ssize_t hwmon_attr_show_string(struct device *dev,
 334                                       struct device_attribute *devattr,
 335                                       char *buf)
 336 {
 337         struct hwmon_device_attribute *hattr = to_hwmon_attr(devattr);
 338         enum hwmon_sensor_types type = hattr->type;
 339         const char *s;
 340         int ret;
 341
 342         ret = hattr->ops->read_string(dev, hattr->type, hattr->attr,
 343                                       hattr->index, &s);
 344         if (ret < 0)
 345                 return ret;
 346
 347         trace_hwmon_attr_show_string(hattr->index + hwmon_attr_base(type),
 348                                      hattr->name, s);
 349
 350         return sprintf(buf, "%s\n", s);
 351 }
 352
 353 static ssize_t hwmon_attr_store(struct device *dev,
 354                                 struct device_attribute *devattr,
 355                                 const char *buf, size_t count)
 356 {
 357         struct hwmon_device_attribute *hattr = to_hwmon_attr(devattr);
 358         long val;
 359         int ret;
 360
 361         ret = kstrtol(buf, 10, &val);
 362         if (ret < 0)
 363                 return ret;
 364
 365         ret = hattr->ops->write(dev, hattr->type, hattr->attr, hattr->index,
 366                                 val);
 367         if (ret < 0)
 368                 return ret;
 369
 370         trace_hwmon_attr_store(hattr->index + hwmon_attr_base(hattr->type),
 371                                hattr->name, val);
 372
 373         return count;
 374 }
 375
 376 static bool is_string_attr(enum hwmon_sensor_types type, u32 attr)
 377 {
 378         return (type == hwmon_temp && attr == hwmon_temp_label) ||
 379                (type == hwmon_in && attr == hwmon_in_label) ||
 380                (type == hwmon_curr && attr == hwmon_curr_label) ||
 381                (type == hwmon_power && attr == hwmon_power_label) ||
 382                (type == hwmon_energy && attr == hwmon_energy_label) ||
 383                (type == hwmon_humidity && attr == hwmon_humidity_label) ||
 384                (type == hwmon_fan && attr == hwmon_fan_label);
 385 }
 386
 387 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         bool is_string = is_string_attr(type, attr);
 400
 401         /* The attribute is invisible if there is no template string */
 402         if (!template)
 403                 return ERR_PTR(-ENOENT);
 404
 405         mode = ops->is_visible(drvdata, type, attr, index);
 406         if (!mode)
 407                 return ERR_PTR(-ENOENT);
 408
 409         if ((mode & 0444) && ((is_string && !ops->read_string) ||
 410                                  (!is_string && !ops->read)))
 411                 return ERR_PTR(-EINVAL);
 412         if ((mode & 0222) && !ops->write)
 413                 return ERR_PTR(-EINVAL);
 414
 415         hattr = kzalloc(sizeof(*hattr), GFP_KERNEL);
 416         if (!hattr)
 417                 return ERR_PTR(-ENOMEM);
 418
 419         if (type == hwmon_chip) {
 420                 name = template;
 421         } else {
 422                 scnprintf(hattr->name, sizeof(hattr->name), template,
 423                           index + hwmon_attr_base(type));
 424                 name = hattr->name;
 425         }
 426
 427         hattr->type = type;
 428         hattr->attr = attr;
 429         hattr->index = index;
 430         hattr->ops = ops;
 431
 432         dattr = &hattr->dev_attr;
 433         dattr->show = is_string ? hwmon_attr_show_string : hwmon_attr_show;
 434         dattr->store = hwmon_attr_store;
 435
 436         a = &dattr->attr;
 437         sysfs_attr_init(a);
 438         a->name = name;
 439         a->mode = mode;
 440
 441         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 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         char *envp[] = { event, NULL };
 648         const char * const *templates;
 649         const char *template;
 650         int base;
 651
 652         if (type >= ARRAY_SIZE(__templates))
 653                 return -EINVAL;
 654         if (attr >= __templates_size[type])
 655                 return -EINVAL;
 656
 657         templates = __templates[type];
 658         template = templates[attr];
 659
 660         base = hwmon_attr_base(type);
 661
 662         scnprintf(sattr, MAX_SYSFS_ATTR_NAME_LENGTH, template, base + channel);
 663         scnprintf(event, sizeof(event), "NAME=%s", sattr);
 664         sysfs_notify(&dev->kobj, NULL, sattr);
 665         kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp);
 666
 667         if (type == hwmon_temp)
 668                 hwmon_thermal_notify(dev, channel);
 669
 670         return 0;
 671 }
 672 EXPORT_SYMBOL_GPL(hwmon_notify_event);
 673
 674 static int hwmon_num_channel_attrs(const struct hwmon_channel_info *info)
 675 {
 676         int i, n;
 677
 678         for (i = n = 0; info->config[i]; i++)
 679                 n += hweight32(info->config[i]);
 680
 681         return n;
 682 }
 683
 684 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         int i, aindex = 0;
 692
 693         if (info->type >= ARRAY_SIZE(__templates))
 694                 return -EINVAL;
 695
 696         templates = __templates[info->type];
 697         template_size = __templates_size[info->type];
 698
 699         for (i = 0; info->config[i]; i++) {
 700                 u32 attr_mask = info->config[i];
 701                 u32 attr;
 702
 703                 while (attr_mask) {
 704                         struct attribute *a;
 705
 706                         attr = __ffs(attr_mask);
 707                         attr_mask &= ~BIT(attr);
 708                         if (attr >= template_size)
 709                                 return -EINVAL;
 710                         a = hwmon_genattr(drvdata, info->type, attr, i,
 711                                           templates[attr], ops);
 712                         if (IS_ERR(a)) {
 713                                 if (PTR_ERR(a) != -ENOENT)
 714                                         return PTR_ERR(a);
 715                                 continue;
 716                         }
 717                         attrs[aindex++] = a;
 718                 }
 719         }
 720         return aindex;
 721 }
 722
 723 static struct attribute **
 724 __hwmon_create_attrs(const void *drvdata, const struct hwmon_chip_info *chip)
 725 {
 726         int ret, i, aindex = 0, nattrs = 0;
 727         struct attribute **attrs;
 728
 729         for (i = 0; chip->info[i]; i++)
 730                 nattrs += hwmon_num_channel_attrs(chip->info[i]);
 731
 732         if (nattrs == 0)
 733                 return ERR_PTR(-EINVAL);
 734
 735         attrs = kcalloc(nattrs + 1, sizeof(*attrs), GFP_KERNEL);
 736         if (!attrs)
 737                 return ERR_PTR(-ENOMEM);
 738
 739         for (i = 0; chip->info[i]; i++) {
 740                 ret = hwmon_genattrs(drvdata, &attrs[aindex], chip->ops,
 741                                      chip->info[i]);
 742                 if (ret < 0) {
 743                         hwmon_free_attrs(attrs);
 744                         return ERR_PTR(ret);
 745                 }
 746                 aindex += ret;
 747         }
 748
 749         return attrs;
 750 }
 751
 752 static struct device *
 753 __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         struct device *tdev = dev;
 761         int i, err, id;
 762
 763         /* Complain about invalid characters in hwmon name attribute */
 764         if (name && (!strlen(name) || strpbrk(name, "-* \t\n")))
 765                 dev_warn(dev,
 766                          "hwmon: '%s' is not a valid name attribute, please fix\n",
 767                          name);
 768
 769         id = ida_alloc(&hwmon_ida, GFP_KERNEL);
 770         if (id < 0)
 771                 return ERR_PTR(id);
 772
 773         hwdev = kzalloc(sizeof(*hwdev), GFP_KERNEL);
 774         if (hwdev == NULL) {
 775                 err = -ENOMEM;
 776                 goto ida_remove;
 777         }
 778
 779         hdev = &hwdev->dev;
 780
 781         if (chip) {
 782                 struct attribute **attrs;
 783                 int ngroups = 2; /* terminating NULL plus &hwdev->groups */
 784
 785                 if (groups)
 786                         for (i = 0; groups[i]; i++)
 787                                 ngroups++;
 788
 789                 hwdev->groups = kcalloc(ngroups, sizeof(*groups), GFP_KERNEL);
 790                 if (!hwdev->groups) {
 791                         err = -ENOMEM;
 792                         goto free_hwmon;
 793                 }
 794
 795                 attrs = __hwmon_create_attrs(drvdata, chip);
 796                 if (IS_ERR(attrs)) {
 797                         err = PTR_ERR(attrs);
 798                         goto free_hwmon;
 799                 }
 800
 801                 hwdev->group.attrs = attrs;
 802                 ngroups = 0;
 803                 hwdev->groups[ngroups++] = &hwdev->group;
 804
 805                 if (groups) {
 806                         for (i = 0; groups[i]; i++)
 807                                 hwdev->groups[ngroups++] = groups[i];
 808                 }
 809
 810                 hdev->groups = hwdev->groups;
 811         } else {
 812                 hdev->groups = groups;
 813         }
 814
 815         if (dev && device_property_present(dev, "label")) {
 816                 err = device_property_read_string(dev, "label", &label);
 817                 if (err < 0)
 818                         goto free_hwmon;
 819
 820                 hwdev->label = kstrdup(label, GFP_KERNEL);
 821                 if (hwdev->label == NULL) {
 822                         err = -ENOMEM;
 823                         goto free_hwmon;
 824                 }
 825         }
 826
 827         hwdev->name = name;
 828         hdev->class = &hwmon_class;
 829         hdev->parent = dev;
 830         while (tdev && !tdev->of_node)
 831                 tdev = tdev->parent;
 832         hdev->of_node = tdev ? tdev->of_node : NULL;
 833         hwdev->chip = chip;
 834         dev_set_drvdata(hdev, drvdata);
 835         dev_set_name(hdev, HWMON_ID_FORMAT, id);
 836         err = device_register(hdev);
 837         if (err) {
 838                 put_device(hdev);
 839                 goto ida_remove;
 840         }
 841
 842         INIT_LIST_HEAD(&hwdev->tzdata);
 843
 844         if (hdev->of_node && chip && chip->ops->read &&
 845             chip->info[0]->type == hwmon_chip &&
 846             (chip->info[0]->config[0] & HWMON_C_REGISTER_TZ)) {
 847                 err = hwmon_thermal_register_sensors(hdev);
 848                 if (err) {
 849                         device_unregister(hdev);
 850                         /*
 851                          * Don't worry about hwdev; hwmon_dev_release(), called
 852                          * from device_unregister(), will free it.
 853                          */
 854                         goto ida_remove;
 855                 }
 856         }
 857
 858         return hdev;
 859
 860 free_hwmon:
 861         hwmon_dev_release(hdev);
 862 ida_remove:
 863         ida_free(&hwmon_ida, id);
 864         return ERR_PTR(err);
 865 }
 866
 867 /**
 868  * hwmon_device_register_with_groups - register w/ hwmon
 869  * @dev: the parent device
 870  * @name: hwmon name attribute
 871  * @drvdata: driver data to attach to created device
 872  * @groups: List of attribute groups to create
 873  *
 874  * hwmon_device_unregister() must be called when the device is no
 875  * longer needed.
 876  *
 877  * Returns the pointer to the new device.
 878  */
 879 struct device *
 880 hwmon_device_register_with_groups(struct device *dev, const char *name,
 881                                   void *drvdata,
 882                                   const struct attribute_group **groups)
 883 {
 884         if (!name)
 885                 return ERR_PTR(-EINVAL);
 886
 887         return __hwmon_device_register(dev, name, drvdata, NULL, groups);
 888 }
 889 EXPORT_SYMBOL_GPL(hwmon_device_register_with_groups);
 890
 891 /**
 892  * hwmon_device_register_with_info - register w/ hwmon
 893  * @dev: the parent device (mandatory)
 894  * @name: hwmon name attribute (mandatory)
 895  * @drvdata: driver data to attach to created device (optional)
 896  * @chip: pointer to hwmon chip information (mandatory)
 897  * @extra_groups: pointer to list of additional non-standard attribute groups
 898  *      (optional)
 899  *
 900  * hwmon_device_unregister() must be called when the device is no
 901  * longer needed.
 902  *
 903  * Returns the pointer to the new device.
 904  */
 905 struct device *
 906 hwmon_device_register_with_info(struct device *dev, const char *name,
 907                                 void *drvdata,
 908                                 const struct hwmon_chip_info *chip,
 909                                 const struct attribute_group **extra_groups)
 910 {
 911         if (!dev || !name || !chip)
 912                 return ERR_PTR(-EINVAL);
 913
 914         if (!chip->ops || !chip->ops->is_visible || !chip->info)
 915                 return ERR_PTR(-EINVAL);
 916
 917         return __hwmon_device_register(dev, name, drvdata, chip, extra_groups);
 918 }
 919 EXPORT_SYMBOL_GPL(hwmon_device_register_with_info);
 920
 921 /**
 922  * hwmon_device_register_for_thermal - register hwmon device for thermal subsystem
 923  * @dev: the parent device
 924  * @name: hwmon name attribute
 925  * @drvdata: driver data to attach to created device
 926  *
 927  * The use of this function is restricted. It is provided for legacy reasons
 928  * and must only be called from the thermal subsystem.
 929  *
 930  * hwmon_device_unregister() must be called when the device is no
 931  * longer needed.
 932  *
 933  * Returns the pointer to the new device.
 934  */
 935 struct device *
 936 hwmon_device_register_for_thermal(struct device *dev, const char *name,
 937                                   void *drvdata)
 938 {
 939         if (!name || !dev)
 940                 return ERR_PTR(-EINVAL);
 941
 942         return __hwmon_device_register(dev, name, drvdata, NULL, NULL);
 943 }
 944 EXPORT_SYMBOL_NS_GPL(hwmon_device_register_for_thermal, HWMON_THERMAL);
 945
 946 /**
 947  * hwmon_device_register - register w/ hwmon
 948  * @dev: the device to register
 949  *
 950  * hwmon_device_unregister() must be called when the device is no
 951  * longer needed.
 952  *
 953  * Returns the pointer to the new device.
 954  */
 955 struct device *hwmon_device_register(struct device *dev)
 956 {
 957         dev_warn(dev,
 958                  "hwmon_device_register() is deprecated. Please convert the driver to use hwmon_device_register_with_info().\n");
 959
 960         return __hwmon_device_register(dev, NULL, NULL, NULL, NULL);
 961 }
 962 EXPORT_SYMBOL_GPL(hwmon_device_register);
 963
 964 /**
 965  * hwmon_device_unregister - removes the previously registered class device
 966  *
 967  * @dev: the class device to destroy
 968  */
 969 void hwmon_device_unregister(struct device *dev)
 970 {
 971         int id;
 972
 973         if (likely(sscanf(dev_name(dev), HWMON_ID_FORMAT, &id) == 1)) {
 974                 device_unregister(dev);
 975                 ida_free(&hwmon_ida, id);
 976         } else
 977                 dev_dbg(dev->parent,
 978                         "hwmon_device_unregister() failed: bad class ID!\n");
 979 }
 980 EXPORT_SYMBOL_GPL(hwmon_device_unregister);
 981
 982 static void devm_hwmon_release(struct device *dev, void *res)
 983 {
 984         struct device *hwdev = *(struct device **)res;
 985
 986         hwmon_device_unregister(hwdev);
 987 }
 988
 989 /**
 990  * devm_hwmon_device_register_with_groups - register w/ hwmon
 991  * @dev: the parent device
 992  * @name: hwmon name attribute
 993  * @drvdata: driver data to attach to created device
 994  * @groups: List of attribute groups to create
 995  *
 996  * Returns the pointer to the new device. The new device is automatically
 997  * unregistered with the parent device.
 998  */
 999 struct device *
1000 devm_hwmon_device_register_with_groups(struct device *dev, const char *name,
1001                                        void *drvdata,
1002                                        const struct attribute_group **groups)
1003 {
1004         struct device **ptr, *hwdev;
1005
1006         if (!dev)
1007                 return ERR_PTR(-EINVAL);
1008
1009         ptr = devres_alloc(devm_hwmon_release, sizeof(*ptr), GFP_KERNEL);
1010         if (!ptr)
1011                 return ERR_PTR(-ENOMEM);
1012
1013         hwdev = hwmon_device_register_with_groups(dev, name, drvdata, groups);
1014         if (IS_ERR(hwdev))
1015                 goto error;
1016
1017         *ptr = hwdev;
1018         devres_add(dev, ptr);
1019         return hwdev;
1020
1021 error:
1022         devres_free(ptr);
1023         return hwdev;
1024 }
1025 EXPORT_SYMBOL_GPL(devm_hwmon_device_register_with_groups);
1026
1027 /**
1028  * devm_hwmon_device_register_with_info - register w/ hwmon
1029  * @dev:        the parent device
1030  * @name:       hwmon name attribute
1031  * @drvdata:    driver data to attach to created device
1032  * @chip:       pointer to hwmon chip information
1033  * @groups:     pointer to list of driver specific attribute groups
1034  *
1035  * Returns the pointer to the new device. The new device is automatically
1036  * unregistered with the parent device.
1037  */
1038 struct device *
1039 devm_hwmon_device_register_with_info(struct device *dev, const char *name,
1040                                      void *drvdata,
1041                                      const struct hwmon_chip_info *chip,
1042                                      const struct attribute_group **groups)
1043 {
1044         struct device **ptr, *hwdev;
1045
1046         if (!dev)
1047                 return ERR_PTR(-EINVAL);
1048
1049         ptr = devres_alloc(devm_hwmon_release, sizeof(*ptr), GFP_KERNEL);
1050         if (!ptr)
1051                 return ERR_PTR(-ENOMEM);
1052
1053         hwdev = hwmon_device_register_with_info(dev, name, drvdata, chip,
1054                                                 groups);
1055         if (IS_ERR(hwdev))
1056                 goto error;
1057
1058         *ptr = hwdev;
1059         devres_add(dev, ptr);
1060
1061         return hwdev;
1062
1063 error:
1064         devres_free(ptr);
1065         return hwdev;
1066 }
1067 EXPORT_SYMBOL_GPL(devm_hwmon_device_register_with_info);
1068
1069 static int devm_hwmon_match(struct device *dev, void *res, void *data)
1070 {
1071         struct device **hwdev = res;
1072
1073         return *hwdev == data;
1074 }
1075
1076 /**
1077  * devm_hwmon_device_unregister - removes a previously registered hwmon device
1078  *
1079  * @dev: the parent device of the device to unregister
1080  */
1081 void devm_hwmon_device_unregister(struct device *dev)
1082 {
1083         WARN_ON(devres_release(dev, devm_hwmon_release, devm_hwmon_match, dev));
1084 }
1085 EXPORT_SYMBOL_GPL(devm_hwmon_device_unregister);
1086
1087 static char *__hwmon_sanitize_name(struct device *dev, const char *old_name)
1088 {
1089         char *name, *p;
1090
1091         if (dev)
1092                 name = devm_kstrdup(dev, old_name, GFP_KERNEL);
1093         else
1094                 name = kstrdup(old_name, GFP_KERNEL);
1095         if (!name)
1096                 return ERR_PTR(-ENOMEM);
1097
1098         for (p = name; *p; p++)
1099                 if (hwmon_is_bad_char(*p))
1100                         *p = '_';
1101
1102         return name;
1103 }
1104
1105 /**
1106  * hwmon_sanitize_name - Replaces invalid characters in a hwmon name
1107  * @name: NUL-terminated name
1108  *
1109  * Allocates a new string where any invalid characters will be replaced
1110  * by an underscore. It is the responsibility of the caller to release
1111  * the memory.
1112  *
1113  * Returns newly allocated name, or ERR_PTR on error.
1114  */
1115 char *hwmon_sanitize_name(const char *name)
1116 {
1117         return __hwmon_sanitize_name(NULL, name);
1118 }
1119 EXPORT_SYMBOL_GPL(hwmon_sanitize_name);
1120
1121 /**
1122  * devm_hwmon_sanitize_name - resource managed hwmon_sanitize_name()
1123  * @dev: device to allocate memory for
1124  * @name: NUL-terminated name
1125  *
1126  * Allocates a new string where any invalid characters will be replaced
1127  * by an underscore.
1128  *
1129  * Returns newly allocated name, or ERR_PTR on error.
1130  */
1131 char *devm_hwmon_sanitize_name(struct device *dev, const char *name)
1132 {
1133         if (!dev)
1134                 return ERR_PTR(-EINVAL);
1135
1136         return __hwmon_sanitize_name(dev, name);
1137 }
1138 EXPORT_SYMBOL_GPL(devm_hwmon_sanitize_name);
1139
1140 static void __init hwmon_pci_quirks(void)
1141 {
1142 #if defined CONFIG_X86 && defined CONFIG_PCI
1143         struct pci_dev *sb;
1144         u16 base;
1145         u8 enable;
1146
1147         /* Open access to 0x295-0x296 on MSI MS-7031 */
1148         sb = pci_get_device(PCI_VENDOR_ID_ATI, 0x436c, NULL);
1149         if (sb) {
1150                 if (sb->subsystem_vendor == 0x1462 &&   /* MSI */
1151                     sb->subsystem_device == 0x0031) {   /* MS-7031 */
1152                         pci_read_config_byte(sb, 0x48, &enable);
1153                         pci_read_config_word(sb, 0x64, &base);
1154
1155                         if (base == 0 && !(enable & BIT(2))) {
1156                                 dev_info(&sb->dev,
1157                                          "Opening wide generic port at 0x295\n");
1158                                 pci_write_config_word(sb, 0x64, 0x295);
1159                                 pci_write_config_byte(sb, 0x48,
1160                                                       enable | BIT(2));
1161                         }
1162                 }
1163                 pci_dev_put(sb);
1164         }
1165 #endif
1166 }
1167
1168 static int __init hwmon_init(void)
1169 {
1170         int err;
1171
1172         hwmon_pci_quirks();
1173
1174         err = class_register(&hwmon_class);
1175         if (err) {
1176                 pr_err("couldn't register hwmon sysfs class\n");
1177                 return err;
1178         }
1179         return 0;
1180 }
1181
1182 static void __exit hwmon_exit(void)
1183 {
1184         class_unregister(&hwmon_class);
1185 }
1186
1187 subsys_initcall(hwmon_init);
1188 module_exit(hwmon_exit);
1189
1190 MODULE_AUTHOR("Mark M. Hoffman <[email protected]>");
1191 MODULE_DESCRIPTION("hardware monitoring sysfs/class support");
1192 MODULE_LICENSE("GPL");
1193