ATAPIPassthrough.cpp@ 107876

Last change on this file since 107876 was 107595, checked in by vboxsync, 6 weeks ago
Devices/Storage/ATAPIPassthrough.cpp: Some parfait warning fixes, bugref:3409
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 33.6 KB

Line
1	/* $Id: ATAPIPassthrough.cpp 107595 2025-01-09 12:03:23Z vboxsync $ */
2	/** @file
3	* VBox storage devices: ATAPI emulation (common code for DevATA and DevAHCI).
4	*/
5
6	/*
7	* Copyright (C) 2012-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	#define LOG_GROUP LOG_GROUP_DEV_IDE
28	#include <iprt/log.h>
29	#include <iprt/assert.h>
30	#include <iprt/mem.h>
31	#include <iprt/string.h>
32
33	#include <VBox/log.h>
34	#include <iprt/errcore.h>
35	#include <VBox/cdefs.h>
36	#include <VBox/scsi.h>
37	#include <VBox/scsiinline.h>
38
39	#include "ATAPIPassthrough.h"
40
41	/** The track was not detected yet. */
42	#define TRACK_FLAGS_UNDETECTED RT_BIT_32(0)
43	/** The track is the lead in track of the medium. */
44	#define TRACK_FLAGS_LEAD_IN RT_BIT_32(1)
45	/** The track is the lead out track of the medium. */
46	#define TRACK_FLAGS_LEAD_OUT RT_BIT_32(2)
47
48	/** Don't clear already detected tracks on the medium. */
49	#define ATAPI_TRACK_LIST_REALLOCATE_FLAGS_DONT_CLEAR RT_BIT_32(0)
50
51	/**
52	* Track main data form.
53	*/
54	typedef enum TRACKDATAFORM
55	{
56	/** Invalid data form. */
57	TRACKDATAFORM_INVALID = 0,
58	/** 2352 bytes of data. */
59	TRACKDATAFORM_CDDA,
60	/** CDDA data is pause. */
61	TRACKDATAFORM_CDDA_PAUSE,
62	/** Mode 1 with 2048 bytes sector size. */
63	TRACKDATAFORM_MODE1_2048,
64	/** Mode 1 with 2352 bytes sector size. */
65	TRACKDATAFORM_MODE1_2352,
66	/** Mode 1 with 0 bytes sector size (generated by the drive). */
67	TRACKDATAFORM_MODE1_0,
68	/** XA Mode with 2336 bytes sector size. */
69	TRACKDATAFORM_XA_2336,
70	/** XA Mode with 2352 bytes sector size. */
71	TRACKDATAFORM_XA_2352,
72	/** XA Mode with 0 bytes sector size (generated by the drive). */
73	TRACKDATAFORM_XA_0,
74	/** Mode 2 with 2336 bytes sector size. */
75	TRACKDATAFORM_MODE2_2336,
76	/** Mode 2 with 2352 bytes sector size. */
77	TRACKDATAFORM_MODE2_2352,
78	/** Mode 2 with 0 bytes sector size (generated by the drive). */
79	TRACKDATAFORM_MODE2_0
80	} TRACKDATAFORM;
81
82	/**
83	* Subchannel data form.
84	*/
85	typedef enum SUBCHNDATAFORM
86	{
87	/** Invalid subchannel data form. */
88	SUBCHNDATAFORM_INVALID = 0,
89	/** 0 bytes for the subchannel (generated by the drive). */
90	SUBCHNDATAFORM_0,
91	/** 96 bytes of data for the subchannel. */
92	SUBCHNDATAFORM_96
93	} SUBCHNDATAFORM;
94
95	/**
96	* Track entry.
97	*/
98	typedef struct TRACK
99	{
100	/** Start LBA of the track. */
101	int64_t iLbaStart;
102	/** Number of sectors in the track. */
103	uint32_t cSectors;
104	/** Data form of main data. */
105	TRACKDATAFORM enmMainDataForm;
106	/** Data form of sub channel. */
107	SUBCHNDATAFORM enmSubChnDataForm;
108	/** Flags for the track. */
109	uint32_t fFlags;
110	} TRACK, *PTRACK;
111
112	/**
113	* Media track list.
114	*/
115	typedef struct TRACKLIST
116	{
117	/** Number of detected tracks of the current medium. */
118	unsigned cTracksCurrent;
119	/** Maximum number of tracks the list can contain. */
120	unsigned cTracksMax;
121	/** Variable list of tracks. */
122	PTRACK paTracks;
123	} TRACKLIST, *PTRACKLIST;
124
125
126	/**
127	* Reallocate the given track list to be able to hold the given number of tracks.
128	*
129	* @returns VBox status code.
130	* @param pTrackList The track list to reallocate.
131	* @param cTracks Number of tracks the list must be able to hold.
132	* @param fFlags Flags for the reallocation.
133	*/
134	static int atapiTrackListReallocate(PTRACKLIST pTrackList, unsigned cTracks, uint32_t fFlags)
135	{
136	int rc = VINF_SUCCESS;
137
138	if (!(fFlags & ATAPI_TRACK_LIST_REALLOCATE_FLAGS_DONT_CLEAR))
139	ATAPIPassthroughTrackListClear(pTrackList);
140
141	if (pTrackList->cTracksMax < cTracks)
142	{
143	PTRACK paTracksNew = (PTRACK)RTMemRealloc(pTrackList->paTracks, cTracks * sizeof(TRACK));
144	if (paTracksNew)
145	{
146	pTrackList->paTracks = paTracksNew;
147
148	/* Mark new tracks as undetected. */
149	for (unsigned i = pTrackList->cTracksMax; i < cTracks; i++)
150	pTrackList->paTracks[i].fFlags \|= TRACK_FLAGS_UNDETECTED;
151
152	pTrackList->cTracksMax = cTracks;
153	}
154	else
155	rc = VERR_NO_MEMORY;
156	}
157
158	if (RT_SUCCESS(rc))
159	pTrackList->cTracksCurrent = cTracks;
160
161	return rc;
162	}
163
164	/**
165	* Initilizes the given track from the given CUE sheet entry.
166	*
167	* @param pTrack The track to initialize.
168	* @param pbCueSheetEntry CUE sheet entry to use.
169	*/
170	static void atapiTrackListEntryCreateFromCueSheetEntry(PTRACK pTrack, const uint8_t *pbCueSheetEntry)
171	{
172	TRACKDATAFORM enmTrackDataForm = TRACKDATAFORM_INVALID;
173	SUBCHNDATAFORM enmSubChnDataForm = SUBCHNDATAFORM_INVALID;
174
175	/* Determine size of main data based on the data form field. */
176	switch (pbCueSheetEntry[3] & 0x3f)
177	{
178	case 0x00: /* CD-DA with data. */
179	enmTrackDataForm = TRACKDATAFORM_CDDA;
180	break;
181	case 0x01: /* CD-DA without data (used for pauses between tracks). */
182	enmTrackDataForm = TRACKDATAFORM_CDDA_PAUSE;
183	break;
184	case 0x10: /* CD-ROM mode 1 */
185	case 0x12:
186	enmTrackDataForm = TRACKDATAFORM_MODE1_2048;
187	break;
188	case 0x11:
189	case 0x13:
190	enmTrackDataForm = TRACKDATAFORM_MODE1_2352;
191	break;
192	case 0x14:
193	enmTrackDataForm = TRACKDATAFORM_MODE1_0;
194	break;
195	case 0x20: /* CD-ROM XA, CD-I */
196	case 0x22:
197	enmTrackDataForm = TRACKDATAFORM_XA_2336;
198	break;
199	case 0x21:
200	case 0x23:
201	enmTrackDataForm = TRACKDATAFORM_XA_2352;
202	break;
203	case 0x24:
204	enmTrackDataForm = TRACKDATAFORM_XA_0;
205	break;
206	case 0x31: /* CD-ROM Mode 2 */
207	case 0x33:
208	enmTrackDataForm = TRACKDATAFORM_MODE2_2352;
209	break;
210	case 0x30:
211	case 0x32:
212	enmTrackDataForm = TRACKDATAFORM_MODE2_2336;
213	break;
214	case 0x34:
215	enmTrackDataForm = TRACKDATAFORM_MODE2_0;
216	break;
217	default: /* Reserved, invalid mode. Log and leave default sector size. */
218	LogRel(("ATA: Invalid data form mode %d for current CUE sheet\n",
219	pbCueSheetEntry[3] & 0x3f));
220	}
221
222	/* Determine size of sub channel data based on data form field. */
223	switch ((pbCueSheetEntry[3] & 0xc0) >> 6)
224	{
225	case 0x00: /* Sub channel all zeroes, autogenerated by the drive. */
226	enmSubChnDataForm = SUBCHNDATAFORM_0;
227	break;
228	case 0x01:
229	case 0x03:
230	enmSubChnDataForm = SUBCHNDATAFORM_96;
231	break;
232	default:
233	LogRel(("ATA: Invalid sub-channel data form mode %u for current CUE sheet\n",
234	pbCueSheetEntry[3] & 0xc0));
235	}
236
237	pTrack->enmMainDataForm = enmTrackDataForm;
238	pTrack->enmSubChnDataForm = enmSubChnDataForm;
239	pTrack->iLbaStart = scsiMSF2LBA(&pbCueSheetEntry[5]);
240	if (pbCueSheetEntry[1] != 0xaa)
241	{
242	/* Calculate number of sectors from the next entry. */
243	int64_t iLbaNext = scsiMSF2LBA(&pbCueSheetEntry[5+8]);
244	pTrack->cSectors = iLbaNext - pTrack->iLbaStart;
245	}
246	else
247	{
248	pTrack->fFlags \|= TRACK_FLAGS_LEAD_OUT;
249	pTrack->cSectors = 0;
250	}
251	pTrack->fFlags &= ~TRACK_FLAGS_UNDETECTED;
252	}
253
254	/**
255	* Update the track list from a SEND CUE SHEET request.
256	*
257	* @returns VBox status code.
258	* @param pTrackList Track list to update.
259	* @param pbCDB CDB of the SEND CUE SHEET request.
260	* @param pvBuf The CUE sheet.
261	* @param cbBuf The buffer size (max).
262	*/
263	static int atapiTrackListUpdateFromSendCueSheet(PTRACKLIST pTrackList, const uint8_t pbCDB, const void pvBuf, size_t cbBuf)
264	{
265	int rc;
266	unsigned cbCueSheet = scsiBE2H_U24(pbCDB + 6);
267	unsigned cTracks = cbCueSheet / 8;
268
269	AssertReturn(cbCueSheet % 8 == 0 && cTracks, VERR_INVALID_PARAMETER);
270
271	rc = atapiTrackListReallocate(pTrackList, cTracks, 0);
272	if (RT_SUCCESS(rc))
273	{
274	const uint8_t pbCueSheet = (uint8_t )pvBuf;
275	PTRACK pTrack = pTrackList->paTracks;
276	AssertLogRelReturn(cTracks <= cbBuf, VERR_BUFFER_OVERFLOW);
277
278	for (unsigned i = 0; i < cTracks; i++)
279	{
280	atapiTrackListEntryCreateFromCueSheetEntry(pTrack, pbCueSheet);
281	if (i == 0)
282	pTrack->fFlags \|= TRACK_FLAGS_LEAD_IN;
283	pTrack++;
284	pbCueSheet += 8;
285	}
286	}
287
288	return rc;
289	}
290
291	static int atapiTrackListUpdateFromSendDvdStructure(PTRACKLIST pTrackList, const uint8_t pbCDB, const void pvBuf, size_t cbBuf)
292	{
293	RT_NOREF(pTrackList, pbCDB, pvBuf, cbBuf);
294	return VERR_NOT_IMPLEMENTED;
295	}
296
297	/**
298	* Update track list from formatted TOC data.
299	*
300	* @returns VBox status code.
301	* @param pTrackList The track list to update.
302	* @param iTrack The first track the TOC has data for.
303	* @param fMSF Flag whether block addresses are in MSF or LBA format.
304	* @param pbBuf Buffer holding the formatted TOC.
305	* @param cbBuffer Size of the buffer.
306	*/
307	static int atapiTrackListUpdateFromFormattedToc(PTRACKLIST pTrackList, uint8_t iTrack,
308	bool fMSF, const uint8_t *pbBuf, uint32_t cbBuffer)
309	{
310	RT_NOREF(iTrack, cbBuffer); /** @todo unused parameters */
311	int rc;
312	unsigned cbToc = scsiBE2H_U16(pbBuf);
313	uint8_t iTrackFirst = pbBuf[2];
314	unsigned cTracks;
315
316	cbToc -= 2;
317	pbBuf += 4;
318	AssertReturn(cbToc % 8 == 0, VERR_INVALID_PARAMETER);
319
320	cTracks = cbToc / 8 + iTrackFirst;
321
322	rc = atapiTrackListReallocate(pTrackList, iTrackFirst + cTracks, ATAPI_TRACK_LIST_REALLOCATE_FLAGS_DONT_CLEAR);
323	if (RT_SUCCESS(rc))
324	{
325	PTRACK pTrack = &pTrackList->paTracks[iTrackFirst];
326
327	for (unsigned i = iTrackFirst; i < cTracks; i++)
328	{
329	if (pbBuf[1] & 0x4)
330	pTrack->enmMainDataForm = TRACKDATAFORM_MODE1_2048;
331	else
332	pTrack->enmMainDataForm = TRACKDATAFORM_CDDA;
333
334	pTrack->enmSubChnDataForm = SUBCHNDATAFORM_0;
335	if (fMSF)
336	pTrack->iLbaStart = scsiMSF2LBA(&pbBuf[4]);
337	else
338	pTrack->iLbaStart = scsiBE2H_U32(&pbBuf[4]);
339
340	if (pbBuf[2] != 0xaa)
341	{
342	/* Calculate number of sectors from the next entry. */
343	int64_t iLbaNext;
344
345	if (fMSF)
346	iLbaNext = scsiMSF2LBA(&pbBuf[4+8]);
347	else
348	iLbaNext = scsiBE2H_U32(&pbBuf[4+8]);
349
350	pTrack->cSectors = iLbaNext - pTrack->iLbaStart;
351	}
352	else
353	pTrack->cSectors = 0;
354
355	pTrack->fFlags &= ~TRACK_FLAGS_UNDETECTED;
356	pbBuf += 8;
357	pTrack++;
358	}
359	}
360
361	return rc;
362	}
363
364	static int atapiTrackListUpdateFromReadTocPmaAtip(PTRACKLIST pTrackList, const uint8_t pbCDB, const void pvBuf, size_t cbBuf)
365	{
366	int rc;
367	size_t const cbBufMaxGst = scsiBE2H_U16(&pbCDB[7]);
368	uint16_t cbBuffer = (uint16_t)RT_MIN(cbBufMaxGst, cbBuf);
369	bool fMSF = (pbCDB[1] & 0x2) != 0;
370	uint8_t uFmt = pbCDB[2] & 0xf;
371	uint8_t iTrack = pbCDB[6];
372
373	switch (uFmt)
374	{
375	case 0x00:
376	rc = atapiTrackListUpdateFromFormattedToc(pTrackList, iTrack, fMSF, (uint8_t *)pvBuf, cbBuffer);
377	break;
378	case 0x01:
379	case 0x02:
380	case 0x03:
381	case 0x04:
382	rc = VERR_NOT_IMPLEMENTED;
383	break;
384	case 0x05:
385	rc = VINF_SUCCESS; /* Does not give information about the tracklist. */
386	break;
387	default:
388	rc = VERR_INVALID_PARAMETER;
389	}
390
391	return rc;
392	}
393
394	static int atapiTrackListUpdateFromReadTrackInformation(PTRACKLIST pTrackList, const uint8_t *pbCDB,
395	const void *pvBuf, size_t cbBuf)
396	{
397	RT_NOREF(pTrackList, pbCDB, pvBuf, cbBuf);
398	return VERR_NOT_IMPLEMENTED;
399	}
400
401	static int atapiTrackListUpdateFromReadDvdStructure(PTRACKLIST pTrackList, const uint8_t *pbCDB,
402	const void *pvBuf, size_t cbBuf)
403	{
404	RT_NOREF(pTrackList, pbCDB, pvBuf, cbBuf);
405	return VERR_NOT_IMPLEMENTED;
406	}
407
408	static int atapiTrackListUpdateFromReadDiscInformation(PTRACKLIST pTrackList, const uint8_t *pbCDB,
409	const void *pvBuf, size_t cbBuf)
410	{
411	RT_NOREF(pTrackList, pbCDB, pvBuf, cbBuf);
412	return VERR_NOT_IMPLEMENTED;
413	}
414
415	#ifdef LOG_ENABLED
416
417	/**
418	* Converts the given track data form to a string.
419	*
420	* @returns Track data form as a string.
421	* @param enmTrackDataForm The track main data form.
422	*/
423	static const char *atapiTrackListMainDataFormToString(TRACKDATAFORM enmTrackDataForm)
424	{
425	switch (enmTrackDataForm)
426	{
427	case TRACKDATAFORM_CDDA:
428	return "CD-DA";
429	case TRACKDATAFORM_CDDA_PAUSE:
430	return "CD-DA Pause";
431	case TRACKDATAFORM_MODE1_2048:
432	return "Mode 1 (2048 bytes)";
433	case TRACKDATAFORM_MODE1_2352:
434	return "Mode 1 (2352 bytes)";
435	case TRACKDATAFORM_MODE1_0:
436	return "Mode 1 (0 bytes)";
437	case TRACKDATAFORM_XA_2336:
438	return "XA (2336 bytes)";
439	case TRACKDATAFORM_XA_2352:
440	return "XA (2352 bytes)";
441	case TRACKDATAFORM_XA_0:
442	return "XA (0 bytes)";
443	case TRACKDATAFORM_MODE2_2336:
444	return "Mode 2 (2336 bytes)";
445	case TRACKDATAFORM_MODE2_2352:
446	return "Mode 2 (2352 bytes)";
447	case TRACKDATAFORM_MODE2_0:
448	return "Mode 2 (0 bytes)";
449	case TRACKDATAFORM_INVALID:
450	default:
451	return "Invalid";
452	}
453	}
454
455	/**
456	* Converts the given subchannel data form to a string.
457	*
458	* @returns Subchannel data form as a string.
459	* @param enmSubChnDataForm The subchannel main data form.
460	*/
461	static const char *atapiTrackListSubChnDataFormToString(SUBCHNDATAFORM enmSubChnDataForm)
462	{
463	switch (enmSubChnDataForm)
464	{
465	case SUBCHNDATAFORM_0:
466	return "0";
467	case SUBCHNDATAFORM_96:
468	return "96";
469	case SUBCHNDATAFORM_INVALID:
470	default:
471	return "Invalid";
472	}
473	}
474
475	/**
476	* Dump the complete track list to the release log.
477	*
478	* @param pTrackList The track list to dump.
479	*/
480	static void atapiTrackListDump(PTRACKLIST pTrackList)
481	{
482	LogRel(("Track List: cTracks=%u\n", pTrackList->cTracksCurrent));
483	for (unsigned i = 0; i < pTrackList->cTracksCurrent; i++)
484	{
485	PTRACK pTrack = &pTrackList->paTracks[i];
486
487	LogRel((" Track %u: LBAStart=%lld cSectors=%u enmMainDataForm=%s enmSubChnDataForm=%s fFlags=[%s%s%s]\n",
488	i, pTrack->iLbaStart, pTrack->cSectors, atapiTrackListMainDataFormToString(pTrack->enmMainDataForm),
489	atapiTrackListSubChnDataFormToString(pTrack->enmSubChnDataForm),
490	pTrack->fFlags & TRACK_FLAGS_UNDETECTED ? "UNDETECTED " : "",
491	pTrack->fFlags & TRACK_FLAGS_LEAD_IN ? "Lead-In " : "",
492	pTrack->fFlags & TRACK_FLAGS_LEAD_OUT ? "Lead-Out" : ""));
493	}
494	}
495
496	#endif /* LOG_ENABLED */
497
498	/**
499	* Creates an empty track list handle.
500	*
501	* @returns VBox status code.
502	* @param ppTrackList Where to store the track list handle on success.
503	*/
504	DECLHIDDEN(int) ATAPIPassthroughTrackListCreateEmpty(PTRACKLIST *ppTrackList)
505	{
506	PTRACKLIST pTrackList = (PTRACKLIST)RTMemAllocZ(sizeof(TRACKLIST));
507	if (pTrackList)
508	{
509	*ppTrackList = pTrackList;
510	return VINF_SUCCESS;
511	}
512	return VERR_NO_MEMORY;
513	}
514
515	/**
516	* Destroys the allocated task list handle.
517	*
518	* @param pTrackList The track list handle to destroy.
519	*/
520	DECLHIDDEN(void) ATAPIPassthroughTrackListDestroy(PTRACKLIST pTrackList)
521	{
522	if (pTrackList->paTracks)
523	RTMemFree(pTrackList->paTracks);
524	RTMemFree(pTrackList);
525	}
526
527	/**
528	* Clears all tracks from the given task list.
529	*
530	* @param pTrackList The track list to clear.
531	*/
532	DECLHIDDEN(void) ATAPIPassthroughTrackListClear(PTRACKLIST pTrackList)
533	{
534	AssertPtrReturnVoid(pTrackList);
535
536	pTrackList->cTracksCurrent = 0;
537
538	/* Mark all tracks as undetected. */
539	for (unsigned i = 0; i < pTrackList->cTracksMax; i++)
540	pTrackList->paTracks[i].fFlags \|= TRACK_FLAGS_UNDETECTED;
541	}
542
543	/**
544	* Updates the track list from the given CDB and data buffer.
545	*
546	* @returns VBox status code.
547	* @param pTrackList The track list to update.
548	* @param pbCDB The CDB buffer.
549	* @param pvBuf The data buffer.
550	* @param cbBuf The buffer isze.
551	*/
552	DECLHIDDEN(int) ATAPIPassthroughTrackListUpdate(PTRACKLIST pTrackList, const uint8_t pbCDB, const void pvBuf, size_t cbBuf)
553	{
554	int rc;
555
556	switch (pbCDB[0])
557	{
558	case SCSI_SEND_CUE_SHEET:
559	rc = atapiTrackListUpdateFromSendCueSheet(pTrackList, pbCDB, pvBuf, cbBuf);
560	break;
561	case SCSI_SEND_DVD_STRUCTURE:
562	rc = atapiTrackListUpdateFromSendDvdStructure(pTrackList, pbCDB, pvBuf, cbBuf);
563	break;
564	case SCSI_READ_TOC_PMA_ATIP:
565	rc = atapiTrackListUpdateFromReadTocPmaAtip(pTrackList, pbCDB, pvBuf, cbBuf);
566	break;
567	case SCSI_READ_TRACK_INFORMATION:
568	rc = atapiTrackListUpdateFromReadTrackInformation(pTrackList, pbCDB, pvBuf, cbBuf);
569	break;
570	case SCSI_READ_DVD_STRUCTURE:
571	rc = atapiTrackListUpdateFromReadDvdStructure(pTrackList, pbCDB, pvBuf, cbBuf);
572	break;
573	case SCSI_READ_DISC_INFORMATION:
574	rc = atapiTrackListUpdateFromReadDiscInformation(pTrackList, pbCDB, pvBuf, cbBuf);
575	break;
576	default:
577	LogRel(("ATAPI: Invalid opcode %#x while determining media layout\n", pbCDB[0]));
578	rc = VERR_INVALID_PARAMETER;
579	}
580
581	#ifdef LOG_ENABLED
582	atapiTrackListDump(pTrackList);
583	#endif
584
585	return rc;
586	}
587
588	/**
589	* Return the sector size from the track matching the LBA in the given track list.
590	*
591	* @returns Sector size.
592	* @param pTrackList The track list to use.
593	* @param iAtapiLba The start LBA to get the sector size for.
594	*/
595	DECLHIDDEN(uint32_t) ATAPIPassthroughTrackListGetSectorSizeFromLba(PTRACKLIST pTrackList, uint32_t iAtapiLba)
596	{
597	PTRACK pTrack = NULL;
598	uint32_t cbAtapiSector = 2048;
599
600	if (pTrackList->cTracksCurrent)
601	{
602	if ( iAtapiLba > UINT32_C(0xffff4fa1)
603	&& (int32_t)iAtapiLba < -150)
604	{
605	/* Lead-In area, this is always the first entry in the cue sheet. */
606	pTrack = pTrackList->paTracks;
607	Assert(pTrack->fFlags & TRACK_FLAGS_LEAD_IN);
608	LogFlowFunc(("Selected Lead-In area\n"));
609	}
610	else
611	{
612	int64_t iAtapiLba64 = (int32_t)iAtapiLba;
613	pTrack = &pTrackList->paTracks[1];
614
615	/* Go through the track list and find the correct entry. */
616	for (unsigned i = 1; i < pTrackList->cTracksCurrent - 1; i++)
617	{
618	if (pTrack->fFlags & TRACK_FLAGS_UNDETECTED)
619	continue;
620
621	if ( pTrack->iLbaStart <= iAtapiLba64
622	&& iAtapiLba64 < pTrack->iLbaStart + pTrack->cSectors)
623	break;
624
625	pTrack++;
626	}
627	}
628
629	if (pTrack)
630	{
631	switch (pTrack->enmMainDataForm)
632	{
633	case TRACKDATAFORM_CDDA:
634	case TRACKDATAFORM_MODE1_2352:
635	case TRACKDATAFORM_XA_2352:
636	case TRACKDATAFORM_MODE2_2352:
637	cbAtapiSector = 2352;
638	break;
639	case TRACKDATAFORM_MODE1_2048:
640	cbAtapiSector = 2048;
641	break;
642	case TRACKDATAFORM_CDDA_PAUSE:
643	case TRACKDATAFORM_MODE1_0:
644	case TRACKDATAFORM_XA_0:
645	case TRACKDATAFORM_MODE2_0:
646	cbAtapiSector = 0;
647	break;
648	case TRACKDATAFORM_XA_2336:
649	case TRACKDATAFORM_MODE2_2336:
650	cbAtapiSector = 2336;
651	break;
652	case TRACKDATAFORM_INVALID:
653	default:
654	AssertMsgFailed(("Invalid track data form %d\n", pTrack->enmMainDataForm));
655	}
656
657	switch (pTrack->enmSubChnDataForm)
658	{
659	case SUBCHNDATAFORM_0:
660	break;
661	case SUBCHNDATAFORM_96:
662	cbAtapiSector += 96;
663	break;
664	case SUBCHNDATAFORM_INVALID:
665	default:
666	AssertMsgFailed(("Invalid subchannel data form %d\n", pTrack->enmSubChnDataForm));
667	}
668	}
669	}
670
671	return cbAtapiSector;
672	}
673
674
675	static uint8_t atapiPassthroughCmdErrorSimple(uint8_t *pbSense, size_t cbSense, uint8_t uATAPISenseKey, uint8_t uATAPIASC)
676	{
677	memset(pbSense, '\0', cbSense);
678	if (RT_LIKELY(cbSense >= 13))
679	{
680	pbSense[0] = 0x70 \| (1 << 7);
681	pbSense[2] = uATAPISenseKey & 0x0f;
682	pbSense[7] = 10;
683	pbSense[12] = uATAPIASC;
684	}
685	return SCSI_STATUS_CHECK_CONDITION;
686	}
687
688
689	/**
690	* Parses the given CDB and returns whether it is safe to pass it through to the host drive.
691	*
692	* @returns Flag whether passing the CDB through to the host drive is safe.
693	* @param pbCdb The CDB to parse.
694	* @param cbCdb Size of the CDB in bytes.
695	* @param cbBuf Size of the guest buffer.
696	* @param pTrackList The track list for the current medium if available (optional).
697	* @param pbSense Pointer to the sense buffer.
698	* @param cbSense Size of the sense buffer.
699	* @param penmTxDir Where to store the transfer direction (guest to host or vice versa).
700	* @param pcbXfer Where to store the transfer size encoded in the CDB.
701	* @param pcbSector Where to store the sector size used for the transfer.
702	* @param pu8ScsiSts Where to store the SCSI status code.
703	*/
704	DECLHIDDEN(bool) ATAPIPassthroughParseCdb(const uint8_t *pbCdb, size_t cbCdb, size_t cbBuf,
705	PTRACKLIST pTrackList, uint8_t *pbSense, size_t cbSense,
706	PDMMEDIATXDIR penmTxDir, size_t pcbXfer,
707	size_t pcbSector, uint8_t pu8ScsiSts)
708	{
709	uint32_t cSectors = 0;
710	size_t cbSector = 0;
711	size_t cbXfer = 0;
712	bool fPassthrough = false;
713	PDMMEDIATXDIR enmTxDir = PDMMEDIATXDIR_NONE;
714
715	RT_NOREF(cbCdb);
716
717	switch (pbCdb[0])
718	{
719	/* First the commands we can pass through without further processing. */
720	case SCSI_BLANK:
721	case SCSI_CLOSE_TRACK_SESSION:
722	case SCSI_LOAD_UNLOAD_MEDIUM:
723	case SCSI_PAUSE_RESUME:
724	case SCSI_PLAY_AUDIO_10:
725	case SCSI_PLAY_AUDIO_12:
726	case SCSI_PLAY_AUDIO_MSF:
727	case SCSI_PREVENT_ALLOW_MEDIUM_REMOVAL:
728	case SCSI_REPAIR_TRACK:
729	case SCSI_RESERVE_TRACK:
730	case SCSI_SCAN:
731	case SCSI_SEEK_10:
732	case SCSI_SET_CD_SPEED:
733	case SCSI_SET_READ_AHEAD:
734	case SCSI_START_STOP_UNIT:
735	case SCSI_STOP_PLAY_SCAN:
736	case SCSI_SYNCHRONIZE_CACHE:
737	case SCSI_TEST_UNIT_READY:
738	case SCSI_VERIFY_10:
739	fPassthrough = true;
740	break;
741	case SCSI_ERASE_10:
742	cbXfer = scsiBE2H_U16(pbCdb + 7);
743	enmTxDir = PDMMEDIATXDIR_TO_DEVICE;
744	fPassthrough = true;
745	break;
746	case SCSI_FORMAT_UNIT:
747	cbXfer = cbBuf;
748	enmTxDir = PDMMEDIATXDIR_TO_DEVICE;
749	fPassthrough = true;
750	break;
751	case SCSI_GET_CONFIGURATION:
752	cbXfer = scsiBE2H_U16(pbCdb + 7);
753	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
754	fPassthrough = true;
755	break;
756	case SCSI_GET_EVENT_STATUS_NOTIFICATION:
757	cbXfer = scsiBE2H_U16(pbCdb + 7);
758	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
759	fPassthrough = true;
760	break;
761	case SCSI_GET_PERFORMANCE:
762	cbXfer = cbBuf;
763	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
764	fPassthrough = true;
765	break;
766	case SCSI_INQUIRY:
767	cbXfer = scsiBE2H_U16(pbCdb + 3);
768	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
769	fPassthrough = true;
770	break;
771	case SCSI_MECHANISM_STATUS:
772	cbXfer = scsiBE2H_U16(pbCdb + 8);
773	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
774	fPassthrough = true;
775	break;
776	case SCSI_MODE_SELECT_10:
777	cbXfer = scsiBE2H_U16(pbCdb + 7);
778	enmTxDir = PDMMEDIATXDIR_TO_DEVICE;
779	fPassthrough = true;
780	break;
781	case SCSI_MODE_SENSE_10:
782	cbXfer = scsiBE2H_U16(pbCdb + 7);
783	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
784	fPassthrough = true;
785	break;
786	case SCSI_READ_10:
787	cSectors = scsiBE2H_U16(pbCdb + 7);
788	cbSector = 2048;
789	cbXfer = cSectors * cbSector;
790	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
791	fPassthrough = true;
792	break;
793	case SCSI_READ_12:
794	cSectors = scsiBE2H_U32(pbCdb + 6);
795	cbSector = 2048;
796	cbXfer = cSectors * cbSector;
797	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
798	fPassthrough = true;
799	break;
800	case SCSI_READ_BUFFER:
801	cbXfer = scsiBE2H_U24(pbCdb + 6);
802	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
803	fPassthrough = true;
804	break;
805	case SCSI_READ_BUFFER_CAPACITY:
806	cbXfer = scsiBE2H_U16(pbCdb + 7);
807	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
808	fPassthrough = true;
809	break;
810	case SCSI_READ_CAPACITY:
811	cbXfer = 8;
812	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
813	fPassthrough = true;
814	break;
815	case SCSI_READ_CD:
816	case SCSI_READ_CD_MSF:
817	{
818	/* Get sector size based on the expected sector type field. */
819	switch ((pbCdb[1] >> 2) & 0x7)
820	{
821	case 0x0: /* All types. */
822	{
823	uint32_t iLbaStart;
824
825	if (pbCdb[0] == SCSI_READ_CD)
826	iLbaStart = scsiBE2H_U32(&pbCdb[2]);
827	else
828	iLbaStart = scsiMSF2LBA(&pbCdb[3]);
829
830	if (pTrackList)
831	cbSector = ATAPIPassthroughTrackListGetSectorSizeFromLba(pTrackList, iLbaStart);
832	else
833	cbSector = 2048; /* Might be incorrect if we couldn't determine the type. */
834	break;
835	}
836	case 0x1: /* CD-DA */
837	cbSector = 2352;
838	break;
839	case 0x2: /* Mode 1 */
840	cbSector = 2048;
841	break;
842	case 0x3: /* Mode 2 formless */
843	cbSector = 2336;
844	break;
845	case 0x4: /* Mode 2 form 1 */
846	cbSector = 2048;
847	break;
848	case 0x5: /* Mode 2 form 2 */
849	cbSector = 2324;
850	break;
851	default: /* Reserved */
852	AssertMsgFailed(("Unknown sector type\n"));
853	cbSector = 0; /** @todo we should probably fail the command here already. */
854	}
855
856	if (pbCdb[0] == SCSI_READ_CD)
857	cbXfer = scsiBE2H_U24(pbCdb + 6) * cbSector;
858	else /* SCSI_READ_MSF */
859	{
860	cSectors = scsiMSF2LBA(pbCdb + 6) - scsiMSF2LBA(pbCdb + 3);
861	if (cSectors > 32)
862	cSectors = 32; /* Limit transfer size to 64~74K. Safety first. In any case this can only harm software doing CDDA extraction. */
863	cbXfer = cSectors * cbSector;
864	}
865	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
866	fPassthrough = true;
867	break;
868	}
869	case SCSI_READ_DISC_INFORMATION:
870	cbXfer = scsiBE2H_U16(pbCdb + 7);
871	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
872	fPassthrough = true;
873	break;
874	case SCSI_READ_DVD_STRUCTURE:
875	cbXfer = scsiBE2H_U16(pbCdb + 8);
876	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
877	fPassthrough = true;
878	break;
879	case SCSI_READ_FORMAT_CAPACITIES:
880	cbXfer = scsiBE2H_U16(pbCdb + 7);
881	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
882	fPassthrough = true;
883	break;
884	case SCSI_READ_SUBCHANNEL:
885	cbXfer = scsiBE2H_U16(pbCdb + 7);
886	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
887	fPassthrough = true;
888	break;
889	case SCSI_READ_TOC_PMA_ATIP:
890	cbXfer = scsiBE2H_U16(pbCdb + 7);
891	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
892	fPassthrough = true;
893	break;
894	case SCSI_READ_TRACK_INFORMATION:
895	cbXfer = scsiBE2H_U16(pbCdb + 7);
896	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
897	fPassthrough = true;
898	break;
899	case SCSI_REPORT_KEY:
900	cbXfer = scsiBE2H_U16(pbCdb + 8);
901	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
902	fPassthrough = true;
903	break;
904	case SCSI_REQUEST_SENSE:
905	cbXfer = pbCdb[4];
906	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
907	fPassthrough = true;
908	break;
909	case SCSI_SEND_CUE_SHEET:
910	cbXfer = scsiBE2H_U24(pbCdb + 6);
911	enmTxDir = PDMMEDIATXDIR_TO_DEVICE;
912	fPassthrough = true;
913	break;
914	case SCSI_SEND_DVD_STRUCTURE:
915	cbXfer = scsiBE2H_U16(pbCdb + 8);
916	enmTxDir = PDMMEDIATXDIR_TO_DEVICE;
917	fPassthrough = true;
918	break;
919	case SCSI_SEND_EVENT:
920	cbXfer = scsiBE2H_U16(pbCdb + 8);
921	enmTxDir = PDMMEDIATXDIR_TO_DEVICE;
922	fPassthrough = true;
923	break;
924	case SCSI_SEND_KEY:
925	cbXfer = scsiBE2H_U16(pbCdb + 8);
926	enmTxDir = PDMMEDIATXDIR_TO_DEVICE;
927	fPassthrough = true;
928	break;
929	case SCSI_SEND_OPC_INFORMATION:
930	cbXfer = scsiBE2H_U16(pbCdb + 7);
931	enmTxDir = PDMMEDIATXDIR_TO_DEVICE;
932	fPassthrough = true;
933	break;
934	case SCSI_SET_STREAMING:
935	cbXfer = scsiBE2H_U16(pbCdb + 9);
936	enmTxDir = PDMMEDIATXDIR_TO_DEVICE;
937	fPassthrough = true;
938	break;
939	case SCSI_WRITE_10:
940	case SCSI_WRITE_AND_VERIFY_10:
941	{
942	uint32_t const uLba = scsiBE2H_U32(pbCdb + 2);
943	cSectors = scsiBE2H_U16(pbCdb + 7);
944	if (pTrackList)
945	cbSector = ATAPIPassthroughTrackListGetSectorSizeFromLba(pTrackList, uLba);
946	else
947	cbSector = 2048;
948	cbXfer = cSectors * cbSector;
949	enmTxDir = PDMMEDIATXDIR_TO_DEVICE;
950	fPassthrough = true;
951	break;
952	}
953	case SCSI_WRITE_12:
954	{
955	uint32_t const uLba = scsiBE2H_U32(pbCdb + 2);
956	cSectors = scsiBE2H_U32(pbCdb + 6);
957	if (pTrackList)
958	cbSector = ATAPIPassthroughTrackListGetSectorSizeFromLba(pTrackList, uLba);
959	else
960	cbSector = 2048;
961	cbXfer = cSectors * cbSector;
962	enmTxDir = PDMMEDIATXDIR_TO_DEVICE;
963	fPassthrough = true;
964	break;
965	}
966	case SCSI_WRITE_BUFFER:
967	switch (pbCdb[1] & 0x1f)
968	{
969	case 0x04: /* download microcode */
970	case 0x05: /* download microcode and save */
971	case 0x06: /* download microcode with offsets */
972	case 0x07: /* download microcode with offsets and save */
973	case 0x0e: /* download microcode with offsets and defer activation */
974	case 0x0f: /* activate deferred microcode */
975	LogRel(("ATAPI: CD-ROM passthrough command attempted to update firmware, blocked\n"));
976	*pu8ScsiSts = atapiPassthroughCmdErrorSimple(pbSense, cbSense, SCSI_SENSE_ILLEGAL_REQUEST, SCSI_ASC_INV_FIELD_IN_CMD_PACKET);
977	break;
978	default:
979	cbXfer = scsiBE2H_U16(pbCdb + 6);
980	enmTxDir = PDMMEDIATXDIR_TO_DEVICE;
981	fPassthrough = true;
982	break;
983	}
984	break;
985	case SCSI_REPORT_LUNS: /* Not part of MMC-3, but used by Windows. */
986	cbXfer = scsiBE2H_U32(pbCdb + 6);
987	enmTxDir = PDMMEDIATXDIR_FROM_DEVICE;
988	fPassthrough = true;
989	break;
990	case SCSI_REZERO_UNIT:
991	/* Obsolete command used by cdrecord. What else would one expect?
992	* This command is not sent to the drive, it is handled internally,
993	* as the Linux kernel doesn't like it (message "scsi: unknown
994	* opcode 0x01" in syslog) and replies with a sense code of 0,
995	* which sends cdrecord to an endless loop. */
996	*pu8ScsiSts = atapiPassthroughCmdErrorSimple(pbSense, cbSense, SCSI_SENSE_ILLEGAL_REQUEST, SCSI_ASC_ILLEGAL_OPCODE);
997	break;
998	default:
999	LogRel(("ATAPI: Passthrough unimplemented for command %#x\n", pbCdb[0]));
1000	*pu8ScsiSts = atapiPassthroughCmdErrorSimple(pbSense, cbSense, SCSI_SENSE_ILLEGAL_REQUEST, SCSI_ASC_ILLEGAL_OPCODE);
1001	break;
1002	}
1003
1004	if (fPassthrough)
1005	{
1006	*penmTxDir = enmTxDir;
1007	*pcbXfer = cbXfer;
1008	*pcbSector = cbSector;
1009	}
1010
1011	return fPassthrough;
1012	}
1013

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

source: vbox/trunk/src/VBox/Devices/Storage/ATAPIPassthrough.cpp@ 107876

Download in other formats: