xref: /freebsd/sys/arm/arm/platform_if.m (revision 031beb4e)
1#-
2# Copyright (c) 2009 Nathan Whitehorn
3# All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions
7# are met:
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.
13#
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
24# SUCH DAMAGE.
25#
26#
27
28#include <sys/param.h>
29#include <sys/systm.h>
30#include <sys/devmap.h>
31#include <sys/lock.h>
32#include <sys/mutex.h>
33#include <sys/smp.h>
34
35#include <machine/machdep.h>
36#include <machine/platform.h>
37#include <machine/platformvar.h>
38#include <machine/smp.h>
39#include <machine/vmparam.h>
40
41/**
42 * @defgroup PLATFORM platform - KObj methods for ARM platform
43 * implementations
44 * @brief A set of methods required by all platform implementations.
45 * These are used to bring up secondary CPUs, supply the physical memory
46 * map, etc.
47 *@{
48 */
49
50INTERFACE platform;
51
52#
53# Default implementations
54#
55CODE {
56	static void platform_null_attach(platform_t plat)
57	{
58		return;
59	}
60
61	static vm_offset_t platform_default_lastaddr(platform_t plat)
62	{
63		return (devmap_lastaddr());
64	}
65
66	static void platform_default_mp_setmaxid(platform_t plat)
67	{
68		mp_ncpus = 1;
69		mp_maxid = 0;
70	}
71};
72
73/**
74 * @brief Probe for whether we are on this platform, returning the standard
75 * newbus probe codes. If we have Open Firmware or a flattened device tree,
76 * it is guaranteed to be available at this point.
77 */
78METHOD int probe {
79	platform_t	_plat;
80};
81
82/**
83 * @brief Attach this platform module. This happens before the MMU is online,
84 * so the platform module can install its own high-priority MMU module at
85 * this point.
86 */
87METHOD int attach {
88	platform_t	_plat;
89} DEFAULT platform_null_attach;
90
91/**
92 * @brief Called as one of the last steps of early virtual memory
93 * initialization, shortly before the new page tables are installed.
94 */
95METHOD int devmap_init {
96	platform_t	_plat;
97};
98
99/**
100 * @brief Called after devmap_init(), and must return the address of the
101 * first byte of unusable KVA space.  This allows a platform to carve out
102 * of the top of the KVA space whatever reserves it needs for things like
103 * static device mapping, and this is called to get the value before
104 * calling pmap_bootstrap() which uses the value to size the available KVA.
105 */
106METHOD vm_offset_t lastaddr {
107	platform_t	_plat;
108} DEFAULT platform_default_lastaddr;
109
110/**
111 * @brief Called after the static device mappings are established and just
112 * before cninit(). The intention is that the routine can do any hardware
113 * setup (such as gpio or pinmux) necessary to make the console functional.
114 */
115METHOD void gpio_init {
116	platform_t	_plat;
117};
118
119/**
120 * @brief Called just after cninit(). This is the first of the init
121 * routines that can use printf() and expect the output to appear on
122 * a standard console.
123 */
124METHOD void late_init {
125	platform_t	_plat;
126};
127
128/**
129 * @brief Called by cpu_mp_setmaxid() to set mp_maxid and mp_ncpus.
130 */
131METHOD void mp_setmaxid {
132	platform_t	_plat;
133} DEFAULT platform_default_mp_setmaxid;
134
135/**
136 * @brief Called by cpu_mp_start to start the secondary processors.
137 */
138METHOD void mp_start_ap {
139	platform_t	_plat;
140};
141
142/**
143 * @brief Called by cpu_reset to reboot.
144 */
145METHOD void cpu_reset {
146	platform_t	_plat;
147};
148