SPDX: Convert all of our single license tags to Linux Kernel style
[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  */
26 struct driver_info {
27         const char *name;
28         const void *platdata;
29 #if CONFIG_IS_ENABLED(OF_PLATDATA)
30         uint platdata_size;
31 #endif
32 };
33
34 /**
35  * NOTE: Avoid using these except in extreme circumstances, where device tree
36  * is not feasible (e.g. serial driver in SPL where <8KB of SRAM is
37  * available). U-Boot's driver model uses device tree for configuration.
38  */
39 #define U_BOOT_DEVICE(__name)                                           \
40         ll_entry_declare(struct driver_info, __name, driver_info)
41
42 /* Declare a list of devices. The argument is a driver_info[] array */
43 #define U_BOOT_DEVICES(__name)                                          \
44         ll_entry_declare_list(struct driver_info, __name, driver_info)
45
46 #endif