2 * Copyright (c) 2006 Wojciech A. Koszek <wkoszek@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
33 #include <sys/kernel.h>
34 #include <sys/systm.h>
35 #include <sys/imgact.h>
42 #include <sys/ucontext.h>
45 #include <sys/ptrace.h>
46 #include <sys/reboot.h>
47 #include <sys/signalvar.h>
48 #include <sys/sysent.h>
49 #include <sys/sysproto.h>
51 #include <sys/timetc.h>
55 #include <vm/vm_object.h>
56 #include <vm/vm_page.h>
57 #include <vm/vm_pager.h>
59 #include <machine/atomic.h>
60 #include <machine/cache.h>
61 #include <machine/clock.h>
62 #include <machine/cpu.h>
63 #include <machine/cpuregs.h>
64 #include <machine/cpufunc.h>
65 #include <mips/cavium/octeon_pcmap_regs.h>
66 #include <machine/hwfunc.h>
67 #include <machine/intr_machdep.h>
68 #include <machine/locore.h>
69 #include <machine/md_var.h>
70 #include <machine/pcpu.h>
71 #include <machine/pte.h>
72 #include <machine/trap.h>
73 #include <machine/vmparam.h>
75 #include <contrib/octeon-sdk/cvmx.h>
76 #include <contrib/octeon-sdk/cvmx-bootmem.h>
77 #include <contrib/octeon-sdk/cvmx-interrupt.h>
78 #include <contrib/octeon-sdk/cvmx-version.h>
80 #if defined(__mips_n64)
81 #define MAX_APP_DESC_ADDR 0xffffffffafffffff
83 #define MAX_APP_DESC_ADDR 0xafffffff
86 #define OCTEON_CLOCK_DEFAULT (500 * 1000 * 1000)
88 struct octeon_feature_description {
89 octeon_feature_t ofd_feature;
90 const char *ofd_string;
95 extern char cpu_model[];
96 extern char cpu_board[];
98 static const struct octeon_feature_description octeon_feature_descriptions[] = {
99 { OCTEON_FEATURE_SAAD, "SAAD" },
100 { OCTEON_FEATURE_ZIP, "ZIP" },
101 { OCTEON_FEATURE_CRYPTO, "CRYPTO" },
102 { OCTEON_FEATURE_DORM_CRYPTO, "DORM_CRYPTO" },
103 { OCTEON_FEATURE_PCIE, "PCIE" },
104 { OCTEON_FEATURE_SRIO, "SRIO" },
105 { OCTEON_FEATURE_KEY_MEMORY, "KEY_MEMORY" },
106 { OCTEON_FEATURE_LED_CONTROLLER, "LED_CONTROLLER" },
107 { OCTEON_FEATURE_TRA, "TRA" },
108 { OCTEON_FEATURE_MGMT_PORT, "MGMT_PORT" },
109 { OCTEON_FEATURE_RAID, "RAID" },
110 { OCTEON_FEATURE_USB, "USB" },
111 { OCTEON_FEATURE_NO_WPTR, "NO_WPTR" },
112 { OCTEON_FEATURE_DFA, "DFA" },
113 { OCTEON_FEATURE_MDIO_CLAUSE_45, "MDIO_CLAUSE_45" },
114 { OCTEON_FEATURE_NPEI, "NPEI" },
118 uint64_t ciu_get_en_reg_addr_new(int corenum, int intx, int enx, int ciu_ip);
119 void ciu_dump_interrutps_enabled(int core_num, int intx, int enx, int ciu_ip);
121 static uint64_t octeon_get_ticks(void);
122 static unsigned octeon_get_timecount(struct timecounter *tc);
124 static void octeon_boot_params_init(register_t ptr);
126 static struct timecounter octeon_timecounter = {
127 octeon_get_timecount, /* get_timecount */
129 0xffffffffu, /* octeon_mask */
132 900, /* quality (adjusted in code) */
138 /* Nothing special yet */
142 * Perform a board-level soft-reset.
147 cvmx_write_csr(CVMX_CIU_SOFT_RST, 1);
151 octeon_led_write_char(int char_position, char val)
153 uint64_t ptr = (OCTEON_CHAR_LED_BASE_ADDR | 0xf8);
155 if (octeon_is_simulation())
158 char_position &= 0x7; /* only 8 chars */
159 ptr += char_position;
160 oct_write8_x8(ptr, val);
164 octeon_led_write_char0(char val)
166 uint64_t ptr = (OCTEON_CHAR_LED_BASE_ADDR | 0xf8);
168 if (octeon_is_simulation())
170 oct_write8_x8(ptr, val);
174 octeon_led_write_hexchar(int char_position, char hexval)
176 uint64_t ptr = (OCTEON_CHAR_LED_BASE_ADDR | 0xf8);
179 if (octeon_is_simulation())
182 char1 = (hexval >> 4) & 0x0f; char1 = (char1 < 10)?char1+'0':char1+'7';
183 char2 = (hexval & 0x0f); char2 = (char2 < 10)?char2+'0':char2+'7';
184 char_position &= 0x7; /* only 8 chars */
185 if (char_position > 6)
187 ptr += char_position;
188 oct_write8_x8(ptr, char1);
190 oct_write8_x8(ptr, char2);
194 octeon_led_write_string(const char *str)
196 uint64_t ptr = (OCTEON_CHAR_LED_BASE_ADDR | 0xf8);
199 if (octeon_is_simulation())
202 for (i=0; i<8; i++, ptr++) {
204 oct_write8_x8(ptr, *str++);
206 oct_write8_x8(ptr, ' ');
207 (void)cvmx_read_csr(CVMX_MIO_BOOT_BIST_STAT);
211 static char progress[8] = { '-', '/', '|', '\\', '-', '/', '|', '\\'};
214 octeon_led_run_wheel(int *prog_count, int led_position)
216 if (octeon_is_simulation())
218 octeon_led_write_char(led_position, progress[*prog_count]);
224 octeon_led_write_hex(uint32_t wl)
228 sprintf(nbuf, "%X", wl);
229 octeon_led_write_string(nbuf);
233 * octeon_debug_symbol
236 * Used to mark the point for simulator to begin tracing
239 octeon_debug_symbol(void)
246 * Shutdown all CIU to IP2, IP3 mappings
249 octeon_ciu_reset(void)
251 /* Disable all CIU interrupts by default */
252 cvmx_write_csr(CVMX_CIU_INTX_EN0(cvmx_get_core_num()*2), 0);
253 cvmx_write_csr(CVMX_CIU_INTX_EN0(cvmx_get_core_num()*2+1), 0);
254 cvmx_write_csr(CVMX_CIU_INTX_EN1(cvmx_get_core_num()*2), 0);
255 cvmx_write_csr(CVMX_CIU_INTX_EN1(cvmx_get_core_num()*2+1), 0);
258 /* Enable the MBOX interrupts. */
259 cvmx_write_csr(CVMX_CIU_INTX_EN0(cvmx_get_core_num()*2+1),
260 (1ull << (CVMX_IRQ_MBOX0 - 8)) |
261 (1ull << (CVMX_IRQ_MBOX1 - 8)));
266 octeon_memory_init(void)
272 phys_end = round_page(MIPS_KSEG0_TO_PHYS((vm_offset_t)&end));
274 if (octeon_is_simulation()) {
275 /* Simulator we limit to 96 meg */
276 phys_avail[0] = phys_end;
277 phys_avail[1] = 96 << 20;
279 dump_avail[0] = phys_avail[0];
280 dump_avail[1] = phys_avail[1];
282 realmem = physmem = btoc(phys_avail[1] - phys_avail[0]);
287 * Allocate memory from bootmem 1MB at a time and merge
291 while (i < PHYS_AVAIL_ENTRIES) {
293 * If there is less than 2MB of memory available in 128-byte
294 * blocks, do not steal any more memory. We need to leave some
295 * memory for the command queues to be allocated out of.
297 if (cvmx_bootmem_available_mem(128) < 2 << 20)
300 addr = cvmx_bootmem_phy_alloc(1 << 20, phys_end,
301 ~(vm_paddr_t)0, PAGE_SIZE, 0);
306 * The SDK needs to be able to easily map any memory that might
307 * come to it e.g. in the form of an mbuf. Because on !n64 we
308 * can't direct-map some addresses and we don't want to manage
309 * temporary mappings within the SDK, don't feed memory that
310 * can't be direct-mapped to the kernel.
312 #if !defined(__mips_n64)
313 if (!MIPS_DIRECT_MAPPABLE(addr + (1 << 20) - 1))
317 physmem += btoc(1 << 20);
319 if (i > 0 && phys_avail[i - 1] == addr) {
320 phys_avail[i - 1] += 1 << 20;
324 phys_avail[i + 0] = addr;
325 phys_avail[i + 1] = addr + (1 << 20);
330 for (j = 0; j < i; j++)
331 dump_avail[j] = phys_avail[j];
337 platform_start(__register_t a0, __register_t a1, __register_t a2 __unused,
340 const struct octeon_feature_description *ofd;
341 uint64_t platform_counter_freq;
345 * octeon_boot_params_init() should be called before anything else,
346 * certainly before any output; we may find out from the boot
347 * descriptor's flags that we're supposed to use the PCI or UART1
348 * consoles rather than UART0. No point doing that reorganization
349 * until we actually intercept UART_DEV_CONSOLE for the UART1 case
350 * and somehow handle the PCI console, which we lack code for
354 /* Initialize pcpu stuff */
356 mips_timer_early_init(OCTEON_CLOCK_DEFAULT);
360 octeon_boot_params_init(a3);
363 * We can certainly parse command line arguments or U-Boot environment
364 * to determine whether to bootverbose / single user / ... I think
365 * stass has patches to add support for loader things to U-Boot even.
370 * For some reason on the cn38xx simulator ebase register is set to
371 * 0x80001000 at bootup time. Move it back to the default, but
372 * when we move to having support for multiple executives, we need
375 mips_wr_ebase(0x80000000);
377 octeon_memory_init();
379 init_param2(physmem);
386 if (boothowto & RB_KDB)
387 kdb_enter(KDB_WHY_BOOTFLAGS, "Boot flags requested debugger");
389 cpu_clock = cvmx_sysinfo_get()->cpu_clock_hz;
390 platform_counter_freq = cpu_clock;
391 octeon_timecounter.tc_frequency = cpu_clock;
392 platform_timecounter = &octeon_timecounter;
393 mips_timer_init_params(platform_counter_freq, 0);
394 set_cputicker(octeon_get_ticks, cpu_clock, 0);
398 * Clear any pending IPIs.
400 cvmx_write_csr(CVMX_CIU_MBOX_CLRX(0), 0xffffffff);
403 printf("Octeon SDK: %s\n", OCTEON_SDK_VERSION_STRING);
404 printf("Available Octeon features:");
405 for (ofd = octeon_feature_descriptions; ofd->ofd_string != NULL; ofd++)
406 if (octeon_has_feature(ofd->ofd_feature))
407 printf(" %s", ofd->ofd_string);
412 octeon_get_ticks(void)
416 CVMX_MF_CYCLE(cvmcount);
421 octeon_get_timecount(struct timecounter *tc)
423 return ((unsigned)octeon_get_ticks());
427 * version of printf that works better in exception context.
431 * XXX If this function weren't in cvmx-interrupt.c, we'd use the SDK version.
433 void cvmx_safe_printf(const char *format, ...)
440 va_start(args, format);
442 count = vsnprintf(buffer, sizeof(buffer), format, args);
444 count = vsprintf(buffer, format, args);
450 cvmx_uart_lsr_t lsrval;
452 /* Spin until there is room */
455 lsrval.u64 = cvmx_read_csr(CVMX_MIO_UARTX_LSR(0));
456 #if !defined(CONFIG_OCTEON_SIM_SPEED)
457 if (lsrval.s.temt == 0)
458 cvmx_wait(10000); /* Just to reduce the load on the system */
461 while (lsrval.s.temt == 0);
464 cvmx_write_csr(CVMX_MIO_UARTX_THR(0), '\r');
465 cvmx_write_csr(CVMX_MIO_UARTX_THR(0), *ptr++);
469 /* impSTART: This stuff should move back into the Cavium SDK */
471 ****************************************************************************************
473 * APP/BOOT DESCRIPTOR STUFF
475 ****************************************************************************************
478 /* Define the struct that is initialized by the bootloader used by the
481 * Copyright (c) 2004, 2005, 2006 Cavium Networks.
483 * The authors hereby grant permission to use, copy, modify, distribute,
484 * and license this software and its documentation for any purpose, provided
485 * that existing copyright notices are retained in all copies and that this
486 * notice is included verbatim in any distributions. No written agreement,
487 * license, or royalty fee is required for any of the authorized uses.
488 * Modifications to this software may be copyrighted by their authors
489 * and need not follow the licensing terms described here, provided that
490 * the new terms are clearly indicated on the first page of each file where
494 #define OCTEON_CURRENT_DESC_VERSION 6
495 #define OCTEON_ARGV_MAX_ARGS (64)
496 #define OCTOEN_SERIAL_LEN 20
499 /* Start of block referenced by assembly code - do not change! */
500 uint32_t desc_version;
506 uint64_t entry_point; /* Only used by bootloader */
508 /* End of This block referenced by assembly code - do not change! */
510 uint32_t exception_base_addr;
513 uint32_t argc; /* Argc count for application */
514 uint32_t argv[OCTEON_ARGV_MAX_ARGS];
517 uint32_t dram_size; /**< DRAM size in megabyes */
518 uint32_t phy_mem_desc_addr; /**< physical address of free memory descriptor block*/
519 uint32_t debugger_flags_base_addr; /**< used to pass flags from app to debugger */
520 uint32_t eclock_hz; /**< CPU clock speed, in hz */
521 uint32_t dclock_hz; /**< DRAM clock speed, in hz */
522 uint32_t spi_clock_hz; /**< SPI4 clock in hz */
524 uint8_t board_rev_major;
525 uint8_t board_rev_minor;
527 uint8_t chip_rev_major;
528 uint8_t chip_rev_minor;
529 char board_serial_number[OCTOEN_SERIAL_LEN];
530 uint8_t mac_addr_base[6];
531 uint8_t mac_addr_count;
532 uint64_t cvmx_desc_vaddr;
533 } octeon_boot_descriptor_t;
535 cvmx_bootinfo_t *octeon_bootinfo;
537 static octeon_boot_descriptor_t *app_desc_ptr;
540 octeon_is_simulation(void)
542 switch (cvmx_sysinfo_get()->board_type) {
543 case CVMX_BOARD_TYPE_SIM:
551 octeon_process_app_desc_ver_6(void)
553 /* XXX Why is 0x00000000ffffffffULL a bad value? */
554 if (app_desc_ptr->cvmx_desc_vaddr == 0 ||
555 app_desc_ptr->cvmx_desc_vaddr == 0xfffffffful)
556 panic("Bad octeon_bootinfo %p", octeon_bootinfo);
559 (cvmx_bootinfo_t *)(intptr_t)app_desc_ptr->cvmx_desc_vaddr;
561 (cvmx_bootinfo_t *) ((intptr_t)octeon_bootinfo | MIPS_KSEG0_START);
562 if (octeon_bootinfo->major_version != 1)
563 panic("Incompatible CVMX descriptor from bootloader: %d.%d %p",
564 (int) octeon_bootinfo->major_version,
565 (int) octeon_bootinfo->minor_version, octeon_bootinfo);
567 cvmx_sysinfo_minimal_initialize(octeon_bootinfo->phy_mem_desc_addr,
568 octeon_bootinfo->board_type,
569 octeon_bootinfo->board_rev_major,
570 octeon_bootinfo->board_rev_minor,
571 octeon_bootinfo->eclock_hz);
575 octeon_boot_params_init(register_t ptr)
577 if (ptr == 0 || ptr >= MAX_APP_DESC_ADDR)
578 panic("app descriptor passed at invalid address %#jx",
581 app_desc_ptr = (octeon_boot_descriptor_t *)(intptr_t)ptr;
582 if (app_desc_ptr->desc_version < 6)
583 panic("Your boot code is too old to be supported.");
584 octeon_process_app_desc_ver_6();
586 KASSERT(octeon_bootinfo != NULL, ("octeon_bootinfo should be set"));
588 if (cvmx_sysinfo_get()->phy_mem_desc_addr == (uint64_t)0)
589 panic("Your boot loader did not supply a memory descriptor.");
590 cvmx_bootmem_init(cvmx_sysinfo_get()->phy_mem_desc_addr);
592 printf("Boot Descriptor Ver: %u -> %u/%u",
593 app_desc_ptr->desc_version, octeon_bootinfo->major_version,
594 octeon_bootinfo->minor_version);
595 printf(" CPU clock: %uMHz Core Mask: %#x\n",
596 cvmx_sysinfo_get()->cpu_clock_hz / 1000000,
597 cvmx_sysinfo_get()->core_mask);
598 printf(" Board Type: %u Revision: %u/%u\n",
599 cvmx_sysinfo_get()->board_type,
600 cvmx_sysinfo_get()->board_rev_major,
601 cvmx_sysinfo_get()->board_rev_minor);
603 printf(" Mac Address %02X.%02X.%02X.%02X.%02X.%02X (%d)\n",
604 octeon_bootinfo->mac_addr_base[0],
605 octeon_bootinfo->mac_addr_base[1],
606 octeon_bootinfo->mac_addr_base[2],
607 octeon_bootinfo->mac_addr_base[3],
608 octeon_bootinfo->mac_addr_base[4],
609 octeon_bootinfo->mac_addr_base[5],
610 octeon_bootinfo->mac_addr_count);
612 #if defined(OCTEON_BOARD_CAPK_0100ND)
613 strcpy(cpu_board, "CAPK-0100ND");
614 if (cvmx_sysinfo_get()->board_type != CVMX_BOARD_TYPE_CN3010_EVB_HS5) {
615 printf("Compiled for CAPK-0100ND, but board type is %s\n",
616 cvmx_board_type_to_string(cvmx_sysinfo_get()->board_type));
617 strcat(cpu_board, " hardwired, but type is ");
619 cvmx_board_type_to_string(cvmx_sysinfo_get()->board_type));
623 cvmx_board_type_to_string(cvmx_sysinfo_get()->board_type));
624 printf("Board: %s\n", cpu_board);
626 strcpy(cpu_model, octeon_model_get_string(cvmx_get_proc_id()));
627 printf("Model: %s\n", cpu_model);
629 /* impEND: This stuff should move back into the Cavium SDK */