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