2 * Copyright (c) 2005 Peter Grehan
3 * Copyright (c) 2009 Nathan Whitehorn
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
33 * Dispatch platform calls to the appropriate platform implementation
34 * through a previously registered kernel object.
37 #include <sys/param.h>
38 #include <sys/kernel.h>
41 #include <sys/mutex.h>
43 #include <sys/systm.h>
45 #include <sys/sysctl.h>
46 #include <sys/types.h>
49 #include <vm/vm_page.h>
51 #include <machine/cpu.h>
52 #include <machine/md_var.h>
53 #include <machine/platform.h>
54 #include <machine/platformvar.h>
55 #include <machine/smp.h>
57 #include "platform_if.h"
59 static platform_def_t *plat_def_impl;
60 static platform_t plat_obj;
61 static struct kobj_ops plat_kernel_kops;
62 static struct platform_kobj plat_kernel_obj;
64 static char plat_name[64] = "";
65 SYSCTL_STRING(_hw, OID_AUTO, platform, CTLFLAG_RD | CTLFLAG_TUN,
66 plat_name, 0, "Platform currently in use");
68 static struct mem_region pregions[PHYS_AVAIL_SZ];
69 static struct mem_region aregions[PHYS_AVAIL_SZ];
70 static int npregions, naregions;
73 * Memory region utilities: determine if two regions overlap,
74 * and merge two overlapping regions into one
77 memr_overlap(struct mem_region *r1, struct mem_region *r2)
79 if ((r1->mr_start + r1->mr_size) < r2->mr_start ||
80 (r2->mr_start + r2->mr_size) < r1->mr_start)
87 memr_merge(struct mem_region *from, struct mem_region *to)
90 end = uqmax(to->mr_start + to->mr_size, from->mr_start + from->mr_size);
91 to->mr_start = uqmin(from->mr_start, to->mr_start);
92 to->mr_size = end - to->mr_start;
96 * Quick sort callout for comparing memory regions.
99 mr_cmp(const void *a, const void *b)
101 const struct mem_region *regiona, *regionb;
105 if (regiona->mr_start < regionb->mr_start)
107 else if (regiona->mr_start > regionb->mr_start)
114 mem_regions(struct mem_region **phys, int *physsz, struct mem_region **avail,
117 int i, j, still_merging;
119 if (npregions == 0) {
120 PLATFORM_MEM_REGIONS(plat_obj, pregions, &npregions,
121 aregions, &naregions);
122 qsort(pregions, npregions, sizeof(*pregions), mr_cmp);
123 qsort(aregions, naregions, sizeof(*aregions), mr_cmp);
125 /* Remove overlapping available regions */
127 still_merging = FALSE;
128 for (i = 0; i < naregions; i++) {
129 if (aregions[i].mr_size == 0)
131 for (j = i+1; j < naregions; j++) {
132 if (aregions[j].mr_size == 0)
134 if (!memr_overlap(&aregions[j],
138 memr_merge(&aregions[j], &aregions[i]);
140 aregions[j].mr_size = 0;
141 still_merging = TRUE;
144 } while (still_merging == TRUE);
146 /* Collapse zero-length available regions */
147 for (i = 0; i < naregions; i++) {
148 if (aregions[i].mr_size == 0) {
149 memcpy(&aregions[i], &aregions[i+1],
150 (naregions - i - 1)*sizeof(*aregions));
160 *availsz = naregions;
164 mem_valid(vm_offset_t addr, int len)
168 if (npregions == 0) {
169 struct mem_region *p, *a;
171 mem_regions(&p, &np, &a, &na);
174 for (i = 0; i < npregions; i++)
175 if ((addr >= pregions[i].mr_start)
176 && (addr + len <= pregions[i].mr_start + pregions[i].mr_size))
183 platform_real_maxaddr(void)
185 return (PLATFORM_REAL_MAXADDR(plat_obj));
191 return (plat_def_impl->name);
195 platform_timebase_freq(struct cpuref *cpu)
197 return (PLATFORM_TIMEBASE_FREQ(plat_obj, cpu));
201 * Put the current CPU, as last step in suspend, to sleep
206 PLATFORM_SLEEP(plat_obj);
210 platform_smp_first_cpu(struct cpuref *cpu)
212 return (PLATFORM_SMP_FIRST_CPU(plat_obj, cpu));
216 platform_smp_next_cpu(struct cpuref *cpu)
218 return (PLATFORM_SMP_NEXT_CPU(plat_obj, cpu));
222 platform_smp_get_bsp(struct cpuref *cpu)
224 return (PLATFORM_SMP_GET_BSP(plat_obj, cpu));
228 platform_smp_start_cpu(struct pcpu *cpu)
230 return (PLATFORM_SMP_START_CPU(plat_obj, cpu));
234 platform_smp_ap_init()
236 PLATFORM_SMP_AP_INIT(plat_obj);
243 return (PLATFORM_SMP_TOPO(plat_obj));
248 * Reset back to firmware.
253 PLATFORM_RESET(plat_obj);
257 cpu_idle_wakeup(int cpu)
259 return (PLATFORM_IDLE_WAKEUP(plat_obj, cpu));
263 platform_cpu_idle(int cpu)
266 PLATFORM_IDLE(plat_obj, cpu);
270 * Platform install routines. Highest priority wins, using the same
271 * algorithm as bus attachment.
273 SET_DECLARE(platform_set, platform_def_t);
276 platform_probe_and_attach()
278 platform_def_t **platpp, *platp;
281 plat_obj = &plat_kernel_obj;
285 * Try to locate the best platform kobj
287 SET_FOREACH(platpp, platform_set) {
291 * Take care of compiling the selected class, and
292 * then statically initialise the MMU object
294 kobj_class_compile_static(platp, &plat_kernel_kops);
295 kobj_init_static((kobj_t)plat_obj, platp);
297 prio = PLATFORM_PROBE(plat_obj);
299 /* Check for errors */
304 * Check if this module was specifically requested through
305 * the loader tunable we provide.
307 if (strcmp(platp->name,plat_name) == 0) {
308 plat_def_impl = platp;
312 /* Otherwise, see if it is better than our current best */
313 if (plat_def_impl == NULL || prio > best_prio) {
315 plat_def_impl = platp;
319 * We can't free the KOBJ, since it is static. Reset the ops
320 * member of this class so that we can come back later.
325 if (plat_def_impl == NULL)
326 panic("No platform module found!");
329 * Recompile to make sure we ended with the
330 * correct one, and then attach.
333 kobj_class_compile_static(plat_def_impl, &plat_kernel_kops);
334 kobj_init_static((kobj_t)plat_obj, plat_def_impl);
336 strlcpy(plat_name,plat_def_impl->name,sizeof(plat_name));
338 PLATFORM_ATTACH(plat_obj);