ebda.h@ 89363

Last change on this file since 89363 was 89363, checked in by vboxsync, 3 years ago
Devices/PC/BIOS/eltorito.c: Don't use the skip_b, skip_a mechanism for accessing arbitrary 512 byte sectors inside a 2048 byte CD sector for the emulation code but rather chop up the transfer into at most 3 separate ones to handle unaligned cases. This enables cleanups in the device drivers which comes next, bugref:4841
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 13.7 KB

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

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

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

Download in other formats: