1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
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
31#ifndef _FDT_COMMON_H_
32#define _FDT_COMMON_H_
33
34#include <sys/sysctl.h>
35#include <sys/slicer.h>
36#include <contrib/libfdt/libfdt_env.h>
37#include <dev/ofw/ofw_bus.h>
38
39#define FDT_MEM_REGIONS	16
40
41#define DI_MAX_INTR_NUM	32
42
43struct fdt_sense_level {
44	enum intr_trigger	trig;
45	enum intr_polarity	pol;
46};
47
48#if defined(__arm__) && !defined(INTRNG)
49typedef int (*fdt_pic_decode_t)(phandle_t, pcell_t *, int *, int *, int *);
50extern fdt_pic_decode_t fdt_pic_table[];
51#endif
52
53#if defined(__arm__) || defined(__powerpc__)
54typedef void (*fdt_fixup_t)(phandle_t);
55struct fdt_fixup_entry {
56	char		*model;
57	fdt_fixup_t	handler;
58};
59extern struct fdt_fixup_entry fdt_fixup_table[];
60#endif
61
62extern SLIST_HEAD(fdt_ic_list, fdt_ic) fdt_ic_list_head;
63struct fdt_ic {
64	SLIST_ENTRY(fdt_ic)	fdt_ics;
65	ihandle_t		iph;
66	device_t		dev;
67};
68
69extern vm_paddr_t fdt_immr_pa;
70extern vm_offset_t fdt_immr_va;
71extern vm_offset_t fdt_immr_size;
72
73#if defined(FDT_DTB_STATIC)
74extern u_char fdt_static_dtb;
75#endif
76
77SYSCTL_DECL(_hw_fdt);
78
79int fdt_addrsize_cells(phandle_t, int *, int *);
80u_long fdt_data_get(void *, int);
81int fdt_data_to_res(pcell_t *, int, int, u_long *, u_long *);
82phandle_t fdt_find_compatible(phandle_t, const char *, int);
83phandle_t fdt_depth_search_compatible(phandle_t, const char *, int);
84int fdt_get_mem_regions(struct mem_region *, int *, uint64_t *);
85int fdt_get_reserved_mem(struct mem_region *, int *);
86int fdt_get_reserved_regions(struct mem_region *, int *);
87int fdt_get_phyaddr(phandle_t, device_t, int *, void **);
88int fdt_get_range(phandle_t, int, u_long *, u_long *);
89int fdt_immr_addr(vm_offset_t);
90int fdt_regsize(phandle_t, u_long *, u_long *);
91int fdt_is_compatible_strict(phandle_t, const char *);
92int fdt_parent_addr_cells(phandle_t);
93int fdt_get_chosen_bootargs(char *bootargs, size_t max_size);
94
95#endif /* _FDT_COMMON_H_ */
96