]>
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 | |
8a0662d9 RW |
54 | bool fwnode_property_present(struct fwnode_handle *fwnode, const char *propname); |
55 | int fwnode_property_read_u8_array(struct fwnode_handle *fwnode, | |
56 | const char *propname, u8 *val, | |
57 | size_t nval); | |
58 | int fwnode_property_read_u16_array(struct fwnode_handle *fwnode, | |
59 | const char *propname, u16 *val, | |
60 | size_t nval); | |
61 | int fwnode_property_read_u32_array(struct fwnode_handle *fwnode, | |
62 | const char *propname, u32 *val, | |
63 | size_t nval); | |
64 | int fwnode_property_read_u64_array(struct fwnode_handle *fwnode, | |
65 | const char *propname, u64 *val, | |
66 | size_t nval); | |
67 | int fwnode_property_read_string_array(struct fwnode_handle *fwnode, | |
68 | const char *propname, const char **val, | |
69 | size_t nval); | |
70 | int fwnode_property_read_string(struct fwnode_handle *fwnode, | |
71 | const char *propname, const char **val); | |
3f5c8d31 MW |
72 | int fwnode_property_match_string(struct fwnode_handle *fwnode, |
73 | const char *propname, const char *string); | |
8a0662d9 | 74 | |
afaf26fd | 75 | struct fwnode_handle *fwnode_get_parent(struct fwnode_handle *fwnode); |
34055190 MW |
76 | struct fwnode_handle *fwnode_get_next_child_node(struct fwnode_handle *fwnode, |
77 | struct fwnode_handle *child); | |
78 | ||
79 | #define fwnode_for_each_child_node(fwnode, child) \ | |
80 | for (child = fwnode_get_next_child_node(fwnode, NULL); child; \ | |
81 | child = fwnode_get_next_child_node(fwnode, child)) | |
afaf26fd | 82 | |
8a0662d9 RW |
83 | struct fwnode_handle *device_get_next_child_node(struct device *dev, |
84 | struct fwnode_handle *child); | |
85 | ||
1d656fb7 AS |
86 | #define device_for_each_child_node(dev, child) \ |
87 | for (child = device_get_next_child_node(dev, NULL); child; \ | |
8a0662d9 RW |
88 | child = device_get_next_child_node(dev, child)) |
89 | ||
21ea73f5 MW |
90 | struct fwnode_handle *fwnode_get_named_child_node(struct fwnode_handle *fwnode, |
91 | const char *childname); | |
613e9721 AT |
92 | struct fwnode_handle *device_get_named_child_node(struct device *dev, |
93 | const char *childname); | |
94 | ||
e7887c28 | 95 | void fwnode_handle_get(struct fwnode_handle *fwnode); |
8a0662d9 RW |
96 | void fwnode_handle_put(struct fwnode_handle *fwnode); |
97 | ||
98 | unsigned int device_get_child_node_count(struct device *dev); | |
99 | ||
b31384fa RW |
100 | static inline bool device_property_read_bool(struct device *dev, |
101 | const char *propname) | |
102 | { | |
103 | return device_property_present(dev, propname); | |
104 | } | |
105 | ||
106 | static inline int device_property_read_u8(struct device *dev, | |
107 | const char *propname, u8 *val) | |
108 | { | |
109 | return device_property_read_u8_array(dev, propname, val, 1); | |
110 | } | |
111 | ||
112 | static inline int device_property_read_u16(struct device *dev, | |
113 | const char *propname, u16 *val) | |
114 | { | |
115 | return device_property_read_u16_array(dev, propname, val, 1); | |
116 | } | |
117 | ||
118 | static inline int device_property_read_u32(struct device *dev, | |
119 | const char *propname, u32 *val) | |
120 | { | |
121 | return device_property_read_u32_array(dev, propname, val, 1); | |
122 | } | |
123 | ||
124 | static inline int device_property_read_u64(struct device *dev, | |
125 | const char *propname, u64 *val) | |
126 | { | |
127 | return device_property_read_u64_array(dev, propname, val, 1); | |
128 | } | |
129 | ||
8a0662d9 RW |
130 | static inline bool fwnode_property_read_bool(struct fwnode_handle *fwnode, |
131 | const char *propname) | |
132 | { | |
133 | return fwnode_property_present(fwnode, propname); | |
134 | } | |
135 | ||
136 | static inline int fwnode_property_read_u8(struct fwnode_handle *fwnode, | |
137 | const char *propname, u8 *val) | |
138 | { | |
139 | return fwnode_property_read_u8_array(fwnode, propname, val, 1); | |
140 | } | |
141 | ||
142 | static inline int fwnode_property_read_u16(struct fwnode_handle *fwnode, | |
143 | const char *propname, u16 *val) | |
144 | { | |
145 | return fwnode_property_read_u16_array(fwnode, propname, val, 1); | |
146 | } | |
147 | ||
148 | static inline int fwnode_property_read_u32(struct fwnode_handle *fwnode, | |
149 | const char *propname, u32 *val) | |
150 | { | |
151 | return fwnode_property_read_u32_array(fwnode, propname, val, 1); | |
152 | } | |
153 | ||
154 | static inline int fwnode_property_read_u64(struct fwnode_handle *fwnode, | |
155 | const char *propname, u64 *val) | |
156 | { | |
157 | return fwnode_property_read_u64_array(fwnode, propname, val, 1); | |
158 | } | |
159 | ||
16ba08d5 RW |
160 | /** |
161 | * struct property_entry - "Built-in" device property representation. | |
162 | * @name: Name of the property. | |
318a1971 | 163 | * @length: Length of data making up the value. |
66586bab AS |
164 | * @is_array: True when the property is an array. |
165 | * @is_string: True when property is a string. | |
166 | * @pointer: Pointer to the property (an array of items of the given type). | |
167 | * @value: Value of the property (when it is a single item of the given type). | |
16ba08d5 RW |
168 | */ |
169 | struct property_entry { | |
170 | const char *name; | |
318a1971 | 171 | size_t length; |
66586bab AS |
172 | bool is_array; |
173 | bool is_string; | |
16ba08d5 | 174 | union { |
66586bab | 175 | union { |
9426998c DT |
176 | const void *raw_data; |
177 | const u8 *u8_data; | |
178 | const u16 *u16_data; | |
179 | const u32 *u32_data; | |
180 | const u64 *u64_data; | |
181 | const char * const *str; | |
66586bab AS |
182 | } pointer; |
183 | union { | |
184 | unsigned long long raw_data; | |
185 | u8 u8_data; | |
186 | u16 u16_data; | |
187 | u32 u32_data; | |
188 | u64 u64_data; | |
189 | const char *str; | |
190 | } value; | |
191 | }; | |
16ba08d5 RW |
192 | }; |
193 | ||
d76eebfa AM |
194 | /* |
195 | * Note: the below four initializers for the anonymous union are carefully | |
196 | * crafted to avoid gcc-4.4.4's problems with initialization of anon unions | |
197 | * and structs. | |
198 | */ | |
199 | ||
a85f4204 HK |
200 | #define PROPERTY_ENTRY_INTEGER_ARRAY(_name_, _type_, _val_) \ |
201 | { \ | |
202 | .name = _name_, \ | |
203 | .length = ARRAY_SIZE(_val_) * sizeof(_type_), \ | |
204 | .is_array = true, \ | |
d76eebfa | 205 | .is_string = false, \ |
37aa7271 | 206 | { .pointer = { ._type_##_data = _val_ } }, \ |
a85f4204 HK |
207 | } |
208 | ||
209 | #define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \ | |
210 | PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u8, _val_) | |
211 | #define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \ | |
212 | PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u16, _val_) | |
213 | #define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \ | |
214 | PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u32, _val_) | |
215 | #define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \ | |
216 | PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u64, _val_) | |
217 | ||
218 | #define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \ | |
219 | { \ | |
220 | .name = _name_, \ | |
221 | .length = ARRAY_SIZE(_val_) * sizeof(const char *), \ | |
222 | .is_array = true, \ | |
223 | .is_string = true, \ | |
d76eebfa | 224 | { .pointer = { .str = _val_ } }, \ |
a85f4204 HK |
225 | } |
226 | ||
227 | #define PROPERTY_ENTRY_INTEGER(_name_, _type_, _val_) \ | |
228 | { \ | |
229 | .name = _name_, \ | |
230 | .length = sizeof(_type_), \ | |
d76eebfa AM |
231 | .is_string = false, \ |
232 | { .value = { ._type_##_data = _val_ } }, \ | |
a85f4204 HK |
233 | } |
234 | ||
235 | #define PROPERTY_ENTRY_U8(_name_, _val_) \ | |
236 | PROPERTY_ENTRY_INTEGER(_name_, u8, _val_) | |
237 | #define PROPERTY_ENTRY_U16(_name_, _val_) \ | |
238 | PROPERTY_ENTRY_INTEGER(_name_, u16, _val_) | |
239 | #define PROPERTY_ENTRY_U32(_name_, _val_) \ | |
240 | PROPERTY_ENTRY_INTEGER(_name_, u32, _val_) | |
241 | #define PROPERTY_ENTRY_U64(_name_, _val_) \ | |
242 | PROPERTY_ENTRY_INTEGER(_name_, u64, _val_) | |
243 | ||
244 | #define PROPERTY_ENTRY_STRING(_name_, _val_) \ | |
245 | { \ | |
246 | .name = _name_, \ | |
247 | .length = sizeof(_val_), \ | |
248 | .is_string = true, \ | |
aace7367 | 249 | { .value = { .str = _val_ } }, \ |
a85f4204 HK |
250 | } |
251 | ||
252 | #define PROPERTY_ENTRY_BOOL(_name_) \ | |
253 | { \ | |
254 | .name = _name_, \ | |
255 | } | |
256 | ||
2d479e1f DT |
257 | struct property_entry * |
258 | property_entries_dup(const struct property_entry *properties); | |
259 | ||
260 | void property_entries_free(const struct property_entry *properties); | |
261 | ||
f4d05266 | 262 | int device_add_properties(struct device *dev, |
bec84da8 | 263 | const struct property_entry *properties); |
f4d05266 | 264 | void device_remove_properties(struct device *dev); |
16ba08d5 | 265 | |
e5e55864 SS |
266 | bool device_dma_supported(struct device *dev); |
267 | ||
268 | enum dev_dma_attr device_get_dma_attr(struct device *dev); | |
269 | ||
4c96b7dc JL |
270 | int device_get_phy_mode(struct device *dev); |
271 | ||
272 | void *device_get_mac_address(struct device *dev, char *addr, int alen); | |
273 | ||
07bb80d4 MW |
274 | struct fwnode_handle *fwnode_graph_get_next_endpoint( |
275 | struct fwnode_handle *fwnode, struct fwnode_handle *prev); | |
276 | struct fwnode_handle *fwnode_graph_get_remote_port_parent( | |
277 | struct fwnode_handle *fwnode); | |
278 | struct fwnode_handle *fwnode_graph_get_remote_port( | |
279 | struct fwnode_handle *fwnode); | |
280 | struct fwnode_handle *fwnode_graph_get_remote_endpoint( | |
281 | struct fwnode_handle *fwnode); | |
282 | ||
2bd5452d SA |
283 | int fwnode_graph_parse_endpoint(struct fwnode_handle *fwnode, |
284 | struct fwnode_endpoint *endpoint); | |
285 | ||
b31384fa | 286 | #endif /* _LINUX_PROPERTY_H_ */ |