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>
27 struct fwnode_operations
;
29 struct fwnode_handle
{
30 enum fwnode_type type
;
31 struct fwnode_handle
*secondary
;
32 const struct fwnode_operations
*ops
;
36 * struct fwnode_endpoint - Fwnode graph endpoint
39 * @local_fwnode: reference to the related fwnode
41 struct fwnode_endpoint
{
44 const struct fwnode_handle
*local_fwnode
;
48 * struct fwnode_operations - Operations for fwnode interface
49 * @get: Get a reference to an fwnode.
50 * @put: Put a reference to an fwnode.
51 * @property_present: Return true if a property is present.
52 * @property_read_integer_array: Read an array of integer properties. Return
53 * zero on success, a negative error code
55 * @property_read_string_array: Read an array of string properties. Return zero
56 * on success, a negative error code otherwise.
57 * @get_parent: Return the parent of an fwnode.
58 * @get_next_child_node: Return the next child node in an iteration.
59 * @get_named_child_node: Return a child node with a given name.
61 struct fwnode_operations
{
62 void (*get
)(struct fwnode_handle
*fwnode
);
63 void (*put
)(struct fwnode_handle
*fwnode
);
64 bool (*property_present
)(struct fwnode_handle
*fwnode
,
65 const char *propname
);
66 int (*property_read_int_array
)(struct fwnode_handle
*fwnode
,
68 unsigned int elem_size
, void *val
,
70 int (*property_read_string_array
)(struct fwnode_handle
*fwnode_handle
,
72 const char **val
, size_t nval
);
73 struct fwnode_handle
*(*get_parent
)(struct fwnode_handle
*fwnode
);
74 struct fwnode_handle
*
75 (*get_next_child_node
)(struct fwnode_handle
*fwnode
,
76 struct fwnode_handle
*child
);
77 struct fwnode_handle
*
78 (*get_named_child_node
)(struct fwnode_handle
*fwnode
, const char *name
);
81 #define fwnode_has_op(fwnode, op) \
82 ((fwnode) && (fwnode)->ops && (fwnode)->ops->op)
83 #define fwnode_call_int_op(fwnode, op, ...) \
84 (fwnode ? (fwnode_has_op(fwnode, op) ? \
85 (fwnode)->ops->op(fwnode, ## __VA_ARGS__) : -ENXIO) : \
87 #define fwnode_call_ptr_op(fwnode, op, ...) \
88 (fwnode_has_op(fwnode, op) ? \
89 (fwnode)->ops->op(fwnode, ## __VA_ARGS__) : NULL)
90 #define fwnode_call_void_op(fwnode, op, ...) \
92 if (fwnode_has_op(fwnode, op)) \
93 (fwnode)->ops->op(fwnode, ## __VA_ARGS__); \