xref: /freebsd/sys/x86/include/metadata.h (revision a3fa657eddade274a5cb684b5e5e890eef67ad25)
1 /*-
2  * Copyright (c) 2003 Peter Wemm <peter@FreeBSD.org>
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_METADATA_H_
28 #define	_MACHINE_METADATA_H_
29 
30 #define	MODINFOMD_SMAP		0x1001
31 #define	MODINFOMD_SMAP_XATTR	0x1002
32 #define	MODINFOMD_DTBP		0x1003
33 #define	MODINFOMD_EFI_MAP	0x1004
34 #define	MODINFOMD_EFI_FB	0x1005
35 #define	MODINFOMD_MODULEP	0x1006
36 #define	MODINFOMD_VBE_FB	0x1007
37 #define	MODINFOMD_EFI_ARCH	0x1008
38 
39 /*
40  * This is not the same as the UEFI standard EFI_MEMORY_ATTRIBUTES_TABLE, though
41  * memory_size / descritpr_size entries of EFI_MEMORY_DESCRIPTORS follow this table
42  * starting at a 16-byte alignment.
43  */
44 struct efi_map_header {
45 	uint64_t	memory_size;		/* Numnber of bytes that follow */
46 	uint64_t	descriptor_size;	/* Size of each EFI_MEMORY_DESCRIPTOR */
47 	uint32_t	descriptor_version;	/* Currently '1' */
48 };
49 
50 struct efi_fb {
51 	uint64_t	fb_addr;
52 	uint64_t	fb_size;
53 	uint32_t	fb_height;
54 	uint32_t	fb_width;
55 	uint32_t	fb_stride;
56 	uint32_t	fb_mask_red;
57 	uint32_t	fb_mask_green;
58 	uint32_t	fb_mask_blue;
59 	uint32_t	fb_mask_reserved;
60 };
61 
62 struct vbe_fb {
63 	uint64_t	fb_addr;
64 	uint64_t	fb_size;
65 	uint32_t	fb_height;
66 	uint32_t	fb_width;
67 	uint32_t	fb_stride;
68 	uint32_t	fb_mask_red;
69 	uint32_t	fb_mask_green;
70 	uint32_t	fb_mask_blue;
71 	uint32_t	fb_mask_reserved;
72 	uint32_t	fb_bpp;
73 };
74 
75 /*
76  * The structure below is used when FreeBSD kernel is booted as a dom0 kernel
77  * from Xen. In such scenario we need to accommodate the modules and the
78  * metadata as a contiguous memory region, so it can be passed as a multiboot
79  * module, and some extra information is required which is conveyed from the
80  * loader to the kernel using the xen_header structure below.
81  *
82  * See the comment in multiboot.c about how the structure below is packaged
83  * together with the rest of the kernel payload data.
84  */
85 struct xen_header {
86 	uint64_t	flags;
87 #define XENHEADER_HAS_MODULEP_OFFSET (1ull << 0)
88 
89 	/*
90 	 * Offset of the modulep location from the start of the multiboot
91 	 * module blob.
92 	 */
93 	uint64_t	modulep_offset;
94 };
95 
96 #endif /* !_MACHINE_METADATA_H_ */
97