ebda.h@ 100658

Last change on this file since 100658 was 100658, checked in by vboxsync, 18 months ago
BIOS: Reworked BIOS build to have a common core and add 286/386 specific modules (see bugref:6549).
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 13.9 KB

Line
1	/* $Id: ebda.h 100658 2023-07-20 07:43:52Z vboxsync $ */
2	/** @file
3	* PC BIOS - EBDA (Extended BIOS Data Area) Definition
4	*/
5
6	/*
7	* Copyright (C) 2006-2023 Oracle and/or its affiliates.
8	*
9	* This file is part of VirtualBox base platform packages, as
10	* available from https://www.virtualbox.org.
11	*
12	* This program is free software; you can redistribute it and/or
13	* modify it under the terms of the GNU General Public License
14	* as published by the Free Software Foundation, in version 3 of the
15	* License.
16	*
17	* This program is distributed in the hope that it will be useful, but
18	* WITHOUT ANY WARRANTY; without even the implied warranty of
19	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20	* General Public License for more details.
21	*
22	* You should have received a copy of the GNU General Public License
23	* along with this program; if not, see <https://www.gnu.org/licenses>.
24	*
25	* SPDX-License-Identifier: GPL-3.0-only
26	* --------------------------------------------------------------------
27	*
28	* This code is based on:
29	*
30	* ROM BIOS for use with Bochs/Plex86/QEMU emulation environment
31	*
32	* Copyright (C) 2002 MandrakeSoft S.A.
33	*
34	* MandrakeSoft S.A.
35	* 43, rue d'Aboukir
36	* 75002 Paris - France
37	* http://www.linux-mandrake.com/
38	* http://www.mandrakesoft.com/
39	*
40	* This library is free software; you can redistribute it and/or
41	* modify it under the terms of the GNU Lesser General Public
42	* License as published by the Free Software Foundation; either
43	* version 2 of the License, or (at your option) any later version.
44	*
45	* This library is distributed in the hope that it will be useful,
46	* but WITHOUT ANY WARRANTY; without even the implied warranty of
47	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
48	* Lesser General Public License for more details.
49	*
50	* You should have received a copy of the GNU Lesser General Public
51	* License along with this library; if not, write to the Free Software
52	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
53	*
54	*/
55
56	/*
57	* Oracle LGPL Disclaimer: For the avoidance of doubt, except that if any license choice
58	* other than GPL or LGPL is available it will apply instead, Oracle elects to use only
59	* the Lesser General Public License version 2.1 (LGPLv2) at this time for any software where
60	* a choice of LGPL license versions is made available with the language indicating
61	* that LGPLv2 or any later version may be used, or where a choice of which version
62	* of the LGPL is applied is otherwise unspecified.
63	*/
64
65	#ifndef VBOX_INCLUDED_SRC_PC_BIOS_ebda_h
66	#define VBOX_INCLUDED_SRC_PC_BIOS_ebda_h
67	#ifndef RT_WITHOUT_PRAGMA_ONCE
68	# pragma once
69	#endif
70
71	#include <stdint.h>
72
73	/* Must be defined here (EBDA structures depend on these). */
74	#define BX_MAX_ATA_INTERFACES 4
75	#define BX_MAX_ATA_DEVICES (BX_MAX_ATA_INTERFACES*2)
76
77	#define BX_USE_ATADRV 1
78	#define BX_ELTORITO_BOOT 1
79
80	#ifdef VBOX_WITH_SCSI
81	/* Enough for now */
82	#define BX_MAX_SCSI_DEVICES 4
83	/* A SCSI device starts always at BX_MAX_ATA_DEVICES. */
84	#define VBOX_IS_SCSI_DEVICE(device_id) (device_id >= BX_MAX_ATA_DEVICES)
85	#define VBOX_GET_SCSI_DEVICE(device_id) (device_id - BX_MAX_ATA_DEVICES)
86	#else
87	#define BX_MAX_SCSI_DEVICES 0
88	#define VBOX_IS_SCSI_DEVICE(device_id) (1 == 0)
89	#endif
90
91	#ifdef VBOX_WITH_AHCI
92	/* Four should be enough for now */
93	#define BX_MAX_AHCI_DEVICES 4
94
95	/* An AHCI device starts always at BX_MAX_ATA_DEVICES + BX_MAX_SCSI_DEVICES. */
96	#define VBOX_IS_AHCI_DEVICE(device_id) (device_id >= (BX_MAX_ATA_DEVICES + BX_MAX_SCSI_DEVICES))
97	#define VBOX_GET_AHCI_DEVICE(device_id) (device_id - (BX_MAX_ATA_DEVICES + BX_MAX_SCSI_DEVICES))
98	#else
99	#define BX_MAX_AHCI_DEVICES 0
100	#endif
101
102	#ifdef VBOX_WITH_VIRTIO_SCSI
103	/* Four should be enough for now */
104	#define BX_MAX_VIRTIO_SCSI_DEVICES 4
105
106	/* An AHCI device starts always at BX_MAX_ATA_DEVICES + BX_MAX_SCSI_DEVICES. */
107	#define VBOX_IS_VIRTIO_SCSI_DEVICE(device_id) (device_id >= (BX_MAX_ATA_DEVICES + BX_MAX_SCSI_DEVICES + BX_MAX_AHCI_DEVICES))
108	#define VBOX_GET_VIRTIO_SCSI_DEVICE(device_id) (device_id - (BX_MAX_ATA_DEVICES + BX_MAX_SCSI_DEVICES + BX_MAX_AHCI_DEVICES))
109	#else
110	#define BX_MAX_VIRTIO_SCSI_DEVICES 0
111	#endif
112
113	#define BX_MAX_STORAGE_DEVICES (BX_MAX_ATA_DEVICES + BX_MAX_SCSI_DEVICES + BX_MAX_AHCI_DEVICES + BX_MAX_VIRTIO_SCSI_DEVICES)
114
115	/* Generic storage device types. These depend on the controller type and
116	* determine which device access routines should be called.
117	*/
118	enum dsk_type_enm {
119	DSK_TYPE_NONE, /* Unknown device. */
120	DSK_TYPE_UNKNOWN, /* Unknown ATA device. */
121	DSK_TYPE_ATA, /* ATA disk. */
122	DSK_TYPE_ATAPI, /* ATAPI device. */
123	DSK_TYPE_SCSI, /* SCSI disk. */
124	DSK_TYPE_AHCI, /* SATA disk via AHCI. */
125	DSKTYP_CNT /* Number of disk types. */
126	};
127
128	/* Disk device types. */
129	//@todo: Do we really need these?
130	#define DSK_DEVICE_NONE 0x00 /* No device attached. */
131	#define DSK_DEVICE_HD 0xFF /* Device is a hard disk. */
132	#define DSK_DEVICE_CDROM 0x05 /* Device is a CD-ROM. */
133
134	/* Geometry translation modes. */
135	enum geo_xlat_enm {
136	GEO_TRANSLATION_NONE, /* No geometry translation. */
137	GEO_TRANSLATION_LBA, /* LBA translation. */
138	GEO_TRANSLATION_LARGE, /* Large CHS translation. */
139	GEO_TRANSLATION_RECHS
140	};
141
142	#if 1 //BX_USE_ATADRV
143
144	/* Note: The DPTE and FDPT structures are industry standards and
145	* may not be modified. The other disk-related structures are
146	* internal to the BIOS.
147	*/
148
149	/* Translated DPT (Device Parameter Table). */
150	typedef struct {
151	uint16_t iobase1;
152	uint16_t iobase2;
153	uint8_t prefix;
154	uint8_t unused;
155	uint8_t irq;
156	uint8_t blkcount;
157	uint8_t dma;
158	uint8_t pio;
159	uint16_t options;
160	uint16_t reserved;
161	uint8_t revision;
162	uint8_t checksum;
163	} dpte_t;
164
165	ct_assert(sizeof(dpte_t) == 16); /* Ensure correct size. */
166
167	#pragma pack(0)
168
169	/* FDPT - Fixed Disk Parameter Table. PC/AT compatible; note
170	* that this structure is slightly misaligned.
171	*/
172	typedef struct {
173	uint16_t lcyl;
174	uint8_t lhead;
175	uint8_t sig;
176	uint8_t spt;
177	uint32_t resvd1;
178	uint16_t cyl;
179	uint8_t head;
180	uint16_t resvd2;
181	uint8_t lspt;
182	uint8_t csum;
183	} fdpt_t;
184
185	#pragma pack()
186
187	ct_assert(sizeof(fdpt_t) == 16); /* Ensure correct size. */
188
189
190	/* C/H/S geometry information. */
191	typedef struct {
192	uint16_t heads; /* Number of heads. */
193	uint16_t cylinders; /* Number of cylinders. */
194	uint16_t spt; /* Number of sectors per track. */
195	} chs_t;
196
197	/* IDE/ATA specific device information. */
198	typedef struct {
199	uint8_t iface; /* ISA or PCI. */
200	uint8_t irq; /* IRQ (on the PIC). */
201	uint16_t iobase1; /* I/O base 1. */
202	uint16_t iobase2; /* I/O base 2. */
203	} ata_chan_t;
204
205	#ifdef VBOX_WITH_SCSI
206
207	/* SCSI specific device information. */
208	typedef struct {
209	uint16_t hba_seg; /* Segment of HBA driver data block. */
210	uint8_t idx_hba; /* The HBA driver to use. */
211	uint8_t target_id; /* Target ID. */
212	} scsi_dev_t;
213
214	#endif
215
216	#ifdef VBOX_WITH_AHCI
217
218	/* AHCI specific device information. */
219	typedef struct {
220	uint8_t port; /* SATA port. */
221	} ahci_dev_t;
222
223	#endif
224
225	/* Generic disk information. */
226	typedef struct {
227	uint8_t type; /* Device type (ATA/ATAPI/SCSI/none/unknown). */
228	uint8_t device; /* Detected type of attached device (HD/CD/none). */
229	uint8_t removable; /* Removable device flag. */
230	uint8_t lock; /* Lock count for removable devices. */
231	//@todo: ATA specific - move?
232	uint8_t mode; /* Transfer mode: PIO 16/32 bits - IRQ - ISADMA - PCIDMA. */
233	uint8_t translation; /* Type of geometry translation. */
234	uint16_t blksize; /* Disk block size. */
235	chs_t lchs; /* Logical CHS geometry. */
236	chs_t pchs; /* Physical CHS geometry. */
237	uint64_t sectors; /* Total sector count. */
238	} disk_dev_t;
239
240	/* A structure for passing disk request information around. This structure
241	* is designed for saving stack space. As BIOS requests cannot be overlapped,
242	* one such structure is sufficient.
243	*/
244	typedef struct {
245	uint64_t lba; /* Starting LBA. */
246	void __far buffer; / Read/write data buffer pointer. */
247	uint8_t dev_id; /* Device ID; index into devices array. */
248	uint16_t nsect; /* Number of sectors to be transferred. */
249	uint16_t sect_sz; /* Size of a sector in bytes. */
250	uint16_t cylinder; /* Starting cylinder (CHS only). */
251	uint16_t head; /* Starting head (CHS only). */
252	uint16_t sector; /* Starting sector (CHS only). */
253	uint16_t trsfsectors; /* Actual sectors transferred. */
254	uint32_t trsfbytes; /* Actual bytes transferred. */
255	} disk_req_t;
256
257	extern uint16_t ahci_cmd_packet(uint16_t device_id, uint8_t cmdlen, char __far *cmdbuf,
258	uint32_t length, uint8_t inout, char __far *buffer);
259	extern uint16_t scsi_cmd_packet(uint16_t device, uint8_t cmdlen, char __far *cmdbuf,
260	uint32_t length, uint8_t inout, char __far *buffer);
261	extern uint16_t ata_cmd_packet(uint16_t device, uint8_t cmdlen, char __far *cmdbuf,
262	uint32_t length, uint8_t inout, char __far *buffer);
263
264	extern uint16_t ata_soft_reset(uint16_t device);
265
266	/* All BIOS disk information. Disk-related code in the BIOS should not need
267	* anything outside of this structure.
268	*/
269	typedef struct {
270	disk_req_t drqp; /* Disk request packet. */
271
272	/* Bus-independent disk device information. */
273	disk_dev_t devices[BX_MAX_STORAGE_DEVICES];
274
275	uint8_t hdcount; /* Total number of BIOS disks. */
276	/* Map between (BIOS disk ID - 0x80) and ATA/SCSI/AHCI disks. */
277	uint8_t hdidmap[BX_MAX_STORAGE_DEVICES];
278
279	uint8_t cdcount; /* Number of CD-ROMs. */
280	/* Map between (BIOS CD-ROM ID - 0xE0) and ATA/SCSI/AHCI devices. */
281	uint8_t cdidmap[BX_MAX_STORAGE_DEVICES];
282
283	/* ATA bus-specific device information. */
284	ata_chan_t channels[BX_MAX_ATA_INTERFACES];
285
286	#ifdef VBOX_WITH_SCSI
287	/* SCSI bus-specific device information. */
288	scsi_dev_t scsidev[BX_MAX_SCSI_DEVICES];
289	uint8_t scsi_devcount; /* Number of SCSI devices. */
290	#endif
291
292	#ifdef VBOX_WITH_AHCI
293	/* SATA (AHCI) bus-specific device information. */
294	ahci_dev_t ahcidev[BX_MAX_AHCI_DEVICES];
295	uint8_t ahci_devcnt; /* Number of SATA devices. */
296	uint16_t ahci_seg; /* Segment of AHCI data block. */
297	#endif
298
299	dpte_t dpte; /* Buffer for building a DPTE. */
300	} bio_dsk_t;
301
302	#if BX_ELTORITO_BOOT
303	/* El Torito device emulation state. */
304	typedef struct {
305	uint8_t active;
306	uint8_t media;
307	uint8_t emulated_drive;
308	uint8_t controller_index;
309	uint16_t device_spec;
310	uint16_t buffer_segment;
311	uint32_t ilba;
312	uint16_t load_segment;
313	uint16_t sector_count;
314	chs_t vdevice; /* Virtual device geometry. */
315	uint8_t __far ptr_unaligned; / Bounce buffer for sector unaligned reads. */
316	} cdemu_t;
317	#endif
318
319	// for access to EBDA area
320	// The EBDA structure should conform to
321	// http://www.frontiernet.net/~fys/rombios.htm document
322	// I made the ata and cdemu structs begin at 0x121 in the EBDA seg
323	/* MS-DOS KEYB.COM may overwrite the word at offset 0x117 in the EBDA
324	* which contains the keyboard ID for PS/2 BIOSes.
325	*/
326	typedef struct {
327	uint8_t filler1[0x3D];
328
329	fdpt_t fdpt0; /* FDPTs for the first two ATA disks. */
330	fdpt_t fdpt1;
331
332	#ifndef VBOX_WITH_VIRTIO_SCSI /** @todo For development only, need to find a real solution to voercome the 1KB limit. */
333	uint8_t filler2[0xC4];
334	#endif
335
336	bio_dsk_t bdisk; /* Disk driver data (ATA/SCSI/AHCI). */
337
338	#if BX_ELTORITO_BOOT
339	cdemu_t cdemu; /* El Torito floppy/HD emulation data. */
340	#endif
341
342	unsigned char uForceBootDrive;
343	unsigned char uForceBootDevice;
344	} ebda_data_t;
345
346	ct_assert(sizeof(ebda_data_t) < 0x380); /* Must be under 1K in size. */
347
348	// the last 16 bytes of the EBDA segment are used for the MPS floating
349	// pointer structure (though only if an I/O APIC is present)
350
351	#define EbdaData ((ebda_data_t *) 0)
352
353	// for access to the int13ext structure
354	typedef struct {
355	uint8_t size;
356	uint8_t reserved;
357	uint16_t count;
358	uint16_t offset;
359	uint16_t segment;
360	uint32_t lba1;
361	uint32_t lba2;
362	} int13ext_t;
363
364	/* Disk Physical Table structure */
365	typedef struct {
366	uint16_t size;
367	uint16_t infos;
368	uint32_t cylinders;
369	uint32_t heads;
370	uint32_t spt;
371	uint32_t sector_count1;
372	uint32_t sector_count2;
373	uint16_t blksize;
374	uint16_t dpte_offset;
375	uint16_t dpte_segment;
376	uint16_t key;
377	uint8_t dpi_length;
378	uint8_t reserved1;
379	uint16_t reserved2;
380	uint8_t host_bus[4];
381	uint8_t iface_type[8];
382	uint8_t iface_path[8];
383	uint8_t device_path[8];
384	uint8_t reserved3;
385	uint8_t checksum;
386	} dpt_t;
387
388	/* Note: Using fastcall reduces stack usage a little. */
389	int __fastcall ata_read_sectors(bio_dsk_t __far *bios_dsk);
390	int __fastcall ata_write_sectors(bio_dsk_t __far *bios_dsk);
391
392	int __fastcall scsi_read_sectors(bio_dsk_t __far *bios_dsk);
393	int __fastcall scsi_write_sectors(bio_dsk_t __far *bios_dsk);
394
395	int __fastcall ahci_read_sectors(bio_dsk_t __far *bios_dsk);
396	int __fastcall ahci_write_sectors(bio_dsk_t __far *bios_dsk);
397
398	extern void set_geom_lba(chs_t __far *lgeo, uint64_t nsectors);
399	extern int edd_fill_dpt(dpt_t __far dpt, bio_dsk_t __far bios_dsk, uint8_t device);
400
401	// @todo: put this elsewhere (and change/eliminate?)
402	#define SET_DISK_RET_STATUS(status) write_byte(0x0040, 0x0074, status)
403
404	#endif
405	#endif /* !VBOX_INCLUDED_SRC_PC_BIOS_ebda_h */
406

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Devices/PC/BIOS/ebda.h@ 100658

Download in other formats: