xref: /optee_os/core/include/kernel/dt.h (revision a4f139d7fc30f5de9b7cd822b83495b22597fd5b)
1 /*
2  * Copyright (c) 2016, Linaro Limited
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  * POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef KERNEL_DT_H
29 #define KERNEL_DT_H
30 
31 #include <compiler.h>
32 #include <stdint.h>
33 #include <types_ext.h>
34 
35 #if defined(CFG_DT)
36 
37 /*
38  * DT-aware drivers
39  */
40 
41 struct dt_device_match {
42 	const char *compatible;
43 };
44 
45 struct dt_driver {
46 	const char *name;
47 	const struct dt_device_match *match_table; /* null-terminated */
48 	const void *driver;
49 };
50 
51 #define __dt_driver __section(".rodata.dtdrv")
52 
53 extern const struct dt_driver __rodata_dtdrv_start, __rodata_dtdrv_end;
54 
55 /*
56  * Find a driver that is suitable for the given DT node, that is, with
57  * a matching "compatible" property.
58  *
59  * @fdt: pointer to the device tree
60  * @offs: node offset
61  */
62 const struct dt_driver *dt_find_compatible_driver(const void *fdt, int offs);
63 
64 const struct dt_driver *__dt_driver_start(void);
65 
66 const struct dt_driver *__dt_driver_end(void);
67 
68 #else
69 
70 static inline const struct dt_driver *__dt_driver_start(void)
71 {
72 	return NULL;
73 }
74 
75 static inline const struct dt_driver *__dt_driver_end(void)
76 {
77 	return NULL;
78 }
79 
80 static inline const struct dt_driver *dt_find_compatible_driver(
81 					const void *fdt __unused,
82 					int offs __unused)
83 {
84 	return NULL;
85 }
86 
87 #endif /* !CFG_DT */
88 
89 #define for_each_dt_driver(drv) \
90 	for (drv = __dt_driver_start(); drv < __dt_driver_end(); drv++)
91 
92 #endif /* KERNEL_DT_H */
93