include/linux/hwmon.h

   1 /*
   2     hwmon.h - part of lm_sensors, Linux kernel modules for hardware monitoring
   3
   4     This file declares helper functions for the sysfs class "hwmon",
   5     for use by sensors drivers.
   6
   7     Copyright (C) 2005 Mark M. Hoffman <mhoffman@lightlink.com>
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; version 2 of the License.
  12 */
  13
  14 #ifndef _HWMON_H_
  15 #define _HWMON_H_
  16
  17 #include <linux/bitops.h>
  18
  19 struct device;
  20 struct attribute_group;
  21
  22 enum hwmon_sensor_types {
  23         hwmon_chip,
  24         hwmon_temp,
  25         hwmon_in,
  26         hwmon_curr,
  27         hwmon_power,
  28         hwmon_energy,
  29         hwmon_humidity,
  30         hwmon_fan,
  31         hwmon_pwm,
  32         hwmon_max,
  33 };
  34
  35 enum hwmon_chip_attributes {
  36         hwmon_chip_temp_reset_history,
  37         hwmon_chip_in_reset_history,
  38         hwmon_chip_curr_reset_history,
  39         hwmon_chip_power_reset_history,
  40         hwmon_chip_register_tz,
  41         hwmon_chip_update_interval,
  42         hwmon_chip_alarms,
  43 };
  44
  45 #define HWMON_C_TEMP_RESET_HISTORY      BIT(hwmon_chip_temp_reset_history)
  46 #define HWMON_C_IN_RESET_HISTORY        BIT(hwmon_chip_in_reset_history)
  47 #define HWMON_C_CURR_RESET_HISTORY      BIT(hwmon_chip_curr_reset_history)
  48 #define HWMON_C_POWER_RESET_HISTORY     BIT(hwmon_chip_power_reset_history)
  49 #define HWMON_C_REGISTER_TZ             BIT(hwmon_chip_register_tz)
  50 #define HWMON_C_UPDATE_INTERVAL         BIT(hwmon_chip_update_interval)
  51 #define HWMON_C_ALARMS                  BIT(hwmon_chip_alarms)
  52
  53 enum hwmon_temp_attributes {
  54         hwmon_temp_input = 0,
  55         hwmon_temp_type,
  56         hwmon_temp_lcrit,
  57         hwmon_temp_lcrit_hyst,
  58         hwmon_temp_min,
  59         hwmon_temp_min_hyst,
  60         hwmon_temp_max,
  61         hwmon_temp_max_hyst,
  62         hwmon_temp_crit,
  63         hwmon_temp_crit_hyst,
  64         hwmon_temp_emergency,
  65         hwmon_temp_emergency_hyst,
  66         hwmon_temp_alarm,
  67         hwmon_temp_lcrit_alarm,
  68         hwmon_temp_min_alarm,
  69         hwmon_temp_max_alarm,
  70         hwmon_temp_crit_alarm,
  71         hwmon_temp_emergency_alarm,
  72         hwmon_temp_fault,
  73         hwmon_temp_offset,
  74         hwmon_temp_label,
  75         hwmon_temp_lowest,
  76         hwmon_temp_highest,
  77         hwmon_temp_reset_history,
  78 };
  79
  80 #define HWMON_T_INPUT           BIT(hwmon_temp_input)
  81 #define HWMON_T_TYPE            BIT(hwmon_temp_type)
  82 #define HWMON_T_LCRIT           BIT(hwmon_temp_lcrit)
  83 #define HWMON_T_LCRIT_HYST      BIT(hwmon_temp_lcrit_hyst)
  84 #define HWMON_T_MIN             BIT(hwmon_temp_min)
  85 #define HWMON_T_MIN_HYST        BIT(hwmon_temp_min_hyst)
  86 #define HWMON_T_MAX             BIT(hwmon_temp_max)
  87 #define HWMON_T_MAX_HYST        BIT(hwmon_temp_max_hyst)
  88 #define HWMON_T_CRIT            BIT(hwmon_temp_crit)
  89 #define HWMON_T_CRIT_HYST       BIT(hwmon_temp_crit_hyst)
  90 #define HWMON_T_EMERGENCY       BIT(hwmon_temp_emergency)
  91 #define HWMON_T_EMERGENCY_HYST  BIT(hwmon_temp_emergency_hyst)
  92 #define HWMON_T_ALARM           BIT(hwmon_temp_alarm)
  93 #define HWMON_T_MIN_ALARM       BIT(hwmon_temp_min_alarm)
  94 #define HWMON_T_MAX_ALARM       BIT(hwmon_temp_max_alarm)
  95 #define HWMON_T_CRIT_ALARM      BIT(hwmon_temp_crit_alarm)
  96 #define HWMON_T_EMERGENCY_ALARM BIT(hwmon_temp_emergency_alarm)
  97 #define HWMON_T_FAULT           BIT(hwmon_temp_fault)
  98 #define HWMON_T_OFFSET          BIT(hwmon_temp_offset)
  99 #define HWMON_T_LABEL           BIT(hwmon_temp_label)
 100 #define HWMON_T_LOWEST          BIT(hwmon_temp_lowest)
 101 #define HWMON_T_HIGHEST         BIT(hwmon_temp_highest)
 102 #define HWMON_T_RESET_HISTORY   BIT(hwmon_temp_reset_history)
 103
 104 enum hwmon_in_attributes {
 105         hwmon_in_input,
 106         hwmon_in_min,
 107         hwmon_in_max,
 108         hwmon_in_lcrit,
 109         hwmon_in_crit,
 110         hwmon_in_average,
 111         hwmon_in_lowest,
 112         hwmon_in_highest,
 113         hwmon_in_reset_history,
 114         hwmon_in_label,
 115         hwmon_in_alarm,
 116         hwmon_in_min_alarm,
 117         hwmon_in_max_alarm,
 118         hwmon_in_lcrit_alarm,
 119         hwmon_in_crit_alarm,
 120 };
 121
 122 #define HWMON_I_INPUT           BIT(hwmon_in_input)
 123 #define HWMON_I_MIN             BIT(hwmon_in_min)
 124 #define HWMON_I_MAX             BIT(hwmon_in_max)
 125 #define HWMON_I_LCRIT           BIT(hwmon_in_lcrit)
 126 #define HWMON_I_CRIT            BIT(hwmon_in_crit)
 127 #define HWMON_I_AVERAGE         BIT(hwmon_in_average)
 128 #define HWMON_I_LOWEST          BIT(hwmon_in_lowest)
 129 #define HWMON_I_HIGHEST         BIT(hwmon_in_highest)
 130 #define HWMON_I_RESET_HISTORY   BIT(hwmon_in_reset_history)
 131 #define HWMON_I_LABEL           BIT(hwmon_in_label)
 132 #define HWMON_I_ALARM           BIT(hwmon_in_alarm)
 133 #define HWMON_I_MIN_ALARM       BIT(hwmon_in_min_alarm)
 134 #define HWMON_I_MAX_ALARM       BIT(hwmon_in_max_alarm)
 135 #define HWMON_I_LCRIT_ALARM     BIT(hwmon_in_lcrit_alarm)
 136 #define HWMON_I_CRIT_ALARM      BIT(hwmon_in_crit_alarm)
 137
 138 enum hwmon_curr_attributes {
 139         hwmon_curr_input,
 140         hwmon_curr_min,
 141         hwmon_curr_max,
 142         hwmon_curr_lcrit,
 143         hwmon_curr_crit,
 144         hwmon_curr_average,
 145         hwmon_curr_lowest,
 146         hwmon_curr_highest,
 147         hwmon_curr_reset_history,
 148         hwmon_curr_label,
 149         hwmon_curr_alarm,
 150         hwmon_curr_min_alarm,
 151         hwmon_curr_max_alarm,
 152         hwmon_curr_lcrit_alarm,
 153         hwmon_curr_crit_alarm,
 154 };
 155
 156 #define HWMON_C_INPUT           BIT(hwmon_curr_input)
 157 #define HWMON_C_MIN             BIT(hwmon_curr_min)
 158 #define HWMON_C_MAX             BIT(hwmon_curr_max)
 159 #define HWMON_C_LCRIT           BIT(hwmon_curr_lcrit)
 160 #define HWMON_C_CRIT            BIT(hwmon_curr_crit)
 161 #define HWMON_C_AVERAGE         BIT(hwmon_curr_average)
 162 #define HWMON_C_LOWEST          BIT(hwmon_curr_lowest)
 163 #define HWMON_C_HIGHEST         BIT(hwmon_curr_highest)
 164 #define HWMON_C_RESET_HISTORY   BIT(hwmon_curr_reset_history)
 165 #define HWMON_C_LABEL           BIT(hwmon_curr_label)
 166 #define HWMON_C_ALARM           BIT(hwmon_curr_alarm)
 167 #define HWMON_C_MIN_ALARM       BIT(hwmon_curr_min_alarm)
 168 #define HWMON_C_MAX_ALARM       BIT(hwmon_curr_max_alarm)
 169 #define HWMON_C_LCRIT_ALARM     BIT(hwmon_curr_lcrit_alarm)
 170 #define HWMON_C_CRIT_ALARM      BIT(hwmon_curr_crit_alarm)
 171
 172 enum hwmon_power_attributes {
 173         hwmon_power_average,
 174         hwmon_power_average_interval,
 175         hwmon_power_average_interval_max,
 176         hwmon_power_average_interval_min,
 177         hwmon_power_average_highest,
 178         hwmon_power_average_lowest,
 179         hwmon_power_average_max,
 180         hwmon_power_average_min,
 181         hwmon_power_input,
 182         hwmon_power_input_highest,
 183         hwmon_power_input_lowest,
 184         hwmon_power_reset_history,
 185         hwmon_power_accuracy,
 186         hwmon_power_cap,
 187         hwmon_power_cap_hyst,
 188         hwmon_power_cap_max,
 189         hwmon_power_cap_min,
 190         hwmon_power_max,
 191         hwmon_power_crit,
 192         hwmon_power_label,
 193         hwmon_power_alarm,
 194         hwmon_power_cap_alarm,
 195         hwmon_power_max_alarm,
 196         hwmon_power_crit_alarm,
 197 };
 198
 199 #define HWMON_P_AVERAGE                 BIT(hwmon_power_average)
 200 #define HWMON_P_AVERAGE_INTERVAL        BIT(hwmon_power_average_interval)
 201 #define HWMON_P_AVERAGE_INTERVAL_MAX    BIT(hwmon_power_average_interval_max)
 202 #define HWMON_P_AVERAGE_INTERVAL_MIN    BIT(hwmon_power_average_interval_min)
 203 #define HWMON_P_AVERAGE_HIGHEST         BIT(hwmon_power_average_highest)
 204 #define HWMON_P_AVERAGE_LOWEST          BIT(hwmon_power_average_lowest)
 205 #define HWMON_P_AVERAGE_MAX             BIT(hwmon_power_average_max)
 206 #define HWMON_P_AVERAGE_MIN             BIT(hwmon_power_average_min)
 207 #define HWMON_P_INPUT                   BIT(hwmon_power_input)
 208 #define HWMON_P_INPUT_HIGHEST           BIT(hwmon_power_input_highest)
 209 #define HWMON_P_INPUT_LOWEST            BIT(hwmon_power_input_lowest)
 210 #define HWMON_P_RESET_HISTORY           BIT(hwmon_power_reset_history)
 211 #define HWMON_P_ACCURACY                BIT(hwmon_power_accuracy)
 212 #define HWMON_P_CAP                     BIT(hwmon_power_cap)
 213 #define HWMON_P_CAP_HYST                BIT(hwmon_power_cap_hyst)
 214 #define HWMON_P_CAP_MAX                 BIT(hwmon_power_cap_max)
 215 #define HWMON_P_CAP_MIN                 BIT(hwmon_power_cap_min)
 216 #define HWMON_P_MAX                     BIT(hwmon_power_max)
 217 #define HWMON_P_CRIT                    BIT(hwmon_power_crit)
 218 #define HWMON_P_LABEL                   BIT(hwmon_power_label)
 219 #define HWMON_P_ALARM                   BIT(hwmon_power_alarm)
 220 #define HWMON_P_CAP_ALARM               BIT(hwmon_power_cap_alarm)
 221 #define HWMON_P_MAX_ALARM               BIT(hwmon_power_max_alarm)
 222 #define HWMON_P_CRIT_ALARM              BIT(hwmon_power_crit_alarm)
 223
 224 enum hwmon_energy_attributes {
 225         hwmon_energy_input,
 226         hwmon_energy_label,
 227 };
 228
 229 #define HWMON_E_INPUT                   BIT(hwmon_energy_input)
 230 #define HWMON_E_LABEL                   BIT(hwmon_energy_label)
 231
 232 enum hwmon_humidity_attributes {
 233         hwmon_humidity_input,
 234         hwmon_humidity_label,
 235         hwmon_humidity_min,
 236         hwmon_humidity_min_hyst,
 237         hwmon_humidity_max,
 238         hwmon_humidity_max_hyst,
 239         hwmon_humidity_alarm,
 240         hwmon_humidity_fault,
 241 };
 242
 243 #define HWMON_H_INPUT                   BIT(hwmon_humidity_input)
 244 #define HWMON_H_LABEL                   BIT(hwmon_humidity_label)
 245 #define HWMON_H_MIN                     BIT(hwmon_humidity_min)
 246 #define HWMON_H_MIN_HYST                BIT(hwmon_humidity_min_hyst)
 247 #define HWMON_H_MAX                     BIT(hwmon_humidity_max)
 248 #define HWMON_H_MAX_HYST                BIT(hwmon_humidity_max_hyst)
 249 #define HWMON_H_ALARM                   BIT(hwmon_humidity_alarm)
 250 #define HWMON_H_FAULT                   BIT(hwmon_humidity_fault)
 251
 252 enum hwmon_fan_attributes {
 253         hwmon_fan_input,
 254         hwmon_fan_label,
 255         hwmon_fan_min,
 256         hwmon_fan_max,
 257         hwmon_fan_div,
 258         hwmon_fan_pulses,
 259         hwmon_fan_target,
 260         hwmon_fan_alarm,
 261         hwmon_fan_min_alarm,
 262         hwmon_fan_max_alarm,
 263         hwmon_fan_fault,
 264 };
 265
 266 #define HWMON_F_INPUT                   BIT(hwmon_fan_input)
 267 #define HWMON_F_LABEL                   BIT(hwmon_fan_label)
 268 #define HWMON_F_MIN                     BIT(hwmon_fan_min)
 269 #define HWMON_F_MAX                     BIT(hwmon_fan_max)
 270 #define HWMON_F_DIV                     BIT(hwmon_fan_div)
 271 #define HWMON_F_PULSES                  BIT(hwmon_fan_pulses)
 272 #define HWMON_F_TARGET                  BIT(hwmon_fan_target)
 273 #define HWMON_F_ALARM                   BIT(hwmon_fan_alarm)
 274 #define HWMON_F_MIN_ALARM               BIT(hwmon_fan_min_alarm)
 275 #define HWMON_F_MAX_ALARM               BIT(hwmon_fan_max_alarm)
 276 #define HWMON_F_FAULT                   BIT(hwmon_fan_fault)
 277
 278 enum hwmon_pwm_attributes {
 279         hwmon_pwm_input,
 280         hwmon_pwm_enable,
 281         hwmon_pwm_mode,
 282         hwmon_pwm_freq,
 283 };
 284
 285 #define HWMON_PWM_INPUT                 BIT(hwmon_pwm_input)
 286 #define HWMON_PWM_ENABLE                BIT(hwmon_pwm_enable)
 287 #define HWMON_PWM_MODE                  BIT(hwmon_pwm_mode)
 288 #define HWMON_PWM_FREQ                  BIT(hwmon_pwm_freq)
 289
 290 /**
 291  * struct hwmon_ops - hwmon device operations
 292  * @is_visible: Callback to return attribute visibility. Mandatory.
 293  *              Parameters are:
 294  *              @const void *drvdata:
 295  *                      Pointer to driver-private data structure passed
 296  *                      as argument to hwmon_device_register_with_info().
 297  *              @type:  Sensor type
 298  *              @attr:  Sensor attribute
 299  *              @channel:
 300  *                      Channel number
 301  *              The function returns the file permissions.
 302  *              If the return value is 0, no attribute will be created.
 303  * @read:       Read callback for data attributes. Mandatory if readable
 304  *              data attributes are present.
 305  *              Parameters are:
 306  *              @dev:   Pointer to hardware monitoring device
 307  *              @type:  Sensor type
 308  *              @attr:  Sensor attribute
 309  *              @channel:
 310  *                      Channel number
 311  *              @val:   Pointer to returned value
 312  *              The function returns 0 on success or a negative error number.
 313  * @read_string:
 314  *              Read callback for string attributes. Mandatory if string
 315  *              attributes are present.
 316  *              Parameters are:
 317  *              @dev:   Pointer to hardware monitoring device
 318  *              @type:  Sensor type
 319  *              @attr:  Sensor attribute
 320  *              @channel:
 321  *                      Channel number
 322  *              @str:   Pointer to returned string
 323  *              The function returns 0 on success or a negative error number.
 324  * @write:      Write callback for data attributes. Mandatory if writeable
 325  *              data attributes are present.
 326  *              Parameters are:
 327  *              @dev:   Pointer to hardware monitoring device
 328  *              @type:  Sensor type
 329  *              @attr:  Sensor attribute
 330  *              @channel:
 331  *                      Channel number
 332  *              @val:   Value to write
 333  *              The function returns 0 on success or a negative error number.
 334  */
 335 struct hwmon_ops {
 336         umode_t (*is_visible)(const void *drvdata, enum hwmon_sensor_types type,
 337                               u32 attr, int channel);
 338         int (*read)(struct device *dev, enum hwmon_sensor_types type,
 339                     u32 attr, int channel, long *val);
 340         int (*read_string)(struct device *dev, enum hwmon_sensor_types type,
 341                     u32 attr, int channel, const char **str);
 342         int (*write)(struct device *dev, enum hwmon_sensor_types type,
 343                      u32 attr, int channel, long val);
 344 };
 345
 346 /**
 347  * Channel information
 348  * @type:       Channel type.
 349  * @config:     Pointer to NULL-terminated list of channel parameters.
 350  *              Use for per-channel attributes.
 351  */
 352 struct hwmon_channel_info {
 353         enum hwmon_sensor_types type;
 354         const u32 *config;
 355 };
 356
 357 /**
 358  * Chip configuration
 359  * @ops:        Pointer to hwmon operations.
 360  * @info:       Null-terminated list of channel information.
 361  */
 362 struct hwmon_chip_info {
 363         const struct hwmon_ops *ops;
 364         const struct hwmon_channel_info **info;
 365 };
 366
 367 /* hwmon_device_register() is deprecated */
 368 struct device *hwmon_device_register(struct device *dev);
 369
 370 struct device *
 371 hwmon_device_register_with_groups(struct device *dev, const char *name,
 372                                   void *drvdata,
 373                                   const struct attribute_group **groups);
 374 struct device *
 375 devm_hwmon_device_register_with_groups(struct device *dev, const char *name,
 376                                        void *drvdata,
 377                                        const struct attribute_group **groups);
 378 struct device *
 379 hwmon_device_register_with_info(struct device *dev,
 380                                 const char *name, void *drvdata,
 381                                 const struct hwmon_chip_info *info,
 382                                 const struct attribute_group **extra_groups);
 383 struct device *
 384 devm_hwmon_device_register_with_info(struct device *dev,
 385                                 const char *name, void *drvdata,
 386                                 const struct hwmon_chip_info *info,
 387                                 const struct attribute_group **extra_groups);
 388
 389 void hwmon_device_unregister(struct device *dev);
 390 void devm_hwmon_device_unregister(struct device *dev);
 391
 392 #endif