]>
git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blob - include/linux/property.h
2 * property.h - Unified device property interface.
4 * Copyright (C) 2014, Intel Corporation
5 * Authors: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
6 * Mika Westerberg <mika.westerberg@linux.intel.com>
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.
13 #ifndef _LINUX_PROPERTY_H_
14 #define _LINUX_PROPERTY_H_
16 #include <linux/fwnode.h>
17 #include <linux/types.h>
31 DEV_DMA_NOT_SUPPORTED
,
36 struct fwnode_handle
*dev_fwnode(struct device
*dev
);
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
,
51 int device_property_match_string(struct device
*dev
,
52 const char *propname
, const char *string
);
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
,
58 const char *propname
, u8
*val
,
60 int fwnode_property_read_u16_array(const struct fwnode_handle
*fwnode
,
61 const char *propname
, u16
*val
,
63 int fwnode_property_read_u32_array(const struct fwnode_handle
*fwnode
,
64 const char *propname
, u32
*val
,
66 int fwnode_property_read_u64_array(const struct fwnode_handle
*fwnode
,
67 const char *propname
, u64
*val
,
69 int fwnode_property_read_string_array(const struct fwnode_handle
*fwnode
,
70 const char *propname
, const char **val
,
72 int fwnode_property_read_string(const struct fwnode_handle
*fwnode
,
73 const char *propname
, const char **val
);
74 int fwnode_property_match_string(const struct fwnode_handle
*fwnode
,
75 const char *propname
, const char *string
);
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
);
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
);
86 struct fwnode_handle
*fwnode_get_next_available_child_node(
87 const struct fwnode_handle
*fwnode
, struct fwnode_handle
*child
);
89 #define fwnode_for_each_child_node(fwnode, child) \
90 for (child = fwnode_get_next_child_node(fwnode, NULL); child; \
91 child = fwnode_get_next_child_node(fwnode, child))
93 #define fwnode_for_each_available_child_node(fwnode, child) \
94 for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\
95 child = fwnode_get_next_available_child_node(fwnode, child))
97 struct fwnode_handle
*device_get_next_child_node(
98 struct device
*dev
, struct fwnode_handle
*child
);
100 #define device_for_each_child_node(dev, child) \
101 for (child = device_get_next_child_node(dev, NULL); child; \
102 child = device_get_next_child_node(dev, child))
104 struct fwnode_handle
*fwnode_get_named_child_node(
105 const struct fwnode_handle
*fwnode
, const char *childname
);
106 struct fwnode_handle
*device_get_named_child_node(struct device
*dev
,
107 const char *childname
);
109 struct fwnode_handle
*fwnode_handle_get(struct fwnode_handle
*fwnode
);
110 void fwnode_handle_put(struct fwnode_handle
*fwnode
);
112 int fwnode_irq_get(struct fwnode_handle
*fwnode
, unsigned int index
);
114 unsigned int device_get_child_node_count(struct device
*dev
);
116 static inline bool device_property_read_bool(struct device
*dev
,
117 const char *propname
)
119 return device_property_present(dev
, propname
);
122 static inline int device_property_read_u8(struct device
*dev
,
123 const char *propname
, u8
*val
)
125 return device_property_read_u8_array(dev
, propname
, val
, 1);
128 static inline int device_property_read_u16(struct device
*dev
,
129 const char *propname
, u16
*val
)
131 return device_property_read_u16_array(dev
, propname
, val
, 1);
134 static inline int device_property_read_u32(struct device
*dev
,
135 const char *propname
, u32
*val
)
137 return device_property_read_u32_array(dev
, propname
, val
, 1);
140 static inline int device_property_read_u64(struct device
*dev
,
141 const char *propname
, u64
*val
)
143 return device_property_read_u64_array(dev
, propname
, val
, 1);
146 static inline bool fwnode_property_read_bool(const struct fwnode_handle
*fwnode
,
147 const char *propname
)
149 return fwnode_property_present(fwnode
, propname
);
152 static inline int fwnode_property_read_u8(const struct fwnode_handle
*fwnode
,
153 const char *propname
, u8
*val
)
155 return fwnode_property_read_u8_array(fwnode
, propname
, val
, 1);
158 static inline int fwnode_property_read_u16(const struct fwnode_handle
*fwnode
,
159 const char *propname
, u16
*val
)
161 return fwnode_property_read_u16_array(fwnode
, propname
, val
, 1);
164 static inline int fwnode_property_read_u32(const struct fwnode_handle
*fwnode
,
165 const char *propname
, u32
*val
)
167 return fwnode_property_read_u32_array(fwnode
, propname
, val
, 1);
170 static inline int fwnode_property_read_u64(const struct fwnode_handle
*fwnode
,
171 const char *propname
, u64
*val
)
173 return fwnode_property_read_u64_array(fwnode
, propname
, val
, 1);
177 * struct property_entry - "Built-in" device property representation.
178 * @name: Name of the property.
179 * @length: Length of data making up the value.
180 * @is_array: True when the property is an array.
181 * @type: Type of the data in unions.
182 * @pointer: Pointer to the property (an array of items of the given type).
183 * @value: Value of the property (when it is a single item of the given type).
185 struct property_entry
{
189 enum dev_prop_type type
;
196 const char * const *str
;
209 * Note: the below four initializers for the anonymous union are carefully
210 * crafted to avoid gcc-4.4.4's problems with initialization of anon unions
214 #define PROPERTY_ENTRY_INTEGER_ARRAY(_name_, _type_, _Type_, _val_) \
215 (struct property_entry) { \
217 .length = ARRAY_SIZE(_val_) * sizeof(_type_), \
219 .type = DEV_PROP_##_Type_, \
220 { .pointer = { ._type_##_data = _val_ } }, \
223 #define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \
224 PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u8, U8, _val_)
225 #define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \
226 PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u16, U16, _val_)
227 #define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \
228 PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u32, U32, _val_)
229 #define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \
230 PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u64, U64, _val_)
232 #define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \
233 (struct property_entry) { \
235 .length = ARRAY_SIZE(_val_) * sizeof(const char *), \
237 .type = DEV_PROP_STRING, \
238 { .pointer = { .str = _val_ } }, \
241 #define PROPERTY_ENTRY_INTEGER(_name_, _type_, _Type_, _val_) \
242 (struct property_entry) { \
244 .length = sizeof(_type_), \
245 .type = DEV_PROP_##_Type_, \
246 { .value = { ._type_##_data = _val_ } }, \
249 #define PROPERTY_ENTRY_U8(_name_, _val_) \
250 PROPERTY_ENTRY_INTEGER(_name_, u8, U8, _val_)
251 #define PROPERTY_ENTRY_U16(_name_, _val_) \
252 PROPERTY_ENTRY_INTEGER(_name_, u16, U16, _val_)
253 #define PROPERTY_ENTRY_U32(_name_, _val_) \
254 PROPERTY_ENTRY_INTEGER(_name_, u32, U32, _val_)
255 #define PROPERTY_ENTRY_U64(_name_, _val_) \
256 PROPERTY_ENTRY_INTEGER(_name_, u64, U64, _val_)
258 #define PROPERTY_ENTRY_STRING(_name_, _val_) \
259 (struct property_entry) { \
261 .length = sizeof(_val_), \
262 .type = DEV_PROP_STRING, \
263 { .value = { .str = _val_ } }, \
266 #define PROPERTY_ENTRY_BOOL(_name_) \
267 (struct property_entry) { \
271 struct property_entry
*
272 property_entries_dup(const struct property_entry
*properties
);
274 void property_entries_free(const struct property_entry
*properties
);
276 int device_add_properties(struct device
*dev
,
277 const struct property_entry
*properties
);
278 void device_remove_properties(struct device
*dev
);
280 bool device_dma_supported(struct device
*dev
);
282 enum dev_dma_attr
device_get_dma_attr(struct device
*dev
);
284 const void *device_get_match_data(struct device
*dev
);
286 int device_get_phy_mode(struct device
*dev
);
288 void *device_get_mac_address(struct device
*dev
, char *addr
, int alen
);
290 int fwnode_get_phy_mode(struct fwnode_handle
*fwnode
);
291 void *fwnode_get_mac_address(struct fwnode_handle
*fwnode
,
292 char *addr
, int alen
);
293 struct fwnode_handle
*fwnode_graph_get_next_endpoint(
294 const struct fwnode_handle
*fwnode
, struct fwnode_handle
*prev
);
295 struct fwnode_handle
*
296 fwnode_graph_get_port_parent(const struct fwnode_handle
*fwnode
);
297 struct fwnode_handle
*fwnode_graph_get_remote_port_parent(
298 const struct fwnode_handle
*fwnode
);
299 struct fwnode_handle
*fwnode_graph_get_remote_port(
300 const struct fwnode_handle
*fwnode
);
301 struct fwnode_handle
*fwnode_graph_get_remote_endpoint(
302 const struct fwnode_handle
*fwnode
);
303 struct fwnode_handle
*
304 fwnode_graph_get_remote_node(const struct fwnode_handle
*fwnode
, u32 port
,
307 #define fwnode_graph_for_each_endpoint(fwnode, child) \
309 (child = fwnode_graph_get_next_endpoint(fwnode, child)); )
311 int fwnode_graph_parse_endpoint(const struct fwnode_handle
*fwnode
,
312 struct fwnode_endpoint
*endpoint
);
314 #endif /* _LINUX_PROPERTY_H_ */