1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * (C) Copyright 2012-2016 Stephen Warren
4  */
5 
6 #include <common.h>
7 #include <config.h>
8 #include <dm.h>
9 #include <env.h>
10 #include <efi_loader.h>
11 #include <fdt_support.h>
12 #include <fdt_simplefb.h>
13 #include <init.h>
14 #include <lcd.h>
15 #include <memalign.h>
16 #include <mmc.h>
17 #include <asm/gpio.h>
18 #include <asm/arch/mbox.h>
19 #include <asm/arch/msg.h>
20 #include <asm/arch/sdhci.h>
21 #include <asm/global_data.h>
22 #include <dm/platform_data/serial_bcm283x_mu.h>
23 #ifdef CONFIG_ARM64
24 #include <asm/armv8/mmu.h>
25 #endif
26 #include <watchdog.h>
27 #include <dm/pinctrl.h>
28 
29 DECLARE_GLOBAL_DATA_PTR;
30 
31 /* Assigned in lowlevel_init.S
32  * Push the variable into the .data section so that it
33  * does not get cleared later.
34  */
35 unsigned long __section(".data") fw_dtb_pointer;
36 
37 /* TODO(sjg@chromium.org): Move these to the msg.c file */
38 struct msg_get_arm_mem {
39 	struct bcm2835_mbox_hdr hdr;
40 	struct bcm2835_mbox_tag_get_arm_mem get_arm_mem;
41 	u32 end_tag;
42 };
43 
44 struct msg_get_board_rev {
45 	struct bcm2835_mbox_hdr hdr;
46 	struct bcm2835_mbox_tag_get_board_rev get_board_rev;
47 	u32 end_tag;
48 };
49 
50 struct msg_get_board_serial {
51 	struct bcm2835_mbox_hdr hdr;
52 	struct bcm2835_mbox_tag_get_board_serial get_board_serial;
53 	u32 end_tag;
54 };
55 
56 struct msg_get_mac_address {
57 	struct bcm2835_mbox_hdr hdr;
58 	struct bcm2835_mbox_tag_get_mac_address get_mac_address;
59 	u32 end_tag;
60 };
61 
62 struct msg_get_clock_rate {
63 	struct bcm2835_mbox_hdr hdr;
64 	struct bcm2835_mbox_tag_get_clock_rate get_clock_rate;
65 	u32 end_tag;
66 };
67 
68 #ifdef CONFIG_ARM64
69 #define DTB_DIR "broadcom/"
70 #else
71 #define DTB_DIR ""
72 #endif
73 
74 /*
75  * https://www.raspberrypi.org/documentation/hardware/raspberrypi/revision-codes/README.md
76  */
77 struct rpi_model {
78 	const char *name;
79 	const char *fdtfile;
80 	bool has_onboard_eth;
81 };
82 
83 static const struct rpi_model rpi_model_unknown = {
84 	"Unknown model",
85 	DTB_DIR "bcm283x-rpi-other.dtb",
86 	false,
87 };
88 
89 static const struct rpi_model rpi_models_new_scheme[] = {
90 	[0x0] = {
91 		"Model A",
92 		DTB_DIR "bcm2835-rpi-a.dtb",
93 		false,
94 	},
95 	[0x1] = {
96 		"Model B",
97 		DTB_DIR "bcm2835-rpi-b.dtb",
98 		true,
99 	},
100 	[0x2] = {
101 		"Model A+",
102 		DTB_DIR "bcm2835-rpi-a-plus.dtb",
103 		false,
104 	},
105 	[0x3] = {
106 		"Model B+",
107 		DTB_DIR "bcm2835-rpi-b-plus.dtb",
108 		true,
109 	},
110 	[0x4] = {
111 		"2 Model B",
112 		DTB_DIR "bcm2836-rpi-2-b.dtb",
113 		true,
114 	},
115 	[0x6] = {
116 		"Compute Module",
117 		DTB_DIR "bcm2835-rpi-cm.dtb",
118 		false,
119 	},
120 	[0x8] = {
121 		"3 Model B",
122 		DTB_DIR "bcm2837-rpi-3-b.dtb",
123 		true,
124 	},
125 	[0x9] = {
126 		"Zero",
127 		DTB_DIR "bcm2835-rpi-zero.dtb",
128 		false,
129 	},
130 	[0xA] = {
131 		"Compute Module 3",
132 		DTB_DIR "bcm2837-rpi-cm3.dtb",
133 		false,
134 	},
135 	[0xC] = {
136 		"Zero W",
137 		DTB_DIR "bcm2835-rpi-zero-w.dtb",
138 		false,
139 	},
140 	[0xD] = {
141 		"3 Model B+",
142 		DTB_DIR "bcm2837-rpi-3-b-plus.dtb",
143 		true,
144 	},
145 	[0xE] = {
146 		"3 Model A+",
147 		DTB_DIR "bcm2837-rpi-3-a-plus.dtb",
148 		false,
149 	},
150 	[0x10] = {
151 		"Compute Module 3+",
152 		DTB_DIR "bcm2837-rpi-cm3.dtb",
153 		false,
154 	},
155 	[0x11] = {
156 		"4 Model B",
157 		DTB_DIR "bcm2711-rpi-4-b.dtb",
158 		true,
159 	},
160 	[0x13] = {
161 		"400",
162 		DTB_DIR "bcm2711-rpi-400.dtb",
163 		true,
164 	},
165 	[0x14] = {
166 		"Compute Module 4",
167 		DTB_DIR "bcm2711-rpi-cm4.dtb",
168 		true,
169 	},
170 };
171 
172 static const struct rpi_model rpi_models_old_scheme[] = {
173 	[0x2] = {
174 		"Model B",
175 		DTB_DIR "bcm2835-rpi-b.dtb",
176 		true,
177 	},
178 	[0x3] = {
179 		"Model B",
180 		DTB_DIR "bcm2835-rpi-b.dtb",
181 		true,
182 	},
183 	[0x4] = {
184 		"Model B rev2",
185 		DTB_DIR "bcm2835-rpi-b-rev2.dtb",
186 		true,
187 	},
188 	[0x5] = {
189 		"Model B rev2",
190 		DTB_DIR "bcm2835-rpi-b-rev2.dtb",
191 		true,
192 	},
193 	[0x6] = {
194 		"Model B rev2",
195 		DTB_DIR "bcm2835-rpi-b-rev2.dtb",
196 		true,
197 	},
198 	[0x7] = {
199 		"Model A",
200 		DTB_DIR "bcm2835-rpi-a.dtb",
201 		false,
202 	},
203 	[0x8] = {
204 		"Model A",
205 		DTB_DIR "bcm2835-rpi-a.dtb",
206 		false,
207 	},
208 	[0x9] = {
209 		"Model A",
210 		DTB_DIR "bcm2835-rpi-a.dtb",
211 		false,
212 	},
213 	[0xd] = {
214 		"Model B rev2",
215 		DTB_DIR "bcm2835-rpi-b-rev2.dtb",
216 		true,
217 	},
218 	[0xe] = {
219 		"Model B rev2",
220 		DTB_DIR "bcm2835-rpi-b-rev2.dtb",
221 		true,
222 	},
223 	[0xf] = {
224 		"Model B rev2",
225 		DTB_DIR "bcm2835-rpi-b-rev2.dtb",
226 		true,
227 	},
228 	[0x10] = {
229 		"Model B+",
230 		DTB_DIR "bcm2835-rpi-b-plus.dtb",
231 		true,
232 	},
233 	[0x11] = {
234 		"Compute Module",
235 		DTB_DIR "bcm2835-rpi-cm.dtb",
236 		false,
237 	},
238 	[0x12] = {
239 		"Model A+",
240 		DTB_DIR "bcm2835-rpi-a-plus.dtb",
241 		false,
242 	},
243 	[0x13] = {
244 		"Model B+",
245 		DTB_DIR "bcm2835-rpi-b-plus.dtb",
246 		true,
247 	},
248 	[0x14] = {
249 		"Compute Module",
250 		DTB_DIR "bcm2835-rpi-cm.dtb",
251 		false,
252 	},
253 	[0x15] = {
254 		"Model A+",
255 		DTB_DIR "bcm2835-rpi-a-plus.dtb",
256 		false,
257 	},
258 };
259 
260 static uint32_t revision;
261 static uint32_t rev_scheme;
262 static uint32_t rev_type;
263 static const struct rpi_model *model;
264 
dram_init(void)265 int dram_init(void)
266 {
267 	ALLOC_CACHE_ALIGN_BUFFER(struct msg_get_arm_mem, msg, 1);
268 	int ret;
269 
270 	BCM2835_MBOX_INIT_HDR(msg);
271 	BCM2835_MBOX_INIT_TAG(&msg->get_arm_mem, GET_ARM_MEMORY);
272 
273 	ret = bcm2835_mbox_call_prop(BCM2835_MBOX_PROP_CHAN, &msg->hdr);
274 	if (ret) {
275 		printf("bcm2835: Could not query ARM memory size\n");
276 		return -1;
277 	}
278 
279 	gd->ram_size = msg->get_arm_mem.body.resp.mem_size;
280 
281 	/*
282 	 * In some configurations the memory size returned by VideoCore
283 	 * is not aligned to the section size, what is mandatory for
284 	 * the u-boot's memory setup.
285 	 */
286 	gd->ram_size &= ~MMU_SECTION_SIZE;
287 
288 	return 0;
289 }
290 
291 #ifdef CONFIG_OF_BOARD
dram_init_banksize(void)292 int dram_init_banksize(void)
293 {
294 	int ret;
295 
296 	ret = fdtdec_setup_memory_banksize();
297 	if (ret)
298 		return ret;
299 
300 	return fdtdec_setup_mem_size_base();
301 }
302 #endif
303 
set_fdtfile(void)304 static void set_fdtfile(void)
305 {
306 	const char *fdtfile;
307 
308 	if (env_get("fdtfile"))
309 		return;
310 
311 	fdtfile = model->fdtfile;
312 	env_set("fdtfile", fdtfile);
313 }
314 
315 /*
316  * If the firmware provided a valid FDT at boot time, let's expose it in
317  * ${fdt_addr} so it may be passed unmodified to the kernel.
318  */
set_fdt_addr(void)319 static void set_fdt_addr(void)
320 {
321 	if (env_get("fdt_addr"))
322 		return;
323 
324 	if (fdt_magic(fw_dtb_pointer) != FDT_MAGIC)
325 		return;
326 
327 	env_set_hex("fdt_addr", fw_dtb_pointer);
328 }
329 
330 /*
331  * Prevent relocation from stomping on a firmware provided FDT blob.
332  */
board_get_usable_ram_top(unsigned long total_size)333 unsigned long board_get_usable_ram_top(unsigned long total_size)
334 {
335 	if ((gd->ram_top - fw_dtb_pointer) > SZ_64M)
336 		return gd->ram_top;
337 	return fw_dtb_pointer & ~0xffff;
338 }
339 
set_usbethaddr(void)340 static void set_usbethaddr(void)
341 {
342 	ALLOC_CACHE_ALIGN_BUFFER(struct msg_get_mac_address, msg, 1);
343 	int ret;
344 
345 	if (!model->has_onboard_eth)
346 		return;
347 
348 	if (env_get("usbethaddr"))
349 		return;
350 
351 	BCM2835_MBOX_INIT_HDR(msg);
352 	BCM2835_MBOX_INIT_TAG(&msg->get_mac_address, GET_MAC_ADDRESS);
353 
354 	ret = bcm2835_mbox_call_prop(BCM2835_MBOX_PROP_CHAN, &msg->hdr);
355 	if (ret) {
356 		printf("bcm2835: Could not query MAC address\n");
357 		/* Ignore error; not critical */
358 		return;
359 	}
360 
361 	eth_env_set_enetaddr("usbethaddr", msg->get_mac_address.body.resp.mac);
362 
363 	if (!env_get("ethaddr"))
364 		env_set("ethaddr", env_get("usbethaddr"));
365 
366 	return;
367 }
368 
369 #ifdef CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
set_board_info(void)370 static void set_board_info(void)
371 {
372 	char s[11];
373 
374 	snprintf(s, sizeof(s), "0x%X", revision);
375 	env_set("board_revision", s);
376 	snprintf(s, sizeof(s), "%d", rev_scheme);
377 	env_set("board_rev_scheme", s);
378 	/* Can't rename this to board_rev_type since it's an ABI for scripts */
379 	snprintf(s, sizeof(s), "0x%X", rev_type);
380 	env_set("board_rev", s);
381 	env_set("board_name", model->name);
382 }
383 #endif /* CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG */
384 
set_serial_number(void)385 static void set_serial_number(void)
386 {
387 	ALLOC_CACHE_ALIGN_BUFFER(struct msg_get_board_serial, msg, 1);
388 	int ret;
389 	char serial_string[17] = { 0 };
390 
391 	if (env_get("serial#"))
392 		return;
393 
394 	BCM2835_MBOX_INIT_HDR(msg);
395 	BCM2835_MBOX_INIT_TAG_NO_REQ(&msg->get_board_serial, GET_BOARD_SERIAL);
396 
397 	ret = bcm2835_mbox_call_prop(BCM2835_MBOX_PROP_CHAN, &msg->hdr);
398 	if (ret) {
399 		printf("bcm2835: Could not query board serial\n");
400 		/* Ignore error; not critical */
401 		return;
402 	}
403 
404 	snprintf(serial_string, sizeof(serial_string), "%016llx",
405 		 msg->get_board_serial.body.resp.serial);
406 	env_set("serial#", serial_string);
407 }
408 
misc_init_r(void)409 int misc_init_r(void)
410 {
411 	set_fdt_addr();
412 	set_fdtfile();
413 	set_usbethaddr();
414 #ifdef CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
415 	set_board_info();
416 #endif
417 	set_serial_number();
418 
419 	return 0;
420 }
421 
get_board_rev(void)422 static void get_board_rev(void)
423 {
424 	ALLOC_CACHE_ALIGN_BUFFER(struct msg_get_board_rev, msg, 1);
425 	int ret;
426 	const struct rpi_model *models;
427 	uint32_t models_count;
428 
429 	BCM2835_MBOX_INIT_HDR(msg);
430 	BCM2835_MBOX_INIT_TAG(&msg->get_board_rev, GET_BOARD_REV);
431 
432 	ret = bcm2835_mbox_call_prop(BCM2835_MBOX_PROP_CHAN, &msg->hdr);
433 	if (ret) {
434 		printf("bcm2835: Could not query board revision\n");
435 		/* Ignore error; not critical */
436 		return;
437 	}
438 
439 	/*
440 	 * For details of old-vs-new scheme, see:
441 	 * https://github.com/pimoroni/RPi.version/blob/master/RPi/version.py
442 	 * http://www.raspberrypi.org/forums/viewtopic.php?f=63&t=99293&p=690282
443 	 * (a few posts down)
444 	 *
445 	 * For the RPi 1, bit 24 is the "warranty bit", so we mask off just the
446 	 * lower byte to use as the board rev:
447 	 * http://www.raspberrypi.org/forums/viewtopic.php?f=63&t=98367&start=250
448 	 * http://www.raspberrypi.org/forums/viewtopic.php?f=31&t=20594
449 	 */
450 	revision = msg->get_board_rev.body.resp.rev;
451 	if (revision & 0x800000) {
452 		rev_scheme = 1;
453 		rev_type = (revision >> 4) & 0xff;
454 		models = rpi_models_new_scheme;
455 		models_count = ARRAY_SIZE(rpi_models_new_scheme);
456 	} else {
457 		rev_scheme = 0;
458 		rev_type = revision & 0xff;
459 		models = rpi_models_old_scheme;
460 		models_count = ARRAY_SIZE(rpi_models_old_scheme);
461 	}
462 	if (rev_type >= models_count) {
463 		printf("RPI: Board rev 0x%x outside known range\n", rev_type);
464 		model = &rpi_model_unknown;
465 	} else if (!models[rev_type].name) {
466 		printf("RPI: Board rev 0x%x unknown\n", rev_type);
467 		model = &rpi_model_unknown;
468 	} else {
469 		model = &models[rev_type];
470 	}
471 
472 	printf("RPI %s (0x%x)\n", model->name, revision);
473 }
474 
board_init(void)475 int board_init(void)
476 {
477 #ifdef CONFIG_HW_WATCHDOG
478 	hw_watchdog_init();
479 #endif
480 
481 	get_board_rev();
482 
483 	gd->bd->bi_boot_params = 0x100;
484 
485 	return bcm2835_power_on_module(BCM2835_MBOX_POWER_DEVID_USB_HCD);
486 }
487 
488 /*
489  * If the firmware passed a device tree use it for U-Boot.
490  */
board_fdt_blob_setup(void)491 void *board_fdt_blob_setup(void)
492 {
493 	if (fdt_magic(fw_dtb_pointer) != FDT_MAGIC)
494 		return NULL;
495 	return (void *)fw_dtb_pointer;
496 }
497 
ft_board_setup(void * blob,struct bd_info * bd)498 int ft_board_setup(void *blob, struct bd_info *bd)
499 {
500 	/*
501 	 * For now, we simply always add the simplefb DT node. Later, we
502 	 * should be more intelligent, and e.g. only do this if no enabled DT
503 	 * node exists for the "real" graphics driver.
504 	 */
505 	lcd_dt_simplefb_add_node(blob);
506 
507 #ifdef CONFIG_EFI_LOADER
508 	/* Reserve the spin table */
509 	efi_add_memory_map(0, CONFIG_RPI_EFI_NR_SPIN_PAGES << EFI_PAGE_SHIFT,
510 			   EFI_RESERVED_MEMORY_TYPE);
511 #endif
512 
513 	return 0;
514 }
515