2 * Copyright (c) 2007 Bruce M. Simpson.
3 * Copyright (c) 2016 Michael Zhilin <mizhka@gmail.com>
4 * Copyright (c) 2016 Landon Fuller <landonf@FreeBSD.org>
5 * Copyright (c) 2017 The FreeBSD Foundation
8 * Portions of this software were developed by Landon Fuller
9 * under sponsorship from the FreeBSD Foundation.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
38 #include <sys/param.h>
40 #include <sys/kernel.h>
41 #include <sys/systm.h>
42 #include <sys/imgact.h>
49 #include <sys/ucontext.h>
52 #include <sys/ptrace.h>
53 #include <sys/reboot.h>
54 #include <sys/signalvar.h>
55 #include <sys/sysent.h>
56 #include <sys/sysproto.h>
60 #include <vm/vm_param.h>
61 #include <vm/vm_object.h>
62 #include <vm/vm_page.h>
63 #include <vm/vm_phys.h>
64 #include <vm/vm_dumpset.h>
66 #include <machine/cache.h>
67 #include <machine/clock.h>
68 #include <machine/cpu.h>
69 #include <machine/cpuinfo.h>
70 #include <machine/cpufunc.h>
71 #include <machine/cpuregs.h>
72 #include <machine/hwfunc.h>
73 #include <machine/intr_machdep.h>
74 #include <machine/locore.h>
75 #include <machine/md_var.h>
76 #include <machine/pte.h>
77 #include <machine/sigframe.h>
78 #include <machine/trap.h>
80 #include <dev/bhnd/bhnd.h>
81 #include <dev/bhnd/bhndreg.h>
82 #include <dev/bhnd/bhnd_eromvar.h>
84 #include <dev/bhnd/bcma/bcma_eromvar.h>
86 #include <dev/bhnd/siba/sibareg.h>
87 #include <dev/bhnd/siba/sibavar.h>
89 #include <dev/bhnd/cores/chipc/chipcreg.h>
90 #include <dev/bhnd/cores/pmu/bhnd_pmureg.h>
92 #include "bcm_machdep.h"
93 #include "bcm_bmips_exts.h"
96 #include <dev/cfe/cfe_api.h>
97 #include <dev/cfe/cfe_error.h>
101 #define BCM_TRACE(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
103 #define BCM_TRACE(_fmt, ...)
106 static int bcm_init_platform_data(struct bcm_platform *bp);
108 static int bcm_find_core(struct bcm_platform *bp,
109 const struct bhnd_core_match *descs, size_t num_descs,
110 struct bhnd_core_info *info, uintptr_t *addr);
112 static int bcm_erom_probe_and_attach(bhnd_erom_class_t **erom_cls,
113 kobj_ops_t erom_ops, bhnd_erom_t *erom, size_t esize,
114 struct bhnd_erom_io *eio, struct bhnd_chipid *cid);
119 static struct bcm_platform bcm_platform_data;
120 static bool bcm_platform_data_avail = false;
123 static struct bcm_nvram_iocfe bcm_cfe_nvram;
126 static const struct bhnd_core_match bcm_chipc_cores[] = {
127 { BHND_MATCH_CORE(BHND_MFGID_BCM, BHND_COREID_CC) },
128 { BHND_MATCH_CORE(BHND_MFGID_BCM, BHND_COREID_4706_CC) },
131 static const struct bhnd_core_match bcm_cpu0_cores[] = {
133 BHND_MATCH_CORE_CLASS(BHND_DEVCLASS_CPU),
134 BHND_MATCH_CORE_UNIT(0)
138 static const struct bhnd_core_match bcm_pmu_cores[] = {
139 { BHND_MATCH_CORE(BHND_MFGID_BCM, BHND_COREID_PMU) },
142 struct bcm_platform *
143 bcm_get_platform(void)
145 if (!bcm_platform_data_avail)
146 panic("platform data not available");
148 return (&bcm_platform_data);
152 bcm_get_bus_addr(void)
156 if (resource_long_value("bhnd", 0, "maddr", &maddr) == 0)
157 return ((u_long)maddr);
159 return (BHND_DEFAULT_CHIPC_ADDR);
163 bcm_get_bus_size(void)
167 if (resource_long_value("bhnd", 0, "msize", &msize) == 0)
168 return ((u_long)msize);
170 return (BHND_DEFAULT_ENUM_SIZE);
174 * Search the device enumeration table for a core matching @p descs,
176 * @param bp Platform state containing a valid EROM parser.
177 * @param descs The core match descriptor table.
178 * @param num_descs The number of match descriptors in @p descs.
179 * @param[out] info If non-NULL, will be populated with the core
181 * @param[out] addr If non-NULL, will be populated with the core's
182 * physical register address.
185 bcm_find_core(struct bcm_platform *bp, const struct bhnd_core_match *descs,
186 size_t num_descs, struct bhnd_core_info *info, uintptr_t *addr)
192 /* Fetch core info */
193 for (size_t i = 0; i < num_descs; i++) {
194 error = bhnd_erom_lookup_core_addr(&bp->erom.obj, &descs[i],
195 BHND_PORT_DEVICE, 0, 0, info, &b_addr, &b_size);
197 /* Terminate search on first match */
201 /* Terminate on first error (other than core not found) */
205 /* Continue search ... */
208 /* Provide the core's base address */
209 if (addr != NULL && b_addr > UINTPTR_MAX) {
210 BCM_ERR("core address %#jx overflows native address width\n",
222 * Read a variable directly from NVRAM, decoding as @p type.
224 * @param bp Platform state.
225 * @param name The raw name of the variable to be fetched,
226 * including any device path (/pci/1/1/varname) or
227 * alias prefix (0:varname).
228 * @param[out] buf On success, the requested value will be written
229 * to this buffer. This argment may be NULL if
230 * the value is not desired.
231 * @param[in,out] len The capacity of @p buf. On success, will be set
232 * to the actual size of the requested value.
233 * @param type The data type to be written to @p buf.
236 * @retval ENOMEM If @p buf is non-NULL and a buffer of @p len is too
237 * small to hold the requested value.
238 * @retval ENOENT If @p name is not found.
239 * @retval EFTYPE If the variable data cannot be coerced to @p type.
240 * @retval ERANGE If value coercion would overflow @p type.
241 * @retval non-zero If parsing NVRAM otherwise fails, a regular unix error
242 * code will be returned.
245 bcm_get_nvram(struct bcm_platform *bp, const char *name, void *buf, size_t *len,
246 bhnd_nvram_type type)
248 if (bp->nvram_io == NULL || bp->nvram_cls == NULL)
251 return (bhnd_nvram_data_getvar_direct(bp->nvram_cls, bp->nvram_io, name,
256 * Probe and attach a bhnd_erom parser instance for the bhnd bus.
258 * @param[out] erom_cls The probed EROM class.
259 * @param[out] erom_ops The storage to be used when compiling
261 * @param[out] erom The storage to be used when initializing the
262 * static instance of @p erom_cls.
263 * @param esize The total available number of bytes allocated
264 * for @p erom. If this is less than is required
265 * by @p erom_cls ENOMEM will be returned.
266 * @param eio EROM I/O callbacks to be used.
267 * @param[out] cid On success, the probed chip identification.
270 bcm_erom_probe_and_attach(bhnd_erom_class_t **erom_cls, kobj_ops_t erom_ops,
271 bhnd_erom_t *erom, size_t esize, struct bhnd_erom_io *eio,
272 struct bhnd_chipid *cid)
274 bhnd_erom_class_t **clsp;
276 int error, prio, result;
281 /* Map our first bus core for the erom probe */
282 bus_addr = bcm_get_bus_addr();
283 if ((error = bhnd_erom_io_map(eio, bus_addr, BHND_DEFAULT_CORE_SIZE))) {
284 BCM_ERR("failed to map first core at %#jx+%#jx: %d\n",
285 (uintmax_t)bus_addr, (uintmax_t)BHND_DEFAULT_CORE_SIZE,
291 SET_FOREACH(clsp, bhnd_erom_class_set) {
292 struct bhnd_chipid pcid;
293 bhnd_erom_class_t *cls;
294 struct kobj_ops kops;
298 /* Compile the class' ops table */
299 kobj_class_compile_static(cls, &kops);
301 /* Probe the bus address */
302 result = bhnd_erom_probe(cls, eio, NULL, &pcid);
304 /* Drop pointer to stack allocated ops table */
307 /* The parser did not match if an error was returned */
311 /* Check for a new highest priority match */
312 if (*erom_cls == NULL || result > prio) {
319 /* Terminate immediately on BUS_PROBE_SPECIFIC */
320 if (result == BUS_PROBE_SPECIFIC)
324 /* Valid EROM class probed? */
325 if (*erom_cls == NULL) {
326 BCM_ERR("no erom parser found for root bus at %#jx\n",
327 (uintmax_t)bus_addr);
332 /* Using the provided storage, recompile the erom class ... */
333 kobj_class_compile_static(*erom_cls, erom_ops);
335 /* ... and initialize the erom parser instance */
336 error = bhnd_erom_init_static(*erom_cls, erom, esize, cid, eio);
342 * Populate platform configuration data.
345 bcm_init_platform_data(struct bcm_platform *bp)
347 bus_addr_t bus_addr, bus_size;
348 bus_space_tag_t erom_bst;
349 bus_space_handle_t erom_bsh;
353 bus_addr = bcm_get_bus_addr();
354 bus_size = bcm_get_bus_size();
357 /* Fetch CFE console handle (if any). Must be initialized before
358 * any calls to printf/early_putc. */
359 if ((bp->cfe_console = cfe_getstdhandle(CFE_STDHANDLE_CONSOLE)) < 0)
360 bp->cfe_console = -1;
362 /* Probe CFE NVRAM sources */
363 bp->nvram_io = &bcm_cfe_nvram.io;
364 error = bcm_nvram_find_cfedev(&bcm_cfe_nvram, &bp->nvram_cls);
367 bp->nvram_cls = NULL;
371 /* Probe and attach device table provider, populating our
372 * chip identification */
373 erom_bst = mips_bus_space_generic;
374 erom_bsh = BCM_SOC_BSH(bus_addr, 0);
376 error = bhnd_erom_iobus_init(&bp->erom_io, bus_addr, bus_size, erom_bst,
379 BCM_ERR("failed to initialize erom I/O callbacks: %d\n", error);
383 error = bcm_erom_probe_and_attach(&bp->erom_impl, &bp->erom_ops,
384 &bp->erom.obj, sizeof(bp->erom), &bp->erom_io.eio, &bp->cid);
386 BCM_ERR("error attaching erom parser: %d\n", error);
387 bhnd_erom_io_fini(&bp->erom_io.eio);
392 bhnd_erom_dump(&bp->erom.obj);
394 /* Fetch chipcommon core info */
395 error = bcm_find_core(bp, bcm_chipc_cores, nitems(bcm_chipc_cores),
396 &bp->cc_id, &bp->cc_addr);
398 BCM_ERR("error locating chipc core: %d\n", error);
402 /* Fetch chipc capability flags */
403 bp->cc_caps = BCM_SOC_READ_4(bp->cc_addr, CHIPC_CAPABILITIES);
404 bp->cc_caps_ext = 0x0;
406 if (CHIPC_HWREV_HAS_CAP_EXT(bp->cc_id.hwrev))
407 bp->cc_caps_ext = BCM_CHIPC_READ_4(bp, CHIPC_CAPABILITIES_EXT);
410 pmu = CHIPC_GET_FLAG(bp->cc_caps, CHIPC_CAP_PMU);
411 aob = CHIPC_GET_FLAG(bp->cc_caps_ext, CHIPC_CAP2_AOB);
414 /* PMU block mapped to a PMU core on the Always-on-Bus (aob) */
415 error = bcm_find_core(bp, bcm_pmu_cores, nitems(bcm_pmu_cores),
416 &bp->pmu_id, &bp->pmu_addr);
418 BCM_ERR("error locating pmu core: %d\n", error);
422 /* PMU block mapped to chipc */
423 bp->pmu_addr = bp->cc_addr;
424 bp->pmu_id = bp->cc_id;
428 memset(&bp->pmu_id, 0, sizeof(bp->pmu_id));
431 /* Initialize PMU query state */
433 error = bhnd_pmu_query_init(&bp->pmu, NULL, bp->cid,
434 &bcm_pmu_soc_io, bp);
436 BCM_ERR("bhnd_pmu_query_init() failed: %d\n", error);
441 /* Find CPU core info */
442 error = bcm_find_core(bp, bcm_cpu0_cores, nitems(bcm_cpu0_cores),
443 &bp->cpu_id, &bp->cpu_addr);
445 BCM_ERR("error locating CPU core: %d\n", error);
449 /* Initialize our platform service registry */
450 if ((error = bhnd_service_registry_init(&bp->services))) {
451 BCM_ERR("error initializing service registry: %d\n", error);
455 bcm_platform_data_avail = true;
462 /* Nothing special */
470 printf("entry: mips_init()\n");
474 * Query DRAM memory map from CFE.
477 for (i = 0; i < 10; i += 2) {
479 uint64_t addr, len, type;
481 result = cfe_enummem(i / 2, 0, &addr, &len, &type);
483 BCM_TRACE("There is no phys memory for: %d\n", i);
484 phys_avail[i] = phys_avail[i + 1] = 0;
487 if (type != CFE_MI_AVAILABLE) {
488 BCM_TRACE("phys memory is not available: %d\n", i);
492 phys_avail[i] = addr;
493 if (i == 0 && addr == 0) {
495 * If this is the first physical memory segment probed
496 * from CFE, omit the region at the start of physical
497 * memory where the kernel has been loaded.
499 phys_avail[i] += MIPS_KSEG0_TO_PHYS(kernel_kseg0_end);
502 BCM_TRACE("phys memory is available for: %d\n", i);
503 BCM_TRACE(" => addr = %jx\n", addr);
504 BCM_TRACE(" => len = %jd\n", len);
506 phys_avail[i + 1] = addr + len;
510 BCM_TRACE("Total phys memory is : %ld\n", physmem);
511 realmem = btoc(physmem);
514 for (j = 0; j < i; j++)
515 dump_avail[j] = phys_avail[j];
520 init_param2(physmem);
527 if (boothowto & RB_KDB)
528 kdb_enter(KDB_WHY_BOOTFLAGS, "Boot flags requested debugger");
535 struct bcm_platform *bp;
538 printf("bcm::platform_reset()\n");
542 /* Fall back on CFE if reset requested during platform
543 * data initialization */
544 if (!bcm_platform_data_avail) {
550 bp = bcm_get_platform();
553 /* Handle BCM4785-specific behavior */
554 if (bp->cid.chip_id == BHND_CHIPID_BCM4785) {
557 /* Switch to async mode */
558 bcm_bmips_wr_pllcfg3(BMIPS_BCMCFG_PLLCFG3_SM);
561 /* Set watchdog (PMU or ChipCommon) */
562 if (bp->pmu_addr != 0x0) {
563 BCM_PMU_WRITE_4(bp, BHND_PMU_WATCHDOG, 1);
565 BCM_CHIPC_WRITE_4(bp, CHIPC_WATCHDOG, 1);
570 __asm __volatile("wait");
577 platform_start(__register_t a0, __register_t a1, __register_t a2,
581 uint64_t platform_counter_freq;
584 /* clear the BSS and SBSS segments */
585 kernend = (vm_offset_t)&end;
586 memset(&edata, 0, kernend - (vm_offset_t)(&edata));
588 mips_postboot_fixup();
590 /* Initialize pcpu stuff */
595 * Initialize CFE firmware trampolines. This must be done
596 * before any CFE APIs are called, including writing
597 * to the CFE console.
599 * CFE passes the following values in registers:
600 * a0: firmware handle
601 * a2: firmware entry point
602 * a3: entry point seal
604 if (a3 == CFE_EPTSEAL)
608 /* Init BCM platform data */
609 if ((error = bcm_init_platform_data(&bcm_platform_data)))
610 panic("bcm_init_platform_data() failed: %d", error);
612 platform_counter_freq = bcm_get_cpufreq(bcm_get_platform());
614 /* CP0 ticks every two cycles */
615 mips_timer_early_init(platform_counter_freq / 2);
621 mips_timer_init_params(platform_counter_freq, 1);
625 * CFE-based EARLY_PRINTF support. To use, add the following to the kernel
627 * option EARLY_PRINTF
631 #if defined(EARLY_PRINTF) && defined(CFE)
638 ch = (unsigned char) c;
640 /* bcm_get_platform() cannot be used here, as we may be called
641 * from bcm_init_platform_data(). */
642 if ((handle = bcm_platform_data.cfe_console) < 0)
648 while ((cfe_write(handle, &ch, 1)) == 0)
652 early_putc_t *early_putc = bcm_cfe_eputc;
653 #endif /* EARLY_PRINTF */