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