2 * initcode.c - Initialize the processor. This is usually entails things
3 * like external memory, voltage regulators, etc... Note that this file
4 * cannot make any function calls as it may be executed all by itself by
5 * the Blackfin's bootrom in LDR format.
7 * Copyright (c) 2004-2008 Analog Devices Inc.
9 * Licensed under the GPL-2 or later.
12 #define BFIN_IN_INITCODE
15 #include <asm/blackfin.h>
16 #include <asm/mach-common/bits/bootrom.h>
17 #include <asm/mach-common/bits/core.h>
18 #include <asm/mach-common/bits/ebiu.h>
19 #include <asm/mach-common/bits/pll.h>
20 #include <asm/mach-common/bits/uart.h>
24 __attribute__((always_inline))
25 static inline void serial_init(void)
28 # ifdef BFIN_BOOT_UART_USE_RTS
29 # define BFIN_UART_USE_RTS 1
31 # define BFIN_UART_USE_RTS 0
33 if (BFIN_UART_USE_RTS && CONFIG_BFIN_BOOT_MODE == BFIN_BOOT_UART) {
36 /* force RTS rather than relying on auto RTS */
37 bfin_write_UART1_MCR(bfin_read_UART1_MCR() | FCPOL);
39 /* Wait for the line to clear up. We cannot rely on UART
40 * registers as none of them reflect the status of the RSR.
41 * Instead, we'll sleep for ~10 bit times at 9600 baud.
42 * We can precalc things here by assuming boot values for
43 * PLL rather than loading registers and calculating.
44 * baud = SCLK / (16 ^ (1 - EDBO) * Divisor)
46 * Divisor = (SCLK / baud) / 16
47 * SCLK = baud * 16 * Divisor
48 * SCLK = (0x14 * CONFIG_CLKIN_HZ) / 5
49 * CCLK = (16 * Divisor * 5) * (9600 / 10)
50 * In reality, this will probably be just about 1 second delay,
51 * so assuming 9600 baud is OK (both as a very low and too high
52 * speed as this will buffer things enough).
54 #define _NUMBITS (10) /* how many bits to delay */
55 #define _LOWBAUD (9600) /* low baud rate */
56 #define _SCLK ((0x14 * CONFIG_CLKIN_HZ) / 5) /* SCLK based on PLL */
57 #define _DIVISOR ((_SCLK / _LOWBAUD) / 16) /* UART DLL/DLH */
58 #define _NUMINS (3) /* how many instructions in loop */
59 #define _CCLK (((16 * _DIVISOR * 5) * (_LOWBAUD / _NUMBITS)) / _NUMINS)
62 asm volatile("" : : : "memory");
66 if (BFIN_DEBUG_EARLY_SERIAL) {
67 int ucen = *pUART_GCTL & UCEN;
70 /* If the UART is off, that means we need to program
71 * the baud rate ourselves initially.
74 serial_early_set_baud(CONFIG_BAUDRATE);
78 __attribute__((always_inline))
79 static inline void serial_deinit(void)
82 if (BFIN_UART_USE_RTS && CONFIG_BFIN_BOOT_MODE == BFIN_BOOT_UART) {
83 /* clear forced RTS rather than relying on auto RTS */
84 bfin_write_UART1_MCR(bfin_read_UART1_MCR() & ~FCPOL);
89 __attribute__((always_inline))
90 static inline void serial_putc(char c)
92 if (!BFIN_DEBUG_EARLY_SERIAL)
100 while (!(*pUART_LSR & TEMT))
105 /* Max SCLK can be 133MHz ... dividing that by (2*4) gives
106 * us a freq of 16MHz for SPI which should generally be
107 * slow enough for the slow reads the bootrom uses.
109 #if !defined(CONFIG_SPI_FLASH_SLOW_READ) && \
110 ((defined(__ADSPBF52x__) && __SILICON_REVISION__ >= 2) || \
111 (defined(__ADSPBF54x__) && __SILICON_REVISION__ >= 1))
112 # define BOOTROM_SUPPORTS_SPI_FAST_READ 1
114 # define BOOTROM_SUPPORTS_SPI_FAST_READ 0
116 #ifndef CONFIG_SPI_BAUD_INITBLOCK
117 # define CONFIG_SPI_BAUD_INITBLOCK (BOOTROM_SUPPORTS_SPI_FAST_READ ? 2 : 4)
120 # define bfin_write_SPI_BAUD bfin_write_SPI0_BAUD
123 /* PLL_DIV defines */
124 #ifndef CONFIG_PLL_DIV_VAL
125 # if (CONFIG_CCLK_DIV == 1)
126 # define CONFIG_CCLK_ACT_DIV CCLK_DIV1
127 # elif (CONFIG_CCLK_DIV == 2)
128 # define CONFIG_CCLK_ACT_DIV CCLK_DIV2
129 # elif (CONFIG_CCLK_DIV == 4)
130 # define CONFIG_CCLK_ACT_DIV CCLK_DIV4
131 # elif (CONFIG_CCLK_DIV == 8)
132 # define CONFIG_CCLK_ACT_DIV CCLK_DIV8
134 # define CONFIG_CCLK_ACT_DIV CONFIG_CCLK_DIV_not_defined_properly
136 # define CONFIG_PLL_DIV_VAL (CONFIG_CCLK_ACT_DIV | CONFIG_SCLK_DIV)
139 #ifndef CONFIG_PLL_LOCKCNT_VAL
140 # define CONFIG_PLL_LOCKCNT_VAL 0x0300
143 #ifndef CONFIG_PLL_CTL_VAL
144 # define CONFIG_PLL_CTL_VAL (SPORT_HYST | (CONFIG_VCO_MULT << 9) | CONFIG_CLKIN_HALF)
147 #ifndef CONFIG_EBIU_RSTCTL_VAL
148 # define CONFIG_EBIU_RSTCTL_VAL 0 /* only MDDRENABLE is useful */
150 #if ((CONFIG_EBIU_RSTCTL_VAL & 0xFFFFFFC4) != 0)
151 # error invalid EBIU_RSTCTL value: must not set reserved bits
154 #ifndef CONFIG_EBIU_MBSCTL_VAL
155 # define CONFIG_EBIU_MBSCTL_VAL 0
158 #if defined(CONFIG_EBIU_DDRQUE_VAL) && ((CONFIG_EBIU_DDRQUE_VAL & 0xFFFF8000) != 0)
159 # error invalid EBIU_DDRQUE value: must not set reserved bits
162 /* Make sure our voltage value is sane so we don't blow up! */
163 #ifndef CONFIG_VR_CTL_VAL
164 # define BFIN_CCLK ((CONFIG_CLKIN_HZ * CONFIG_VCO_MULT) / CONFIG_CCLK_DIV)
165 # if defined(__ADSPBF533__) || defined(__ADSPBF532__) || defined(__ADSPBF531__)
166 # define CCLK_VLEV_120 400000000
167 # define CCLK_VLEV_125 533000000
168 # elif defined(__ADSPBF537__) || defined(__ADSPBF536__) || defined(__ADSPBF534__)
169 # define CCLK_VLEV_120 401000000
170 # define CCLK_VLEV_125 401000000
171 # elif defined(__ADSPBF561__)
172 # define CCLK_VLEV_120 300000000
173 # define CCLK_VLEV_125 501000000
175 # if BFIN_CCLK < CCLK_VLEV_120
176 # define CONFIG_VR_CTL_VLEV VLEV_120
177 # elif BFIN_CCLK < CCLK_VLEV_125
178 # define CONFIG_VR_CTL_VLEV VLEV_125
180 # define CONFIG_VR_CTL_VLEV VLEV_130
182 # if defined(__ADSPBF52x__) /* TBD; use default */
183 # undef CONFIG_VR_CTL_VLEV
184 # define CONFIG_VR_CTL_VLEV VLEV_110
185 # elif defined(__ADSPBF54x__) /* TBD; use default */
186 # undef CONFIG_VR_CTL_VLEV
187 # define CONFIG_VR_CTL_VLEV VLEV_120
188 # elif defined(__ADSPBF538__) || defined(__ADSPBF539__) /* TBD; use default */
189 # undef CONFIG_VR_CTL_VLEV
190 # define CONFIG_VR_CTL_VLEV VLEV_125
193 # ifdef CONFIG_BFIN_MAC
194 # define CONFIG_VR_CTL_CLKBUF CLKBUFOE
196 # define CONFIG_VR_CTL_CLKBUF 0
199 # if defined(__ADSPBF52x__)
200 # define CONFIG_VR_CTL_FREQ FREQ_1000
202 # define CONFIG_VR_CTL_FREQ (GAIN_20 | FREQ_1000)
205 # define CONFIG_VR_CTL_VAL (CONFIG_VR_CTL_CLKBUF | CONFIG_VR_CTL_VLEV | CONFIG_VR_CTL_FREQ)
208 /* some parts do not have an on-chip voltage regulator */
209 #if defined(__ADSPBF51x__)
210 # define CONFIG_HAS_VR 0
211 # undef CONFIG_VR_CTL_VAL
212 # define CONFIG_VR_CTL_VAL 0
214 # define CONFIG_HAS_VR 1
219 /* Blackfin with SDRAM */
220 #ifndef CONFIG_EBIU_SDBCTL_VAL
221 # if CONFIG_MEM_SIZE == 16
222 # define CONFIG_EBSZ_VAL EBSZ_16
223 # elif CONFIG_MEM_SIZE == 32
224 # define CONFIG_EBSZ_VAL EBSZ_32
225 # elif CONFIG_MEM_SIZE == 64
226 # define CONFIG_EBSZ_VAL EBSZ_64
227 # elif CONFIG_MEM_SIZE == 128
228 # define CONFIG_EBSZ_VAL EBSZ_128
229 # elif CONFIG_MEM_SIZE == 256
230 # define CONFIG_EBSZ_VAL EBSZ_256
231 # elif CONFIG_MEM_SIZE == 512
232 # define CONFIG_EBSZ_VAL EBSZ_512
234 # error You need to define CONFIG_EBIU_SDBCTL_VAL or CONFIG_MEM_SIZE
236 # if CONFIG_MEM_ADD_WDTH == 8
237 # define CONFIG_EBCAW_VAL EBCAW_8
238 # elif CONFIG_MEM_ADD_WDTH == 9
239 # define CONFIG_EBCAW_VAL EBCAW_9
240 # elif CONFIG_MEM_ADD_WDTH == 10
241 # define CONFIG_EBCAW_VAL EBCAW_10
242 # elif CONFIG_MEM_ADD_WDTH == 11
243 # define CONFIG_EBCAW_VAL EBCAW_11
245 # error You need to define CONFIG_EBIU_SDBCTL_VAL or CONFIG_MEM_ADD_WDTH
247 # define CONFIG_EBIU_SDBCTL_VAL (CONFIG_EBCAW_VAL | CONFIG_EBSZ_VAL | EBE)
252 /* Conflicting Column Address Widths Causes SDRAM Errors:
253 * EB2CAW and EB3CAW must be the same
256 # if ((CONFIG_EBIU_SDBCTL_VAL & 0x30000000) >> 8) != (CONFIG_EBIU_SDBCTL_VAL & 0x00300000)
257 # error "Anomaly 05000362: EB2CAW and EB3CAW must be the same"
261 __attribute__((always_inline)) static inline void
262 program_early_devices(ADI_BOOT_DATA *bs, uint *sdivB, uint *divB, uint *vcoB)
266 /* Save the clock pieces that are used in baud rate calculation */
267 if (BFIN_DEBUG_EARLY_SERIAL || CONFIG_BFIN_BOOT_MODE == BFIN_BOOT_UART) {
269 *sdivB = bfin_read_PLL_DIV() & 0xf;
270 *vcoB = (bfin_read_PLL_CTL() >> 9) & 0x3f;
271 *divB = serial_early_get_div();
277 #ifdef CONFIG_HW_WATCHDOG
278 # ifndef CONFIG_HW_WATCHDOG_TIMEOUT_INITCODE
279 # define CONFIG_HW_WATCHDOG_TIMEOUT_INITCODE 20000
281 /* Program the watchdog with an initial timeout of ~20 seconds.
282 * Hopefully that should be long enough to load the u-boot LDR
283 * (from wherever) and then the common u-boot code can take over.
284 * In bypass mode, the start.S would have already set a much lower
285 * timeout, so don't clobber that.
287 if (CONFIG_BFIN_BOOT_MODE != BFIN_BOOT_BYPASS) {
289 bfin_write_WDOG_CNT(MSEC_TO_SCLK(CONFIG_HW_WATCHDOG_TIMEOUT_INITCODE));
290 bfin_write_WDOG_CTL(0);
297 /* Blackfin bootroms use the SPI slow read opcode instead of the SPI
298 * fast read, so we need to slow down the SPI clock a lot more during
299 * boot. Once we switch over to u-boot's SPI flash driver, we'll
300 * increase the speed appropriately.
302 if (CONFIG_BFIN_BOOT_MODE == BFIN_BOOT_SPI_MASTER) {
304 if (BOOTROM_SUPPORTS_SPI_FAST_READ && CONFIG_SPI_BAUD_INITBLOCK < 4)
305 bs->dFlags |= BFLAG_FASTREAD;
306 bfin_write_SPI_BAUD(CONFIG_SPI_BAUD_INITBLOCK);
313 __attribute__((always_inline)) static inline bool
314 maybe_self_refresh(ADI_BOOT_DATA *bs)
318 if (!CONFIG_MEM_SIZE)
321 /* If external memory is enabled, put it into self refresh first. */
323 if (bfin_read_EBIU_RSTCTL() & DDR_SRESET) {
325 bfin_write_EBIU_RSTCTL(bfin_read_EBIU_RSTCTL() | SRREQ);
329 if (bfin_read_EBIU_SDBCTL() & EBE) {
331 bfin_write_EBIU_SDGCTL(bfin_read_EBIU_SDGCTL() | SRFS);
341 __attribute__((always_inline)) static inline u16
342 program_clocks(ADI_BOOT_DATA *bs, bool put_into_srfs)
348 vr_ctl = bfin_read_VR_CTL();
352 /* If we're entering self refresh, make sure it has happened. */
355 while (!(bfin_read_EBIU_RSTCTL() & SRACK))
357 while (!(bfin_read_EBIU_SDSTAT() & SDSRA))
363 /* With newer bootroms, we use the helper function to set up
364 * the memory controller. Older bootroms lacks such helpers
365 * so we do it ourselves.
367 if (!ANOMALY_05000386) {
370 /* Always programming PLL_LOCKCNT avoids Anomaly 05000430 */
371 ADI_SYSCTRL_VALUES memory_settings;
372 uint32_t actions = SYSCTRL_WRITE | SYSCTRL_PLLCTL | SYSCTRL_PLLDIV | SYSCTRL_LOCKCNT;
374 actions |= SYSCTRL_VRCTL;
375 if (CONFIG_VR_CTL_VAL & FREQ_MASK)
376 actions |= SYSCTRL_INTVOLTAGE;
378 actions |= SYSCTRL_EXTVOLTAGE;
379 memory_settings.uwVrCtl = CONFIG_VR_CTL_VAL;
381 actions |= SYSCTRL_EXTVOLTAGE;
382 memory_settings.uwPllCtl = CONFIG_PLL_CTL_VAL;
383 memory_settings.uwPllDiv = CONFIG_PLL_DIV_VAL;
384 memory_settings.uwPllLockCnt = CONFIG_PLL_LOCKCNT_VAL;
386 bfin_write_SIC_IWR1(0);
389 bfrom_SysControl(actions, &memory_settings, NULL);
392 bfin_write_SIC_IWR1(-1);
395 bfin_write_SICA_IWR0(-1);
396 bfin_write_SICA_IWR1(-1);
402 /* Disable all peripheral wakeups except for the PLL event. */
404 bfin_write_SIC_IWR0(1);
405 bfin_write_SIC_IWR1(0);
407 bfin_write_SIC_IWR2(0);
409 #elif defined(SICA_IWR0)
410 bfin_write_SICA_IWR0(1);
411 bfin_write_SICA_IWR1(0);
413 bfin_write_SIC_IWR(1);
418 /* Always programming PLL_LOCKCNT avoids Anomaly 05000430 */
419 bfin_write_PLL_LOCKCNT(CONFIG_PLL_LOCKCNT_VAL);
423 /* Only reprogram when needed to avoid triggering unnecessary
424 * PLL relock sequences.
426 if (vr_ctl != CONFIG_VR_CTL_VAL) {
428 bfin_write_VR_CTL(CONFIG_VR_CTL_VAL);
435 bfin_write_PLL_DIV(CONFIG_PLL_DIV_VAL);
439 /* Only reprogram when needed to avoid triggering unnecessary
440 * PLL relock sequences.
442 if (ANOMALY_05000242 || bfin_read_PLL_CTL() != CONFIG_PLL_CTL_VAL) {
444 bfin_write_PLL_CTL(CONFIG_PLL_CTL_VAL);
451 /* Restore all peripheral wakeups. */
453 bfin_write_SIC_IWR0(-1);
454 bfin_write_SIC_IWR1(-1);
456 bfin_write_SIC_IWR2(-1);
458 #elif defined(SICA_IWR0)
459 bfin_write_SICA_IWR0(-1);
460 bfin_write_SICA_IWR1(-1);
462 bfin_write_SIC_IWR(-1);
473 __attribute__((always_inline)) static inline void
474 update_serial_clocks(ADI_BOOT_DATA *bs, uint sdivB, uint divB, uint vcoB)
478 /* Since we've changed the SCLK above, we may need to update
479 * the UART divisors (UART baud rates are based on SCLK).
480 * Do the division by hand as there are no native instructions
481 * for dividing which means we'd generate a libgcc reference.
483 if (CONFIG_BFIN_BOOT_MODE == BFIN_BOOT_UART) {
485 unsigned int sdivR, vcoR;
486 sdivR = bfin_read_PLL_DIV() & 0xf;
487 vcoR = (bfin_read_PLL_CTL() >> 9) & 0x3f;
488 int dividend = sdivB * divB * vcoR;
489 int divisor = vcoB * sdivR;
490 unsigned int quotient;
491 for (quotient = 0; dividend > 0; ++quotient)
493 serial_early_put_div(quotient - ANOMALY_05000230);
500 __attribute__((always_inline)) static inline void
501 program_memory_controller(ADI_BOOT_DATA *bs, bool put_into_srfs)
505 if (!CONFIG_MEM_SIZE)
510 /* Program the external memory controller before we come out of
511 * self-refresh. This only works with our SDRAM controller.
514 # ifdef CONFIG_EBIU_SDRRC_VAL
515 bfin_write_EBIU_SDRRC(CONFIG_EBIU_SDRRC_VAL);
517 # ifdef CONFIG_EBIU_SDBCTL_VAL
518 bfin_write_EBIU_SDBCTL(CONFIG_EBIU_SDBCTL_VAL);
520 # ifdef CONFIG_EBIU_SDGCTL_VAL
521 bfin_write_EBIU_SDGCTL(CONFIG_EBIU_SDGCTL_VAL);
527 /* Now that we've reprogrammed, take things out of self refresh. */
530 bfin_write_EBIU_RSTCTL(bfin_read_EBIU_RSTCTL() & ~(SRREQ));
532 bfin_write_EBIU_SDGCTL(bfin_read_EBIU_SDGCTL() & ~(SRFS));
537 /* Our DDR controller sucks and cannot be programmed while in
538 * self-refresh. So we have to pull it out before programming.
541 # ifdef CONFIG_EBIU_RSTCTL_VAL
542 bfin_write_EBIU_RSTCTL(bfin_read_EBIU_RSTCTL() | 0x1 /*DDRSRESET*/ | CONFIG_EBIU_RSTCTL_VAL);
544 # ifdef CONFIG_EBIU_DDRCTL0_VAL
545 bfin_write_EBIU_DDRCTL0(CONFIG_EBIU_DDRCTL0_VAL);
547 # ifdef CONFIG_EBIU_DDRCTL1_VAL
548 bfin_write_EBIU_DDRCTL1(CONFIG_EBIU_DDRCTL1_VAL);
550 # ifdef CONFIG_EBIU_DDRCTL2_VAL
551 bfin_write_EBIU_DDRCTL2(CONFIG_EBIU_DDRCTL2_VAL);
553 # ifdef CONFIG_EBIU_DDRCTL3_VAL
554 /* default is disable, so don't need to force this */
555 bfin_write_EBIU_DDRCTL3(CONFIG_EBIU_DDRCTL3_VAL);
557 # ifdef CONFIG_EBIU_DDRQUE_VAL
558 bfin_write_EBIU_DDRQUE(bfin_read_EBIU_DDRQUE() | CONFIG_EBIU_DDRQUE_VAL);
565 __attribute__((always_inline)) static inline void
566 check_hibernation(ADI_BOOT_DATA *bs, u16 vr_ctl, bool put_into_srfs)
570 if (!CONFIG_MEM_SIZE)
575 /* Are we coming out of hibernate (suspend to memory) ?
576 * The memory layout is:
577 * 0x0: hibernate magic for anomaly 307 (0xDEADBEEF)
578 * 0x4: return address
581 * SCKELOW is unreliable on older parts (anomaly 307)
583 if (ANOMALY_05000307 || vr_ctl & 0x8000) {
584 uint32_t *hibernate_magic = 0;
585 __builtin_bfin_ssync(); /* make sure memory controller is done */
586 if (hibernate_magic[0] == 0xDEADBEEF) {
588 bfin_write_EVT15(hibernate_magic[1]);
589 bfin_write_IMASK(EVT_IVG15);
590 __asm__ __volatile__ (
591 /* load reti early to avoid anomaly 281 */
593 /* clear hibernate magic */
595 /* load stack pointer */
597 /* lower ourselves from reset ivg to ivg15 */
601 : "p"(hibernate_magic), "d"(0x2000 /* jump.s 0 */)
610 __attribute__((always_inline)) static inline void
611 program_async_controller(ADI_BOOT_DATA *bs)
615 /* Program the async banks controller. */
616 bfin_write_EBIU_AMBCTL0(CONFIG_EBIU_AMBCTL0_VAL);
617 bfin_write_EBIU_AMBCTL1(CONFIG_EBIU_AMBCTL1_VAL);
618 bfin_write_EBIU_AMGCTL(CONFIG_EBIU_AMGCTL_VAL);
622 /* Not all parts have these additional MMRs. */
624 # ifdef CONFIG_EBIU_MBSCTL_VAL
625 bfin_write_EBIU_MBSCTL(CONFIG_EBIU_MBSCTL_VAL);
627 # ifdef CONFIG_EBIU_MODE_VAL
628 bfin_write_EBIU_MODE(CONFIG_EBIU_MODE_VAL);
630 # ifdef CONFIG_EBIU_FCTL_VAL
631 bfin_write_EBIU_FCTL(CONFIG_EBIU_FCTL_VAL);
638 BOOTROM_CALLED_FUNC_ATTR
639 void initcode(ADI_BOOT_DATA *bs)
641 ADI_BOOT_DATA bootstruct_scratch;
647 /* If the bootstruct is NULL, then it's because we're loading
648 * dynamically and not via LDR (bootrom). So set the struct to
649 * some scratch space.
652 bs = &bootstruct_scratch;
655 bool put_into_srfs = maybe_self_refresh(bs);
658 uint sdivB, divB, vcoB;
659 program_early_devices(bs, &sdivB, &divB, &vcoB);
662 u16 vr_ctl = program_clocks(bs, put_into_srfs);
665 update_serial_clocks(bs, sdivB, divB, vcoB);
668 program_memory_controller(bs, put_into_srfs);
671 check_hibernation(bs, vr_ctl, put_into_srfs);
674 program_async_controller(bs);
676 #ifdef CONFIG_BFIN_BOOTROM_USES_EVT1
678 /* tell the bootrom where our entry point is */
679 if (CONFIG_BFIN_BOOT_MODE != BFIN_BOOT_BYPASS)
680 bfin_write_EVT1(CONFIG_SYS_MONITOR_BASE);