2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2006 Wojciech A. Koszek <wkoszek@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
36 #include <sys/kernel.h>
37 #include <sys/systm.h>
38 #include <sys/imgact.h>
45 #include <sys/ucontext.h>
48 #include <sys/ptrace.h>
49 #include <sys/reboot.h>
50 #include <sys/signalvar.h>
51 #include <sys/sysctl.h>
52 #include <sys/sysent.h>
53 #include <sys/sysproto.h>
55 #include <sys/timetc.h>
59 #include <vm/vm_param.h>
60 #include <vm/vm_object.h>
61 #include <vm/vm_page.h>
62 #include <vm/vm_phys.h>
64 #include <machine/atomic.h>
65 #include <machine/cache.h>
66 #include <machine/clock.h>
67 #include <machine/cpu.h>
68 #include <machine/cpuregs.h>
69 #include <machine/cpufunc.h>
70 #include <mips/cavium/octeon_pcmap_regs.h>
71 #include <machine/hwfunc.h>
72 #include <machine/intr_machdep.h>
73 #include <machine/locore.h>
74 #include <machine/md_var.h>
75 #include <machine/pcpu.h>
76 #include <machine/pte.h>
77 #include <machine/trap.h>
79 #include <contrib/octeon-sdk/cvmx.h>
80 #include <contrib/octeon-sdk/cvmx-bootmem.h>
81 #include <contrib/octeon-sdk/cvmx-ebt3000.h>
82 #include <contrib/octeon-sdk/cvmx-helper-cfg.h>
83 #include <contrib/octeon-sdk/cvmx-interrupt.h>
84 #include <contrib/octeon-sdk/cvmx-version.h>
86 #include <mips/cavium/octeon_irq.h>
88 #if defined(__mips_n64)
89 #define MAX_APP_DESC_ADDR 0xffffffffafffffff
91 #define MAX_APP_DESC_ADDR 0xafffffff
94 struct octeon_feature_description {
95 octeon_feature_t ofd_feature;
96 const char *ofd_string;
100 extern char cpu_model[];
101 extern char cpu_board[];
102 static char octeon_kenv[0x2000];
104 static const struct octeon_feature_description octeon_feature_descriptions[] = {
105 { OCTEON_FEATURE_SAAD, "SAAD" },
106 { OCTEON_FEATURE_ZIP, "ZIP" },
107 { OCTEON_FEATURE_CRYPTO, "CRYPTO" },
108 { OCTEON_FEATURE_DORM_CRYPTO, "DORM_CRYPTO" },
109 { OCTEON_FEATURE_PCIE, "PCIE" },
110 { OCTEON_FEATURE_SRIO, "SRIO" },
111 { OCTEON_FEATURE_KEY_MEMORY, "KEY_MEMORY" },
112 { OCTEON_FEATURE_LED_CONTROLLER, "LED_CONTROLLER" },
113 { OCTEON_FEATURE_TRA, "TRA" },
114 { OCTEON_FEATURE_MGMT_PORT, "MGMT_PORT" },
115 { OCTEON_FEATURE_RAID, "RAID" },
116 { OCTEON_FEATURE_USB, "USB" },
117 { OCTEON_FEATURE_NO_WPTR, "NO_WPTR" },
118 { OCTEON_FEATURE_DFA, "DFA" },
119 { OCTEON_FEATURE_MDIO_CLAUSE_45, "MDIO_CLAUSE_45" },
120 { OCTEON_FEATURE_NPEI, "NPEI" },
121 { OCTEON_FEATURE_ILK, "ILK" },
122 { OCTEON_FEATURE_HFA, "HFA" },
123 { OCTEON_FEATURE_DFM, "DFM" },
124 { OCTEON_FEATURE_CIU2, "CIU2" },
125 { OCTEON_FEATURE_DICI_MODE, "DICI_MODE" },
126 { OCTEON_FEATURE_BIT_EXTRACTOR, "BIT_EXTRACTOR" },
127 { OCTEON_FEATURE_NAND, "NAND" },
128 { OCTEON_FEATURE_MMC, "MMC" },
129 { OCTEON_FEATURE_PKND, "PKND" },
130 { OCTEON_FEATURE_CN68XX_WQE, "CN68XX_WQE" },
134 static uint64_t octeon_get_ticks(void);
135 static unsigned octeon_get_timecount(struct timecounter *tc);
137 static void octeon_boot_params_init(register_t ptr);
138 static void octeon_init_kenv(register_t ptr);
140 static struct timecounter octeon_timecounter = {
141 octeon_get_timecount, /* get_timecount */
143 0xffffffffu, /* octeon_mask */
146 900, /* quality (adjusted in code) */
152 /* Nothing special yet */
156 * Perform a board-level soft-reset.
161 cvmx_write_csr(CVMX_CIU_SOFT_RST, 1);
165 * octeon_debug_symbol
168 * Used to mark the point for simulator to begin tracing
171 octeon_debug_symbol(void)
178 * Shutdown all CIU to IP2, IP3 mappings
181 octeon_ciu_reset(void)
185 /* Disable all CIU interrupts by default */
186 cvmx_write_csr(CVMX_CIU_INTX_EN0(cvmx_get_core_num()*2), 0);
187 cvmx_write_csr(CVMX_CIU_INTX_EN0(cvmx_get_core_num()*2+1), 0);
188 cvmx_write_csr(CVMX_CIU_INTX_EN1(cvmx_get_core_num()*2), 0);
189 cvmx_write_csr(CVMX_CIU_INTX_EN1(cvmx_get_core_num()*2+1), 0);
192 /* Enable the MBOX interrupts. */
193 cvmx_write_csr(CVMX_CIU_INTX_EN0(cvmx_get_core_num()*2+1),
194 (1ull << (OCTEON_IRQ_MBOX0 - 8)) |
195 (1ull << (OCTEON_IRQ_MBOX1 - 8)));
199 * Move the Performance Counter interrupt to OCTEON_PMC_IRQ
201 cvmctl = mips_rd_cvmctl();
203 cvmctl |= (OCTEON_PMC_IRQ + 2) << 7;
204 mips_wr_cvmctl(cvmctl);
208 octeon_memory_init(void)
214 phys_end = round_page(MIPS_KSEG0_TO_PHYS((vm_offset_t)&end));
216 if (cvmx_sysinfo_get()->board_type == CVMX_BOARD_TYPE_SIM) {
217 /* Simulator we limit to 96 meg */
218 phys_avail[0] = phys_end;
219 phys_avail[1] = 96 << 20;
221 dump_avail[0] = phys_avail[0];
222 dump_avail[1] = phys_avail[1];
224 realmem = physmem = btoc(phys_avail[1] - phys_avail[0]);
229 * Allocate memory from bootmem 1MB at a time and merge
233 while (i < PHYS_AVAIL_ENTRIES) {
235 * If there is less than 2MB of memory available in 128-byte
236 * blocks, do not steal any more memory. We need to leave some
237 * memory for the command queues to be allocated out of.
239 if (cvmx_bootmem_available_mem(128) < 2 << 20)
242 addr = cvmx_bootmem_phy_alloc(1 << 20, phys_end,
243 ~(vm_paddr_t)0, PAGE_SIZE, 0);
248 * The SDK needs to be able to easily map any memory that might
249 * come to it e.g. in the form of an mbuf. Because on !n64 we
250 * can't direct-map some addresses and we don't want to manage
251 * temporary mappings within the SDK, don't feed memory that
252 * can't be direct-mapped to the kernel.
254 #if !defined(__mips_n64)
255 if (!MIPS_DIRECT_MAPPABLE(addr + (1 << 20) - 1))
259 physmem += btoc(1 << 20);
261 if (i > 0 && phys_avail[i - 1] == addr) {
262 phys_avail[i - 1] += 1 << 20;
266 phys_avail[i + 0] = addr;
267 phys_avail[i + 1] = addr + (1 << 20);
272 for (j = 0; j < i; j++)
273 dump_avail[j] = phys_avail[j];
279 platform_start(__register_t a0, __register_t a1, __register_t a2 __unused,
282 const struct octeon_feature_description *ofd;
283 uint64_t platform_counter_freq;
286 mips_postboot_fixup();
289 * Initialize boot parameters so that we can determine things like
290 * which console we shoud use, etc.
292 octeon_boot_params_init(a3);
294 /* Initialize pcpu stuff */
296 mips_timer_early_init(cvmx_sysinfo_get()->cpu_clock_hz);
298 /* Initialize console. */
302 * Display information about the CPU.
304 #if !defined(OCTEON_MODEL)
305 printf("Using runtime CPU model checks.\n");
307 printf("Compiled for CPU model: " __XSTRING(OCTEON_MODEL) "\n");
309 strcpy(cpu_model, octeon_model_get_string(cvmx_get_proc_id()));
310 printf("CPU Model: %s\n", cpu_model);
311 printf("CPU clock: %uMHz Core Mask: %#x\n",
312 cvmx_sysinfo_get()->cpu_clock_hz / 1000000,
313 cvmx_sysinfo_get()->core_mask);
314 rv = octeon_model_version_check(cvmx_get_proc_id());
316 panic("%s: kernel not compatible with this processor.", __func__);
319 * Display information about the board.
321 #if defined(OCTEON_BOARD_CAPK_0100ND)
322 strcpy(cpu_board, "CAPK-0100ND");
323 if (cvmx_sysinfo_get()->board_type != CVMX_BOARD_TYPE_CN3010_EVB_HS5) {
324 panic("Compiled for %s, but board type is %s.", cpu_board,
325 cvmx_board_type_to_string(cvmx_sysinfo_get()->board_type));
329 cvmx_board_type_to_string(cvmx_sysinfo_get()->board_type));
331 printf("Board: %s\n", cpu_board);
332 printf("Board Type: %u Revision: %u/%u\n",
333 cvmx_sysinfo_get()->board_type,
334 cvmx_sysinfo_get()->board_rev_major,
335 cvmx_sysinfo_get()->board_rev_minor);
336 printf("Serial number: %s\n", cvmx_sysinfo_get()->board_serial_number);
339 * Additional on-chip hardware/settings.
341 * XXX Display PCI host/target? What else?
343 printf("MAC address base: %6D (%u configured)\n",
344 cvmx_sysinfo_get()->mac_addr_base, ":",
345 cvmx_sysinfo_get()->mac_addr_count);
350 * Convert U-Boot 'bootoctlinux' loader command line arguments into
351 * boot flags and kernel environment variables.
354 octeon_init_kenv(a3);
357 * For some reason on the cn38xx simulator ebase register is set to
358 * 0x80001000 at bootup time. Move it back to the default, but
359 * when we move to having support for multiple executives, we need
362 mips_wr_ebase(0x80000000);
364 octeon_memory_init();
366 init_param2(physmem);
373 if (boothowto & RB_KDB)
374 kdb_enter(KDB_WHY_BOOTFLAGS, "Boot flags requested debugger");
376 cpu_clock = cvmx_sysinfo_get()->cpu_clock_hz;
377 platform_counter_freq = cpu_clock;
378 octeon_timecounter.tc_frequency = cpu_clock;
379 platform_timecounter = &octeon_timecounter;
380 mips_timer_init_params(platform_counter_freq, 0);
381 set_cputicker(octeon_get_ticks, cpu_clock, 0);
385 * Clear any pending IPIs.
387 cvmx_write_csr(CVMX_CIU_MBOX_CLRX(0), 0xffffffff);
390 printf("Octeon SDK: %s\n", OCTEON_SDK_VERSION_STRING);
391 printf("Available Octeon features:");
392 for (ofd = octeon_feature_descriptions; ofd->ofd_string != NULL; ofd++)
393 if (octeon_has_feature(ofd->ofd_feature))
394 printf(" %s", ofd->ofd_string);
399 octeon_get_ticks(void)
403 CVMX_MF_CYCLE(cvmcount);
408 octeon_get_timecount(struct timecounter *tc)
410 return ((unsigned)octeon_get_ticks());
414 sysctl_machdep_led_display(SYSCTL_HANDLER_ARGS)
420 if (req->newptr == NULL)
423 if (cvmx_sysinfo_get()->led_display_base_addr == 0)
427 * Revision 1.x of the EBT3000 only supports 4 characters, but
428 * other devices support 8.
430 if (cvmx_sysinfo_get()->board_type == CVMX_BOARD_TYPE_EBT3000 &&
431 cvmx_sysinfo_get()->board_rev_major == 1)
436 if (req->newlen > buflen)
439 error = SYSCTL_IN(req, buf, req->newlen);
443 buf[req->newlen] = '\0';
444 ebt3000_str_write(buf);
449 SYSCTL_PROC(_machdep, OID_AUTO, led_display, CTLTYPE_STRING | CTLFLAG_WR,
450 NULL, 0, sysctl_machdep_led_display, "A",
451 "String to display on LED display");
454 cvmx_dvprintf(const char *fmt, va_list ap)
462 cvmx_dprintf(const char *fmt, ...)
467 cvmx_dvprintf(fmt, ap);
472 * version of printf that works better in exception context.
476 * XXX If this function weren't in cvmx-interrupt.c, we'd use the SDK version.
478 void cvmx_safe_printf(const char *format, ...)
485 va_start(args, format);
487 count = vsnprintf(buffer, sizeof(buffer), format, args);
489 count = vsprintf(buffer, format, args);
495 cvmx_uart_lsr_t lsrval;
497 /* Spin until there is room */
500 lsrval.u64 = cvmx_read_csr(CVMX_MIO_UARTX_LSR(0));
501 #if !defined(CONFIG_OCTEON_SIM_SPEED)
502 if (lsrval.s.temt == 0)
503 cvmx_wait(10000); /* Just to reduce the load on the system */
506 while (lsrval.s.temt == 0);
509 cvmx_write_csr(CVMX_MIO_UARTX_THR(0), '\r');
510 cvmx_write_csr(CVMX_MIO_UARTX_THR(0), *ptr++);
514 /* impSTART: This stuff should move back into the Cavium SDK */
516 ****************************************************************************************
518 * APP/BOOT DESCRIPTOR STUFF
520 ****************************************************************************************
523 /* Define the struct that is initialized by the bootloader used by the
526 * Copyright (c) 2004, 2005, 2006 Cavium Networks.
528 * The authors hereby grant permission to use, copy, modify, distribute,
529 * and license this software and its documentation for any purpose, provided
530 * that existing copyright notices are retained in all copies and that this
531 * notice is included verbatim in any distributions. No written agreement,
532 * license, or royalty fee is required for any of the authorized uses.
533 * Modifications to this software may be copyrighted by their authors
534 * and need not follow the licensing terms described here, provided that
535 * the new terms are clearly indicated on the first page of each file where
539 #define OCTEON_CURRENT_DESC_VERSION 6
540 #define OCTEON_ARGV_MAX_ARGS (64)
541 #define OCTOEN_SERIAL_LEN 20
544 /* Start of block referenced by assembly code - do not change! */
545 uint32_t desc_version;
551 uint64_t entry_point; /* Only used by bootloader */
553 /* End of This block referenced by assembly code - do not change! */
555 uint32_t exception_base_addr;
558 uint32_t argc; /* Argc count for application */
559 uint32_t argv[OCTEON_ARGV_MAX_ARGS];
562 uint32_t dram_size; /**< DRAM size in megabyes */
563 uint32_t phy_mem_desc_addr; /**< physical address of free memory descriptor block*/
564 uint32_t debugger_flags_base_addr; /**< used to pass flags from app to debugger */
565 uint32_t eclock_hz; /**< CPU clock speed, in hz */
566 uint32_t dclock_hz; /**< DRAM clock speed, in hz */
567 uint32_t spi_clock_hz; /**< SPI4 clock in hz */
569 uint8_t board_rev_major;
570 uint8_t board_rev_minor;
572 uint8_t chip_rev_major;
573 uint8_t chip_rev_minor;
574 char board_serial_number[OCTOEN_SERIAL_LEN];
575 uint8_t mac_addr_base[6];
576 uint8_t mac_addr_count;
577 uint64_t cvmx_desc_vaddr;
578 } octeon_boot_descriptor_t;
580 static cvmx_bootinfo_t *
581 octeon_process_app_desc_ver_6(octeon_boot_descriptor_t *app_desc_ptr)
583 cvmx_bootinfo_t *octeon_bootinfo;
585 /* XXX Why is 0x00000000ffffffffULL a bad value? */
586 if (app_desc_ptr->cvmx_desc_vaddr == 0 ||
587 app_desc_ptr->cvmx_desc_vaddr == 0xfffffffful) {
588 cvmx_safe_printf("Bad octeon_bootinfo %#jx\n",
589 (uintmax_t)app_desc_ptr->cvmx_desc_vaddr);
593 octeon_bootinfo = cvmx_phys_to_ptr(app_desc_ptr->cvmx_desc_vaddr);
594 if (octeon_bootinfo->major_version != 1) {
595 cvmx_safe_printf("Incompatible CVMX descriptor from bootloader: %d.%d %p\n",
596 (int) octeon_bootinfo->major_version,
597 (int) octeon_bootinfo->minor_version, octeon_bootinfo);
601 cvmx_sysinfo_minimal_initialize(octeon_bootinfo->phy_mem_desc_addr,
602 octeon_bootinfo->board_type,
603 octeon_bootinfo->board_rev_major,
604 octeon_bootinfo->board_rev_minor,
605 octeon_bootinfo->eclock_hz);
606 memcpy(cvmx_sysinfo_get()->mac_addr_base,
607 octeon_bootinfo->mac_addr_base, 6);
608 cvmx_sysinfo_get()->mac_addr_count = octeon_bootinfo->mac_addr_count;
609 cvmx_sysinfo_get()->compact_flash_common_base_addr =
610 octeon_bootinfo->compact_flash_common_base_addr;
611 cvmx_sysinfo_get()->compact_flash_attribute_base_addr =
612 octeon_bootinfo->compact_flash_attribute_base_addr;
613 cvmx_sysinfo_get()->core_mask = octeon_bootinfo->core_mask;
614 cvmx_sysinfo_get()->led_display_base_addr =
615 octeon_bootinfo->led_display_base_addr;
616 memcpy(cvmx_sysinfo_get()->board_serial_number,
617 octeon_bootinfo->board_serial_number,
618 sizeof cvmx_sysinfo_get()->board_serial_number);
619 return (octeon_bootinfo);
623 octeon_boot_params_init(register_t ptr)
625 octeon_boot_descriptor_t *app_desc_ptr;
626 cvmx_bootinfo_t *octeon_bootinfo;
628 if (ptr == 0 || ptr >= MAX_APP_DESC_ADDR) {
629 cvmx_safe_printf("app descriptor passed at invalid address %#jx\n",
634 app_desc_ptr = (octeon_boot_descriptor_t *)(intptr_t)ptr;
635 if (app_desc_ptr->desc_version < 6) {
636 cvmx_safe_printf("Your boot code is too old to be supported.\n");
639 octeon_bootinfo = octeon_process_app_desc_ver_6(app_desc_ptr);
640 if (octeon_bootinfo == NULL) {
641 cvmx_safe_printf("Could not parse boot descriptor.\n");
645 if (cvmx_sysinfo_get()->led_display_base_addr != 0) {
647 * Revision 1.x of the EBT3000 only supports 4 characters, but
648 * other devices support 8.
650 if (cvmx_sysinfo_get()->board_type == CVMX_BOARD_TYPE_EBT3000 &&
651 cvmx_sysinfo_get()->board_rev_major == 1)
652 ebt3000_str_write("FBSD");
654 ebt3000_str_write("FreeBSD!");
657 if (cvmx_sysinfo_get()->phy_mem_desc_addr == (uint64_t)0) {
658 cvmx_safe_printf("Your boot loader did not supply a memory descriptor.\n");
661 cvmx_bootmem_init(cvmx_sysinfo_get()->phy_mem_desc_addr);
663 octeon_feature_init();
665 __cvmx_helper_cfg_init();
667 /* impEND: This stuff should move back into the Cavium SDK */
670 * The boot loader command line may specify kernel environment variables or
671 * applicable boot flags of boot(8).
674 octeon_init_kenv(register_t ptr)
679 octeon_boot_descriptor_t *app_desc_ptr;
681 app_desc_ptr = (octeon_boot_descriptor_t *)(intptr_t)ptr;
682 memset(octeon_kenv, 0, sizeof(octeon_kenv));
683 init_static_kenv(octeon_kenv, sizeof(octeon_kenv));
685 for (i = 0; i < app_desc_ptr->argc; i++) {
686 v = cvmx_phys_to_ptr(app_desc_ptr->argv[i]);
690 boothowto |= boot_parse_arg(v);