include/grub/efi/efi.h

   1 /* efi.h - declare variables and functions for EFI support */
   2 /*
   3  *  GRUB  --  GRand Unified Bootloader
   4  *  Copyright (C) 2006,2007,2008,2009  Free Software Foundation, Inc.
   5  *
   6  *  GRUB is free software: you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation, either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  GRUB is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef GRUB_EFI_EFI_HEADER
  21 #define GRUB_EFI_EFI_HEADER     1
  22
  23 #include <grub/types.h>
  24 #include <grub/dl.h>
  25 #include <grub/efi/api.h>
  26
  27 /* Functions.  */
  28 void *EXPORT_FUNC(grub_efi_locate_protocol) (grub_efi_guid_t *protocol,
  29                                              void *registration);
  30 grub_efi_handle_t *
  31 EXPORT_FUNC(grub_efi_locate_handle) (grub_efi_locate_search_type_t search_type,
  32                                      grub_efi_guid_t *protocol,
  33                                      void *search_key,
  34                                      grub_efi_uintn_t *num_handles);
  35 void *EXPORT_FUNC(grub_efi_open_protocol) (grub_efi_handle_t handle,
  36                                            grub_efi_guid_t *protocol,
  37                                            grub_efi_uint32_t attributes);
  38 int EXPORT_FUNC(grub_efi_set_text_mode) (int on);
  39 void EXPORT_FUNC(grub_efi_stall) (grub_efi_uintn_t microseconds);
  40 void *
  41 EXPORT_FUNC(grub_efi_allocate_pages) (grub_efi_physical_address_t address,
  42                                       grub_efi_uintn_t pages);
  43 void EXPORT_FUNC(grub_efi_free_pages) (grub_efi_physical_address_t address,
  44                                        grub_efi_uintn_t pages);
  45 int
  46 EXPORT_FUNC(grub_efi_get_memory_map) (grub_efi_uintn_t *memory_map_size,
  47                                       grub_efi_memory_descriptor_t *memory_map,
  48                                       grub_efi_uintn_t *map_key,
  49                                       grub_efi_uintn_t *descriptor_size,
  50                                       grub_efi_uint32_t *descriptor_version);
  51 grub_efi_loaded_image_t *EXPORT_FUNC(grub_efi_get_loaded_image) (grub_efi_handle_t image_handle);
  52 void EXPORT_FUNC(grub_efi_print_device_path) (grub_efi_device_path_t *dp);
  53 char *EXPORT_FUNC(grub_efi_get_filename) (grub_efi_device_path_t *dp);
  54 grub_efi_device_path_t *
  55 EXPORT_FUNC(grub_efi_get_device_path) (grub_efi_handle_t handle);
  56 grub_efi_device_path_t *
  57 EXPORT_FUNC(grub_efi_find_last_device_path) (const grub_efi_device_path_t *dp);
  58 grub_efi_device_path_t *
  59 EXPORT_FUNC(grub_efi_duplicate_device_path) (const grub_efi_device_path_t *dp);
  60 grub_err_t EXPORT_FUNC (grub_efi_finish_boot_services) (grub_efi_uintn_t *outbuf_size, void *outbuf,
  61                                                         grub_efi_uintn_t *map_key,
  62                                                         grub_efi_uintn_t *efi_desc_size,
  63                                                         grub_efi_uint32_t *efi_desc_version);
  64 grub_err_t EXPORT_FUNC (grub_efi_set_virtual_address_map) (grub_efi_uintn_t memory_map_size,
  65                                                            grub_efi_uintn_t descriptor_size,
  66                                                            grub_efi_uint32_t descriptor_version,
  67                                                            grub_efi_memory_descriptor_t *virtual_map);
  68 void *EXPORT_FUNC (grub_efi_get_variable) (const char *variable,
  69                                            const grub_efi_guid_t *guid,
  70                                            grub_size_t *datasize_out);
  71 grub_err_t
  72 EXPORT_FUNC (grub_efi_set_variable) (const char *var,
  73                                      const grub_efi_guid_t *guid,
  74                                      void *data,
  75                                      grub_size_t datasize);
  76 int
  77 EXPORT_FUNC (grub_efi_compare_device_paths) (const grub_efi_device_path_t *dp1,
  78                                              const grub_efi_device_path_t *dp2);
  79
  80 extern void (*EXPORT_VAR(grub_efi_net_config)) (grub_efi_handle_t hnd,
  81                                                 char **device,
  82                                                 char **path);
  83
  84 #if defined(__arm__) || defined(__aarch64__)
  85 void *EXPORT_FUNC(grub_efi_get_firmware_fdt)(void);
  86 #endif
  87
  88 grub_addr_t grub_efi_modules_addr (void);
  89
  90 void grub_efi_mm_init (void);
  91 void grub_efi_mm_fini (void);
  92 void grub_efi_init (void);
  93 void grub_efi_fini (void);
  94 void grub_efi_set_prefix (void);
  95
  96 /* Variables.  */
  97 extern grub_efi_system_table_t *EXPORT_VAR(grub_efi_system_table);
  98 extern grub_efi_handle_t EXPORT_VAR(grub_efi_image_handle);
  99
 100 extern int EXPORT_VAR(grub_efi_is_finished);
 101
 102 struct grub_net_card;
 103
 104 grub_efi_handle_t
 105 grub_efinet_get_device_handle (struct grub_net_card *card);
 106
 107 #endif /* ! GRUB_EFI_EFI_HEADER */