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