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