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
27 #ifndef _SYS_EFI_H_
28 #define _SYS_EFI_H_
29
30 #include <sys/uuid.h>
31 #include <machine/efi.h>
32
33 #define EFI_PAGE_SHIFT 12
34 #define EFI_PAGE_SIZE (1 << EFI_PAGE_SHIFT)
35 #define EFI_PAGE_MASK (EFI_PAGE_SIZE - 1)
36
37 #define EFI_TABLE_SMBIOS \
38 {0xeb9d2d31,0x2d88,0x11d3,{0x9a,0x16,0x00,0x90,0x27,0x3f,0xc1,0x4d}}
39 #define EFI_TABLE_SMBIOS3 \
40 {0xf2fd1544,0x9794,0x4a2c,{0x99,0x2e,0xe5,0xbb,0xcf,0x20,0xe3,0x94}}
41 #define EFI_TABLE_ESRT \
42 {0xb122a263,0x3661,0x4f68,{0x99,0x29,0x78,0xf8,0xb0,0xd6,0x21,0x80}}
43 #define EFI_PROPERTIES_TABLE \
44 {0x880aaca3,0x4adc,0x4a04,{0x90,0x79,0xb7,0x47,0x34,0x08,0x25,0xe5}}
45 #define LINUX_EFI_MEMRESERVE_TABLE \
46 {0x888eb0c6,0x8ede,0x4ff5,{0xa8,0xf0,0x9a,0xee,0x5c,0xb9,0x77,0xc2}}
47
48 enum efi_reset {
49 EFI_RESET_COLD = 0,
50 EFI_RESET_WARM = 1,
51 EFI_RESET_SHUTDOWN = 2,
52 };
53
54 typedef uint16_t efi_char;
55 typedef unsigned long efi_status;
56
57 /*
58 * This type-puns to a struct uuid, but all the EDK2 headers use this variation,
59 * and we use it in the loader to specify GUIDs. We define it here so that we
60 * can use EDK2 definitions both places.
61 */
62 typedef struct efi_guid {
63 uint32_t Data1;
64 uint16_t Data2;
65 uint16_t Data3;
66 uint8_t Data4[8];
67 } efi_guid_t; /* Type puns with GUID and EFI_GUID */
68
69 struct efi_cfgtbl {
70 efi_guid_t ct_guid;
71 void *ct_data;
72 };
73
74 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
75
76 struct efi_md {
77 uint32_t md_type;
78 #define EFI_MD_TYPE_NULL 0
79 #define EFI_MD_TYPE_CODE 1 /* Loader text. */
80 #define EFI_MD_TYPE_DATA 2 /* Loader data. */
81 #define EFI_MD_TYPE_BS_CODE 3 /* Boot services text. */
82 #define EFI_MD_TYPE_BS_DATA 4 /* Boot services data. */
83 #define EFI_MD_TYPE_RT_CODE 5 /* Runtime services text. */
84 #define EFI_MD_TYPE_RT_DATA 6 /* Runtime services data. */
85 #define EFI_MD_TYPE_FREE 7 /* Unused/free memory. */
86 #define EFI_MD_TYPE_BAD 8 /* Bad memory */
87 #define EFI_MD_TYPE_RECLAIM 9 /* ACPI reclaimable memory. */
88 #define EFI_MD_TYPE_FIRMWARE 10 /* ACPI NV memory */
89 #define EFI_MD_TYPE_IOMEM 11 /* Memory-mapped I/O. */
90 #define EFI_MD_TYPE_IOPORT 12 /* I/O port space. */
91 #define EFI_MD_TYPE_PALCODE 13 /* PAL */
92 #define EFI_MD_TYPE_PERSISTENT 14 /* Persistent memory. */
93 uint32_t __pad;
94 uint64_t md_phys;
95 uint64_t md_virt;
96 uint64_t md_pages;
97 uint64_t md_attr;
98 #define EFI_MD_ATTR_UC 0x0000000000000001UL
99 #define EFI_MD_ATTR_WC 0x0000000000000002UL
100 #define EFI_MD_ATTR_WT 0x0000000000000004UL
101 #define EFI_MD_ATTR_WB 0x0000000000000008UL
102 #define EFI_MD_ATTR_UCE 0x0000000000000010UL
103 #define EFI_MD_ATTR_WP 0x0000000000001000UL
104 #define EFI_MD_ATTR_RP 0x0000000000002000UL
105 #define EFI_MD_ATTR_XP 0x0000000000004000UL
106 #define EFI_MD_ATTR_NV 0x0000000000008000UL
107 #define EFI_MD_ATTR_MORE_RELIABLE \
108 0x0000000000010000UL
109 #define EFI_MD_ATTR_RO 0x0000000000020000UL
110 #define EFI_MD_ATTR_RT 0x8000000000000000UL
111 };
112
113 #define efi_next_descriptor(ptr, size) \
114 ((struct efi_md *)(((uint8_t *)(ptr)) + (size)))
115
116 struct efi_tm {
117 uint16_t tm_year; /* 1998 - 20XX */
118 uint8_t tm_mon; /* 1 - 12 */
119 uint8_t tm_mday; /* 1 - 31 */
120 uint8_t tm_hour; /* 0 - 23 */
121 uint8_t tm_min; /* 0 - 59 */
122 uint8_t tm_sec; /* 0 - 59 */
123 uint8_t __pad1;
124 uint32_t tm_nsec; /* 0 - 999,999,999 */
125 int16_t tm_tz; /* -1440 to 1440 or 2047 */
126 uint8_t tm_dst;
127 uint8_t __pad2;
128 };
129
130 struct efi_tmcap {
131 uint32_t tc_res; /* 1e-6 parts per million */
132 uint32_t tc_prec; /* hertz */
133 uint8_t tc_stz; /* Set clears sub-second time */
134 };
135
136 struct efi_tblhdr {
137 uint64_t th_sig;
138 uint32_t th_rev;
139 uint32_t th_hdrsz;
140 uint32_t th_crc32;
141 uint32_t __res;
142 };
143
144 #define ESRT_FIRMWARE_RESOURCE_VERSION 1
145
146 struct efi_esrt_table {
147 uint32_t fw_resource_count;
148 uint32_t fw_resource_count_max;
149 uint64_t fw_resource_version;
150 uint8_t entries[];
151 };
152
153 struct efi_esrt_entry_v1 {
154 efi_guid_t fw_class;
155 uint32_t fw_type;
156 uint32_t fw_version;
157 uint32_t lowest_supported_fw_version;
158 uint32_t capsule_flags;
159 uint32_t last_attempt_version;
160 uint32_t last_attempt_status;
161 };
162
163 struct efi_prop_table {
164 uint32_t version;
165 uint32_t length;
166 uint64_t memory_protection_attribute;
167 };
168
169 #ifdef _KERNEL
170
171 #ifdef EFIABI_ATTR
172 struct efi_rt {
173 struct efi_tblhdr rt_hdr;
174 efi_status (*rt_gettime)(struct efi_tm *, struct efi_tmcap *)
175 EFIABI_ATTR;
176 efi_status (*rt_settime)(struct efi_tm *) EFIABI_ATTR;
177 efi_status (*rt_getwaketime)(uint8_t *, uint8_t *,
178 struct efi_tm *) EFIABI_ATTR;
179 efi_status (*rt_setwaketime)(uint8_t, struct efi_tm *)
180 EFIABI_ATTR;
181 efi_status (*rt_setvirtual)(u_long, u_long, uint32_t,
182 struct efi_md *) EFIABI_ATTR;
183 efi_status (*rt_cvtptr)(u_long, void **) EFIABI_ATTR;
184 efi_status (*rt_getvar)(efi_char *, efi_guid_t *, uint32_t *,
185 u_long *, void *) EFIABI_ATTR;
186 efi_status (*rt_scanvar)(u_long *, efi_char *, efi_guid_t *)
187 EFIABI_ATTR;
188 efi_status (*rt_setvar)(efi_char *, efi_guid_t *, uint32_t,
189 u_long, void *) EFIABI_ATTR;
190 efi_status (*rt_gethicnt)(uint32_t *) EFIABI_ATTR;
191 efi_status (*rt_reset)(enum efi_reset, efi_status, u_long,
192 efi_char *) EFIABI_ATTR;
193 };
194 #endif
195
196 struct efi_systbl {
197 struct efi_tblhdr st_hdr;
198 #define EFI_SYSTBL_SIG 0x5453595320494249UL
199 efi_char *st_fwvendor;
200 uint32_t st_fwrev;
201 uint32_t __pad;
202 void *st_cin;
203 void *st_cinif;
204 void *st_cout;
205 void *st_coutif;
206 void *st_cerr;
207 void *st_cerrif;
208 uint64_t st_rt;
209 void *st_bs;
210 u_long st_entries;
211 uint64_t st_cfgtbl;
212 };
213
214 extern vm_paddr_t efi_systbl_phys;
215
216 /*
217 * When memory is reserved for some use, Linux will add a
218 * LINUX_EFI_MEMSERVE_TABLE to the cfgtbl array of tables to communicate
219 * this. At present, Linux only uses this as part of its workaround for a GICv3
220 * issue where you can't stop the controller long enough to move it's config and
221 * pending vectors. When the LinuxBoot environment kexec's a new kernel, the new
222 * kernel needs to use this old memory (and not use it for any other purpose).
223 *
224 * Linux stores the PA of this table in the cfgtbl. And all the addresses are
225 * the physical address of 'reserved' memory. The mr_next field creates a linked
226 * list of these tables, and all must be walked. If mr_count is 0, that entry
227 * should be ignored. There is no checksum for these tables, nor do they have
228 * a efi_tblhdr.
229 *
230 * This table is only documented in the Linux code in drivers/firmware/efi/efi.c.
231 */
232 struct linux_efi_memreserve_entry {
233 vm_offset_t mre_base; /* PA of reserved area */
234 vm_offset_t mre_size; /* Size of area */
235 };
236
237 struct linux_efi_memreserve {
238 uint32_t mr_size; /* Total size of table in bytes */
239 uint32_t mr_count; /* Count of entries used */
240 vm_offset_t mr_next; /* Next in chain (though unused?) */
241 struct linux_efi_memreserve_entry mr_entry[];
242 };
243
244 struct efirt_callinfo;
245
246 /* Internal MD EFI functions */
247 int efi_arch_enter(void);
248 void efi_arch_leave(void);
249 vm_offset_t efi_phys_to_kva(vm_paddr_t);
250 int efi_rt_arch_call(struct efirt_callinfo *);
251 bool efi_create_1t1_map(struct efi_md *, int, int);
252 void efi_destroy_1t1_map(void);
253
254 struct efi_ops {
255 /*
256 * The EFI calls might be virtualized in some environments, requiring
257 * FreeBSD to use a different interface (ie: hypercalls) in order to
258 * access them.
259 */
260 int (*rt_ok)(void);
261 int (*get_table)(efi_guid_t *, void **);
262 int (*copy_table)(efi_guid_t *, void **, size_t, size_t *);
263 int (*get_time)(struct efi_tm *);
264 int (*get_time_capabilities)(struct efi_tmcap *);
265 int (*reset_system)(enum efi_reset);
266 int (*set_time)(struct efi_tm *);
267 int (*get_waketime)(uint8_t *enabled, uint8_t *pending,
268 struct efi_tm *tm);
269 int (*set_waketime)(uint8_t enable, struct efi_tm *tm);
270 int (*var_get)(uint16_t *, efi_guid_t *, uint32_t *, size_t *,
271 void *);
272 int (*var_nextname)(size_t *, uint16_t *, efi_guid_t *);
273 int (*var_set)(uint16_t *, efi_guid_t *, uint32_t, size_t, void *);
274 };
275 extern const struct efi_ops *active_efi_ops;
276
277 /* Public MI EFI functions */
efi_rt_ok(void)278 static inline int efi_rt_ok(void)
279 {
280
281 if (active_efi_ops->rt_ok == NULL)
282 return (ENXIO);
283 return (active_efi_ops->rt_ok());
284 }
285
efi_get_table(efi_guid_t * guid,void ** ptr)286 static inline int efi_get_table(efi_guid_t *guid, void **ptr)
287 {
288
289 if (active_efi_ops->get_table == NULL)
290 return (ENXIO);
291 return (active_efi_ops->get_table(guid, ptr));
292 }
293
efi_copy_table(efi_guid_t * guid,void ** buf,size_t buf_len,size_t * table_len)294 static inline int efi_copy_table(efi_guid_t *guid, void **buf,
295 size_t buf_len, size_t *table_len)
296 {
297
298 if (active_efi_ops->copy_table == NULL)
299 return (ENXIO);
300 return (active_efi_ops->copy_table(guid, buf, buf_len, table_len));
301 }
302
efi_get_time(struct efi_tm * tm)303 static inline int efi_get_time(struct efi_tm *tm)
304 {
305
306 if (active_efi_ops->get_time == NULL)
307 return (ENXIO);
308 return (active_efi_ops->get_time(tm));
309 }
310
efi_get_time_capabilities(struct efi_tmcap * tmcap)311 static inline int efi_get_time_capabilities(struct efi_tmcap *tmcap)
312 {
313
314 if (active_efi_ops->get_time_capabilities == NULL)
315 return (ENXIO);
316 return (active_efi_ops->get_time_capabilities(tmcap));
317 }
318
efi_reset_system(enum efi_reset type)319 static inline int efi_reset_system(enum efi_reset type)
320 {
321
322 if (active_efi_ops->reset_system == NULL)
323 return (ENXIO);
324 return (active_efi_ops->reset_system(type));
325 }
326
efi_set_time(struct efi_tm * tm)327 static inline int efi_set_time(struct efi_tm *tm)
328 {
329
330 if (active_efi_ops->set_time == NULL)
331 return (ENXIO);
332 return (active_efi_ops->set_time(tm));
333 }
334
efi_get_waketime(uint8_t * enabled,uint8_t * pending,struct efi_tm * tm)335 static inline int efi_get_waketime(uint8_t *enabled, uint8_t *pending,
336 struct efi_tm *tm)
337 {
338 if (active_efi_ops->get_waketime == NULL)
339 return (ENXIO);
340 return (active_efi_ops->get_waketime(enabled, pending, tm));
341 }
342
efi_set_waketime(uint8_t enable,struct efi_tm * tm)343 static inline int efi_set_waketime(uint8_t enable, struct efi_tm *tm)
344 {
345 if (active_efi_ops->set_waketime == NULL)
346 return (ENXIO);
347 return (active_efi_ops->set_waketime(enable, tm));
348 }
349
efi_var_get(uint16_t * name,efi_guid_t * vendor,uint32_t * attrib,size_t * datasize,void * data)350 static inline int efi_var_get(uint16_t *name, efi_guid_t *vendor,
351 uint32_t *attrib, size_t *datasize, void *data)
352 {
353
354 if (active_efi_ops->var_get == NULL)
355 return (ENXIO);
356 return (active_efi_ops->var_get(name, vendor, attrib, datasize, data));
357 }
358
efi_var_nextname(size_t * namesize,uint16_t * name,efi_guid_t * vendor)359 static inline int efi_var_nextname(size_t *namesize, uint16_t *name,
360 efi_guid_t *vendor)
361 {
362
363 if (active_efi_ops->var_nextname == NULL)
364 return (ENXIO);
365 return (active_efi_ops->var_nextname(namesize, name, vendor));
366 }
367
efi_var_set(uint16_t * name,efi_guid_t * vendor,uint32_t attrib,size_t datasize,void * data)368 static inline int efi_var_set(uint16_t *name, efi_guid_t *vendor,
369 uint32_t attrib, size_t datasize, void *data)
370 {
371
372 if (active_efi_ops->var_set == NULL)
373 return (ENXIO);
374 return (active_efi_ops->var_set(name, vendor, attrib, datasize, data));
375 }
376
377 int efi_status_to_errno(efi_status status);
378
379 #endif /* _KERNEL */
380
381 #endif /* _SYS_EFI_H_ */
382