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