xref: /illumos-gate/usr/src/boot/i386/libi386/libi386.h (revision f9feecc1)
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 
28 #ifndef	_LIBI386_H
29 #define	_LIBI386_H
30 
31 /*
32  * i386 fully-qualified device descriptor.
33  * Note, this must match the 'struct devdesc' declaration
34  * in bootstrap.h and also with struct zfs_devdesc for zfs
35  * support.
36  */
37 struct i386_devdesc
38 {
39     struct devsw	*d_dev;
40     int			d_type;
41     int			d_unit;
42     union
43     {
44 	struct
45 	{
46 	    void	*data;
47 	    int		slice;
48 	    int		partition;
49 	    off_t	offset;
50 	} biosdisk;
51 	struct
52 	{
53 	    void	*data;
54 	} bioscd;
55 	struct
56 	{
57 	    void	*data;
58 	    uint64_t	pool_guid;
59 	    uint64_t	root_guid;
60 	} zfs;
61     } d_kind;
62 };
63 
64 /*
65  * relocater trampoline support.
66  */
67 struct relocate_data {
68 	uint32_t	src;
69 	uint32_t	dest;
70 	uint32_t	size;
71 };
72 
73 extern void relocater(void);
74 
75 /*
76  * The relocater_data[] is fixed size array allocated in relocater_tramp.S
77  */
78 extern struct relocate_data relocater_data[];
79 extern uint32_t relocater_size;
80 
81 extern uint16_t relocator_ip;
82 extern uint16_t relocator_cs;
83 extern uint16_t relocator_ds;
84 extern uint16_t relocator_es;
85 extern uint16_t relocator_fs;
86 extern uint16_t relocator_gs;
87 extern uint16_t relocator_ss;
88 extern uint16_t relocator_sp;
89 extern uint32_t relocator_esi;
90 extern uint32_t relocator_eax;
91 extern uint32_t relocator_ebx;
92 extern uint32_t relocator_edx;
93 extern uint32_t relocator_ebp;
94 extern uint16_t relocator_a20_enabled;
95 
96 int	i386_getdev(void **vdev, const char *devspec, const char **path);
97 char	*i386_fmtdev(void *vdev);
98 int	i386_setcurrdev(struct env_var *ev, int flags, const void *value);
99 
100 extern struct devdesc	currdev;	/* our current device */
101 
102 #define MAXDEV		31		/* maximum number of distinct devices */
103 #define MAXBDDEV	MAXDEV
104 
105 /* exported devices XXX rename? */
106 extern struct devsw bioscd;
107 extern struct devsw biosdisk;
108 extern struct devsw pxedisk;
109 extern struct fs_ops pxe_fsops;
110 
111 int	bc_add(int biosdev);		/* Register CD booted from. */
112 int	bc_getdev(struct i386_devdesc *dev);	/* return dev_t for (dev) */
113 int	bc_bios2unit(int biosdev);	/* xlate BIOS device -> bioscd unit */
114 int	bc_unit2bios(int unit);		/* xlate bioscd unit -> BIOS device */
115 uint32_t bd_getbigeom(int bunit);	/* return geometry in bootinfo format */
116 int	bd_bios2unit(int biosdev);	/* xlate BIOS device -> biosdisk unit */
117 int	bd_unit2bios(int unit);		/* xlate biosdisk unit -> BIOS device */
118 int	bd_getdev(struct i386_devdesc *dev);	/* return dev_t for (dev) */
119 
120 ssize_t	i386_copyin(const void *src, vm_offset_t dest, const size_t len);
121 ssize_t	i386_copyout(const vm_offset_t src, void *dest, const size_t len);
122 ssize_t	i386_readin(const int fd, vm_offset_t dest, const size_t len);
123 
124 struct preloaded_file;
125 void	bios_addsmapdata(struct preloaded_file *);
126 void	bios_getsmap(void);
127 
128 void	bios_getmem(void);
129 extern uint32_t		bios_basemem;	/* base memory in bytes */
130 extern uint32_t		bios_extmem;	/* extended memory in bytes */
131 extern vm_offset_t	memtop;		/* last address of physical memory + 1 */
132 extern vm_offset_t	memtop_copyin;	/* memtop less heap size for the cases */
133 					/*  when heap is at the top of         */
134 					/*  extended memory; for other cases   */
135 					/*  just the same as memtop            */
136 extern uint32_t		high_heap_size;	/* extended memory region available */
137 extern vm_offset_t	high_heap_base;	/* for use as the heap */
138 
139 void	biospci_detect(void);
140 int biospci_find_devclass(uint32_t class, int index, uint32_t *locator);
141 int biospci_read_config(uint32_t locator, int offset, int width, uint32_t *val);
142 uint32_t biospci_locator(int8_t bus, uint8_t device, uint8_t function);
143 int biospci_write_config(uint32_t locator, int offset, int width, uint32_t val);
144 
145 void	biosacpi_detect(void);
146 
147 int	i386_autoload(void);
148 
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 addr, vm_offset_t *modulep,
155 	    vm_offset_t *kernend, int add_smap);
156 int	bi_checkcpu(void);
157 
158 int	mb_kernel_cmdline(struct preloaded_file *, struct devdesc *, char **);
159 void	multiboot_tramp(uint32_t, vm_offset_t, vm_offset_t);
160 void	pxe_enable(void *pxeinfo);
161 
162 #endif /* _LIBI386_H */
163