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 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,
49 int device_property_match_string(struct device *dev,
50 const char *propname, const char *string);
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,
56 int fwnode_property_read_u16_array(struct fwnode_handle *fwnode,
57 const char *propname, u16 *val,
59 int fwnode_property_read_u32_array(struct fwnode_handle *fwnode,
60 const char *propname, u32 *val,
62 int fwnode_property_read_u64_array(struct fwnode_handle *fwnode,
63 const char *propname, u64 *val,
65 int fwnode_property_read_string_array(struct fwnode_handle *fwnode,
66 const char *propname, const char **val,
68 int fwnode_property_read_string(struct fwnode_handle *fwnode,
69 const char *propname, const char **val);
70 int fwnode_property_match_string(struct fwnode_handle *fwnode,
71 const char *propname, const char *string);
73 struct fwnode_handle *device_get_next_child_node(struct device *dev,
74 struct fwnode_handle *child);
76 #define device_for_each_child_node(dev, child) \
77 for (child = device_get_next_child_node(dev, NULL); child; \
78 child = device_get_next_child_node(dev, child))
80 struct fwnode_handle *device_get_named_child_node(struct device *dev,
81 const char *childname);
83 void fwnode_handle_put(struct fwnode_handle *fwnode);
85 unsigned int device_get_child_node_count(struct device *dev);
87 static inline bool device_property_read_bool(struct device *dev,
90 return device_property_present(dev, propname);
93 static inline int device_property_read_u8(struct device *dev,
94 const char *propname, u8 *val)
96 return device_property_read_u8_array(dev, propname, val, 1);
99 static inline int device_property_read_u16(struct device *dev,
100 const char *propname, u16 *val)
102 return device_property_read_u16_array(dev, propname, val, 1);
105 static inline int device_property_read_u32(struct device *dev,
106 const char *propname, u32 *val)
108 return device_property_read_u32_array(dev, propname, val, 1);
111 static inline int device_property_read_u64(struct device *dev,
112 const char *propname, u64 *val)
114 return device_property_read_u64_array(dev, propname, val, 1);
117 static inline bool fwnode_property_read_bool(struct fwnode_handle *fwnode,
118 const char *propname)
120 return fwnode_property_present(fwnode, propname);
123 static inline int fwnode_property_read_u8(struct fwnode_handle *fwnode,
124 const char *propname, u8 *val)
126 return fwnode_property_read_u8_array(fwnode, propname, val, 1);
129 static inline int fwnode_property_read_u16(struct fwnode_handle *fwnode,
130 const char *propname, u16 *val)
132 return fwnode_property_read_u16_array(fwnode, propname, val, 1);
135 static inline int fwnode_property_read_u32(struct fwnode_handle *fwnode,
136 const char *propname, u32 *val)
138 return fwnode_property_read_u32_array(fwnode, propname, val, 1);
141 static inline int fwnode_property_read_u64(struct fwnode_handle *fwnode,
142 const char *propname, u64 *val)
144 return fwnode_property_read_u64_array(fwnode, propname, val, 1);
148 * struct property_entry - "Built-in" device property representation.
149 * @name: Name of the property.
150 * @length: Length of data making up the value.
151 * @is_array: True when the property is an array.
152 * @is_string: True when property is a string.
153 * @pointer: Pointer to the property (an array of items of the given type).
154 * @value: Value of the property (when it is a single item of the given type).
156 struct property_entry {
171 unsigned long long raw_data;
182 * Note: the below four initializers for the anonymous union are carefully
183 * crafted to avoid gcc-4.4.4's problems with initialization of anon unions
187 #define PROPERTY_ENTRY_INTEGER_ARRAY(_name_, _type_, _val_) \
190 .length = ARRAY_SIZE(_val_) * sizeof(_type_), \
192 .is_string = false, \
193 { .pointer = { _type_##_data = _val_ } }, \
196 #define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \
197 PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u8, _val_)
198 #define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \
199 PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u16, _val_)
200 #define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \
201 PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u32, _val_)
202 #define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \
203 PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u64, _val_)
205 #define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \
208 .length = ARRAY_SIZE(_val_) * sizeof(const char *), \
211 { .pointer = { .str = _val_ } }, \
214 #define PROPERTY_ENTRY_INTEGER(_name_, _type_, _val_) \
217 .length = sizeof(_type_), \
218 .is_string = false, \
219 { .value = { ._type_##_data = _val_ } }, \
222 #define PROPERTY_ENTRY_U8(_name_, _val_) \
223 PROPERTY_ENTRY_INTEGER(_name_, u8, _val_)
224 #define PROPERTY_ENTRY_U16(_name_, _val_) \
225 PROPERTY_ENTRY_INTEGER(_name_, u16, _val_)
226 #define PROPERTY_ENTRY_U32(_name_, _val_) \
227 PROPERTY_ENTRY_INTEGER(_name_, u32, _val_)
228 #define PROPERTY_ENTRY_U64(_name_, _val_) \
229 PROPERTY_ENTRY_INTEGER(_name_, u64, _val_)
231 #define PROPERTY_ENTRY_STRING(_name_, _val_) \
234 .length = sizeof(_val_), \
236 { .value = { .str = _val_ } }, \
239 #define PROPERTY_ENTRY_BOOL(_name_) \
244 int device_add_properties(struct device *dev,
245 struct property_entry *properties);
246 void device_remove_properties(struct device *dev);
248 bool device_dma_supported(struct device *dev);
250 enum dev_dma_attr device_get_dma_attr(struct device *dev);
252 int device_get_phy_mode(struct device *dev);
254 void *device_get_mac_address(struct device *dev, char *addr, int alen);
256 #endif /* _LINUX_PROPERTY_H_ */