board/raspberrypi/rpi/rpi.c

   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 };
 161
 162 static const struct rpi_model rpi_models_old_scheme[] = {
 163         [0x2] = {
 164                 "Model B",
 165                 DTB_DIR "bcm2835-rpi-b.dtb",
 166                 true,
 167         },
 168         [0x3] = {
 169                 "Model B",
 170                 DTB_DIR "bcm2835-rpi-b.dtb",
 171                 true,
 172         },
 173         [0x4] = {
 174                 "Model B rev2",
 175                 DTB_DIR "bcm2835-rpi-b-rev2.dtb",
 176                 true,
 177         },
 178         [0x5] = {
 179                 "Model B rev2",
 180                 DTB_DIR "bcm2835-rpi-b-rev2.dtb",
 181                 true,
 182         },
 183         [0x6] = {
 184                 "Model B rev2",
 185                 DTB_DIR "bcm2835-rpi-b-rev2.dtb",
 186                 true,
 187         },
 188         [0x7] = {
 189                 "Model A",
 190                 DTB_DIR "bcm2835-rpi-a.dtb",
 191                 false,
 192         },
 193         [0x8] = {
 194                 "Model A",
 195                 DTB_DIR "bcm2835-rpi-a.dtb",
 196                 false,
 197         },
 198         [0x9] = {
 199                 "Model A",
 200                 DTB_DIR "bcm2835-rpi-a.dtb",
 201                 false,
 202         },
 203         [0xd] = {
 204                 "Model B rev2",
 205                 DTB_DIR "bcm2835-rpi-b-rev2.dtb",
 206                 true,
 207         },
 208         [0xe] = {
 209                 "Model B rev2",
 210                 DTB_DIR "bcm2835-rpi-b-rev2.dtb",
 211                 true,
 212         },
 213         [0xf] = {
 214                 "Model B rev2",
 215                 DTB_DIR "bcm2835-rpi-b-rev2.dtb",
 216                 true,
 217         },
 218         [0x10] = {
 219                 "Model B+",
 220                 DTB_DIR "bcm2835-rpi-b-plus.dtb",
 221                 true,
 222         },
 223         [0x11] = {
 224                 "Compute Module",
 225                 DTB_DIR "bcm2835-rpi-cm.dtb",
 226                 false,
 227         },
 228         [0x12] = {
 229                 "Model A+",
 230                 DTB_DIR "bcm2835-rpi-a-plus.dtb",
 231                 false,
 232         },
 233         [0x13] = {
 234                 "Model B+",
 235                 DTB_DIR "bcm2835-rpi-b-plus.dtb",
 236                 true,
 237         },
 238         [0x14] = {
 239                 "Compute Module",
 240                 DTB_DIR "bcm2835-rpi-cm.dtb",
 241                 false,
 242         },
 243         [0x15] = {
 244                 "Model A+",
 245                 DTB_DIR "bcm2835-rpi-a-plus.dtb",
 246                 false,
 247         },
 248 };
 249
 250 static uint32_t revision;
 251 static uint32_t rev_scheme;
 252 static uint32_t rev_type;
 253 static const struct rpi_model *model;
 254
 255 int dram_init(void)
 256 {
 257         ALLOC_CACHE_ALIGN_BUFFER(struct msg_get_arm_mem, msg, 1);
 258         int ret;
 259
 260         BCM2835_MBOX_INIT_HDR(msg);
 261         BCM2835_MBOX_INIT_TAG(&msg->get_arm_mem, GET_ARM_MEMORY);
 262
 263         ret = bcm2835_mbox_call_prop(BCM2835_MBOX_PROP_CHAN, &msg->hdr);
 264         if (ret) {
 265                 printf("bcm2835: Could not query ARM memory size\n");
 266                 return -1;
 267         }
 268
 269         gd->ram_size = msg->get_arm_mem.body.resp.mem_size;
 270
 271         return 0;
 272 }
 273
 274 #ifdef CONFIG_OF_BOARD
 275 #ifdef CONFIG_BCM2711
 276 int dram_init_banksize(void)
 277 {
 278         return fdtdec_decode_ram_size(gd->fdt_blob, NULL, 0, NULL,
 279                                      (phys_size_t *)&gd->ram_size, gd->bd);
 280 }
 281 #endif
 282 #endif
 283
 284 static void set_fdtfile(void)
 285 {
 286         const char *fdtfile;
 287
 288         if (env_get("fdtfile"))
 289                 return;
 290
 291         fdtfile = model->fdtfile;
 292         env_set("fdtfile", fdtfile);
 293 }
 294
 295 /*
 296  * If the firmware provided a valid FDT at boot time, let's expose it in
 297  * ${fdt_addr} so it may be passed unmodified to the kernel.
 298  */
 299 static void set_fdt_addr(void)
 300 {
 301         if (env_get("fdt_addr"))
 302                 return;
 303
 304         if (fdt_magic(fw_dtb_pointer) != FDT_MAGIC)
 305                 return;
 306
 307         env_set_hex("fdt_addr", fw_dtb_pointer);
 308 }
 309
 310 /*
 311  * Prevent relocation from stomping on a firmware provided FDT blob.
 312  */
 313 unsigned long board_get_usable_ram_top(unsigned long total_size)
 314 {
 315         if ((gd->ram_top - fw_dtb_pointer) > SZ_64M)
 316                 return gd->ram_top;
 317         return fw_dtb_pointer & ~0xffff;
 318 }
 319
 320 static void set_usbethaddr(void)
 321 {
 322         ALLOC_CACHE_ALIGN_BUFFER(struct msg_get_mac_address, msg, 1);
 323         int ret;
 324
 325         if (!model->has_onboard_eth)
 326                 return;
 327
 328         if (env_get("usbethaddr"))
 329                 return;
 330
 331         BCM2835_MBOX_INIT_HDR(msg);
 332         BCM2835_MBOX_INIT_TAG(&msg->get_mac_address, GET_MAC_ADDRESS);
 333
 334         ret = bcm2835_mbox_call_prop(BCM2835_MBOX_PROP_CHAN, &msg->hdr);
 335         if (ret) {
 336                 printf("bcm2835: Could not query MAC address\n");
 337                 /* Ignore error; not critical */
 338                 return;
 339         }
 340
 341         eth_env_set_enetaddr("usbethaddr", msg->get_mac_address.body.resp.mac);
 342
 343         if (!env_get("ethaddr"))
 344                 env_set("ethaddr", env_get("usbethaddr"));
 345
 346         return;
 347 }
 348
 349 #ifdef CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
 350 static void set_board_info(void)
 351 {
 352         char s[11];
 353
 354         snprintf(s, sizeof(s), "0x%X", revision);
 355         env_set("board_revision", s);
 356         snprintf(s, sizeof(s), "%d", rev_scheme);
 357         env_set("board_rev_scheme", s);
 358         /* Can't rename this to board_rev_type since it's an ABI for scripts */
 359         snprintf(s, sizeof(s), "0x%X", rev_type);
 360         env_set("board_rev", s);
 361         env_set("board_name", model->name);
 362 }
 363 #endif /* CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG */
 364
 365 static void set_serial_number(void)
 366 {
 367         ALLOC_CACHE_ALIGN_BUFFER(struct msg_get_board_serial, msg, 1);
 368         int ret;
 369         char serial_string[17] = { 0 };
 370
 371         if (env_get("serial#"))
 372                 return;
 373
 374         BCM2835_MBOX_INIT_HDR(msg);
 375         BCM2835_MBOX_INIT_TAG_NO_REQ(&msg->get_board_serial, GET_BOARD_SERIAL);
 376
 377         ret = bcm2835_mbox_call_prop(BCM2835_MBOX_PROP_CHAN, &msg->hdr);
 378         if (ret) {
 379                 printf("bcm2835: Could not query board serial\n");
 380                 /* Ignore error; not critical */
 381                 return;
 382         }
 383
 384         snprintf(serial_string, sizeof(serial_string), "%016llx",
 385                  msg->get_board_serial.body.resp.serial);
 386         env_set("serial#", serial_string);
 387 }
 388
 389 int misc_init_r(void)
 390 {
 391         set_fdt_addr();
 392         set_fdtfile();
 393         set_usbethaddr();
 394 #ifdef CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
 395         set_board_info();
 396 #endif
 397         set_serial_number();
 398
 399         return 0;
 400 }
 401
 402 static void get_board_rev(void)
 403 {
 404         ALLOC_CACHE_ALIGN_BUFFER(struct msg_get_board_rev, msg, 1);
 405         int ret;
 406         const struct rpi_model *models;
 407         uint32_t models_count;
 408
 409         BCM2835_MBOX_INIT_HDR(msg);
 410         BCM2835_MBOX_INIT_TAG(&msg->get_board_rev, GET_BOARD_REV);
 411
 412         ret = bcm2835_mbox_call_prop(BCM2835_MBOX_PROP_CHAN, &msg->hdr);
 413         if (ret) {
 414                 printf("bcm2835: Could not query board revision\n");
 415                 /* Ignore error; not critical */
 416                 return;
 417         }
 418
 419         /*
 420          * For details of old-vs-new scheme, see:
 421          * https://github.com/pimoroni/RPi.version/blob/master/RPi/version.py
 422          * http://www.raspberrypi.org/forums/viewtopic.php?f=63&t=99293&p=690282
 423          * (a few posts down)
 424          *
 425          * For the RPi 1, bit 24 is the "warranty bit", so we mask off just the
 426          * lower byte to use as the board rev:
 427          * http://www.raspberrypi.org/forums/viewtopic.php?f=63&t=98367&start=250
 428          * http://www.raspberrypi.org/forums/viewtopic.php?f=31&t=20594
 429          */
 430         revision = msg->get_board_rev.body.resp.rev;
 431         if (revision & 0x800000) {
 432                 rev_scheme = 1;
 433                 rev_type = (revision >> 4) & 0xff;
 434                 models = rpi_models_new_scheme;
 435                 models_count = ARRAY_SIZE(rpi_models_new_scheme);
 436         } else {
 437                 rev_scheme = 0;
 438                 rev_type = revision & 0xff;
 439                 models = rpi_models_old_scheme;
 440                 models_count = ARRAY_SIZE(rpi_models_old_scheme);
 441         }
 442         if (rev_type >= models_count) {
 443                 printf("RPI: Board rev 0x%x outside known range\n", rev_type);
 444                 model = &rpi_model_unknown;
 445         } else if (!models[rev_type].name) {
 446                 printf("RPI: Board rev 0x%x unknown\n", rev_type);
 447                 model = &rpi_model_unknown;
 448         } else {
 449                 model = &models[rev_type];
 450         }
 451
 452         printf("RPI %s (0x%x)\n", model->name, revision);
 453 }
 454
 455 int board_init(void)
 456 {
 457 #ifdef CONFIG_HW_WATCHDOG
 458         hw_watchdog_init();
 459 #endif
 460
 461         get_board_rev();
 462
 463         gd->bd->bi_boot_params = 0x100;
 464
 465         return bcm2835_power_on_module(BCM2835_MBOX_POWER_DEVID_USB_HCD);
 466 }
 467
 468 /*
 469  * If the firmware passed a device tree use it for U-Boot.
 470  */
 471 void *board_fdt_blob_setup(void)
 472 {
 473         if (fdt_magic(fw_dtb_pointer) != FDT_MAGIC)
 474                 return NULL;
 475         return (void *)fw_dtb_pointer;
 476 }
 477
 478 int ft_board_setup(void *blob, bd_t *bd)
 479 {
 480         /*
 481          * For now, we simply always add the simplefb DT node. Later, we
 482          * should be more intelligent, and e.g. only do this if no enabled DT
 483          * node exists for the "real" graphics driver.
 484          */
 485         lcd_dt_simplefb_add_node(blob);
 486
 487 #ifdef CONFIG_EFI_LOADER
 488         /* Reserve the spin table */
 489         efi_add_memory_map(0, 1, EFI_RESERVED_MEMORY_TYPE, 0);
 490 #endif
 491
 492         return 0;
 493 }