include/dm/uclass.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright (c) 2013 Google, Inc
   4  *
   5  * (C) Copyright 2012
   6  * Pavel Herrmann <morpheus.ibis@gmail.com>
   7  */
   8
   9 #ifndef _DM_UCLASS_H
  10 #define _DM_UCLASS_H
  11
  12 #include <dm/ofnode.h>
  13 #include <dm/uclass-id.h>
  14 #include <linker_lists.h>
  15 #include <linux/list.h>
  16
  17 /**
  18  * struct uclass - a U-Boot drive class, collecting together similar drivers
  19  *
  20  * A uclass provides an interface to a particular function, which is
  21  * implemented by one or more drivers. Every driver belongs to a uclass even
  22  * if it is the only driver in that uclass. An example uclass is GPIO, which
  23  * provides the ability to change read inputs, set and clear outputs, etc.
  24  * There may be drivers for on-chip SoC GPIO banks, I2C GPIO expanders and
  25  * PMIC IO lines, all made available in a unified way through the uclass.
  26  *
  27  * @priv: Private data for this uclass
  28  * @uc_drv: The driver for the uclass itself, not to be confused with a
  29  * 'struct driver'
  30  * @dev_head: List of devices in this uclass (devices are attached to their
  31  * uclass when their bind method is called)
  32  * @sibling_node: Next uclass in the linked list of uclasses
  33  */
  34 struct uclass {
  35         void *priv;
  36         struct uclass_driver *uc_drv;
  37         struct list_head dev_head;
  38         struct list_head sibling_node;
  39 };
  40
  41 struct driver;
  42 struct udevice;
  43
  44 /* Members of this uclass sequence themselves with aliases */
  45 #define DM_UC_FLAG_SEQ_ALIAS                    (1 << 0)
  46
  47 /* Members of this uclass without aliases don't get a sequence number */
  48 #define DM_UC_FLAG_NO_AUTO_SEQ                  (1 << 1)
  49
  50 /* Same as DM_FLAG_ALLOC_PRIV_DMA */
  51 #define DM_UC_FLAG_ALLOC_PRIV_DMA               (1 << 5)
  52
  53 /**
  54  * struct uclass_driver - Driver for the uclass
  55  *
  56  * A uclass_driver provides a consistent interface to a set of related
  57  * drivers.
  58  *
  59  * @name: Name of uclass driver
  60  * @id: ID number of this uclass
  61  * @post_bind: Called after a new device is bound to this uclass
  62  * @pre_unbind: Called before a device is unbound from this uclass
  63  * @pre_probe: Called before a new device is probed
  64  * @post_probe: Called after a new device is probed
  65  * @pre_remove: Called before a device is removed
  66  * @child_post_bind: Called after a child is bound to a device in this uclass
  67  * @child_pre_probe: Called before a child in this uclass is probed
  68  * @child_post_probe: Called after a child in this uclass is probed
  69  * @init: Called to set up the uclass
  70  * @destroy: Called to destroy the uclass
  71  * @priv_auto: If non-zero this is the size of the private data
  72  * to be allocated in the uclass's ->priv pointer. If zero, then the uclass
  73  * driver is responsible for allocating any data required.
  74  * @per_device_auto: Each device can hold private data owned
  75  * by the uclass. If required this will be automatically allocated if this
  76  * value is non-zero.
  77  * @per_device_plat_auto: Each device can hold platform data
  78  * owned by the uclass as 'dev->uclass_plat'. If the value is non-zero,
  79  * then this will be automatically allocated.
  80  * @per_child_auto: Each child device (of a parent in this
  81  * uclass) can hold parent data for the device/uclass. This value is only
  82  * used as a fallback if this member is 0 in the driver.
  83  * @per_child_plat_auto: A bus likes to store information about
  84  * its children. If non-zero this is the size of this data, to be allocated
  85  * in the child device's parent_plat pointer. This value is only used as
  86  * a fallback if this member is 0 in the driver.
  87  * @ops: Uclass operations, providing the consistent interface to devices
  88  * within the uclass.
  89  * @flags: Flags for this uclass (DM_UC_...)
  90  */
  91 struct uclass_driver {
  92         const char *name;
  93         enum uclass_id id;
  94         int (*post_bind)(struct udevice *dev);
  95         int (*pre_unbind)(struct udevice *dev);
  96         int (*pre_probe)(struct udevice *dev);
  97         int (*post_probe)(struct udevice *dev);
  98         int (*pre_remove)(struct udevice *dev);
  99         int (*child_post_bind)(struct udevice *dev);
 100         int (*child_pre_probe)(struct udevice *dev);
 101         int (*child_post_probe)(struct udevice *dev);
 102         int (*init)(struct uclass *class);
 103         int (*destroy)(struct uclass *class);
 104         int priv_auto;
 105         int per_device_auto;
 106         int per_device_plat_auto;
 107         int per_child_auto;
 108         int per_child_plat_auto;
 109         const void *ops;
 110         uint32_t flags;
 111 };
 112
 113 /* Declare a new uclass_driver */
 114 #define UCLASS_DRIVER(__name)                                           \
 115         ll_entry_declare(struct uclass_driver, __name, uclass)
 116
 117 /**
 118  * uclass_get() - Get a uclass based on an ID, creating it if needed
 119  *
 120  * Every uclass is identified by an ID, a number from 0 to n-1 where n is
 121  * the number of uclasses. This function allows looking up a uclass by its
 122  * ID.
 123  *
 124  * @key: ID to look up
 125  * @ucp: Returns pointer to uclass (there is only one per ID)
 126  * @return 0 if OK, -ve on error
 127  */
 128 int uclass_get(enum uclass_id key, struct uclass **ucp);
 129
 130 /**
 131  * uclass_get_name() - Get the name of a uclass driver
 132  *
 133  * @id: ID to look up
 134  * @returns the name of the uclass driver for that ID, or NULL if none
 135  */
 136 const char *uclass_get_name(enum uclass_id id);
 137
 138 /**
 139  * uclass_get_by_name() - Look up a uclass by its driver name
 140  *
 141  * @name: Name to look up
 142  * @returns the associated uclass ID, or UCLASS_INVALID if not found
 143  */
 144 enum uclass_id uclass_get_by_name(const char *name);
 145
 146 /**
 147  * uclass_get_device() - Get a uclass device based on an ID and index
 148  *
 149  * The device is probed to activate it ready for use.
 150  *
 151  * @id: ID to look up
 152  * @index: Device number within that uclass (0=first)
 153  * @devp: Returns pointer to device (there is only one per for each ID)
 154  * @return 0 if OK, -ve on error
 155  */
 156 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp);
 157
 158 /**
 159  * uclass_get_device_by_name() - Get a uclass device by its name
 160  *
 161  * This searches the devices in the uclass for one with the exactly given name.
 162  *
 163  * The device is probed to activate it ready for use.
 164  *
 165  * @id: ID to look up
 166  * @name: name of a device to get
 167  * @devp: Returns pointer to device (the first one with the name)
 168  * @return 0 if OK, -ve on error
 169  */
 170 int uclass_get_device_by_name(enum uclass_id id, const char *name,
 171                               struct udevice **devp);
 172
 173 /**
 174  * uclass_get_device_by_seq() - Get a uclass device based on an ID and sequence
 175  *
 176  * If an active device has this sequence it will be returned. If there is no
 177  * such device then this will check for a device that is requesting this
 178  * sequence.
 179  *
 180  * The device is probed to activate it ready for use.
 181  *
 182  * @id: ID to look up
 183  * @seq: Sequence number to find (0=first)
 184  * @devp: Returns pointer to device (there is only one for each seq)
 185  * @return 0 if OK, -ve on error
 186  */
 187 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp);
 188
 189 /**
 190  * uclass_get_device_by_of_offset() - Get a uclass device by device tree node
 191  *
 192  * This searches the devices in the uclass for one attached to the given
 193  * device tree node.
 194  *
 195  * The device is probed to activate it ready for use.
 196  *
 197  * @id: ID to look up
 198  * @node: Device tree offset to search for (if -ve then -ENODEV is returned)
 199  * @devp: Returns pointer to device (there is only one for each node)
 200  * @return 0 if OK, -ve on error
 201  */
 202 int uclass_get_device_by_of_offset(enum uclass_id id, int node,
 203                                    struct udevice **devp);
 204
 205 /**
 206  * uclass_get_device_by_ofnode() - Get a uclass device by device tree node
 207  *
 208  * This searches the devices in the uclass for one attached to the given
 209  * device tree node.
 210  *
 211  * The device is probed to activate it ready for use.
 212  *
 213  * @id: ID to look up
 214  * @np: Device tree node to search for (if NULL then -ENODEV is returned)
 215  * @devp: Returns pointer to device (there is only one for each node)
 216  * @return 0 if OK, -ve on error
 217  */
 218 int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
 219                                 struct udevice **devp);
 220
 221 /**
 222  * uclass_get_device_by_phandle_id() - Get a uclass device by phandle id
 223  *
 224  * This searches the devices in the uclass for one with the given phandle id.
 225  *
 226  * The device is probed to activate it ready for use.
 227  *
 228  * @id: uclass ID to look up
 229  * @phandle_id: the phandle id to look up
 230  * @devp: Returns pointer to device (there is only one for each node). NULL if
 231  *      there is no such device.
 232  * @return 0 if OK, -ENODEV if there is no device match the phandle, other
 233  *      -ve on error
 234  */
 235 int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id,
 236                                     struct udevice **devp);
 237
 238 /**
 239  * uclass_get_device_by_phandle() - Get a uclass device by phandle
 240  *
 241  * This searches the devices in the uclass for one with the given phandle.
 242  *
 243  * The device is probed to activate it ready for use.
 244  *
 245  * @id: uclass ID to look up
 246  * @parent: Parent device containing the phandle pointer
 247  * @name: Name of property in the parent device node
 248  * @devp: Returns pointer to device (there is only one for each node)
 249  * @return 0 if OK, -ENOENT if there is no @name present in the node, other
 250  *      -ve on error
 251  */
 252 int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
 253                                  const char *name, struct udevice **devp);
 254
 255 /**
 256  * uclass_get_device_by_driver() - Get a uclass device for a driver
 257  *
 258  * This searches the devices in the uclass for one that uses the given
 259  * driver. Use DM_GET_DRIVER(name) for the @drv argument, where 'name' is
 260  * the driver name - as used in U_BOOT_DRIVER(name).
 261  *
 262  * The device is probed to activate it ready for use.
 263  *
 264  * @id: ID to look up
 265  * @drv: Driver to look for
 266  * @devp: Returns pointer to the first device with that driver
 267  * @return 0 if OK, -ve on error
 268  */
 269 int uclass_get_device_by_driver(enum uclass_id id, const struct driver *drv,
 270                                 struct udevice **devp);
 271
 272 /**
 273  * uclass_first_device() - Get the first device in a uclass
 274  *
 275  * The device returned is probed if necessary, and ready for use
 276  *
 277  * This function is useful to start iterating through a list of devices which
 278  * are functioning correctly and can be probed.
 279  *
 280  * @id: Uclass ID to look up
 281  * @devp: Returns pointer to the first device in that uclass if no error
 282  * occurred, or NULL if there is no first device, or an error occurred with
 283  * that device.
 284  * @return 0 if OK (found or not found), other -ve on error
 285  */
 286 int uclass_first_device(enum uclass_id id, struct udevice **devp);
 287
 288 /**
 289  * uclass_first_device_err() - Get the first device in a uclass
 290  *
 291  * The device returned is probed if necessary, and ready for use
 292  *
 293  * @id: Uclass ID to look up
 294  * @devp: Returns pointer to the first device in that uclass, or NULL if none
 295  * @return 0 if found, -ENODEV if not found, other -ve on error
 296  */
 297 int uclass_first_device_err(enum uclass_id id, struct udevice **devp);
 298
 299 /**
 300  * uclass_next_device() - Get the next device in a uclass
 301  *
 302  * The device returned is probed if necessary, and ready for use
 303  *
 304  * This function is useful to iterate through a list of devices which
 305  * are functioning correctly and can be probed.
 306  *
 307  * @devp: On entry, pointer to device to lookup. On exit, returns pointer
 308  * to the next device in the uclass if no error occurred, or NULL if there is
 309  * no next device, or an error occurred with that next device.
 310  * @return 0 if OK (found or not found), other -ve on error
 311  */
 312 int uclass_next_device(struct udevice **devp);
 313
 314 /**
 315  * uclass_next_device_err() - Get the next device in a uclass
 316  *
 317  * The device returned is probed if necessary, and ready for use
 318  *
 319  * @devp: On entry, pointer to device to lookup. On exit, returns pointer
 320  * to the next device in the uclass if no error occurred, or -ENODEV if
 321  * there is no next device.
 322  * @return 0 if found, -ENODEV if not found, other -ve on error
 323  */
 324 int uclass_next_device_err(struct udevice **devp);
 325
 326 /**
 327  * uclass_first_device_check() - Get the first device in a uclass
 328  *
 329  * The device returned is probed if necessary, and ready for use
 330  *
 331  * This function is useful to start iterating through a list of devices which
 332  * are functioning correctly and can be probed.
 333  *
 334  * @id: Uclass ID to look up
 335  * @devp: Returns pointer to the first device in that uclass, or NULL if there
 336  * is no first device
 337  * @return 0 if OK (found or not found), other -ve on error. If an error occurs
 338  * it is still possible to move to the next device.
 339  */
 340 int uclass_first_device_check(enum uclass_id id, struct udevice **devp);
 341
 342 /**
 343  * uclass_next_device_check() - Get the next device in a uclass
 344  *
 345  * The device returned is probed if necessary, and ready for use
 346  *
 347  * This function is useful to start iterating through a list of devices which
 348  * are functioning correctly and can be probed.
 349  *
 350  * @devp: On entry, pointer to device to lookup. On exit, returns pointer
 351  * to the next device in the uclass if any
 352  * @return 0 if OK (found or not found), other -ve on error. If an error occurs
 353  * it is still possible to move to the next device.
 354  */
 355 int uclass_next_device_check(struct udevice **devp);
 356
 357 /**
 358  * uclass_first_device_drvdata() - Find the first device with given driver data
 359  *
 360  * This searches through the devices for a particular uclass looking for one
 361  * that has the given driver data.
 362  *
 363  * @id: Uclass ID to check
 364  * @driver_data: Driver data to search for
 365  * @devp: Returns pointer to the first matching device in that uclass, if found
 366  * @return 0 if found, -ENODEV if not found, other -ve on error
 367  */
 368 int uclass_first_device_drvdata(enum uclass_id id, ulong driver_data,
 369                                 struct udevice **devp);
 370
 371 /**
 372  * uclass_resolve_seq() - Resolve a device's sequence number
 373  *
 374  * On entry dev->seq is -1, and dev->req_seq may be -1 (to allocate a
 375  * sequence number automatically, or >= 0 to select a particular number.
 376  * If the requested sequence number is in use, then this device will
 377  * be allocated another one.
 378  *
 379  * Note that the device's seq value is not changed by this function.
 380  *
 381  * @dev: Device for which to allocate sequence number
 382  * @return sequence number allocated, or -ve on error
 383  */
 384 int uclass_resolve_seq(struct udevice *dev);
 385
 386 /**
 387  * uclass_id_foreach_dev() - Helper function to iteration through devices
 388  *
 389  * This creates a for() loop which works through the available devices in
 390  * a uclass ID in order from start to end.
 391  *
 392  * If for some reason the uclass cannot be found, this does nothing.
 393  *
 394  * @id: enum uclass_id ID to use
 395  * @pos: struct udevice * to hold the current device. Set to NULL when there
 396  * are no more devices.
 397  * @uc: temporary uclass variable (struct uclass *)
 398  */
 399 #define uclass_id_foreach_dev(id, pos, uc) \
 400         if (!uclass_get(id, &uc)) \
 401                 list_for_each_entry(pos, &uc->dev_head, uclass_node)
 402
 403 /**
 404  * uclass_foreach_dev() - Helper function to iteration through devices
 405  *
 406  * This creates a for() loop which works through the available devices in
 407  * a uclass in order from start to end.
 408  *
 409  * @pos: struct udevice * to hold the current device. Set to NULL when there
 410  * are no more devices.
 411  * @uc: uclass to scan
 412  */
 413 #define uclass_foreach_dev(pos, uc)     \
 414         list_for_each_entry(pos, &uc->dev_head, uclass_node)
 415
 416 /**
 417  * uclass_foreach_dev_safe() - Helper function to safely iteration through devs
 418  *
 419  * This creates a for() loop which works through the available devices in
 420  * a uclass in order from start to end. Inside the loop, it is safe to remove
 421  * @pos if required.
 422  *
 423  * @pos: struct udevice * to hold the current device. Set to NULL when there
 424  * are no more devices.
 425  * @next: struct udevice * to hold the next next
 426  * @uc: uclass to scan
 427  */
 428 #define uclass_foreach_dev_safe(pos, next, uc)  \
 429         list_for_each_entry_safe(pos, next, &uc->dev_head, uclass_node)
 430
 431 /**
 432  * uclass_foreach_dev_probe() - Helper function to iteration through devices
 433  * of given uclass
 434  *
 435  * This creates a for() loop which works through the available devices in
 436  * a uclass in order from start to end. Devices are probed if necessary,
 437  * and ready for use.
 438  *
 439  * @id: Uclass ID
 440  * @dev: struct udevice * to hold the current device. Set to NULL when there
 441  * are no more devices.
 442  */
 443 #define uclass_foreach_dev_probe(id, dev)       \
 444         for (int _ret = uclass_first_device_err(id, &dev); !_ret && dev; \
 445              _ret = uclass_next_device_err(&dev))
 446
 447 #endif