include/dm/lists.h

   1 /*
   2  * Copyright (c) 2013 Google, Inc
   3  *
   4  * (C) Copyright 2012
   5  * Pavel Herrmann <morpheus.ibis@gmail.com>
   6  *
   7  * SPDX-License-Identifier:     GPL-2.0+
   8  */
   9
  10 #ifndef _DM_LISTS_H_
  11 #define _DM_LISTS_H_
  12
  13 #include <dm/uclass-id.h>
  14
  15 /**
  16  * lists_driver_lookup_name() - Return u_boot_driver corresponding to name
  17  *
  18  * This function returns a pointer to a driver given its name. This is used
  19  * for binding a driver given its name and platdata.
  20  *
  21  * @name: Name of driver to look up
  22  * @return pointer to driver, or NULL if not found
  23  */
  24 struct driver *lists_driver_lookup_name(const char *name);
  25
  26 /**
  27  * lists_uclass_lookup() - Return uclass_driver based on ID of the class
  28  * id:          ID of the class
  29  *
  30  * This function returns the pointer to uclass_driver, which is the class's
  31  * base structure based on the ID of the class. Returns NULL on error.
  32  */
  33 struct uclass_driver *lists_uclass_lookup(enum uclass_id id);
  34
  35 /**
  36  * lists_bind_drivers() - search for and bind all drivers to parent
  37  *
  38  * This searches the U_BOOT_DEVICE() structures and creates new devices for
  39  * each one. The devices will have @parent as their parent.
  40  *
  41  * @parent: parent device (root)
  42  * @early_only: If true, bind only drivers with the DM_INIT_F flag. If false
  43  * bind all drivers.
  44  */
  45 int lists_bind_drivers(struct udevice *parent, bool pre_reloc_only);
  46
  47 /**
  48  * lists_bind_fdt() - bind a device tree node
  49  *
  50  * This creates a new device bound to the given device tree node, with
  51  * @parent as its parent.
  52  *
  53  * @parent: parent device (root)
  54  * @blob: device tree blob
  55  * @offset: offset of this device tree node
  56  * @devp: if non-NULL, returns a pointer to the bound device
  57  * @return 0 if device was bound, -EINVAL if the device tree is invalid,
  58  * other -ve value on error
  59  */
  60 int lists_bind_fdt(struct udevice *parent, const void *blob, int offset,
  61                    struct udevice **devp);
  62
  63 /**
  64  * device_bind_driver() - bind a device to a driver
  65  *
  66  * This binds a new device to a driver.
  67  *
  68  * @parent:     Parent device
  69  * @drv_name:   Name of driver to attach to this parent
  70  * @dev_name:   Name of the new device thus created
  71  * @devp:       If non-NULL, returns the newly bound device
  72  */
  73 int device_bind_driver(struct udevice *parent, const char *drv_name,
  74                        const char *dev_name, struct udevice **devp);
  75
  76 /**
  77  * device_bind_driver_to_node() - bind a device to a driver for a node
  78  *
  79  * This binds a new device to a driver for a given device tree node. This
  80  * should only be needed if the node lacks a compatible strings.
  81  *
  82  * @parent:     Parent device
  83  * @drv_name:   Name of driver to attach to this parent
  84  * @dev_name:   Name of the new device thus created
  85  * @node:       Device tree node
  86  * @devp:       If non-NULL, returns the newly bound device
  87  */
  88 int device_bind_driver_to_node(struct udevice *parent, const char *drv_name,
  89                                const char *dev_name, int node,
  90                                struct udevice **devp);
  91
  92 #endif