[linux-block.git] / include / linux / hwmon.h

/*
    hwmon.h - part of lm_sensors, Linux kernel modules for hardware monitoring

    This file declares helper functions for the sysfs class "hwmon",
    for use by sensors drivers.

    Copyright (C) 2005 Mark M. Hoffman <mhoffman@lightlink.com>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; version 2 of the License.
*/

#ifndef _HWMON_H_
#define _HWMON_H_

#include <linux/bitops.h>

struct device;
struct attribute_group;

enum hwmon_sensor_types {
	hwmon_chip,
	hwmon_temp,
	hwmon_in,
	hwmon_curr,
	hwmon_power,
	hwmon_energy,
	hwmon_humidity,
	hwmon_fan,
	hwmon_pwm,
	hwmon_max,
};

enum hwmon_chip_attributes {
	hwmon_chip_temp_reset_history,
	hwmon_chip_in_reset_history,
	hwmon_chip_curr_reset_history,
	hwmon_chip_power_reset_history,
	hwmon_chip_register_tz,
	hwmon_chip_update_interval,
	hwmon_chip_alarms,
};

#define HWMON_C_TEMP_RESET_HISTORY	BIT(hwmon_chip_temp_reset_history)
#define HWMON_C_IN_RESET_HISTORY	BIT(hwmon_chip_in_reset_history)
#define HWMON_C_CURR_RESET_HISTORY	BIT(hwmon_chip_curr_reset_history)
#define HWMON_C_POWER_RESET_HISTORY	BIT(hwmon_chip_power_reset_history)
#define HWMON_C_REGISTER_TZ		BIT(hwmon_chip_register_tz)
#define HWMON_C_UPDATE_INTERVAL		BIT(hwmon_chip_update_interval)
#define HWMON_C_ALARMS			BIT(hwmon_chip_alarms)

enum hwmon_temp_attributes {
	hwmon_temp_input = 0,
	hwmon_temp_type,
	hwmon_temp_lcrit,
	hwmon_temp_lcrit_hyst,
	hwmon_temp_min,
	hwmon_temp_min_hyst,
	hwmon_temp_max,
	hwmon_temp_max_hyst,
	hwmon_temp_crit,
	hwmon_temp_crit_hyst,
	hwmon_temp_emergency,
	hwmon_temp_emergency_hyst,
	hwmon_temp_alarm,
	hwmon_temp_lcrit_alarm,
	hwmon_temp_min_alarm,
	hwmon_temp_max_alarm,
	hwmon_temp_crit_alarm,
	hwmon_temp_emergency_alarm,
	hwmon_temp_fault,
	hwmon_temp_offset,
	hwmon_temp_label,
	hwmon_temp_lowest,
	hwmon_temp_highest,
	hwmon_temp_reset_history,
};

#define HWMON_T_INPUT		BIT(hwmon_temp_input)
#define HWMON_T_TYPE		BIT(hwmon_temp_type)
#define HWMON_T_LCRIT		BIT(hwmon_temp_lcrit)
#define HWMON_T_LCRIT_HYST	BIT(hwmon_temp_lcrit_hyst)
#define HWMON_T_MIN		BIT(hwmon_temp_min)
#define HWMON_T_MIN_HYST	BIT(hwmon_temp_min_hyst)
#define HWMON_T_MAX		BIT(hwmon_temp_max)
#define HWMON_T_MAX_HYST	BIT(hwmon_temp_max_hyst)
#define HWMON_T_CRIT		BIT(hwmon_temp_crit)
#define HWMON_T_CRIT_HYST	BIT(hwmon_temp_crit_hyst)
#define HWMON_T_EMERGENCY	BIT(hwmon_temp_emergency)
#define HWMON_T_EMERGENCY_HYST	BIT(hwmon_temp_emergency_hyst)
#define HWMON_T_ALARM		BIT(hwmon_temp_alarm)
#define HWMON_T_MIN_ALARM	BIT(hwmon_temp_min_alarm)
#define HWMON_T_MAX_ALARM	BIT(hwmon_temp_max_alarm)
#define HWMON_T_CRIT_ALARM	BIT(hwmon_temp_crit_alarm)
#define HWMON_T_LCRIT_ALARM	BIT(hwmon_temp_lcrit_alarm)
#define HWMON_T_EMERGENCY_ALARM	BIT(hwmon_temp_emergency_alarm)
#define HWMON_T_FAULT		BIT(hwmon_temp_fault)
#define HWMON_T_OFFSET		BIT(hwmon_temp_offset)
#define HWMON_T_LABEL		BIT(hwmon_temp_label)
#define HWMON_T_LOWEST		BIT(hwmon_temp_lowest)
#define HWMON_T_HIGHEST		BIT(hwmon_temp_highest)
#define HWMON_T_RESET_HISTORY	BIT(hwmon_temp_reset_history)

enum hwmon_in_attributes {
	hwmon_in_input,
	hwmon_in_min,
	hwmon_in_max,
	hwmon_in_lcrit,
	hwmon_in_crit,
	hwmon_in_average,
	hwmon_in_lowest,
	hwmon_in_highest,
	hwmon_in_reset_history,
	hwmon_in_label,
	hwmon_in_alarm,
	hwmon_in_min_alarm,
	hwmon_in_max_alarm,
	hwmon_in_lcrit_alarm,
	hwmon_in_crit_alarm,
	hwmon_in_enable,
};

#define HWMON_I_INPUT		BIT(hwmon_in_input)
#define HWMON_I_MIN		BIT(hwmon_in_min)
#define HWMON_I_MAX		BIT(hwmon_in_max)
#define HWMON_I_LCRIT		BIT(hwmon_in_lcrit)
#define HWMON_I_CRIT		BIT(hwmon_in_crit)
#define HWMON_I_AVERAGE		BIT(hwmon_in_average)
#define HWMON_I_LOWEST		BIT(hwmon_in_lowest)
#define HWMON_I_HIGHEST		BIT(hwmon_in_highest)
#define HWMON_I_RESET_HISTORY	BIT(hwmon_in_reset_history)
#define HWMON_I_LABEL		BIT(hwmon_in_label)
#define HWMON_I_ALARM		BIT(hwmon_in_alarm)
#define HWMON_I_MIN_ALARM	BIT(hwmon_in_min_alarm)
#define HWMON_I_MAX_ALARM	BIT(hwmon_in_max_alarm)
#define HWMON_I_LCRIT_ALARM	BIT(hwmon_in_lcrit_alarm)
#define HWMON_I_CRIT_ALARM	BIT(hwmon_in_crit_alarm)
#define HWMON_I_ENABLE		BIT(hwmon_in_enable)

enum hwmon_curr_attributes {
	hwmon_curr_input,
	hwmon_curr_min,
	hwmon_curr_max,
	hwmon_curr_lcrit,
	hwmon_curr_crit,
	hwmon_curr_average,
	hwmon_curr_lowest,
	hwmon_curr_highest,
	hwmon_curr_reset_history,
	hwmon_curr_label,
	hwmon_curr_alarm,
	hwmon_curr_min_alarm,
	hwmon_curr_max_alarm,
	hwmon_curr_lcrit_alarm,
	hwmon_curr_crit_alarm,
};

#define HWMON_C_INPUT		BIT(hwmon_curr_input)
#define HWMON_C_MIN		BIT(hwmon_curr_min)
#define HWMON_C_MAX		BIT(hwmon_curr_max)
#define HWMON_C_LCRIT		BIT(hwmon_curr_lcrit)
#define HWMON_C_CRIT		BIT(hwmon_curr_crit)
#define HWMON_C_AVERAGE		BIT(hwmon_curr_average)
#define HWMON_C_LOWEST		BIT(hwmon_curr_lowest)
#define HWMON_C_HIGHEST		BIT(hwmon_curr_highest)
#define HWMON_C_RESET_HISTORY	BIT(hwmon_curr_reset_history)
#define HWMON_C_LABEL		BIT(hwmon_curr_label)
#define HWMON_C_ALARM		BIT(hwmon_curr_alarm)
#define HWMON_C_MIN_ALARM	BIT(hwmon_curr_min_alarm)
#define HWMON_C_MAX_ALARM	BIT(hwmon_curr_max_alarm)
#define HWMON_C_LCRIT_ALARM	BIT(hwmon_curr_lcrit_alarm)
#define HWMON_C_CRIT_ALARM	BIT(hwmon_curr_crit_alarm)

enum hwmon_power_attributes {
	hwmon_power_average,
	hwmon_power_average_interval,
	hwmon_power_average_interval_max,
	hwmon_power_average_interval_min,
	hwmon_power_average_highest,
	hwmon_power_average_lowest,
	hwmon_power_average_max,
	hwmon_power_average_min,
	hwmon_power_input,
	hwmon_power_input_highest,
	hwmon_power_input_lowest,
	hwmon_power_reset_history,
	hwmon_power_accuracy,
	hwmon_power_cap,
	hwmon_power_cap_hyst,
	hwmon_power_cap_max,
	hwmon_power_cap_min,
	hwmon_power_min,
	hwmon_power_max,
	hwmon_power_crit,
	hwmon_power_lcrit,
	hwmon_power_label,
	hwmon_power_alarm,
	hwmon_power_cap_alarm,
	hwmon_power_min_alarm,
	hwmon_power_max_alarm,
	hwmon_power_lcrit_alarm,
	hwmon_power_crit_alarm,
};

#define HWMON_P_AVERAGE			BIT(hwmon_power_average)
#define HWMON_P_AVERAGE_INTERVAL	BIT(hwmon_power_average_interval)
#define HWMON_P_AVERAGE_INTERVAL_MAX	BIT(hwmon_power_average_interval_max)
#define HWMON_P_AVERAGE_INTERVAL_MIN	BIT(hwmon_power_average_interval_min)
#define HWMON_P_AVERAGE_HIGHEST		BIT(hwmon_power_average_highest)
#define HWMON_P_AVERAGE_LOWEST		BIT(hwmon_power_average_lowest)
#define HWMON_P_AVERAGE_MAX		BIT(hwmon_power_average_max)
#define HWMON_P_AVERAGE_MIN		BIT(hwmon_power_average_min)
#define HWMON_P_INPUT			BIT(hwmon_power_input)
#define HWMON_P_INPUT_HIGHEST		BIT(hwmon_power_input_highest)
#define HWMON_P_INPUT_LOWEST		BIT(hwmon_power_input_lowest)
#define HWMON_P_RESET_HISTORY		BIT(hwmon_power_reset_history)
#define HWMON_P_ACCURACY		BIT(hwmon_power_accuracy)
#define HWMON_P_CAP			BIT(hwmon_power_cap)
#define HWMON_P_CAP_HYST		BIT(hwmon_power_cap_hyst)
#define HWMON_P_CAP_MAX			BIT(hwmon_power_cap_max)
#define HWMON_P_CAP_MIN			BIT(hwmon_power_cap_min)
#define HWMON_P_MIN			BIT(hwmon_power_min)
#define HWMON_P_MAX			BIT(hwmon_power_max)
#define HWMON_P_LCRIT			BIT(hwmon_power_lcrit)
#define HWMON_P_CRIT			BIT(hwmon_power_crit)
#define HWMON_P_LABEL			BIT(hwmon_power_label)
#define HWMON_P_ALARM			BIT(hwmon_power_alarm)
#define HWMON_P_CAP_ALARM		BIT(hwmon_power_cap_alarm)
#define HWMON_P_MIN_ALARM		BIT(hwmon_power_max_alarm)
#define HWMON_P_MAX_ALARM		BIT(hwmon_power_max_alarm)
#define HWMON_P_LCRIT_ALARM		BIT(hwmon_power_lcrit_alarm)
#define HWMON_P_CRIT_ALARM		BIT(hwmon_power_crit_alarm)

enum hwmon_energy_attributes {
	hwmon_energy_input,
	hwmon_energy_label,
};

#define HWMON_E_INPUT			BIT(hwmon_energy_input)
#define HWMON_E_LABEL			BIT(hwmon_energy_label)

enum hwmon_humidity_attributes {
	hwmon_humidity_input,
	hwmon_humidity_label,
	hwmon_humidity_min,
	hwmon_humidity_min_hyst,
	hwmon_humidity_max,
	hwmon_humidity_max_hyst,
	hwmon_humidity_alarm,
	hwmon_humidity_fault,
};

#define HWMON_H_INPUT			BIT(hwmon_humidity_input)
#define HWMON_H_LABEL			BIT(hwmon_humidity_label)
#define HWMON_H_MIN			BIT(hwmon_humidity_min)
#define HWMON_H_MIN_HYST		BIT(hwmon_humidity_min_hyst)
#define HWMON_H_MAX			BIT(hwmon_humidity_max)
#define HWMON_H_MAX_HYST		BIT(hwmon_humidity_max_hyst)
#define HWMON_H_ALARM			BIT(hwmon_humidity_alarm)
#define HWMON_H_FAULT			BIT(hwmon_humidity_fault)

enum hwmon_fan_attributes {
	hwmon_fan_input,
	hwmon_fan_label,
	hwmon_fan_min,
	hwmon_fan_max,
	hwmon_fan_div,
	hwmon_fan_pulses,
	hwmon_fan_target,
	hwmon_fan_alarm,
	hwmon_fan_min_alarm,
	hwmon_fan_max_alarm,
	hwmon_fan_fault,
};

#define HWMON_F_INPUT			BIT(hwmon_fan_input)
#define HWMON_F_LABEL			BIT(hwmon_fan_label)
#define HWMON_F_MIN			BIT(hwmon_fan_min)
#define HWMON_F_MAX			BIT(hwmon_fan_max)
#define HWMON_F_DIV			BIT(hwmon_fan_div)
#define HWMON_F_PULSES			BIT(hwmon_fan_pulses)
#define HWMON_F_TARGET			BIT(hwmon_fan_target)
#define HWMON_F_ALARM			BIT(hwmon_fan_alarm)
#define HWMON_F_MIN_ALARM		BIT(hwmon_fan_min_alarm)
#define HWMON_F_MAX_ALARM		BIT(hwmon_fan_max_alarm)
#define HWMON_F_FAULT			BIT(hwmon_fan_fault)

enum hwmon_pwm_attributes {
	hwmon_pwm_input,
	hwmon_pwm_enable,
	hwmon_pwm_mode,
	hwmon_pwm_freq,
};

#define HWMON_PWM_INPUT			BIT(hwmon_pwm_input)
#define HWMON_PWM_ENABLE		BIT(hwmon_pwm_enable)
#define HWMON_PWM_MODE			BIT(hwmon_pwm_mode)
#define HWMON_PWM_FREQ			BIT(hwmon_pwm_freq)

/**
 * struct hwmon_ops - hwmon device operations
 * @is_visible: Callback to return attribute visibility. Mandatory.
 *		Parameters are:
 *		@const void *drvdata:
 *			Pointer to driver-private data structure passed
 *			as argument to hwmon_device_register_with_info().
 *		@type:	Sensor type
 *		@attr:	Sensor attribute
 *		@channel:
 *			Channel number
 *		The function returns the file permissions.
 *		If the return value is 0, no attribute will be created.
 * @read:	Read callback for data attributes. Mandatory if readable
 *		data attributes are present.
 *		Parameters are:
 *		@dev:	Pointer to hardware monitoring device
 *		@type:	Sensor type
 *		@attr:	Sensor attribute
 *		@channel:
 *			Channel number
 *		@val:	Pointer to returned value
 *		The function returns 0 on success or a negative error number.
 * @read_string:
 *		Read callback for string attributes. Mandatory if string
 *		attributes are present.
 *		Parameters are:
 *		@dev:	Pointer to hardware monitoring device
 *		@type:	Sensor type
 *		@attr:	Sensor attribute
 *		@channel:
 *			Channel number
 *		@str:	Pointer to returned string
 *		The function returns 0 on success or a negative error number.
 * @write:	Write callback for data attributes. Mandatory if writeable
 *		data attributes are present.
 *		Parameters are:
 *		@dev:	Pointer to hardware monitoring device
 *		@type:	Sensor type
 *		@attr:	Sensor attribute
 *		@channel:
 *			Channel number
 *		@val:	Value to write
 *		The function returns 0 on success or a negative error number.
 */
struct hwmon_ops {
	umode_t (*is_visible)(const void *drvdata, enum hwmon_sensor_types type,
			      u32 attr, int channel);
	int (*read)(struct device *dev, enum hwmon_sensor_types type,
		    u32 attr, int channel, long *val);
	int (*read_string)(struct device *dev, enum hwmon_sensor_types type,
		    u32 attr, int channel, const char **str);
	int (*write)(struct device *dev, enum hwmon_sensor_types type,
		     u32 attr, int channel, long val);
};

/**
 * Channel information
 * @type:	Channel type.
 * @config:	Pointer to NULL-terminated list of channel parameters.
 *		Use for per-channel attributes.
 */
struct hwmon_channel_info {
	enum hwmon_sensor_types type;
	const u32 *config;
};

/**
 * Chip configuration
 * @ops:	Pointer to hwmon operations.
 * @info:	Null-terminated list of channel information.
 */
struct hwmon_chip_info {
	const struct hwmon_ops *ops;
	const struct hwmon_channel_info **info;
};

/* hwmon_device_register() is deprecated */
struct device *hwmon_device_register(struct device *dev);

struct device *
hwmon_device_register_with_groups(struct device *dev, const char *name,
				  void *drvdata,
				  const struct attribute_group **groups);
struct device *
devm_hwmon_device_register_with_groups(struct device *dev, const char *name,
				       void *drvdata,
				       const struct attribute_group **groups);
struct device *
hwmon_device_register_with_info(struct device *dev,
				const char *name, void *drvdata,
				const struct hwmon_chip_info *info,
				const struct attribute_group **extra_groups);
struct device *
devm_hwmon_device_register_with_info(struct device *dev,
				const char *name, void *drvdata,
				const struct hwmon_chip_info *info,
				const struct attribute_group **extra_groups);

void hwmon_device_unregister(struct device *dev);
void devm_hwmon_device_unregister(struct device *dev);

/**
 * hwmon_is_bad_char - Is the char invalid in a hwmon name
 * @ch: the char to be considered
 *
 * hwmon_is_bad_char() can be used to determine if the given character
 * may not be used in a hwmon name.
 *
 * Returns true if the char is invalid, false otherwise.
 */
static inline bool hwmon_is_bad_char(const char ch)
{
	switch (ch) {
	case '-':
	case '*':
	case ' ':
	case '\t':
	case '\n':
		return true;
	default:
		return false;
	}
}

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