stand/efi/include/efilib.h

   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  * $FreeBSD$
  28  */
  29
  30 #ifndef _LOADER_EFILIB_H
  31 #define _LOADER_EFILIB_H
  32
  33 #include <stand.h>
  34 #include <stdbool.h>
  35 #include <sys/queue.h>
  36
  37 extern EFI_HANDLE               IH;
  38 extern EFI_SYSTEM_TABLE         *ST;
  39 extern EFI_BOOT_SERVICES        *BS;
  40 extern EFI_RUNTIME_SERVICES     *RS;
  41
  42 extern struct devsw efipart_fddev;
  43 extern struct devsw efipart_cddev;
  44 extern struct devsw efipart_hddev;
  45 extern struct devsw efinet_dev;
  46 extern struct netif_driver efinetif;
  47
  48 /* EFI block device data, included here to help efi_zfs_probe() */
  49 typedef STAILQ_HEAD(pdinfo_list, pdinfo) pdinfo_list_t;
  50
  51 typedef struct pdinfo
  52 {
  53         STAILQ_ENTRY(pdinfo)    pd_link;        /* link in device list */
  54         pdinfo_list_t           pd_part;        /* list of partitions */
  55         EFI_HANDLE              pd_handle;
  56         EFI_HANDLE              pd_alias;
  57         EFI_DEVICE_PATH         *pd_devpath;
  58         EFI_BLOCK_IO            *pd_blkio;
  59         uint32_t                pd_unit;        /* unit number */
  60         uint32_t                pd_open;        /* reference counter */
  61         void                    *pd_bcache;     /* buffer cache data */
  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
  67 void *efi_get_table(EFI_GUID *tbl);
  68
  69 int efi_getdev(void **vdev, const char *devspec, const char **path);
  70 char *efi_fmtdev(void *vdev);
  71 int efi_setcurrdev(struct env_var *ev, int flags, const void *value);
  72
  73
  74 int efi_register_handles(struct devsw *, EFI_HANDLE *, EFI_HANDLE *, int);
  75 EFI_HANDLE efi_find_handle(struct devsw *, int);
  76 int efi_handle_lookup(EFI_HANDLE, struct devsw **, int *,  uint64_t *);
  77 int efi_handle_update_dev(EFI_HANDLE, struct devsw *, int, uint64_t);
  78
  79 EFI_DEVICE_PATH *efi_lookup_image_devpath(EFI_HANDLE);
  80 EFI_DEVICE_PATH *efi_lookup_devpath(EFI_HANDLE);
  81 EFI_HANDLE efi_devpath_handle(EFI_DEVICE_PATH *);
  82 EFI_DEVICE_PATH *efi_devpath_last_node(EFI_DEVICE_PATH *);
  83 EFI_DEVICE_PATH *efi_devpath_trim(EFI_DEVICE_PATH *);
  84 bool efi_devpath_match(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *);
  85 bool efi_devpath_is_prefix(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *);
  86 CHAR16 *efi_devpath_name(EFI_DEVICE_PATH *);
  87 void efi_free_devpath_name(CHAR16 *);
  88
  89 int efi_status_to_errno(EFI_STATUS);
  90 EFI_STATUS errno_to_efi_status(int errno);
  91
  92 void efi_time_init(void);
  93 void efi_time_fini(void);
  94
  95 EFI_STATUS efi_main(EFI_HANDLE Ximage, EFI_SYSTEM_TABLE* Xsystab);
  96
  97 EFI_STATUS main(int argc, CHAR16 *argv[]);
  98 void efi_exit(EFI_STATUS status) __dead2;
  99 void delay(int usecs);
 100
 101 /* EFI environment initialization. */
 102 void efi_init_environment(void);
 103
 104 /* CHAR16 utility functions. */
 105 int wcscmp(CHAR16 *, CHAR16 *);
 106 void cpy8to16(const char *, CHAR16 *, size_t);
 107 void cpy16to8(const CHAR16 *, char *, size_t);
 108
 109 #endif  /* _LOADER_EFILIB_H */