initial commit
[freebsd-arm:freebsd-arm.git] / 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.
34  */
35 struct i386_devdesc
36 {
37     struct devsw        *d_dev;
38     int                 d_type;
39     int                 d_unit;
40     union 
41     {
42         struct 
43         {
44             void        *data;
45             int         slice;
46             int         partition;
47         } biosdisk;
48         struct
49         {
50             void        *data;
51         } bioscd;
52     } d_kind;
53 };
54
55 struct edd_packet {
56     uint16_t    len;
57     uint16_t    count;
58     uint16_t    offset;
59     uint16_t    seg;
60     uint64_t    lba;
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
71 /* exported devices XXX rename? */
72 extern struct devsw bioscd;
73 extern struct devsw biosdisk;
74 extern struct devsw pxedisk;
75 extern struct fs_ops pxe_fsops;
76
77 int     bc_add(int biosdev);            /* Register CD booted from. */
78 int     bc_getdev(struct i386_devdesc *dev);    /* return dev_t for (dev) */
79 int     bc_bios2unit(int biosdev);      /* xlate BIOS device -> bioscd unit */
80 int     bc_unit2bios(int unit);         /* xlate bioscd unit -> BIOS device */
81 uint32_t bd_getbigeom(int bunit);       /* return geometry in bootinfo format */
82 int     bd_bios2unit(int biosdev);      /* xlate BIOS device -> biosdisk unit */
83 int     bd_unit2bios(int unit);         /* xlate biosdisk unit -> BIOS device */
84 int     bd_getdev(struct i386_devdesc *dev);    /* return dev_t for (dev) */
85
86 ssize_t i386_copyin(const void *src, vm_offset_t dest, const size_t len);
87 ssize_t i386_copyout(const vm_offset_t src, void *dest, const size_t len);
88 ssize_t i386_readin(const int fd, vm_offset_t dest, const size_t len);
89
90 struct preloaded_file;
91 void    bios_addsmapdata(struct preloaded_file *);
92 void    bios_getsmap(void);
93
94 void    bios_getmem(void);
95 extern uint32_t         bios_basemem;   /* base memory in bytes */
96 extern uint32_t         bios_extmem;    /* extended memory in bytes */
97 extern vm_offset_t      memtop;         /* last address of physical memory + 1 */
98 extern vm_offset_t      memtop_copyin;  /* memtop less heap size for the cases */
99                                         /*  when heap is at the top of         */
100                                         /*  extended memory; for other cases   */
101                                         /*  just the same as memtop            */
102 extern uint32_t         high_heap_size; /* extended memory region available */
103 extern vm_offset_t      high_heap_base; /* for use as the heap */
104
105 int biospci_find_devclass(uint32_t class, int index, uint32_t *locator);
106 int biospci_write_config(uint32_t locator, int offset, int width, uint32_t val);
107 int biospci_read_config(uint32_t locator, int offset, int width, uint32_t *val);
108
109 void    biosacpi_detect(void);
110
111 void    smbios_detect(void);
112
113 int     i386_autoload(void);
114
115 int     bi_getboothowto(char *kargs);
116 void    bi_setboothowto(int howto);
117 vm_offset_t     bi_copyenv(vm_offset_t addr);
118 int     bi_load32(char *args, int *howtop, int *bootdevp, vm_offset_t *bip,
119             vm_offset_t *modulep, vm_offset_t *kernend);
120 int     bi_load64(char *args, vm_offset_t *modulep, vm_offset_t *kernend);
121
122 void    pxe_enable(void *pxeinfo);