2 * Copyright (c) 2005-2008 Olivier Houchard. All rights reserved.
3 * Copyright (c) 2005-2012 Warner Losh. All rights reserved.
4 * Copyright (c) 2007-2014 Ian Lepore. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * Board init code for the TSC4370, and all other current TSC mainboards.
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/systm.h>
37 #include <arm/at91/at91_pioreg.h>
38 #include <arm/at91/at91_piovar.h>
39 #include <arm/at91/at91_pmcreg.h>
40 #include <arm/at91/at91_pmcvar.h>
41 #include <arm/at91/at91_twireg.h>
42 #include <arm/at91/at91_usartreg.h>
43 #include <arm/at91/at91board.h>
44 #include <arm/at91/at91var.h>
45 #include <arm/at91/at91rm9200var.h>
46 #include <arm/at91/at91rm92reg.h>
47 #include <arm/at91/if_atereg.h>
48 #include <machine/board.h>
49 #include <machine/cpu.h>
50 #include <machine/machdep.h>
51 #include <net/ethernet.h>
52 #include <sys/reboot.h>
55 * RD4HW()/WR4HW() read and write at91rm9200 hardware register space directly.
56 * They serve the same purpose as the RD4()/WR4() idiom you see in many drivers,
57 * except that those translate to bus_space calls, but in this code we need to
58 * access the registers directly before the at91 bus_space stuff is set up.
61 static inline uint32_t
62 RD4HW(uint32_t devbase, uint32_t regoff)
64 return *(volatile uint32_t *)(AT91_BASE + devbase + regoff);
68 WR4HW(uint32_t devbase, uint32_t regoff, uint32_t val)
70 *(volatile uint32_t *)(AT91_BASE + devbase + regoff) = val;
74 * This is the same calculation the at91 uart driver does, we use it to update
75 * the console uart baud rate after changing the MCK rate.
78 #define BAUD2DIVISOR(b) \
79 ((((at91_master_clock * 10) / ((b) * 16)) + 5) / 10)
83 * If doing an in-house build, use tsc_bootinfo.h which is shared with our
84 * custom boot2. Otherwise define some crucial bits of it here, enough to allow
85 * this code to compile.
88 #include <machine/tsc_bootinfo.h>
93 uint32_t bi_flags; /* RB_xxxxx flags from sys/reboot.h */
94 char bi_rootdevname[64];
96 #define TSC_BOOTINFO_MAGIC 0x06C30000
99 static struct arm_boot_params boot_params;
100 static struct tsc_bootinfo inkernel_bootinfo;
103 * Change the master clock config and wait for it to stabilize.
106 change_mckr(uint32_t mckr)
110 WR4HW(AT91RM92_PMC_BASE, PMC_MCKR, mckr);
112 for (i = 0; i < 1000; ++i)
113 if ((RD4HW(AT91RM92_PMC_BASE, PMC_SR) & PMC_IER_MCKRDY))
118 * Allow the master clock frequency to be changed from whatever the bootloader
119 * set up, because sometimes it's harder to change/update a bootloader than it
120 * is to change/update the kernel once a product is in the field.
123 master_clock_init(void)
125 uint32_t mckr = RD4HW(AT91RM92_PMC_BASE, PMC_MCKR);
130 * If there's a hint that specifies the contents of MCKR, use it
131 * without question (it had better be right).
133 * If there's a "mckfreq" hint it might be in hertz or mhz (convert the
134 * latter to hz). Calculate the new MCK divider. If the CPU frequency
135 * is not a sane multiple of the hinted MCK frequency this is likely to
136 * behave badly. The moral is: don't hint at impossibilities.
139 if (resource_int_value("at91", 0, "mckr", &hintvalue) == 0) {
142 hintvalue = 90; /* Default to 90mhz if not specified. */
143 resource_int_value("at91", 0, "mckfreq", &hintvalue);
144 if (hintvalue != 0) {
145 if (hintvalue < 1000)
146 hintvalue *= 1000000;
147 if (hintvalue != at91_master_clock) {
149 struct at91_pmc_clock * cpuclk;
150 cpuclk = at91_pmc_clock_ref("cpu");
151 divider = (cpuclk->hz / hintvalue) - 1;
152 newmckr = (mckr & 0xFFFFFCFF) | ((divider & 0x03) << 8);
153 at91_pmc_clock_deref(cpuclk);
158 /* If the new mckr value is different than what's in the register now,
159 * make the change and wait for the clocks to settle (MCKRDY status).
161 * MCKRDY will never be asserted unless either the selected clock or the
162 * prescaler value changes (but not both at once) [this is detailed in
163 * the rm9200 errata]. This code assumes the prescaler value is always
164 * zero and that by time we get to here we're running on something other
165 * than the slow clock, so to change the mckr divider we first change
166 * back to the slow clock (keeping prescaler and divider unchanged),
167 * then go back to the original selected clock with the new divider.
169 * After changing MCK, go re-init everything clock-related, and reset
170 * the baud rate generator for the console (doing this here is kind of a
171 * rude hack, but hey, you do what you have to to run MCK faster).
174 if (newmckr != 0 && newmckr != mckr) {
176 change_mckr(mckr & ~0x03);
177 change_mckr(newmckr);
178 at91_pmc_init_clock();
179 WR4HW(AT91RM92_DBGU_BASE, USART_BRGR, BAUD2DIVISOR(115200));
184 * TSC-specific code to read the ID eeprom on the mainboard and extract the
185 * unit's EUI-64 which gets translated into a MAC-48 for ethernet.
190 const uint32_t twiHz = 400000;
191 const uint32_t twiCkDiv = 1 << 16;
192 const uint32_t twiChDiv = ((at91_master_clock / twiHz) - 2) << 8;
193 const uint32_t twiClDiv = ((at91_master_clock / twiHz) - 2);
196 * Set the TWCK and TWD lines for Periph A, no pullup, open-drain.
198 at91_pio_use_periph_a(AT91RM92_PIOA_BASE,
199 AT91C_PIO_PA25 | AT91C_PIO_PA26, 0);
200 at91_pio_gpio_high_z(AT91RM92_PIOA_BASE, AT91C_PIO_PA25, 1);
203 * Enable TWI power (irq numbers are also device IDs for power)
205 WR4HW(AT91RM92_PMC_BASE, PMC_PCER, 1u << AT91RM92_IRQ_TWI);
208 * Disable TWI interrupts, reset device, enable Master mode,
209 * disable Slave mode, set the clock.
211 WR4HW(AT91RM92_TWI_BASE, TWI_IDR, 0xffffffff);
212 WR4HW(AT91RM92_TWI_BASE, TWI_CR, TWI_CR_SWRST);
213 WR4HW(AT91RM92_TWI_BASE, TWI_CR, TWI_CR_MSEN | TWI_CR_SVDIS);
214 WR4HW(AT91RM92_TWI_BASE, TWI_CWGR, twiCkDiv | twiChDiv | twiClDiv);
218 eeprom_read(uint32_t EE_DEV_ADDR, uint32_t ee_off, void * buf, uint32_t size)
220 uint8_t *bufptr = (uint8_t *)buf;
224 /* Clean out any old status and received byte. */
225 status = RD4HW(AT91RM92_TWI_BASE, TWI_SR);
226 status = RD4HW(AT91RM92_TWI_BASE, TWI_RHR);
228 /* Set the TWI Master Mode Register */
229 WR4HW(AT91RM92_TWI_BASE, TWI_MMR,
230 TWI_MMR_DADR(EE_DEV_ADDR) | TWI_MMR_IADRSZ(2) | TWI_MMR_MREAD);
232 /* Set TWI Internal Address Register */
233 WR4HW(AT91RM92_TWI_BASE, TWI_IADR, ee_off);
236 WR4HW(AT91RM92_TWI_BASE, TWI_CR, TWI_CR_START);
238 status = RD4HW(AT91RM92_TWI_BASE, TWI_SR);
241 /* Wait until Receive Holding Register is full */
243 while (!(RD4HW(AT91RM92_TWI_BASE, TWI_SR) & TWI_SR_RXRDY) &&
248 /* Read and store byte */
249 *bufptr++ = (uint8_t)RD4HW(AT91RM92_TWI_BASE, TWI_RHR);
251 WR4HW(AT91RM92_TWI_BASE, TWI_CR, TWI_CR_STOP);
253 status = RD4HW(AT91RM92_TWI_BASE, TWI_SR);
255 /* Wait until transfer is finished */
256 while (!(RD4HW(AT91RM92_TWI_BASE, TWI_SR) & TWI_SR_TXCOMP))
260 *bufptr = (uint8_t)RD4HW(AT91RM92_TWI_BASE, TWI_RHR);
266 set_mac_from_idprom(void)
268 #define SIGNATURE_SIZE 4
269 #define EETYPE_SIZE 2
270 #define BSLENGTH_SIZE 2
273 #define BS_SIGNATURE 0x21706d69
274 #define BSO_SIGNATURE 0x216f7362
275 #define DEVOFFSET_BSO_SIGNATURE 0x20
276 #define OFFSET_BS_SIGNATURE 0
277 #define SIZE_BS_SIGNATURE SIGNATURE_SIZE
278 #define OFFSET_EETYPE (OFFSET_BS_SIGNATURE + SIZE_BS_SIGNATURE)
279 #define SIZE_EETYPE EETYPE_SIZE
280 #define OFFSET_BOOTSECTSIZE (OFFSET_EETYPE + SIZE_EETYPE)
281 #define SIZE_BOOTSECTSIZE BSLENGTH_SIZE
282 #define OFFSET_RAW (OFFSET_BOOTSECTSIZE + SIZE_BOOTSECTSIZE)
283 #define OFFSET_EUI64 (OFFSET_RAW + RAW_SIZE)
284 #define EE_DEV_ADDR 0xA0 /* eeprom is AT24C256 at address 0xA0 */
287 uint32_t dev_offset = 0;
289 uint8_t eui64[EUI64_SIZE];
290 uint8_t eaddr[ETHER_ADDR_LEN];
294 /* Check for the boot section signature at offset 0. */
295 status = eeprom_read(EE_DEV_ADDR, OFFSET_BS_SIGNATURE, &sig, sizeof(sig));
299 if (sig != BS_SIGNATURE) {
300 /* Check for the boot section offset signature. */
301 status = eeprom_read(EE_DEV_ADDR,
302 DEVOFFSET_BSO_SIGNATURE, &sig, sizeof(sig));
303 if ((status == -1) || (sig != BSO_SIGNATURE))
306 /* Read the device offset of the boot section structure. */
307 status = eeprom_read(EE_DEV_ADDR,
308 DEVOFFSET_BSO_SIGNATURE + sizeof(sig),
309 &dev_offset, sizeof(dev_offset));
313 /* Check for the boot section signature. */
314 status = eeprom_read(EE_DEV_ADDR,
315 dev_offset + OFFSET_BS_SIGNATURE, &sig, sizeof(sig));
316 if ((status == -1) || (sig != BS_SIGNATURE))
319 dev_offset += OFFSET_EUI64;
321 /* Read the EUI64 from the device. */
322 if (eeprom_read(EE_DEV_ADDR, dev_offset, eui64, sizeof(eui64)) == -1)
325 /* Transcribe the EUI-64 to a MAC-48.
327 * Given an EUI-64 of aa:bb:cc:dd:ee:ff:gg:hh
329 * if (ff is zero and ee is non-zero)
330 * mac is aa:bb:cc:ee:gg:hh
332 * mac is aa:bb:cc:ff:gg:hh
334 * This logic fixes a glitch in our mfg process in which the ff byte was
335 * always zero and the ee byte contained a non-zero value. This
336 * resulted in duplicate MAC addresses because we discarded the ee byte.
337 * Now they've fixed the process so that the ff byte is non-zero and
338 * unique addresses are formed from the ff:gg:hh bytes. If the ff byte
339 * is zero, then we have a unit manufactured during the glitch era, and
340 * we fix the problem by grabbing the ee byte rather than the ff byte.
349 if (eui64[5] == 0 && eui64[4] != 0) {
354 * Set the address in the hardware regs where the ate driver
357 WR4HW(AT91RM92_EMAC_BASE, ETH_SA1L,
358 (eaddr[3] << 24) | (eaddr[2] << 16) | (eaddr[1] << 8) | eaddr[0]);
359 WR4HW(AT91RM92_EMAC_BASE, ETH_SA1H,
360 (eaddr[5] << 8) | (eaddr[4]));
363 "ID: EUI-64 %02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x\n"
364 " MAC-48 %02x:%02x:%02x:%02x:%02x:%02x\n"
365 " read from i2c device 0x%02X offset 0x%x\n",
366 eui64[0], eui64[1], eui64[2], eui64[3],
367 eui64[4], eui64[5], eui64[6], eui64[7],
368 eaddr[0], eaddr[1], eaddr[2],
369 eaddr[3], eaddr[4], eaddr[5],
370 EE_DEV_ADDR, dev_offset);
376 * Assign SPI chip select pins based on which chip selects are found in hints.
379 assign_spi_pins(void)
385 { AT91C_PIO_PA3, "PA3", },
386 { AT91C_PIO_PA4, "PA4", },
387 { AT91C_PIO_PA5, "PA5", },
388 { AT91C_PIO_PA6, "PA6", },
391 uint32_t chipsel_inuse = 0;
394 * Search through all device hints looking for any that have
395 * ".at=spibus0". For each one found, ensure that there is also a
396 * chip select hint ".cs=<num>" and that <num> is 0-3, and assign the
397 * corresponding pin to the SPI peripheral. Whine if we find a SPI
398 * device with a missing or invalid chipsel hint.
401 const char * rName = "";
406 ret = resource_find_match(&anchor, &rName, &unit, "at", "spibus0");
410 ret = resource_int_value(rName, unit, "cs", &cs);
412 printf( "Error: hint for SPI device %s%d "
413 "without a chip select hint; "
414 "device will not function.\n",
418 if (cs < 0 || cs > 3) {
419 printf( "Error: hint for SPI device %s%d "
420 "contains an invalid chip select "
425 if (chipsel_inuse & (1 << cs)) {
426 printf( "Error: hint for SPI device %s%d "
427 "specifies chip select %d, which "
428 "is already used by another device\n",
432 chipsel_inuse |= 1 << cs;
433 at91_pio_use_periph_a(AT91RM92_PIOA_BASE,
434 chipsel_pins[cs].num, 1);
435 printf( "Configured pin %s as SPI chip "
436 "select %d for %s%d\n",
437 chipsel_pins[cs].name, cs, rName, unit);
441 * If there were hints for any SPI devices, assign the basic SPI IO pins
442 * and enable SPI power (irq numbers are also device IDs for power).
444 if (chipsel_inuse != 0) {
445 at91_pio_use_periph_a(AT91RM92_PIOA_BASE,
446 AT91C_PIO_PA1 | AT91C_PIO_PA0 | AT91C_PIO_PA2, 0);
447 WR4HW(AT91RM92_PMC_BASE, PMC_PCER, 1u << AT91RM92_IRQ_SPI);
457 * Deal with bootinfo (if any) passed in from the boot2 bootloader and
458 * copied to the static inkernel_bootinfo earlier in the init. Do this
459 * early so that bootverbose is set from this point on.
461 if (inkernel_bootinfo.bi_size > 0 &&
462 (inkernel_bootinfo.bi_flags & RB_BOOTINFO)) {
463 struct tsc_bootinfo *bip = &inkernel_bootinfo;
464 printf("TSC_BOOTINFO: size %u howtoflags=0x%08x rootdev='%s'\n",
465 bip->bi_size, bip->bi_flags, bip->bi_rootdevname);
466 boothowto = bip->bi_flags;
467 bootverbose = (boothowto & RB_VERBOSE);
468 if (bip->bi_rootdevname[0] != 0)
469 rootdevnames[0] = bip->bi_rootdevname;
473 * The only way to know if we're in a BGA package (and thus have PIOD)
474 * is to be told via a hint; there's nothing detectable in the silicon.
475 * This is esentially an rm92-specific extension to getting the chip ID
476 * (which was done by at91_machdep just before calling this routine).
477 * If it is the BGA package, enable the clock for PIOD.
480 resource_int_value("at91", 0, "is_bga_package", &is_bga);
483 WR4HW(AT91RM92_PMC_BASE, PMC_PCER, 1u << AT91RM92_IRQ_PIOD);
485 #if __FreeBSD_version >= 1000000
486 at91rm9200_set_subtype(is_bga ? AT91_ST_RM9200_BGA :
487 AT91_ST_RM9200_PQFP);
491 * Go reprogram the MCK frequency based on hints.
495 /* From this point on you can use printf. */
500 at91rm9200_config_uart(AT91_ID_DBGU, 0, 0); /* DBGU just Tx and Rx */
501 at91rm9200_config_uart(AT91RM9200_ID_USART0, 1, 0); /* Tx and Rx */
502 at91rm9200_config_uart(AT91RM9200_ID_USART1, 2, 0); /* Tx and Rx */
503 at91rm9200_config_uart(AT91RM9200_ID_USART2, 3, 0); /* Tx and Rx */
504 at91rm9200_config_uart(AT91RM9200_ID_USART3, 4, 0); /* Tx and Rx */
507 * Configure MCI (sdcard)
509 at91rm9200_config_mci(0);
512 * Assign the pins needed by the emac device, and power it up. Also,
513 * configure it for RMII operation unless the 'revmii_mode' hint is set,
514 * in which case configure the full set of MII pins. The revmii_mode
515 * hint is for so-called reverse-MII, used for connections to a Broadcom
516 * 5325E switch on some boards. Note that order is important here:
517 * configure pins, then power on the device, then access the device's
521 resource_int_value("ate", 0, "phy_revmii_mode", &rev_mii);
523 at91_pio_use_periph_a(AT91RM92_PIOA_BASE,
524 AT91C_PIO_PA7 | AT91C_PIO_PA8 | AT91C_PIO_PA9 |
525 AT91C_PIO_PA10 | AT91C_PIO_PA11 | AT91C_PIO_PA12 |
526 AT91C_PIO_PA13 | AT91C_PIO_PA14 | AT91C_PIO_PA15 |
529 at91_pio_use_periph_b(AT91RM92_PIOB_BASE,
530 AT91C_PIO_PB12 | AT91C_PIO_PB13 | AT91C_PIO_PB14 |
531 AT91C_PIO_PB15 | AT91C_PIO_PB16 | AT91C_PIO_PB17 |
532 AT91C_PIO_PB18 | AT91C_PIO_PB19, 0);
534 WR4HW(AT91RM92_PMC_BASE, PMC_PCER, 1u << AT91RM92_IRQ_EMAC);
536 WR4HW(AT91RM92_EMAC_BASE, ETH_CFG,
537 RD4HW(AT91RM92_EMAC_BASE, ETH_CFG) | ETH_CFG_RMII);
541 * Get our ethernet MAC address from the ID eeprom.
542 * Configures TWI as a side effect.
544 set_mac_from_idprom();
554 at91_pio_use_periph_a(
556 AT91C_PIO_PB6 | AT91C_PIO_PB7 | AT91C_PIO_PB8 | /* transmit */
557 AT91C_PIO_PB9 | AT91C_PIO_PB10 | AT91C_PIO_PB11, /* receive */
561 * We're using TC1's A1 input for PPS measurements that drive the
562 * kernel PLL and our NTP refclock. On some old boards we route a 5mhz
563 * signal to TC1's A2 input (pin PA21), but we have never used that
564 * clock (it rolls over too fast for hz=100), and now newer boards are
565 * using pin PA21 as a CTS0 for USART1, so we no longer assign it to
566 * the timer block like we used to here.
568 at91_pio_use_periph_b(AT91RM92_PIOA_BASE, AT91C_PIO_PA19, 0);
571 * Configure pins used to bitbang-upload the firmware to the main FPGA.
573 at91_pio_use_gpio(AT91RM92_PIOB_BASE,
574 AT91C_PIO_PB16 | AT91C_PIO_PB17 | AT91C_PIO_PB18 | AT91C_PIO_PB19);
576 return (at91_ramsize());
580 * Override the default boot param parser (supplied via weak linkage) with one
581 * that knows how to handle our custom tsc_bootinfo passed in from boot2.
584 parse_boot_param(struct arm_boot_params *abp)
590 * If the right magic is in r0 and a non-NULL pointer is in r1, then
591 * it's our bootinfo, copy it. The pointer in r1 is a physical address
592 * passed from boot2. This routine is called immediately upon entry to
593 * initarm() and is in very nearly the same environment as boot2. In
594 * particular, va=pa and we can safely copy the args before we lose easy
595 * access to the memory they're stashed in right now.
597 * Note that all versions of boot2 that we've ever shipped have put
598 * zeroes into r2 and r3. Maybe that'll be useful some day.
600 if (abp->abp_r0 == TSC_BOOTINFO_MAGIC && abp->abp_r1 != 0) {
601 inkernel_bootinfo = *(struct tsc_bootinfo *)(abp->abp_r1);
604 return fake_preload_metadata(abp, NULL, 0);
607 ARM_BOARD(NONE, "TSC4370 Controller Board");