xref: /freebsd/sys/dev/ofw/ofw_subr.c (revision 190cef3d)
1 /*-
2  * Copyright (c) 2015 Ian Lepore <ian@freebsd.org>
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
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * The initial ofw_reg_to_paddr() implementation has been copied from powerpc
27  * ofw_machdep.c OF_decode_addr(). It was added by Marcel Moolenaar, who did not
28  * assert copyright with the addition but still deserves credit for the work.
29  */
30 
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
33 
34 #include <sys/param.h>
35 #include <sys/boot.h>
36 #include <sys/bus.h>
37 #include <sys/libkern.h>
38 #include <sys/reboot.h>
39 #include <sys/rman.h>
40 
41 #include <machine/bus.h>
42 
43 #include <dev/ofw/openfirm.h>
44 #include <dev/ofw/ofw_pci.h>
45 #include <dev/ofw/ofw_subr.h>
46 
47 static void
48 get_addr_props(phandle_t node, uint32_t *addrp, uint32_t *sizep, int *pcip)
49 {
50 	char type[64];
51 	uint32_t addr, size;
52 	int pci, res;
53 
54 	res = OF_getencprop(node, "#address-cells", &addr, sizeof(addr));
55 	if (res == -1)
56 		addr = 2;
57 	res = OF_getencprop(node, "#size-cells", &size, sizeof(size));
58 	if (res == -1)
59 		size = 1;
60 	pci = 0;
61 	if (addr == 3 && size == 2) {
62 		res = OF_getprop(node, "device_type", type, sizeof(type));
63 		if (res != -1) {
64 			type[sizeof(type) - 1] = '\0';
65 			if (strcmp(type, "pci") == 0 ||
66 			    strcmp(type, "pciex")== 0)
67 				pci = 1;
68 		}
69 	}
70 	if (addrp != NULL)
71 		*addrp = addr;
72 	if (sizep != NULL)
73 		*sizep = size;
74 	if (pcip != NULL)
75 		*pcip = pci;
76 }
77 
78 int
79 ofw_reg_to_paddr(phandle_t dev, int regno, bus_addr_t *paddr,
80     bus_size_t *psize, pcell_t *ppci_hi)
81 {
82 	pcell_t cell[32], pci_hi;
83 	uint64_t addr, raddr, baddr;
84 	uint64_t size, rsize;
85 	uint32_t c, nbridge, naddr, nsize;
86 	phandle_t bridge, parent;
87 	u_int spc, rspc;
88 	int pci, pcib, res;
89 
90 	/* Sanity checking. */
91 	if (dev == 0)
92 		return (EINVAL);
93 	bridge = OF_parent(dev);
94 	if (bridge == 0)
95 		return (EINVAL);
96 	if (regno < 0)
97 		return (EINVAL);
98 	if (paddr == NULL || psize == NULL)
99 		return (EINVAL);
100 
101 	get_addr_props(bridge, &naddr, &nsize, &pci);
102 	res = OF_getencprop(dev, (pci) ? "assigned-addresses" : "reg",
103 	    cell, sizeof(cell));
104 	if (res == -1)
105 		return (ENXIO);
106 	if (res % sizeof(cell[0]))
107 		return (ENXIO);
108 	res /= sizeof(cell[0]);
109 	regno *= naddr + nsize;
110 	if (regno + naddr + nsize > res)
111 		return (EINVAL);
112 	pci_hi = pci ? cell[regno] : OFW_PADDR_NOT_PCI;
113 	spc = pci_hi & OFW_PCI_PHYS_HI_SPACEMASK;
114 	addr = 0;
115 	for (c = 0; c < naddr; c++)
116 		addr = ((uint64_t)addr << 32) | cell[regno++];
117 	size = 0;
118 	for (c = 0; c < nsize; c++)
119 		size = ((uint64_t)size << 32) | cell[regno++];
120 	/*
121 	 * Map the address range in the bridge's decoding window as given
122 	 * by the "ranges" property. If a node doesn't have such property
123 	 * or the property is empty, we assume an identity mapping.  The
124 	 * standard says a missing property indicates no possible mapping.
125 	 * This code is more liberal since the intended use is to get a
126 	 * console running early, and a printf to warn of malformed data
127 	 * is probably futile before the console is fully set up.
128 	 */
129 	parent = OF_parent(bridge);
130 	while (parent != 0) {
131 		get_addr_props(parent, &nbridge, NULL, &pcib);
132 		res = OF_getencprop(bridge, "ranges", cell, sizeof(cell));
133 		if (res < 1)
134 			goto next;
135 		if (res % sizeof(cell[0]))
136 			return (ENXIO);
137 		/* Capture pci_hi if we just transitioned onto a PCI bus. */
138 		if (pcib && pci_hi == OFW_PADDR_NOT_PCI) {
139 			pci_hi = cell[0];
140 			spc = pci_hi & OFW_PCI_PHYS_HI_SPACEMASK;
141 		}
142 		res /= sizeof(cell[0]);
143 		regno = 0;
144 		while (regno < res) {
145 			rspc = (pci ? cell[regno] : OFW_PADDR_NOT_PCI) &
146 			    OFW_PCI_PHYS_HI_SPACEMASK;
147 			if (rspc != spc) {
148 				regno += naddr + nbridge + nsize;
149 				continue;
150 			}
151 			raddr = 0;
152 			for (c = 0; c < naddr; c++)
153 				raddr = ((uint64_t)raddr << 32) | cell[regno++];
154 			rspc = (pcib)
155 			    ? cell[regno] & OFW_PCI_PHYS_HI_SPACEMASK
156 			    : OFW_PADDR_NOT_PCI;
157 			baddr = 0;
158 			for (c = 0; c < nbridge; c++)
159 				baddr = ((uint64_t)baddr << 32) | cell[regno++];
160 			rsize = 0;
161 			for (c = 0; c < nsize; c++)
162 				rsize = ((uint64_t)rsize << 32) | cell[regno++];
163 			if (addr < raddr || addr >= raddr + rsize)
164 				continue;
165 			addr = addr - raddr + baddr;
166 			if (rspc != OFW_PADDR_NOT_PCI)
167 				spc = rspc;
168 		}
169 	next:
170 		bridge = parent;
171 		parent = OF_parent(bridge);
172 		get_addr_props(bridge, &naddr, &nsize, &pci);
173 	}
174 
175 	KASSERT(addr <= BUS_SPACE_MAXADDR,
176 	    ("Bus address is too large: %jx", (uintmax_t)addr));
177 	KASSERT(size <= BUS_SPACE_MAXSIZE,
178 	    ("Bus size is too large: %jx", (uintmax_t)size));
179 
180 	*paddr = addr;
181 	*psize = size;
182 	if (ppci_hi != NULL)
183 		*ppci_hi = pci_hi;
184 
185 	return (0);
186 }
187 
188 /*
189  * This is intended to be called early on, right after the OF system is
190  * initialized, so pmap may not be up yet.
191  */
192 int
193 ofw_parse_bootargs(void)
194 {
195 	phandle_t chosen;
196 	char buf[2048];		/* early stack supposedly big enough */
197 	int err;
198 
199 	chosen = OF_finddevice("/chosen");
200 	if (chosen == -1)
201 		return (chosen);
202 
203 	if ((err = OF_getprop(chosen, "bootargs", buf, sizeof(buf))) != -1) {
204 		boothowto |= boot_parse_cmdline(buf);
205 		return (0);
206 	}
207 
208 	return (err);
209 }
210