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 (do not access outside driver model)
  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  * @flags: Flags for this uclass ``(DM_UC_...)``
  88  */
  89 struct uclass_driver {
  90         const char *name;
  91         enum uclass_id id;
  92         int (*post_bind)(struct udevice *dev);
  93         int (*pre_unbind)(struct udevice *dev);
  94         int (*pre_probe)(struct udevice *dev);
  95         int (*post_probe)(struct udevice *dev);
  96         int (*pre_remove)(struct udevice *dev);
  97         int (*child_post_bind)(struct udevice *dev);
  98         int (*child_pre_probe)(struct udevice *dev);
  99         int (*child_post_probe)(struct udevice *dev);
 100         int (*init)(struct uclass *class);
 101         int (*destroy)(struct uclass *class);
 102         int priv_auto;
 103         int per_device_auto;
 104         int per_device_plat_auto;
 105         int per_child_auto;
 106         int per_child_plat_auto;
 107         uint32_t flags;
 108 };
 109
 110 /* Declare a new uclass_driver */
 111 #define UCLASS_DRIVER(__name)                                           \
 112         ll_entry_declare(struct uclass_driver, __name, uclass_driver)
 113
 114 /*
 115  * These two macros DM_UCLASS_DRIVER_REF and DM_UCLASS_DRIVER_REF are only
 116  * allowed in code generated by dtoc, because the ordering is important and if
 117  * other instances creep in then they may mess up the ordering expected by dtoc.
 118  *
 119  * It is OK to use them with 'extern' though, since that does not actually
 120  * add a new record to the linker_list.
 121  */
 122
 123 /**
 124  * DM_UCLASS_DRIVER_REF() - Get a reference to a uclass driver
 125  *
 126  * This is useful in data structures and code for referencing a uclass_driver at
 127  * build time. Before this is used, an extern UCLASS_DRIVER() must have been
 128  * declared.
 129  *
 130  * For example::
 131  *
 132  *   extern UCLASS_DRIVER(clk);
 133  *   struct uclass_driver *drvs[] = {
 134  *       DM_UCLASS_DRIVER_REF(clk),
 135  *   };
 136  *
 137  * @_name: Name of the uclass_driver. This must be a valid C identifier, used by
 138  *      the linker_list.
 139  * Return: struct uclass_driver * for the uclass driver
 140  */
 141 #define DM_UCLASS_DRIVER_REF(_name)                                     \
 142         ll_entry_ref(struct uclass_driver, _name, uclass_driver)
 143
 144 /**
 145  * uclass_get_priv() - Get the private data for a uclass
 146  *
 147  * @uc: Uclass to check
 148  * Return: private data, or NULL if none
 149  */
 150 void *uclass_get_priv(const struct uclass *uc);
 151
 152 /**
 153  * uclass_get() - Get a uclass based on an ID, creating it if needed
 154  *
 155  * Every uclass is identified by an ID, a number from 0 to n-1 where n is
 156  * the number of uclasses. This function allows looking up a uclass by its
 157  * ID.
 158  *
 159  * @key: ID to look up
 160  * @ucp: Returns pointer to uclass (there is only one per ID)
 161  * Return:
 162  * 0 if OK, -EDEADLK if driver model is not yet inited,
 163  * other -ve on other error
 164  */
 165 int uclass_get(enum uclass_id key, struct uclass **ucp);
 166
 167 /**
 168  * uclass_get_name() - Get the name of a uclass driver
 169  *
 170  * @id: ID to look up
 171  * Return: the name of the uclass driver for that ID, or NULL if none
 172  */
 173 const char *uclass_get_name(enum uclass_id id);
 174
 175 /**
 176  * uclass_get_by_namelen() - Look up a uclass by its driver name
 177  *
 178  * @name: Name to look up
 179  * @len: Length of @name (the uclass driver name must have the same length)
 180  * Return: the associated uclass ID, or UCLASS_INVALID if not found
 181  */
 182 enum uclass_id uclass_get_by_namelen(const char *name, int len);
 183
 184 /**
 185  * uclass_get_by_name() - Look up a uclass by its driver name
 186  *
 187  * @name: Name to look up
 188  * Return: the associated uclass ID, or UCLASS_INVALID if not found
 189  */
 190 enum uclass_id uclass_get_by_name(const char *name);
 191
 192 /**
 193  * uclass_get_device() - Get a uclass device based on an ID and index
 194  *
 195  * The device is probed to activate it ready for use.
 196  *
 197  * @id: ID to look up
 198  * @index: Device number within that uclass (0=first)
 199  * @devp: Returns pointer to device (there is only one per for each ID)
 200  * Return: 0 if OK, -ve on error
 201  */
 202 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp);
 203
 204 /**
 205  * uclass_get_device_by_name() - Get a uclass device by its name
 206  *
 207  * This searches the devices in the uclass for one with the exactly given name.
 208  *
 209  * The device is probed to activate it ready for use.
 210  *
 211  * @id: ID to look up
 212  * @name: name of a device to get
 213  * @devp: Returns pointer to device (the first one with the name)
 214  * Return: 0 if OK, -ve on error
 215  */
 216 int uclass_get_device_by_name(enum uclass_id id, const char *name,
 217                               struct udevice **devp);
 218
 219 /**
 220  * uclass_get_device_by_seq() - Get a uclass device based on an ID and sequence
 221  *
 222  * If an active device has this sequence it will be returned. If there is no
 223  * such device then this will check for a device that is requesting this
 224  * sequence.
 225  *
 226  * The device is probed to activate it ready for use.
 227  *
 228  * @id: ID to look up
 229  * @seq: Sequence number to find (0=first)
 230  * @devp: Returns pointer to device (there is only one for each seq)
 231  * Return: 0 if OK, -ve on error
 232  */
 233 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp);
 234
 235 /**
 236  * uclass_get_device_by_of_offset() - Get a uclass device by device tree node
 237  *
 238  * This searches the devices in the uclass for one attached to the given
 239  * device tree node.
 240  *
 241  * The device is probed to activate it ready for use.
 242  *
 243  * @id: ID to look up
 244  * @node: Device tree offset to search for (if -ve then -ENODEV is returned)
 245  * @devp: Returns pointer to device (there is only one for each node)
 246  * Return: 0 if OK, -ve on error
 247  */
 248 int uclass_get_device_by_of_offset(enum uclass_id id, int node,
 249                                    struct udevice **devp);
 250
 251 /**
 252  * uclass_get_device_by_ofnode() - Get a uclass device by device tree node
 253  *
 254  * This searches the devices in the uclass for one attached to the given
 255  * device tree node.
 256  *
 257  * The device is probed to activate it ready for use.
 258  *
 259  * @id: ID to look up
 260  * @node: Device tree node to search for (if NULL then -ENODEV is returned)
 261  * @devp: Returns pointer to device (there is only one for each node)
 262  * Return: 0 if OK, -ve on error
 263  */
 264 int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
 265                                 struct udevice **devp);
 266
 267 /**
 268  * uclass_get_device_by_phandle_id() - Get a uclass device by phandle id
 269  *
 270  * This searches the devices in the uclass for one with the given phandle id.
 271  *
 272  * The device is probed to activate it ready for use.
 273  *
 274  * @id:         uclass ID to look up
 275  * @phandle_id: the phandle id to look up
 276  * @devp:       Returns pointer to device (there is only one for each node).
 277  *              NULL if there is no such device.
 278  * Return:
 279  * 0 if OK, -ENODEV if there is no device match the phandle,
 280  * other -ve on error
 281  */
 282 int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id,
 283                                     struct udevice **devp);
 284
 285 /**
 286  * uclass_get_device_by_phandle() - Get a uclass device by phandle
 287  *
 288  * This searches the devices in the uclass for one with the given phandle.
 289  *
 290  * The device is probed to activate it ready for use.
 291  *
 292  * @id: uclass ID to look up
 293  * @parent: Parent device containing the phandle pointer
 294  * @name: Name of property in the parent device node
 295  * @devp: Returns pointer to device (there is only one for each node)
 296  * Return: 0 if OK, -ENOENT if there is no @name present in the node, other
 297  * -ve on error
 298  */
 299 int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
 300                                  const char *name, struct udevice **devp);
 301
 302 /**
 303  * uclass_get_device_by_driver() - Get a uclass device for a driver
 304  *
 305  * This searches the devices in the uclass for one that uses the given
 306  * driver. Use DM_DRIVER_GET(name) for the @drv argument, where 'name' is
 307  * the driver name - as used in U_BOOT_DRIVER(name).
 308  *
 309  * The device is probed to activate it ready for use.
 310  *
 311  * @id: ID to look up
 312  * @drv: Driver to look for
 313  * @devp: Returns pointer to the first device with that driver
 314  * Return: 0 if OK, -ve on error
 315  */
 316 int uclass_get_device_by_driver(enum uclass_id id, const struct driver *drv,
 317                                 struct udevice **devp);
 318
 319 /**
 320  * uclass_first_device() - Get the first device in a uclass
 321  *
 322  * The device returned is probed if necessary, and ready for use
 323  *
 324  * This function is useful to start iterating through a list of devices which
 325  * are functioning correctly and can be probed.
 326  *
 327  * @id: Uclass ID to look up
 328  * @devp: Returns pointer to the first device in that uclass if no error
 329  * occurred, or NULL if there is no first device, or an error occurred with
 330  * that device.
 331  * Return: 0 if OK (found or not found), other -ve on error
 332  */
 333 int uclass_first_device(enum uclass_id id, struct udevice **devp);
 334
 335 /**
 336  * uclass_first_device_err() - Get the first device in a uclass
 337  *
 338  * The device returned is probed if necessary, and ready for use
 339  *
 340  * @id: Uclass ID to look up
 341  * @devp: Returns pointer to the first device in that uclass, or NULL if none
 342  * Return: 0 if found, -ENODEV if not found, other -ve on error
 343  */
 344 int uclass_first_device_err(enum uclass_id id, struct udevice **devp);
 345
 346 /**
 347  * uclass_next_device() - Get the next device in a uclass
 348  *
 349  * The device returned is probed if necessary, and ready for use
 350  *
 351  * This function is useful to iterate through a list of devices which
 352  * are functioning correctly and can be probed.
 353  *
 354  * @devp: On entry, pointer to device to lookup. On exit, returns pointer
 355  * to the next device in the uclass if no error occurred, or NULL if there is
 356  * no next device, or an error occurred with that next device.
 357  * Return: 0 if OK (found or not found), other -ve on error
 358  */
 359 int uclass_next_device(struct udevice **devp);
 360
 361 /**
 362  * uclass_next_device_err() - Get the next device in a uclass
 363  *
 364  * The device returned is probed if necessary, and ready for use
 365  *
 366  * @devp: On entry, pointer to device to lookup. On exit, returns pointer
 367  * to the next device in the uclass if no error occurred, or NULL if
 368  * there is no next device.
 369  * Return: 0 if found, -ENODEV if not found, other -ve on error
 370  */
 371 int uclass_next_device_err(struct udevice **devp);
 372
 373 /**
 374  * uclass_first_device_check() - Get the first device in a uclass
 375  *
 376  * The device returned is probed if necessary, and ready for use
 377  *
 378  * This function is useful to start iterating through a list of devices which
 379  * are functioning correctly and can be probed.
 380  *
 381  * @id: Uclass ID to look up
 382  * @devp: Returns pointer to the first device in that uclass, or NULL if there
 383  * is no first device
 384  * Return: 0 if OK (found or not found), other -ve on error. If an error occurs
 385  * it is still possible to move to the next device.
 386  */
 387 int uclass_first_device_check(enum uclass_id id, struct udevice **devp);
 388
 389 /**
 390  * uclass_next_device_check() - Get the next device in a uclass
 391  *
 392  * The device returned is probed if necessary, and ready for use
 393  *
 394  * This function is useful to start iterating through a list of devices which
 395  * are functioning correctly and can be probed.
 396  *
 397  * @devp: On entry, pointer to device to lookup. On exit, returns pointer
 398  * to the next device in the uclass if any
 399  * Return: 0 if OK (found or not found), other -ve on error. If an error occurs
 400  * it is still possible to move to the next device.
 401  */
 402 int uclass_next_device_check(struct udevice **devp);
 403
 404 /**
 405  * uclass_first_device_drvdata() - Find the first device with given driver data
 406  *
 407  * This searches through the devices for a particular uclass looking for one
 408  * that has the given driver data.
 409  *
 410  * @id: Uclass ID to check
 411  * @driver_data: Driver data to search for
 412  * @devp: Returns pointer to the first matching device in that uclass, if found
 413  * Return: 0 if found, -ENODEV if not found, other -ve on error
 414  */
 415 int uclass_first_device_drvdata(enum uclass_id id, ulong driver_data,
 416                                 struct udevice **devp);
 417
 418 /**
 419  * uclass_probe_all() - Probe all devices based on an uclass ID
 420  *
 421  * This function probes all devices associated with a uclass by
 422  * looking for its ID.
 423  *
 424  * @id: uclass ID to look up
 425  * Return: 0 if OK, other -ve on error
 426  */
 427 int uclass_probe_all(enum uclass_id id);
 428
 429 /**
 430  * uclass_id_count() - Count the number of devices in a uclass
 431  *
 432  * @id: uclass ID to look up
 433  * Return: number of devices in that uclass (0 if none)
 434  */
 435 int uclass_id_count(enum uclass_id id);
 436
 437 /**
 438  * uclass_id_foreach_dev() - iterate through devices of a given uclass ID
 439  *
 440  * This creates a for() loop which works through the available devices in
 441  * a uclass ID in order from start to end.
 442  *
 443  * If for some reason the uclass cannot be found, this does nothing.
 444  *
 445  * @id: enum uclass_id ID to use
 446  * @pos: struct udevice * to hold the current device. Set to NULL when there
 447  * are no more devices.
 448  * @uc: temporary uclass variable (``struct uclass *``)
 449  */
 450 #define uclass_id_foreach_dev(id, pos, uc) \
 451         if (!uclass_get(id, &uc)) \
 452                 list_for_each_entry(pos, &uc->dev_head, uclass_node)
 453
 454 /**
 455  * uclass_foreach_dev() - iterate through devices of a given uclass
 456  *
 457  * This creates a for() loop which works through the available devices in
 458  * a uclass in order from start to end.
 459  *
 460  * @pos: struct udevice * to hold the current device. Set to NULL when there
 461  * are no more devices.
 462  * @uc: uclass to scan (`struct uclass *`)
 463  */
 464 #define uclass_foreach_dev(pos, uc)     \
 465         list_for_each_entry(pos, &uc->dev_head, uclass_node)
 466
 467 /**
 468  * uclass_foreach_dev_safe() - safely iterate through devices of a given uclass
 469  *
 470  * This creates a for() loop which works through the available devices in
 471  * a uclass in order from start to end. Inside the loop, it is safe to remove
 472  * @pos if required.
 473  *
 474  * @pos: struct udevice * to hold the current device. Set to NULL when there
 475  * are no more devices.
 476  * @next: struct udevice * to hold the next next
 477  * @uc: uclass to scan (`struct uclass *`)
 478  */
 479 #define uclass_foreach_dev_safe(pos, next, uc)  \
 480         list_for_each_entry_safe(pos, next, &uc->dev_head, uclass_node)
 481
 482 /**
 483  * uclass_foreach_dev_probe() - iterate through devices of a given uclass ID
 484  *
 485  * This creates a for() loop which works through the available devices in
 486  * a uclass in order from start to end. Devices are probed if necessary,
 487  * and ready for use.
 488  *
 489  * @id: Uclass ID
 490  * @dev: struct udevice * to hold the current device. Set to NULL when there
 491  * are no more devices.
 492  */
 493 #define uclass_foreach_dev_probe(id, dev)       \
 494         for (int _ret = uclass_first_device_err(id, &dev); !_ret && dev; \
 495              _ret = uclass_next_device_err(&dev))
 496
 497 #endif