xref: /freebsd/sys/arm/freescale/imx/imx6_machdep.c (revision ab40f58ccfe6c07ebefddc72f4661a52fe746353)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2013 Ian Lepore <ian@freebsd.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include "opt_platform.h"
30 
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
33 
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/bus.h>
37 #include <sys/reboot.h>
38 #include <sys/devmap.h>
39 
40 #include <vm/vm.h>
41 
42 #include <machine/bus.h>
43 #include <machine/intr.h>
44 #include <machine/machdep.h>
45 #include <machine/platformvar.h>
46 
47 #include <arm/arm/mpcore_timervar.h>
48 #include <arm/freescale/imx/imx6_anatopreg.h>
49 #include <arm/freescale/imx/imx6_anatopvar.h>
50 #include <arm/freescale/imx/imx_machdep.h>
51 
52 #include <dev/fdt/fdt_common.h>
53 #include <dev/ofw/openfirm.h>
54 
55 #include <arm/freescale/imx/imx6_machdep.h>
56 
57 #include "platform_if.h"
58 #include "platform_pl310_if.h"
59 
60 static platform_attach_t imx6_attach;
61 static platform_devmap_init_t imx6_devmap_init;
62 static platform_late_init_t imx6_late_init;
63 static platform_cpu_reset_t imx6_cpu_reset;
64 
65 /*
66  * Fix FDT data related to interrupts.
67  *
68  * Driven by the needs of linux and its drivers (as always), the published FDT
69  * data for imx6 now sets the interrupt parent for most devices to the GPC
70  * interrupt controller, which is for use when the chip is in deep-sleep mode.
71  * We don't support deep sleep or have a GPC-PIC driver; we need all interrupts
72  * to be handled by the GIC.
73  *
74  * Luckily, the change to the FDT data was to assign the GPC as the interrupt
75  * parent for the soc node and letting that get inherited by all other devices
76  * (except a few that directly name GIC as their interrupt parent).  So we can
77  * set the world right by just changing the interrupt-parent property of the soc
78  * node to refer to GIC instead of GPC.  This will get us by until we write our
79  * own GPC driver (or until linux changes its mind and the FDT data again).
80  *
81  * We validate that we have data that looks like we expect before changing it:
82  *  - SOC node exists and has GPC as its interrupt parent.
83  *  - GPC node exists and has GIC as its interrupt parent.
84  *  - GIC node exists and is its own interrupt parent or has no parent.
85  *
86  * This applies to all models of imx6.  Luckily all of them have the devices
87  * involved at the same addresses on the same buses, so we don't need any
88  * per-soc logic.  We handle this at platform attach time rather than via the
89  * fdt_fixup_table, because the latter requires matching on the FDT "model"
90  * property, and this applies to all boards including those not yet invented.
91  *
92  * This just in:  as of the import of dts files from linux 4.15 on 2018-02-10,
93  * they appear to have applied a new style rule to the dts which forbids leading
94  * zeroes in the @address qualifiers on node names.  Since we have to find those
95  * nodes by string matching we now have to search for both flavors of each node
96  * name involved.
97  */
98 static void
99 fix_fdt_interrupt_data(void)
100 {
101 	phandle_t gicipar, gicnode, gicxref;
102 	phandle_t gpcipar, gpcnode, gpcxref;
103 	phandle_t socipar, socnode;
104 	int result;
105 
106 	socnode = OF_finddevice("/soc");
107 	if (socnode == -1)
108 	    return;
109 	result = OF_getencprop(socnode, "interrupt-parent", &socipar,
110 	    sizeof(socipar));
111 	if (result <= 0)
112 		return;
113 
114 	/* GIC node may be child of soc node, or appear directly at root. */
115 	gicnode = OF_finddevice("/soc/interrupt-controller@00a01000");
116 	if (gicnode == -1)
117 		gicnode = OF_finddevice("/soc/interrupt-controller@a01000");
118 	if (gicnode == -1) {
119 		gicnode = OF_finddevice("/interrupt-controller@00a01000");
120 		if (gicnode == -1)
121 			gicnode = OF_finddevice("/interrupt-controller@a01000");
122 		if (gicnode == -1)
123 			return;
124 	}
125 	gicxref = OF_xref_from_node(gicnode);
126 
127 	/* If gic node has no parent, pretend it is its own parent. */
128 	result = OF_getencprop(gicnode, "interrupt-parent", &gicipar,
129 	    sizeof(gicipar));
130 	if (result <= 0)
131 		gicipar = gicxref;
132 
133 	gpcnode = OF_finddevice("/soc/aips-bus@02000000/gpc@020dc000");
134 	if (gpcnode == -1)
135 		gpcnode = OF_finddevice("/soc/aips-bus@2000000/gpc@20dc000");
136 	if (gpcnode == -1)
137 		return;
138 	result = OF_getencprop(gpcnode, "interrupt-parent", &gpcipar,
139 	    sizeof(gpcipar));
140 	if (result <= 0)
141 		return;
142 	gpcxref = OF_xref_from_node(gpcnode);
143 
144 	if (socipar != gpcxref || gpcipar != gicxref || gicipar != gicxref)
145 		return;
146 
147 	gicxref = cpu_to_fdt32(gicxref);
148 	OF_setprop(socnode, "interrupt-parent", &gicxref, sizeof(gicxref));
149 }
150 
151 static int
152 imx6_attach(platform_t plat)
153 {
154 
155 	/* Fix soc interrupt-parent property. */
156 	fix_fdt_interrupt_data();
157 
158 	/* Inform the MPCore timer driver that its clock is variable. */
159 	arm_tmr_change_frequency(ARM_TMR_FREQUENCY_VARIES);
160 
161 	return (0);
162 }
163 
164 static void
165 imx6_late_init(platform_t plat)
166 {
167 	const uint32_t IMX6_WDOG_SR_PHYS = 0x020bc004;
168 
169 	imx_wdog_init_last_reset(IMX6_WDOG_SR_PHYS);
170 }
171 
172 /*
173  * Set up static device mappings.
174  *
175  * This attempts to cover the most-used devices with 1MB section mappings, which
176  * is good for performance (uses fewer TLB entries for device access).
177  *
178  * ARMMP covers the interrupt controller, MPCore timers, global timer, and the
179  * L2 cache controller.  Most of the 1MB range is unused reserved space.
180  *
181  * AIPS1/AIPS2 cover most of the on-chip devices such as uart, spi, i2c, etc.
182  *
183  * Notably not mapped right now are HDMI, GPU, and other devices below ARMMP in
184  * the memory map.  When we get support for graphics it might make sense to
185  * static map some of that area.  Be careful with other things in that area such
186  * as OCRAM that probably shouldn't be mapped as VM_MEMATTR_DEVICE memory.
187  */
188 static int
189 imx6_devmap_init(platform_t plat)
190 {
191 	const uint32_t IMX6_ARMMP_PHYS = 0x00a00000;
192 	const uint32_t IMX6_ARMMP_SIZE = 0x00100000;
193 	const uint32_t IMX6_AIPS1_PHYS = 0x02000000;
194 	const uint32_t IMX6_AIPS1_SIZE = 0x00100000;
195 	const uint32_t IMX6_AIPS2_PHYS = 0x02100000;
196 	const uint32_t IMX6_AIPS2_SIZE = 0x00100000;
197 
198 	devmap_add_entry(IMX6_ARMMP_PHYS, IMX6_ARMMP_SIZE);
199 	devmap_add_entry(IMX6_AIPS1_PHYS, IMX6_AIPS1_SIZE);
200 	devmap_add_entry(IMX6_AIPS2_PHYS, IMX6_AIPS2_SIZE);
201 
202 	return (0);
203 }
204 
205 static void
206 imx6_cpu_reset(platform_t plat)
207 {
208 	const uint32_t IMX6_WDOG_CR_PHYS = 0x020bc000;
209 
210 	imx_wdog_cpu_reset(IMX6_WDOG_CR_PHYS);
211 }
212 
213 /*
214  * Determine what flavor of imx6 we're running on.
215  *
216  * This code is based on the way u-boot does it.  Information found on the web
217  * indicates that Freescale themselves were the original source of this logic,
218  * including the strange check for number of CPUs in the SCU configuration
219  * register, which is apparently needed on some revisions of the SOLO.
220  *
221  * According to the documentation, there is such a thing as an i.MX6 Dual
222  * (non-lite flavor).  However, Freescale doesn't seem to have assigned it a
223  * number or provided any logic to handle it in their detection code.
224  *
225  * Note that the ANALOG_DIGPROG and SCU configuration registers are not
226  * documented in the chip reference manual.  (SCU configuration is mentioned,
227  * but not mapped out in detail.)  I think the bottom two bits of the scu config
228  * register may be ncpu-1.
229  *
230  * This hasn't been tested yet on a dual[-lite].
231  *
232  * On a solo:
233  *      digprog    = 0x00610001
234  *      hwsoc      = 0x00000062
235  *      scu config = 0x00000500
236  * On a quad:
237  *      digprog    = 0x00630002
238  *      hwsoc      = 0x00000063
239  *      scu config = 0x00005503
240  */
241 u_int
242 imx_soc_type(void)
243 {
244 	uint32_t digprog, hwsoc;
245 	uint32_t *pcr;
246 	static u_int soctype;
247 	const vm_offset_t SCU_CONFIG_PHYSADDR = 0x00a00004;
248 #define	HWSOC_MX6SL	0x60
249 #define	HWSOC_MX6DL	0x61
250 #define	HWSOC_MX6SOLO	0x62
251 #define	HWSOC_MX6Q	0x63
252 #define	HWSOC_MX6UL	0x64
253 
254 	if (soctype != 0)
255 		return (soctype);
256 
257 	digprog = imx6_anatop_read_4(IMX6_ANALOG_DIGPROG_SL);
258 	hwsoc = (digprog >> IMX6_ANALOG_DIGPROG_SOCTYPE_SHIFT) &
259 	    IMX6_ANALOG_DIGPROG_SOCTYPE_MASK;
260 
261 	if (hwsoc != HWSOC_MX6SL) {
262 		digprog = imx6_anatop_read_4(IMX6_ANALOG_DIGPROG);
263 		hwsoc = (digprog & IMX6_ANALOG_DIGPROG_SOCTYPE_MASK) >>
264 		    IMX6_ANALOG_DIGPROG_SOCTYPE_SHIFT;
265 		/*printf("digprog = 0x%08x\n", digprog);*/
266 		if (hwsoc == HWSOC_MX6DL) {
267 			pcr = devmap_ptov(SCU_CONFIG_PHYSADDR, 4);
268 			if (pcr != NULL) {
269 				/*printf("scu config = 0x%08x\n", *pcr);*/
270 				if ((*pcr & 0x03) == 0) {
271 					hwsoc = HWSOC_MX6SOLO;
272 				}
273 			}
274 		}
275 	}
276 	/* printf("hwsoc 0x%08x\n", hwsoc); */
277 
278 	switch (hwsoc) {
279 	case HWSOC_MX6SL:
280 		soctype = IMXSOC_6SL;
281 		break;
282 	case HWSOC_MX6SOLO:
283 		soctype = IMXSOC_6S;
284 		break;
285 	case HWSOC_MX6DL:
286 		soctype = IMXSOC_6DL;
287 		break;
288 	case HWSOC_MX6Q :
289 		soctype = IMXSOC_6Q;
290 		break;
291 	case HWSOC_MX6UL:
292 		soctype = IMXSOC_6UL;
293 		break;
294 	default:
295 		printf("imx_soc_type: Don't understand hwsoc 0x%02x, "
296 		    "digprog 0x%08x; assuming IMXSOC_6Q\n", hwsoc, digprog);
297 		soctype = IMXSOC_6Q;
298 		break;
299 	}
300 
301 	return (soctype);
302 }
303 
304 /*
305  * Early putc routine for EARLY_PRINTF support.  To use, add to kernel config:
306  *   option SOCDEV_PA=0x02000000
307  *   option SOCDEV_VA=0x02000000
308  *   option EARLY_PRINTF
309  * Resist the temptation to change the #if 0 to #ifdef EARLY_PRINTF here. It
310  * makes sense now, but if multiple SOCs do that it will make early_putc another
311  * duplicate symbol to be eliminated on the path to a generic kernel.
312  */
313 #if 0
314 static void
315 imx6_early_putc(int c)
316 {
317 	volatile uint32_t * UART_STAT_REG = (uint32_t *)0x02020098;
318 	volatile uint32_t * UART_TX_REG   = (uint32_t *)0x02020040;
319 	const uint32_t      UART_TXRDY    = (1 << 3);
320 
321 	while ((*UART_STAT_REG & UART_TXRDY) == 0)
322 		continue;
323 	*UART_TX_REG = c;
324 }
325 early_putc_t *early_putc = imx6_early_putc;
326 #endif
327 
328 static platform_method_t imx6_methods[] = {
329 	PLATFORMMETHOD(platform_attach,		imx6_attach),
330 	PLATFORMMETHOD(platform_devmap_init,	imx6_devmap_init),
331 	PLATFORMMETHOD(platform_late_init,	imx6_late_init),
332 	PLATFORMMETHOD(platform_cpu_reset,	imx6_cpu_reset),
333 
334 #ifdef SMP
335 	PLATFORMMETHOD(platform_mp_start_ap,	imx6_mp_start_ap),
336 	PLATFORMMETHOD(platform_mp_setmaxid,	imx6_mp_setmaxid),
337 #endif
338 
339 	PLATFORMMETHOD(platform_pl310_init,	imx6_pl310_init),
340 
341 	PLATFORMMETHOD_END,
342 };
343 
344 FDT_PLATFORM_DEF2(imx6, imx6s, "i.MX6 Solo", 0, "fsl,imx6s", 80);
345 FDT_PLATFORM_DEF2(imx6, imx6d, "i.MX6 Dual", 0, "fsl,imx6dl", 80);
346 FDT_PLATFORM_DEF2(imx6, imx6q, "i.MX6 Quad", 0, "fsl,imx6q", 80);
347 FDT_PLATFORM_DEF2(imx6, imx6ul, "i.MX6 UltraLite", 0, "fsl,imx6ul", 67);
348