usr/src/boot/sys/boot/i386/libi386/libi386.h

   1 /*
   2  * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #ifndef _LIBI386_H
  28 #define _LIBI386_H
  29
  30 /*
  31  * i386 fully-qualified device descriptor.
  32  */
  33 struct i386_devdesc {
  34     struct devdesc      dd;     /* Must be first. */
  35     union {
  36         struct {
  37             int         slice;
  38             int         partition;
  39             off_t       offset;
  40         } biosdisk;
  41         struct {
  42             uint64_t    pool_guid;
  43             uint64_t    root_guid;
  44         } zfs;
  45     } d_kind;
  46 };
  47
  48 /*
  49  * relocater trampoline support.
  50  */
  51 struct relocate_data {
  52         uint32_t        src;
  53         uint32_t        dest;
  54         uint32_t        size;
  55 };
  56
  57 extern void relocater(void);
  58
  59 /*
  60  * The relocater_data[] is fixed size array allocated in relocater_tramp.S
  61  */
  62 extern struct relocate_data relocater_data[];
  63 extern uint32_t relocater_size;
  64
  65 extern uint16_t relocator_ip;
  66 extern uint16_t relocator_cs;
  67 extern uint16_t relocator_ds;
  68 extern uint16_t relocator_es;
  69 extern uint16_t relocator_fs;
  70 extern uint16_t relocator_gs;
  71 extern uint16_t relocator_ss;
  72 extern uint16_t relocator_sp;
  73 extern uint32_t relocator_esi;
  74 extern uint32_t relocator_eax;
  75 extern uint32_t relocator_ebx;
  76 extern uint32_t relocator_edx;
  77 extern uint32_t relocator_ebp;
  78 extern uint16_t relocator_a20_enabled;
  79
  80 int     i386_getdev(void **vdev, const char *devspec, const char **path);
  81 char    *i386_fmtdev(void *vdev);
  82 int     i386_setcurrdev(struct env_var *ev, int flags, const void *value);
  83
  84 extern struct devdesc   currdev;        /* our current device */
  85
  86 #define MAXDEV          31              /* maximum number of distinct devices */
  87 #define MAXBDDEV        MAXDEV
  88
  89 /* exported devices XXX rename? */
  90 extern struct devsw bioscd;
  91 extern struct devsw biosfd;
  92 extern struct devsw bioshd;
  93 extern struct devsw pxedisk;
  94 extern struct fs_ops pxe_fsops;
  95
  96 int     bc_add(int biosdev);            /* Register CD booted from. */
  97 uint32_t bd_getbigeom(int bunit);       /* return geometry in bootinfo format */
  98 int     bd_bios2unit(int biosdev);      /* xlate BIOS device -> biosdisk unit */
  99 int     bd_unit2bios(struct i386_devdesc *); /* xlate biosdisk -> BIOS device */
 100 int     bd_getdev(struct i386_devdesc *dev);    /* return dev_t for (dev) */
 101
 102 ssize_t i386_copyin(const void *src, vm_offset_t dest, const size_t len);
 103 ssize_t i386_copyout(const vm_offset_t src, void *dest, const size_t len);
 104 ssize_t i386_readin(const int fd, vm_offset_t dest, const size_t len);
 105
 106 struct preloaded_file;
 107 void    bios_addsmapdata(struct preloaded_file *);
 108 void    bios_getsmap(void);
 109
 110 void    bios_getmem(void);
 111 extern uint32_t         bios_basemem;   /* base memory in bytes */
 112 extern uint32_t         bios_extmem;    /* extended memory in bytes */
 113 extern vm_offset_t      memtop;         /* last address of physical memory + 1 */
 114 extern vm_offset_t      memtop_copyin;  /* memtop less heap size for the cases */
 115                                         /*  when heap is at the top of         */
 116                                         /*  extended memory; for other cases   */
 117                                         /*  just the same as memtop            */
 118 extern uint32_t         high_heap_size; /* extended memory region available */
 119 extern vm_offset_t      high_heap_base; /* for use as the heap */
 120
 121 /* 16KB buffer space for real mode data transfers. */
 122 #define BIO_BUFFER_SIZE 0x4000
 123 void *bio_alloc(size_t size);
 124 void bio_free(void *ptr, size_t size);
 125
 126 void    biospci_detect(void);
 127 int biospci_find_devclass(uint32_t class, int index, uint32_t *locator);
 128 int biospci_read_config(uint32_t locator, int offset, int width, uint32_t *val);
 129 uint32_t biospci_locator(int8_t bus, uint8_t device, uint8_t function);
 130 int biospci_write_config(uint32_t locator, int offset, int width, uint32_t val);
 131
 132 void    biosacpi_detect(void);
 133
 134 int     i386_autoload(void);
 135 vm_offset_t i386_loadaddr(u_int type, void *data, vm_offset_t addr);
 136
 137 int     bi_getboothowto(char *kargs);
 138 void    bi_setboothowto(int howto);
 139 vm_offset_t     bi_copyenv(vm_offset_t addr);
 140 int     bi_load32(char *args, int *howtop, int *bootdevp, vm_offset_t *bip,
 141             vm_offset_t *modulep, vm_offset_t *kernend);
 142 int     bi_load64(char *args, vm_offset_t addr, vm_offset_t *modulep,
 143             vm_offset_t *kernend, int add_smap);
 144 int     bi_checkcpu(void);
 145 void    bi_isadir(void);
 146
 147 int     mb_kernel_cmdline(struct preloaded_file *, struct devdesc *, char **);
 148 void    multiboot_tramp(uint32_t, vm_offset_t, vm_offset_t);
 149 void    pxe_enable(void *pxeinfo);
 150
 151 #endif /* _LIBI386_H */