src/shared/efivars.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #if ! ENABLE_EFI
   5 #include <errno.h>
   6 #endif
   7 #include <stdbool.h>
   8 #include <stddef.h>
   9 #include <stdint.h>
  10
  11 #include "sd-id128.h"
  12
  13 #include "time-util.h"
  14
  15 #define EFI_VENDOR_LOADER SD_ID128_MAKE(4a,67,b0,82,0a,4c,41,cf,b6,c7,44,0b,29,bb,8c,4f)
  16 #define EFI_VENDOR_GLOBAL SD_ID128_MAKE(8b,e4,df,61,93,ca,11,d2,aa,0d,00,e0,98,03,2b,8c)
  17 #define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
  18 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
  19 #define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
  20
  21 #define EFI_LOADER_FEATURE_CONFIG_TIMEOUT          (UINT64_C(1) << 0)
  22 #define EFI_LOADER_FEATURE_CONFIG_TIMEOUT_ONE_SHOT (UINT64_C(1) << 1)
  23 #define EFI_LOADER_FEATURE_ENTRY_DEFAULT           (UINT64_C(1) << 2)
  24 #define EFI_LOADER_FEATURE_ENTRY_ONESHOT           (UINT64_C(1) << 3)
  25 #define EFI_LOADER_FEATURE_BOOT_COUNTING           (UINT64_C(1) << 4)
  26
  27 #if ENABLE_EFI
  28
  29 bool is_efi_boot(void);
  30 bool is_efi_secure_boot(void);
  31 bool is_efi_secure_boot_setup_mode(void);
  32 int efi_reboot_to_firmware_supported(void);
  33 int efi_get_reboot_to_firmware(void);
  34 int efi_set_reboot_to_firmware(bool value);
  35
  36 int efi_get_variable(sd_id128_t vendor, const char *name, uint32_t *attribute, void **value, size_t *size);
  37 int efi_get_variable_string(sd_id128_t vendor, const char *name, char **p);
  38 int efi_set_variable(sd_id128_t vendor, const char *name, const void *value, size_t size);
  39 int efi_set_variable_string(sd_id128_t vendor, const char *name, const char *p);
  40
  41 int efi_get_boot_option(uint16_t nr, char **title, sd_id128_t *part_uuid, char **path, bool *active);
  42 int efi_add_boot_option(uint16_t id, const char *title, uint32_t part, uint64_t pstart, uint64_t psize, sd_id128_t part_uuid, const char *path);
  43 int efi_remove_boot_option(uint16_t id);
  44 int efi_get_boot_order(uint16_t **order);
  45 int efi_set_boot_order(uint16_t *order, size_t n);
  46 int efi_get_boot_options(uint16_t **options);
  47
  48 int efi_loader_get_device_part_uuid(sd_id128_t *u);
  49 int efi_loader_get_boot_usec(usec_t *firmware, usec_t *loader);
  50
  51 int efi_loader_get_entries(char ***ret);
  52
  53 int efi_loader_get_features(uint64_t *ret);
  54
  55 #else
  56
  57 static inline bool is_efi_boot(void) {
  58         return false;
  59 }
  60
  61 static inline bool is_efi_secure_boot(void) {
  62         return false;
  63 }
  64
  65 static inline bool is_efi_secure_boot_setup_mode(void) {
  66         return false;
  67 }
  68
  69 static inline int efi_reboot_to_firmware_supported(void) {
  70         return -EOPNOTSUPP;
  71 }
  72
  73 static inline int efi_get_reboot_to_firmware(void) {
  74         return -EOPNOTSUPP;
  75 }
  76
  77 static inline int efi_set_reboot_to_firmware(bool value) {
  78         return -EOPNOTSUPP;
  79 }
  80
  81 static inline int efi_get_variable(sd_id128_t vendor, const char *name, uint32_t *attribute, void **value, size_t *size) {
  82         return -EOPNOTSUPP;
  83 }
  84
  85 static inline int efi_get_variable_string(sd_id128_t vendor, const char *name, char **p) {
  86         return -EOPNOTSUPP;
  87 }
  88
  89 static inline int efi_set_variable(sd_id128_t vendor, const char *name, const void *value, size_t size) {
  90         return -EOPNOTSUPP;
  91 }
  92
  93 static inline int efi_set_variable_string(sd_id128_t vendor, const char *name, const char *p) {
  94         return -EOPNOTSUPP;
  95 }
  96
  97 static inline int efi_get_boot_option(uint16_t nr, char **title, sd_id128_t *part_uuid, char **path, bool *active) {
  98         return -EOPNOTSUPP;
  99 }
 100
 101 static inline int efi_add_boot_option(uint16_t id, const char *title, uint32_t part, uint64_t pstart, uint64_t psize, sd_id128_t part_uuid, const char *path) {
 102         return -EOPNOTSUPP;
 103 }
 104
 105 static inline int efi_remove_boot_option(uint16_t id) {
 106         return -EOPNOTSUPP;
 107 }
 108
 109 static inline int efi_get_boot_order(uint16_t **order) {
 110         return -EOPNOTSUPP;
 111 }
 112
 113 static inline int efi_set_boot_order(uint16_t *order, size_t n) {
 114         return -EOPNOTSUPP;
 115 }
 116
 117 static inline int efi_get_boot_options(uint16_t **options) {
 118         return -EOPNOTSUPP;
 119 }
 120
 121 static inline int efi_loader_get_device_part_uuid(sd_id128_t *u) {
 122         return -EOPNOTSUPP;
 123 }
 124
 125 static inline int efi_loader_get_boot_usec(usec_t *firmware, usec_t *loader) {
 126         return -EOPNOTSUPP;
 127 }
 128
 129 static inline int efi_loader_get_entries(char ***ret) {
 130         return -EOPNOTSUPP;
 131 }
 132
 133 static inline int efi_loader_get_features(uint64_t *ret) {
 134         return -EOPNOTSUPP;
 135 }
 136
 137 #endif
 138
 139 bool efi_loader_entry_name_valid(const char *s);
 140
 141 char *efi_tilt_backslashes(char *s);