xref: /freebsd/sys/i386/include/bootinfo.h (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
1 /*-
2  * Copyright (C) 1994 by Rodney W. Grimes, Milwaukie, Oregon  97222
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 as
10  *    the first lines of this file unmodified.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *	This product includes software developed by Rodney W. Grimes.
17  * 4. The name of the author may not be used to endorse or promote products
18  *    derived from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY RODNEY W. GRIMES ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL RODNEY W. GRIMES BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * $FreeBSD$
33  */
34 
35 #ifndef	_MACHINE_BOOTINFO_H_
36 #define	_MACHINE_BOOTINFO_H_
37 
38 /* Only change the version number if you break compatibility. */
39 #define	BOOTINFO_VERSION	1
40 
41 #define	N_BIOS_GEOM		8
42 
43 /*
44  * A zero bootinfo field often means that there is no info available.
45  * Flags are used to indicate the validity of fields where zero is a
46  * normal value.
47  */
48 struct bootinfo {
49 	u_int32_t	bi_version;
50 	u_int32_t	bi_kernelname;		/* represents a char * */
51 	u_int32_t	bi_nfs_diskless;	/* struct nfs_diskless * */
52 				/* End of fields that are always present. */
53 #define	bi_endcommon	bi_n_bios_used
54 	u_int32_t	bi_n_bios_used;
55 	u_int32_t	bi_bios_geom[N_BIOS_GEOM];
56 	u_int32_t	bi_size;
57 	u_int8_t	bi_memsizes_valid;
58 	u_int8_t	bi_bios_dev;		/* bootdev BIOS unit number */
59 	u_int8_t	bi_pad[2];
60 	u_int32_t	bi_basemem;
61 	u_int32_t	bi_extmem;
62 	u_int32_t	bi_symtab;		/* struct symtab * */
63 	u_int32_t	bi_esymtab;		/* struct symtab * */
64 				/* Items below only from advanced bootloader */
65 	u_int32_t	bi_kernend;		/* end of kernel space */
66 	u_int32_t	bi_envp;		/* environment */
67 	u_int32_t	bi_modulep;		/* preloaded modules */
68 	uint32_t	bi_memdesc_version;	/* EFI memory desc version */
69 	uint64_t	bi_memdesc_size;	/* sizeof EFI memory desc */
70 	uint64_t	bi_memmap;		/* pa of EFI memory map */
71 	uint64_t	bi_memmap_size;		/* size of EFI memory map */
72 	uint64_t	bi_hcdp;		/* DIG64 HCDP table */
73 	uint64_t	bi_fpswa;		/* FPSWA interface */
74 	uint64_t	bi_systab;		/* pa of EFI system table */
75 };
76 
77 #ifdef _KERNEL
78 extern struct bootinfo	bootinfo;
79 #endif
80 
81 /*
82  * Constants for converting boot-style device number to type,
83  * adaptor (uba, mba, etc), unit number and partition number.
84  * Type (== major device number) is in the low byte
85  * for backward compatibility.  Except for that of the "magic
86  * number", each mask applies to the shifted value.
87  * Format:
88  *	 (4)   (8)   (4)  (8)     (8)
89  *	--------------------------------
90  *	|MA | SLICE | UN| PART  | TYPE |
91  *	--------------------------------
92  */
93 #define B_SLICESHIFT		20
94 #define B_SLICEMASK		0xff
95 #define B_SLICE(val)		(((val)>>B_SLICESHIFT) & B_SLICEMASK)
96 #define B_UNITSHIFT		16
97 #define B_UNITMASK		0xf
98 #define	B_UNIT(val)		(((val) >> B_UNITSHIFT) & B_UNITMASK)
99 #define B_PARTITIONSHIFT	8
100 #define B_PARTITIONMASK		0xff
101 #define	B_PARTITION(val)	(((val) >> B_PARTITIONSHIFT) & B_PARTITIONMASK)
102 #define	B_TYPESHIFT		0
103 #define	B_TYPEMASK		0xff
104 #define	B_TYPE(val)		(((val) >> B_TYPESHIFT) & B_TYPEMASK)
105 
106 #define	B_MAGICMASK	0xf0000000
107 #define	B_DEVMAGIC	0xa0000000
108 
109 #define	MAKEBOOTDEV(type, slice, unit, partition) \
110 	(((type) << B_TYPESHIFT) | ((slice) << B_SLICESHIFT) | \
111 	((unit) << B_UNITSHIFT) | ((partition) << B_PARTITIONSHIFT) | \
112 	B_DEVMAGIC)
113 
114 #define	BASE_SLICE		2
115 #define	COMPATIBILITY_SLICE	0
116 #define	MAX_SLICES		32
117 #define	WHOLE_DISK_SLICE	1
118 
119 #endif	/* !_MACHINE_BOOTINFO_H_ */
120