xref: /freebsd/stand/i386/libi386/libi386.h (revision e8d8bef961a50d4dc22501cde4fb9fb0be1b2532)
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  */
33 struct i386_devdesc {
34     struct devdesc	dd;		/* Must be first. */
35     union
36     {
37 	struct
38 	{
39 	    int		slice;
40 	    int		partition;
41 	    off_t	offset;
42 	} biosdisk;
43 	struct
44 	{
45 	    uint64_t	pool_guid;
46 	    uint64_t	root_guid;
47 	} zfs;
48     } d_kind;
49 };
50 
51 /*
52  * relocater trampoline support.
53  */
54 struct relocate_data {
55 	uint32_t	src;
56 	uint32_t	dest;
57 	uint32_t	size;
58 };
59 
60 extern void relocater(void);
61 
62 /*
63  * The relocater_data[] is fixed size array allocated in relocater_tramp.S
64  */
65 extern struct relocate_data relocater_data[];
66 extern uint32_t relocater_size;
67 
68 extern uint16_t relocator_ip;
69 extern uint16_t relocator_cs;
70 extern uint16_t relocator_ds;
71 extern uint16_t relocator_es;
72 extern uint16_t relocator_fs;
73 extern uint16_t relocator_gs;
74 extern uint16_t relocator_ss;
75 extern uint16_t relocator_sp;
76 extern uint32_t relocator_esi;
77 extern uint32_t relocator_eax;
78 extern uint32_t relocator_ebx;
79 extern uint32_t relocator_edx;
80 extern uint32_t relocator_ebp;
81 extern uint16_t relocator_a20_enabled;
82 
83 int	i386_getdev(void **vdev, const char *devspec, const char **path);
84 char	*i386_fmtdev(void *vdev);
85 int	i386_setcurrdev(struct env_var *ev, int flags, const void *value);
86 
87 extern struct devdesc	currdev;	/* our current device */
88 
89 #define MAXDEV		31		/* maximum number of distinct devices */
90 #define MAXBDDEV	MAXDEV
91 
92 #include <readin.h>
93 
94 /* exported devices XXX rename? */
95 extern struct devsw bioscd;
96 extern struct devsw biosfd;
97 extern struct devsw bioshd;
98 extern struct devsw pxedisk;
99 extern struct fs_ops pxe_fsops;
100 
101 int	bc_add(int biosdev);		/* Register CD booted from. */
102 uint32_t bd_getbigeom(int bunit);	/* return geometry in bootinfo format */
103 int	bd_bios2unit(int biosdev);	/* xlate BIOS device -> biosdisk unit */
104 int	bd_unit2bios(struct i386_devdesc *); /* xlate biosdisk -> BIOS device */
105 int	bd_getdev(struct i386_devdesc *dev);	/* return dev_t for (dev) */
106 
107 ssize_t	i386_copyin(const void *src, vm_offset_t dest, const size_t len);
108 ssize_t	i386_copyout(const vm_offset_t src, void *dest, const size_t len);
109 ssize_t	i386_readin(readin_handle_t fd, vm_offset_t dest, const size_t len);
110 
111 struct preloaded_file;
112 void	bios_addsmapdata(struct preloaded_file *);
113 void	bios_getsmap(void);
114 
115 void	bios_getmem(void);
116 extern uint32_t		bios_basemem;	/* base memory in bytes */
117 extern uint32_t		bios_extmem;	/* extended memory in bytes */
118 extern vm_offset_t	memtop;		/* last address of physical memory + 1 */
119 extern vm_offset_t	memtop_copyin;	/* memtop less heap size for the cases */
120 					/*  when heap is at the top of         */
121 					/*  extended memory; for other cases   */
122 					/*  just the same as memtop            */
123 extern uint32_t		high_heap_size;	/* extended memory region available */
124 extern vm_offset_t	high_heap_base;	/* for use as the heap */
125 
126 /* 16KB buffer space for real mode data transfers. */
127 #define	BIO_BUFFER_SIZE 0x4000
128 void *bio_alloc(size_t size);
129 void bio_free(void *ptr, size_t size);
130 
131 /*
132  * Values for width parameter to biospci_{read,write}_config
133  */
134 #define BIOSPCI_8BITS	0
135 #define BIOSPCI_16BITS	1
136 #define BIOSPCI_32BITS	2
137 
138 void	biospci_detect(void);
139 int	biospci_find_devclass(uint32_t class, int index, uint32_t *locator);
140 int	biospci_read_config(uint32_t locator, int offset, int width, uint32_t *val);
141 uint32_t biospci_locator(int8_t bus, uint8_t device, uint8_t function);
142 int	biospci_write_config(uint32_t locator, int offset, int width, uint32_t val);
143 
144 void	biosacpi_detect(void);
145 
146 int	i386_autoload(void);
147 
148 void	bi_load_vbe_data(struct preloaded_file *kfp);
149 int	bi_getboothowto(char *kargs);
150 void	bi_setboothowto(int howto);
151 vm_offset_t	bi_copyenv(vm_offset_t addr);
152 int	bi_load32(char *args, int *howtop, int *bootdevp, vm_offset_t *bip,
153 	    vm_offset_t *modulep, vm_offset_t *kernend);
154 int	bi_load64(char *args, vm_offset_t *modulep,
155 	    vm_offset_t *kernend, int add_smap);
156 
157 void	pxe_enable(void *pxeinfo);
158