include/dm/platdata.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  * Marek Vasut <marex@denx.de>
   8  */
   9
  10 #ifndef _DM_PLATDATA_H
  11 #define _DM_PLATDATA_H
  12
  13 #include <linker_lists.h>
  14
  15 /**
  16  * struct driver_info - Information required to instantiate a device
  17  *
  18  * NOTE: Avoid using this except in extreme circumstances, where device tree
  19  * is not feasible (e.g. serial driver in SPL where <8KB of SRAM is
  20  * available). U-Boot's driver model uses device tree for configuration.
  21  *
  22  * @name:       Driver name
  23  * @platdata:   Driver-specific platform data
  24  * @platdata_size: Size of platform data structure
  25  * @dev:        Device created from this structure data
  26  */
  27 struct driver_info {
  28         const char *name;
  29         const void *platdata;
  30 #if CONFIG_IS_ENABLED(OF_PLATDATA)
  31         uint platdata_size;
  32         struct udevice *dev;
  33 #endif
  34 };
  35
  36 /**
  37  * NOTE: Avoid using these except in extreme circumstances, where device tree
  38  * is not feasible (e.g. serial driver in SPL where <8KB of SRAM is
  39  * available). U-Boot's driver model uses device tree for configuration.
  40  */
  41 #define U_BOOT_DEVICE(__name)                                           \
  42         ll_entry_declare(struct driver_info, __name, driver_info)
  43
  44 /* Declare a list of devices. The argument is a driver_info[] array */
  45 #define U_BOOT_DEVICES(__name)                                          \
  46         ll_entry_declare_list(struct driver_info, __name, driver_info)
  47
  48 /**
  49  * Get a pointer to a given device info given its name
  50  *
  51  * With the declaration U_BOOT_DEVICE(name), DM_GET_DEVICE(name) will return a
  52  * pointer to the struct driver_info created by that declaration.
  53  *
  54  * if OF_PLATDATA is enabled, from this it is possible to use the @dev member of
  55  * struct driver_info to find the device pointer itself.
  56  *
  57  * TODO(sjg@chromium.org): U_BOOT_DEVICE() tells U-Boot to create a device, so
  58  * the naming seems sensible, but DM_GET_DEVICE() is a bit of misnomer, since it
  59  * finds the driver_info record, not the device.
  60  *
  61  * @__name: Driver name (C identifier, not a string. E.g. gpio7_at_ff7e0000)
  62  * @return struct driver_info * to the driver that created the device
  63  */
  64 #define DM_GET_DEVICE(__name)                                           \
  65         ll_entry_get(struct driver_info, __name, driver_info)
  66
  67 /**
  68  * dm_populate_phandle_data() - Populates phandle data in platda
  69  *
  70  * This populates phandle data with an U_BOOT_DEVICE entry get by
  71  * DM_GET_DEVICE. The implementation of this function will be done
  72  * by dtoc when parsing dtb.
  73  */
  74 void dm_populate_phandle_data(void);
  75 #endif