xref: /freebsd/sys/amd64/include/pc/bios.h (revision 6990ffd8a95caaba6858ad44ff1b3157d1efba8f)
1 /*-
2  * Copyright (c) 1997 Michael Smith
3  * Copyright (c) 1998 Jonathan Lemon
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 
30 /*
31  * Signature structure for the BIOS32 Service Directory header
32  */
33 struct bios32_SDheader
34 {
35     u_int8_t	sig[4];
36     u_int32_t	entry;
37     u_int8_t	revision;
38     u_int8_t	len;
39     u_int8_t	cksum;
40     u_int8_t	pad[5];
41 };
42 
43 /*
44  * BIOS32 Service Directory entry.  Caller supplies name, bios32_SDlookup
45  * fills in the rest of the details.
46  */
47 struct bios32_SDentry
48 {
49     union
50     {
51 	u_int8_t	name[4];	/* service identifier */
52 	u_int32_t	id;		/* as a 32-bit value */
53     } ident;
54     u_int32_t	base;			/* base of service */
55     u_int32_t	len;			/* service length */
56     u_int32_t	entry;			/* entrypoint offset from base */
57     vm_offset_t	ventry;			/* entrypoint in kernel virtual segment */
58 };
59 
60 extern int		bios32_SDlookup(struct bios32_SDentry *ent);
61 extern u_int32_t	bios_sigsearch(u_int32_t start, u_char *sig, int siglen,
62 					 int paralen, int sigofs);
63 
64 #define BIOS_PADDRTOVADDR(x)	(((x) - ISA_HOLE_START) + atdevbase)
65 #define BIOS_VADDRTOPADDR(x)	(((x) - atdevbase) + ISA_HOLE_START)
66 
67 
68 /*
69  * PnP BIOS presence structure
70  */
71 struct PnPBIOS_table
72 {
73     u_int8_t	sig[4];			/* "$PnP */
74     u_int8_t	version;		/* should be 0x10 */
75     u_int8_t	len;    		/* total structure length */
76     u_int16_t	control;		/* BIOS feature flags */
77     u_int8_t	cksum;			/* checksum */
78     u_int32_t	evflagaddr;		/* address of event notificaton flag */
79     u_int16_t	rmentryoffset;		/* real-mode entry offset */
80     u_int16_t	rmentryseg;		/*                 segment */
81     u_int16_t	pmentryoffset;		/* protected-mode entry offset */
82     u_int32_t	pmentrybase;		/*                segment base */
83     u_int32_t	oemdevid;		/* motherboard EISA ID */
84     u_int16_t	rmbiosseg;		/* real-mode BIOS segment */
85     u_int32_t	pmdataseg;		/* protected-mode data segment */
86 } __attribute__ ((packed));
87 
88 
89 /*
90  * Exported lookup results
91  */
92 extern struct bios32_SDentry	PCIbios;
93 extern struct PnPBIOS_table	*PnPBIOStable;
94 
95 struct segment_info {
96 	u_int	base;
97 	u_int	limit;
98 };
99 
100 #define BIOSCODE_FLAG	0x01
101 #define BIOSDATA_FLAG	0x02
102 #define BIOSUTIL_FLAG	0x04
103 #define BIOSARGS_FLAG	0x08
104 
105 struct bios_segments {
106 	struct	segment_info code32;		/* 32-bit code (mandatory) */
107 	struct	segment_info code16;		/* 16-bit code */
108 	struct	segment_info data;		/* 16-bit data */
109 	struct	segment_info util;		/* 16-bit utility */
110 	struct	segment_info args;		/* 16-bit args */
111 };
112 
113 struct bios_regs {
114 	u_int	eax;
115 	u_int	ebx;
116 	u_int	ecx;
117 	u_int	edx;
118 	u_int	esi;
119 	u_int	edi;
120 };
121 
122 struct bios_args {
123 	u_int	entry;				/* entry point of routine */
124 	struct	bios_regs r;
125 	struct	bios_segments seg;
126 };
127 
128 /*
129  * PnP BIOS return codes
130  */
131 #define PNP_SUCCESS				0x00
132 #define PNP_NOT_SET_STATICALLY			0x7f
133 #define PNP_UNKNOWN_FUNCTION			0x81
134 #define PNP_FUNTION_NOT_SUPPORTED		0x82
135 #define PNP_INVALID_HANDLE			0x83
136 #define PNP_BAD_PARAMETER			0x84
137 #define PNP_SET_FAILED				0x85
138 #define PNP_EVENTS_NOT_PENDING			0x86
139 #define PNP_SYSTEM_NOT_DOCKED			0x87
140 #define PNP_NO_ISA_PNP_CARDS			0x88
141 #define PNP_UNABLE_TO_DETERMINE_DOCK_CAPABILITIES 0x89
142 #define PNP_CONFIG_CHANGE_FAILED_NO_BATTERY	0x8a
143 #define PNP_CONFIG_CHANGE_FAILED_RESOURCE_CONFLICT 0x8b
144 #define PNP_BUFFER_TOO_SMALL			0x8c
145 #define PNP_USE_ESCD_SUPPORT			0x8d
146 #define PNP_MESSAGE_NOT_SUPPORTED		0x8e
147 #define PNP_HARDWARE_ERROR			0x8f
148 
149 /*
150  * DMI return codes
151  */
152 #define DMI_SUCCESS				0x00
153 #define DMI_UNKNOWN_FUNCTION			0x81
154 #define DMI_FUNCTION_NOT_SUPPORTED		0x82
155 #define DMI_INVALID_HANDLE			0x83
156 #define DMI_BAD_PARAMETER			0x84
157 #define DMI_INVALID_SUBFUNCTION			0x85
158 #define DMI_NO_CHANGE				0x86
159 #define DMI_ADD_STRUCTURE_FAILED		0x87
160 #define DMI_READ_ONLY				0x8d
161 #define DMI_LOCK_NOT_SUPPORTED			0x90
162 #define DMI_CURRENTLY_LOCKED			0x91
163 #define DMI_INVALID_LOCK			0x92
164 
165 /*
166  * format specifiers and defines for bios16()
167  *     s	= short (16 bits)
168  *     i	= int (32 bits)
169  *     p	= pointer (converted to seg:offset)
170  *     C,D,U 	= selector (corresponding to code/data/utility segment)
171  */
172 #define PNP_COUNT_DEVNODES	"sppD",		0x00
173 #define PNP_GET_DEVNODE		"sppsD",	0x01
174 #define PNP_SET_DEVNODE		"sspsD",	0x02
175 #define PNP_GET_EVENT		"spD",		0x03
176 #define PNP_SEND_MSG		"ssD",		0x04
177 #define PNP_GET_DOCK_INFO	"spD",		0x05
178 
179 #define PNP_SEL_PRIBOOT		"ssiiisspD",	0x07
180 #define PNP_GET_PRIBOOT		"sspppppD",	0x08
181 #define PNP_SET_RESINFO		"spD",		0x09
182 #define PNP_GET_RESINFO		"spD",		0x0A
183 #define PNP_GET_APM_ID		"sppD",		0x0B
184 
185 #define PNP_GET_ISA_INFO	"spD",		0x40
186 #define PNP_GET_ECSD_INFO	"spppD",	0x41
187 #define PNP_READ_ESCD		"spUD",		0x42
188 #define PNP_WRITE_ESCD		"spUD",		0x43
189 
190 #define PNP_GET_DMI_INFO	"spppppD",	0x50
191 #define PNP_GET_DMI_STRUCTURE	"sppUD",	0x51
192 #define PNP_SET_DMI_STRUCTURE	"sppsUD"	0x52
193 #define PNP_GET_DMI_CHANGE	"spUD"		0x53
194 #define PNP_DMI_CONTROL		"sspsUD"	0x54
195 #define PNP_GET_GPNV_INFO	"sppppD"	0x55
196 #define PNP_READ_GPNV_DATA	"ssppUD"	0x56
197 #define PNP_WRITE_GPNV_DATA	"sspsUD"	0x57
198 
199 #define PNP_BOOT_CHECK		"sp",		0x60
200 #define PNP_COUNT_IPL		"sppp",		0x61
201 #define PNP_GET_BOOTPRI		"spp",		0x62
202 #define PNP_SET_BOOTPRI		"sp",		0x63
203 #define PNP_GET_LASTBOOT	"sp",		0x64
204 #define PNP_GET_BOOTFIRST	"sp",		0x65
205 #define PNP_SET_BOOTFIRST	"sp",		0x66
206 
207 /*
208  * PCI BIOS functions
209  */
210 #define PCIBIOS_BIOS_PRESENT		0xb101
211 #define PCIBIOS_READ_CONFIG_BYTE	0xb108
212 #define PCIBIOS_READ_CONFIG_WORD	0xb109
213 #define PCIBIOS_READ_CONFIG_DWORD	0xb10a
214 #define PCIBIOS_WRITE_CONFIG_BYTE	0xb10b
215 #define PCIBIOS_WRITE_CONFIG_WORD	0xb10c
216 #define PCIBIOS_WRITE_CONFIG_DWORD	0xb10d
217 #define PCIBIOS_GET_IRQ_ROUTING		0xb10e
218 #define PCIBIOS_ROUTE_INTERRUPT		0xb10f
219 
220 extern int bios16(struct bios_args *, char *, ...);
221 extern int bios16_call(struct bios_regs *, char *);
222 extern int bios32(struct bios_regs *, u_int, u_short);
223 extern void set_bios_selectors(struct bios_segments *, int);
224 
225 /*
226  * PCI interrupt routing table.
227  *
228  * $PIR in the BIOS segment contains a PIR_table
229  * int 1a:b106 returns PIR_table in buffer at es:(e)di
230  * int 1a:b18e returns PIR_table in buffer at es:(e)di
231  * int 1a:b406 returns es:di pointing to the BIOS PIR_table
232  */
233 struct PIR_header
234 {
235     int8_t	ph_signature[4];
236     u_int16_t	ph_version;
237     u_int16_t	ph_length;
238     u_int8_t	ph_router_bus;
239     u_int8_t	ph_router_dev_fn;
240     u_int16_t	ph_pci_irqs;
241     u_int16_t	ph_router_vendor;
242     u_int16_t	ph_router_device;
243     u_int32_t	ph_miniport;
244     u_int8_t	ph_res[11];
245     u_int8_t	ph_checksum;
246 } __attribute__ ((packed));
247 
248 struct PIR_intpin
249 {
250     u_int8_t	link;
251     u_int16_t	irqs;
252 } __attribute__ ((packed));
253 
254 struct PIR_entry
255 {
256     u_int8_t		pe_bus;
257     u_int8_t		pe_res1:3;
258     u_int8_t		pe_device:5;
259     struct PIR_intpin	pe_intpin[4];
260     u_int8_t	pe_slot;
261     u_int8_t	pe_res3;
262 } __attribute__ ((packed));
263 
264 struct PIR_table
265 {
266     struct PIR_header	pt_header;
267     struct PIR_entry	pt_entry[0];
268 } __attribute__ ((packed));
269 
270 /*
271  * Int 15:E820 'SMAP' structure
272  *
273  * XXX add constants for type
274  */
275 #define SMAP_SIG	0x534D4150			/* 'SMAP' */
276 struct bios_smap {
277     u_int64_t	base;
278     u_int64_t	length;
279     u_int32_t	type;
280 } __attribute__ ((packed));
281