1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 hwmon.h - part of lm_sensors, Linux kernel modules for hardware monitoring
4
5 This file declares helper functions for the sysfs class "hwmon",
6 for use by sensors drivers.
7
8 Copyright (C) 2005 Mark M. Hoffman <mhoffman@lightlink.com>
9
10 */
11
12 #ifndef _HWMON_H_
13 #define _HWMON_H_
14
15 #include <linux/bitops.h>
16
17 struct device;
18 struct attribute_group;
19
20 enum hwmon_sensor_types {
21 hwmon_chip,
22 hwmon_temp,
23 hwmon_in,
24 hwmon_curr,
25 hwmon_power,
26 hwmon_energy,
27 hwmon_humidity,
28 hwmon_fan,
29 hwmon_pwm,
30 hwmon_intrusion,
31 hwmon_max,
32 };
33
34 enum hwmon_chip_attributes {
35 hwmon_chip_temp_reset_history,
36 hwmon_chip_in_reset_history,
37 hwmon_chip_curr_reset_history,
38 hwmon_chip_power_reset_history,
39 hwmon_chip_register_tz,
40 hwmon_chip_update_interval,
41 hwmon_chip_alarms,
42 hwmon_chip_samples,
43 hwmon_chip_curr_samples,
44 hwmon_chip_in_samples,
45 hwmon_chip_power_samples,
46 hwmon_chip_temp_samples,
47 hwmon_chip_beep_enable,
48 };
49
50 #define HWMON_C_TEMP_RESET_HISTORY BIT(hwmon_chip_temp_reset_history)
51 #define HWMON_C_IN_RESET_HISTORY BIT(hwmon_chip_in_reset_history)
52 #define HWMON_C_CURR_RESET_HISTORY BIT(hwmon_chip_curr_reset_history)
53 #define HWMON_C_POWER_RESET_HISTORY BIT(hwmon_chip_power_reset_history)
54 #define HWMON_C_REGISTER_TZ BIT(hwmon_chip_register_tz)
55 #define HWMON_C_UPDATE_INTERVAL BIT(hwmon_chip_update_interval)
56 #define HWMON_C_ALARMS BIT(hwmon_chip_alarms)
57 #define HWMON_C_SAMPLES BIT(hwmon_chip_samples)
58 #define HWMON_C_CURR_SAMPLES BIT(hwmon_chip_curr_samples)
59 #define HWMON_C_IN_SAMPLES BIT(hwmon_chip_in_samples)
60 #define HWMON_C_POWER_SAMPLES BIT(hwmon_chip_power_samples)
61 #define HWMON_C_TEMP_SAMPLES BIT(hwmon_chip_temp_samples)
62 #define HWMON_C_BEEP_ENABLE BIT(hwmon_chip_beep_enable)
63
64 enum hwmon_temp_attributes {
65 hwmon_temp_enable,
66 hwmon_temp_input,
67 hwmon_temp_type,
68 hwmon_temp_lcrit,
69 hwmon_temp_lcrit_hyst,
70 hwmon_temp_min,
71 hwmon_temp_min_hyst,
72 hwmon_temp_max,
73 hwmon_temp_max_hyst,
74 hwmon_temp_crit,
75 hwmon_temp_crit_hyst,
76 hwmon_temp_emergency,
77 hwmon_temp_emergency_hyst,
78 hwmon_temp_alarm,
79 hwmon_temp_lcrit_alarm,
80 hwmon_temp_min_alarm,
81 hwmon_temp_max_alarm,
82 hwmon_temp_crit_alarm,
83 hwmon_temp_emergency_alarm,
84 hwmon_temp_fault,
85 hwmon_temp_offset,
86 hwmon_temp_label,
87 hwmon_temp_lowest,
88 hwmon_temp_highest,
89 hwmon_temp_reset_history,
90 hwmon_temp_rated_min,
91 hwmon_temp_rated_max,
92 hwmon_temp_beep,
93 };
94
95 #define HWMON_T_ENABLE BIT(hwmon_temp_enable)
96 #define HWMON_T_INPUT BIT(hwmon_temp_input)
97 #define HWMON_T_TYPE BIT(hwmon_temp_type)
98 #define HWMON_T_LCRIT BIT(hwmon_temp_lcrit)
99 #define HWMON_T_LCRIT_HYST BIT(hwmon_temp_lcrit_hyst)
100 #define HWMON_T_MIN BIT(hwmon_temp_min)
101 #define HWMON_T_MIN_HYST BIT(hwmon_temp_min_hyst)
102 #define HWMON_T_MAX BIT(hwmon_temp_max)
103 #define HWMON_T_MAX_HYST BIT(hwmon_temp_max_hyst)
104 #define HWMON_T_CRIT BIT(hwmon_temp_crit)
105 #define HWMON_T_CRIT_HYST BIT(hwmon_temp_crit_hyst)
106 #define HWMON_T_EMERGENCY BIT(hwmon_temp_emergency)
107 #define HWMON_T_EMERGENCY_HYST BIT(hwmon_temp_emergency_hyst)
108 #define HWMON_T_ALARM BIT(hwmon_temp_alarm)
109 #define HWMON_T_MIN_ALARM BIT(hwmon_temp_min_alarm)
110 #define HWMON_T_MAX_ALARM BIT(hwmon_temp_max_alarm)
111 #define HWMON_T_CRIT_ALARM BIT(hwmon_temp_crit_alarm)
112 #define HWMON_T_LCRIT_ALARM BIT(hwmon_temp_lcrit_alarm)
113 #define HWMON_T_EMERGENCY_ALARM BIT(hwmon_temp_emergency_alarm)
114 #define HWMON_T_FAULT BIT(hwmon_temp_fault)
115 #define HWMON_T_OFFSET BIT(hwmon_temp_offset)
116 #define HWMON_T_LABEL BIT(hwmon_temp_label)
117 #define HWMON_T_LOWEST BIT(hwmon_temp_lowest)
118 #define HWMON_T_HIGHEST BIT(hwmon_temp_highest)
119 #define HWMON_T_RESET_HISTORY BIT(hwmon_temp_reset_history)
120 #define HWMON_T_RATED_MIN BIT(hwmon_temp_rated_min)
121 #define HWMON_T_RATED_MAX BIT(hwmon_temp_rated_max)
122 #define HWMON_T_BEEP BIT(hwmon_temp_beep)
123
124 enum hwmon_in_attributes {
125 hwmon_in_enable,
126 hwmon_in_input,
127 hwmon_in_min,
128 hwmon_in_max,
129 hwmon_in_lcrit,
130 hwmon_in_crit,
131 hwmon_in_average,
132 hwmon_in_lowest,
133 hwmon_in_highest,
134 hwmon_in_reset_history,
135 hwmon_in_label,
136 hwmon_in_alarm,
137 hwmon_in_min_alarm,
138 hwmon_in_max_alarm,
139 hwmon_in_lcrit_alarm,
140 hwmon_in_crit_alarm,
141 hwmon_in_rated_min,
142 hwmon_in_rated_max,
143 hwmon_in_beep,
144 hwmon_in_fault,
145 };
146
147 #define HWMON_I_ENABLE BIT(hwmon_in_enable)
148 #define HWMON_I_INPUT BIT(hwmon_in_input)
149 #define HWMON_I_MIN BIT(hwmon_in_min)
150 #define HWMON_I_MAX BIT(hwmon_in_max)
151 #define HWMON_I_LCRIT BIT(hwmon_in_lcrit)
152 #define HWMON_I_CRIT BIT(hwmon_in_crit)
153 #define HWMON_I_AVERAGE BIT(hwmon_in_average)
154 #define HWMON_I_LOWEST BIT(hwmon_in_lowest)
155 #define HWMON_I_HIGHEST BIT(hwmon_in_highest)
156 #define HWMON_I_RESET_HISTORY BIT(hwmon_in_reset_history)
157 #define HWMON_I_LABEL BIT(hwmon_in_label)
158 #define HWMON_I_ALARM BIT(hwmon_in_alarm)
159 #define HWMON_I_MIN_ALARM BIT(hwmon_in_min_alarm)
160 #define HWMON_I_MAX_ALARM BIT(hwmon_in_max_alarm)
161 #define HWMON_I_LCRIT_ALARM BIT(hwmon_in_lcrit_alarm)
162 #define HWMON_I_CRIT_ALARM BIT(hwmon_in_crit_alarm)
163 #define HWMON_I_RATED_MIN BIT(hwmon_in_rated_min)
164 #define HWMON_I_RATED_MAX BIT(hwmon_in_rated_max)
165 #define HWMON_I_BEEP BIT(hwmon_in_beep)
166 #define HWMON_I_FAULT BIT(hwmon_in_fault)
167
168 enum hwmon_curr_attributes {
169 hwmon_curr_enable,
170 hwmon_curr_input,
171 hwmon_curr_min,
172 hwmon_curr_max,
173 hwmon_curr_lcrit,
174 hwmon_curr_crit,
175 hwmon_curr_average,
176 hwmon_curr_lowest,
177 hwmon_curr_highest,
178 hwmon_curr_reset_history,
179 hwmon_curr_label,
180 hwmon_curr_alarm,
181 hwmon_curr_min_alarm,
182 hwmon_curr_max_alarm,
183 hwmon_curr_lcrit_alarm,
184 hwmon_curr_crit_alarm,
185 hwmon_curr_rated_min,
186 hwmon_curr_rated_max,
187 hwmon_curr_beep,
188 };
189
190 #define HWMON_C_ENABLE BIT(hwmon_curr_enable)
191 #define HWMON_C_INPUT BIT(hwmon_curr_input)
192 #define HWMON_C_MIN BIT(hwmon_curr_min)
193 #define HWMON_C_MAX BIT(hwmon_curr_max)
194 #define HWMON_C_LCRIT BIT(hwmon_curr_lcrit)
195 #define HWMON_C_CRIT BIT(hwmon_curr_crit)
196 #define HWMON_C_AVERAGE BIT(hwmon_curr_average)
197 #define HWMON_C_LOWEST BIT(hwmon_curr_lowest)
198 #define HWMON_C_HIGHEST BIT(hwmon_curr_highest)
199 #define HWMON_C_RESET_HISTORY BIT(hwmon_curr_reset_history)
200 #define HWMON_C_LABEL BIT(hwmon_curr_label)
201 #define HWMON_C_ALARM BIT(hwmon_curr_alarm)
202 #define HWMON_C_MIN_ALARM BIT(hwmon_curr_min_alarm)
203 #define HWMON_C_MAX_ALARM BIT(hwmon_curr_max_alarm)
204 #define HWMON_C_LCRIT_ALARM BIT(hwmon_curr_lcrit_alarm)
205 #define HWMON_C_CRIT_ALARM BIT(hwmon_curr_crit_alarm)
206 #define HWMON_C_RATED_MIN BIT(hwmon_curr_rated_min)
207 #define HWMON_C_RATED_MAX BIT(hwmon_curr_rated_max)
208 #define HWMON_C_BEEP BIT(hwmon_curr_beep)
209
210 enum hwmon_power_attributes {
211 hwmon_power_enable,
212 hwmon_power_average,
213 hwmon_power_average_interval,
214 hwmon_power_average_interval_max,
215 hwmon_power_average_interval_min,
216 hwmon_power_average_highest,
217 hwmon_power_average_lowest,
218 hwmon_power_average_max,
219 hwmon_power_average_min,
220 hwmon_power_input,
221 hwmon_power_input_highest,
222 hwmon_power_input_lowest,
223 hwmon_power_reset_history,
224 hwmon_power_accuracy,
225 hwmon_power_cap,
226 hwmon_power_cap_hyst,
227 hwmon_power_cap_max,
228 hwmon_power_cap_min,
229 hwmon_power_min,
230 hwmon_power_max,
231 hwmon_power_crit,
232 hwmon_power_lcrit,
233 hwmon_power_label,
234 hwmon_power_alarm,
235 hwmon_power_cap_alarm,
236 hwmon_power_min_alarm,
237 hwmon_power_max_alarm,
238 hwmon_power_lcrit_alarm,
239 hwmon_power_crit_alarm,
240 hwmon_power_rated_min,
241 hwmon_power_rated_max,
242 };
243
244 #define HWMON_P_ENABLE BIT(hwmon_power_enable)
245 #define HWMON_P_AVERAGE BIT(hwmon_power_average)
246 #define HWMON_P_AVERAGE_INTERVAL BIT(hwmon_power_average_interval)
247 #define HWMON_P_AVERAGE_INTERVAL_MAX BIT(hwmon_power_average_interval_max)
248 #define HWMON_P_AVERAGE_INTERVAL_MIN BIT(hwmon_power_average_interval_min)
249 #define HWMON_P_AVERAGE_HIGHEST BIT(hwmon_power_average_highest)
250 #define HWMON_P_AVERAGE_LOWEST BIT(hwmon_power_average_lowest)
251 #define HWMON_P_AVERAGE_MAX BIT(hwmon_power_average_max)
252 #define HWMON_P_AVERAGE_MIN BIT(hwmon_power_average_min)
253 #define HWMON_P_INPUT BIT(hwmon_power_input)
254 #define HWMON_P_INPUT_HIGHEST BIT(hwmon_power_input_highest)
255 #define HWMON_P_INPUT_LOWEST BIT(hwmon_power_input_lowest)
256 #define HWMON_P_RESET_HISTORY BIT(hwmon_power_reset_history)
257 #define HWMON_P_ACCURACY BIT(hwmon_power_accuracy)
258 #define HWMON_P_CAP BIT(hwmon_power_cap)
259 #define HWMON_P_CAP_HYST BIT(hwmon_power_cap_hyst)
260 #define HWMON_P_CAP_MAX BIT(hwmon_power_cap_max)
261 #define HWMON_P_CAP_MIN BIT(hwmon_power_cap_min)
262 #define HWMON_P_MIN BIT(hwmon_power_min)
263 #define HWMON_P_MAX BIT(hwmon_power_max)
264 #define HWMON_P_LCRIT BIT(hwmon_power_lcrit)
265 #define HWMON_P_CRIT BIT(hwmon_power_crit)
266 #define HWMON_P_LABEL BIT(hwmon_power_label)
267 #define HWMON_P_ALARM BIT(hwmon_power_alarm)
268 #define HWMON_P_CAP_ALARM BIT(hwmon_power_cap_alarm)
269 #define HWMON_P_MIN_ALARM BIT(hwmon_power_min_alarm)
270 #define HWMON_P_MAX_ALARM BIT(hwmon_power_max_alarm)
271 #define HWMON_P_LCRIT_ALARM BIT(hwmon_power_lcrit_alarm)
272 #define HWMON_P_CRIT_ALARM BIT(hwmon_power_crit_alarm)
273 #define HWMON_P_RATED_MIN BIT(hwmon_power_rated_min)
274 #define HWMON_P_RATED_MAX BIT(hwmon_power_rated_max)
275
276 enum hwmon_energy_attributes {
277 hwmon_energy_enable,
278 hwmon_energy_input,
279 hwmon_energy_label,
280 };
281
282 #define HWMON_E_ENABLE BIT(hwmon_energy_enable)
283 #define HWMON_E_INPUT BIT(hwmon_energy_input)
284 #define HWMON_E_LABEL BIT(hwmon_energy_label)
285
286 enum hwmon_humidity_attributes {
287 hwmon_humidity_enable,
288 hwmon_humidity_input,
289 hwmon_humidity_label,
290 hwmon_humidity_min,
291 hwmon_humidity_min_hyst,
292 hwmon_humidity_max,
293 hwmon_humidity_max_hyst,
294 hwmon_humidity_alarm,
295 hwmon_humidity_fault,
296 hwmon_humidity_rated_min,
297 hwmon_humidity_rated_max,
298 hwmon_humidity_min_alarm,
299 hwmon_humidity_max_alarm,
300 };
301
302 #define HWMON_H_ENABLE BIT(hwmon_humidity_enable)
303 #define HWMON_H_INPUT BIT(hwmon_humidity_input)
304 #define HWMON_H_LABEL BIT(hwmon_humidity_label)
305 #define HWMON_H_MIN BIT(hwmon_humidity_min)
306 #define HWMON_H_MIN_HYST BIT(hwmon_humidity_min_hyst)
307 #define HWMON_H_MAX BIT(hwmon_humidity_max)
308 #define HWMON_H_MAX_HYST BIT(hwmon_humidity_max_hyst)
309 #define HWMON_H_ALARM BIT(hwmon_humidity_alarm)
310 #define HWMON_H_FAULT BIT(hwmon_humidity_fault)
311 #define HWMON_H_RATED_MIN BIT(hwmon_humidity_rated_min)
312 #define HWMON_H_RATED_MAX BIT(hwmon_humidity_rated_max)
313 #define HWMON_H_MIN_ALARM BIT(hwmon_humidity_min_alarm)
314 #define HWMON_H_MAX_ALARM BIT(hwmon_humidity_max_alarm)
315
316 enum hwmon_fan_attributes {
317 hwmon_fan_enable,
318 hwmon_fan_input,
319 hwmon_fan_label,
320 hwmon_fan_min,
321 hwmon_fan_max,
322 hwmon_fan_div,
323 hwmon_fan_pulses,
324 hwmon_fan_target,
325 hwmon_fan_alarm,
326 hwmon_fan_min_alarm,
327 hwmon_fan_max_alarm,
328 hwmon_fan_fault,
329 hwmon_fan_beep,
330 };
331
332 #define HWMON_F_ENABLE BIT(hwmon_fan_enable)
333 #define HWMON_F_INPUT BIT(hwmon_fan_input)
334 #define HWMON_F_LABEL BIT(hwmon_fan_label)
335 #define HWMON_F_MIN BIT(hwmon_fan_min)
336 #define HWMON_F_MAX BIT(hwmon_fan_max)
337 #define HWMON_F_DIV BIT(hwmon_fan_div)
338 #define HWMON_F_PULSES BIT(hwmon_fan_pulses)
339 #define HWMON_F_TARGET BIT(hwmon_fan_target)
340 #define HWMON_F_ALARM BIT(hwmon_fan_alarm)
341 #define HWMON_F_MIN_ALARM BIT(hwmon_fan_min_alarm)
342 #define HWMON_F_MAX_ALARM BIT(hwmon_fan_max_alarm)
343 #define HWMON_F_FAULT BIT(hwmon_fan_fault)
344 #define HWMON_F_BEEP BIT(hwmon_fan_beep)
345
346 enum hwmon_pwm_attributes {
347 hwmon_pwm_input,
348 hwmon_pwm_enable,
349 hwmon_pwm_mode,
350 hwmon_pwm_freq,
351 hwmon_pwm_auto_channels_temp,
352 };
353
354 #define HWMON_PWM_INPUT BIT(hwmon_pwm_input)
355 #define HWMON_PWM_ENABLE BIT(hwmon_pwm_enable)
356 #define HWMON_PWM_MODE BIT(hwmon_pwm_mode)
357 #define HWMON_PWM_FREQ BIT(hwmon_pwm_freq)
358 #define HWMON_PWM_AUTO_CHANNELS_TEMP BIT(hwmon_pwm_auto_channels_temp)
359
360 enum hwmon_intrusion_attributes {
361 hwmon_intrusion_alarm,
362 hwmon_intrusion_beep,
363 };
364 #define HWMON_INTRUSION_ALARM BIT(hwmon_intrusion_alarm)
365 #define HWMON_INTRUSION_BEEP BIT(hwmon_intrusion_beep)
366
367 /**
368 * struct hwmon_ops - hwmon device operations
369 * @is_visible: Callback to return attribute visibility. Mandatory.
370 * Parameters are:
371 * @const void *drvdata:
372 * Pointer to driver-private data structure passed
373 * as argument to hwmon_device_register_with_info().
374 * @type: Sensor type
375 * @attr: Sensor attribute
376 * @channel:
377 * Channel number
378 * The function returns the file permissions.
379 * If the return value is 0, no attribute will be created.
380 * @read: Read callback for data attributes. Mandatory if readable
381 * data attributes are present.
382 * Parameters are:
383 * @dev: Pointer to hardware monitoring device
384 * @type: Sensor type
385 * @attr: Sensor attribute
386 * @channel:
387 * Channel number
388 * @val: Pointer to returned value
389 * The function returns 0 on success or a negative error number.
390 * @read_string:
391 * Read callback for string attributes. Mandatory if string
392 * attributes are present.
393 * Parameters are:
394 * @dev: Pointer to hardware monitoring device
395 * @type: Sensor type
396 * @attr: Sensor attribute
397 * @channel:
398 * Channel number
399 * @str: Pointer to returned string
400 * The function returns 0 on success or a negative error number.
401 * @write: Write callback for data attributes. Mandatory if writeable
402 * data attributes are present.
403 * Parameters are:
404 * @dev: Pointer to hardware monitoring device
405 * @type: Sensor type
406 * @attr: Sensor attribute
407 * @channel:
408 * Channel number
409 * @val: Value to write
410 * The function returns 0 on success or a negative error number.
411 */
412 struct hwmon_ops {
413 umode_t (*is_visible)(const void *drvdata, enum hwmon_sensor_types type,
414 u32 attr, int channel);
415 int (*read)(struct device *dev, enum hwmon_sensor_types type,
416 u32 attr, int channel, long *val);
417 int (*read_string)(struct device *dev, enum hwmon_sensor_types type,
418 u32 attr, int channel, const char **str);
419 int (*write)(struct device *dev, enum hwmon_sensor_types type,
420 u32 attr, int channel, long val);
421 };
422
423 /**
424 * struct hwmon_channel_info - Channel information
425 * @type: Channel type.
426 * @config: Pointer to NULL-terminated list of channel parameters.
427 * Use for per-channel attributes.
428 */
429 struct hwmon_channel_info {
430 enum hwmon_sensor_types type;
431 const u32 *config;
432 };
433
434 #define HWMON_CHANNEL_INFO(stype, ...) \
435 (&(const struct hwmon_channel_info) { \
436 .type = hwmon_##stype, \
437 .config = (const u32 []) { \
438 __VA_ARGS__, 0 \
439 } \
440 })
441
442 /**
443 * struct hwmon_chip_info - Chip configuration
444 * @ops: Pointer to hwmon operations.
445 * @info: Null-terminated list of channel information.
446 */
447 struct hwmon_chip_info {
448 const struct hwmon_ops *ops;
449 const struct hwmon_channel_info * const *info;
450 };
451
452 /* hwmon_device_register() is deprecated */
453 struct device *hwmon_device_register(struct device *dev);
454
455 /*
456 * hwmon_device_register_with_groups() and
457 * devm_hwmon_device_register_with_groups() are deprecated.
458 */
459 struct device *
460 hwmon_device_register_with_groups(struct device *dev, const char *name,
461 void *drvdata,
462 const struct attribute_group **groups);
463 struct device *
464 devm_hwmon_device_register_with_groups(struct device *dev, const char *name,
465 void *drvdata,
466 const struct attribute_group **groups);
467 struct device *
468 hwmon_device_register_with_info(struct device *dev,
469 const char *name, void *drvdata,
470 const struct hwmon_chip_info *info,
471 const struct attribute_group **extra_groups);
472 struct device *
473 hwmon_device_register_for_thermal(struct device *dev, const char *name,
474 void *drvdata);
475 struct device *
476 devm_hwmon_device_register_with_info(struct device *dev,
477 const char *name, void *drvdata,
478 const struct hwmon_chip_info *info,
479 const struct attribute_group **extra_groups);
480
481 void hwmon_device_unregister(struct device *dev);
482 void devm_hwmon_device_unregister(struct device *dev);
483
484 int hwmon_notify_event(struct device *dev, enum hwmon_sensor_types type,
485 u32 attr, int channel);
486
487 char *hwmon_sanitize_name(const char *name);
488 char *devm_hwmon_sanitize_name(struct device *dev, const char *name);
489
490 /**
491 * hwmon_is_bad_char - Is the char invalid in a hwmon name
492 * @ch: the char to be considered
493 *
494 * hwmon_is_bad_char() can be used to determine if the given character
495 * may not be used in a hwmon name.
496 *
497 * Returns true if the char is invalid, false otherwise.
498 */
hwmon_is_bad_char(const char ch)499 static inline bool hwmon_is_bad_char(const char ch)
500 {
501 switch (ch) {
502 case '-':
503 case '*':
504 case ' ':
505 case '\t':
506 case '\n':
507 return true;
508 default:
509 return false;
510 }
511 }
512
513 #endif
514