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