include/linux/fwnode.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * fwnode.h - Firmware device node object handle type definition.
   4  *
   5  * Copyright (C) 2015, Intel Corporation
   6  * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
   7  */
   8
   9 #ifndef _LINUX_FWNODE_H_
  10 #define _LINUX_FWNODE_H_
  11
  12 #include <linux/types.h>
  13
  14 struct fwnode_operations;
  15 struct device;
  16
  17 struct fwnode_handle {
  18         struct fwnode_handle *secondary;
  19         const struct fwnode_operations *ops;
  20         struct device *dev;
  21 };
  22
  23 /**
  24  * struct fwnode_endpoint - Fwnode graph endpoint
  25  * @port: Port number
  26  * @id: Endpoint id
  27  * @local_fwnode: reference to the related fwnode
  28  */
  29 struct fwnode_endpoint {
  30         unsigned int port;
  31         unsigned int id;
  32         const struct fwnode_handle *local_fwnode;
  33 };
  34
  35 #define NR_FWNODE_REFERENCE_ARGS        8
  36
  37 /**
  38  * struct fwnode_reference_args - Fwnode reference with additional arguments
  39  * @fwnode:- A reference to the base fwnode
  40  * @nargs: Number of elements in @args array
  41  * @args: Integer arguments on the fwnode
  42  */
  43 struct fwnode_reference_args {
  44         struct fwnode_handle *fwnode;
  45         unsigned int nargs;
  46         u64 args[NR_FWNODE_REFERENCE_ARGS];
  47 };
  48
  49 /**
  50  * struct fwnode_operations - Operations for fwnode interface
  51  * @get: Get a reference to an fwnode.
  52  * @put: Put a reference to an fwnode.
  53  * @device_get_match_data: Return the device driver match data.
  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
  57  *                               otherwise.
  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
  66  *                             endpoint node.
  67  * @graph_get_port_parent: Return the parent node of a port node.
  68  * @graph_parse_endpoint: Parse endpoint for port and endpoint id.
  69  * @add_links:  Called after the device corresponding to the fwnode is added
  70  *              using device_add(). The function is expected to create device
  71  *              links to all the suppliers of the device that are available at
  72  *              the time this function is called.  The function must NOT stop
  73  *              at the first failed device link if other unlinked supplier
  74  *              devices are present in the system.  This is necessary for the
  75  *              driver/bus sync_state() callbacks to work correctly.
  76  *
  77  *              For example, say Device-C depends on suppliers Device-S1 and
  78  *              Device-S2 and the dependency is listed in that order in the
  79  *              firmware.  Say, S1 gets populated from the firmware after
  80  *              late_initcall_sync().  Say S2 is populated and probed way
  81  *              before that in device_initcall(). When C is populated, if this
  82  *              add_links() function doesn't continue past a "failed linking to
  83  *              S1" and continue linking C to S2, then S2 will get a
  84  *              sync_state() callback before C is probed. This is because from
  85  *              the perspective of S2, C was never a consumer when its
  86  *              sync_state() evaluation is done. To avoid this, the add_links()
  87  *              function has to go through all available suppliers of the
  88  *              device (that corresponds to this fwnode) and link to them
  89  *              before returning.
  90  *
  91  *              If some suppliers are not yet available (indicated by an error
  92  *              return value), this function will be called again when other
  93  *              devices are added to allow creating device links to any newly
  94  *              available suppliers.
  95  *
  96  *              Return 0 if device links have been successfully created to all
  97  *              the suppliers of this device or if the supplier information is
  98  *              not known. Return an error if and only if the supplier
  99  *              information is known but some of the suppliers are not yet
 100  *              available to create device links to.
 101  */
 102 struct fwnode_operations {
 103         struct fwnode_handle *(*get)(struct fwnode_handle *fwnode);
 104         void (*put)(struct fwnode_handle *fwnode);
 105         bool (*device_is_available)(const struct fwnode_handle *fwnode);
 106         const void *(*device_get_match_data)(const struct fwnode_handle *fwnode,
 107                                              const struct device *dev);
 108         bool (*property_present)(const struct fwnode_handle *fwnode,
 109                                  const char *propname);
 110         int (*property_read_int_array)(const struct fwnode_handle *fwnode,
 111                                        const char *propname,
 112                                        unsigned int elem_size, void *val,
 113                                        size_t nval);
 114         int
 115         (*property_read_string_array)(const struct fwnode_handle *fwnode_handle,
 116                                       const char *propname, const char **val,
 117                                       size_t nval);
 118         struct fwnode_handle *(*get_parent)(const struct fwnode_handle *fwnode);
 119         struct fwnode_handle *
 120         (*get_next_child_node)(const struct fwnode_handle *fwnode,
 121                                struct fwnode_handle *child);
 122         struct fwnode_handle *
 123         (*get_named_child_node)(const struct fwnode_handle *fwnode,
 124                                 const char *name);
 125         int (*get_reference_args)(const struct fwnode_handle *fwnode,
 126                                   const char *prop, const char *nargs_prop,
 127                                   unsigned int nargs, unsigned int index,
 128                                   struct fwnode_reference_args *args);
 129         struct fwnode_handle *
 130         (*graph_get_next_endpoint)(const struct fwnode_handle *fwnode,
 131                                    struct fwnode_handle *prev);
 132         struct fwnode_handle *
 133         (*graph_get_remote_endpoint)(const struct fwnode_handle *fwnode);
 134         struct fwnode_handle *
 135         (*graph_get_port_parent)(struct fwnode_handle *fwnode);
 136         int (*graph_parse_endpoint)(const struct fwnode_handle *fwnode,
 137                                     struct fwnode_endpoint *endpoint);
 138         int (*add_links)(const struct fwnode_handle *fwnode,
 139                          struct device *dev);
 140 };
 141
 142 #define fwnode_has_op(fwnode, op)                               \
 143         ((fwnode) && (fwnode)->ops && (fwnode)->ops->op)
 144 #define fwnode_call_int_op(fwnode, op, ...)                             \
 145         (fwnode ? (fwnode_has_op(fwnode, op) ?                          \
 146                    (fwnode)->ops->op(fwnode, ## __VA_ARGS__) : -ENXIO) : \
 147          -EINVAL)
 148
 149 #define fwnode_call_bool_op(fwnode, op, ...)            \
 150         (fwnode_has_op(fwnode, op) ?                    \
 151          (fwnode)->ops->op(fwnode, ## __VA_ARGS__) : false)
 152
 153 #define fwnode_call_ptr_op(fwnode, op, ...)             \
 154         (fwnode_has_op(fwnode, op) ?                    \
 155          (fwnode)->ops->op(fwnode, ## __VA_ARGS__) : NULL)
 156 #define fwnode_call_void_op(fwnode, op, ...)                            \
 157         do {                                                            \
 158                 if (fwnode_has_op(fwnode, op))                          \
 159                         (fwnode)->ops->op(fwnode, ## __VA_ARGS__);      \
 160         } while (false)
 161 #define get_dev_from_fwnode(fwnode)     get_device((fwnode)->dev)
 162
 163 #endif