1 /***********************license start***************
2 * Copyright (c) 2003-2010 Cavium Inc. (support@cavium.com). All rights
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
18 * * Neither the name of Cavium Inc. nor the names of
19 * its contributors may be used to endorse or promote products
20 * derived from this software without specific prior written
23 * This Software, including technical data, may be subject to U.S. export control
24 * laws, including the U.S. Export Administration Act and its associated
25 * regulations, and may be subject to export or import regulations in other
28 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
29 * AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR
30 * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
31 * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR
32 * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM
33 * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE,
34 * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF
35 * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
36 * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT OF USE OR
37 * PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
38 ***********************license end**************************************/
50 #include "executive-config.h"
51 #include "cvmx-config.h"
53 #include "cvmx-spinlock.h"
54 #include <octeon-app-init.h>
55 #include "cvmx-sysinfo.h"
56 #include "cvmx-bootmem.h"
57 #include "cvmx-uart.h"
58 #include "cvmx-coremask.h"
59 #include "cvmx-core.h"
60 #include "cvmx-interrupt.h"
61 #include "cvmx-ebt3000.h"
62 #include "cvmx-sim-magic.h"
63 #include "cvmx-debug.h"
65 #include "cvmx-scratch.h"
66 #include "cvmx-helper-cfg.h"
67 #include "cvmx-helper-jtag.h"
68 #include <octeon_mem_map.h>
70 int cvmx_debug_uart = -1;
75 * Main entry point for all simple executive based programs.
79 extern void cvmx_interrupt_initialize(void);
84 * Main entry point for all simple executive based programs.
85 * This is the first C function called. It completes
86 * initialization, calls main, and performs C level cleanup.
88 * @param app_desc_addr
89 * Address of the application description structure passed
90 * brom the boot loader.
92 EXTERN_ASM void __cvmx_app_init(uint64_t app_desc_addr);
96 * Set up sysinfo structure from boot descriptor versions 6 and higher.
97 * In these versions, the interesting data in not in the boot info structure
98 * defined by the toolchain, but is in the cvmx_bootinfo structure defined in
101 * @param app_desc_ptr
102 * pointer to boot descriptor block
104 * @param sys_info_ptr
105 * pointer to sysinfo structure to fill in
107 static void process_boot_desc_ver_6(octeon_boot_descriptor_t *app_desc_ptr, cvmx_sysinfo_t *sys_info_ptr)
109 cvmx_bootinfo_t *cvmx_bootinfo_ptr = CASTPTR(cvmx_bootinfo_t, app_desc_ptr->cvmx_desc_vaddr);
111 /* copy application information for simple exec use */
112 /* Populate the sys_info structure from the boot descriptor block created by the bootloader.
113 ** The boot descriptor block is put in the top of the heap, so it will be overwritten when the
114 ** heap is fully used. Information that is to be used must be copied before that.
115 ** Applications should only use the sys_info structure, not the boot descriptor
117 if (cvmx_bootinfo_ptr->major_version == 1)
119 sys_info_ptr->core_mask = cvmx_bootinfo_ptr->core_mask;
120 sys_info_ptr->heap_base = cvmx_bootinfo_ptr->heap_base;
121 sys_info_ptr->heap_size = cvmx_bootinfo_ptr->heap_end - cvmx_bootinfo_ptr->heap_base;
122 sys_info_ptr->stack_top = cvmx_bootinfo_ptr->stack_top;
123 sys_info_ptr->stack_size = cvmx_bootinfo_ptr->stack_size;
124 sys_info_ptr->init_core = cvmx_get_core_num();
125 sys_info_ptr->phy_mem_desc_addr = cvmx_bootinfo_ptr->phy_mem_desc_addr;
126 sys_info_ptr->exception_base_addr = cvmx_bootinfo_ptr->exception_base_addr;
127 sys_info_ptr->cpu_clock_hz = cvmx_bootinfo_ptr->eclock_hz;
128 sys_info_ptr->dram_data_rate_hz = cvmx_bootinfo_ptr->dclock_hz * 2;
130 sys_info_ptr->board_type = cvmx_bootinfo_ptr->board_type;
131 sys_info_ptr->board_rev_major = cvmx_bootinfo_ptr->board_rev_major;
132 sys_info_ptr->board_rev_minor = cvmx_bootinfo_ptr->board_rev_minor;
133 memcpy(sys_info_ptr->mac_addr_base, cvmx_bootinfo_ptr->mac_addr_base, 6);
134 sys_info_ptr->mac_addr_count = cvmx_bootinfo_ptr->mac_addr_count;
135 memcpy(sys_info_ptr->board_serial_number, cvmx_bootinfo_ptr->board_serial_number, CVMX_BOOTINFO_OCTEON_SERIAL_LEN);
136 sys_info_ptr->console_uart_num = 0;
137 if (cvmx_bootinfo_ptr->flags & OCTEON_BL_FLAG_CONSOLE_UART1)
138 sys_info_ptr->console_uart_num = 1;
140 if (cvmx_bootinfo_ptr->dram_size > 32*1024*1024)
141 sys_info_ptr->system_dram_size = (uint64_t)cvmx_bootinfo_ptr->dram_size; /* older bootloaders incorrectly gave this in bytes, so don't convert */
143 sys_info_ptr->system_dram_size = (uint64_t)cvmx_bootinfo_ptr->dram_size * 1024 * 1024; /* convert from Megabytes to bytes */
144 if (cvmx_bootinfo_ptr->minor_version >= 1)
146 sys_info_ptr->compact_flash_common_base_addr = cvmx_bootinfo_ptr->compact_flash_common_base_addr;
147 sys_info_ptr->compact_flash_attribute_base_addr = cvmx_bootinfo_ptr->compact_flash_attribute_base_addr;
148 sys_info_ptr->led_display_base_addr = cvmx_bootinfo_ptr->led_display_base_addr;
150 else if (sys_info_ptr->board_type == CVMX_BOARD_TYPE_EBT3000 ||
151 sys_info_ptr->board_type == CVMX_BOARD_TYPE_EBT5800 ||
152 sys_info_ptr->board_type == CVMX_BOARD_TYPE_EBT5810)
154 /* Default these variables so that users of structure can be the same no
155 ** matter what version fo boot info block the bootloader passes */
156 sys_info_ptr->compact_flash_common_base_addr = 0x1d000000 + 0x800;
157 sys_info_ptr->compact_flash_attribute_base_addr = 0x1d010000;
158 if (sys_info_ptr->board_rev_major == 1)
159 sys_info_ptr->led_display_base_addr = 0x1d020000;
161 sys_info_ptr->led_display_base_addr = 0x1d020000 + 0xf8;
165 sys_info_ptr->compact_flash_common_base_addr = 0;
166 sys_info_ptr->compact_flash_attribute_base_addr = 0;
167 sys_info_ptr->led_display_base_addr = 0;
170 if (cvmx_bootinfo_ptr->minor_version >= 2)
172 sys_info_ptr->dfa_ref_clock_hz = cvmx_bootinfo_ptr->dfa_ref_clock_hz;
173 sys_info_ptr->bootloader_config_flags = cvmx_bootinfo_ptr->config_flags;
177 sys_info_ptr->dfa_ref_clock_hz = 0;
178 sys_info_ptr->bootloader_config_flags = 0;
179 if (app_desc_ptr->flags & OCTEON_BL_FLAG_DEBUG)
180 sys_info_ptr->bootloader_config_flags |= CVMX_BOOTINFO_CFG_FLAG_DEBUG;
181 if (app_desc_ptr->flags & OCTEON_BL_FLAG_NO_MAGIC)
182 sys_info_ptr->bootloader_config_flags |= CVMX_BOOTINFO_CFG_FLAG_NO_MAGIC;
188 printf("ERROR: Incompatible CVMX descriptor passed by bootloader: %d.%d\n",
189 (int)cvmx_bootinfo_ptr->major_version, (int)cvmx_bootinfo_ptr->minor_version);
192 if ((cvmx_bootinfo_ptr->minor_version >= 3) && (cvmx_bootinfo_ptr->fdt_addr != 0))
194 sys_info_ptr->fdt_addr = UNMAPPED_PTR(cvmx_bootinfo_ptr->fdt_addr);
195 if (fdt_check_header((const void *)sys_info_ptr->fdt_addr))
197 printf("ERROR : Corrupt Device Tree.\n");
200 printf("Using device tree\n");
204 sys_info_ptr->fdt_addr = 0;
210 * Interrupt handler for calling exit on Control-C interrupts.
212 * @param irq_number IRQ interrupt number
213 * @param registers CPU registers at the time of the interrupt
214 * @param user_arg Unused user argument
216 static void process_break_interrupt(int irq_number, uint64_t registers[32], void *user_arg)
218 /* Exclude new functionality when building with older toolchains */
219 #if OCTEON_APP_INIT_H_VERSION >= 3
220 int uart = irq_number - CVMX_IRQ_UART0;
221 cvmx_uart_lsr_t lsrval;
223 /* Check for a Control-C interrupt from the console. This loop will eat
224 all input received on the uart */
225 lsrval.u64 = cvmx_read_csr(CVMX_MIO_UARTX_LSR(uart));
228 int c = cvmx_read_csr(CVMX_MIO_UARTX_RBR(uart));
231 register uint64_t tmp;
233 /* Wait for an another Control-C if right now we have no
234 access to the console. After this point we hold the
235 lock and use a different lock to synchronize between
236 the memfile dumps from different cores. As a
237 consequence regular printfs *don't* work after this
239 if (__octeon_uart_trylock () == 1)
242 /* Pulse MCD0 signal on Ctrl-C to stop all the cores. Also
243 set the MCD0 to be not masked by this core so we know
244 the signal is received by someone */
247 "ori %0, %0, 0x1110\n"
251 lsrval.u64 = cvmx_read_csr(CVMX_MIO_UARTX_LSR(uart));
257 * This is the debug exception handler with "break". Before calling exit to
258 * dump the profile-feedback output it releases the lock on the console.
259 * This way if there is buffered data in stdout it can still be flushed.
260 * stdio is required to flush all output during an fread.
263 static void exit_on_break(void)
265 #if OCTEON_APP_INIT_H_VERSION >= 4
266 unsigned int coremask = cvmx_sysinfo_get()->core_mask;
268 cvmx_coremask_barrier_sync(coremask);
269 if (cvmx_coremask_first_core(coremask))
270 __octeon_uart_unlock();
276 /* Add string signature to applications so that we can easily tell what
277 ** Octeon revision they were compiled for. Don't make static to avoid unused
278 ** variable warning. */
279 #define xstr(s) str(s)
282 int octeon_model_version_check(uint32_t chip_id);
284 #define OMS xstr(OCTEON_MODEL)
285 char octeon_rev_signature[] =
286 #ifdef USE_RUNTIME_MODEL_CHECKS
287 "Compiled for runtime Octeon model checking";
289 "Compiled for Octeon processor id: "OMS;
292 #define OCTEON_BL_FLAG_HPLUG_CORES (1 << 6)
293 void __cvmx_app_init(uint64_t app_desc_addr)
295 /* App descriptor used by bootloader */
296 octeon_boot_descriptor_t *app_desc_ptr = CASTPTR(octeon_boot_descriptor_t, app_desc_addr);
298 /* app info structure used by the simple exec */
299 cvmx_sysinfo_t *sys_info_ptr = cvmx_sysinfo_get();
302 //printf("coremask=%08x flags=%08x \n", app_desc_ptr->core_mask, app_desc_ptr->flags);
303 if (cvmx_coremask_first_core(app_desc_ptr->core_mask))
305 /* Intialize the bootmem allocator with the descriptor that was provided by
307 * IMPORTANT: All printfs must happen after this since PCI console uses named
310 cvmx_bootmem_init(CASTPTR(cvmx_bootinfo_t, app_desc_ptr->cvmx_desc_vaddr)->phy_mem_desc_addr);
312 /* do once per application setup */
313 if (app_desc_ptr->desc_version < 6)
315 printf("Obsolete bootloader, can't run application\n");
320 /* Handle all newer versions here.... */
321 if (app_desc_ptr->desc_version > 7)
323 printf("Warning: newer boot descripter version than expected\n");
325 process_boot_desc_ver_6(app_desc_ptr,sys_info_ptr);
330 * set up the feature map and config.
332 octeon_feature_init();
334 __cvmx_helper_cfg_init();
336 /* The flags varibale get copied over at some places and tracing the origins
338 ** In octeon_setup_boot_desc_block
339 . cvmx_bootinfo_array[core].flags is initialized and the various bits are set
340 . cvmx_bootinfo_array[core].flags gets copied to boot_desc[core].flags
341 . Then boot_desc then get copied over to the end of the application heap and
342 boot_info_block_array[core].boot_descr_addr is set to point to the boot_desc
344 ** In start_app boot_vect->boot_info_addr->boot_desc_addr is referenced and passed on
345 to octeon_setup_crt0_tlb() and this puts it into r16
346 ** In ctr0.S of the toolchain r16 is picked up and passed on as a parameter to
349 Note : boot_vect->boot_info_addr points to boot_info_block_array[core] and this
350 pointer is setup in octeon_setup_boot_vector()
353 if (!(app_desc_ptr->flags & OCTEON_BL_FLAG_HPLUG_CORES))
354 cvmx_coremask_barrier_sync(app_desc_ptr->core_mask);
357 breakflag = sys_info_ptr->bootloader_config_flags & CVMX_BOOTINFO_CFG_FLAG_BREAK;
359 /* No need to initialize bootmem, interrupts, interrupt handler and error handler
360 if version does not match. */
361 if (cvmx_coremask_first_core(sys_info_ptr->core_mask))
363 /* Check to make sure the Chip version matches the configured version */
364 uint32_t chip_id = cvmx_get_proc_id();
365 /* Make sure we can properly run on this chip */
366 octeon_model_version_check(chip_id);
368 cvmx_interrupt_initialize();
369 if (cvmx_coremask_first_core(sys_info_ptr->core_mask))
374 if (breakflag && cvmx_debug_booted())
376 printf("ERROR: Using debug and break together in not supported.\n");
381 /* Search through the arguments for a break=X or a debug=X. */
382 for (i = 0; i < app_desc_ptr->argc; i++)
384 const char *argv = CASTPTR(const char, CVMX_ADD_SEG32(CVMX_MIPS32_SPACE_KSEG0, app_desc_ptr->argv[i]));
385 if (strncmp(argv, "break=", 6) == 0)
386 break_uart = atoi(argv + 6);
387 else if (strncmp(argv, "debug=", 6) == 0)
388 cvmx_debug_uart = atoi(argv + 6);
393 int32_t *trampoline = CASTPTR(int32_t, CVMX_ADD_SEG32(CVMX_MIPS32_SPACE_KSEG0, BOOTLOADER_DEBUG_TRAMPOLINE));
394 /* On debug exception, call exit_on_break from all cores. */
395 *trampoline = (int32_t)(long)&exit_on_break;
396 cvmx_uart_enable_intr(break_uart, process_break_interrupt);
399 if ( !(app_desc_ptr->flags & OCTEON_BL_FLAG_HPLUG_CORES))
400 cvmx_coremask_barrier_sync(app_desc_ptr->core_mask);
402 /* Clear BEV now that we have installed exception handlers. */
409 " mfc0 %[tmp], $12, 0 \n"
410 " li $at, 1 << 22 \n"
412 " and %[tmp], $at \n"
413 " mtc0 %[tmp], $12, 0 \n"
415 : [tmp] "=&r" (tmp) : );
417 /* Set all cores to stop on MCD0 signals */
420 "or %0, %0, 0x1100\n"
421 "dmtc0 %0, $22, 0\n" : "=r" (tmp));
424 /* Now intialize the debug exception handler as BEV is cleared. */
425 if ((!breakflag) && (!(app_desc_ptr->flags & OCTEON_BL_FLAG_HPLUG_CORES)))
428 /* Synchronise all cores at this point */
429 if ( !(app_desc_ptr->flags & OCTEON_BL_FLAG_HPLUG_CORES))
430 cvmx_coremask_barrier_sync(app_desc_ptr->core_mask);
434 int cvmx_user_app_init(void)
443 /* Put message on LED display */
444 if (cvmx_sysinfo_get()->board_type != CVMX_BOARD_TYPE_SIM)
445 ebt3000_str_write("CVMX ");
447 /* Check BIST results for COP0 registers, some values only meaningful in pass 2 */
448 CVMX_MF_CACHE_ERR(bist_val);
449 mask = (0x3fULL<<32); // Icache;BHT;AES;HSH/GFM;LRU;register file
453 printf("BIST FAILURE: COP0_CACHE_ERR: 0x%llx\n", (unsigned long long)bist_val);
457 mask = 0xfc00000000000000ull;
458 CVMX_MF_CVM_MEM_CTL(bist_val);
462 printf("BIST FAILURE: COP0_CVM_MEM_CTL: 0x%llx\n", (unsigned long long)bist_val);
466 /* Set up 4 cache lines of local memory, make available from Kernel space */
467 CVMX_MF_CVM_MEM_CTL(tmp);
470 /* Set WBTHRESH=4 as per Core-14752 errata in cn63xxp1.X. */
471 if (OCTEON_IS_MODEL(OCTEON_CN63XX_PASS1_X))
473 tmp &= ~(0xfull << 11);
476 CVMX_MT_CVM_MEM_CTL(tmp);
478 if (OCTEON_IS_MODEL(OCTEON_CN63XX_PASS2_X))
480 /* Clear the lines of scratch memory configured, for
481 ** 63XX pass 2 errata Core-15169. */
484 CVMX_MF_CVM_MEM_CTL(tmp);
485 num_lines = tmp & 0x3f;
486 for (addr = 0; addr < CVMX_CACHE_LINE_SIZE * num_lines; addr += 8)
487 cvmx_scratch_write64(addr, 0);
490 #if CVMX_USE_1_TO_1_TLB_MAPPINGS
492 /* Check to see if the bootloader is indicating that the application is outside
493 ** of the 0x10000000 0x20000000 range, in which case we can't use 1-1 mappings */
494 if (cvmx_sysinfo_get()->bootloader_config_flags & CVMX_BOOTINFO_CFG_FLAG_OVERSIZE_TLB_MAPPING)
496 printf("ERROR: 1-1 TLB mappings configured and oversize application loaded.\n");
497 printf("ERROR: Either 1-1 TLB mappings must be disabled or application size reduced.\n");
501 /* Create 1-1 Mappings for all DRAM up to 8 gigs, excluding the low 1 Megabyte. This area
502 ** is reserved for the bootloader and exception vectors. By not mapping this area, NULL pointer
503 ** dereferences will be caught with TLB exceptions. Exception handlers should be written
504 ** using XKPHYS or KSEG0 addresses. */
505 #if CVMX_NULL_POINTER_PROTECT
506 /* Exclude low 1 MByte from mapping to detect NULL pointer accesses.
507 ** The only down side of this is it uses more TLB mappings */
508 cvmx_core_add_fixed_tlb_mapping_bits(0x0, 0x0, 0x100000 | TLB_DIRTY | TLB_VALID | TLB_GLOBAL, CVMX_TLB_PAGEMASK_1M);
509 cvmx_core_add_fixed_tlb_mapping(0x200000, 0x200000, 0x300000, CVMX_TLB_PAGEMASK_1M);
510 cvmx_core_add_fixed_tlb_mapping(0x400000, 0x400000, 0x500000, CVMX_TLB_PAGEMASK_1M);
511 cvmx_core_add_fixed_tlb_mapping(0x600000, 0x600000, 0x700000, CVMX_TLB_PAGEMASK_1M);
513 cvmx_core_add_fixed_tlb_mapping(0x800000, 0x800000, 0xC00000, CVMX_TLB_PAGEMASK_4M);
514 cvmx_core_add_fixed_tlb_mapping(0x1000000, 0x1000000, 0x1400000, CVMX_TLB_PAGEMASK_4M);
515 cvmx_core_add_fixed_tlb_mapping(0x1800000, 0x1800000, 0x1c00000, CVMX_TLB_PAGEMASK_4M);
517 cvmx_core_add_fixed_tlb_mapping(0x2000000, 0x2000000, 0x3000000, CVMX_TLB_PAGEMASK_16M);
518 cvmx_core_add_fixed_tlb_mapping(0x4000000, 0x4000000, 0x5000000, CVMX_TLB_PAGEMASK_16M);
519 cvmx_core_add_fixed_tlb_mapping(0x6000000, 0x6000000, 0x7000000, CVMX_TLB_PAGEMASK_16M);
521 /* Map entire low 128 Megs, including 0x0 */
522 cvmx_core_add_fixed_tlb_mapping(0x0, 0x0, 0x4000000ULL, CVMX_TLB_PAGEMASK_64M);
524 cvmx_core_add_fixed_tlb_mapping(0x8000000ULL, 0x8000000ULL, 0xc000000ULL, CVMX_TLB_PAGEMASK_64M);
526 if (OCTEON_IS_MODEL(OCTEON_CN6XXX))
528 for (base_addr = 0x20000000ULL; base_addr < (cvmx_sysinfo_get()->system_dram_size + 0x10000000ULL); base_addr += 0x20000000ULL)
530 if (0 > cvmx_core_add_fixed_tlb_mapping(base_addr, base_addr, base_addr + 0x10000000ULL, CVMX_TLB_PAGEMASK_256M))
532 printf("ERROR adding 1-1 TLB mapping for address 0x%llx\n", (unsigned long long)base_addr);
533 /* Exit from here, as expected memory mappings aren't set
541 /* Create 1-1 mapping for next 256 megs
542 ** bottom page is not valid */
543 cvmx_core_add_fixed_tlb_mapping_bits(0x400000000ULL, 0, 0x410000000ULL | TLB_DIRTY | TLB_VALID | TLB_GLOBAL, CVMX_TLB_PAGEMASK_256M);
545 /* Map from 0.5 up to the installed memory size in 512 MByte chunks. If this loop runs out of memory,
546 ** the NULL pointer detection can be disabled to free up more TLB entries. */
547 if (cvmx_sysinfo_get()->system_dram_size > 0x20000000ULL)
549 for (base_addr = 0x20000000ULL; base_addr <= (cvmx_sysinfo_get()->system_dram_size - 0x20000000ULL); base_addr += 0x20000000ULL)
551 if (0 > cvmx_core_add_fixed_tlb_mapping(base_addr, base_addr, base_addr + 0x10000000ULL, CVMX_TLB_PAGEMASK_256M))
553 printf("ERROR adding 1-1 TLB mapping for address 0x%llx\n", (unsigned long long)base_addr);
554 /* Exit from here, as expected memory mappings
555 aren't set up if this fails */
564 cvmx_sysinfo_t *sys_info_ptr = cvmx_sysinfo_get();
565 cvmx_bootmem_init(sys_info_ptr->phy_mem_desc_addr);
567 /* Initialize QLM and JTAG settings. Also apply any erratas. */
568 if (cvmx_coremask_first_core(cvmx_sysinfo_get()->core_mask))
574 void __cvmx_app_exit(void)
578 if (cvmx_sysinfo_get()->board_type == CVMX_BOARD_TYPE_SIM)
582 /* Hang forever, until more appropriate stand alone simple executive
583 exit() is implemented */