1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
.\" Copyright (c) 2023 Ian Marco Moffett and the VegaOS team.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright notice,
.\" this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of VegaOS nor the names of its
.\" contributors may be used to endorse or promote products derived from
.\" this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.Dd October 4, 2023
.Dt ARCH 9
.Os
.Sh NAME
.Nm arch - vega arch information
.Sh SYNOPSIS
.In sys/machdep.h
.In machine/cpu.h
.In machine/pmap.h
.Sh DESCRIPTION
NOTE: All examples will be for x86_64 but can be applied to others
Information about how Vega and architectures work together. This
will describe headers and .c files that need to exist for all
architectures and things they should include. The
.Ft machine/cpu.h
file contains information about the CPU for the specific
architecture. Required structures in this header include the
.Ft cpu_info
struct which contains CPU specific fields.
Example
.Ft cpu_info
structure for x86_64 is shown below:
.Bd -literal
struct cpu_info {
void *pmap; /* Current pmap */
volatile uint32_t lapic_freq;
...
};
.Ed
The macro
.Ft this_cpu()
calls an internal function that fetches the
cpu_info structure for the current CPU.
The macro
.Ft get_bsp()
calls an internal function that fetches the
cpu_info structure for the BSP.
The function these macros call must return a pointer
to a
.Ft cpu_info
structure.
In the
.Ft machine/pmap.h
header, should be a struct containing information
about the address space. This header MUST be implemented
or compiler errors will occur.
.Sh AUTHORS
.An Ian Moffett Aq Mt ian@osmora.org
|
