]> git.proxmox.com Git - mirror_edk2.git/blame - OvmfPkg/Include/IndustryStandard/VirtioScsi.h
OvmfPkg: Make the VirtIo devices use the new VIRTIO_DEVICE_PROTOCOL
[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
56f65ed8
OM
29 UINT32 NumQueues;\r
30 UINT32 SegMax;\r
31 UINT32 MaxSectors;\r
32 UINT32 CmdPerLun;\r
33 UINT32 EventInfoSize;\r
34 UINT32 SenseSize;\r
35 UINT32 CdbSize;\r
36 UINT16 MaxChannel;\r
37 UINT16 MaxTarget;\r
38 UINT32 MaxLun;\r
39} VIRTIO_SCSI_CONFIG;\r
37078a63 40#pragma pack()\r
41\r
56f65ed8
OM
42#define OFFSET_OF_VSCSI(Field) OFFSET_OF (VIRTIO_SCSI_CONFIG, Field)\r
43#define SIZE_OF_VSCSI(Field) (sizeof ((VIRTIO_SCSI_CONFIG *) 0)->Field)\r
37078a63 44\r
45#define VIRTIO_SCSI_F_INOUT BIT0\r
46#define VIRTIO_SCSI_F_HOTPLUG BIT1\r
47\r
48//\r
49// We expect these maximum sizes from the host. Also we force the CdbLength and\r
50// SenseDataLength parameters of EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru() not\r
51// to exceed these limits. See UEFI 2.3.1 errata C 14.7.\r
52//\r
53#define VIRTIO_SCSI_CDB_SIZE 32\r
54#define VIRTIO_SCSI_SENSE_SIZE 96\r
55\r
56//\r
57// We pass the dynamically sized buffers ("dataout", "datain") in separate ring\r
58// descriptors.\r
59//\r
60#pragma pack(1)\r
61typedef struct {\r
62 UINT8 Lun[8];\r
63 UINT64 Id;\r
64 UINT8 TaskAttr;\r
65 UINT8 Prio;\r
66 UINT8 Crn;\r
67 UINT8 Cdb[VIRTIO_SCSI_CDB_SIZE];\r
68} VIRTIO_SCSI_REQ;\r
69\r
70typedef struct {\r
71 UINT32 SenseLen;\r
72 UINT32 Residual;\r
73 UINT16 StatusQualifier;\r
74 UINT8 Status;\r
75 UINT8 Response;\r
76 UINT8 Sense[VIRTIO_SCSI_SENSE_SIZE];\r
77} VIRTIO_SCSI_RESP;\r
78#pragma pack()\r
79\r
80//\r
81// selector of first virtio queue usable for request transfer\r
82//\r
83#define VIRTIO_SCSI_REQUEST_QUEUE 2\r
84\r
85//\r
86// host response codes\r
87//\r
88#define VIRTIO_SCSI_S_OK 0\r
89#define VIRTIO_SCSI_S_OVERRUN 1\r
90#define VIRTIO_SCSI_S_ABORTED 2\r
91#define VIRTIO_SCSI_S_BAD_TARGET 3\r
92#define VIRTIO_SCSI_S_RESET 4\r
93#define VIRTIO_SCSI_S_BUSY 5\r
94#define VIRTIO_SCSI_S_TRANSPORT_FAILURE 6\r
95#define VIRTIO_SCSI_S_TARGET_FAILURE 7\r
96#define VIRTIO_SCSI_S_NEXUS_FAILURE 8\r
97#define VIRTIO_SCSI_S_FAILURE 9\r
98\r
99#endif // _VIRTIO_SCSI_H_\r