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