]> git.proxmox.com Git - mirror_edk2.git/blame - OvmfPkg/Include/IndustryStandard/VirtioScsi.h
OvmfPkg: introduce virtio-scsi driver
[mirror_edk2.git] / OvmfPkg / Include / IndustryStandard / VirtioScsi.h
CommitLineData
37078a63 1/** @file\r
2\r
3 Virtio SCSI Host Device specific type and macro definitions corresponding to\r
4 the virtio-0.9.5 specification.\r
5\r
6 Copyright (C) 2012, Red Hat, Inc.\r
7\r
8 This program and the accompanying materials are licensed and made available\r
9 under the terms and conditions of the BSD License which accompanies this\r
10 distribution. The full text of the license may be found at\r
11 http://opensource.org/licenses/bsd-license.php\r
12\r
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r
14 WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
15\r
16**/\r
17\r
18#ifndef _VIRTIO_SCSI_H_\r
19#define _VIRTIO_SCSI_H_\r
20\r
21#include <IndustryStandard/Virtio.h>\r
22\r
23\r
24//\r
25// virtio-0.9.5, Appendix I: SCSI Host Device\r
26//\r
27#pragma pack(1)\r
28typedef struct {\r
29 VIRTIO_HDR Generic;\r
30 UINT32 VhdrNumQueues;\r
31 UINT32 VhdrSegMax;\r
32 UINT32 VhdrMaxSectors;\r
33 UINT32 VhdrCmdPerLun;\r
34 UINT32 VhdrEventInfoSize;\r
35 UINT32 VhdrSenseSize;\r
36 UINT32 VhdrCdbSize;\r
37 UINT16 VhdrMaxChannel;\r
38 UINT16 VhdrMaxTarget;\r
39 UINT32 VhdrMaxLun;\r
40} VSCSI_HDR;\r
41#pragma pack()\r
42\r
43#define OFFSET_OF_VSCSI(Field) OFFSET_OF (VSCSI_HDR, Field)\r
44#define SIZE_OF_VSCSI(Field) (sizeof ((VSCSI_HDR *) 0)->Field)\r
45\r
46#define VIRTIO_SCSI_F_INOUT BIT0\r
47#define VIRTIO_SCSI_F_HOTPLUG BIT1\r
48\r
49//\r
50// We expect these maximum sizes from the host. Also we force the CdbLength and\r
51// SenseDataLength parameters of EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru() not\r
52// to exceed these limits. See UEFI 2.3.1 errata C 14.7.\r
53//\r
54#define VIRTIO_SCSI_CDB_SIZE 32\r
55#define VIRTIO_SCSI_SENSE_SIZE 96\r
56\r
57//\r
58// We pass the dynamically sized buffers ("dataout", "datain") in separate ring\r
59// descriptors.\r
60//\r
61#pragma pack(1)\r
62typedef struct {\r
63 UINT8 Lun[8];\r
64 UINT64 Id;\r
65 UINT8 TaskAttr;\r
66 UINT8 Prio;\r
67 UINT8 Crn;\r
68 UINT8 Cdb[VIRTIO_SCSI_CDB_SIZE];\r
69} VIRTIO_SCSI_REQ;\r
70\r
71typedef struct {\r
72 UINT32 SenseLen;\r
73 UINT32 Residual;\r
74 UINT16 StatusQualifier;\r
75 UINT8 Status;\r
76 UINT8 Response;\r
77 UINT8 Sense[VIRTIO_SCSI_SENSE_SIZE];\r
78} VIRTIO_SCSI_RESP;\r
79#pragma pack()\r
80\r
81//\r
82// selector of first virtio queue usable for request transfer\r
83//\r
84#define VIRTIO_SCSI_REQUEST_QUEUE 2\r
85\r
86//\r
87// host response codes\r
88//\r
89#define VIRTIO_SCSI_S_OK 0\r
90#define VIRTIO_SCSI_S_OVERRUN 1\r
91#define VIRTIO_SCSI_S_ABORTED 2\r
92#define VIRTIO_SCSI_S_BAD_TARGET 3\r
93#define VIRTIO_SCSI_S_RESET 4\r
94#define VIRTIO_SCSI_S_BUSY 5\r
95#define VIRTIO_SCSI_S_TRANSPORT_FAILURE 6\r
96#define VIRTIO_SCSI_S_TARGET_FAILURE 7\r
97#define VIRTIO_SCSI_S_NEXUS_FAILURE 8\r
98#define VIRTIO_SCSI_S_FAILURE 9\r
99\r
100#endif // _VIRTIO_SCSI_H_\r