dm: core: Add a comment about the device_remove() flags
[platform/kernel/u-boot.git] / include / dm / platdata.h
1 /*
2  * Copyright (c) 2013 Google, Inc
3  *
4  * (C) Copyright 2012
5  * Pavel Herrmann <morpheus.ibis@gmail.com>
6  * Marek Vasut <marex@denx.de>
7  *
8  * SPDX-License-Identifier:     GPL-2.0+
9  */
10
11 #ifndef _DM_PLATDATA_H
12 #define _DM_PLATDATA_H
13
14 #include <linker_lists.h>
15
16 /**
17  * struct driver_info - Information required to instantiate a device
18  *
19  * NOTE: Avoid using this except in extreme circumstances, where device tree
20  * is not feasible (e.g. serial driver in SPL where <8KB of SRAM is
21  * available). U-Boot's driver model uses device tree for configuration.
22  *
23  * @name:       Driver name
24  * @platdata:   Driver-specific platform data
25  * @platdata_size: Size of platform data structure
26  * @flags:      Platform data flags (DM_FLAG_...)
27  */
28 struct driver_info {
29         const char *name;
30         const void *platdata;
31 #if CONFIG_IS_ENABLED(OF_PLATDATA)
32         uint platdata_size;
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 #endif