]>
Commit | Line | Data |
---|---|---|
37078a63 | 1 | /** @file\r |
2 | \r | |
3 | Internal definitions for the virtio-scsi driver, which produces Extended SCSI\r | |
4 | Pass Thru Protocol instances for virtio-scsi devices.\r | |
5 | \r | |
6 | Copyright (C) 2012, Red Hat, Inc.\r | |
7 | \r | |
b26f0cf9 | 8 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
37078a63 | 9 | \r |
10 | **/\r | |
11 | \r | |
12 | #ifndef _VIRTIO_SCSI_DXE_H_\r | |
13 | #define _VIRTIO_SCSI_DXE_H_\r | |
14 | \r | |
15 | #include <Protocol/ComponentName.h>\r | |
16 | #include <Protocol/DriverBinding.h>\r | |
37078a63 | 17 | #include <Protocol/ScsiPassThruExt.h>\r |
18 | \r | |
19 | #include <IndustryStandard/Virtio.h>\r | |
20 | \r | |
37078a63 | 21 | //\r |
22 | // This driver supports 2-byte target identifiers and 4-byte LUN identifiers.\r | |
23 | //\r | |
24 | // EFI_EXT_SCSI_PASS_THRU_PROTOCOL provides TARGET_MAX_BYTES bytes for target\r | |
25 | // identification, and 8 bytes for LUN identification.\r | |
26 | //\r | |
27 | // EFI_EXT_SCSI_PASS_THRU_MODE.AdapterId is also a target identifier,\r | |
b6b33f67 | 28 | // consisting of 4 bytes. Make sure TARGET_MAX_BYTES can accommodate both\r |
37078a63 | 29 | // AdapterId and our target identifiers.\r |
30 | //\r | |
31 | #if TARGET_MAX_BYTES < 4\r | |
ac0a286f | 32 | #error "virtio-scsi requires TARGET_MAX_BYTES >= 4"\r |
37078a63 | 33 | #endif\r |
34 | \r | |
ac0a286f | 35 | #define VSCSI_SIG SIGNATURE_32 ('V', 'S', 'C', 'S')\r |
37078a63 | 36 | \r |
37 | typedef struct {\r | |
38 | //\r | |
39 | // Parts of this structure are initialized / torn down in various functions\r | |
40 | // at various call depths. The table to the right should make it easier to\r | |
41 | // track them.\r | |
42 | //\r | |
56f65ed8 OM |
43 | // field init function init depth\r |
44 | // ---------------- ------------------ ----------\r | |
ac0a286f MK |
45 | UINT32 Signature; // DriverBindingStart 0\r |
46 | VIRTIO_DEVICE_PROTOCOL *VirtIo; // DriverBindingStart 0\r | |
47 | EFI_EVENT ExitBoot; // DriverBindingStart 0\r | |
48 | BOOLEAN InOutSupported; // VirtioScsiInit 1\r | |
49 | UINT16 MaxTarget; // VirtioScsiInit 1\r | |
50 | UINT32 MaxLun; // VirtioScsiInit 1\r | |
51 | UINT32 MaxSectors; // VirtioScsiInit 1\r | |
52 | VRING Ring; // VirtioRingInit 2\r | |
53 | EFI_EXT_SCSI_PASS_THRU_PROTOCOL PassThru; // VirtioScsiInit 1\r | |
54 | EFI_EXT_SCSI_PASS_THRU_MODE PassThruMode; // VirtioScsiInit 1\r | |
55 | VOID *RingMap; // VirtioRingMap 2\r | |
37078a63 | 56 | } VSCSI_DEV;\r |
57 | \r | |
58 | #define VIRTIO_SCSI_FROM_PASS_THRU(PassThruPointer) \\r | |
59 | CR (PassThruPointer, VSCSI_DEV, PassThru, VSCSI_SIG)\r | |
60 | \r | |
37078a63 | 61 | //\r |
62 | // Probe, start and stop functions of this driver, called by the DXE core for\r | |
63 | // specific devices.\r | |
64 | //\r | |
65 | // The following specifications document these interfaces:\r | |
66 | // - Driver Writer's Guide for UEFI 2.3.1 v1.01, 9 Driver Binding Protocol\r | |
67 | // - UEFI Spec 2.3.1 + Errata C, 10.1 EFI Driver Binding Protocol\r | |
68 | //\r | |
69 | \r | |
70 | EFI_STATUS\r | |
71 | EFIAPI\r | |
72 | VirtioScsiDriverBindingSupported (\r | |
ac0a286f MK |
73 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r |
74 | IN EFI_HANDLE DeviceHandle,\r | |
75 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
37078a63 | 76 | );\r |
77 | \r | |
37078a63 | 78 | EFI_STATUS\r |
79 | EFIAPI\r | |
80 | VirtioScsiDriverBindingStart (\r | |
ac0a286f MK |
81 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r |
82 | IN EFI_HANDLE DeviceHandle,\r | |
83 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
37078a63 | 84 | );\r |
85 | \r | |
37078a63 | 86 | EFI_STATUS\r |
87 | EFIAPI\r | |
88 | VirtioScsiDriverBindingStop (\r | |
ac0a286f MK |
89 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r |
90 | IN EFI_HANDLE DeviceHandle,\r | |
91 | IN UINTN NumberOfChildren,\r | |
92 | IN EFI_HANDLE *ChildHandleBuffer\r | |
37078a63 | 93 | );\r |
94 | \r | |
37078a63 | 95 | //\r |
96 | // The next seven functions implement EFI_EXT_SCSI_PASS_THRU_PROTOCOL\r | |
97 | // for the virtio-scsi HBA. Refer to UEFI Spec 2.3.1 + Errata C, sections\r | |
98 | // - 14.1 SCSI Driver Model Overview,\r | |
99 | // - 14.7 Extended SCSI Pass Thru Protocol.\r | |
100 | //\r | |
101 | \r | |
102 | EFI_STATUS\r | |
103 | EFIAPI\r | |
104 | VirtioScsiPassThru (\r | |
ac0a286f MK |
105 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r |
106 | IN UINT8 *Target,\r | |
107 | IN UINT64 Lun,\r | |
108 | IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r | |
109 | IN EFI_EVENT Event OPTIONAL\r | |
37078a63 | 110 | );\r |
111 | \r | |
37078a63 | 112 | EFI_STATUS\r |
113 | EFIAPI\r | |
114 | VirtioScsiGetNextTargetLun (\r | |
ac0a286f MK |
115 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r |
116 | IN OUT UINT8 **Target,\r | |
117 | IN OUT UINT64 *Lun\r | |
37078a63 | 118 | );\r |
119 | \r | |
37078a63 | 120 | EFI_STATUS\r |
121 | EFIAPI\r | |
122 | VirtioScsiBuildDevicePath (\r | |
ac0a286f MK |
123 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r |
124 | IN UINT8 *Target,\r | |
125 | IN UINT64 Lun,\r | |
126 | IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r | |
37078a63 | 127 | );\r |
128 | \r | |
37078a63 | 129 | EFI_STATUS\r |
130 | EFIAPI\r | |
131 | VirtioScsiGetTargetLun (\r | |
ac0a286f MK |
132 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r |
133 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
134 | OUT UINT8 **Target,\r | |
135 | OUT UINT64 *Lun\r | |
37078a63 | 136 | );\r |
137 | \r | |
37078a63 | 138 | EFI_STATUS\r |
139 | EFIAPI\r | |
140 | VirtioScsiResetChannel (\r | |
ac0a286f | 141 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This\r |
37078a63 | 142 | );\r |
143 | \r | |
37078a63 | 144 | EFI_STATUS\r |
145 | EFIAPI\r | |
146 | VirtioScsiResetTargetLun (\r | |
ac0a286f MK |
147 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r |
148 | IN UINT8 *Target,\r | |
149 | IN UINT64 Lun\r | |
37078a63 | 150 | );\r |
151 | \r | |
37078a63 | 152 | EFI_STATUS\r |
153 | EFIAPI\r | |
154 | VirtioScsiGetNextTarget (\r | |
ac0a286f MK |
155 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r |
156 | IN OUT UINT8 **Target\r | |
37078a63 | 157 | );\r |
158 | \r | |
37078a63 | 159 | //\r |
160 | // The purpose of the following scaffolding (EFI_COMPONENT_NAME_PROTOCOL and\r | |
161 | // EFI_COMPONENT_NAME2_PROTOCOL implementation) is to format the driver's name\r | |
162 | // in English, for display on standard console devices. This is recommended for\r | |
163 | // UEFI drivers that follow the UEFI Driver Model. Refer to the Driver Writer's\r | |
164 | // Guide for UEFI 2.3.1 v1.01, 11 UEFI Driver and Controller Names.\r | |
165 | //\r | |
166 | // Device type names ("Virtio SCSI Host Device") are not formatted because the\r | |
167 | // driver supports only that device type. Therefore the driver name suffices\r | |
168 | // for unambiguous identification.\r | |
169 | //\r | |
170 | \r | |
171 | EFI_STATUS\r | |
172 | EFIAPI\r | |
173 | VirtioScsiGetDriverName (\r | |
ac0a286f MK |
174 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r |
175 | IN CHAR8 *Language,\r | |
176 | OUT CHAR16 **DriverName\r | |
37078a63 | 177 | );\r |
178 | \r | |
37078a63 | 179 | EFI_STATUS\r |
180 | EFIAPI\r | |
181 | VirtioScsiGetDeviceName (\r | |
ac0a286f MK |
182 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r |
183 | IN EFI_HANDLE DeviceHandle,\r | |
184 | IN EFI_HANDLE ChildHandle,\r | |
185 | IN CHAR8 *Language,\r | |
186 | OUT CHAR16 **ControllerName\r | |
37078a63 | 187 | );\r |
188 | \r | |
189 | #endif // _VIRTIO_SCSI_DXE_H_\r |