xref: /illumos-gate/usr/src/boot/sys/sys/efi.h (revision 199767f8)
1 /*-
2  * Copyright (c) 2004 Marcel Moolenaar
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  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
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  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _SYS_EFI_H_
30 #define _SYS_EFI_H_
31 
32 #include <sys/uuid.h>
33 
34 #define	EFI_PAGE_SHIFT		12
35 #define	EFI_PAGE_SIZE		(1 << EFI_PAGE_SHIFT)
36 #define	EFI_PAGE_MASK		(EFI_PAGE_SIZE - 1)
37 
38 #define	EFI_TABLE_ACPI20			\
39 	{0x8868e871,0xe4f1,0x11d3,0xbc,0x22,{0x00,0x80,0xc7,0x3c,0x88,0x81}}
40 #define	EFI_TABLE_SAL				\
41 	{0xeb9d2d32,0x2d88,0x11d3,0x9a,0x16,{0x00,0x90,0x27,0x3f,0xc1,0x4d}}
42 
43 enum efi_reset {
44 	EFI_RESET_COLD,
45 	EFI_RESET_WARM
46 };
47 
48 typedef uint16_t	efi_char;
49 typedef unsigned long efi_status;
50 
51 struct efi_cfgtbl {
52 	struct uuid	ct_uuid;
53 	uint64_t	ct_data;
54 };
55 
56 struct efi_md {
57 	uint32_t	md_type;
58 #define	EFI_MD_TYPE_NULL	0
59 #define	EFI_MD_TYPE_CODE	1	/* Loader text. */
60 #define	EFI_MD_TYPE_DATA	2	/* Loader data. */
61 #define	EFI_MD_TYPE_BS_CODE	3	/* Boot services text. */
62 #define	EFI_MD_TYPE_BS_DATA	4	/* Boot services data. */
63 #define	EFI_MD_TYPE_RT_CODE	5	/* Runtime services text. */
64 #define	EFI_MD_TYPE_RT_DATA	6	/* Runtime services data. */
65 #define	EFI_MD_TYPE_FREE	7	/* Unused/free memory. */
66 #define	EFI_MD_TYPE_BAD		8	/* Bad memory */
67 #define	EFI_MD_TYPE_RECLAIM	9	/* ACPI reclaimable memory. */
68 #define	EFI_MD_TYPE_FIRMWARE	10	/* ACPI NV memory */
69 #define	EFI_MD_TYPE_IOMEM	11	/* Memory-mapped I/O. */
70 #define	EFI_MD_TYPE_IOPORT	12	/* I/O port space. */
71 #define	EFI_MD_TYPE_PALCODE	13	/* PAL */
72 	uint32_t	__pad;
73 	uint64_t	md_phys;
74 	void		*md_virt;
75 	uint64_t	md_pages;
76 	uint64_t	md_attr;
77 #define	EFI_MD_ATTR_UC		0x0000000000000001UL
78 #define	EFI_MD_ATTR_WC		0x0000000000000002UL
79 #define	EFI_MD_ATTR_WT		0x0000000000000004UL
80 #define	EFI_MD_ATTR_WB		0x0000000000000008UL
81 #define	EFI_MD_ATTR_UCE		0x0000000000000010UL
82 #define	EFI_MD_ATTR_WP		0x0000000000001000UL
83 #define	EFI_MD_ATTR_RP		0x0000000000002000UL
84 #define	EFI_MD_ATTR_XP		0x0000000000004000UL
85 #define	EFI_MD_ATTR_RT		0x8000000000000000UL
86 };
87 
88 struct efi_tm {
89 	uint16_t	tm_year;		/* 1998 - 20XX */
90 	uint8_t		tm_mon;			/* 1 - 12 */
91 	uint8_t		tm_mday;		/* 1 - 31 */
92 	uint8_t		tm_hour;		/* 0 - 23 */
93 	uint8_t		tm_min;			/* 0 - 59 */
94 	uint8_t		tm_sec;			/* 0 - 59 */
95 	uint8_t		__pad1;
96 	uint32_t	tm_nsec;		/* 0 - 999,999,999 */
97 	int16_t		tm_tz;			/* -1440 to 1440 or 2047 */
98 	uint8_t		tm_dst;
99 	uint8_t		__pad2;
100 };
101 
102 struct efi_tmcap {
103 	uint32_t	tc_res;		/* 1e-6 parts per million */
104 	uint32_t	tc_prec;	/* hertz */
105 	uint8_t		tc_stz;		/* Set clears sub-second time */
106 };
107 
108 struct efi_tblhdr {
109 	uint64_t	th_sig;
110 	uint32_t	th_rev;
111 	uint32_t	th_hdrsz;
112 	uint32_t	th_crc32;
113 	uint32_t	__res;
114 };
115 
116 struct efi_rt {
117 	struct efi_tblhdr rt_hdr;
118 	efi_status	(*rt_gettime)(struct efi_tm *, struct efi_tmcap *);
119 	efi_status	(*rt_settime)(struct efi_tm *);
120 	efi_status	(*rt_getwaketime)(uint8_t *, uint8_t *,
121 	    struct efi_tm *);
122 	efi_status	(*rt_setwaketime)(uint8_t, struct efi_tm *);
123 	efi_status	(*rt_setvirtual)(u_long, u_long, uint32_t,
124 	    struct efi_md *);
125 	efi_status	(*rt_cvtptr)(u_long, void **);
126 	efi_status	(*rt_getvar)(efi_char *, struct uuid *, uint32_t *,
127 	    u_long *, void *);
128 	efi_status	(*rt_scanvar)(u_long *, efi_char *, struct uuid *);
129 	efi_status	(*rt_setvar)(efi_char *, struct uuid *, uint32_t,
130 	    u_long, void *);
131 	efi_status	(*rt_gethicnt)(uint32_t *);
132 	efi_status	(*rt_reset)(enum efi_reset, efi_status, u_long,
133 	    efi_char *);
134 };
135 
136 struct efi_systbl {
137 	struct efi_tblhdr st_hdr;
138 #define	EFI_SYSTBL_SIG	0x5453595320494249UL
139 	efi_char	*st_fwvendor;
140 	uint32_t	st_fwrev;
141 	uint32_t	__pad;
142 	void		*st_cin;
143 	void		*st_cinif;
144 	void		*st_cout;
145 	void		*st_coutif;
146 	void		*st_cerr;
147 	void		*st_cerrif;
148 	uint64_t	st_rt;
149 	void		*st_bs;
150 	u_long		st_entries;
151 	uint64_t	st_cfgtbl;
152 };
153 
154 extern vm_paddr_t efi_systbl;
155 #endif /* _SYS_EFI_H_ */
156