efi.h revision 1.12
1 /* $NetBSD: efi.h,v 1.12 2022/08/20 09:40:04 riastradh Exp $ */ 2 3 /*- 4 * Copyright (c) 2004 Marcel Moolenaar 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 /* This file is mainly ia64/include/efi.h with little modifications. */ 32 33 #ifndef _X86_EFI_H_ 34 #define _X86_EFI_H_ 35 36 #include <sys/uuid.h> 37 38 #define EFI_PAGE_SHIFT 12 39 #define EFI_PAGE_SIZE (1 << EFI_PAGE_SHIFT) 40 #define EFI_PAGE_MASK (EFI_PAGE_SIZE - 1) 41 42 #define EFI_TABLE_ACPI20 \ 43 {0x8868e871,0xe4f1,0x11d3,0xbc,0x22,{0x00,0x80,0xc7,0x3c,0x88,0x81}} 44 #define EFI_TABLE_ACPI10 \ 45 {0xeb9d2d30,0x2d88,0x11d3,0x9a,0x16,{0x00,0x90,0x27,0x3f,0xc1,0x4d}} 46 #define EFI_TABLE_SMBIOS \ 47 {0xeb9d2d31,0x2d88,0x11d3,0x9a,0x16,{0x00,0x90,0x27,0x3f,0xc1,0x4d}} 48 #define EFI_TABLE_SMBIOS3 \ 49 {0xf2fd1544,0x9794,0x4a2c,0x99,0x2e,{0xe5,0xbb,0xcf,0x20,0xe3,0x94}} 50 51 extern const struct uuid EFI_UUID_ACPI20; 52 extern const struct uuid EFI_UUID_ACPI10; 53 extern const struct uuid EFI_UUID_SMBIOS; 54 extern const struct uuid EFI_UUID_SMBIOS3; 55 56 extern bool bootmethod_efi; 57 58 enum efi_reset { 59 EFI_RESET_COLD, 60 EFI_RESET_WARM 61 }; 62 63 typedef uint16_t efi_char; 64 typedef unsigned long efi_status; 65 66 #if defined(__amd64__) 67 typedef uint64_t uintn; 68 #elif defined(__i386__) 69 typedef uint32_t uintn; 70 #endif 71 72 struct efi_cfgtbl { 73 struct uuid ct_uuid; 74 void *ct_data; 75 }; 76 77 struct efi_md { 78 uint32_t md_type; 79 #define EFI_MD_TYPE_NULL 0 80 #define EFI_MD_TYPE_CODE 1 /* Loader text. */ 81 #define EFI_MD_TYPE_DATA 2 /* Loader data. */ 82 #define EFI_MD_TYPE_BS_CODE 3 /* Boot services text. */ 83 #define EFI_MD_TYPE_BS_DATA 4 /* Boot services data. */ 84 #define EFI_MD_TYPE_RT_CODE 5 /* Runtime services text. */ 85 #define EFI_MD_TYPE_RT_DATA 6 /* Runtime services data. */ 86 #define EFI_MD_TYPE_FREE 7 /* Unused/free memory. */ 87 #define EFI_MD_TYPE_BAD 8 /* Bad memory */ 88 #define EFI_MD_TYPE_RECLAIM 9 /* ACPI reclaimable memory. */ 89 #define EFI_MD_TYPE_FIRMWARE 10 /* ACPI NV memory */ 90 #define EFI_MD_TYPE_IOMEM 11 /* Memory-mapped I/O. */ 91 #define EFI_MD_TYPE_IOPORT 12 /* I/O port space. */ 92 #define EFI_MD_TYPE_PALCODE 13 /* PAL */ 93 #define EFI_MD_TYPE_PMEM 14 /* Persistent memory. */ 94 uint32_t __pad; 95 uint64_t md_phys; 96 uint64_t md_virt; 97 uint64_t md_pages; 98 uint64_t md_attr; 99 #define EFI_MD_ATTR_UC 0x0000000000000001UL 100 #define EFI_MD_ATTR_WC 0x0000000000000002UL 101 #define EFI_MD_ATTR_WT 0x0000000000000004UL 102 #define EFI_MD_ATTR_WB 0x0000000000000008UL 103 #define EFI_MD_ATTR_UCE 0x0000000000000010UL 104 #define EFI_MD_ATTR_WP 0x0000000000001000UL 105 #define EFI_MD_ATTR_RP 0x0000000000002000UL 106 #define EFI_MD_ATTR_XP 0x0000000000004000UL 107 #define EFI_MD_ATTR_NV 0x0000000000008000UL 108 #define EFI_MD_ATTR_MORE_RELIABLE 0x0000000000010000UL 109 #define EFI_MD_ATTR_RO 0x0000000000020000UL 110 #define EFI_MD_ATTR_SP 0x0000000000040000UL 111 #define EFI_MD_ATTR_CPU_CRYPTO 0x0000000000080000UL 112 #define EFI_MD_ATTR_RT 0x8000000000000000UL 113 }; 114 115 struct efi_tm { 116 uint16_t tm_year; /* 1998 - 20XX */ 117 uint8_t tm_mon; /* 1 - 12 */ 118 uint8_t tm_mday; /* 1 - 31 */ 119 uint8_t tm_hour; /* 0 - 23 */ 120 uint8_t tm_min; /* 0 - 59 */ 121 uint8_t tm_sec; /* 0 - 59 */ 122 uint8_t __pad1; 123 uint32_t tm_nsec; /* 0 - 999,999,999 */ 124 int16_t tm_tz; /* -1440 to 1440 or 2047 */ 125 uint8_t tm_dst; 126 uint8_t __pad2; 127 }; 128 129 struct efi_tmcap { 130 uint32_t tc_res; /* 1e-6 parts per million */ 131 uint32_t tc_prec; /* hertz */ 132 uint8_t tc_stz; /* Set clears sub-second time */ 133 }; 134 135 struct efi_tblhdr { 136 uint64_t th_sig; 137 uint32_t th_rev; 138 uint32_t th_hdrsz; 139 uint32_t th_crc32; 140 uint32_t __res; 141 }; 142 143 struct efi_rt { 144 struct efi_tblhdr rt_hdr; 145 efi_status (*rt_gettime)(struct efi_tm *, struct efi_tmcap *); 146 efi_status (*rt_settime)(struct efi_tm *); 147 efi_status (*rt_getwaketime)(uint8_t *, uint8_t *, 148 struct efi_tm *); 149 efi_status (*rt_setwaketime)(uint8_t, struct efi_tm *); 150 efi_status (*rt_setvirtual)(u_long, u_long, uint32_t, 151 struct efi_md *); 152 efi_status (*rt_cvtptr)(u_long, void **); 153 efi_status (*rt_getvar)(efi_char *, struct uuid *, uint32_t *, 154 u_long *, void *); 155 efi_status (*rt_scanvar)(u_long *, efi_char *, struct uuid *); 156 efi_status (*rt_setvar)(efi_char *, struct uuid *, uint32_t, 157 u_long, void *); 158 efi_status (*rt_gethicnt)(uint32_t *); 159 efi_status (*rt_reset)(enum efi_reset, efi_status, u_long, 160 efi_char *); 161 }; 162 163 typedef uintn efi_tpl; 164 typedef void *efi_event; 165 typedef void (*efi_event_notify)(efi_event, void *); 166 typedef void *efi_handle; 167 typedef struct { 168 uint8_t type; 169 uint8_t subtype; 170 uint8_t ldnegth[2]; 171 } efi_device_path; 172 173 struct efi_bs { 174 struct efi_tblhdr bs_hdr; 175 #define EFI_BS_SIG 0x56524553544f4f42UL 176 efi_tpl (*bs_raisetpl)(efi_tpl); 177 void (*bs_restoretpl)(efi_tpl); 178 efi_status (*bs_allocatepages)(uint32_t, uint32_t, 179 uintn, paddr_t *); 180 efi_status (*bs_freepages)(paddr_t, uintn); 181 efi_status (*bs_getmemorymap)(uintn *, struct efi_md *, 182 uintn *, uintn *, uint32_t *); 183 efi_status (*bs_allocatepool)(uint32_t, uintn, void **); 184 efi_status (*bs_freepool)(void *); 185 efi_status (*bs_createevent)(uint32_t, efi_tpl, efi_event_notify, 186 void *, efi_event *); 187 efi_status (*bs_settimer)(efi_event, uint32_t, uint64_t); 188 efi_status (*bs_waitforevent)(uintn, efi_event *, uintn *); 189 efi_status (*bs_signalevent)(efi_event); 190 efi_status (*bs_closeevent)(efi_event); 191 efi_status (*bs_checkevent)(efi_event); 192 efi_status (*bs_installprotocolinterface)(efi_handle *, 193 struct uuid *, uint32_t, void *); 194 efi_status (*bs_reinstallprotocolinterface)(efi_handle *, 195 struct uuid *, void *, void *); 196 efi_status (*bs_uninstallprotocolinterface)(efi_handle *, 197 struct uuid *, void *); 198 efi_status (*bs_handleprotocol)(efi_handle, 199 struct uuid *, void **); 200 efi_status (*bs_pchandleprotocol)(efi_handle, 201 struct uuid *, void **); 202 efi_status (*bs_registerprotocolnotify)(struct uuid *, efi_event, 203 void **); 204 efi_status (*bs_locatehandle)(uint32_t, struct uuid *, void *, 205 uintn *, efi_handle *); 206 efi_status (*bs_locatedevicepath)(struct uuid *, efi_device_path **, 207 efi_handle *); 208 efi_status (*bs_installconfigurationtable)(struct uuid *, void *); 209 efi_status (*bs_loadimage)(uint8_t, efi_handle, efi_device_path *, 210 void *, uintn, efi_handle *); 211 efi_status (*bs_startimage)(efi_handle, uintn *, efi_char **); 212 efi_status (*bs_exit)(efi_handle, efi_status, uintn, efi_char *); 213 efi_status (*bs_unloadimage)(efi_handle); 214 efi_status (*bs_exitbootservices)(efi_handle, uintn); 215 efi_status (*bs_getnextmonotoniccount)(uint64_t *); 216 efi_status (*bs_stall)(uintn); 217 efi_status (*bs_setwatchdogtimer)(uintn, uint64_t, 218 uintn, efi_char *); 219 efi_status (*bs_connectcontroller)(efi_handle, efi_handle *, 220 efi_device_path *, uint8_t); 221 efi_status (*bs_disconnectcontroller)(efi_handle, efi_handle, 222 efi_handle); 223 efi_status (*bs_openprotocol)(efi_handle, struct uuid *, void **, 224 efi_handle, efi_handle, uint32_t); 225 efi_status (*bs_closeprotocol)(efi_handle, struct uuid *, 226 efi_handle, efi_handle); 227 efi_status (*bs_openprotocolinformation)(efi_handle, efi_handle, 228 uint32_t, uint32_t); 229 efi_status (*bs_protocolsperhandle)(efi_handle, 230 struct uuid ***, uintn *); 231 efi_status (*bs_locatehandlebuffer)(uint32_t, struct uuid *, 232 void *, uintn *, efi_handle **); 233 efi_status (*bs_locateprotocol)(struct uuid *, void *, void **); 234 efi_status (*bs_installmultipleprotocolinterfaces)(efi_handle *, 235 ...); 236 efi_status (*bs_uninstallmultipleprotocolinterfaces)(efi_handle, 237 ...); 238 efi_status (*bs_calculatecrc32)(void *, uintn, uint32_t *); 239 efi_status (*bs_copymem)(void *, void *, uintn); 240 efi_status (*bs_setmem)(void *, uintn, uint8_t); 241 efi_status (*bs_createeventex)(uint32_t, efi_tpl, 242 efi_event_notify, void *, struct uuid, efi_event *); 243 }; 244 245 struct efi_input; 246 247 struct efi_key { 248 uint16_t scancode; 249 efi_char unicodechar; 250 }; 251 252 struct efi_input { 253 efi_status (*ei_reset)(struct efi_input *, uint8_t); 254 efi_status (*ei_readkeystroke)(struct efi_input *, 255 struct efi_key *); 256 void *ei_waitforkey; 257 }; 258 259 typedef struct efi_input efi_input; 260 261 struct efi_text_output_mode { 262 int32_t maxmode; 263 int32_t mode; 264 int32_t attribute; 265 int32_t cursorcolumn; 266 int32_t cursorrow; 267 uint8_t cursorvisible; 268 }; 269 270 271 struct efi_output; 272 273 struct efi_output { 274 efi_status (*ei_reset)(struct efi_output *, uint8_t); 275 efi_status (*ei_outputstring)(struct efi_output *, efi_char *); 276 efi_status (*ei_teststring)(struct efi_output *, efi_char *); 277 efi_status (*ei_textquerymode)(struct efi_output *, 278 uintn, uintn *, uintn *); 279 efi_status (*ei_textsetmode)(struct efi_output *, uintn); 280 efi_status (*ei_setattribute)(struct efi_output *, uintn); 281 efi_status (*ei_clearscreen)(struct efi_output *); 282 efi_status (*ei_setcursorposition)(struct efi_output *, 283 uintn, uintn); 284 efi_status (*ei_enablecursor)(struct efi_output *, uint8_t); 285 struct efi_text_output_mode *ei_mode; 286 }; 287 288 typedef struct efi_output efi_output; 289 290 struct efi_systbl { 291 struct efi_tblhdr st_hdr; 292 #define EFI_SYSTBL_SIG 0x5453595320494249UL 293 efi_char *st_fwvendor; 294 uint32_t st_fwrev; 295 #ifdef __amd64__ 296 uint32_t __pad; 297 #endif 298 efi_handle *st_cin; 299 efi_input *st_cinif; 300 efi_handle *st_cout; 301 efi_output *st_coutif; 302 efi_handle *st_cerr; 303 efi_output *st_cerrif; 304 struct efi_rt *st_rt; 305 struct efi_bs *st_bs; 306 u_long st_entries; 307 struct efi_cfgtbl *st_cfgtbl; 308 }; 309 310 #if defined(__amd64__) 311 struct efi_cfgtbl32 { 312 struct uuid ct_uuid; 313 uint32_t ct_data; /* void * */ 314 }; 315 316 struct efi_systbl32 { 317 struct efi_tblhdr st_hdr; 318 319 uint32_t st_fwvendor; 320 uint32_t st_fwrev; 321 uint32_t st_cin; /* = 0 */ 322 uint32_t st_cinif; /* = 0 */ 323 uint32_t st_cout; /* = 0 */ 324 uint32_t st_coutif; /* = 0 */ 325 uint32_t st_cerr; /* = 0 */ 326 uint32_t st_cerrif; /* = 0 */ 327 uint32_t st_rt; /* struct efi_rt32 * */ 328 uint32_t st_bs; /* = 0 */ 329 uint32_t st_entries; 330 uint32_t st_cfgtbl; /* struct efi_cfgtbl32 * */ 331 }; 332 #elif defined(__i386__) 333 struct efi_cfgtbl64 { 334 struct uuid ct_uuid; 335 uint64_t ct_data; /* void * */ 336 }; 337 338 struct efi_systbl64 { 339 struct efi_tblhdr st_hdr; 340 341 uint64_t st_fwvendor; 342 uint32_t st_fwrev; 343 uint32_t __pad; 344 uint64_t st_cin; /* = 0 */ 345 uint64_t st_cinif; /* = 0 */ 346 uint64_t st_cout; /* = 0 */ 347 uint64_t st_coutif; /* = 0 */ 348 uint64_t st_cerr; /* = 0 */ 349 uint64_t st_cerrif; /* = 0 */ 350 uint64_t st_rt; /* struct efi_rt64 * */ 351 uint64_t st_bs; /* = 0 */ 352 uint64_t st_entries; 353 uint64_t st_cfgtbl; /* struct efi_cfgtbl64 * */ 354 }; 355 #endif 356 357 void efi_init(void); 358 bool efi_probe(void); 359 paddr_t efi_getsystblpa(void); 360 struct efi_systbl *efi_getsystbl(void); 361 paddr_t efi_getcfgtblpa(const struct uuid*); 362 void *efi_getcfgtbl(const struct uuid*); 363 int efi_getbiosmemtype(uint32_t, uint64_t); 364 const char *efi_getmemtype_str(uint32_t); 365 struct btinfo_memmap; 366 struct btinfo_memmap *efi_get_e820memmap(void); 367 368 /* 369 void efi_boot_finish(void); 370 int efi_boot_minimal(uint64_t); 371 void *efi_get_table(struct uuid *); 372 void efi_get_time(struct efi_tm *); 373 struct efi_md *efi_md_first(void); 374 struct efi_md *efi_md_next(struct efi_md *); 375 void efi_reset_system(void); 376 efi_status efi_set_time(struct efi_tm *); 377 */ 378 379 #endif /* _X86_EFI_H_ */ 380
Indexes created Wed Sep 24 05:09:52 GMT 2025