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