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/sysctl.h>
49 #include <sys/sysent.h>
50 #include <sys/sysproto.h>
52 #include <sys/timetc.h>
56 #include <vm/vm_object.h>
57 #include <vm/vm_page.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-ebt3000.h>
78 #include <contrib/octeon-sdk/cvmx-helper-cfg.h>
79 #include <contrib/octeon-sdk/cvmx-interrupt.h>
80 #include <contrib/octeon-sdk/cvmx-version.h>
82 #include <mips/cavium/octeon_irq.h>
84 #if defined(__mips_n64)
85 #define MAX_APP_DESC_ADDR 0xffffffffafffffff
87 #define MAX_APP_DESC_ADDR 0xafffffff
90 struct octeon_feature_description {
91 octeon_feature_t ofd_feature;
92 const char *ofd_string;
96 extern char cpu_model[];
97 extern char cpu_board[];
98 static char octeon_kenv[0x2000];
100 static const struct octeon_feature_description octeon_feature_descriptions[] = {
101 { OCTEON_FEATURE_SAAD, "SAAD" },
102 { OCTEON_FEATURE_ZIP, "ZIP" },
103 { OCTEON_FEATURE_CRYPTO, "CRYPTO" },
104 { OCTEON_FEATURE_DORM_CRYPTO, "DORM_CRYPTO" },
105 { OCTEON_FEATURE_PCIE, "PCIE" },
106 { OCTEON_FEATURE_SRIO, "SRIO" },
107 { OCTEON_FEATURE_KEY_MEMORY, "KEY_MEMORY" },
108 { OCTEON_FEATURE_LED_CONTROLLER, "LED_CONTROLLER" },
109 { OCTEON_FEATURE_TRA, "TRA" },
110 { OCTEON_FEATURE_MGMT_PORT, "MGMT_PORT" },
111 { OCTEON_FEATURE_RAID, "RAID" },
112 { OCTEON_FEATURE_USB, "USB" },
113 { OCTEON_FEATURE_NO_WPTR, "NO_WPTR" },
114 { OCTEON_FEATURE_DFA, "DFA" },
115 { OCTEON_FEATURE_MDIO_CLAUSE_45, "MDIO_CLAUSE_45" },
116 { OCTEON_FEATURE_NPEI, "NPEI" },
117 { OCTEON_FEATURE_ILK, "ILK" },
118 { OCTEON_FEATURE_HFA, "HFA" },
119 { OCTEON_FEATURE_DFM, "DFM" },
120 { OCTEON_FEATURE_CIU2, "CIU2" },
121 { OCTEON_FEATURE_DICI_MODE, "DICI_MODE" },
122 { OCTEON_FEATURE_BIT_EXTRACTOR, "BIT_EXTRACTOR" },
123 { OCTEON_FEATURE_NAND, "NAND" },
124 { OCTEON_FEATURE_MMC, "MMC" },
125 { OCTEON_FEATURE_PKND, "PKND" },
126 { OCTEON_FEATURE_CN68XX_WQE, "CN68XX_WQE" },
130 static uint64_t octeon_get_ticks(void);
131 static unsigned octeon_get_timecount(struct timecounter *tc);
133 static void octeon_boot_params_init(register_t ptr);
134 static void octeon_init_kenv(register_t ptr);
136 static struct timecounter octeon_timecounter = {
137 octeon_get_timecount, /* get_timecount */
139 0xffffffffu, /* octeon_mask */
142 900, /* quality (adjusted in code) */
148 /* Nothing special yet */
152 * Perform a board-level soft-reset.
157 cvmx_write_csr(CVMX_CIU_SOFT_RST, 1);
161 * octeon_debug_symbol
164 * Used to mark the point for simulator to begin tracing
167 octeon_debug_symbol(void)
174 * Shutdown all CIU to IP2, IP3 mappings
177 octeon_ciu_reset(void)
181 /* Disable all CIU interrupts by default */
182 cvmx_write_csr(CVMX_CIU_INTX_EN0(cvmx_get_core_num()*2), 0);
183 cvmx_write_csr(CVMX_CIU_INTX_EN0(cvmx_get_core_num()*2+1), 0);
184 cvmx_write_csr(CVMX_CIU_INTX_EN1(cvmx_get_core_num()*2), 0);
185 cvmx_write_csr(CVMX_CIU_INTX_EN1(cvmx_get_core_num()*2+1), 0);
188 /* Enable the MBOX interrupts. */
189 cvmx_write_csr(CVMX_CIU_INTX_EN0(cvmx_get_core_num()*2+1),
190 (1ull << (OCTEON_IRQ_MBOX0 - 8)) |
191 (1ull << (OCTEON_IRQ_MBOX1 - 8)));
195 * Move the Performance Counter interrupt to OCTEON_PMC_IRQ
197 cvmctl = mips_rd_cvmctl();
199 cvmctl |= (OCTEON_PMC_IRQ + 2) << 7;
200 mips_wr_cvmctl(cvmctl);
204 octeon_memory_init(void)
210 phys_end = round_page(MIPS_KSEG0_TO_PHYS((vm_offset_t)&end));
212 if (cvmx_sysinfo_get()->board_type == CVMX_BOARD_TYPE_SIM) {
213 /* Simulator we limit to 96 meg */
214 phys_avail[0] = phys_end;
215 phys_avail[1] = 96 << 20;
217 dump_avail[0] = phys_avail[0];
218 dump_avail[1] = phys_avail[1];
220 realmem = physmem = btoc(phys_avail[1] - phys_avail[0]);
225 * Allocate memory from bootmem 1MB at a time and merge
229 while (i < PHYS_AVAIL_ENTRIES) {
231 * If there is less than 2MB of memory available in 128-byte
232 * blocks, do not steal any more memory. We need to leave some
233 * memory for the command queues to be allocated out of.
235 if (cvmx_bootmem_available_mem(128) < 2 << 20)
238 addr = cvmx_bootmem_phy_alloc(1 << 20, phys_end,
239 ~(vm_paddr_t)0, PAGE_SIZE, 0);
244 * The SDK needs to be able to easily map any memory that might
245 * come to it e.g. in the form of an mbuf. Because on !n64 we
246 * can't direct-map some addresses and we don't want to manage
247 * temporary mappings within the SDK, don't feed memory that
248 * can't be direct-mapped to the kernel.
250 #if !defined(__mips_n64)
251 if (!MIPS_DIRECT_MAPPABLE(addr + (1 << 20) - 1))
255 physmem += btoc(1 << 20);
257 if (i > 0 && phys_avail[i - 1] == addr) {
258 phys_avail[i - 1] += 1 << 20;
262 phys_avail[i + 0] = addr;
263 phys_avail[i + 1] = addr + (1 << 20);
268 for (j = 0; j < i; j++)
269 dump_avail[j] = phys_avail[j];
275 platform_start(__register_t a0, __register_t a1, __register_t a2 __unused,
278 const struct octeon_feature_description *ofd;
279 uint64_t platform_counter_freq;
282 mips_postboot_fixup();
285 * Initialize boot parameters so that we can determine things like
286 * which console we shoud use, etc.
288 octeon_boot_params_init(a3);
290 /* Initialize pcpu stuff */
292 mips_timer_early_init(cvmx_sysinfo_get()->cpu_clock_hz);
294 /* Initialize console. */
298 * Display information about the CPU.
300 #if !defined(OCTEON_MODEL)
301 printf("Using runtime CPU model checks.\n");
303 printf("Compiled for CPU model: " __XSTRING(OCTEON_MODEL) "\n");
305 strcpy(cpu_model, octeon_model_get_string(cvmx_get_proc_id()));
306 printf("CPU Model: %s\n", cpu_model);
307 printf("CPU clock: %uMHz Core Mask: %#x\n",
308 cvmx_sysinfo_get()->cpu_clock_hz / 1000000,
309 cvmx_sysinfo_get()->core_mask);
310 rv = octeon_model_version_check(cvmx_get_proc_id());
312 panic("%s: kernel not compatible with this processor.", __func__);
315 * Display information about the board.
317 #if defined(OCTEON_BOARD_CAPK_0100ND)
318 strcpy(cpu_board, "CAPK-0100ND");
319 if (cvmx_sysinfo_get()->board_type != CVMX_BOARD_TYPE_CN3010_EVB_HS5) {
320 panic("Compiled for %s, but board type is %s.", cpu_board,
321 cvmx_board_type_to_string(cvmx_sysinfo_get()->board_type));
325 cvmx_board_type_to_string(cvmx_sysinfo_get()->board_type));
327 printf("Board: %s\n", cpu_board);
328 printf("Board Type: %u Revision: %u/%u\n",
329 cvmx_sysinfo_get()->board_type,
330 cvmx_sysinfo_get()->board_rev_major,
331 cvmx_sysinfo_get()->board_rev_minor);
332 printf("Serial number: %s\n", cvmx_sysinfo_get()->board_serial_number);
335 * Additional on-chip hardware/settings.
337 * XXX Display PCI host/target? What else?
339 printf("MAC address base: %6D (%u configured)\n",
340 cvmx_sysinfo_get()->mac_addr_base, ":",
341 cvmx_sysinfo_get()->mac_addr_count);
346 * Convert U-Boot 'bootoctlinux' loader command line arguments into
347 * boot flags and kernel environment variables.
350 octeon_init_kenv(a3);
353 * For some reason on the cn38xx simulator ebase register is set to
354 * 0x80001000 at bootup time. Move it back to the default, but
355 * when we move to having support for multiple executives, we need
358 mips_wr_ebase(0x80000000);
360 octeon_memory_init();
362 init_param2(physmem);
369 if (boothowto & RB_KDB)
370 kdb_enter(KDB_WHY_BOOTFLAGS, "Boot flags requested debugger");
372 cpu_clock = cvmx_sysinfo_get()->cpu_clock_hz;
373 platform_counter_freq = cpu_clock;
374 octeon_timecounter.tc_frequency = cpu_clock;
375 platform_timecounter = &octeon_timecounter;
376 mips_timer_init_params(platform_counter_freq, 0);
377 set_cputicker(octeon_get_ticks, cpu_clock, 0);
381 * Clear any pending IPIs.
383 cvmx_write_csr(CVMX_CIU_MBOX_CLRX(0), 0xffffffff);
386 printf("Octeon SDK: %s\n", OCTEON_SDK_VERSION_STRING);
387 printf("Available Octeon features:");
388 for (ofd = octeon_feature_descriptions; ofd->ofd_string != NULL; ofd++)
389 if (octeon_has_feature(ofd->ofd_feature))
390 printf(" %s", ofd->ofd_string);
395 octeon_get_ticks(void)
399 CVMX_MF_CYCLE(cvmcount);
404 octeon_get_timecount(struct timecounter *tc)
406 return ((unsigned)octeon_get_ticks());
410 sysctl_machdep_led_display(SYSCTL_HANDLER_ARGS)
416 if (req->newptr == NULL)
419 if (cvmx_sysinfo_get()->led_display_base_addr == 0)
423 * Revision 1.x of the EBT3000 only supports 4 characters, but
424 * other devices support 8.
426 if (cvmx_sysinfo_get()->board_type == CVMX_BOARD_TYPE_EBT3000 &&
427 cvmx_sysinfo_get()->board_rev_major == 1)
432 if (req->newlen > buflen)
435 error = SYSCTL_IN(req, buf, req->newlen);
439 buf[req->newlen] = '\0';
440 ebt3000_str_write(buf);
445 SYSCTL_PROC(_machdep, OID_AUTO, led_display, CTLTYPE_STRING | CTLFLAG_WR,
446 NULL, 0, sysctl_machdep_led_display, "A",
447 "String to display on LED display");
450 cvmx_dvprintf(const char *fmt, va_list ap)
458 cvmx_dprintf(const char *fmt, ...)
463 cvmx_dvprintf(fmt, ap);
468 * version of printf that works better in exception context.
472 * XXX If this function weren't in cvmx-interrupt.c, we'd use the SDK version.
474 void cvmx_safe_printf(const char *format, ...)
481 va_start(args, format);
483 count = vsnprintf(buffer, sizeof(buffer), format, args);
485 count = vsprintf(buffer, format, args);
491 cvmx_uart_lsr_t lsrval;
493 /* Spin until there is room */
496 lsrval.u64 = cvmx_read_csr(CVMX_MIO_UARTX_LSR(0));
497 #if !defined(CONFIG_OCTEON_SIM_SPEED)
498 if (lsrval.s.temt == 0)
499 cvmx_wait(10000); /* Just to reduce the load on the system */
502 while (lsrval.s.temt == 0);
505 cvmx_write_csr(CVMX_MIO_UARTX_THR(0), '\r');
506 cvmx_write_csr(CVMX_MIO_UARTX_THR(0), *ptr++);
510 /* impSTART: This stuff should move back into the Cavium SDK */
512 ****************************************************************************************
514 * APP/BOOT DESCRIPTOR STUFF
516 ****************************************************************************************
519 /* Define the struct that is initialized by the bootloader used by the
522 * Copyright (c) 2004, 2005, 2006 Cavium Networks.
524 * The authors hereby grant permission to use, copy, modify, distribute,
525 * and license this software and its documentation for any purpose, provided
526 * that existing copyright notices are retained in all copies and that this
527 * notice is included verbatim in any distributions. No written agreement,
528 * license, or royalty fee is required for any of the authorized uses.
529 * Modifications to this software may be copyrighted by their authors
530 * and need not follow the licensing terms described here, provided that
531 * the new terms are clearly indicated on the first page of each file where
535 #define OCTEON_CURRENT_DESC_VERSION 6
536 #define OCTEON_ARGV_MAX_ARGS (64)
537 #define OCTOEN_SERIAL_LEN 20
540 /* Start of block referenced by assembly code - do not change! */
541 uint32_t desc_version;
547 uint64_t entry_point; /* Only used by bootloader */
549 /* End of This block referenced by assembly code - do not change! */
551 uint32_t exception_base_addr;
554 uint32_t argc; /* Argc count for application */
555 uint32_t argv[OCTEON_ARGV_MAX_ARGS];
558 uint32_t dram_size; /**< DRAM size in megabyes */
559 uint32_t phy_mem_desc_addr; /**< physical address of free memory descriptor block*/
560 uint32_t debugger_flags_base_addr; /**< used to pass flags from app to debugger */
561 uint32_t eclock_hz; /**< CPU clock speed, in hz */
562 uint32_t dclock_hz; /**< DRAM clock speed, in hz */
563 uint32_t spi_clock_hz; /**< SPI4 clock in hz */
565 uint8_t board_rev_major;
566 uint8_t board_rev_minor;
568 uint8_t chip_rev_major;
569 uint8_t chip_rev_minor;
570 char board_serial_number[OCTOEN_SERIAL_LEN];
571 uint8_t mac_addr_base[6];
572 uint8_t mac_addr_count;
573 uint64_t cvmx_desc_vaddr;
574 } octeon_boot_descriptor_t;
576 static cvmx_bootinfo_t *
577 octeon_process_app_desc_ver_6(octeon_boot_descriptor_t *app_desc_ptr)
579 cvmx_bootinfo_t *octeon_bootinfo;
581 /* XXX Why is 0x00000000ffffffffULL a bad value? */
582 if (app_desc_ptr->cvmx_desc_vaddr == 0 ||
583 app_desc_ptr->cvmx_desc_vaddr == 0xfffffffful) {
584 cvmx_safe_printf("Bad octeon_bootinfo %#jx\n",
585 (uintmax_t)app_desc_ptr->cvmx_desc_vaddr);
589 octeon_bootinfo = cvmx_phys_to_ptr(app_desc_ptr->cvmx_desc_vaddr);
590 if (octeon_bootinfo->major_version != 1) {
591 cvmx_safe_printf("Incompatible CVMX descriptor from bootloader: %d.%d %p\n",
592 (int) octeon_bootinfo->major_version,
593 (int) octeon_bootinfo->minor_version, octeon_bootinfo);
597 cvmx_sysinfo_minimal_initialize(octeon_bootinfo->phy_mem_desc_addr,
598 octeon_bootinfo->board_type,
599 octeon_bootinfo->board_rev_major,
600 octeon_bootinfo->board_rev_minor,
601 octeon_bootinfo->eclock_hz);
602 memcpy(cvmx_sysinfo_get()->mac_addr_base,
603 octeon_bootinfo->mac_addr_base, 6);
604 cvmx_sysinfo_get()->mac_addr_count = octeon_bootinfo->mac_addr_count;
605 cvmx_sysinfo_get()->compact_flash_common_base_addr =
606 octeon_bootinfo->compact_flash_common_base_addr;
607 cvmx_sysinfo_get()->compact_flash_attribute_base_addr =
608 octeon_bootinfo->compact_flash_attribute_base_addr;
609 cvmx_sysinfo_get()->core_mask = octeon_bootinfo->core_mask;
610 cvmx_sysinfo_get()->led_display_base_addr =
611 octeon_bootinfo->led_display_base_addr;
612 memcpy(cvmx_sysinfo_get()->board_serial_number,
613 octeon_bootinfo->board_serial_number,
614 sizeof cvmx_sysinfo_get()->board_serial_number);
615 return (octeon_bootinfo);
619 octeon_boot_params_init(register_t ptr)
621 octeon_boot_descriptor_t *app_desc_ptr;
622 cvmx_bootinfo_t *octeon_bootinfo;
624 if (ptr == 0 || ptr >= MAX_APP_DESC_ADDR) {
625 cvmx_safe_printf("app descriptor passed at invalid address %#jx\n",
630 app_desc_ptr = (octeon_boot_descriptor_t *)(intptr_t)ptr;
631 if (app_desc_ptr->desc_version < 6) {
632 cvmx_safe_printf("Your boot code is too old to be supported.\n");
635 octeon_bootinfo = octeon_process_app_desc_ver_6(app_desc_ptr);
636 if (octeon_bootinfo == NULL) {
637 cvmx_safe_printf("Could not parse boot descriptor.\n");
641 if (cvmx_sysinfo_get()->led_display_base_addr != 0) {
643 * Revision 1.x of the EBT3000 only supports 4 characters, but
644 * other devices support 8.
646 if (cvmx_sysinfo_get()->board_type == CVMX_BOARD_TYPE_EBT3000 &&
647 cvmx_sysinfo_get()->board_rev_major == 1)
648 ebt3000_str_write("FBSD");
650 ebt3000_str_write("FreeBSD!");
653 if (cvmx_sysinfo_get()->phy_mem_desc_addr == (uint64_t)0) {
654 cvmx_safe_printf("Your boot loader did not supply a memory descriptor.\n");
657 cvmx_bootmem_init(cvmx_sysinfo_get()->phy_mem_desc_addr);
659 octeon_feature_init();
661 __cvmx_helper_cfg_init();
663 /* impEND: This stuff should move back into the Cavium SDK */
666 boothowto_parse(const char *v)
668 if ((v == NULL) || (*v != '-'))
674 case 'a': boothowto |= RB_ASKNAME; break;
675 case 'C': boothowto |= RB_CDROM; break;
676 case 'd': boothowto |= RB_KDB; break;
677 case 'D': boothowto |= RB_MULTIPLE; break;
678 case 'm': boothowto |= RB_MUTE; break;
679 case 'g': boothowto |= RB_GDB; break;
680 case 'h': boothowto |= RB_SERIAL; break;
681 case 'p': boothowto |= RB_PAUSE; break;
682 case 'r': boothowto |= RB_DFLTROOT; break;
683 case 's': boothowto |= RB_SINGLE; break;
684 case 'v': boothowto |= RB_VERBOSE; break;
690 * The boot loader command line may specify kernel environment variables or
691 * applicable boot flags of boot(8).
694 octeon_init_kenv(register_t ptr)
699 octeon_boot_descriptor_t *app_desc_ptr;
701 app_desc_ptr = (octeon_boot_descriptor_t *)(intptr_t)ptr;
702 memset(octeon_kenv, 0, sizeof(octeon_kenv));
703 init_static_kenv(octeon_kenv, sizeof(octeon_kenv));
705 for (i = 0; i < app_desc_ptr->argc; i++) {
706 v = cvmx_phys_to_ptr(app_desc_ptr->argv[i]);