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  * $FreeBSD$
  27  */
  28
  29
  30 /*
  31  * i386 fully-qualified device descriptor.
  32  * Note, this must match the 'struct devdesc' declaration
  33  * in bootstrap.h and also with struct zfs_devdesc for zfs
  34  * support.
  35  */
  36 struct i386_devdesc
  37 {
  38     struct devsw        *d_dev;
  39     int                 d_type;
  40     int                 d_unit;
  41     union
  42     {
  43         struct
  44         {
  45             void        *data;
  46             int         slice;
  47             int         partition;
  48             off_t       offset;
  49         } biosdisk;
  50         struct
  51         {
  52             void        *data;
  53         } bioscd;
  54         struct
  55         {
  56             void        *data;
  57             uint64_t    pool_guid;
  58             uint64_t    root_guid;
  59         } zfs;
  60     } d_kind;
  61 };
  62
  63 int     i386_getdev(void **vdev, const char *devspec, const char **path);
  64 char    *i386_fmtdev(void *vdev);
  65 int     i386_setcurrdev(struct env_var *ev, int flags, const void *value);
  66
  67 extern struct devdesc   currdev;        /* our current device */
  68
  69 #define MAXDEV          31              /* maximum number of distinct devices */
  70 #define MAXBDDEV        MAXDEV
  71
  72 /* exported devices XXX rename? */
  73 extern struct devsw bioscd;
  74 extern struct devsw biosdisk;
  75 extern struct devsw pxedisk;
  76 extern struct fs_ops pxe_fsops;
  77
  78 int     bc_add(int biosdev);            /* Register CD booted from. */
  79 int     bc_getdev(struct i386_devdesc *dev);    /* return dev_t for (dev) */
  80 int     bc_bios2unit(int biosdev);      /* xlate BIOS device -> bioscd unit */
  81 int     bc_unit2bios(int unit);         /* xlate bioscd unit -> BIOS device */
  82 uint32_t bd_getbigeom(int bunit);       /* return geometry in bootinfo format */
  83 int     bd_bios2unit(int biosdev);      /* xlate BIOS device -> biosdisk unit */
  84 int     bd_unit2bios(int unit);         /* xlate biosdisk unit -> BIOS device */
  85 int     bd_getdev(struct i386_devdesc *dev);    /* return dev_t for (dev) */
  86
  87 ssize_t i386_copyin(const void *src, vm_offset_t dest, const size_t len);
  88 ssize_t i386_copyout(const vm_offset_t src, void *dest, const size_t len);
  89 ssize_t i386_readin(const int fd, vm_offset_t dest, const size_t len);
  90
  91 struct preloaded_file;
  92 void    bios_addsmapdata(struct preloaded_file *);
  93 void    bios_getsmap(void);
  94
  95 void    bios_getmem(void);
  96 extern uint32_t         bios_basemem;   /* base memory in bytes */
  97 extern uint32_t         bios_extmem;    /* extended memory in bytes */
  98 extern vm_offset_t      memtop;         /* last address of physical memory + 1 */
  99 extern vm_offset_t      memtop_copyin;  /* memtop less heap size for the cases */
 100                                         /*  when heap is at the top of         */
 101                                         /*  extended memory; for other cases   */
 102                                         /*  just the same as memtop            */
 103 extern uint32_t         high_heap_size; /* extended memory region available */
 104 extern vm_offset_t      high_heap_base; /* for use as the heap */
 105
 106 int biospci_find_devclass(uint32_t class, int index, uint32_t *locator);
 107 int biospci_write_config(uint32_t locator, int offset, int width, uint32_t val);
 108 int biospci_read_config(uint32_t locator, int offset, int width, uint32_t *val);
 109 uint32_t biospci_locator(int8_t bus, uint8_t device, uint8_t function);
 110
 111 void    biosacpi_detect(void);
 112
 113 void    smbios_detect(void);
 114
 115 int     i386_autoload(void);
 116
 117 int     bi_getboothowto(char *kargs);
 118 void    bi_setboothowto(int howto);
 119 vm_offset_t     bi_copyenv(vm_offset_t addr);
 120 int     bi_load32(char *args, int *howtop, int *bootdevp, vm_offset_t *bip,
 121             vm_offset_t *modulep, vm_offset_t *kernend);
 122 int     bi_load64(char *args, vm_offset_t *modulep, vm_offset_t *kernend);
 123
 124 void    pxe_enable(void *pxeinfo);