VirtualBox

source: vbox/trunk/src/VBox/Devices/Storage/VBoxSCSI.h@ 71564

Last change on this file since 71564 was 69500, checked in by vboxsync, 7 years ago

*: scm --update-copyright-year

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.9 KB
Line 
1/* $Id: VBoxSCSI.h 69500 2017-10-28 15:14:05Z vboxsync $ */
2/** @file
3 * VBox storage devices - Simple SCSI interface for BIOS access.
4 */
5
6/*
7 * Copyright (C) 2006-2017 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/** @page pg_drv_scsi Simple SCSI interface for BIOS access.
19 *
20 * This is a simple interface to access SCSI devices from the BIOS which is
21 * shared between the BusLogic and the LsiLogic SCSI host adapters to simplify
22 * the BIOS part.
23 *
24 * The first interface (if available) will be starting at port 0x430 and
25 * each will occupy 4 ports. The ports are used as described below:
26 *
27 * +--------+--------+----------+
28 * | Offset | Access | Purpose |
29 * +--------+--------+----------+
30 * | 0 | Write | Command |
31 * +--------+--------+----------+
32 * | 0 | Read | Status |
33 * +--------+--------+----------+
34 * | 1 | Write | Data in |
35 * +--------+--------+----------+
36 * | 1 | Read | Data out |
37 * +--------+--------+----------+
38 * | 2 | R/W | Detect |
39 * +--------+--------+----------+
40 * | 3 | Read | SCSI rc |
41 * +--------+--------+----------+
42 * | 3 | Write | Reset |
43 * +--------+--------+----------+
44 *
45 * The register at port 0 receives the SCSI CDB issued from the driver when
46 * writing to it but before writing the actual CDB the first write gives the
47 * size of the CDB in bytes.
48 *
49 * Reading the port at offset 0 gives status information about the adapter. If
50 * the busy bit is set the adapter is processing a previous issued request if it is
51 * cleared the command finished and the adapter can process another request.
52 * The driver has to poll this bit because the adapter will not assert an IRQ
53 * for simplicity reasons.
54 *
55 * The register at offset 2 is to detect if a host adapter is available. If the
56 * driver writes a value to this port and gets the same value after reading it
57 * again the adapter is available.
58 *
59 * Any write to the register at offset 3 causes the interface to be reset. A
60 * read returns the SCSI status code of the last operation.
61 *
62 * This part has no R0 or RC components.
63 */
64
65#ifndef ___Storage_VBoxSCSI_h
66#define ___Storage_VBoxSCSI_h
67
68/*******************************************************************************
69* Header Files *
70*******************************************************************************/
71//#define DEBUG
72#include <VBox/vmm/pdmdev.h>
73#include <VBox/vmm/pdmstorageifs.h>
74#include <VBox/scsi.h>
75
76typedef enum VBOXSCSISTATE
77{
78 VBOXSCSISTATE_NO_COMMAND = 0x00,
79 VBOXSCSISTATE_READ_TXDIR = 0x01,
80 VBOXSCSISTATE_READ_CDB_SIZE_BUFHI = 0x02,
81 VBOXSCSISTATE_READ_BUFFER_SIZE_LSB = 0x03,
82 VBOXSCSISTATE_READ_BUFFER_SIZE_MID = 0x04,
83 VBOXSCSISTATE_READ_COMMAND = 0x05,
84 VBOXSCSISTATE_COMMAND_READY = 0x06
85} VBOXSCSISTATE;
86
87#define VBOXSCSI_TXDIR_FROM_DEVICE 0
88#define VBOXSCSI_TXDIR_TO_DEVICE 1
89
90/** Maximum CDB size the BIOS driver sends. */
91#define VBOXSCSI_CDB_SIZE_MAX 16
92
93typedef struct VBOXSCSI
94{
95 /** The identify register. */
96 uint8_t regIdentify;
97 /** The target device. */
98 uint8_t uTargetDevice;
99 /** Transfer direction. */
100 uint8_t uTxDir;
101 /** The size of the CDB we are issuing. */
102 uint8_t cbCDB;
103 /** The command to issue. */
104 uint8_t abCDB[VBOXSCSI_CDB_SIZE_MAX + 4];
105 /** Current position in the array. */
106 uint8_t iCDB;
107
108#if HC_ARCH_BITS == 64
109 uint32_t Alignment0;
110#endif
111
112 /** Pointer to the buffer holding the data. */
113 R3PTRTYPE(uint8_t *) pbBuf;
114 /** Size of the buffer in bytes. */
115 uint32_t cbBuf;
116 /** The number of bytes left to read/write in the
117 * buffer. It is decremented when the guest (BIOS) accesses
118 * the buffer data. */
119 uint32_t cbBufLeft;
120 /** Current position in the buffer (offBuf if you like). */
121 uint32_t iBuf;
122 /** The result code of last operation. */
123 int32_t rcCompletion;
124 /** Flag whether a request is pending. */
125 volatile bool fBusy;
126 /** The state we are in when fetching a command from the BIOS. */
127 VBOXSCSISTATE enmState;
128} VBOXSCSI, *PVBOXSCSI;
129
130#define VBOX_SCSI_BUSY RT_BIT(0)
131#define VBOX_SCSI_ERROR RT_BIT(1)
132
133#ifdef IN_RING3
134RT_C_DECLS_BEGIN
135int vboxscsiInitialize(PVBOXSCSI pVBoxSCSI);
136int vboxscsiReadRegister(PVBOXSCSI pVBoxSCSI, uint8_t iRegister, uint32_t *pu32Value);
137int vboxscsiWriteRegister(PVBOXSCSI pVBoxSCSI, uint8_t iRegister, uint8_t uVal);
138int vboxscsiSetupRequest(PVBOXSCSI pVBoxSCSI, uint32_t *puLun, uint8_t **ppbCdb, size_t *pcbCdb,
139 size_t *pcbBuf, uint32_t *puTargetDevice);
140int vboxscsiRequestFinished(PVBOXSCSI pVBoxSCSI, int rcCompletion);
141size_t vboxscsiCopyToBuf(PVBOXSCSI pVBoxSCSI, PRTSGBUF pSgBuf, size_t cbSkip, size_t cbCopy);
142size_t vboxscsiCopyFromBuf(PVBOXSCSI pVBoxSCSI, PRTSGBUF pSgBuf, size_t cbSkip, size_t cbCopy);
143void vboxscsiSetRequestRedo(PVBOXSCSI pVBoxSCSI);
144int vboxscsiWriteString(PPDMDEVINS pDevIns, PVBOXSCSI pVBoxSCSI, uint8_t iRegister,
145 uint8_t const *pbSrc, uint32_t *pcTransfers, unsigned cb);
146int vboxscsiReadString(PPDMDEVINS pDevIns, PVBOXSCSI pVBoxSCSI, uint8_t iRegister,
147 uint8_t *pbDst, uint32_t *pcTransfers, unsigned cb);
148
149DECLHIDDEN(int) vboxscsiR3LoadExec(PVBOXSCSI pVBoxSCSI, PSSMHANDLE pSSM);
150DECLHIDDEN(int) vboxscsiR3SaveExec(PVBOXSCSI pVBoxSCSI, PSSMHANDLE pSSM);
151RT_C_DECLS_END
152#endif /* IN_RING3 */
153
154#endif /* !___Storage_VBoxSCSI_h */
155
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette