xref: /freebsd/sys/dev/fdt/fdt_common.h (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2009-2010 The FreeBSD Foundation
5  *
6  * This software was developed by Semihalf under sponsorship from
7  * the FreeBSD Foundation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * $FreeBSD$
31  */
32 
33 #ifndef _FDT_COMMON_H_
34 #define _FDT_COMMON_H_
35 
36 #include <sys/sysctl.h>
37 #include <sys/slicer.h>
38 #include <contrib/libfdt/libfdt_env.h>
39 #include <dev/ofw/ofw_bus.h>
40 
41 #define FDT_MEM_REGIONS	16
42 
43 #define DI_MAX_INTR_NUM	32
44 
45 struct fdt_sense_level {
46 	enum intr_trigger	trig;
47 	enum intr_polarity	pol;
48 };
49 
50 #if defined(__arm__) && !defined(INTRNG)
51 typedef int (*fdt_pic_decode_t)(phandle_t, pcell_t *, int *, int *, int *);
52 extern fdt_pic_decode_t fdt_pic_table[];
53 #endif
54 
55 #if defined(__arm__) || defined(__powerpc__)
56 typedef void (*fdt_fixup_t)(phandle_t);
57 struct fdt_fixup_entry {
58 	char		*model;
59 	fdt_fixup_t	handler;
60 };
61 extern struct fdt_fixup_entry fdt_fixup_table[];
62 #endif
63 
64 extern SLIST_HEAD(fdt_ic_list, fdt_ic) fdt_ic_list_head;
65 struct fdt_ic {
66 	SLIST_ENTRY(fdt_ic)	fdt_ics;
67 	ihandle_t		iph;
68 	device_t		dev;
69 };
70 
71 extern vm_paddr_t fdt_immr_pa;
72 extern vm_offset_t fdt_immr_va;
73 extern vm_offset_t fdt_immr_size;
74 
75 #if defined(FDT_DTB_STATIC)
76 extern u_char fdt_static_dtb;
77 #endif
78 
79 SYSCTL_DECL(_hw_fdt);
80 
81 int fdt_addrsize_cells(phandle_t, int *, int *);
82 u_long fdt_data_get(void *, int);
83 int fdt_data_to_res(pcell_t *, int, int, u_long *, u_long *);
84 phandle_t fdt_find_compatible(phandle_t, const char *, int);
85 phandle_t fdt_depth_search_compatible(phandle_t, const char *, int);
86 int fdt_get_mem_regions(struct mem_region *, int *, uint64_t *);
87 int fdt_get_reserved_mem(struct mem_region *, int *);
88 int fdt_get_reserved_regions(struct mem_region *, int *);
89 int fdt_get_phyaddr(phandle_t, device_t, int *, void **);
90 int fdt_get_range(phandle_t, int, u_long *, u_long *);
91 int fdt_immr_addr(vm_offset_t);
92 int fdt_regsize(phandle_t, u_long *, u_long *);
93 int fdt_is_compatible_strict(phandle_t, const char *);
94 int fdt_parent_addr_cells(phandle_t);
95 int fdt_get_chosen_bootargs(char *bootargs, size_t max_size);
96 
97 #endif /* _FDT_COMMON_H_ */
98