xref: /openbmc/linux/include/linux/iio/sysfs.h (revision 2cc64a23)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /* The industrial I/O core
3  *
4  *Copyright (c) 2008 Jonathan Cameron
5  *
6  * General attributes
7  */
8 
9 #ifndef _INDUSTRIAL_IO_SYSFS_H_
10 #define _INDUSTRIAL_IO_SYSFS_H_
11 
12 struct iio_buffer;
13 struct iio_chan_spec;
14 
15 /**
16  * struct iio_dev_attr - iio specific device attribute
17  * @dev_attr:	underlying device attribute
18  * @address:	associated register address
19  * @l:		list head for maintaining list of dynamically created attrs
20  * @c:		specification for the underlying channel
21  * @buffer:	the IIO buffer to which this attribute belongs to (if any)
22  */
23 struct iio_dev_attr {
24 	struct device_attribute dev_attr;
25 	u64 address;
26 	struct list_head l;
27 	struct iio_chan_spec const *c;
28 	struct iio_buffer *buffer;
29 };
30 
31 #define to_iio_dev_attr(_dev_attr)				\
32 	container_of(_dev_attr, struct iio_dev_attr, dev_attr)
33 
34 ssize_t iio_read_const_attr(struct device *dev,
35 			    struct device_attribute *attr,
36 			    char *len);
37 
38 /**
39  * struct iio_const_attr - constant device specific attribute
40  *                         often used for things like available modes
41  * @string:	attribute string
42  * @dev_attr:	underlying device attribute
43  */
44 struct iio_const_attr {
45 	const char *string;
46 	struct device_attribute dev_attr;
47 };
48 
49 #define to_iio_const_attr(_dev_attr) \
50 	container_of(_dev_attr, struct iio_const_attr, dev_attr)
51 
52 /* Some attributes will be hard coded (device dependent) and not require an
53    address, in these cases pass a negative */
54 #define IIO_ATTR(_name, _mode, _show, _store, _addr)		\
55 	{ .dev_attr = __ATTR(_name, _mode, _show, _store),	\
56 	  .address = _addr }
57 
58 #define IIO_ATTR_RO(_name, _addr)       \
59 	{ .dev_attr = __ATTR_RO(_name), \
60 	  .address = _addr }
61 
62 #define IIO_ATTR_WO(_name, _addr)       \
63 	{ .dev_attr = __ATTR_WO(_name), \
64 	  .address = _addr }
65 
66 #define IIO_ATTR_RW(_name, _addr)       \
67 	{ .dev_attr = __ATTR_RW(_name), \
68 	  .address = _addr }
69 
70 #define IIO_DEVICE_ATTR(_name, _mode, _show, _store, _addr)	\
71 	struct iio_dev_attr iio_dev_attr_##_name		\
72 	= IIO_ATTR(_name, _mode, _show, _store, _addr)
73 
74 #define IIO_DEVICE_ATTR_RO(_name, _addr)                       \
75 	struct iio_dev_attr iio_dev_attr_##_name                \
76 	= IIO_ATTR_RO(_name, _addr)
77 
78 #define IIO_DEVICE_ATTR_WO(_name, _addr)                       \
79 	struct iio_dev_attr iio_dev_attr_##_name                \
80 	= IIO_ATTR_WO(_name, _addr)
81 
82 #define IIO_DEVICE_ATTR_RW(_name, _addr)                                   \
83 	struct iio_dev_attr iio_dev_attr_##_name                            \
84 	= IIO_ATTR_RW(_name, _addr)
85 
86 #define IIO_DEVICE_ATTR_NAMED(_vname, _name, _mode, _show, _store, _addr) \
87 	struct iio_dev_attr iio_dev_attr_##_vname			\
88 	= IIO_ATTR(_name, _mode, _show, _store, _addr)
89 
90 #define IIO_CONST_ATTR(_name, _string)					\
91 	struct iio_const_attr iio_const_attr_##_name			\
92 	= { .string = _string,						\
93 	    .dev_attr = __ATTR(_name, S_IRUGO, iio_read_const_attr, NULL)}
94 
95 #define IIO_CONST_ATTR_NAMED(_vname, _name, _string)			\
96 	struct iio_const_attr iio_const_attr_##_vname			\
97 	= { .string = _string,						\
98 	    .dev_attr = __ATTR(_name, S_IRUGO, iio_read_const_attr, NULL)}
99 
100 #define IIO_STATIC_CONST_DEVICE_ATTR(_name, _string)				\
101 	static ssize_t iio_const_dev_attr_show_##_name(			\
102 					struct device *dev,		\
103 					struct device_attribute *attr,	\
104 					char *buf)			\
105 	{								\
106 		return sysfs_emit(buf, "%s\n", _string);		\
107 	}								\
108 	static IIO_DEVICE_ATTR(_name, 0444,				\
109 			       iio_const_dev_attr_show_##_name, NULL, 0)
110 
111 /* Generic attributes of onetype or another */
112 
113 /**
114  * IIO_DEV_ATTR_SAMP_FREQ - sets any internal clock frequency
115  * @_mode: sysfs file mode/permissions
116  * @_show: output method for the attribute
117  * @_store: input method for the attribute
118  **/
119 #define IIO_DEV_ATTR_SAMP_FREQ(_mode, _show, _store)			\
120 	IIO_DEVICE_ATTR(sampling_frequency, _mode, _show, _store, 0)
121 
122 /**
123  * IIO_DEV_ATTR_SAMP_FREQ_AVAIL - list available sampling frequencies
124  * @_show: output method for the attribute
125  *
126  * May be mode dependent on some devices
127  **/
128 #define IIO_DEV_ATTR_SAMP_FREQ_AVAIL(_show)				\
129 	IIO_DEVICE_ATTR(sampling_frequency_available, S_IRUGO, _show, NULL, 0)
130 /**
131  * IIO_CONST_ATTR_SAMP_FREQ_AVAIL - list available sampling frequencies
132  * @_string: frequency string for the attribute
133  *
134  * Constant version
135  **/
136 #define IIO_CONST_ATTR_SAMP_FREQ_AVAIL(_string)			\
137 	IIO_CONST_ATTR(sampling_frequency_available, _string)
138 
139 /**
140  * IIO_DEV_ATTR_INT_TIME_AVAIL - list available integration times
141  * @_show: output method for the attribute
142  **/
143 #define IIO_DEV_ATTR_INT_TIME_AVAIL(_show)		\
144 	IIO_DEVICE_ATTR(integration_time_available, S_IRUGO, _show, NULL, 0)
145 /**
146  * IIO_CONST_ATTR_INT_TIME_AVAIL - list available integration times
147  * @_string: frequency string for the attribute
148  *
149  * Constant version
150  **/
151 #define IIO_CONST_ATTR_INT_TIME_AVAIL(_string)		\
152 	IIO_CONST_ATTR(integration_time_available, _string)
153 
154 #define IIO_DEV_ATTR_TEMP_RAW(_show)			\
155 	IIO_DEVICE_ATTR(in_temp_raw, S_IRUGO, _show, NULL, 0)
156 
157 #define IIO_CONST_ATTR_TEMP_OFFSET(_string)		\
158 	IIO_CONST_ATTR(in_temp_offset, _string)
159 
160 #define IIO_CONST_ATTR_TEMP_SCALE(_string)		\
161 	IIO_CONST_ATTR(in_temp_scale, _string)
162 
163 #endif /* _INDUSTRIAL_IO_SYSFS_H_ */
164