Home | History | Annotate | Line # | Download | only in efiboot
efiboot.h revision 1.18
      1 /*	$NetBSD: efiboot.h,v 1.18 2021/10/06 10:13:19 jmcneill Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2016 Kimihiro Nonaka <nonaka (at) netbsd.org>
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  *
     16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     26  * SUCH DAMAGE.
     27  */
     28 
     29 #include <efi.h>
     30 #include <efilib.h>
     31 
     32 #include <lib/libsa/stand.h>
     33 #include <lib/libkern/libkern.h>
     34 
     35 #include <loadfile.h>
     36 #include <net.h>
     37 
     38 #include "efiboot_machdep.h"
     39 
     40 struct boot_command {
     41 	const char *c_name;
     42 	void (*c_fn)(char *);
     43 	const char *c_help;
     44 };
     45 
     46 int arch_prepare_boot(const char *, const char *, u_long *);
     47 void arch_cleanup_boot(void);
     48 size_t arch_alloc_size(void);
     49 void arch_set_virtual_address_map(EFI_MEMORY_DESCRIPTOR *, UINTN, UINTN, UINTN, UINT32);
     50 
     51 /* conf.c */
     52 extern struct fs_ops null_fs_ops;
     53 extern struct fs_ops tftp_fs_ops;
     54 extern struct fs_ops nfs_fs_ops;
     55 
     56 /* boot.c */
     57 void boot(void);
     58 void clearit(void);
     59 extern const struct boot_command commands[];
     60 void command_help(char *);
     61 int set_default_device(const char *);
     62 char *get_default_device(void);
     63 void set_default_fstype(int);
     64 int get_default_fstype(void);
     65 int set_initrd_path(const char *);
     66 char *get_initrd_path(void);
     67 int set_dtb_path(const char *);
     68 char *get_dtb_path(void);
     69 int set_rndseed_path(const char *);
     70 char *get_rndseed_path(void);
     71 
     72 /* console.c */
     73 int ischar(void);
     74 
     75 /* efiboot.c */
     76 extern EFI_HANDLE IH;
     77 extern EFI_DEVICE_PATH *efi_bootdp;
     78 extern EFI_LOADED_IMAGE *efi_li;
     79 void efi_cleanup(void);
     80 void efi_exit(void);
     81 void efi_delay(int);
     82 void efi_reboot(void);
     83 void efi_progress(const char *, ...);
     84 extern int howto;
     85 
     86 /* efichar.c */
     87 size_t ucs2len(const CHAR16 *);
     88 int ucs2_to_utf8(const CHAR16 *, char **);
     89 int utf8_to_ucs2(const char *, CHAR16 **, size_t *);
     90 
     91 /* efidev.c */
     92 int efi_device_path_depth(EFI_DEVICE_PATH *, int);
     93 int efi_device_path_count(EFI_DEVICE_PATH *);
     94 int efi_device_path_ncmp(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *, int);
     95 
     96 /* efinet.c */
     97 struct efi_net_if {
     98 	const char *if_name;
     99 	uint8_t if_mac[6];
    100 };
    101 int efi_net_open(struct open_file *, ...);
    102 void efi_net_probe(void);
    103 void efi_net_show(void);
    104 int efi_net_get_booted_interface_unit(void);
    105 int efi_net_get_booted_macaddr(uint8_t *);
    106 extern struct netif_driver efinetif;
    107 
    108 /* efipxe.c */
    109 void efi_pxe_probe(void);
    110 bool efi_pxe_match_booted_interface(const EFI_MAC_ADDRESS *, UINT32);
    111 
    112 /* efiwatchdog.c */
    113 void efi_set_watchdog(uint32_t, uint64_t);
    114 
    115 /* efigop.c */
    116 void efi_gop_probe(void);
    117 void efi_gop_show(void);
    118 void efi_gop_dump(void);
    119 void efi_gop_setmode(UINT32);
    120 
    121 /* exec.c */
    122 int load_file(const char *, u_long, bool, EFI_PHYSICAL_ADDRESS *, u_long *);
    123 int exec_netbsd(const char *, const char *);
    124 
    125 /* panic.c */
    126 __dead VOID Panic(IN CHAR16 *, ...);
    127 __dead void reboot(void);
    128 
    129 /* prompt.c */
    130 char *gettrailer(char *);
    131 void docommand(char *);
    132 char awaitkey(int, int);
    133 __dead void bootprompt(void);
    134