Merge tag 'u-boot-clk-24Aug2020' of https://gitlab.denx.de/u-boot/custodians/u-boot-clk
[platform/kernel/u-boot.git] / 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 /* Get a pointer to a given driver */
49 #define DM_GET_DEVICE(__name)                                           \
50         ll_entry_get(struct driver_info, __name, driver_info)
51
52 /**
53  * dm_populate_phandle_data() - Populates phandle data in platda
54  *
55  * This populates phandle data with an U_BOOT_DEVICE entry get by
56  * DM_GET_DEVICE. The implementation of this function will be done
57  * by dtoc when parsing dtb.
58  */
59 void dm_populate_phandle_data(void);
60 #endif