sys/sys/efi.h

   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 #include <machine/efi.h>
  34
  35 #define EFI_PAGE_SHIFT          12
  36 #define EFI_PAGE_SIZE           (1 << EFI_PAGE_SHIFT)
  37 #define EFI_PAGE_MASK           (EFI_PAGE_SIZE - 1)
  38
  39 #define EFI_TABLE_SMBIOS                                \
  40         {0xeb9d2d31,0x2d88,0x11d3,0x9a,0x16,{0x00,0x90,0x27,0x3f,0xc1,0x4d}}
  41 #define EFI_TABLE_SMBIOS3                               \
  42         {0xf2fd1544,0x9794,0x4a2c,0x99,0x2e,{0xe5,0xbb,0xcf,0x20,0xe3,0x94}}
  43 #define EFI_TABLE_ESRT                                  \
  44         {0xb122a263,0x3661,0x4f68,0x99,0x29,{0x78,0xf8,0xb0,0xd6,0x21,0x80}}
  45 #define EFI_PROPERTIES_TABLE                    \
  46         {0x880aaca3,0x4adc,0x4a04,0x90,0x79,{0xb7,0x47,0x34,0x08,0x25,0xe5}}
  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 struct efirt_callinfo;
 205
 206 /* Internal MD EFI functions */
 207 int efi_arch_enter(void);
 208 void efi_arch_leave(void);
 209 vm_offset_t efi_phys_to_kva(vm_paddr_t);
 210 int efi_rt_arch_call(struct efirt_callinfo *);
 211 bool efi_create_1t1_map(struct efi_md *, int, int);
 212 void efi_destroy_1t1_map(void);
 213
 214 struct efi_ops {
 215         /*
 216          * The EFI calls might be virtualized in some environments, requiring
 217          * FreeBSD to use a different interface (ie: hypercalls) in order to
 218          * access them.
 219          */
 220         int     (*rt_ok)(void);
 221         int     (*get_table)(struct uuid *, void **);
 222         int     (*copy_table)(struct uuid *, void **, size_t, size_t *);
 223         int     (*get_time)(struct efi_tm *);
 224         int     (*get_time_capabilities)(struct efi_tmcap *);
 225         int     (*reset_system)(enum efi_reset);
 226         int     (*set_time)(struct efi_tm *);
 227         int     (*var_get)(uint16_t *, struct uuid *, uint32_t *, size_t *,
 228     void *);
 229         int     (*var_nextname)(size_t *, uint16_t *, struct uuid *);
 230         int     (*var_set)(uint16_t *, struct uuid *, uint32_t, size_t, void *);
 231 };
 232 extern const struct efi_ops *active_efi_ops;
 233
 234 /* Public MI EFI functions */
 235 static inline int efi_rt_ok(void)
 236 {
 237
 238         if (active_efi_ops->rt_ok == NULL)
 239                 return (ENXIO);
 240         return (active_efi_ops->rt_ok());
 241 }
 242
 243 static inline int efi_get_table(struct uuid *uuid, void **ptr)
 244 {
 245
 246         if (active_efi_ops->get_table == NULL)
 247                 return (ENXIO);
 248         return (active_efi_ops->get_table(uuid, ptr));
 249 }
 250
 251 static inline int efi_copy_table(struct uuid *uuid, void **buf,
 252     size_t buf_len, size_t *table_len)
 253 {
 254
 255         if (active_efi_ops->copy_table == NULL)
 256                 return (ENXIO);
 257         return (active_efi_ops->copy_table(uuid, buf, buf_len, table_len));
 258 }
 259
 260 static inline int efi_get_time(struct efi_tm *tm)
 261 {
 262
 263         if (active_efi_ops->get_time == NULL)
 264                 return (ENXIO);
 265         return (active_efi_ops->get_time(tm));
 266 }
 267
 268 static inline int efi_get_time_capabilities(struct efi_tmcap *tmcap)
 269 {
 270
 271         if (active_efi_ops->get_time_capabilities == NULL)
 272                 return (ENXIO);
 273         return (active_efi_ops->get_time_capabilities(tmcap));
 274 }
 275
 276 static inline int efi_reset_system(enum efi_reset type)
 277 {
 278
 279         if (active_efi_ops->reset_system == NULL)
 280                 return (ENXIO);
 281         return (active_efi_ops->reset_system(type));
 282 }
 283
 284 static inline int efi_set_time(struct efi_tm *tm)
 285 {
 286
 287         if (active_efi_ops->set_time == NULL)
 288                 return (ENXIO);
 289         return (active_efi_ops->set_time(tm));
 290 }
 291
 292 static inline int efi_var_get(uint16_t *name, struct uuid *vendor,
 293     uint32_t *attrib, size_t *datasize, void *data)
 294 {
 295
 296         if (active_efi_ops->var_get == NULL)
 297                 return (ENXIO);
 298         return (active_efi_ops->var_get(name, vendor, attrib, datasize, data));
 299 }
 300
 301 static inline int efi_var_nextname(size_t *namesize, uint16_t *name,
 302     struct uuid *vendor)
 303 {
 304
 305         if (active_efi_ops->var_nextname == NULL)
 306                 return (ENXIO);
 307         return (active_efi_ops->var_nextname(namesize, name, vendor));
 308 }
 309
 310 static inline int efi_var_set(uint16_t *name, struct uuid *vendor,
 311     uint32_t attrib, size_t datasize, void *data)
 312 {
 313
 314         if (active_efi_ops->var_set == NULL)
 315                 return (ENXIO);
 316         return (active_efi_ops->var_set(name, vendor, attrib, datasize, data));
 317 }
 318
 319 int efi_status_to_errno(efi_status status);
 320
 321 #endif  /* _KERNEL */
 322
 323 #endif /* _SYS_EFI_H_ */