1 /* 2 * Copyright (c) 2000 Doug Rabson 3 * Copyright (c) 2006 Marcel Moolenaar 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 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 AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27 28 #ifndef _LOADER_EFILIB_H 29 #define _LOADER_EFILIB_H 30 31 #include <stand.h> 32 #include <stdbool.h> 33 #include <sys/queue.h> 34 35 extern EFI_HANDLE IH; 36 extern EFI_SYSTEM_TABLE *ST; 37 extern EFI_BOOT_SERVICES *BS; 38 extern EFI_RUNTIME_SERVICES *RS; 39 40 extern struct devsw efipart_fddev; 41 extern struct devsw efipart_cddev; 42 extern struct devsw efipart_hddev; 43 extern struct devsw efinet_dev; 44 extern struct netif_driver efinetif; 45 46 /* EFI block device data, included here to help efi_zfs_probe() */ 47 typedef STAILQ_HEAD(pdinfo_list, pdinfo) pdinfo_list_t; 48 49 typedef struct pdinfo 50 { 51 STAILQ_ENTRY(pdinfo) pd_link; /* link in device list */ 52 pdinfo_list_t pd_part; /* list of partitions */ 53 EFI_HANDLE pd_handle; 54 EFI_HANDLE pd_alias; 55 EFI_DEVICE_PATH *pd_devpath; 56 EFI_BLOCK_IO *pd_blkio; 57 uint32_t pd_unit; /* unit number */ 58 uint32_t pd_open; /* reference counter */ 59 void *pd_bcache; /* buffer cache data */ 60 struct pdinfo *pd_parent; /* Linked items (eg partitions) */ 61 struct devsw *pd_devsw; /* Back pointer to devsw */ 62 } pdinfo_t; 63 64 pdinfo_list_t *efiblk_get_pdinfo_list(struct devsw *dev); 65 pdinfo_t *efiblk_get_pdinfo(struct devdesc *dev); 66 pdinfo_t *efiblk_get_pdinfo_by_handle(EFI_HANDLE h); 67 68 void *efi_get_table(EFI_GUID *tbl); 69 EFI_STATUS OpenProtocolByHandle(EFI_HANDLE, EFI_GUID *, void **); 70 EFI_STATUS efi_get_protocol_handles(EFI_GUID *, uint_t *, EFI_HANDLE **); 71 72 int efi_getdev(void **, const char *, const char **); 73 char *efi_fmtdev(void *); 74 int efi_setcurrdev(struct env_var *, int, const void *); 75 76 int efi_register_handles(struct devsw *, EFI_HANDLE *, EFI_HANDLE *, int); 77 EFI_HANDLE efi_find_handle(struct devsw *, int); 78 int efi_handle_lookup(EFI_HANDLE, struct devsw **, int *, uint64_t *); 79 int efi_handle_update_dev(EFI_HANDLE, struct devsw *, int, uint64_t); 80 81 EFI_DEVICE_PATH *efi_lookup_image_devpath(EFI_HANDLE); 82 EFI_DEVICE_PATH *efi_lookup_devpath(EFI_HANDLE); 83 void efi_close_devpath(EFI_HANDLE); 84 EFI_HANDLE efi_devpath_handle(EFI_DEVICE_PATH *); 85 EFI_DEVICE_PATH *efi_devpath_last_node(EFI_DEVICE_PATH *); 86 EFI_DEVICE_PATH *efi_devpath_trim(EFI_DEVICE_PATH *); 87 EFI_DEVICE_PATH *efi_devpath_next_instance(EFI_DEVICE_PATH *); 88 bool efi_devpath_match(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *); 89 bool efi_devpath_is_prefix(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *); 90 CHAR16 *efi_devpath_name(EFI_DEVICE_PATH *); 91 void efi_free_devpath_name(CHAR16 *); 92 93 int efi_status_to_errno(EFI_STATUS); 94 EFI_STATUS errno_to_efi_status(int errno); 95 96 void efi_time_init(void); 97 void efi_time_fini(void); 98 99 EFI_STATUS efi_main(EFI_HANDLE Ximage, EFI_SYSTEM_TABLE* Xsystab); 100 101 EFI_STATUS main(int argc, CHAR16 *argv[]); 102 void efi_exit(EFI_STATUS status) __dead2; 103 void delay(int usecs); 104 105 /* EFI environment initialization. */ 106 void efi_init_environment(void); 107 108 /* EFI Memory type strings. */ 109 const char *efi_memory_type(EFI_MEMORY_TYPE); 110 111 /* CHAR16 utility functions. */ 112 int wcscmp(CHAR16 *, CHAR16 *); 113 void cpy8to16(const char *, CHAR16 *, size_t); 114 void cpy16to8(const CHAR16 *, char *, size_t); 115 116 /* 117 * Routines for interacting with EFI's env vars in a more unix-like 118 * way than the standard APIs. In addition, convenience routines for 119 * the loader setting / getting illumos specific variables. 120 */ 121 122 EFI_STATUS efi_illumos_getenv(const char *v, void *data, size_t *len); 123 EFI_STATUS efi_getenv(EFI_GUID *g, const char *v, void *data, size_t *len); 124 EFI_STATUS efi_setenv(EFI_GUID *g, uint32_t, const char *, void *, size_t); 125 EFI_STATUS efi_global_getenv(const char *v, void *data, size_t *len); 126 EFI_STATUS efi_global_setenv(const char *v, void *data, size_t len); 127 EFI_STATUS efi_setenv_illumos_wcs(const char *varname, CHAR16 *valstr); 128 129 /* guids and names */ 130 bool efi_guid_to_str(const EFI_GUID *, char **); 131 bool efi_str_to_guid(const char *, EFI_GUID *); 132 bool efi_name_to_guid(const char *, EFI_GUID *); 133 bool efi_guid_to_name(EFI_GUID *, char **); 134 135 /* efipart.c */ 136 int efipart_inithandles(void); 137 138 #endif /* _LOADER_EFILIB_H */ 139