efi.h revision 1.1
1 /* $NetBSD: efi.h,v 1.1 2022/08/20 10:55:28 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 29 #ifndef _DEV_EFI_EFI_H_ 30 #define _DEV_EFI_EFI_H_ 31 32 /* 33 * Machine-independent UEFI protocol definitions. Based on: 34 * 35 * Unified Extensible Firmware Interface (UEFI) Specification, 36 * Version 2.9, UEFI Forum, Inc., March 2021. 37 * 38 * https://uefi.org/sites/default/files/resources/UEFI_Spec_2_9_2021_03_18.pdf 39 */ 40 41 enum efi_reset { 42 EFI_RESET_COLD, 43 EFI_RESET_WARM, 44 EFI_RESET_SHUTDOWN, 45 EFI_RESET_PLATFORM_SPECIFIC, 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 void *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 #define EFI_MD_TYPE_PMEM 14 /* Persistent memory. */ 73 uint32_t __pad; 74 uint64_t md_phys; 75 uint64_t md_virt; 76 uint64_t md_pages; 77 uint64_t md_attr; 78 #define EFI_MD_ATTR_UC 0x0000000000000001UL 79 #define EFI_MD_ATTR_WC 0x0000000000000002UL 80 #define EFI_MD_ATTR_WT 0x0000000000000004UL 81 #define EFI_MD_ATTR_WB 0x0000000000000008UL 82 #define EFI_MD_ATTR_UCE 0x0000000000000010UL 83 #define EFI_MD_ATTR_WP 0x0000000000001000UL 84 #define EFI_MD_ATTR_RP 0x0000000000002000UL 85 #define EFI_MD_ATTR_XP 0x0000000000004000UL 86 #define EFI_MD_ATTR_NV 0x0000000000008000UL 87 #define EFI_MD_ATTR_MORE_RELIABLE 0x0000000000010000UL 88 #define EFI_MD_ATTR_RO 0x0000000000020000UL 89 #define EFI_MD_ATTR_SP 0x0000000000040000UL 90 #define EFI_MD_ATTR_CPU_CRYPTO 0x0000000000080000UL 91 #define EFI_MD_ATTR_RT 0x8000000000000000UL 92 }; 93 94 struct efi_tm { 95 uint16_t tm_year; /* 1998 - 20XX */ 96 uint8_t tm_mon; /* 1 - 12 */ 97 uint8_t tm_mday; /* 1 - 31 */ 98 uint8_t tm_hour; /* 0 - 23 */ 99 uint8_t tm_min; /* 0 - 59 */ 100 uint8_t tm_sec; /* 0 - 59 */ 101 uint8_t __pad1; 102 uint32_t tm_nsec; /* 0 - 999,999,999 */ 103 int16_t tm_tz; /* -1440 to 1440 or 2047 */ 104 uint8_t tm_dst; 105 uint8_t __pad2; 106 }; 107 108 struct efi_tmcap { 109 uint32_t tc_res; /* 1e-6 parts per million */ 110 uint32_t tc_prec; /* hertz */ 111 uint8_t tc_stz; /* Set clears sub-second time */ 112 }; 113 114 struct efi_tblhdr { 115 uint64_t th_sig; 116 uint32_t th_rev; 117 uint32_t th_hdrsz; 118 uint32_t th_crc32; 119 uint32_t __res; 120 }; 121 122 struct efi_rt { 123 struct efi_tblhdr rt_hdr; 124 efi_status (*rt_gettime)(struct efi_tm *, struct efi_tmcap *); 125 efi_status (*rt_settime)(struct efi_tm *); 126 efi_status (*rt_getwaketime)(uint8_t *, uint8_t *, 127 struct efi_tm *); 128 efi_status (*rt_setwaketime)(uint8_t, struct efi_tm *); 129 efi_status (*rt_setvirtual)(u_long, u_long, uint32_t, 130 struct efi_md *); 131 efi_status (*rt_cvtptr)(u_long, void **); 132 efi_status (*rt_getvar)(efi_char *, struct uuid *, uint32_t *, 133 u_long *, void *); 134 efi_status (*rt_scanvar)(u_long *, efi_char *, struct uuid *); 135 efi_status (*rt_setvar)(efi_char *, struct uuid *, uint32_t, 136 u_long, void *); 137 efi_status (*rt_gethicnt)(uint32_t *); 138 efi_status (*rt_reset)(enum efi_reset, efi_status, u_long, 139 efi_char *); 140 }; 141 142 struct efi_systbl { 143 struct efi_tblhdr st_hdr; 144 #define EFI_SYSTBL_SIG 0x5453595320494249UL 145 efi_char *st_fwvendor; 146 uint32_t st_fwrev; 147 #ifdef _LP64 148 uint32_t __pad; 149 #endif 150 void *st_cin; 151 void *st_cinif; 152 void *st_cout; 153 void *st_coutif; 154 void *st_cerr; 155 void *st_cerrif; 156 struct efi_rt *st_rt; 157 void *st_bs; 158 u_long st_entries; 159 struct efi_cfgtbl *st_cfgtbl; 160 }; 161 #ifdef _LP64 162 __CTASSERT(sizeof(struct efi_systbl) == 120); 163 #else 164 __CTASSERT(sizeof(struct efi_systbl) == 72); 165 #endif 166 167 #endif /* _DEV_EFI_EFI_H_ */ 168
Indexes created Wed Sep 24 05:09:52 GMT 2025