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 #include <Protocol/BlockIo.h> 35 #include <Protocol/LoadedImage.h> 36 #include <Protocol/SerialIo.h> 37 #include <Protocol/IsaIo.h> 38 39 extern EFI_HANDLE IH; 40 extern EFI_SYSTEM_TABLE *ST; 41 extern EFI_BOOT_SERVICES *BS; 42 extern EFI_RUNTIME_SERVICES *RS; 43 extern EFI_LOADED_IMAGE_PROTOCOL *boot_img; 44 45 extern struct devsw efipart_fddev; 46 extern struct devsw efipart_cddev; 47 extern struct devsw efipart_hddev; 48 extern struct devsw efinet_dev; 49 extern struct netif_driver efinetif; 50 51 /* 52 * Serial port descriptor. 53 */ 54 typedef STAILQ_HEAD(serial_list, serial) serial_list_t; 55 56 struct serial { 57 STAILQ_ENTRY(serial) next; 58 uint64_t baudrate; 59 uint32_t timeout; 60 uint32_t receivefifodepth; 61 uint32_t databits; 62 EFI_PARITY_TYPE parity; 63 EFI_STOP_BITS_TYPE stopbits; 64 bool ignore_cd; 65 bool rtsdtr_off; 66 bool is_efi_console; /* EFI Console device */ 67 EFI_HANDLE currdev; /* current serial device */ 68 EFI_HANDLE iodev; /* handle to IO layer */ 69 EFI_GUID *guid; /* Driver protocol guid */ 70 union { 71 EFI_SERIAL_IO_PROTOCOL *sio; 72 EFI_ISA_IO_PROTOCOL *isa; 73 } io; 74 uint32_t ioaddr; 75 char name; /* 'a'-'d' or '0'-'9' */ 76 }; 77 78 extern serial_list_t serials; /* In efiserialio.c */ 79 80 /* EFI block device data, included here to help efi_zfs_probe() */ 81 typedef STAILQ_HEAD(pdinfo_list, pdinfo) pdinfo_list_t; 82 83 typedef struct pdinfo 84 { 85 STAILQ_ENTRY(pdinfo) pd_link; /* link in device list */ 86 pdinfo_list_t pd_part; /* list of partitions */ 87 EFI_HANDLE pd_handle; 88 EFI_HANDLE pd_alias; 89 EFI_DEVICE_PATH *pd_devpath; 90 EFI_BLOCK_IO *pd_blkio; 91 uint32_t pd_unit; /* unit number */ 92 uint32_t pd_open; /* reference counter */ 93 void *pd_bcache; /* buffer cache data */ 94 struct pdinfo *pd_parent; /* Linked items (eg partitions) */ 95 struct devsw *pd_devsw; /* Back pointer to devsw */ 96 } pdinfo_t; 97 98 pdinfo_list_t *efiblk_get_pdinfo_list(struct devsw *dev); 99 pdinfo_t *efiblk_get_pdinfo(struct devdesc *dev); 100 pdinfo_t *efiblk_get_pdinfo_by_handle(EFI_HANDLE h); 101 102 void *efi_get_table(EFI_GUID *tbl); 103 EFI_STATUS OpenProtocolByHandle(EFI_HANDLE, EFI_GUID *, void **); 104 EFI_STATUS efi_get_protocol_handles(EFI_GUID *, uint_t *, EFI_HANDLE **); 105 106 int efi_getdev(void **, const char *, const char **); 107 char *efi_fmtdev(void *); 108 int efi_setcurrdev(struct env_var *, int, const void *); 109 110 int efi_register_handles(struct devsw *, EFI_HANDLE *, EFI_HANDLE *, int); 111 EFI_HANDLE efi_find_handle(struct devsw *, int); 112 int efi_handle_lookup(EFI_HANDLE, struct devsw **, int *, uint64_t *); 113 int efi_handle_update_dev(EFI_HANDLE, struct devsw *, int, uint64_t); 114 115 EFI_DEVICE_PATH *efi_lookup_image_devpath(EFI_HANDLE); 116 EFI_DEVICE_PATH *efi_lookup_devpath(EFI_HANDLE); 117 void efi_close_devpath(EFI_HANDLE); 118 EFI_HANDLE efi_devpath_handle(EFI_DEVICE_PATH *); 119 EFI_DEVICE_PATH *efi_devpath_last_node(EFI_DEVICE_PATH *); 120 EFI_DEVICE_PATH *efi_devpath_trim(EFI_DEVICE_PATH *); 121 EFI_DEVICE_PATH *efi_devpath_next_instance(EFI_DEVICE_PATH *); 122 bool efi_devpath_match(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *); 123 bool efi_devpath_is_prefix(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *); 124 CHAR16 *efi_devpath_name(EFI_DEVICE_PATH *); 125 void efi_free_devpath_name(CHAR16 *); 126 127 int efi_status_to_errno(EFI_STATUS); 128 EFI_STATUS errno_to_efi_status(int errno); 129 130 void acpi_detect(void); 131 void *acpi_find_table(const char *); 132 133 void efi_time_init(void); 134 void efi_time_fini(void); 135 136 void efi_serial_ini(void); 137 void efi_isa_ini(void); 138 139 EFI_STATUS efi_main(EFI_HANDLE Ximage, EFI_SYSTEM_TABLE* Xsystab); 140 141 EFI_STATUS main(int argc, CHAR16 *argv[]); 142 void efi_exit(EFI_STATUS status) __dead2; 143 void delay(int usecs); 144 145 /* EFI environment initialization. */ 146 void efi_init_environment(void); 147 148 /* EFI Memory type strings. */ 149 const char *efi_memory_type(EFI_MEMORY_TYPE); 150 151 /* CHAR16 utility functions. */ 152 int wcscmp(CHAR16 *, CHAR16 *); 153 void cpy8to16(const char *, CHAR16 *, size_t); 154 void cpy16to8(const CHAR16 *, char *, size_t); 155 156 /* 157 * Routines for interacting with EFI's env vars in a more unix-like 158 * way than the standard APIs. In addition, convenience routines for 159 * the loader setting / getting illumos specific variables. 160 */ 161 162 EFI_STATUS efi_illumos_getenv(const char *v, void *data, size_t *len); 163 EFI_STATUS efi_getenv(EFI_GUID *g, const char *v, void *data, size_t *len); 164 EFI_STATUS efi_setenv(EFI_GUID *g, uint32_t, const char *, void *, size_t); 165 EFI_STATUS efi_global_getenv(const char *v, void *data, size_t *len); 166 EFI_STATUS efi_global_setenv(const char *v, void *data, size_t len); 167 EFI_STATUS efi_setenv_illumos_wcs(const char *varname, CHAR16 *valstr); 168 169 /* guids and names */ 170 bool efi_guid_to_str(const EFI_GUID *, char **); 171 bool efi_str_to_guid(const char *, EFI_GUID *); 172 bool efi_name_to_guid(const char *, EFI_GUID *); 173 bool efi_guid_to_name(EFI_GUID *, char **); 174 175 /* efipart.c */ 176 int efipart_inithandles(void); 177 178 #endif /* _LOADER_EFILIB_H */ 179