xref: /freebsd/sys/arm/include/platform.h (revision 7899f917b1c0ea178f1d2be0cfb452086d079d23)
1 /*-
2  * Copyright (c) 2014 Andrew Turner
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 #ifndef	_MACHINE_PLATFORM_H_
28 #define	_MACHINE_PLATFORM_H_
29 
30 /*
31  * Initialization functions called by the common initarm() function in
32  * arm/machdep.c (but not necessarily from the custom initarm() functions of
33  * older code).
34  *
35  *  - platform_probe_and_attach() is called very early, after parsing the boot
36  *    params and after physical memory has been located and sized.
37  *
38  *  - platform_devmap_init() is called as one of the last steps of early virtual
39  *    memory initialization, shortly before the new page tables are installed.
40  *
41  *  - platform_lastaddr() is called after platform_devmap_init(), and must return
42  *    the address of the first byte of unusable KVA space.  This allows a
43  *    platform to carve out of the top of the KVA space whatever reserves it
44  *    needs for things like static device mapping, and this is called to get the
45  *    value before calling pmap_bootstrap() which uses the value to size the
46  *    available KVA.
47  *
48  *  - platform_gpio_init() is called after the static device mappings are
49  *    established and just before cninit().  The intention is that the routine
50  *    can do any hardware setup (such as gpio or pinmux) necessary to make the
51  *    console functional.
52  *
53  *  - platform_late_init() is called just after cninit().  This is the first of
54  *    the init routines that can use printf() and expect the output to appear on
55  *    a standard console.
56  *
57  */
58 void platform_probe_and_attach(void);
59 int platform_devmap_init(void);
60 vm_offset_t platform_lastaddr(void);
61 void platform_gpio_init(void);
62 void platform_late_init(void);
63 
64 #endif	/* _MACHINE_PLATFORM_H_ */
65