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