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 | ||
0fcc2bdc | 16 | #include <linux/bits.h> |
ce793486 | 17 | #include <linux/fwnode.h> |
b31384fa RW |
18 | #include <linux/types.h> |
19 | ||
20 | struct device; | |
21 | ||
22 | enum dev_prop_type { | |
23 | DEV_PROP_U8, | |
24 | DEV_PROP_U16, | |
25 | DEV_PROP_U32, | |
26 | DEV_PROP_U64, | |
27 | DEV_PROP_STRING, | |
28 | DEV_PROP_MAX, | |
29 | }; | |
30 | ||
1b9863c6 SS |
31 | enum dev_dma_attr { |
32 | DEV_DMA_NOT_SUPPORTED, | |
33 | DEV_DMA_NON_COHERENT, | |
34 | DEV_DMA_COHERENT, | |
35 | }; | |
36 | ||
e44bb0cb SA |
37 | struct fwnode_handle *dev_fwnode(struct device *dev); |
38 | ||
b31384fa RW |
39 | bool device_property_present(struct device *dev, const char *propname); |
40 | int device_property_read_u8_array(struct device *dev, const char *propname, | |
41 | u8 *val, size_t nval); | |
42 | int device_property_read_u16_array(struct device *dev, const char *propname, | |
43 | u16 *val, size_t nval); | |
44 | int device_property_read_u32_array(struct device *dev, const char *propname, | |
45 | u32 *val, size_t nval); | |
46 | int device_property_read_u64_array(struct device *dev, const char *propname, | |
47 | u64 *val, size_t nval); | |
48 | int device_property_read_string_array(struct device *dev, const char *propname, | |
49 | const char **val, size_t nval); | |
50 | int device_property_read_string(struct device *dev, const char *propname, | |
51 | const char **val); | |
3f5c8d31 MW |
52 | int device_property_match_string(struct device *dev, |
53 | const char *propname, const char *string); | |
b31384fa | 54 | |
37ba983c SA |
55 | bool fwnode_device_is_available(const struct fwnode_handle *fwnode); |
56 | bool fwnode_property_present(const struct fwnode_handle *fwnode, | |
57 | const char *propname); | |
58 | int fwnode_property_read_u8_array(const struct fwnode_handle *fwnode, | |
8a0662d9 RW |
59 | const char *propname, u8 *val, |
60 | size_t nval); | |
37ba983c | 61 | int fwnode_property_read_u16_array(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
62 | const char *propname, u16 *val, |
63 | size_t nval); | |
37ba983c | 64 | int fwnode_property_read_u32_array(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
65 | const char *propname, u32 *val, |
66 | size_t nval); | |
37ba983c | 67 | int fwnode_property_read_u64_array(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
68 | const char *propname, u64 *val, |
69 | size_t nval); | |
37ba983c | 70 | int fwnode_property_read_string_array(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
71 | const char *propname, const char **val, |
72 | size_t nval); | |
37ba983c | 73 | int fwnode_property_read_string(const struct fwnode_handle *fwnode, |
8a0662d9 | 74 | const char *propname, const char **val); |
37ba983c | 75 | int fwnode_property_match_string(const struct fwnode_handle *fwnode, |
3f5c8d31 | 76 | const char *propname, const char *string); |
3e3119d3 SA |
77 | int fwnode_property_get_reference_args(const struct fwnode_handle *fwnode, |
78 | const char *prop, const char *nargs_prop, | |
79 | unsigned int nargs, unsigned int index, | |
80 | struct fwnode_reference_args *args); | |
8a0662d9 | 81 | |
37ba983c SA |
82 | struct fwnode_handle *fwnode_get_parent(const struct fwnode_handle *fwnode); |
83 | struct fwnode_handle *fwnode_get_next_parent( | |
84 | struct fwnode_handle *fwnode); | |
85 | struct fwnode_handle *fwnode_get_next_child_node( | |
86 | const struct fwnode_handle *fwnode, struct fwnode_handle *child); | |
3395de96 MW |
87 | struct fwnode_handle *fwnode_get_next_available_child_node( |
88 | const struct fwnode_handle *fwnode, struct fwnode_handle *child); | |
34055190 MW |
89 | |
90 | #define fwnode_for_each_child_node(fwnode, child) \ | |
91 | for (child = fwnode_get_next_child_node(fwnode, NULL); child; \ | |
92 | child = fwnode_get_next_child_node(fwnode, child)) | |
afaf26fd | 93 | |
3395de96 MW |
94 | #define fwnode_for_each_available_child_node(fwnode, child) \ |
95 | for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\ | |
96 | child = fwnode_get_next_available_child_node(fwnode, child)) | |
97 | ||
37ba983c SA |
98 | struct fwnode_handle *device_get_next_child_node( |
99 | struct device *dev, struct fwnode_handle *child); | |
8a0662d9 | 100 | |
1d656fb7 AS |
101 | #define device_for_each_child_node(dev, child) \ |
102 | for (child = device_get_next_child_node(dev, NULL); child; \ | |
8a0662d9 RW |
103 | child = device_get_next_child_node(dev, child)) |
104 | ||
37ba983c SA |
105 | struct fwnode_handle *fwnode_get_named_child_node( |
106 | const struct fwnode_handle *fwnode, const char *childname); | |
613e9721 AT |
107 | struct fwnode_handle *device_get_named_child_node(struct device *dev, |
108 | const char *childname); | |
109 | ||
cf89a31c | 110 | struct fwnode_handle *fwnode_handle_get(struct fwnode_handle *fwnode); |
8a0662d9 RW |
111 | void fwnode_handle_put(struct fwnode_handle *fwnode); |
112 | ||
7c6c57f2 MW |
113 | int fwnode_irq_get(struct fwnode_handle *fwnode, unsigned int index); |
114 | ||
8a0662d9 RW |
115 | unsigned int device_get_child_node_count(struct device *dev); |
116 | ||
b31384fa RW |
117 | static inline bool device_property_read_bool(struct device *dev, |
118 | const char *propname) | |
119 | { | |
120 | return device_property_present(dev, propname); | |
121 | } | |
122 | ||
123 | static inline int device_property_read_u8(struct device *dev, | |
124 | const char *propname, u8 *val) | |
125 | { | |
126 | return device_property_read_u8_array(dev, propname, val, 1); | |
127 | } | |
128 | ||
129 | static inline int device_property_read_u16(struct device *dev, | |
130 | const char *propname, u16 *val) | |
131 | { | |
132 | return device_property_read_u16_array(dev, propname, val, 1); | |
133 | } | |
134 | ||
135 | static inline int device_property_read_u32(struct device *dev, | |
136 | const char *propname, u32 *val) | |
137 | { | |
138 | return device_property_read_u32_array(dev, propname, val, 1); | |
139 | } | |
140 | ||
141 | static inline int device_property_read_u64(struct device *dev, | |
142 | const char *propname, u64 *val) | |
143 | { | |
144 | return device_property_read_u64_array(dev, propname, val, 1); | |
145 | } | |
146 | ||
37ba983c | 147 | static inline bool fwnode_property_read_bool(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
148 | const char *propname) |
149 | { | |
150 | return fwnode_property_present(fwnode, propname); | |
151 | } | |
152 | ||
37ba983c | 153 | static inline int fwnode_property_read_u8(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
154 | const char *propname, u8 *val) |
155 | { | |
156 | return fwnode_property_read_u8_array(fwnode, propname, val, 1); | |
157 | } | |
158 | ||
37ba983c | 159 | static inline int fwnode_property_read_u16(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
160 | const char *propname, u16 *val) |
161 | { | |
162 | return fwnode_property_read_u16_array(fwnode, propname, val, 1); | |
163 | } | |
164 | ||
37ba983c | 165 | static inline int fwnode_property_read_u32(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
166 | const char *propname, u32 *val) |
167 | { | |
168 | return fwnode_property_read_u32_array(fwnode, propname, val, 1); | |
169 | } | |
170 | ||
37ba983c | 171 | static inline int fwnode_property_read_u64(const struct fwnode_handle *fwnode, |
8a0662d9 RW |
172 | const char *propname, u64 *val) |
173 | { | |
174 | return fwnode_property_read_u64_array(fwnode, propname, val, 1); | |
175 | } | |
176 | ||
16ba08d5 RW |
177 | /** |
178 | * struct property_entry - "Built-in" device property representation. | |
179 | * @name: Name of the property. | |
318a1971 | 180 | * @length: Length of data making up the value. |
66586bab | 181 | * @is_array: True when the property is an array. |
63dcc709 | 182 | * @type: Type of the data in unions. |
66586bab AS |
183 | * @pointer: Pointer to the property (an array of items of the given type). |
184 | * @value: Value of the property (when it is a single item of the given type). | |
16ba08d5 RW |
185 | */ |
186 | struct property_entry { | |
187 | const char *name; | |
318a1971 | 188 | size_t length; |
66586bab | 189 | bool is_array; |
63dcc709 | 190 | enum dev_prop_type type; |
16ba08d5 | 191 | union { |
66586bab | 192 | union { |
9426998c DT |
193 | const u8 *u8_data; |
194 | const u16 *u16_data; | |
195 | const u32 *u32_data; | |
196 | const u64 *u64_data; | |
197 | const char * const *str; | |
66586bab AS |
198 | } pointer; |
199 | union { | |
66586bab AS |
200 | u8 u8_data; |
201 | u16 u16_data; | |
202 | u32 u32_data; | |
203 | u64 u64_data; | |
204 | const char *str; | |
205 | } value; | |
206 | }; | |
16ba08d5 RW |
207 | }; |
208 | ||
d76eebfa AM |
209 | /* |
210 | * Note: the below four initializers for the anonymous union are carefully | |
211 | * crafted to avoid gcc-4.4.4's problems with initialization of anon unions | |
212 | * and structs. | |
213 | */ | |
214 | ||
63dcc709 AS |
215 | #define PROPERTY_ENTRY_INTEGER_ARRAY(_name_, _type_, _Type_, _val_) \ |
216 | (struct property_entry) { \ | |
217 | .name = _name_, \ | |
218 | .length = ARRAY_SIZE(_val_) * sizeof(_type_), \ | |
219 | .is_array = true, \ | |
220 | .type = DEV_PROP_##_Type_, \ | |
221 | { .pointer = { ._type_##_data = _val_ } }, \ | |
a85f4204 HK |
222 | } |
223 | ||
224 | #define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \ | |
63dcc709 | 225 | PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u8, U8, _val_) |
a85f4204 | 226 | #define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \ |
63dcc709 | 227 | PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u16, U16, _val_) |
a85f4204 | 228 | #define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \ |
63dcc709 | 229 | PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u32, U32, _val_) |
a85f4204 | 230 | #define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \ |
63dcc709 | 231 | PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u64, U64, _val_) |
a85f4204 HK |
232 | |
233 | #define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \ | |
c505cbd4 | 234 | (struct property_entry) { \ |
a85f4204 HK |
235 | .name = _name_, \ |
236 | .length = ARRAY_SIZE(_val_) * sizeof(const char *), \ | |
237 | .is_array = true, \ | |
63dcc709 | 238 | .type = DEV_PROP_STRING, \ |
d76eebfa | 239 | { .pointer = { .str = _val_ } }, \ |
a85f4204 HK |
240 | } |
241 | ||
63dcc709 AS |
242 | #define PROPERTY_ENTRY_INTEGER(_name_, _type_, _Type_, _val_) \ |
243 | (struct property_entry) { \ | |
244 | .name = _name_, \ | |
245 | .length = sizeof(_type_), \ | |
246 | .type = DEV_PROP_##_Type_, \ | |
247 | { .value = { ._type_##_data = _val_ } }, \ | |
a85f4204 HK |
248 | } |
249 | ||
250 | #define PROPERTY_ENTRY_U8(_name_, _val_) \ | |
63dcc709 | 251 | PROPERTY_ENTRY_INTEGER(_name_, u8, U8, _val_) |
a85f4204 | 252 | #define PROPERTY_ENTRY_U16(_name_, _val_) \ |
63dcc709 | 253 | PROPERTY_ENTRY_INTEGER(_name_, u16, U16, _val_) |
a85f4204 | 254 | #define PROPERTY_ENTRY_U32(_name_, _val_) \ |
63dcc709 | 255 | PROPERTY_ENTRY_INTEGER(_name_, u32, U32, _val_) |
a85f4204 | 256 | #define PROPERTY_ENTRY_U64(_name_, _val_) \ |
63dcc709 | 257 | PROPERTY_ENTRY_INTEGER(_name_, u64, U64, _val_) |
a85f4204 HK |
258 | |
259 | #define PROPERTY_ENTRY_STRING(_name_, _val_) \ | |
c505cbd4 | 260 | (struct property_entry) { \ |
a85f4204 | 261 | .name = _name_, \ |
2b6e4924 | 262 | .length = sizeof(const char *), \ |
63dcc709 | 263 | .type = DEV_PROP_STRING, \ |
aace7367 | 264 | { .value = { .str = _val_ } }, \ |
a85f4204 HK |
265 | } |
266 | ||
267 | #define PROPERTY_ENTRY_BOOL(_name_) \ | |
c505cbd4 | 268 | (struct property_entry) { \ |
a85f4204 HK |
269 | .name = _name_, \ |
270 | } | |
271 | ||
2d479e1f DT |
272 | struct property_entry * |
273 | property_entries_dup(const struct property_entry *properties); | |
274 | ||
275 | void property_entries_free(const struct property_entry *properties); | |
276 | ||
f4d05266 | 277 | int device_add_properties(struct device *dev, |
bec84da8 | 278 | const struct property_entry *properties); |
f4d05266 | 279 | void device_remove_properties(struct device *dev); |
16ba08d5 | 280 | |
e5e55864 SS |
281 | bool device_dma_supported(struct device *dev); |
282 | ||
283 | enum dev_dma_attr device_get_dma_attr(struct device *dev); | |
b283f157 | 284 | |
67dcc26d | 285 | const void *device_get_match_data(struct device *dev); |
e5e55864 | 286 | |
4c96b7dc JL |
287 | int device_get_phy_mode(struct device *dev); |
288 | ||
289 | void *device_get_mac_address(struct device *dev, char *addr, int alen); | |
290 | ||
b28f263b | 291 | int fwnode_get_phy_mode(struct fwnode_handle *fwnode); |
babe2dbb MW |
292 | void *fwnode_get_mac_address(struct fwnode_handle *fwnode, |
293 | char *addr, int alen); | |
07bb80d4 | 294 | struct fwnode_handle *fwnode_graph_get_next_endpoint( |
37ba983c | 295 | const struct fwnode_handle *fwnode, struct fwnode_handle *prev); |
6a71d8d7 | 296 | struct fwnode_handle * |
37ba983c | 297 | fwnode_graph_get_port_parent(const struct fwnode_handle *fwnode); |
07bb80d4 | 298 | struct fwnode_handle *fwnode_graph_get_remote_port_parent( |
37ba983c | 299 | const struct fwnode_handle *fwnode); |
07bb80d4 | 300 | struct fwnode_handle *fwnode_graph_get_remote_port( |
37ba983c | 301 | const struct fwnode_handle *fwnode); |
07bb80d4 | 302 | struct fwnode_handle *fwnode_graph_get_remote_endpoint( |
37ba983c SA |
303 | const struct fwnode_handle *fwnode); |
304 | struct fwnode_handle * | |
305 | fwnode_graph_get_remote_node(const struct fwnode_handle *fwnode, u32 port, | |
306 | u32 endpoint); | |
07bb80d4 | 307 | |
0fcc2bdc SA |
308 | /* |
309 | * Fwnode lookup flags | |
310 | * | |
311 | * @FWNODE_GRAPH_ENDPOINT_NEXT: In the case of no exact match, look for the | |
312 | * closest endpoint ID greater than the specified | |
313 | * one. | |
314 | * @FWNODE_GRAPH_DEVICE_DISABLED: That the device to which the remote | |
315 | * endpoint of the given endpoint belongs to, | |
316 | * may be disabled. | |
317 | */ | |
318 | #define FWNODE_GRAPH_ENDPOINT_NEXT BIT(0) | |
319 | #define FWNODE_GRAPH_DEVICE_DISABLED BIT(1) | |
320 | ||
321 | struct fwnode_handle * | |
322 | fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode, | |
323 | u32 port, u32 endpoint, unsigned long flags); | |
324 | ||
5e4b1b70 SA |
325 | #define fwnode_graph_for_each_endpoint(fwnode, child) \ |
326 | for (child = NULL; \ | |
327 | (child = fwnode_graph_get_next_endpoint(fwnode, child)); ) | |
328 | ||
37ba983c | 329 | int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode, |
2bd5452d SA |
330 | struct fwnode_endpoint *endpoint); |
331 | ||
59abd836 HK |
332 | /* -------------------------------------------------------------------------- */ |
333 | /* Software fwnode support - when HW description is incomplete or missing */ | |
334 | ||
335 | bool is_software_node(const struct fwnode_handle *fwnode); | |
336 | ||
337 | int software_node_notify(struct device *dev, unsigned long action); | |
338 | ||
339 | struct fwnode_handle * | |
340 | fwnode_create_software_node(const struct property_entry *properties, | |
341 | const struct fwnode_handle *parent); | |
342 | void fwnode_remove_software_node(struct fwnode_handle *fwnode); | |
343 | ||
b31384fa | 344 | #endif /* _LINUX_PROPERTY_H_ */ |