xref: /f-stack/freebsd/arm/include/platform.h (revision a9643ea8)
1*a9643ea8Slogwang /*-
2*a9643ea8Slogwang  * Copyright (c) 2014 Andrew Turner
3*a9643ea8Slogwang  * All rights reserved.
4*a9643ea8Slogwang  *
5*a9643ea8Slogwang  * Redistribution and use in source and binary forms, with or without
6*a9643ea8Slogwang  * modification, are permitted provided that the following conditions
7*a9643ea8Slogwang  * are met:
8*a9643ea8Slogwang  * 1. Redistributions of source code must retain the above copyright
9*a9643ea8Slogwang  *    notice, this list of conditions and the following disclaimer.
10*a9643ea8Slogwang  * 2. Redistributions in binary form must reproduce the above copyright
11*a9643ea8Slogwang  *    notice, this list of conditions and the following disclaimer in the
12*a9643ea8Slogwang  *    documentation and/or other materials provided with the distribution.
13*a9643ea8Slogwang  *
14*a9643ea8Slogwang  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15*a9643ea8Slogwang  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16*a9643ea8Slogwang  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17*a9643ea8Slogwang  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18*a9643ea8Slogwang  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19*a9643ea8Slogwang  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20*a9643ea8Slogwang  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21*a9643ea8Slogwang  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22*a9643ea8Slogwang  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23*a9643ea8Slogwang  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24*a9643ea8Slogwang  * SUCH DAMAGE.
25*a9643ea8Slogwang  *
26*a9643ea8Slogwang  * $FreeBSD$
27*a9643ea8Slogwang  */
28*a9643ea8Slogwang 
29*a9643ea8Slogwang #ifndef	_MACHINE_PLATFORM_H_
30*a9643ea8Slogwang #define	_MACHINE_PLATFORM_H_
31*a9643ea8Slogwang 
32*a9643ea8Slogwang /*
33*a9643ea8Slogwang  * Initialization functions called by the common initarm() function in
34*a9643ea8Slogwang  * arm/machdep.c (but not necessarily from the custom initarm() functions of
35*a9643ea8Slogwang  * older code).
36*a9643ea8Slogwang  *
37*a9643ea8Slogwang  *  - platform_probe_and_attach() is called very early, after parsing the boot
38*a9643ea8Slogwang  *    params and after physical memory has been located and sized.
39*a9643ea8Slogwang  *
40*a9643ea8Slogwang  *  - platform_devmap_init() is called as one of the last steps of early virtual
41*a9643ea8Slogwang  *    memory initialization, shortly before the new page tables are installed.
42*a9643ea8Slogwang  *
43*a9643ea8Slogwang  *  - platform_lastaddr() is called after platform_devmap_init(), and must return
44*a9643ea8Slogwang  *    the address of the first byte of unusable KVA space.  This allows a
45*a9643ea8Slogwang  *    platform to carve out of the top of the KVA space whatever reserves it
46*a9643ea8Slogwang  *    needs for things like static device mapping, and this is called to get the
47*a9643ea8Slogwang  *    value before calling pmap_bootstrap() which uses the value to size the
48*a9643ea8Slogwang  *    available KVA.
49*a9643ea8Slogwang  *
50*a9643ea8Slogwang  *  - platform_gpio_init() is called after the static device mappings are
51*a9643ea8Slogwang  *    established and just before cninit().  The intention is that the routine
52*a9643ea8Slogwang  *    can do any hardware setup (such as gpio or pinmux) necessary to make the
53*a9643ea8Slogwang  *    console functional.
54*a9643ea8Slogwang  *
55*a9643ea8Slogwang  *  - platform_late_init() is called just after cninit().  This is the first of
56*a9643ea8Slogwang  *    the init routines that can use printf() and expect the output to appear on
57*a9643ea8Slogwang  *    a standard console.
58*a9643ea8Slogwang  *
59*a9643ea8Slogwang  */
60*a9643ea8Slogwang void platform_probe_and_attach(void);
61*a9643ea8Slogwang int platform_devmap_init(void);
62*a9643ea8Slogwang vm_offset_t platform_lastaddr(void);
63*a9643ea8Slogwang void platform_gpio_init(void);
64*a9643ea8Slogwang void platform_late_init(void);
65*a9643ea8Slogwang 
66*a9643ea8Slogwang #endif	/* _MACHINE_PLATFORM_H_ */
67