include/dm/root.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_ROOT_H_
  10 #define _DM_ROOT_H_
  11
  12 struct udevice;
  13
  14 /**
  15  * dm_root() - Return pointer to the top of the driver tree
  16  *
  17  * This function returns pointer to the root node of the driver tree,
  18  *
  19  * @return pointer to root device, or NULL if not inited yet
  20  */
  21 struct udevice *dm_root(void);
  22
  23 struct global_data;
  24 /**
  25  * dm_fixup_for_gd_move() - Handle global_data moving to a new place
  26  *
  27  * The uclass list is part of global_data. Due to the way lists work, moving
  28  * the list will cause it to become invalid. This function fixes that up so
  29  * that the uclass list will work correctly.
  30  */
  31 void dm_fixup_for_gd_move(struct global_data *new_gd);
  32
  33 /**
  34  * dm_scan_platdata() - Scan all platform data and bind drivers
  35  *
  36  * This scans all available platdata and creates drivers for each
  37  *
  38  * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC
  39  * flag. If false bind all drivers.
  40  * @return 0 if OK, -ve on error
  41  */
  42 int dm_scan_platdata(bool pre_reloc_only);
  43
  44 /**
  45  * dm_scan_fdt() - Scan the device tree and bind drivers
  46  *
  47  * This scans the device tree and creates a driver for each node. Only
  48  * the top-level subnodes are examined.
  49  *
  50  * @blob: Pointer to device tree blob
  51  * @pre_reloc_only: If true, bind only nodes with special devicetree properties,
  52  * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
  53  * @return 0 if OK, -ve on error
  54  */
  55 int dm_scan_fdt(const void *blob, bool pre_reloc_only);
  56
  57 /**
  58  * dm_extended_scan_fdt() - Scan the device tree and bind drivers
  59  *
  60  * This calls dm_scna_dft() which scans the device tree and creates a driver
  61  * for each node. the top-level subnodes are examined and also all sub-nodes
  62  * of "clocks" node.
  63  *
  64  * @blob: Pointer to device tree blob
  65  * @pre_reloc_only: If true, bind only nodes with special devicetree properties,
  66  * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
  67  * @return 0 if OK, -ve on error
  68  */
  69 int dm_extended_scan_fdt(const void *blob, bool pre_reloc_only);
  70
  71 /**
  72  * dm_scan_other() - Scan for other devices
  73  *
  74  * Some devices may not be visible to Driver Model. This weak function can
  75  * be provided by boards which wish to create their own devices
  76  * programmaticaly. They should do this by calling device_bind() on each
  77  * device.
  78  *
  79  * @pre_reloc_only: If true, bind only nodes with special devicetree properties,
  80  * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
  81  * @return 0 if OK, -ve on error
  82  */
  83 int dm_scan_other(bool pre_reloc_only);
  84
  85 /**
  86  * dm_init_and_scan() - Initialise Driver Model structures and scan for devices
  87  *
  88  * This function initialises the roots of the driver tree and uclass trees,
  89  * then scans and binds available devices from platform data and the FDT.
  90  * This calls dm_init() to set up Driver Model structures.
  91  *
  92  * @pre_reloc_only: If true, bind only nodes with special devicetree properties,
  93  * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
  94  * @return 0 if OK, -ve on error
  95  */
  96 int dm_init_and_scan(bool pre_reloc_only);
  97
  98 /**
  99  * dm_init() - Initialise Driver Model structures
 100  *
 101  * This function will initialize roots of driver tree and class tree.
 102  * This needs to be called before anything uses the DM
 103  *
 104  * @of_live:    Enable live device tree
 105  * @return 0 if OK, -ve on error
 106  */
 107 int dm_init(bool of_live);
 108
 109 /**
 110  * dm_uninit - Uninitialise Driver Model structures
 111  *
 112  * All devices will be removed and unbound
 113  * @return 0 if OK, -ve on error
 114  */
 115 int dm_uninit(void);
 116
 117 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
 118 /**
 119  * dm_remove_devices_flags - Call remove function of all drivers with
 120  *                           specific removal flags set to selectively
 121  *                           remove drivers
 122  *
 123  * All devices with the matching flags set will be removed
 124  *
 125  * @flags: Flags for selective device removal
 126  * @return 0 if OK, -ve on error
 127  */
 128 int dm_remove_devices_flags(uint flags);
 129 #else
 130 static inline int dm_remove_devices_flags(uint flags) { return 0; }
 131 #endif
 132
 133 #endif