ahci.c

Last change on this file was 106071, checked in by vboxsync, 3 weeks ago
BIOS: Remove no longer needed DMA write workaround for floppy and AHCI.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 34.3 KB

Line
1	/* $Id: ahci.c 106071 2024-09-17 12:08:24Z vboxsync $ */
2	/** @file
3	* AHCI host adapter driver to boot from SATA disks.
4	*/
5
6	/*
7	* Copyright (C) 2011-2024 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	#include <stdint.h>
29	#include <string.h>
30	#include "biosint.h"
31	#include "ebda.h"
32	#include "inlines.h"
33	#include "pciutil.h"
34	#include "vds.h"
35
36	#if DEBUG_AHCI
37	# define DBG_AHCI(...) BX_INFO(__VA_ARGS__)
38	#else
39	# define DBG_AHCI(...)
40	#endif
41
42	/* Number of S/G table entries in EDDS. */
43	#define NUM_EDDS_SG 17
44
45
46	/**
47	* AHCI PRDT structure.
48	*/
49	typedef struct
50	{
51	uint32_t phys_addr;
52	uint32_t something;
53	uint32_t reserved;
54	uint32_t len;
55	} ahci_prdt;
56
57	/**
58	* SATA D2H FIS (Device to Host Frame Information Structure).
59	*/
60	typedef struct {
61	uint8_t fis_type; /* 34h */
62	uint8_t intr; /* Bit 6 indicates interrupt status. */
63	uint8_t status; /* Status register. */
64	uint8_t error; /* Error register. */
65	uint8_t sec_no; /* Sector number register. */
66	uint8_t cyl_lo; /* Cylinder low register. */
67	uint8_t cyl_hi; /* Cylinder high register. */
68	uint8_t dev_hd; /* Device/head register. */
69	uint8_t sec_no_exp; /* Expanded sector number register. */
70	uint8_t cyl_lo_exp; /* Expanded cylinder low register. */
71	uint8_t cyl_hi_exp; /* Expanded cylinder high register. */
72	uint8_t resvd0;
73	uint8_t sec_cn; /* Sector count register. */
74	uint8_t sec_cn_exp; /* Expanded sector count register. */
75	uint16_t resvd1;
76	uint32_t resvd2;
77	} fis_d2h;
78
79	ct_assert(sizeof(fis_d2h) == 20);
80
81	/**
82	* AHCI controller data.
83	*/
84	typedef struct
85	{
86	/** The AHCI command list as defined by chapter 4.2.2 of the Intel AHCI spec.
87	* Because the BIOS doesn't support NCQ only the first command header is defined
88	* to save memory. - Must be aligned on a 1K boundary.
89	*/
90	uint32_t aCmdHdr[0x8];
91	/** Align the next structure on a 128 byte boundary. */
92	uint8_t abAlignment1[0x60];
93	/** The command table of one request as defined by chapter 4.2.3 of the Intel AHCI spec.
94	* Must be aligned on 128 byte boundary.
95	*/
96	uint8_t abCmd[0x40];
97	/** The ATAPI command region.
98	* Located 40h bytes after the beginning of the CFIS (Command FIS).
99	*/
100	uint8_t abAcmd[0x20];
101	/** Align the PRDT structure on a 128 byte boundary. */
102	uint8_t abAlignment2[0x20];
103	/** Physical Region Descriptor Table (PRDT) array. In other
104	* words, a scatter/gather descriptor list.
105	*/
106	ahci_prdt aPrdt[16];
107	/** Memory for the received command FIS area as specified by chapter 4.2.1
108	* of the Intel AHCI spec. This area is normally 256 bytes big but to save memory
109	* only the first 96 bytes are used because it is assumed that the controller
110	* never writes to the UFIS or reserved area. - Must be aligned on a 256byte boundary.
111	*/
112	uint8_t abFisRecv[0x60];
113	/** Base I/O port for the index/data register pair. */
114	uint16_t iobase;
115	/** Current port which uses the memory to communicate with the controller. */
116	uint8_t cur_port;
117	/** Current PRD index (for pre/post skip). */
118	uint8_t cur_prd;
119	/** Saved high bits of EAX. */
120	uint16_t saved_eax_hi;
121	/** VDS EDDS DMA buffer descriptor structure. */
122	vds_edds edds;
123	vds_sg edds_more_sg[NUM_EDDS_SG - 1];
124	} ahci_t;
125
126	/* The AHCI specific data must fit into 1KB (statically allocated). */
127	ct_assert(sizeof(ahci_t) <= 1024);
128
129	/** PCI configuration fields. */
130	#define PCI_CONFIG_CAP 0x34
131
132	#define PCI_CAP_ID_SATACR 0x12
133	#define VBOX_AHCI_NO_DEVICE 0xffff
134
135	#define RT_BIT_32(bit) ((uint32_t)(1L << (bit)))
136
137	/** Global register set. */
138	#define AHCI_HBA_SIZE 0x100
139
140	/// @todo what are the casts good for?
141	#define AHCI_REG_CAP ((uint32_t)0x00)
142	#define AHCI_REG_GHC ((uint32_t)0x04)
143	# define AHCI_GHC_AE RT_BIT_32(31)
144	# define AHCI_GHC_IR RT_BIT_32(1)
145	# define AHCI_GHC_HR RT_BIT_32(0)
146	#define AHCI_REG_IS ((uint32_t)0x08)
147	#define AHCI_REG_PI ((uint32_t)0x0c)
148	#define AHCI_REG_VS ((uint32_t)0x10)
149
150	/** Per port register set. */
151	#define AHCI_PORT_SIZE 0x80
152
153	#define AHCI_REG_PORT_CLB 0x00
154	#define AHCI_REG_PORT_CLBU 0x04
155	#define AHCI_REG_PORT_FB 0x08
156	#define AHCI_REG_PORT_FBU 0x0c
157	#define AHCI_REG_PORT_IS 0x10
158	# define AHCI_REG_PORT_IS_DHRS RT_BIT_32(0)
159	# define AHCI_REG_PORT_IS_TFES RT_BIT_32(30)
160	#define AHCI_REG_PORT_IE 0x14
161	#define AHCI_REG_PORT_CMD 0x18
162	# define AHCI_REG_PORT_CMD_ST RT_BIT_32(0)
163	# define AHCI_REG_PORT_CMD_FRE RT_BIT_32(4)
164	# define AHCI_REG_PORT_CMD_FR RT_BIT_32(14)
165	# define AHCI_REG_PORT_CMD_CR RT_BIT_32(15)
166	#define AHCI_REG_PORT_TFD 0x20
167	#define AHCI_REG_PORT_SIG 0x24
168	#define AHCI_REG_PORT_SSTS 0x28
169	#define AHCI_REG_PORT_SCTL 0x2c
170	#define AHCI_REG_PORT_SERR 0x30
171	#define AHCI_REG_PORT_SACT 0x34
172	#define AHCI_REG_PORT_CI 0x38
173
174	/** Returns the absolute register offset from a given port and port register. */
175	#define AHCI_PORT_REG(port, reg) (AHCI_HBA_SIZE + (port) * AHCI_PORT_SIZE + (reg))
176
177	#define AHCI_REG_IDX 0
178	#define AHCI_REG_DATA 4
179
180	/** Writes the given value to a AHCI register. */
181	#define AHCI_WRITE_REG(iobase, reg, val) \
182	outpd((iobase) + AHCI_REG_IDX, reg); \
183	outpd((iobase) + AHCI_REG_DATA, val)
184
185	/** Reads from a AHCI register. */
186	#define AHCI_READ_REG(iobase, reg, val) \
187	outpd((iobase) + AHCI_REG_IDX, reg); \
188	(val) = inpd((iobase) + AHCI_REG_DATA)
189
190	/** Writes to the given port register. */
191	#define VBOXAHCI_PORT_WRITE_REG(iobase, port, reg, val) \
192	AHCI_WRITE_REG((iobase), AHCI_PORT_REG((port), (reg)), val)
193
194	/** Reads from the given port register. */
195	#define VBOXAHCI_PORT_READ_REG(iobase, port, reg, val) \
196	AHCI_READ_REG((iobase), AHCI_PORT_REG((port), (reg)), val)
197
198	#define ATA_CMD_IDENTIFY_DEVICE 0xEC
199	#define ATA_CMD_IDENTIFY_PACKET 0xA1
200	#define ATA_CMD_PACKET 0xA0
201	#define AHCI_CMD_READ_DMA_EXT 0x25
202	#define AHCI_CMD_WRITE_DMA_EXT 0x35
203
204
205	/* Warning: Destroys high bits of EAX. */
206	uint32_t inpd(uint16_t port);
207	#pragma aux inpd = \
208	".386" \
209	"in eax, dx" \
210	"mov dx, ax" \
211	"shr eax, 16" \
212	"xchg ax, dx" \
213	parm [dx] value [dx ax] modify nomemory;
214
215	/* Warning: Destroys high bits of EAX. */
216	void outpd(uint16_t port, uint32_t val);
217	#pragma aux outpd = \
218	".386" \
219	"xchg ax, cx" \
220	"shl eax, 16" \
221	"mov ax, cx" \
222	"out dx, eax" \
223	parm [dx] [cx ax] modify nomemory;
224
225
226	/* Machinery to save/restore high bits of EAX. 32-bit port I/O needs to use
227	* EAX, but saving/restoring EAX around each port access would be inefficient.
228	* Instead, each externally callable routine must save the high bits before
229	* modifying them and restore the high bits before exiting.
230	*/
231
232	/* Note: Reading high EAX bits destroys them - must be restored later. */
233	uint16_t eax_hi_rd(void);
234	#pragma aux eax_hi_rd = \
235	".386" \
236	"shr eax, 16" \
237	value [ax] modify nomemory;
238
239	void eax_hi_wr(uint16_t);
240	#pragma aux eax_hi_wr = \
241	".386" \
242	"shl eax, 16" \
243	parm [ax] modify nomemory;
244
245	void inline high_bits_save(ahci_t __far *ahci)
246	{
247	ahci->saved_eax_hi = eax_hi_rd();
248	}
249
250	void inline high_bits_restore(ahci_t __far *ahci)
251	{
252	eax_hi_wr(ahci->saved_eax_hi);
253	}
254
255	/**
256	* Sets a given set of bits in a register.
257	*/
258	static void inline ahci_ctrl_set_bits(uint16_t iobase, uint16_t reg, uint32_t mask)
259	{
260	outpd(iobase + AHCI_REG_IDX, reg);
261	outpd(iobase + AHCI_REG_DATA, inpd(iobase + AHCI_REG_DATA) \| mask);
262	}
263
264	/**
265	* Clears a given set of bits in a register.
266	*/
267	static void inline ahci_ctrl_clear_bits(uint16_t iobase, uint16_t reg, uint32_t mask)
268	{
269	outpd(iobase + AHCI_REG_IDX, reg);
270	outpd(iobase + AHCI_REG_DATA, inpd(iobase + AHCI_REG_DATA) & ~mask);
271	}
272
273	/**
274	* Returns whether at least one of the bits in the given mask is set
275	* for a register.
276	*/
277	static uint8_t inline ahci_ctrl_is_bit_set(uint16_t iobase, uint16_t reg, uint32_t mask)
278	{
279	outpd(iobase + AHCI_REG_IDX, reg);
280	return (inpd(iobase + AHCI_REG_DATA) & mask) != 0;
281	}
282
283	/**
284	* Extracts a range of bits from a register and shifts them
285	* to the right.
286	*/
287	static uint16_t ahci_ctrl_extract_bits(uint32_t val, uint32_t mask, uint8_t shift)
288	{
289	return (val & mask) >> shift;
290	}
291
292	/**
293	* Converts a segment:offset pair into a 32bit physical address.
294	*/
295	static uint32_t ahci_addr_to_phys(void __far *ptr)
296	{
297	return ((uint32_t)FP_SEG(ptr) << 4) + FP_OFF(ptr);
298	}
299
300	/**
301	* Issues a command to the SATA controller and waits for completion.
302	*/
303	static void ahci_port_cmd_sync(ahci_t __far *ahci, uint8_t val)
304	{
305	uint16_t io_base;
306	uint8_t port;
307
308	port = ahci->cur_port;
309	io_base = ahci->iobase;
310
311	if (port != 0xff)
312	{
313	/* Prepare the command header. */
314	ahci->aCmdHdr[0] = ((uint32_t)ahci->cur_prd << 16) \| RT_BIT_32(7) \| val;
315	ahci->aCmdHdr[1] = 0;
316	ahci->aCmdHdr[2] = ahci_addr_to_phys(&ahci->abCmd[0]);
317
318	/* Enable Command and FIS receive engine. */
319	ahci_ctrl_set_bits(io_base, AHCI_PORT_REG(port, AHCI_REG_PORT_CMD),
320	AHCI_REG_PORT_CMD_FRE \| AHCI_REG_PORT_CMD_ST);
321
322	/* Queue command. */
323	VBOXAHCI_PORT_WRITE_REG(io_base, port, AHCI_REG_PORT_CI, 0x1);
324
325	/* Wait for a D2H FIS. */
326	DBG_AHCI("AHCI: Waiting for D2H FIS\n");
327	while (ahci_ctrl_is_bit_set(io_base, AHCI_PORT_REG(port, AHCI_REG_PORT_IS),
328	AHCI_REG_PORT_IS_DHRS \| AHCI_REG_PORT_IS_TFES) == 0)
329	{
330	// This is where we'd need some kind of a yield functionality...
331	}
332
333	ahci_ctrl_set_bits(io_base, AHCI_PORT_REG(port, AHCI_REG_PORT_IS),
334	AHCI_REG_PORT_IS_DHRS); /* Acknowledge received D2H FIS. */
335
336	/* Disable command engine. */
337	ahci_ctrl_clear_bits(io_base, AHCI_PORT_REG(port, AHCI_REG_PORT_CMD),
338	AHCI_REG_PORT_CMD_ST);
339	/* Caller must examine status. */
340	}
341	else
342	DBG_AHCI("AHCI: Invalid port given\n");
343	}
344
345	/**
346	* Issue command to device.
347	*/
348	static uint16_t ahci_cmd_data(bio_dsk_t __far *bios_dsk, uint8_t cmd)
349	{
350	ahci_t __far *ahci = bios_dsk->ahci_seg :> 0;
351	uint16_t n_sect = bios_dsk->drqp.nsect;
352	uint16_t sectsz = bios_dsk->drqp.sect_sz;
353	fis_d2h __far *d2h;
354	int i;
355
356	DBG_AHCI("AHCI: Data block at %04X:%04X\n", FP_SEG(ahci), FP_OFF(ahci));
357	_fmemset(&ahci->abCmd[0], 0, sizeof(ahci->abCmd));
358
359	/* Prepare the FIS. */
360	ahci->abCmd[0] = 0x27; /* FIS type H2D. */
361	ahci->abCmd[1] = 1 << 7; /* Command update. */
362	ahci->abCmd[2] = cmd;
363	ahci->abCmd[3] = 0;
364
365	ahci->abCmd[4] = bios_dsk->drqp.lba & 0xff;
366	ahci->abCmd[5] = (bios_dsk->drqp.lba >> 8) & 0xff;
367	ahci->abCmd[6] = (bios_dsk->drqp.lba >> 16) & 0xff;
368	ahci->abCmd[7] = RT_BIT_32(6); /* LBA access. */
369
370	ahci->abCmd[8] = (bios_dsk->drqp.lba >> 24) & 0xff;
371	ahci->abCmd[9] = (bios_dsk->drqp.lba >> 32) & 0xff;
372	ahci->abCmd[10] = (bios_dsk->drqp.lba >> 40) & 0xff;
373	ahci->abCmd[11] = 0;
374
375	ahci->abCmd[12] = (uint8_t)(n_sect & 0xff);
376	ahci->abCmd[13] = (uint8_t)((n_sect >> 8) & 0xff);
377
378	/* Lock memory needed for DMA. */
379	ahci->edds.num_avail = NUM_EDDS_SG;
380	DBG_AHCI("AHCI: S/G list for %lu bytes\n", (uint32_t)n_sect * sectsz);
381	vds_build_sg_list(&ahci->edds, bios_dsk->drqp.buffer, (uint32_t)n_sect * sectsz);
382
383	/* Set up the PRDT. */
384	for (i = 0; i < ahci->edds.num_used; ++i)
385	{
386	ahci->aPrdt[ahci->cur_prd].len = ahci->edds.u.sg[i].size - 1;
387	ahci->aPrdt[ahci->cur_prd].phys_addr = ahci->edds.u.sg[i].phys_addr;
388	++ahci->cur_prd;
389	}
390
391	#if DEBUG_AHCI
392	{
393	uint16_t prdt_idx;
394
395	for (prdt_idx = 0; prdt_idx < ahci->cur_prd; ++prdt_idx) {
396	DBG_AHCI("S/G entry %u: %5lu bytes @ %08lX\n", prdt_idx,
397	ahci->aPrdt[prdt_idx].len + 1, ahci->aPrdt[prdt_idx].phys_addr);
398	}
399	}
400	#endif
401
402	/* Build variable part of first command DWORD (reuses 'cmd'). */
403	if (cmd == AHCI_CMD_WRITE_DMA_EXT)
404	cmd = RT_BIT_32(6); /* Indicate a write to device. */
405	else if (cmd == ATA_CMD_PACKET) {
406	cmd \|= RT_BIT_32(5); /* Indicate ATAPI command. */
407	ahci->abCmd[3] \|= 1; /* DMA transfers. */
408	} else
409	cmd = 0;
410
411	cmd \|= 5; /* Five DWORDs. */
412
413	ahci_port_cmd_sync(ahci, cmd);
414
415	/* Examine operation status. */
416	d2h = (void __far *)&ahci->abFisRecv[0x40];
417	DBG_AHCI("AHCI: ERR=%02x, STAT=%02x, SCNT=%02x\n", d2h->error, d2h->status, d2h->sec_cn);
418
419	/* Unlock the buffer again. */
420	vds_free_sg_list(&ahci->edds);
421	return d2h->error ? 4 : 0;
422	}
423
424	/**
425	* Deinits the curent active port.
426	*/
427	static void ahci_port_deinit_current(ahci_t __far *ahci)
428	{
429	uint16_t io_base;
430	uint8_t port;
431
432	io_base = ahci->iobase;
433	port = ahci->cur_port;
434
435	if (port != 0xff)
436	{
437	/* Put the port into an idle state. */
438	ahci_ctrl_clear_bits(io_base, AHCI_PORT_REG(port, AHCI_REG_PORT_CMD),
439	AHCI_REG_PORT_CMD_FRE \| AHCI_REG_PORT_CMD_ST);
440
441	while (ahci_ctrl_is_bit_set(io_base, AHCI_PORT_REG(port, AHCI_REG_PORT_CMD),
442	AHCI_REG_PORT_CMD_FRE \| AHCI_REG_PORT_CMD_ST \| AHCI_REG_PORT_CMD_FR \| AHCI_REG_PORT_CMD_CR) == 1)
443	{
444	DBG_AHCI("AHCI: Waiting for the port to idle\n");
445	}
446
447	/*
448	* Port idles, set up memory for commands and received FIS and program the
449	* address registers.
450	*/
451	/// @todo merge memsets?
452	_fmemset(&ahci->aCmdHdr[0], 0, sizeof(ahci->aCmdHdr));
453	_fmemset(&ahci->abCmd[0], 0, sizeof(ahci->abCmd));
454	_fmemset(&ahci->abFisRecv[0], 0, sizeof(ahci->abFisRecv));
455
456	VBOXAHCI_PORT_WRITE_REG(io_base, port, AHCI_REG_PORT_FB, 0);
457	VBOXAHCI_PORT_WRITE_REG(io_base, port, AHCI_REG_PORT_FBU, 0);
458
459	VBOXAHCI_PORT_WRITE_REG(io_base, port, AHCI_REG_PORT_CLB, 0);
460	VBOXAHCI_PORT_WRITE_REG(io_base, port, AHCI_REG_PORT_CLBU, 0);
461
462	/* Disable all interrupts. */
463	VBOXAHCI_PORT_WRITE_REG(io_base, port, AHCI_REG_PORT_IE, 0);
464
465	ahci->cur_port = 0xff;
466	}
467	}
468
469	/**
470	* Brings a port into a minimal state to make device detection possible
471	* or to queue requests.
472	*/
473	static void ahci_port_init(ahci_t __far *ahci, uint8_t u8Port)
474	{
475	/* Deinit any other port first. */
476	ahci_port_deinit_current(ahci);
477
478	/* Put the port into an idle state. */
479	ahci_ctrl_clear_bits(ahci->iobase, AHCI_PORT_REG(u8Port, AHCI_REG_PORT_CMD),
480	AHCI_REG_PORT_CMD_FRE \| AHCI_REG_PORT_CMD_ST);
481
482	while (ahci_ctrl_is_bit_set(ahci->iobase, AHCI_PORT_REG(u8Port, AHCI_REG_PORT_CMD),
483	AHCI_REG_PORT_CMD_FRE \| AHCI_REG_PORT_CMD_ST \| AHCI_REG_PORT_CMD_FR \| AHCI_REG_PORT_CMD_CR) == 1)
484	{
485	DBG_AHCI("AHCI: Waiting for the port to idle\n");
486	}
487
488	/*
489	* Port idles, set up memory for commands and received FIS and program the
490	* address registers.
491	*/
492	/// @todo just one memset?
493	_fmemset(&ahci->aCmdHdr[0], 0, sizeof(ahci->aCmdHdr));
494	_fmemset(&ahci->abCmd[0], 0, sizeof(ahci->abCmd));
495	_fmemset(&ahci->abFisRecv[0], 0, sizeof(ahci->abFisRecv));
496
497	DBG_AHCI("AHCI: FIS receive area %lx from %x:%x\n",
498	ahci_addr_to_phys(&ahci->abFisRecv), FP_SEG(&ahci->abFisRecv), FP_OFF(&ahci->abFisRecv));
499	VBOXAHCI_PORT_WRITE_REG(ahci->iobase, u8Port, AHCI_REG_PORT_FB, ahci_addr_to_phys(&ahci->abFisRecv));
500	VBOXAHCI_PORT_WRITE_REG(ahci->iobase, u8Port, AHCI_REG_PORT_FBU, 0);
501
502	DBG_AHCI("AHCI: CMD list area %lx\n", ahci_addr_to_phys(&ahci->aCmdHdr));
503	VBOXAHCI_PORT_WRITE_REG(ahci->iobase, u8Port, AHCI_REG_PORT_CLB, ahci_addr_to_phys(&ahci->aCmdHdr));
504	VBOXAHCI_PORT_WRITE_REG(ahci->iobase, u8Port, AHCI_REG_PORT_CLBU, 0);
505
506	/* Disable all interrupts. */
507	VBOXAHCI_PORT_WRITE_REG(ahci->iobase, u8Port, AHCI_REG_PORT_IE, 0);
508	VBOXAHCI_PORT_WRITE_REG(ahci->iobase, u8Port, AHCI_REG_PORT_IS, 0xffffffff);
509	/* Clear all errors. */
510	VBOXAHCI_PORT_WRITE_REG(ahci->iobase, u8Port, AHCI_REG_PORT_SERR, 0xffffffff);
511
512	ahci->cur_port = u8Port;
513	ahci->cur_prd = 0;
514	}
515
516	/**
517	* Read sectors from an attached AHCI device.
518	*
519	* @returns status code.
520	* @param bios_dsk Pointer to disk request packet (in the
521	* EBDA).
522	*/
523	int ahci_read_sectors(bio_dsk_t __far *bios_dsk)
524	{
525	uint16_t device_id;
526	uint16_t rc;
527
528	device_id = VBOX_GET_AHCI_DEVICE(bios_dsk->drqp.dev_id);
529	if (device_id > BX_MAX_AHCI_DEVICES)
530	BX_PANIC("%s: device_id out of range %d\n", __func__, device_id);
531
532	DBG_AHCI("%s: %u sectors @ LBA 0x%llx, device %d, port %d\n", __func__,
533	bios_dsk->drqp.nsect, bios_dsk->drqp.lba,
534	device_id, bios_dsk->ahcidev[device_id].port);
535
536	high_bits_save(bios_dsk->ahci_seg :> 0);
537	ahci_port_init(bios_dsk->ahci_seg :> 0, bios_dsk->ahcidev[device_id].port);
538	rc = ahci_cmd_data(bios_dsk, AHCI_CMD_READ_DMA_EXT);
539	DBG_AHCI("%s: transferred %lu bytes\n", __func__, ((ahci_t __far *)(bios_dsk->ahci_seg :> 0))->aCmdHdr[1]);
540	bios_dsk->drqp.trsfsectors = bios_dsk->drqp.nsect;
541	high_bits_restore(bios_dsk->ahci_seg :> 0);
542	return rc;
543	}
544
545	/**
546	* Write sectors to an attached AHCI device.
547	*
548	* @returns status code.
549	* @param bios_dsk Pointer to disk request packet (in the
550	* EBDA).
551	*/
552	int ahci_write_sectors(bio_dsk_t __far *bios_dsk)
553	{
554	uint16_t device_id;
555	uint16_t rc;
556
557	device_id = VBOX_GET_AHCI_DEVICE(bios_dsk->drqp.dev_id);
558	if (device_id > BX_MAX_AHCI_DEVICES)
559	BX_PANIC("%s: device_id out of range %d\n", __func__, device_id);
560
561	DBG_AHCI("%s: %u sectors @ LBA 0x%llx, device %d, port %d\n", __func__,
562	bios_dsk->drqp.nsect, bios_dsk->drqp.lba, device_id,
563	bios_dsk->ahcidev[device_id].port);
564
565	high_bits_save(bios_dsk->ahci_seg :> 0);
566	ahci_port_init(bios_dsk->ahci_seg :> 0, bios_dsk->ahcidev[device_id].port);
567	rc = ahci_cmd_data(bios_dsk, AHCI_CMD_WRITE_DMA_EXT);
568	DBG_AHCI("%s: transferred %lu bytes\n", __func__, ((ahci_t __far *)(bios_dsk->ahci_seg :> 0))->aCmdHdr[1]);
569	bios_dsk->drqp.trsfsectors = bios_dsk->drqp.nsect;
570	high_bits_restore(bios_dsk->ahci_seg :> 0);
571	return rc;
572	}
573
574	/// @todo move
575	#define ATA_DATA_NO 0x00
576	#define ATA_DATA_IN 0x01
577	#define ATA_DATA_OUT 0x02
578
579	uint16_t ahci_cmd_packet(uint16_t device_id, uint8_t cmdlen, char __far *cmdbuf,
580	uint32_t length, uint8_t inout, char __far *buffer)
581	{
582	bio_dsk_t __far *bios_dsk = read_word(0x0040, 0x000E) :> &EbdaData->bdisk;
583	ahci_t __far *ahci;
584
585	/* Data out is currently not supported. */
586	if (inout == ATA_DATA_OUT) {
587	BX_INFO("%s: DATA_OUT not supported yet\n", __func__);
588	return 1;
589	}
590
591	/* Convert to AHCI specific device number. */
592	device_id = VBOX_GET_AHCI_DEVICE(device_id);
593
594	DBG_AHCI("%s: reading %lu bytes, device %d, port %d\n", __func__,
595	length, device_id, bios_dsk->ahcidev[device_id].port);
596	DBG_AHCI("%s: reading %u %u-byte sectors\n", __func__,
597	bios_dsk->drqp.nsect, bios_dsk->drqp.sect_sz);
598
599	bios_dsk->drqp.lba = length << 8; /// @todo xfer length limit
600	bios_dsk->drqp.buffer = buffer;
601	bios_dsk->drqp.nsect = length / bios_dsk->drqp.sect_sz;
602	// bios_dsk->drqp.sect_sz = 2048;
603
604	ahci = bios_dsk->ahci_seg :> 0;
605	high_bits_save(ahci);
606
607	ahci_port_init(bios_dsk->ahci_seg :> 0, bios_dsk->ahcidev[device_id].port);
608
609	/* Copy the ATAPI command where the HBA can fetch it. */
610	_fmemcpy(ahci->abAcmd, cmdbuf, cmdlen);
611
612	/* Reset transferred counts. */
613	/// @todo clear in calling code?
614	bios_dsk->drqp.trsfsectors = 0;
615	bios_dsk->drqp.trsfbytes = 0;
616
617	ahci_cmd_data(bios_dsk, ATA_CMD_PACKET);
618	DBG_AHCI("%s: transferred %lu bytes\n", __func__, ahci->aCmdHdr[1]);
619	bios_dsk->drqp.trsfbytes = ahci->aCmdHdr[1];
620	high_bits_restore(ahci);
621
622	return ahci->aCmdHdr[1] == 0 ? 4 : 0;
623	}
624
625	void ahci_port_detect_device(ahci_t __far *ahci, uint8_t u8Port)
626	{
627	uint32_t val;
628	bio_dsk_t __far *bios_dsk;
629	volatile uint32_t __far *ticks;
630	uint32_t end_tick;
631	int device_found = 0;
632
633	ahci_port_init(ahci, u8Port);
634
635	bios_dsk = read_word(0x0040, 0x000E) :> &EbdaData->bdisk;
636
637	/* Reset connection. */
638	VBOXAHCI_PORT_WRITE_REG(ahci->iobase, u8Port, AHCI_REG_PORT_SCTL, 0x01);
639	/*
640	* According to the spec we should wait at least 1msec until the reset
641	* is cleared but this is a virtual controller so we don't have to.
642	*/
643	VBOXAHCI_PORT_WRITE_REG(ahci->iobase, u8Port, AHCI_REG_PORT_SCTL, 0);
644
645	/*
646	* We do however have to wait for the device to initialize (the port reset
647	* to complete). That can take up to 10ms according to the SATA spec (device
648	* must send COMINIT within 10ms of COMRESET). We should be generous with
649	* the wait because in the typical case there are no ports without a device
650	* attached.
651	*/
652	ticks = MK_FP( 0x40, 0x6C );
653	end_tick = ticks + 3; / Wait up to five BIOS ticks, something in 150ms range. */
654
655	while( *ticks < end_tick )
656	{
657	/* If PxSSTS.DET is 3, everything went fine. */
658	VBOXAHCI_PORT_READ_REG(ahci->iobase, u8Port, AHCI_REG_PORT_SSTS, val);
659	if (ahci_ctrl_extract_bits(val, 0xfL, 0) == 3) {
660	device_found = 1;
661	break;
662	}
663	}
664
665	/* Timed out, no device detected. */
666	if (!device_found) {
667	DBG_AHCI("AHCI: Timed out, no device detected on port %d\n", u8Port);
668	return;
669	}
670
671	if (ahci_ctrl_extract_bits(val, 0xfL, 0) == 0x3)
672	{
673	uint8_t abBuffer[0x0200];
674	uint8_t hdcount, devcount_ahci, hd_index;
675	uint8_t cdcount;
676	uint8_t removable;
677
678	/* Clear all errors after the reset. */
679	VBOXAHCI_PORT_WRITE_REG(ahci->iobase, u8Port, AHCI_REG_PORT_SERR, 0xffffffff);
680
681	devcount_ahci = bios_dsk->ahci_devcnt;
682
683	DBG_AHCI("AHCI: Device detected on port %d\n", u8Port);
684
685	/// @todo Merge common HD/CDROM detection code
686	if (devcount_ahci < BX_MAX_AHCI_DEVICES)
687	{
688	/* Device detected, enable FIS receive. */
689	ahci_ctrl_set_bits(ahci->iobase, AHCI_PORT_REG(u8Port, AHCI_REG_PORT_CMD),
690	AHCI_REG_PORT_CMD_FRE);
691
692	/* Check signature to determine device type. */
693	VBOXAHCI_PORT_READ_REG(ahci->iobase, u8Port, AHCI_REG_PORT_SIG, val);
694	if (val == 0x101)
695	{
696	uint64_t sectors;
697	uint16_t cylinders, heads, spt;
698	chs_t lgeo;
699	uint8_t idxCmosChsBase;
700
701	DBG_AHCI("AHCI: Detected hard disk\n");
702
703	/* Identify device. */
704	bios_dsk->drqp.lba = 0;
705	bios_dsk->drqp.buffer = &abBuffer;
706	bios_dsk->drqp.nsect = 1;
707	bios_dsk->drqp.sect_sz = 512;
708	ahci_cmd_data(bios_dsk, ATA_CMD_IDENTIFY_DEVICE);
709
710	/* Calculate index into the generic device table. */
711	hd_index = devcount_ahci + BX_MAX_ATA_DEVICES + BX_MAX_SCSI_DEVICES;
712
713	removable = *(abBuffer+0) & 0x80 ? 1 : 0;
714	cylinders = (uint16_t )(abBuffer+(1*2)); // word 1
715	heads = (uint16_t )(abBuffer+(3*2)); // word 3
716	spt = (uint16_t )(abBuffer+(6*2)); // word 6
717	sectors = (uint32_t )(abBuffer+(60*2)); // word 60 and word 61
718
719	if (sectors == 0x0FFFFFFF) /* For disks bigger than ~128GB */
720	sectors = (uint64_t )(abBuffer+(100*2)); // words 100 to 103
721
722	DBG_AHCI("AHCI: 0x%llx sectors\n", sectors);
723
724	bios_dsk->ahcidev[devcount_ahci].port = u8Port;
725	bios_dsk->devices[hd_index].type = DSK_TYPE_AHCI;
726	bios_dsk->devices[hd_index].device = DSK_DEVICE_HD;
727	bios_dsk->devices[hd_index].removable = removable;
728	bios_dsk->devices[hd_index].lock = 0;
729	bios_dsk->devices[hd_index].blksize = 512;
730	bios_dsk->devices[hd_index].translation = GEO_TRANSLATION_LBA;
731	bios_dsk->devices[hd_index].sectors = sectors;
732
733	bios_dsk->devices[hd_index].pchs.heads = heads;
734	bios_dsk->devices[hd_index].pchs.cylinders = cylinders;
735	bios_dsk->devices[hd_index].pchs.spt = spt;
736
737	/* Get logical CHS geometry. */
738	switch (devcount_ahci)
739	{
740	case 0:
741	idxCmosChsBase = 0x40;
742	break;
743	case 1:
744	idxCmosChsBase = 0x48;
745	break;
746	case 2:
747	idxCmosChsBase = 0x50;
748	break;
749	case 3:
750	idxCmosChsBase = 0x58;
751	break;
752	default:
753	idxCmosChsBase = 0;
754	}
755	if (idxCmosChsBase && inb_cmos(idxCmosChsBase+7))
756	{
757	lgeo.cylinders = get_cmos_word(idxCmosChsBase /, idxCmosChsBase+1/);
758	lgeo.heads = inb_cmos(idxCmosChsBase + 2);
759	lgeo.spt = inb_cmos(idxCmosChsBase + 7);
760	}
761	else
762	set_geom_lba(&lgeo, sectors); /* Default EDD-style translated LBA geometry. */
763
764	BX_INFO("AHCI %d-P#%d: PCHS=%u/%u/%u LCHS=%u/%u/%u 0x%llx sectors\n", devcount_ahci,
765	u8Port, cylinders, heads, spt, lgeo.cylinders, lgeo.heads, lgeo.spt,
766	sectors);
767
768	bios_dsk->devices[hd_index].lchs = lgeo;
769
770	/* Store the ID of the disk in the BIOS hdidmap. */
771	hdcount = bios_dsk->hdcount;
772	bios_dsk->hdidmap[hdcount] = devcount_ahci + BX_MAX_ATA_DEVICES + BX_MAX_SCSI_DEVICES;
773	hdcount++;
774	bios_dsk->hdcount = hdcount;
775
776	/* Update hdcount in the BDA. */
777	hdcount = read_byte(0x40, 0x75);
778	hdcount++;
779	write_byte(0x40, 0x75, hdcount);
780	}
781	else if (val == 0xeb140101)
782	{
783	DBG_AHCI("AHCI: Detected ATAPI device\n");
784
785	/* Identify packet device. */
786	bios_dsk->drqp.lba = 0;
787	bios_dsk->drqp.buffer = &abBuffer;
788	bios_dsk->drqp.nsect = 1;
789	bios_dsk->drqp.sect_sz = 512;
790	ahci_cmd_data(bios_dsk, ATA_CMD_IDENTIFY_PACKET);
791
792	/* Calculate index into the generic device table. */
793	hd_index = devcount_ahci + BX_MAX_ATA_DEVICES + BX_MAX_SCSI_DEVICES;
794
795	removable = *(abBuffer+0) & 0x80 ? 1 : 0;
796
797	bios_dsk->ahcidev[devcount_ahci].port = u8Port;
798	bios_dsk->devices[hd_index].type = DSK_TYPE_AHCI;
799	bios_dsk->devices[hd_index].device = DSK_DEVICE_CDROM;
800	bios_dsk->devices[hd_index].removable = removable;
801	bios_dsk->devices[hd_index].blksize = 2048;
802	bios_dsk->devices[hd_index].translation = GEO_TRANSLATION_NONE;
803
804	/* Store the ID of the device in the BIOS cdidmap. */
805	cdcount = bios_dsk->cdcount;
806	bios_dsk->cdidmap[cdcount] = devcount_ahci + BX_MAX_ATA_DEVICES + BX_MAX_SCSI_DEVICES;
807	cdcount++;
808	bios_dsk->cdcount = cdcount;
809	}
810	else
811	DBG_AHCI("AHCI: Ignoring unknown device\n");
812
813	devcount_ahci++;
814	bios_dsk->ahci_devcnt = devcount_ahci;
815	}
816	else
817	DBG_AHCI("AHCI: Reached maximum device count, skipping\n");
818	}
819	}
820
821	/**
822	* Initializes the AHCI HBA and detects attached devices.
823	*/
824	static int ahci_hba_init(uint16_t io_base)
825	{
826	uint8_t i, cPorts;
827	uint32_t val;
828	uint16_t ebda_seg;
829	uint16_t ahci_seg;
830	bio_dsk_t __far *bios_dsk;
831	ahci_t __far *ahci;
832
833	/* Allocate 1K of base memory (this will move the EBDA).
834	* NB: The AHCI memory block must be 1K aligned. If the EBDA
835	* gets relocated, it will land on a paragraph aligned boundary;
836	* therefore the memory is allocated outside of the EBDA.
837	*/
838	ahci_seg = conv_mem_alloc(1/KB/, 0/in_ebda/);
839	if (ahci_seg == 0)
840	{
841	DBG_AHCI("AHCI: Could not allocate 1K of memory\n");
842	return 0;
843	}
844
845	ebda_seg = read_word(0x0040, 0x000E);
846	bios_dsk = ebda_seg :> &EbdaData->bdisk;
847
848	AHCI_READ_REG(io_base, AHCI_REG_VS, val);
849	DBG_AHCI("AHCI: Controller version: 0x%x (major) 0x%x (minor)\n",
850	ahci_ctrl_extract_bits(val, 0xffff0000, 16),
851	ahci_ctrl_extract_bits(val, 0x0000ffff, 0));
852
853	bios_dsk->ahci_seg = ahci_seg;
854	bios_dsk->ahci_devcnt = 0;
855
856	DBG_AHCI("AHCI: ahci_seg=%04x, size=%04x, pointer at EBDA:%04x (EBDA size=%04x)\n",
857	bios_dsk->ahci_seg, sizeof(ahci_t), (uint16_t)&EbdaData->bdisk.ahci_seg, sizeof(ebda_data_t));
858
859	ahci = ahci_seg :> 0;
860	ahci->cur_port = 0xff;
861	ahci->iobase = io_base;
862
863	/* Reset the controller. */
864	ahci_ctrl_set_bits(io_base, AHCI_REG_GHC, AHCI_GHC_HR);
865	do
866	{
867	AHCI_READ_REG(io_base, AHCI_REG_GHC, val);
868	} while ((val & AHCI_GHC_HR) != 0);
869
870	AHCI_READ_REG(io_base, AHCI_REG_CAP, val);
871	cPorts = ahci_ctrl_extract_bits(val, 0x1f, 0) + 1; /* Extract number of ports.*/
872
873	DBG_AHCI("AHCI: HBA has %u ports\n", cPorts);
874
875	/* Go through the ports. */
876	i = 0;
877	while (i < 32)
878	{
879	if (ahci_ctrl_is_bit_set(io_base, AHCI_REG_PI, RT_BIT_32(i)) != 0)
880	{
881	DBG_AHCI("AHCI: Port %u is present\n", i);
882	ahci_port_detect_device(ahci_seg :> 0, i);
883	cPorts--;
884	if (cPorts == 0)
885	break;
886	}
887	i++;
888	}
889
890	return 0;
891	}
892
893	/**
894	* Init the AHCI driver and detect attached disks.
895	*/
896	void BIOSCALL ahci_init(void)
897	{
898	uint16_t busdevfn;
899
900	busdevfn = pci_find_classcode(0x00010601);
901	if (busdevfn != VBOX_AHCI_NO_DEVICE)
902	{
903	uint8_t u8Bus, u8DevFn;
904	uint8_t u8PciCapOff;
905
906	u8Bus = (busdevfn & 0xff00) >> 8;
907	u8DevFn = busdevfn & 0x00ff;
908
909	DBG_AHCI("AHCI HBA at Bus %u DevFn 0x%x (raw 0x%x)\n", u8Bus, u8DevFn, busdevfn);
910
911	/* Examine the capability list and search for the Serial ATA Capability Register. */
912	u8PciCapOff = pci_read_config_byte(u8Bus, u8DevFn, PCI_CONFIG_CAP);
913
914	while (u8PciCapOff != 0)
915	{
916	uint8_t u8PciCapId = pci_read_config_byte(u8Bus, u8DevFn, u8PciCapOff);
917
918	DBG_AHCI("Capability ID 0x%x at 0x%x\n", u8PciCapId, u8PciCapOff);
919
920	if (u8PciCapId == PCI_CAP_ID_SATACR)
921	break;
922
923	/* Go on to the next capability. */
924	u8PciCapOff = pci_read_config_byte(u8Bus, u8DevFn, u8PciCapOff + 1);
925	}
926
927	if (u8PciCapOff != 0)
928	{
929	uint8_t u8Rev;
930
931	DBG_AHCI("AHCI HBA with SATA Capability register at 0x%x\n", u8PciCapOff);
932
933	/* Advance to the stuff behind the id and next capability pointer. */
934	u8PciCapOff += 2;
935
936	u8Rev = pci_read_config_byte(u8Bus, u8DevFn, u8PciCapOff);
937	if (u8Rev == 0x10)
938	{
939	/* Read the SATACR1 register and get the bar and offset of the index/data pair register. */
940	uint8_t u8Bar = 0x00;
941	uint16_t u16Off = 0x00;
942	uint16_t u16BarOff = pci_read_config_word(u8Bus, u8DevFn, u8PciCapOff + 2);
943
944	DBG_AHCI("SATACR1: 0x%x\n", u16BarOff);
945
946	switch (u16BarOff & 0xf)
947	{
948	case 0x04:
949	u8Bar = 0x10;
950	break;
951	case 0x05:
952	u8Bar = 0x14;
953	break;
954	case 0x06:
955	u8Bar = 0x18;
956	break;
957	case 0x07:
958	u8Bar = 0x1c;
959	break;
960	case 0x08:
961	u8Bar = 0x20;
962	break;
963	case 0x09:
964	u8Bar = 0x24;
965	break;
966	case 0x0f:
967	default:
968	/* Reserved or unsupported. */
969	DBG_AHCI("BAR 0x%x unsupported\n", u16BarOff & 0xf);
970	}
971
972	/* Get the offset inside the BAR from bits 4:15. */
973	u16Off = (u16BarOff >> 4) * 4;
974
975	if (u8Bar != 0x00)
976	{
977	uint32_t u32Bar = pci_read_config_dword(u8Bus, u8DevFn, u8Bar);
978
979	DBG_AHCI("BAR at 0x%x : 0x%x\n", u8Bar, u32Bar);
980
981	if ((u32Bar & 0x01) != 0)
982	{
983	int rc;
984	uint16_t u16AhciIoBase = (u32Bar & 0xfff0) + u16Off;
985
986	/* Enable PCI memory, I/O, bus mastering access in command register. */
987	pci_write_config_word(u8Bus, u8DevFn, 4, 0x7);
988
989	DBG_AHCI("I/O base: 0x%x\n", u16AhciIoBase);
990	rc = ahci_hba_init(u16AhciIoBase);
991	}
992	else
993	DBG_AHCI("BAR is MMIO\n");
994	}
995	}
996	else
997	DBG_AHCI("Invalid revision 0x%x\n", u8Rev);
998	}
999	else
1000	DBG_AHCI("AHCI HBA with no usable Index/Data register pair!\n");
1001	}
1002	else
1003	DBG_AHCI("No AHCI HBA!\n");
1004	}

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

source: vbox/trunk/src/VBox/Devices/PC/BIOS/ahci.c

Download in other formats: