xref: /freebsd/sys/arm/arm/platform_if.m (revision 5b9c547c)
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# $FreeBSD$
27#
28
29#include <sys/param.h>
30#include <sys/lock.h>
31#include <sys/mutex.h>
32#include <sys/systm.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
62/**
63 * @brief Probe for whether we are on this platform, returning the standard
64 * newbus probe codes. If we have Open Firmware or a flattened device tree,
65 * it is guaranteed to be available at this point.
66 */
67METHOD int probe {
68	platform_t	_plat;
69};
70
71/**
72 * @brief Attach this platform module. This happens before the MMU is online,
73 * so the platform module can install its own high-priority MMU module at
74 * this point.
75 */
76METHOD int attach {
77	platform_t	_plat;
78} DEFAULT platform_null_attach;
79
80/**
81 * @brief Called as one of the last steps of early virtual memory
82 * initialization, shortly before the new page tables are installed.
83 */
84METHOD int devmap_init {
85	platform_t	_plat;
86};
87
88/**
89 * @brief Called after devmap_init(), and must return the address of the
90 * first byte of unusable KVA space.  This allows a platform to carve out
91 * of the top of the KVA space whatever reserves it needs for things like
92 * static device mapping, and this is called to get the value before
93 * calling pmap_bootstrap() which uses the value to size the available KVA.
94 */
95METHOD vm_offset_t lastaddr {
96	platform_t	_plat;
97};
98
99/**
100 * @brief Called after the static device mappings are established and just
101 * before cninit(). The intention is that the routine can do any hardware
102 * setup (such as gpio or pinmux) necessary to make the console functional.
103 */
104METHOD void gpio_init {
105	platform_t	_plat;
106};
107
108/**
109 * @brief Called just after cninit(). This is the first of the init
110 * routines that can use printf() and expect the output to appear on
111 * a standard console.
112 */
113METHOD void late_init {
114	platform_t	_plat;
115};
116
117