Commit | Line | Data |
---|---|---|
b31384fa RW |
1 | /* |
2 | * property.h - Unified device property interface. | |
3 | * | |
4 | * Copyright (C) 2014, Intel Corporation | |
5 | * Authors: Rafael J. Wysocki <rafael.j.wysocki@intel.com> | |
6 | * Mika Westerberg <mika.westerberg@linux.intel.com> | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License version 2 as | |
10 | * published by the Free Software Foundation. | |
11 | */ | |
12 | ||
13 | #ifndef _LINUX_PROPERTY_H_ | |
14 | #define _LINUX_PROPERTY_H_ | |
15 | ||
ce793486 | 16 | #include <linux/fwnode.h> |
b31384fa RW |
17 | #include <linux/types.h> |
18 | ||
19 | struct device; | |
20 | ||
21 | enum dev_prop_type { | |
22 | DEV_PROP_U8, | |
23 | DEV_PROP_U16, | |
24 | DEV_PROP_U32, | |
25 | DEV_PROP_U64, | |
26 | DEV_PROP_STRING, | |
27 | DEV_PROP_MAX, | |
28 | }; | |
29 | ||
1b9863c6 SS |
30 | enum dev_dma_attr { |
31 | DEV_DMA_NOT_SUPPORTED, | |
32 | DEV_DMA_NON_COHERENT, | |
33 | DEV_DMA_COHERENT, | |
34 | }; | |
35 | ||
e44bb0cb SA |
36 | struct fwnode_handle *dev_fwnode(struct device *dev); |
37 | ||
b31384fa RW |
38 | bool device_property_present(struct device *dev, const char *propname); |
39 | int device_property_read_u8_array(struct device *dev, const char *propname, | |
40 | u8 *val, size_t nval); | |
41 | int device_property_read_u16_array(struct device *dev, const char *propname, | |
42 | u16 *val, size_t nval); | |
43 | int device_property_read_u32_array(struct device *dev, const char *propname, | |
44 | u32 *val, size_t nval); | |
45 | int device_property_read_u64_array(struct device *dev, const char *propname, | |
46 | u64 *val, size_t nval); | |
47 | int device_property_read_string_array(struct device *dev, const char *propname, | |
48 | const char **val, size_t nval); | |
49 | int device_property_read_string(struct device *dev, const char *propname, | |
50 | const char **val); | |
3f5c8d31 MW |
51 | int device_property_match_string(struct device *dev, |
52 | const char *propname, const char *string); | |
b31384fa | 53 | |
37ba983c SA |
54 | bool fwnode_device_is_available(const struct fwnode_handle *fwnode); |
55 | bool fwnode_property_present(const struct fwnode_handle *fwnode, | |
56 | const char *propname); | |
57 | int fwnode_property_read_u8_array(const struct fwnode_handle *fwnode, | |
8a0662d9 RW |
58 | const char *propname, u8 *val, |
59 | size_t nval); | |
37ba983c | 60 | int fwnode_property_read_u16_array(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
61 | const char *propname, u16 *val, |
62 | size_t nval); | |
37ba983c | 63 | int fwnode_property_read_u32_array(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
64 | const char *propname, u32 *val, |
65 | size_t nval); | |
37ba983c | 66 | int fwnode_property_read_u64_array(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
67 | const char *propname, u64 *val, |
68 | size_t nval); | |
37ba983c | 69 | int fwnode_property_read_string_array(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
70 | const char *propname, const char **val, |
71 | size_t nval); | |
37ba983c | 72 | int fwnode_property_read_string(const struct fwnode_handle *fwnode, |
8a0662d9 | 73 | const char *propname, const char **val); |
37ba983c | 74 | int fwnode_property_match_string(const struct fwnode_handle *fwnode, |
3f5c8d31 | 75 | const char *propname, const char *string); |
3e3119d3 SA |
76 | int fwnode_property_get_reference_args(const struct fwnode_handle *fwnode, |
77 | const char *prop, const char *nargs_prop, | |
78 | unsigned int nargs, unsigned int index, | |
79 | struct fwnode_reference_args *args); | |
8a0662d9 | 80 | |
37ba983c SA |
81 | struct fwnode_handle *fwnode_get_parent(const struct fwnode_handle *fwnode); |
82 | struct fwnode_handle *fwnode_get_next_parent( | |
83 | struct fwnode_handle *fwnode); | |
84 | struct fwnode_handle *fwnode_get_next_child_node( | |
85 | const struct fwnode_handle *fwnode, struct fwnode_handle *child); | |
34055190 MW |
86 | |
87 | #define fwnode_for_each_child_node(fwnode, child) \ | |
88 | for (child = fwnode_get_next_child_node(fwnode, NULL); child; \ | |
89 | child = fwnode_get_next_child_node(fwnode, child)) | |
afaf26fd | 90 | |
37ba983c SA |
91 | struct fwnode_handle *device_get_next_child_node( |
92 | struct device *dev, struct fwnode_handle *child); | |
8a0662d9 | 93 | |
1d656fb7 AS |
94 | #define device_for_each_child_node(dev, child) \ |
95 | for (child = device_get_next_child_node(dev, NULL); child; \ | |
8a0662d9 RW |
96 | child = device_get_next_child_node(dev, child)) |
97 | ||
37ba983c SA |
98 | struct fwnode_handle *fwnode_get_named_child_node( |
99 | const struct fwnode_handle *fwnode, const char *childname); | |
613e9721 AT |
100 | struct fwnode_handle *device_get_named_child_node(struct device *dev, |
101 | const char *childname); | |
102 | ||
cf89a31c | 103 | struct fwnode_handle *fwnode_handle_get(struct fwnode_handle *fwnode); |
8a0662d9 RW |
104 | void fwnode_handle_put(struct fwnode_handle *fwnode); |
105 | ||
106 | unsigned int device_get_child_node_count(struct device *dev); | |
107 | ||
b31384fa RW |
108 | static inline bool device_property_read_bool(struct device *dev, |
109 | const char *propname) | |
110 | { | |
111 | return device_property_present(dev, propname); | |
112 | } | |
113 | ||
114 | static inline int device_property_read_u8(struct device *dev, | |
115 | const char *propname, u8 *val) | |
116 | { | |
117 | return device_property_read_u8_array(dev, propname, val, 1); | |
118 | } | |
119 | ||
120 | static inline int device_property_read_u16(struct device *dev, | |
121 | const char *propname, u16 *val) | |
122 | { | |
123 | return device_property_read_u16_array(dev, propname, val, 1); | |
124 | } | |
125 | ||
126 | static inline int device_property_read_u32(struct device *dev, | |
127 | const char *propname, u32 *val) | |
128 | { | |
129 | return device_property_read_u32_array(dev, propname, val, 1); | |
130 | } | |
131 | ||
132 | static inline int device_property_read_u64(struct device *dev, | |
133 | const char *propname, u64 *val) | |
134 | { | |
135 | return device_property_read_u64_array(dev, propname, val, 1); | |
136 | } | |
137 | ||
37ba983c | 138 | static inline bool fwnode_property_read_bool(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
139 | const char *propname) |
140 | { | |
141 | return fwnode_property_present(fwnode, propname); | |
142 | } | |
143 | ||
37ba983c | 144 | static inline int fwnode_property_read_u8(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
145 | const char *propname, u8 *val) |
146 | { | |
147 | return fwnode_property_read_u8_array(fwnode, propname, val, 1); | |
148 | } | |
149 | ||
37ba983c | 150 | static inline int fwnode_property_read_u16(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
151 | const char *propname, u16 *val) |
152 | { | |
153 | return fwnode_property_read_u16_array(fwnode, propname, val, 1); | |
154 | } | |
155 | ||
37ba983c | 156 | static inline int fwnode_property_read_u32(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
157 | const char *propname, u32 *val) |
158 | { | |
159 | return fwnode_property_read_u32_array(fwnode, propname, val, 1); | |
160 | } | |
161 | ||
37ba983c | 162 | static inline int fwnode_property_read_u64(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
163 | const char *propname, u64 *val) |
164 | { | |
165 | return fwnode_property_read_u64_array(fwnode, propname, val, 1); | |
166 | } | |
167 | ||
16ba08d5 RW |
168 | /** |
169 | * struct property_entry - "Built-in" device property representation. | |
170 | * @name: Name of the property. | |
318a1971 | 171 | * @length: Length of data making up the value. |
66586bab AS |
172 | * @is_array: True when the property is an array. |
173 | * @is_string: True when property is a string. | |
174 | * @pointer: Pointer to the property (an array of items of the given type). | |
175 | * @value: Value of the property (when it is a single item of the given type). | |
16ba08d5 RW |
176 | */ |
177 | struct property_entry { | |
178 | const char *name; | |
318a1971 | 179 | size_t length; |
66586bab AS |
180 | bool is_array; |
181 | bool is_string; | |
16ba08d5 | 182 | union { |
66586bab | 183 | union { |
9426998c DT |
184 | const void *raw_data; |
185 | const u8 *u8_data; | |
186 | const u16 *u16_data; | |
187 | const u32 *u32_data; | |
188 | const u64 *u64_data; | |
189 | const char * const *str; | |
66586bab AS |
190 | } pointer; |
191 | union { | |
192 | unsigned long long raw_data; | |
193 | u8 u8_data; | |
194 | u16 u16_data; | |
195 | u32 u32_data; | |
196 | u64 u64_data; | |
197 | const char *str; | |
198 | } value; | |
199 | }; | |
16ba08d5 RW |
200 | }; |
201 | ||
d76eebfa AM |
202 | /* |
203 | * Note: the below four initializers for the anonymous union are carefully | |
204 | * crafted to avoid gcc-4.4.4's problems with initialization of anon unions | |
205 | * and structs. | |
206 | */ | |
207 | ||
a85f4204 HK |
208 | #define PROPERTY_ENTRY_INTEGER_ARRAY(_name_, _type_, _val_) \ |
209 | { \ | |
210 | .name = _name_, \ | |
211 | .length = ARRAY_SIZE(_val_) * sizeof(_type_), \ | |
212 | .is_array = true, \ | |
d76eebfa | 213 | .is_string = false, \ |
37aa7271 | 214 | { .pointer = { ._type_##_data = _val_ } }, \ |
a85f4204 HK |
215 | } |
216 | ||
217 | #define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \ | |
218 | PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u8, _val_) | |
219 | #define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \ | |
220 | PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u16, _val_) | |
221 | #define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \ | |
222 | PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u32, _val_) | |
223 | #define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \ | |
224 | PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u64, _val_) | |
225 | ||
226 | #define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \ | |
227 | { \ | |
228 | .name = _name_, \ | |
229 | .length = ARRAY_SIZE(_val_) * sizeof(const char *), \ | |
230 | .is_array = true, \ | |
231 | .is_string = true, \ | |
d76eebfa | 232 | { .pointer = { .str = _val_ } }, \ |
a85f4204 HK |
233 | } |
234 | ||
235 | #define PROPERTY_ENTRY_INTEGER(_name_, _type_, _val_) \ | |
236 | { \ | |
237 | .name = _name_, \ | |
238 | .length = sizeof(_type_), \ | |
d76eebfa AM |
239 | .is_string = false, \ |
240 | { .value = { ._type_##_data = _val_ } }, \ | |
a85f4204 HK |
241 | } |
242 | ||
243 | #define PROPERTY_ENTRY_U8(_name_, _val_) \ | |
244 | PROPERTY_ENTRY_INTEGER(_name_, u8, _val_) | |
245 | #define PROPERTY_ENTRY_U16(_name_, _val_) \ | |
246 | PROPERTY_ENTRY_INTEGER(_name_, u16, _val_) | |
247 | #define PROPERTY_ENTRY_U32(_name_, _val_) \ | |
248 | PROPERTY_ENTRY_INTEGER(_name_, u32, _val_) | |
249 | #define PROPERTY_ENTRY_U64(_name_, _val_) \ | |
250 | PROPERTY_ENTRY_INTEGER(_name_, u64, _val_) | |
251 | ||
252 | #define PROPERTY_ENTRY_STRING(_name_, _val_) \ | |
253 | { \ | |
254 | .name = _name_, \ | |
255 | .length = sizeof(_val_), \ | |
256 | .is_string = true, \ | |
aace7367 | 257 | { .value = { .str = _val_ } }, \ |
a85f4204 HK |
258 | } |
259 | ||
260 | #define PROPERTY_ENTRY_BOOL(_name_) \ | |
261 | { \ | |
262 | .name = _name_, \ | |
263 | } | |
264 | ||
2d479e1f DT |
265 | struct property_entry * |
266 | property_entries_dup(const struct property_entry *properties); | |
267 | ||
268 | void property_entries_free(const struct property_entry *properties); | |
269 | ||
f4d05266 | 270 | int device_add_properties(struct device *dev, |
bec84da8 | 271 | const struct property_entry *properties); |
f4d05266 | 272 | void device_remove_properties(struct device *dev); |
16ba08d5 | 273 | |
e5e55864 SS |
274 | bool device_dma_supported(struct device *dev); |
275 | ||
276 | enum dev_dma_attr device_get_dma_attr(struct device *dev); | |
277 | ||
4c96b7dc JL |
278 | int device_get_phy_mode(struct device *dev); |
279 | ||
280 | void *device_get_mac_address(struct device *dev, char *addr, int alen); | |
281 | ||
07bb80d4 | 282 | struct fwnode_handle *fwnode_graph_get_next_endpoint( |
37ba983c | 283 | const struct fwnode_handle *fwnode, struct fwnode_handle *prev); |
6a71d8d7 | 284 | struct fwnode_handle * |
37ba983c | 285 | fwnode_graph_get_port_parent(const struct fwnode_handle *fwnode); |
07bb80d4 | 286 | struct fwnode_handle *fwnode_graph_get_remote_port_parent( |
37ba983c | 287 | const struct fwnode_handle *fwnode); |
07bb80d4 | 288 | struct fwnode_handle *fwnode_graph_get_remote_port( |
37ba983c | 289 | const struct fwnode_handle *fwnode); |
07bb80d4 | 290 | struct fwnode_handle *fwnode_graph_get_remote_endpoint( |
37ba983c SA |
291 | const struct fwnode_handle *fwnode); |
292 | struct fwnode_handle * | |
293 | fwnode_graph_get_remote_node(const struct fwnode_handle *fwnode, u32 port, | |
294 | u32 endpoint); | |
07bb80d4 | 295 | |
5e4b1b70 SA |
296 | #define fwnode_graph_for_each_endpoint(fwnode, child) \ |
297 | for (child = NULL; \ | |
298 | (child = fwnode_graph_get_next_endpoint(fwnode, child)); ) | |
299 | ||
37ba983c | 300 | int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode, |
2bd5452d SA |
301 | struct fwnode_endpoint *endpoint); |
302 | ||
b31384fa | 303 | #endif /* _LINUX_PROPERTY_H_ */ |