sys/boot/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 <sys/queue.h>
  35
  36 extern EFI_HANDLE               IH;
  37 extern EFI_SYSTEM_TABLE         *ST;
  38 extern EFI_BOOT_SERVICES        *BS;
  39 extern EFI_RUNTIME_SERVICES     *RS;
  40
  41 extern struct devsw efipart_fddev;
  42 extern struct devsw efipart_cddev;
  43 extern struct devsw efipart_hddev;
  44 extern struct devsw efinet_dev;
  45 extern struct netif_driver efinetif;
  46
  47 /* EFI block device data, included here to help efi_zfs_probe() */
  48 typedef STAILQ_HEAD(pdinfo_list, pdinfo) pdinfo_list_t;
  49
  50 typedef struct pdinfo
  51 {
  52         STAILQ_ENTRY(pdinfo)    pd_link;        /* link in device list */
  53         pdinfo_list_t           pd_part;        /* link of partitions */
  54         EFI_HANDLE              pd_handle;
  55         EFI_HANDLE              pd_alias;
  56         EFI_DEVICE_PATH         *pd_devpath;
  57         EFI_BLOCK_IO            *pd_blkio;
  58         int                     pd_unit;        /* unit number */
  59         int                     pd_open;        /* reference counter */
  60         void                    *pd_bcache;     /* buffer cache data */
  61 } pdinfo_t;
  62
  63 pdinfo_list_t *efiblk_get_pdinfo_list(struct devsw *dev);
  64
  65 void *efi_get_table(EFI_GUID *tbl);
  66
  67 int efi_register_handles(struct devsw *, EFI_HANDLE *, EFI_HANDLE *, int);
  68 EFI_HANDLE efi_find_handle(struct devsw *, int);
  69 int efi_handle_lookup(EFI_HANDLE, struct devsw **, int *,  uint64_t *);
  70 int efi_handle_update_dev(EFI_HANDLE, struct devsw *, int, uint64_t);
  71
  72 EFI_DEVICE_PATH *efi_lookup_image_devpath(EFI_HANDLE);
  73 EFI_DEVICE_PATH *efi_lookup_devpath(EFI_HANDLE);
  74 EFI_HANDLE efi_devpath_handle(EFI_DEVICE_PATH *);
  75 EFI_DEVICE_PATH *efi_devpath_last_node(EFI_DEVICE_PATH *);
  76 EFI_DEVICE_PATH *efi_devpath_trim(EFI_DEVICE_PATH *);
  77 int efi_devpath_match(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *);
  78 CHAR16 *efi_devpath_name(EFI_DEVICE_PATH *);
  79 void efi_free_devpath_name(CHAR16 *);
  80
  81 int efi_status_to_errno(EFI_STATUS);
  82
  83 void efi_time_init(void);
  84 void efi_time_fini(void);
  85
  86 EFI_STATUS main(int argc, CHAR16 *argv[]);
  87 void exit(EFI_STATUS status);
  88 void delay(int usecs);
  89
  90 /* EFI environment initialization. */
  91 void efi_init_environment(void);
  92
  93 /* CHAR16 utility functions. */
  94 int wcscmp(CHAR16 *, CHAR16 *);
  95 void cpy8to16(const char *, CHAR16 *, size_t);
  96 void cpy16to8(const CHAR16 *, char *, size_t);
  97
  98 #endif  /* _LOADER_EFILIB_H */