2 * fwnode.h - Firmware device node object handle type definition.
4 * Copyright (C) 2015, Intel Corporation
5 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
12 #ifndef _LINUX_FWNODE_H_
13 #define _LINUX_FWNODE_H_
15 #include <linux/types.h>
17 struct fwnode_operations
;
19 struct fwnode_handle
{
20 struct fwnode_handle
*secondary
;
21 const struct fwnode_operations
*ops
;
25 * struct fwnode_endpoint - Fwnode graph endpoint
28 * @local_fwnode: reference to the related fwnode
30 struct fwnode_endpoint
{
33 const struct fwnode_handle
*local_fwnode
;
36 #define NR_FWNODE_REFERENCE_ARGS 8
39 * struct fwnode_reference_args - Fwnode reference with additional arguments
40 * @fwnode:- A reference to the base fwnode
41 * @nargs: Number of elements in @args array
42 * @args: Integer arguments on the fwnode
44 struct fwnode_reference_args
{
45 struct fwnode_handle
*fwnode
;
47 unsigned int args
[NR_FWNODE_REFERENCE_ARGS
];
51 * struct fwnode_operations - Operations for fwnode interface
52 * @get: Get a reference to an fwnode.
53 * @put: Put a reference to an fwnode.
54 * @property_present: Return true if a property is present.
55 * @property_read_integer_array: Read an array of integer properties. Return
56 * zero on success, a negative error code
58 * @property_read_string_array: Read an array of string properties. Return zero
59 * on success, a negative error code otherwise.
60 * @get_parent: Return the parent of an fwnode.
61 * @get_next_child_node: Return the next child node in an iteration.
62 * @get_named_child_node: Return a child node with a given name.
63 * @get_reference_args: Return a reference pointed to by a property, with args
64 * @graph_get_next_endpoint: Return an endpoint node in an iteration.
65 * @graph_get_remote_endpoint: Return the remote endpoint node of a local
67 * @graph_get_port_parent: Return the parent node of a port node.
68 * @graph_parse_endpoint: Parse endpoint for port and endpoint id.
70 struct fwnode_operations
{
71 struct fwnode_handle
*(*get
)(struct fwnode_handle
*fwnode
);
72 void (*put
)(struct fwnode_handle
*fwnode
);
73 bool (*device_is_available
)(const struct fwnode_handle
*fwnode
);
74 bool (*property_present
)(const struct fwnode_handle
*fwnode
,
75 const char *propname
);
76 int (*property_read_int_array
)(const struct fwnode_handle
*fwnode
,
78 unsigned int elem_size
, void *val
,
81 (*property_read_string_array
)(const struct fwnode_handle
*fwnode_handle
,
82 const char *propname
, const char **val
,
84 struct fwnode_handle
*(*get_parent
)(const struct fwnode_handle
*fwnode
);
85 struct fwnode_handle
*
86 (*get_next_child_node
)(const struct fwnode_handle
*fwnode
,
87 struct fwnode_handle
*child
);
88 struct fwnode_handle
*
89 (*get_named_child_node
)(const struct fwnode_handle
*fwnode
,
91 int (*get_reference_args
)(const struct fwnode_handle
*fwnode
,
92 const char *prop
, const char *nargs_prop
,
93 unsigned int nargs
, unsigned int index
,
94 struct fwnode_reference_args
*args
);
95 struct fwnode_handle
*
96 (*graph_get_next_endpoint
)(const struct fwnode_handle
*fwnode
,
97 struct fwnode_handle
*prev
);
98 struct fwnode_handle
*
99 (*graph_get_remote_endpoint
)(const struct fwnode_handle
*fwnode
);
100 struct fwnode_handle
*
101 (*graph_get_port_parent
)(struct fwnode_handle
*fwnode
);
102 int (*graph_parse_endpoint
)(const struct fwnode_handle
*fwnode
,
103 struct fwnode_endpoint
*endpoint
);
106 #define fwnode_has_op(fwnode, op) \
107 ((fwnode) && (fwnode)->ops && (fwnode)->ops->op)
108 #define fwnode_call_int_op(fwnode, op, ...) \
109 (fwnode ? (fwnode_has_op(fwnode, op) ? \
110 (fwnode)->ops->op(fwnode, ## __VA_ARGS__) : -ENXIO) : \
112 #define fwnode_call_bool_op(fwnode, op, ...) \
113 (fwnode ? (fwnode_has_op(fwnode, op) ? \
114 (fwnode)->ops->op(fwnode, ## __VA_ARGS__) : false) : \
116 #define fwnode_call_ptr_op(fwnode, op, ...) \
117 (fwnode_has_op(fwnode, op) ? \
118 (fwnode)->ops->op(fwnode, ## __VA_ARGS__) : NULL)
119 #define fwnode_call_void_op(fwnode, op, ...) \
121 if (fwnode_has_op(fwnode, op)) \
122 (fwnode)->ops->op(fwnode, ## __VA_ARGS__); \