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_LCRIT_ALARM BIT(hwmon_temp_lcrit_alarm)
97 #define HWMON_T_EMERGENCY_ALARM BIT(hwmon_temp_emergency_alarm)
98 #define HWMON_T_FAULT BIT(hwmon_temp_fault)
99 #define HWMON_T_OFFSET BIT(hwmon_temp_offset)
100 #define HWMON_T_LABEL BIT(hwmon_temp_label)
101 #define HWMON_T_LOWEST BIT(hwmon_temp_lowest)
102 #define HWMON_T_HIGHEST BIT(hwmon_temp_highest)
103 #define HWMON_T_RESET_HISTORY BIT(hwmon_temp_reset_history)
104
105 enum hwmon_in_attributes {
106 hwmon_in_input,
107 hwmon_in_min,
108 hwmon_in_max,
109 hwmon_in_lcrit,
110 hwmon_in_crit,
111 hwmon_in_average,
112 hwmon_in_lowest,
113 hwmon_in_highest,
114 hwmon_in_reset_history,
115 hwmon_in_label,
116 hwmon_in_alarm,
117 hwmon_in_min_alarm,
118 hwmon_in_max_alarm,
119 hwmon_in_lcrit_alarm,
120 hwmon_in_crit_alarm,
121 };
122
123 #define HWMON_I_INPUT BIT(hwmon_in_input)
124 #define HWMON_I_MIN BIT(hwmon_in_min)
125 #define HWMON_I_MAX BIT(hwmon_in_max)
126 #define HWMON_I_LCRIT BIT(hwmon_in_lcrit)
127 #define HWMON_I_CRIT BIT(hwmon_in_crit)
128 #define HWMON_I_AVERAGE BIT(hwmon_in_average)
129 #define HWMON_I_LOWEST BIT(hwmon_in_lowest)
130 #define HWMON_I_HIGHEST BIT(hwmon_in_highest)
131 #define HWMON_I_RESET_HISTORY BIT(hwmon_in_reset_history)
132 #define HWMON_I_LABEL BIT(hwmon_in_label)
133 #define HWMON_I_ALARM BIT(hwmon_in_alarm)
134 #define HWMON_I_MIN_ALARM BIT(hwmon_in_min_alarm)
135 #define HWMON_I_MAX_ALARM BIT(hwmon_in_max_alarm)
136 #define HWMON_I_LCRIT_ALARM BIT(hwmon_in_lcrit_alarm)
137 #define HWMON_I_CRIT_ALARM BIT(hwmon_in_crit_alarm)
138
139 enum hwmon_curr_attributes {
140 hwmon_curr_input,
141 hwmon_curr_min,
142 hwmon_curr_max,
143 hwmon_curr_lcrit,
144 hwmon_curr_crit,
145 hwmon_curr_average,
146 hwmon_curr_lowest,
147 hwmon_curr_highest,
148 hwmon_curr_reset_history,
149 hwmon_curr_label,
150 hwmon_curr_alarm,
151 hwmon_curr_min_alarm,
152 hwmon_curr_max_alarm,
153 hwmon_curr_lcrit_alarm,
154 hwmon_curr_crit_alarm,
155 };
156
157 #define HWMON_C_INPUT BIT(hwmon_curr_input)
158 #define HWMON_C_MIN BIT(hwmon_curr_min)
159 #define HWMON_C_MAX BIT(hwmon_curr_max)
160 #define HWMON_C_LCRIT BIT(hwmon_curr_lcrit)
161 #define HWMON_C_CRIT BIT(hwmon_curr_crit)
162 #define HWMON_C_AVERAGE BIT(hwmon_curr_average)
163 #define HWMON_C_LOWEST BIT(hwmon_curr_lowest)
164 #define HWMON_C_HIGHEST BIT(hwmon_curr_highest)
165 #define HWMON_C_RESET_HISTORY BIT(hwmon_curr_reset_history)
166 #define HWMON_C_LABEL BIT(hwmon_curr_label)
167 #define HWMON_C_ALARM BIT(hwmon_curr_alarm)
168 #define HWMON_C_MIN_ALARM BIT(hwmon_curr_min_alarm)
169 #define HWMON_C_MAX_ALARM BIT(hwmon_curr_max_alarm)
170 #define HWMON_C_LCRIT_ALARM BIT(hwmon_curr_lcrit_alarm)
171 #define HWMON_C_CRIT_ALARM BIT(hwmon_curr_crit_alarm)
172
173 enum hwmon_power_attributes {
174 hwmon_power_average,
175 hwmon_power_average_interval,
176 hwmon_power_average_interval_max,
177 hwmon_power_average_interval_min,
178 hwmon_power_average_highest,
179 hwmon_power_average_lowest,
180 hwmon_power_average_max,
181 hwmon_power_average_min,
182 hwmon_power_input,
183 hwmon_power_input_highest,
184 hwmon_power_input_lowest,
185 hwmon_power_reset_history,
186 hwmon_power_accuracy,
187 hwmon_power_cap,
188 hwmon_power_cap_hyst,
189 hwmon_power_cap_max,
190 hwmon_power_cap_min,
191 hwmon_power_min,
192 hwmon_power_max,
193 hwmon_power_crit,
194 hwmon_power_lcrit,
195 hwmon_power_label,
196 hwmon_power_alarm,
197 hwmon_power_cap_alarm,
198 hwmon_power_min_alarm,
199 hwmon_power_max_alarm,
200 hwmon_power_lcrit_alarm,
201 hwmon_power_crit_alarm,
202 };
203
204 #define HWMON_P_AVERAGE BIT(hwmon_power_average)
205 #define HWMON_P_AVERAGE_INTERVAL BIT(hwmon_power_average_interval)
206 #define HWMON_P_AVERAGE_INTERVAL_MAX BIT(hwmon_power_average_interval_max)
207 #define HWMON_P_AVERAGE_INTERVAL_MIN BIT(hwmon_power_average_interval_min)
208 #define HWMON_P_AVERAGE_HIGHEST BIT(hwmon_power_average_highest)
209 #define HWMON_P_AVERAGE_LOWEST BIT(hwmon_power_average_lowest)
210 #define HWMON_P_AVERAGE_MAX BIT(hwmon_power_average_max)
211 #define HWMON_P_AVERAGE_MIN BIT(hwmon_power_average_min)
212 #define HWMON_P_INPUT BIT(hwmon_power_input)
213 #define HWMON_P_INPUT_HIGHEST BIT(hwmon_power_input_highest)
214 #define HWMON_P_INPUT_LOWEST BIT(hwmon_power_input_lowest)
215 #define HWMON_P_RESET_HISTORY BIT(hwmon_power_reset_history)
216 #define HWMON_P_ACCURACY BIT(hwmon_power_accuracy)
217 #define HWMON_P_CAP BIT(hwmon_power_cap)
218 #define HWMON_P_CAP_HYST BIT(hwmon_power_cap_hyst)
219 #define HWMON_P_CAP_MAX BIT(hwmon_power_cap_max)
220 #define HWMON_P_CAP_MIN BIT(hwmon_power_cap_min)
221 #define HWMON_P_MIN BIT(hwmon_power_min)
222 #define HWMON_P_MAX BIT(hwmon_power_max)
223 #define HWMON_P_LCRIT BIT(hwmon_power_lcrit)
224 #define HWMON_P_CRIT BIT(hwmon_power_crit)
225 #define HWMON_P_LABEL BIT(hwmon_power_label)
226 #define HWMON_P_ALARM BIT(hwmon_power_alarm)
227 #define HWMON_P_CAP_ALARM BIT(hwmon_power_cap_alarm)
228 #define HWMON_P_MIN_ALARM BIT(hwmon_power_max_alarm)
229 #define HWMON_P_MAX_ALARM BIT(hwmon_power_max_alarm)
230 #define HWMON_P_LCRIT_ALARM BIT(hwmon_power_lcrit_alarm)
231 #define HWMON_P_CRIT_ALARM BIT(hwmon_power_crit_alarm)
232
233 enum hwmon_energy_attributes {
234 hwmon_energy_input,
235 hwmon_energy_label,
236 };
237
238 #define HWMON_E_INPUT BIT(hwmon_energy_input)
239 #define HWMON_E_LABEL BIT(hwmon_energy_label)
240
241 enum hwmon_humidity_attributes {
242 hwmon_humidity_input,
243 hwmon_humidity_label,
244 hwmon_humidity_min,
245 hwmon_humidity_min_hyst,
246 hwmon_humidity_max,
247 hwmon_humidity_max_hyst,
248 hwmon_humidity_alarm,
249 hwmon_humidity_fault,
250 };
251
252 #define HWMON_H_INPUT BIT(hwmon_humidity_input)
253 #define HWMON_H_LABEL BIT(hwmon_humidity_label)
254 #define HWMON_H_MIN BIT(hwmon_humidity_min)
255 #define HWMON_H_MIN_HYST BIT(hwmon_humidity_min_hyst)
256 #define HWMON_H_MAX BIT(hwmon_humidity_max)
257 #define HWMON_H_MAX_HYST BIT(hwmon_humidity_max_hyst)
258 #define HWMON_H_ALARM BIT(hwmon_humidity_alarm)
259 #define HWMON_H_FAULT BIT(hwmon_humidity_fault)
260
261 enum hwmon_fan_attributes {
262 hwmon_fan_input,
263 hwmon_fan_label,
264 hwmon_fan_min,
265 hwmon_fan_max,
266 hwmon_fan_div,
267 hwmon_fan_pulses,
268 hwmon_fan_target,
269 hwmon_fan_alarm,
270 hwmon_fan_min_alarm,
271 hwmon_fan_max_alarm,
272 hwmon_fan_fault,
273 };
274
275 #define HWMON_F_INPUT BIT(hwmon_fan_input)
276 #define HWMON_F_LABEL BIT(hwmon_fan_label)
277 #define HWMON_F_MIN BIT(hwmon_fan_min)
278 #define HWMON_F_MAX BIT(hwmon_fan_max)
279 #define HWMON_F_DIV BIT(hwmon_fan_div)
280 #define HWMON_F_PULSES BIT(hwmon_fan_pulses)
281 #define HWMON_F_TARGET BIT(hwmon_fan_target)
282 #define HWMON_F_ALARM BIT(hwmon_fan_alarm)
283 #define HWMON_F_MIN_ALARM BIT(hwmon_fan_min_alarm)
284 #define HWMON_F_MAX_ALARM BIT(hwmon_fan_max_alarm)
285 #define HWMON_F_FAULT BIT(hwmon_fan_fault)
286
287 enum hwmon_pwm_attributes {
288 hwmon_pwm_input,
289 hwmon_pwm_enable,
290 hwmon_pwm_mode,
291 hwmon_pwm_freq,
292 };
293
294 #define HWMON_PWM_INPUT BIT(hwmon_pwm_input)
295 #define HWMON_PWM_ENABLE BIT(hwmon_pwm_enable)
296 #define HWMON_PWM_MODE BIT(hwmon_pwm_mode)
297 #define HWMON_PWM_FREQ BIT(hwmon_pwm_freq)
298
299 /**
300 * struct hwmon_ops - hwmon device operations
301 * @is_visible: Callback to return attribute visibility. Mandatory.
302 * Parameters are:
303 * @const void *drvdata:
304 * Pointer to driver-private data structure passed
305 * as argument to hwmon_device_register_with_info().
306 * @type: Sensor type
307 * @attr: Sensor attribute
308 * @channel:
309 * Channel number
310 * The function returns the file permissions.
311 * If the return value is 0, no attribute will be created.
312 * @read: Read callback for data attributes. Mandatory if readable
313 * data attributes are present.
314 * Parameters are:
315 * @dev: Pointer to hardware monitoring device
316 * @type: Sensor type
317 * @attr: Sensor attribute
318 * @channel:
319 * Channel number
320 * @val: Pointer to returned value
321 * The function returns 0 on success or a negative error number.
322 * @read_string:
323 * Read callback for string attributes. Mandatory if string
324 * attributes are present.
325 * Parameters are:
326 * @dev: Pointer to hardware monitoring device
327 * @type: Sensor type
328 * @attr: Sensor attribute
329 * @channel:
330 * Channel number
331 * @str: Pointer to returned string
332 * The function returns 0 on success or a negative error number.
333 * @write: Write callback for data attributes. Mandatory if writeable
334 * data attributes are present.
335 * Parameters are:
336 * @dev: Pointer to hardware monitoring device
337 * @type: Sensor type
338 * @attr: Sensor attribute
339 * @channel:
340 * Channel number
341 * @val: Value to write
342 * The function returns 0 on success or a negative error number.
343 */
344 struct hwmon_ops {
345 umode_t (*is_visible)(const void *drvdata, enum hwmon_sensor_types type,
346 u32 attr, int channel);
347 int (*read)(struct device *dev, enum hwmon_sensor_types type,
348 u32 attr, int channel, long *val);
349 int (*read_string)(struct device *dev, enum hwmon_sensor_types type,
350 u32 attr, int channel, const char **str);
351 int (*write)(struct device *dev, enum hwmon_sensor_types type,
352 u32 attr, int channel, long val);
353 };
354
355 /**
356 * Channel information
357 * @type: Channel type.
358 * @config: Pointer to NULL-terminated list of channel parameters.
359 * Use for per-channel attributes.
360 */
361 struct hwmon_channel_info {
362 enum hwmon_sensor_types type;
363 const u32 *config;
364 };
365
366 /**
367 * Chip configuration
368 * @ops: Pointer to hwmon operations.
369 * @info: Null-terminated list of channel information.
370 */
371 struct hwmon_chip_info {
372 const struct hwmon_ops *ops;
373 const struct hwmon_channel_info **info;
374 };
375
376 /* hwmon_device_register() is deprecated */
377 struct device *hwmon_device_register(struct device *dev);
378
379 struct device *
380 hwmon_device_register_with_groups(struct device *dev, const char *name,
381 void *drvdata,
382 const struct attribute_group **groups);
383 struct device *
384 devm_hwmon_device_register_with_groups(struct device *dev, const char *name,
385 void *drvdata,
386 const struct attribute_group **groups);
387 struct device *
388 hwmon_device_register_with_info(struct device *dev,
389 const char *name, void *drvdata,
390 const struct hwmon_chip_info *info,
391 const struct attribute_group **extra_groups);
392 struct device *
393 devm_hwmon_device_register_with_info(struct device *dev,
394 const char *name, void *drvdata,
395 const struct hwmon_chip_info *info,
396 const struct attribute_group **extra_groups);
397
398 void hwmon_device_unregister(struct device *dev);
399 void devm_hwmon_device_unregister(struct device *dev);
400
401 /**
402 * hwmon_is_bad_char - Is the char invalid in a hwmon name
403 * @ch: the char to be considered
404 *
405 * hwmon_is_bad_char() can be used to determine if the given character
406 * may not be used in a hwmon name.
407 *
408 * Returns true if the char is invalid, false otherwise.
409 */
hwmon_is_bad_char(const char ch)410 static inline bool hwmon_is_bad_char(const char ch)
411 {
412 switch (ch) {
413 case '-':
414 case '*':
415 case ' ':
416 case '\t':
417 case '\n':
418 return true;
419 default:
420 return false;
421 }
422 }
423
424 #endif
425
