1/*-
2 * Copyright (c) 2009-2010 The FreeBSD Foundation
3 * All rights reserved.
4 *
5 * This software was developed by Semihalf under sponsorship from
6 * the FreeBSD Foundation.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD$
30 */
31
32#ifndef _FDT_COMMON_H_
33#define _FDT_COMMON_H_
34
35#include <contrib/libfdt/libfdt_env.h>
36#include <dev/ofw/ofw_bus.h>
37#include <machine/fdt.h>
38
39#define FDT_MEM_REGIONS	8
40
41#define DI_MAX_INTR_NUM	8
42
43struct fdt_pci_range {
44	u_long	base_pci;
45	u_long	base_parent;
46	u_long	len;
47};
48
49struct fdt_pci_intr {
50	int	addr_cells;
51	int	intr_cells;
52	int	map_len;
53	pcell_t	*map;
54	pcell_t	*mask;
55};
56
57struct fdt_sense_level {
58	enum intr_trigger	trig;
59	enum intr_polarity	pol;
60};
61
62typedef int (*fdt_pic_decode_t)(phandle_t, pcell_t *, int *, int *, int *);
63extern fdt_pic_decode_t fdt_pic_table[];
64
65typedef void (*fdt_fixup_t)(phandle_t);
66struct fdt_fixup_entry {
67	char		*model;
68	fdt_fixup_t	handler;
69};
70extern struct fdt_fixup_entry fdt_fixup_table[];
71
72extern vm_paddr_t fdt_immr_pa;
73extern vm_offset_t fdt_immr_va;
74extern vm_offset_t fdt_immr_size;
75
76struct fdt_pm_mask_entry {
77	char		*compat;
78	uint32_t	mask;
79};
80extern struct fdt_pm_mask_entry fdt_pm_mask_table[];
81
82#if defined(FDT_DTB_STATIC)
83extern u_char fdt_static_dtb;
84#endif
85
86int fdt_addrsize_cells(phandle_t, int *, int *);
87u_long fdt_data_get(void *, int);
88int fdt_data_to_res(pcell_t *, int, int, u_long *, u_long *);
89int fdt_data_verify(void *, int);
90phandle_t fdt_find_compatible(phandle_t, const char *, int);
91int fdt_get_mem_regions(struct mem_region *, int *, uint32_t *);
92int fdt_get_phyaddr(phandle_t, device_t, int *, void **);
93int fdt_immr_addr(vm_offset_t);
94int fdt_regsize(phandle_t, u_long *, u_long *);
95int fdt_intr_decode(phandle_t, pcell_t *, int *, int *, int *);
96int fdt_intr_to_rl(phandle_t, struct resource_list *, struct fdt_sense_level *);
97int fdt_is_compatible(phandle_t, const char *);
98int fdt_is_compatible_strict(phandle_t, const char *);
99int fdt_is_enabled(phandle_t);
100int fdt_pm_is_enabled(phandle_t);
101int fdt_is_type(phandle_t, const char *);
102int fdt_parent_addr_cells(phandle_t);
103int fdt_pci_intr_info(phandle_t, struct fdt_pci_intr *);
104int fdt_pci_ranges(phandle_t, struct fdt_pci_range *, struct fdt_pci_range *);
105int fdt_pci_ranges_decode(phandle_t, struct fdt_pci_range *,
106    struct fdt_pci_range *);
107int fdt_pci_route_intr(int, int, int, int, struct fdt_pci_intr *, int *);
108int fdt_ranges_verify(pcell_t *, int, int, int, int);
109int fdt_reg_to_rl(phandle_t, struct resource_list *, u_long);
110int fdt_pm(phandle_t);
111
112#endif /* _FDT_COMMON_H_ */
113