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