1 /* The industrial I/O core
2  *
3  *Copyright (c) 2008 Jonathan Cameron
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 as published by
7  * the Free Software Foundation.
8  *
9  * General attributes
10  */
11 
12 #ifndef _INDUSTRIAL_IO_SYSFS_H_
13 #define _INDUSTRIAL_IO_SYSFS_H_
14 
15 struct iio_chan_spec;
16 
17 /**
18  * struct iio_dev_attr - iio specific device attribute
19  * @dev_attr:	underlying device attribute
20  * @address:	associated register address
21  * @l:		list head for maintaining list of dynamically created attrs
22  * @c:		specification for the underlying channel
23  */
24 struct iio_dev_attr {
25 	struct device_attribute dev_attr;
26 	u64 address;
27 	struct list_head l;
28 	struct iio_chan_spec const *c;
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 /* Generic attributes of onetype or another */
101 
102 /**
103  * IIO_DEV_ATTR_SAMP_FREQ - sets any internal clock frequency
104  * @_mode: sysfs file mode/permissions
105  * @_show: output method for the attribute
106  * @_store: input method for the attribute
107  **/
108 #define IIO_DEV_ATTR_SAMP_FREQ(_mode, _show, _store)			\
109 	IIO_DEVICE_ATTR(sampling_frequency, _mode, _show, _store, 0)
110 
111 /**
112  * IIO_DEV_ATTR_SAMP_FREQ_AVAIL - list available sampling frequencies
113  * @_show: output method for the attribute
114  *
115  * May be mode dependent on some devices
116  **/
117 #define IIO_DEV_ATTR_SAMP_FREQ_AVAIL(_show)				\
118 	IIO_DEVICE_ATTR(sampling_frequency_available, S_IRUGO, _show, NULL, 0)
119 /**
120  * IIO_CONST_ATTR_SAMP_FREQ_AVAIL - list available sampling frequencies
121  * @_string: frequency string for the attribute
122  *
123  * Constant version
124  **/
125 #define IIO_CONST_ATTR_SAMP_FREQ_AVAIL(_string)			\
126 	IIO_CONST_ATTR(sampling_frequency_available, _string)
127 
128 /**
129  * IIO_DEV_ATTR_INT_TIME_AVAIL - list available integration times
130  * @_show: output method for the attribute
131  **/
132 #define IIO_DEV_ATTR_INT_TIME_AVAIL(_show)		\
133 	IIO_DEVICE_ATTR(integration_time_available, S_IRUGO, _show, NULL, 0)
134 /**
135  * IIO_CONST_ATTR_INT_TIME_AVAIL - list available integration times
136  * @_string: frequency string for the attribute
137  *
138  * Constant version
139  **/
140 #define IIO_CONST_ATTR_INT_TIME_AVAIL(_string)		\
141 	IIO_CONST_ATTR(integration_time_available, _string)
142 
143 #define IIO_DEV_ATTR_TEMP_RAW(_show)			\
144 	IIO_DEVICE_ATTR(in_temp_raw, S_IRUGO, _show, NULL, 0)
145 
146 #define IIO_CONST_ATTR_TEMP_OFFSET(_string)		\
147 	IIO_CONST_ATTR(in_temp_offset, _string)
148 
149 #define IIO_CONST_ATTR_TEMP_SCALE(_string)		\
150 	IIO_CONST_ATTR(in_temp_scale, _string)
151 
152 #endif /* _INDUSTRIAL_IO_SYSFS_H_ */
153