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