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