]>
Commit | Line | Data |
---|---|---|
37078a63 | 1 | /** @file\r |
2 | \r | |
3 | This driver produces Extended SCSI Pass Thru Protocol instances for\r | |
4 | virtio-scsi devices.\r | |
5 | \r | |
6 | The implementation is basic:\r | |
7 | \r | |
8 | - No hotplug / hot-unplug.\r | |
9 | \r | |
10 | - Although EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru() could be a good match\r | |
11 | for multiple in-flight virtio-scsi requests, we stick to synchronous\r | |
12 | requests for now.\r | |
13 | \r | |
14 | - Timeouts are not supported for EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru().\r | |
15 | \r | |
16 | - Only one channel is supported. (At the time of this writing, host-side\r | |
17 | virtio-scsi supports a single channel too.)\r | |
18 | \r | |
19 | - Only one request queue is used (for the one synchronous request).\r | |
20 | \r | |
21 | - The ResetChannel() and ResetTargetLun() functions of\r | |
22 | EFI_EXT_SCSI_PASS_THRU_PROTOCOL are not supported (which is allowed by the\r | |
23 | UEFI 2.3.1 Errata C specification), although\r | |
24 | VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET could be a good match. That would\r | |
25 | however require client code for the control queue, which is deemed\r | |
26 | unreasonable for now.\r | |
27 | \r | |
28 | Copyright (C) 2012, Red Hat, Inc.\r | |
c4046161 | 29 | Copyright (c) 2012 - 2014, Intel Corporation. All rights reserved.<BR>\r |
fc2c1543 | 30 | Copyright (c) 2017, AMD Inc, All rights reserved.<BR>\r |
37078a63 | 31 | \r |
32 | This program and the accompanying materials are licensed and made available\r | |
33 | under the terms and conditions of the BSD License which accompanies this\r | |
34 | distribution. The full text of the license may be found at\r | |
35 | http://opensource.org/licenses/bsd-license.php\r | |
36 | \r | |
37 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r | |
38 | WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
39 | \r | |
40 | **/\r | |
41 | \r | |
37078a63 | 42 | #include <IndustryStandard/VirtioScsi.h>\r |
43 | #include <Library/BaseMemoryLib.h>\r | |
44 | #include <Library/DebugLib.h>\r | |
45 | #include <Library/MemoryAllocationLib.h>\r | |
46 | #include <Library/UefiBootServicesTableLib.h>\r | |
47 | #include <Library/UefiLib.h>\r | |
48 | #include <Library/VirtioLib.h>\r | |
49 | \r | |
50 | #include "VirtioScsi.h"\r | |
51 | \r | |
52 | /**\r | |
53 | \r | |
56f65ed8 OM |
54 | Convenience macros to read and write configuration elements of the\r |
55 | virtio-scsi VirtIo device.\r | |
37078a63 | 56 | \r |
57 | The following macros make it possible to specify only the "core parameters"\r | |
58 | for such accesses and to derive the rest. By the time VIRTIO_CFG_WRITE()\r | |
59 | returns, the transaction will have been completed.\r | |
60 | \r | |
56f65ed8 | 61 | @param[in] Dev Pointer to the VSCSI_DEV structure.\r |
37078a63 | 62 | \r |
63 | @param[in] Field A field name from VSCSI_HDR, identifying the virtio-scsi\r | |
64 | configuration item to access.\r | |
65 | \r | |
66 | @param[in] Value (VIRTIO_CFG_WRITE() only.) The value to write to the\r | |
67 | selected configuration item.\r | |
68 | \r | |
69 | @param[out] Pointer (VIRTIO_CFG_READ() only.) The object to receive the\r | |
70 | value read from the configuration item. Its type must be\r | |
71 | one of UINT8, UINT16, UINT32, UINT64.\r | |
72 | \r | |
73 | \r | |
ece77e40 | 74 | @return Status codes returned by Virtio->WriteDevice() / Virtio->ReadDevice().\r |
37078a63 | 75 | \r |
76 | **/\r | |
77 | \r | |
ece77e40 OM |
78 | #define VIRTIO_CFG_WRITE(Dev, Field, Value) ((Dev)->VirtIo->WriteDevice ( \\r |
79 | (Dev)->VirtIo, \\r | |
80 | OFFSET_OF_VSCSI (Field), \\r | |
81 | SIZE_OF_VSCSI (Field), \\r | |
82 | (Value) \\r | |
37078a63 | 83 | ))\r |
84 | \r | |
ece77e40 OM |
85 | #define VIRTIO_CFG_READ(Dev, Field, Pointer) ((Dev)->VirtIo->ReadDevice ( \\r |
86 | (Dev)->VirtIo, \\r | |
87 | OFFSET_OF_VSCSI (Field), \\r | |
88 | SIZE_OF_VSCSI (Field), \\r | |
89 | sizeof *(Pointer), \\r | |
90 | (Pointer) \\r | |
37078a63 | 91 | ))\r |
92 | \r | |
93 | \r | |
94 | //\r | |
95 | // UEFI Spec 2.3.1 + Errata C, 14.7 Extended SCSI Pass Thru Protocol specifies\r | |
96 | // the PassThru() interface. Beside returning a status code, the function must\r | |
97 | // set some fields in the EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET in/out\r | |
98 | // parameter on return. The following is a full list of those fields, for\r | |
99 | // easier validation of PopulateRequest(), ParseResponse(), and\r | |
1b15eb06 | 100 | // ReportHostAdapterError() below.\r |
37078a63 | 101 | //\r |
102 | // - InTransferLength\r | |
103 | // - OutTransferLength\r | |
104 | // - HostAdapterStatus\r | |
105 | // - TargetStatus\r | |
106 | // - SenseDataLength\r | |
107 | // - SenseData\r | |
108 | //\r | |
109 | // On any return from the PassThru() interface, these fields must be set,\r | |
110 | // except if the returned status code is explicitly exempt. (Actually the\r | |
111 | // implementation here conservatively sets these fields even in case not all\r | |
112 | // of them would be required by the specification.)\r | |
113 | //\r | |
114 | \r | |
115 | /**\r | |
116 | \r | |
117 | Populate a virtio-scsi request from the Extended SCSI Pass Thru Protocol\r | |
118 | packet.\r | |
119 | \r | |
120 | The caller is responsible for pre-zeroing the virtio-scsi request. The\r | |
121 | Extended SCSI Pass Thru Protocol packet is modified, to be forwarded outwards\r | |
122 | by VirtioScsiPassThru(), if invalid or unsupported parameters are detected.\r | |
123 | \r | |
124 | @param[in] Dev The virtio-scsi host device the packet targets.\r | |
125 | \r | |
126 | @param[in] Target The SCSI target controlled by the virtio-scsi host\r | |
127 | device.\r | |
128 | \r | |
129 | @param[in] Lun The Logical Unit Number under the SCSI target.\r | |
130 | \r | |
131 | @param[in out] Packet The Extended SCSI Pass Thru Protocol packet the\r | |
132 | function translates to a virtio-scsi request. On\r | |
133 | failure this parameter relays error contents.\r | |
134 | \r | |
135 | @param[out] Request The pre-zeroed virtio-scsi request to populate. This\r | |
136 | parameter is volatile-qualified because we expect the\r | |
137 | caller to append it to a virtio ring, thus\r | |
138 | assignments to Request must be visible when the\r | |
139 | function returns.\r | |
140 | \r | |
141 | \r | |
142 | @retval EFI_SUCCESS The Extended SCSI Pass Thru Protocol packet was valid,\r | |
143 | Request has been populated.\r | |
144 | \r | |
145 | @return Otherwise, invalid or unsupported parameters were\r | |
146 | detected. Status codes are meant for direct forwarding\r | |
147 | by the EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru()\r | |
148 | implementation.\r | |
149 | \r | |
150 | **/\r | |
151 | STATIC\r | |
152 | EFI_STATUS\r | |
153 | EFIAPI\r | |
154 | PopulateRequest (\r | |
155 | IN CONST VSCSI_DEV *Dev,\r | |
156 | IN UINT16 Target,\r | |
157 | IN UINT64 Lun,\r | |
158 | IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r | |
159 | OUT volatile VIRTIO_SCSI_REQ *Request\r | |
160 | )\r | |
161 | {\r | |
162 | UINTN Idx;\r | |
163 | \r | |
164 | if (\r | |
165 | //\r | |
166 | // bidirectional transfer was requested, but the host doesn't support it\r | |
167 | //\r | |
168 | (Packet->InTransferLength > 0 && Packet->OutTransferLength > 0 &&\r | |
169 | !Dev->InOutSupported) ||\r | |
170 | \r | |
171 | //\r | |
172 | // a target / LUN was addressed that's impossible to encode for the host\r | |
173 | //\r | |
174 | Target > 0xFF || Lun >= 0x4000 ||\r | |
175 | \r | |
176 | //\r | |
177 | // Command Descriptor Block bigger than VIRTIO_SCSI_CDB_SIZE\r | |
178 | //\r | |
179 | Packet->CdbLength > VIRTIO_SCSI_CDB_SIZE ||\r | |
180 | \r | |
181 | //\r | |
182 | // From virtio-0.9.5, 2.3.2 Descriptor Table:\r | |
183 | // "no descriptor chain may be more than 2^32 bytes long in total".\r | |
184 | //\r | |
185 | (UINT64) Packet->InTransferLength + Packet->OutTransferLength > SIZE_1GB\r | |
186 | ) {\r | |
187 | \r | |
188 | //\r | |
189 | // this error code doesn't require updates to the Packet output fields\r | |
190 | //\r | |
191 | return EFI_UNSUPPORTED;\r | |
192 | }\r | |
193 | \r | |
194 | if (\r | |
195 | //\r | |
196 | // addressed invalid device\r | |
197 | //\r | |
198 | Target > Dev->MaxTarget || Lun > Dev->MaxLun ||\r | |
199 | \r | |
200 | //\r | |
201 | // invalid direction (there doesn't seem to be a macro for the "no data\r | |
202 | // transferred" "direction", eg. for TEST UNIT READY)\r | |
203 | //\r | |
204 | Packet->DataDirection > EFI_EXT_SCSI_DATA_DIRECTION_BIDIRECTIONAL ||\r | |
205 | \r | |
206 | //\r | |
207 | // trying to receive, but destination pointer is NULL, or contradicting\r | |
208 | // transfer direction\r | |
209 | //\r | |
210 | (Packet->InTransferLength > 0 &&\r | |
211 | (Packet->InDataBuffer == NULL ||\r | |
212 | Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_WRITE\r | |
213 | )\r | |
214 | ) ||\r | |
215 | \r | |
216 | //\r | |
217 | // trying to send, but source pointer is NULL, or contradicting transfer\r | |
218 | // direction\r | |
219 | //\r | |
220 | (Packet->OutTransferLength > 0 &&\r | |
221 | (Packet->OutDataBuffer == NULL ||\r | |
222 | Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_READ\r | |
223 | )\r | |
224 | )\r | |
225 | ) {\r | |
226 | \r | |
227 | //\r | |
228 | // this error code doesn't require updates to the Packet output fields\r | |
229 | //\r | |
230 | return EFI_INVALID_PARAMETER;\r | |
231 | }\r | |
232 | \r | |
233 | //\r | |
234 | // Catch oversized requests eagerly. If this condition evaluates to false,\r | |
235 | // then the combined size of a bidirectional request will not exceed the\r | |
236 | // virtio-scsi device's transfer limit either.\r | |
237 | //\r | |
238 | if (ALIGN_VALUE (Packet->OutTransferLength, 512) / 512\r | |
239 | > Dev->MaxSectors / 2 ||\r | |
240 | ALIGN_VALUE (Packet->InTransferLength, 512) / 512\r | |
241 | > Dev->MaxSectors / 2) {\r | |
242 | Packet->InTransferLength = (Dev->MaxSectors / 2) * 512;\r | |
243 | Packet->OutTransferLength = (Dev->MaxSectors / 2) * 512;\r | |
244 | Packet->HostAdapterStatus =\r | |
245 | EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN;\r | |
246 | Packet->TargetStatus = EFI_EXT_SCSI_STATUS_TARGET_GOOD;\r | |
247 | Packet->SenseDataLength = 0;\r | |
248 | return EFI_BAD_BUFFER_SIZE;\r | |
249 | }\r | |
250 | \r | |
251 | //\r | |
252 | // target & LUN encoding: see virtio-0.9.5, Appendix I: SCSI Host Device,\r | |
253 | // Device Operation: request queues\r | |
254 | //\r | |
255 | Request->Lun[0] = 1;\r | |
256 | Request->Lun[1] = (UINT8) Target;\r | |
faba4a14 | 257 | Request->Lun[2] = (UINT8) (((UINT32)Lun >> 8) | 0x40);\r |
37078a63 | 258 | Request->Lun[3] = (UINT8) Lun;\r |
259 | \r | |
260 | //\r | |
261 | // CopyMem() would cast away the "volatile" qualifier before access, which is\r | |
262 | // undefined behavior (ISO C99 6.7.3p5)\r | |
263 | //\r | |
264 | for (Idx = 0; Idx < Packet->CdbLength; ++Idx) {\r | |
265 | Request->Cdb[Idx] = ((UINT8 *) Packet->Cdb)[Idx];\r | |
266 | }\r | |
267 | \r | |
268 | return EFI_SUCCESS;\r | |
269 | }\r | |
270 | \r | |
271 | \r | |
272 | /**\r | |
273 | \r | |
274 | Parse the virtio-scsi device's response, translate it to an EFI status code,\r | |
275 | and update the Extended SCSI Pass Thru Protocol packet, to be returned by\r | |
276 | the EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru() implementation.\r | |
277 | \r | |
278 | @param[in out] Packet The Extended SCSI Pass Thru Protocol packet that has\r | |
279 | been translated to a virtio-scsi request with\r | |
280 | PopulateRequest(), and processed by the host. On\r | |
281 | output this parameter is updated with response or\r | |
282 | error contents.\r | |
283 | \r | |
284 | @param[in] Response The virtio-scsi response structure to parse. We expect\r | |
285 | it to come from a virtio ring, thus it is qualified\r | |
286 | volatile.\r | |
287 | \r | |
288 | \r | |
289 | @return PassThru() status codes mandated by UEFI Spec 2.3.1 + Errata C, 14.7\r | |
290 | Extended SCSI Pass Thru Protocol.\r | |
291 | \r | |
292 | **/\r | |
293 | STATIC\r | |
294 | EFI_STATUS\r | |
295 | EFIAPI\r | |
296 | ParseResponse (\r | |
297 | IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r | |
298 | IN CONST volatile VIRTIO_SCSI_RESP *Response\r | |
299 | )\r | |
300 | {\r | |
301 | UINTN ResponseSenseLen;\r | |
302 | UINTN Idx;\r | |
303 | \r | |
304 | //\r | |
305 | // return sense data (length and contents) in all cases, truncated if needed\r | |
306 | //\r | |
307 | ResponseSenseLen = MIN (Response->SenseLen, VIRTIO_SCSI_SENSE_SIZE);\r | |
308 | if (Packet->SenseDataLength > ResponseSenseLen) {\r | |
309 | Packet->SenseDataLength = (UINT8) ResponseSenseLen;\r | |
310 | }\r | |
311 | for (Idx = 0; Idx < Packet->SenseDataLength; ++Idx) {\r | |
312 | ((UINT8 *) Packet->SenseData)[Idx] = Response->Sense[Idx];\r | |
313 | }\r | |
314 | \r | |
315 | //\r | |
316 | // Report actual transfer lengths. The logic below covers all three\r | |
317 | // DataDirections (read, write, bidirectional).\r | |
318 | //\r | |
319 | // -+- @ 0\r | |
320 | // |\r | |
321 | // | write ^ @ Residual (unprocessed)\r | |
322 | // | |\r | |
323 | // -+- @ OutTransferLength -+- @ InTransferLength\r | |
324 | // | |\r | |
325 | // | read |\r | |
326 | // | |\r | |
327 | // V @ OutTransferLength + InTransferLength -+- @ 0\r | |
328 | //\r | |
329 | if (Response->Residual <= Packet->InTransferLength) {\r | |
330 | Packet->InTransferLength -= Response->Residual;\r | |
331 | }\r | |
332 | else {\r | |
333 | Packet->OutTransferLength -= Response->Residual - Packet->InTransferLength;\r | |
334 | Packet->InTransferLength = 0;\r | |
335 | }\r | |
336 | \r | |
337 | //\r | |
338 | // report target status in all cases\r | |
339 | //\r | |
340 | Packet->TargetStatus = Response->Status;\r | |
341 | \r | |
342 | //\r | |
343 | // host adapter status and function return value depend on virtio-scsi\r | |
344 | // response code\r | |
345 | //\r | |
346 | switch (Response->Response) {\r | |
347 | case VIRTIO_SCSI_S_OK:\r | |
348 | Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OK;\r | |
349 | return EFI_SUCCESS;\r | |
350 | \r | |
351 | case VIRTIO_SCSI_S_OVERRUN:\r | |
352 | Packet->HostAdapterStatus =\r | |
353 | EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN;\r | |
354 | break;\r | |
355 | \r | |
356 | case VIRTIO_SCSI_S_BAD_TARGET:\r | |
357 | //\r | |
358 | // This is non-intuitive but explicitly required by the\r | |
359 | // EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru() specification for\r | |
360 | // disconnected (but otherwise valid) target / LUN addresses.\r | |
361 | //\r | |
362 | Packet->HostAdapterStatus =\r | |
363 | EFI_EXT_SCSI_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND;\r | |
364 | return EFI_TIMEOUT;\r | |
365 | \r | |
366 | case VIRTIO_SCSI_S_RESET:\r | |
367 | Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_BUS_RESET;\r | |
368 | break;\r | |
369 | \r | |
370 | case VIRTIO_SCSI_S_BUSY:\r | |
371 | Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OK;\r | |
372 | return EFI_NOT_READY;\r | |
373 | \r | |
374 | //\r | |
375 | // Lump together the rest. The mapping for VIRTIO_SCSI_S_ABORTED is\r | |
376 | // intentional as well, not an oversight.\r | |
377 | //\r | |
378 | case VIRTIO_SCSI_S_ABORTED:\r | |
379 | case VIRTIO_SCSI_S_TRANSPORT_FAILURE:\r | |
380 | case VIRTIO_SCSI_S_TARGET_FAILURE:\r | |
381 | case VIRTIO_SCSI_S_NEXUS_FAILURE:\r | |
382 | case VIRTIO_SCSI_S_FAILURE:\r | |
383 | default:\r | |
384 | Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OTHER;\r | |
385 | }\r | |
386 | \r | |
387 | return EFI_DEVICE_ERROR;\r | |
388 | }\r | |
389 | \r | |
390 | \r | |
1b15eb06 BS |
391 | /**\r |
392 | \r | |
393 | The function can be used to create a fake host adapter error.\r | |
394 | \r | |
395 | When VirtioScsiPassThru() is failed due to some reasons then this function\r | |
396 | can be called to construct a host adapter error.\r | |
397 | \r | |
398 | @param[out] Packet The Extended SCSI Pass Thru Protocol packet that the host\r | |
399 | adapter error shall be placed in.\r | |
400 | \r | |
401 | \r | |
402 | @retval EFI_DEVICE_ERROR The function returns this status code\r | |
403 | unconditionally, to be propagated by\r | |
404 | VirtioScsiPassThru().\r | |
405 | \r | |
406 | **/\r | |
407 | STATIC\r | |
408 | EFI_STATUS\r | |
409 | ReportHostAdapterError (\r | |
410 | OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r | |
411 | )\r | |
412 | {\r | |
413 | Packet->InTransferLength = 0;\r | |
414 | Packet->OutTransferLength = 0;\r | |
415 | Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OTHER;\r | |
416 | Packet->TargetStatus = EFI_EXT_SCSI_STATUS_TARGET_GOOD;\r | |
417 | Packet->SenseDataLength = 0;\r | |
418 | return EFI_DEVICE_ERROR;\r | |
419 | }\r | |
420 | \r | |
421 | \r | |
37078a63 | 422 | //\r |
423 | // The next seven functions implement EFI_EXT_SCSI_PASS_THRU_PROTOCOL\r | |
424 | // for the virtio-scsi HBA. Refer to UEFI Spec 2.3.1 + Errata C, sections\r | |
425 | // - 14.1 SCSI Driver Model Overview,\r | |
426 | // - 14.7 Extended SCSI Pass Thru Protocol.\r | |
427 | //\r | |
428 | \r | |
429 | EFI_STATUS\r | |
430 | EFIAPI\r | |
431 | VirtioScsiPassThru (\r | |
432 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
433 | IN UINT8 *Target,\r | |
434 | IN UINT64 Lun,\r | |
435 | IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r | |
436 | IN EFI_EVENT Event OPTIONAL\r | |
437 | )\r | |
438 | {\r | |
439 | VSCSI_DEV *Dev;\r | |
440 | UINT16 TargetValue;\r | |
441 | EFI_STATUS Status;\r | |
442 | volatile VIRTIO_SCSI_REQ Request;\r | |
9d0d5050 BS |
443 | volatile VIRTIO_SCSI_RESP *Response;\r |
444 | VOID *ResponseBuffer;\r | |
37078a63 | 445 | DESC_INDICES Indices;\r |
9d0d5050 BS |
446 | VOID *RequestMapping;\r |
447 | VOID *ResponseMapping;\r | |
448 | VOID *InDataMapping;\r | |
449 | VOID *OutDataMapping;\r | |
450 | EFI_PHYSICAL_ADDRESS RequestDeviceAddress;\r | |
451 | EFI_PHYSICAL_ADDRESS ResponseDeviceAddress;\r | |
452 | EFI_PHYSICAL_ADDRESS InDataDeviceAddress;\r | |
453 | EFI_PHYSICAL_ADDRESS OutDataDeviceAddress;\r | |
454 | VOID *InDataBuffer;\r | |
455 | UINTN InDataNumPages;\r | |
456 | BOOLEAN OutDataBufferIsMapped;\r | |
37078a63 | 457 | \r |
151304d9 | 458 | ZeroMem ((VOID*) &Request, sizeof (Request));\r |
37078a63 | 459 | \r |
460 | Dev = VIRTIO_SCSI_FROM_PASS_THRU (This);\r | |
461 | CopyMem (&TargetValue, Target, sizeof TargetValue);\r | |
462 | \r | |
9d0d5050 BS |
463 | InDataBuffer = NULL;\r |
464 | OutDataBufferIsMapped = FALSE;\r | |
465 | InDataNumPages = 0;\r | |
466 | \r | |
37078a63 | 467 | Status = PopulateRequest (Dev, TargetValue, Lun, Packet, &Request);\r |
468 | if (EFI_ERROR (Status)) {\r | |
469 | return Status;\r | |
470 | }\r | |
471 | \r | |
9d0d5050 BS |
472 | //\r |
473 | // Map the virtio-scsi Request header buffer\r | |
474 | //\r | |
475 | Status = VirtioMapAllBytesInSharedBuffer (\r | |
476 | Dev->VirtIo,\r | |
477 | VirtioOperationBusMasterRead,\r | |
478 | (VOID *) &Request,\r | |
479 | sizeof Request,\r | |
480 | &RequestDeviceAddress,\r | |
481 | &RequestMapping);\r | |
482 | if (EFI_ERROR (Status)) {\r | |
483 | return ReportHostAdapterError (Packet);\r | |
484 | }\r | |
485 | \r | |
486 | //\r | |
487 | // Map the input buffer\r | |
488 | //\r | |
489 | if (Packet->InTransferLength > 0) {\r | |
490 | //\r | |
491 | // Allocate a intermediate input buffer. This is mainly to handle the\r | |
492 | // following case:\r | |
493 | // * caller submits a bi-directional request\r | |
494 | // * we perform the request fine\r | |
495 | // * but we fail to unmap the "InDataMapping"\r | |
496 | //\r | |
497 | // In that case simply returing the EFI_DEVICE_ERROR is not sufficient. In\r | |
498 | // addition to the error code we also need to update Packet fields\r | |
499 | // accordingly so that we report the full loss of the incoming transfer.\r | |
500 | //\r | |
501 | // We allocate a temporary buffer and map it with BusMasterCommonBuffer. If\r | |
502 | // the Virtio request is successful then we copy the data from temporary\r | |
503 | // buffer into Packet->InDataBuffer.\r | |
504 | //\r | |
505 | InDataNumPages = EFI_SIZE_TO_PAGES ((UINTN)Packet->InTransferLength);\r | |
506 | Status = Dev->VirtIo->AllocateSharedPages (\r | |
507 | Dev->VirtIo,\r | |
508 | InDataNumPages,\r | |
509 | &InDataBuffer\r | |
510 | );\r | |
511 | if (EFI_ERROR (Status)) {\r | |
512 | Status = ReportHostAdapterError (Packet);\r | |
513 | goto UnmapRequestBuffer;\r | |
514 | }\r | |
515 | \r | |
516 | ZeroMem (InDataBuffer, Packet->InTransferLength);\r | |
517 | \r | |
518 | Status = VirtioMapAllBytesInSharedBuffer (\r | |
519 | Dev->VirtIo,\r | |
520 | VirtioOperationBusMasterCommonBuffer,\r | |
521 | InDataBuffer,\r | |
522 | Packet->InTransferLength,\r | |
523 | &InDataDeviceAddress,\r | |
524 | &InDataMapping\r | |
525 | );\r | |
526 | if (EFI_ERROR (Status)) {\r | |
527 | Status = ReportHostAdapterError (Packet);\r | |
528 | goto FreeInDataBuffer;\r | |
529 | }\r | |
530 | }\r | |
531 | \r | |
532 | //\r | |
533 | // Map the output buffer\r | |
534 | //\r | |
535 | if (Packet->OutTransferLength > 0) {\r | |
536 | Status = VirtioMapAllBytesInSharedBuffer (\r | |
537 | Dev->VirtIo,\r | |
538 | VirtioOperationBusMasterRead,\r | |
539 | Packet->OutDataBuffer,\r | |
540 | Packet->OutTransferLength,\r | |
541 | &OutDataDeviceAddress,\r | |
542 | &OutDataMapping\r | |
543 | );\r | |
544 | if (EFI_ERROR (Status)) {\r | |
545 | Status = ReportHostAdapterError (Packet);\r | |
546 | goto UnmapInDataBuffer;\r | |
547 | }\r | |
548 | \r | |
549 | OutDataBufferIsMapped = TRUE;\r | |
550 | }\r | |
551 | \r | |
552 | //\r | |
553 | // Response header is bi-direction (we preset with host status and expect\r | |
554 | // the device to update it). Allocate a response buffer which can be mapped\r | |
555 | // to access equally by both processor and device.\r | |
556 | //\r | |
557 | Status = Dev->VirtIo->AllocateSharedPages (\r | |
558 | Dev->VirtIo,\r | |
559 | EFI_SIZE_TO_PAGES (sizeof *Response),\r | |
560 | &ResponseBuffer\r | |
561 | );\r | |
562 | if (EFI_ERROR (Status)) {\r | |
563 | Status = ReportHostAdapterError (Packet);\r | |
564 | goto UnmapOutDataBuffer;\r | |
565 | }\r | |
566 | \r | |
567 | Response = ResponseBuffer;\r | |
568 | \r | |
569 | ZeroMem ((VOID *)Response, sizeof (*Response));\r | |
37078a63 | 570 | \r |
571 | //\r | |
572 | // preset a host status for ourselves that we do not accept as success\r | |
573 | //\r | |
9d0d5050 BS |
574 | Response->Response = VIRTIO_SCSI_S_FAILURE;\r |
575 | \r | |
576 | //\r | |
577 | // Map the response buffer with BusMasterCommonBuffer so that response\r | |
578 | // buffer can be accessed by both host and device.\r | |
579 | //\r | |
580 | Status = VirtioMapAllBytesInSharedBuffer (\r | |
581 | Dev->VirtIo,\r | |
582 | VirtioOperationBusMasterCommonBuffer,\r | |
583 | ResponseBuffer,\r | |
584 | sizeof (*Response),\r | |
585 | &ResponseDeviceAddress,\r | |
586 | &ResponseMapping\r | |
587 | );\r | |
588 | if (EFI_ERROR (Status)) {\r | |
589 | Status = ReportHostAdapterError (Packet);\r | |
590 | goto FreeResponseBuffer;\r | |
591 | }\r | |
592 | \r | |
593 | VirtioPrepare (&Dev->Ring, &Indices);\r | |
37078a63 | 594 | \r |
595 | //\r | |
596 | // ensured by VirtioScsiInit() -- this predicate, in combination with the\r | |
597 | // lock-step progress, ensures we don't have to track free descriptors.\r | |
598 | //\r | |
599 | ASSERT (Dev->Ring.QueueSize >= 4);\r | |
600 | \r | |
601 | //\r | |
602 | // enqueue Request\r | |
603 | //\r | |
9d0d5050 BS |
604 | VirtioAppendDesc (\r |
605 | &Dev->Ring,\r | |
606 | RequestDeviceAddress,\r | |
607 | sizeof Request,\r | |
608 | VRING_DESC_F_NEXT,\r | |
609 | &Indices\r | |
610 | );\r | |
37078a63 | 611 | \r |
612 | //\r | |
613 | // enqueue "dataout" if any\r | |
614 | //\r | |
615 | if (Packet->OutTransferLength > 0) {\r | |
9d0d5050 BS |
616 | VirtioAppendDesc (\r |
617 | &Dev->Ring,\r | |
618 | OutDataDeviceAddress,\r | |
619 | Packet->OutTransferLength,\r | |
620 | VRING_DESC_F_NEXT,\r | |
621 | &Indices\r | |
622 | );\r | |
37078a63 | 623 | }\r |
624 | \r | |
625 | //\r | |
626 | // enqueue Response, to be written by the host\r | |
627 | //\r | |
9d0d5050 BS |
628 | VirtioAppendDesc (\r |
629 | &Dev->Ring,\r | |
630 | ResponseDeviceAddress,\r | |
631 | sizeof *Response,\r | |
632 | VRING_DESC_F_WRITE | (Packet->InTransferLength > 0 ? VRING_DESC_F_NEXT : 0),\r | |
633 | &Indices\r | |
634 | );\r | |
37078a63 | 635 | \r |
636 | //\r | |
637 | // enqueue "datain" if any, to be written by the host\r | |
638 | //\r | |
639 | if (Packet->InTransferLength > 0) {\r | |
9d0d5050 BS |
640 | VirtioAppendDesc (\r |
641 | &Dev->Ring,\r | |
642 | InDataDeviceAddress,\r | |
643 | Packet->InTransferLength,\r | |
644 | VRING_DESC_F_WRITE,\r | |
645 | &Indices\r | |
646 | );\r | |
37078a63 | 647 | }\r |
648 | \r | |
649 | // If kicking the host fails, we must fake a host adapter error.\r | |
650 | // EFI_NOT_READY would save us the effort, but it would also suggest that the\r | |
651 | // caller retry.\r | |
652 | //\r | |
56f65ed8 | 653 | if (VirtioFlush (Dev->VirtIo, VIRTIO_SCSI_REQUEST_QUEUE, &Dev->Ring,\r |
8bc951a2 | 654 | &Indices, NULL) != EFI_SUCCESS) {\r |
9d0d5050 BS |
655 | Status = ReportHostAdapterError (Packet);\r |
656 | goto UnmapResponseBuffer;\r | |
37078a63 | 657 | }\r |
658 | \r | |
9d0d5050 BS |
659 | Status = ParseResponse (Packet, Response);\r |
660 | \r | |
661 | //\r | |
662 | // If virtio request was successful and it was a CPU read request then we\r | |
663 | // have used an intermediate buffer. Copy the data from intermediate buffer\r | |
664 | // to the final buffer.\r | |
665 | //\r | |
666 | if (InDataBuffer != NULL) {\r | |
667 | CopyMem (Packet->InDataBuffer, InDataBuffer, Packet->InTransferLength);\r | |
668 | }\r | |
669 | \r | |
670 | UnmapResponseBuffer:\r | |
671 | Dev->VirtIo->UnmapSharedBuffer (Dev->VirtIo, ResponseMapping);\r | |
672 | \r | |
673 | FreeResponseBuffer:\r | |
674 | Dev->VirtIo->FreeSharedPages (\r | |
675 | Dev->VirtIo,\r | |
676 | EFI_SIZE_TO_PAGES (sizeof *Response),\r | |
677 | ResponseBuffer\r | |
678 | );\r | |
679 | \r | |
680 | UnmapOutDataBuffer:\r | |
681 | if (OutDataBufferIsMapped) {\r | |
682 | Dev->VirtIo->UnmapSharedBuffer (Dev->VirtIo, OutDataMapping);\r | |
683 | }\r | |
684 | \r | |
685 | UnmapInDataBuffer:\r | |
686 | if (InDataBuffer != NULL) {\r | |
687 | Dev->VirtIo->UnmapSharedBuffer (Dev->VirtIo, InDataMapping);\r | |
688 | }\r | |
689 | \r | |
690 | FreeInDataBuffer:\r | |
691 | if (InDataBuffer != NULL) {\r | |
692 | Dev->VirtIo->FreeSharedPages (Dev->VirtIo, InDataNumPages, InDataBuffer);\r | |
693 | }\r | |
694 | \r | |
695 | UnmapRequestBuffer:\r | |
696 | Dev->VirtIo->UnmapSharedBuffer (Dev->VirtIo, RequestMapping);\r | |
697 | \r | |
698 | return Status;\r | |
37078a63 | 699 | }\r |
700 | \r | |
701 | \r | |
702 | EFI_STATUS\r | |
703 | EFIAPI\r | |
704 | VirtioScsiGetNextTargetLun (\r | |
705 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
706 | IN OUT UINT8 **TargetPointer,\r | |
707 | IN OUT UINT64 *Lun\r | |
708 | )\r | |
709 | {\r | |
710 | UINT8 *Target;\r | |
711 | UINTN Idx;\r | |
712 | UINT16 LastTarget;\r | |
713 | VSCSI_DEV *Dev;\r | |
714 | \r | |
715 | //\r | |
716 | // the TargetPointer input parameter is unnecessarily a pointer-to-pointer\r | |
717 | //\r | |
718 | Target = *TargetPointer;\r | |
719 | \r | |
720 | //\r | |
721 | // Search for first non-0xFF byte. If not found, return first target & LUN.\r | |
722 | //\r | |
723 | for (Idx = 0; Idx < TARGET_MAX_BYTES && Target[Idx] == 0xFF; ++Idx)\r | |
724 | ;\r | |
725 | if (Idx == TARGET_MAX_BYTES) {\r | |
726 | SetMem (Target, TARGET_MAX_BYTES, 0x00);\r | |
727 | *Lun = 0;\r | |
728 | return EFI_SUCCESS;\r | |
729 | }\r | |
730 | \r | |
731 | //\r | |
732 | // see the TARGET_MAX_BYTES check in "VirtioScsi.h"\r | |
733 | //\r | |
734 | CopyMem (&LastTarget, Target, sizeof LastTarget);\r | |
735 | \r | |
736 | //\r | |
737 | // increment (target, LUN) pair if valid on input\r | |
738 | //\r | |
739 | Dev = VIRTIO_SCSI_FROM_PASS_THRU (This);\r | |
740 | if (LastTarget > Dev->MaxTarget || *Lun > Dev->MaxLun) {\r | |
741 | return EFI_INVALID_PARAMETER;\r | |
742 | }\r | |
743 | \r | |
744 | if (*Lun < Dev->MaxLun) {\r | |
745 | ++*Lun;\r | |
746 | return EFI_SUCCESS;\r | |
747 | }\r | |
748 | \r | |
749 | if (LastTarget < Dev->MaxTarget) {\r | |
750 | *Lun = 0;\r | |
751 | ++LastTarget;\r | |
752 | CopyMem (Target, &LastTarget, sizeof LastTarget);\r | |
753 | return EFI_SUCCESS;\r | |
754 | }\r | |
755 | \r | |
756 | return EFI_NOT_FOUND;\r | |
757 | }\r | |
758 | \r | |
759 | \r | |
760 | EFI_STATUS\r | |
761 | EFIAPI\r | |
762 | VirtioScsiBuildDevicePath (\r | |
763 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
764 | IN UINT8 *Target,\r | |
765 | IN UINT64 Lun,\r | |
766 | IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r | |
767 | )\r | |
768 | {\r | |
769 | UINT16 TargetValue;\r | |
770 | VSCSI_DEV *Dev;\r | |
771 | SCSI_DEVICE_PATH *ScsiDevicePath;\r | |
772 | \r | |
773 | if (DevicePath == NULL) {\r | |
774 | return EFI_INVALID_PARAMETER;\r | |
775 | }\r | |
776 | \r | |
777 | CopyMem (&TargetValue, Target, sizeof TargetValue);\r | |
778 | Dev = VIRTIO_SCSI_FROM_PASS_THRU (This);\r | |
779 | if (TargetValue > Dev->MaxTarget || Lun > Dev->MaxLun || Lun > 0xFFFF) {\r | |
780 | return EFI_NOT_FOUND;\r | |
781 | }\r | |
782 | \r | |
783 | ScsiDevicePath = AllocatePool (sizeof *ScsiDevicePath);\r | |
784 | if (ScsiDevicePath == NULL) {\r | |
785 | return EFI_OUT_OF_RESOURCES;\r | |
786 | }\r | |
787 | \r | |
788 | ScsiDevicePath->Header.Type = MESSAGING_DEVICE_PATH;\r | |
789 | ScsiDevicePath->Header.SubType = MSG_SCSI_DP;\r | |
790 | ScsiDevicePath->Header.Length[0] = (UINT8) sizeof *ScsiDevicePath;\r | |
791 | ScsiDevicePath->Header.Length[1] = (UINT8) (sizeof *ScsiDevicePath >> 8);\r | |
792 | ScsiDevicePath->Pun = TargetValue;\r | |
793 | ScsiDevicePath->Lun = (UINT16) Lun;\r | |
794 | \r | |
795 | *DevicePath = &ScsiDevicePath->Header;\r | |
796 | return EFI_SUCCESS;\r | |
797 | }\r | |
798 | \r | |
799 | \r | |
800 | EFI_STATUS\r | |
801 | EFIAPI\r | |
802 | VirtioScsiGetTargetLun (\r | |
803 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
804 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
805 | OUT UINT8 **TargetPointer,\r | |
806 | OUT UINT64 *Lun\r | |
807 | )\r | |
808 | {\r | |
809 | SCSI_DEVICE_PATH *ScsiDevicePath;\r | |
810 | VSCSI_DEV *Dev;\r | |
811 | UINT8 *Target;\r | |
812 | \r | |
813 | if (DevicePath == NULL || TargetPointer == NULL || *TargetPointer == NULL ||\r | |
814 | Lun == NULL) {\r | |
815 | return EFI_INVALID_PARAMETER;\r | |
816 | }\r | |
817 | \r | |
818 | if (DevicePath->Type != MESSAGING_DEVICE_PATH ||\r | |
819 | DevicePath->SubType != MSG_SCSI_DP) {\r | |
820 | return EFI_UNSUPPORTED;\r | |
821 | }\r | |
822 | \r | |
823 | ScsiDevicePath = (SCSI_DEVICE_PATH *) DevicePath;\r | |
824 | Dev = VIRTIO_SCSI_FROM_PASS_THRU (This);\r | |
825 | if (ScsiDevicePath->Pun > Dev->MaxTarget ||\r | |
826 | ScsiDevicePath->Lun > Dev->MaxLun) {\r | |
827 | return EFI_NOT_FOUND;\r | |
828 | }\r | |
829 | \r | |
830 | //\r | |
831 | // a) the TargetPointer input parameter is unnecessarily a pointer-to-pointer\r | |
832 | // b) see the TARGET_MAX_BYTES check in "VirtioScsi.h"\r | |
833 | // c) ScsiDevicePath->Pun is an UINT16\r | |
834 | //\r | |
835 | Target = *TargetPointer;\r | |
836 | CopyMem (Target, &ScsiDevicePath->Pun, 2);\r | |
837 | SetMem (Target + 2, TARGET_MAX_BYTES - 2, 0x00);\r | |
838 | \r | |
839 | *Lun = ScsiDevicePath->Lun;\r | |
840 | return EFI_SUCCESS;\r | |
841 | }\r | |
842 | \r | |
843 | \r | |
844 | EFI_STATUS\r | |
845 | EFIAPI\r | |
846 | VirtioScsiResetChannel (\r | |
847 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This\r | |
848 | )\r | |
849 | {\r | |
850 | return EFI_UNSUPPORTED;\r | |
851 | }\r | |
852 | \r | |
853 | \r | |
854 | EFI_STATUS\r | |
855 | EFIAPI\r | |
856 | VirtioScsiResetTargetLun (\r | |
857 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
858 | IN UINT8 *Target,\r | |
859 | IN UINT64 Lun\r | |
860 | )\r | |
861 | {\r | |
862 | return EFI_UNSUPPORTED;\r | |
863 | }\r | |
864 | \r | |
865 | \r | |
866 | EFI_STATUS\r | |
867 | EFIAPI\r | |
868 | VirtioScsiGetNextTarget (\r | |
869 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
870 | IN OUT UINT8 **TargetPointer\r | |
871 | )\r | |
872 | {\r | |
873 | UINT8 *Target;\r | |
874 | UINTN Idx;\r | |
875 | UINT16 LastTarget;\r | |
876 | VSCSI_DEV *Dev;\r | |
877 | \r | |
878 | //\r | |
879 | // the TargetPointer input parameter is unnecessarily a pointer-to-pointer\r | |
880 | //\r | |
881 | Target = *TargetPointer;\r | |
882 | \r | |
883 | //\r | |
884 | // Search for first non-0xFF byte. If not found, return first target.\r | |
885 | //\r | |
886 | for (Idx = 0; Idx < TARGET_MAX_BYTES && Target[Idx] == 0xFF; ++Idx)\r | |
887 | ;\r | |
888 | if (Idx == TARGET_MAX_BYTES) {\r | |
889 | SetMem (Target, TARGET_MAX_BYTES, 0x00);\r | |
890 | return EFI_SUCCESS;\r | |
891 | }\r | |
892 | \r | |
893 | //\r | |
894 | // see the TARGET_MAX_BYTES check in "VirtioScsi.h"\r | |
895 | //\r | |
896 | CopyMem (&LastTarget, Target, sizeof LastTarget);\r | |
897 | \r | |
898 | //\r | |
899 | // increment target if valid on input\r | |
900 | //\r | |
901 | Dev = VIRTIO_SCSI_FROM_PASS_THRU (This);\r | |
902 | if (LastTarget > Dev->MaxTarget) {\r | |
903 | return EFI_INVALID_PARAMETER;\r | |
904 | }\r | |
905 | \r | |
906 | if (LastTarget < Dev->MaxTarget) {\r | |
907 | ++LastTarget;\r | |
908 | CopyMem (Target, &LastTarget, sizeof LastTarget);\r | |
909 | return EFI_SUCCESS;\r | |
910 | }\r | |
911 | \r | |
912 | return EFI_NOT_FOUND;\r | |
913 | }\r | |
914 | \r | |
915 | \r | |
916 | STATIC\r | |
917 | EFI_STATUS\r | |
918 | EFIAPI\r | |
919 | VirtioScsiInit (\r | |
920 | IN OUT VSCSI_DEV *Dev\r | |
921 | )\r | |
922 | {\r | |
923 | UINT8 NextDevStat;\r | |
924 | EFI_STATUS Status;\r | |
fc2168fe | 925 | UINT64 RingBaseShift;\r |
bc8fde6f | 926 | UINT64 Features;\r |
37078a63 | 927 | UINT16 MaxChannel; // for validation only\r |
928 | UINT32 NumQueues; // for validation only\r | |
929 | UINT16 QueueSize;\r | |
930 | \r | |
931 | //\r | |
932 | // Execute virtio-0.9.5, 2.2.1 Device Initialization Sequence.\r | |
933 | //\r | |
934 | NextDevStat = 0; // step 1 -- reset device\r | |
56f65ed8 | 935 | Status = Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, NextDevStat);\r |
37078a63 | 936 | if (EFI_ERROR (Status)) {\r |
937 | goto Failed;\r | |
938 | }\r | |
939 | \r | |
940 | NextDevStat |= VSTAT_ACK; // step 2 -- acknowledge device presence\r | |
56f65ed8 | 941 | Status = Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, NextDevStat);\r |
37078a63 | 942 | if (EFI_ERROR (Status)) {\r |
943 | goto Failed;\r | |
944 | }\r | |
945 | \r | |
946 | NextDevStat |= VSTAT_DRIVER; // step 3 -- we know how to drive it\r | |
56f65ed8 OM |
947 | Status = Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, NextDevStat);\r |
948 | if (EFI_ERROR (Status)) {\r | |
949 | goto Failed;\r | |
950 | }\r | |
951 | \r | |
952 | //\r | |
953 | // Set Page Size - MMIO VirtIo Specific\r | |
954 | //\r | |
955 | Status = Dev->VirtIo->SetPageSize (Dev->VirtIo, EFI_PAGE_SIZE);\r | |
37078a63 | 956 | if (EFI_ERROR (Status)) {\r |
957 | goto Failed;\r | |
958 | }\r | |
959 | \r | |
960 | //\r | |
961 | // step 4a -- retrieve and validate features\r | |
962 | //\r | |
56f65ed8 | 963 | Status = Dev->VirtIo->GetDeviceFeatures (Dev->VirtIo, &Features);\r |
37078a63 | 964 | if (EFI_ERROR (Status)) {\r |
965 | goto Failed;\r | |
966 | }\r | |
c4046161 | 967 | Dev->InOutSupported = (BOOLEAN) ((Features & VIRTIO_SCSI_F_INOUT) != 0);\r |
37078a63 | 968 | \r |
56f65ed8 | 969 | Status = VIRTIO_CFG_READ (Dev, MaxChannel, &MaxChannel);\r |
37078a63 | 970 | if (EFI_ERROR (Status)) {\r |
971 | goto Failed;\r | |
972 | }\r | |
973 | if (MaxChannel != 0) {\r | |
974 | //\r | |
975 | // this driver is for a single-channel virtio-scsi HBA\r | |
976 | //\r | |
977 | Status = EFI_UNSUPPORTED;\r | |
978 | goto Failed;\r | |
979 | }\r | |
980 | \r | |
56f65ed8 | 981 | Status = VIRTIO_CFG_READ (Dev, NumQueues, &NumQueues);\r |
37078a63 | 982 | if (EFI_ERROR (Status)) {\r |
983 | goto Failed;\r | |
984 | }\r | |
985 | if (NumQueues < 1) {\r | |
986 | Status = EFI_UNSUPPORTED;\r | |
987 | goto Failed;\r | |
988 | }\r | |
989 | \r | |
56f65ed8 | 990 | Status = VIRTIO_CFG_READ (Dev, MaxTarget, &Dev->MaxTarget);\r |
37078a63 | 991 | if (EFI_ERROR (Status)) {\r |
992 | goto Failed;\r | |
993 | }\r | |
994 | if (Dev->MaxTarget > PcdGet16 (PcdVirtioScsiMaxTargetLimit)) {\r | |
995 | Dev->MaxTarget = PcdGet16 (PcdVirtioScsiMaxTargetLimit);\r | |
996 | }\r | |
997 | \r | |
56f65ed8 | 998 | Status = VIRTIO_CFG_READ (Dev, MaxLun, &Dev->MaxLun);\r |
37078a63 | 999 | if (EFI_ERROR (Status)) {\r |
1000 | goto Failed;\r | |
1001 | }\r | |
1002 | if (Dev->MaxLun > PcdGet32 (PcdVirtioScsiMaxLunLimit)) {\r | |
1003 | Dev->MaxLun = PcdGet32 (PcdVirtioScsiMaxLunLimit);\r | |
1004 | }\r | |
1005 | \r | |
56f65ed8 | 1006 | Status = VIRTIO_CFG_READ (Dev, MaxSectors, &Dev->MaxSectors);\r |
37078a63 | 1007 | if (EFI_ERROR (Status)) {\r |
1008 | goto Failed;\r | |
1009 | }\r | |
1010 | if (Dev->MaxSectors < 2) {\r | |
1011 | //\r | |
1012 | // We must be able to halve it for bidirectional transfers\r | |
1013 | // (see EFI_BAD_BUFFER_SIZE in PopulateRequest()).\r | |
1014 | //\r | |
1015 | Status = EFI_UNSUPPORTED;\r | |
1016 | goto Failed;\r | |
1017 | }\r | |
1018 | \r | |
17cbf735 BS |
1019 | Features &= VIRTIO_SCSI_F_INOUT | VIRTIO_F_VERSION_1 |\r |
1020 | VIRTIO_F_IOMMU_PLATFORM;\r | |
39c2d339 LE |
1021 | \r |
1022 | //\r | |
1023 | // In virtio-1.0, feature negotiation is expected to complete before queue\r | |
1024 | // discovery, and the device can also reject the selected set of features.\r | |
1025 | //\r | |
1026 | if (Dev->VirtIo->Revision >= VIRTIO_SPEC_REVISION (1, 0, 0)) {\r | |
1027 | Status = Virtio10WriteFeatures (Dev->VirtIo, Features, &NextDevStat);\r | |
1028 | if (EFI_ERROR (Status)) {\r | |
1029 | goto Failed;\r | |
1030 | }\r | |
1031 | }\r | |
1032 | \r | |
37078a63 | 1033 | //\r |
1034 | // step 4b -- allocate request virtqueue\r | |
1035 | //\r | |
56f65ed8 | 1036 | Status = Dev->VirtIo->SetQueueSel (Dev->VirtIo, VIRTIO_SCSI_REQUEST_QUEUE);\r |
37078a63 | 1037 | if (EFI_ERROR (Status)) {\r |
1038 | goto Failed;\r | |
1039 | }\r | |
56f65ed8 | 1040 | Status = Dev->VirtIo->GetQueueNumMax (Dev->VirtIo, &QueueSize);\r |
37078a63 | 1041 | if (EFI_ERROR (Status)) {\r |
1042 | goto Failed;\r | |
1043 | }\r | |
1044 | //\r | |
1045 | // VirtioScsiPassThru() uses at most four descriptors\r | |
1046 | //\r | |
1047 | if (QueueSize < 4) {\r | |
1048 | Status = EFI_UNSUPPORTED;\r | |
1049 | goto Failed;\r | |
1050 | }\r | |
1051 | \r | |
fc2c1543 | 1052 | Status = VirtioRingInit (Dev->VirtIo, QueueSize, &Dev->Ring);\r |
37078a63 | 1053 | if (EFI_ERROR (Status)) {\r |
1054 | goto Failed;\r | |
1055 | }\r | |
1056 | \r | |
fc2168fe BS |
1057 | //\r |
1058 | // If anything fails from here on, we must release the ring resources\r | |
1059 | //\r | |
1060 | Status = VirtioRingMap (\r | |
1061 | Dev->VirtIo,\r | |
1062 | &Dev->Ring,\r | |
1063 | &RingBaseShift,\r | |
1064 | &Dev->RingMap\r | |
1065 | );\r | |
1066 | if (EFI_ERROR (Status)) {\r | |
1067 | goto ReleaseQueue;\r | |
1068 | }\r | |
1069 | \r | |
37078a63 | 1070 | //\r |
56f65ed8 | 1071 | // Additional steps for MMIO: align the queue appropriately, and set the\r |
fc2168fe | 1072 | // size. If anything fails from here on, we must unmap the ring resources.\r |
37078a63 | 1073 | //\r |
56f65ed8 OM |
1074 | Status = Dev->VirtIo->SetQueueNum (Dev->VirtIo, QueueSize);\r |
1075 | if (EFI_ERROR (Status)) {\r | |
fc2168fe | 1076 | goto UnmapQueue;\r |
56f65ed8 OM |
1077 | }\r |
1078 | \r | |
1079 | Status = Dev->VirtIo->SetQueueAlign (Dev->VirtIo, EFI_PAGE_SIZE);\r | |
1080 | if (EFI_ERROR (Status)) {\r | |
fc2168fe | 1081 | goto UnmapQueue;\r |
56f65ed8 OM |
1082 | }\r |
1083 | \r | |
1084 | //\r | |
1085 | // step 4c -- Report GPFN (guest-physical frame number) of queue.\r | |
1086 | //\r | |
fc2168fe BS |
1087 | Status = Dev->VirtIo->SetQueueAddress (\r |
1088 | Dev->VirtIo,\r | |
1089 | &Dev->Ring,\r | |
1090 | RingBaseShift\r | |
1091 | );\r | |
37078a63 | 1092 | if (EFI_ERROR (Status)) {\r |
fc2168fe | 1093 | goto UnmapQueue;\r |
37078a63 | 1094 | }\r |
1095 | \r | |
1096 | //\r | |
39c2d339 | 1097 | // step 5 -- Report understood features and guest-tuneables.\r |
37078a63 | 1098 | //\r |
39c2d339 | 1099 | if (Dev->VirtIo->Revision < VIRTIO_SPEC_REVISION (1, 0, 0)) {\r |
17cbf735 | 1100 | Features &= ~(UINT64)(VIRTIO_F_VERSION_1 | VIRTIO_F_IOMMU_PLATFORM);\r |
39c2d339 LE |
1101 | Status = Dev->VirtIo->SetGuestFeatures (Dev->VirtIo, Features);\r |
1102 | if (EFI_ERROR (Status)) {\r | |
fc2168fe | 1103 | goto UnmapQueue;\r |
39c2d339 | 1104 | }\r |
37078a63 | 1105 | }\r |
1106 | \r | |
1107 | //\r | |
1108 | // We expect these maximum sizes from the host. Since they are\r | |
1109 | // guest-negotiable, ask for them rather than just checking them.\r | |
1110 | //\r | |
56f65ed8 | 1111 | Status = VIRTIO_CFG_WRITE (Dev, CdbSize, VIRTIO_SCSI_CDB_SIZE);\r |
37078a63 | 1112 | if (EFI_ERROR (Status)) {\r |
fc2168fe | 1113 | goto UnmapQueue;\r |
37078a63 | 1114 | }\r |
56f65ed8 | 1115 | Status = VIRTIO_CFG_WRITE (Dev, SenseSize, VIRTIO_SCSI_SENSE_SIZE);\r |
37078a63 | 1116 | if (EFI_ERROR (Status)) {\r |
fc2168fe | 1117 | goto UnmapQueue;\r |
37078a63 | 1118 | }\r |
1119 | \r | |
1120 | //\r | |
1121 | // step 6 -- initialization complete\r | |
1122 | //\r | |
1123 | NextDevStat |= VSTAT_DRIVER_OK;\r | |
56f65ed8 | 1124 | Status = Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, NextDevStat);\r |
37078a63 | 1125 | if (EFI_ERROR (Status)) {\r |
fc2168fe | 1126 | goto UnmapQueue;\r |
37078a63 | 1127 | }\r |
1128 | \r | |
1129 | //\r | |
1130 | // populate the exported interface's attributes\r | |
1131 | //\r | |
1132 | Dev->PassThru.Mode = &Dev->PassThruMode;\r | |
1133 | Dev->PassThru.PassThru = &VirtioScsiPassThru;\r | |
1134 | Dev->PassThru.GetNextTargetLun = &VirtioScsiGetNextTargetLun;\r | |
1135 | Dev->PassThru.BuildDevicePath = &VirtioScsiBuildDevicePath;\r | |
1136 | Dev->PassThru.GetTargetLun = &VirtioScsiGetTargetLun;\r | |
1137 | Dev->PassThru.ResetChannel = &VirtioScsiResetChannel;\r | |
1138 | Dev->PassThru.ResetTargetLun = &VirtioScsiResetTargetLun;\r | |
1139 | Dev->PassThru.GetNextTarget = &VirtioScsiGetNextTarget;\r | |
1140 | \r | |
1141 | //\r | |
1142 | // AdapterId is a target for which no handle will be created during bus scan.\r | |
1143 | // Prevent any conflict with real devices.\r | |
1144 | //\r | |
1145 | Dev->PassThruMode.AdapterId = 0xFFFFFFFF;\r | |
1146 | \r | |
1147 | //\r | |
1148 | // Set both physical and logical attributes for non-RAID SCSI channel. See\r | |
1149 | // Driver Writer's Guide for UEFI 2.3.1 v1.01, 20.1.5 Implementing Extended\r | |
1150 | // SCSI Pass Thru Protocol.\r | |
1151 | //\r | |
1152 | Dev->PassThruMode.Attributes = EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL |\r | |
1153 | EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL;\r | |
1154 | \r | |
1155 | //\r | |
1156 | // no restriction on transfer buffer alignment\r | |
1157 | //\r | |
1158 | Dev->PassThruMode.IoAlign = 0;\r | |
1159 | \r | |
1160 | return EFI_SUCCESS;\r | |
1161 | \r | |
fc2168fe BS |
1162 | UnmapQueue:\r |
1163 | Dev->VirtIo->UnmapSharedBuffer (Dev->VirtIo, Dev->RingMap);\r | |
1164 | \r | |
37078a63 | 1165 | ReleaseQueue:\r |
fc2c1543 | 1166 | VirtioRingUninit (Dev->VirtIo, &Dev->Ring);\r |
37078a63 | 1167 | \r |
1168 | Failed:\r | |
1169 | //\r | |
1170 | // Notify the host about our failure to setup: virtio-0.9.5, 2.2.2.1 Device\r | |
56f65ed8 | 1171 | // Status. VirtIo access failure here should not mask the original error.\r |
37078a63 | 1172 | //\r |
1173 | NextDevStat |= VSTAT_FAILED;\r | |
56f65ed8 | 1174 | Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, NextDevStat);\r |
37078a63 | 1175 | \r |
1176 | Dev->InOutSupported = FALSE;\r | |
1177 | Dev->MaxTarget = 0;\r | |
1178 | Dev->MaxLun = 0;\r | |
1179 | Dev->MaxSectors = 0;\r | |
1180 | \r | |
1181 | return Status; // reached only via Failed above\r | |
1182 | }\r | |
1183 | \r | |
1184 | \r | |
37078a63 | 1185 | STATIC\r |
1186 | VOID\r | |
1187 | EFIAPI\r | |
1188 | VirtioScsiUninit (\r | |
1189 | IN OUT VSCSI_DEV *Dev\r | |
1190 | )\r | |
1191 | {\r | |
1192 | //\r | |
1193 | // Reset the virtual device -- see virtio-0.9.5, 2.2.2.1 Device Status. When\r | |
1194 | // VIRTIO_CFG_WRITE() returns, the host will have learned to stay away from\r | |
1195 | // the old comms area.\r | |
1196 | //\r | |
56f65ed8 | 1197 | Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, 0);\r |
37078a63 | 1198 | \r |
1199 | Dev->InOutSupported = FALSE;\r | |
1200 | Dev->MaxTarget = 0;\r | |
1201 | Dev->MaxLun = 0;\r | |
1202 | Dev->MaxSectors = 0;\r | |
1203 | \r | |
fc2168fe | 1204 | Dev->VirtIo->UnmapSharedBuffer (Dev->VirtIo, Dev->RingMap);\r |
fc2c1543 | 1205 | VirtioRingUninit (Dev->VirtIo, &Dev->Ring);\r |
37078a63 | 1206 | \r |
1207 | SetMem (&Dev->PassThru, sizeof Dev->PassThru, 0x00);\r | |
1208 | SetMem (&Dev->PassThruMode, sizeof Dev->PassThruMode, 0x00);\r | |
1209 | }\r | |
1210 | \r | |
1211 | \r | |
fbc80813 LE |
1212 | //\r |
1213 | // Event notification function enqueued by ExitBootServices().\r | |
1214 | //\r | |
1215 | \r | |
1216 | STATIC\r | |
1217 | VOID\r | |
1218 | EFIAPI\r | |
1219 | VirtioScsiExitBoot (\r | |
1220 | IN EFI_EVENT Event,\r | |
1221 | IN VOID *Context\r | |
1222 | )\r | |
1223 | {\r | |
1224 | VSCSI_DEV *Dev;\r | |
1225 | \r | |
bf99bdd1 | 1226 | DEBUG ((DEBUG_VERBOSE, "%a: Context=0x%p\n", __FUNCTION__, Context));\r |
fbc80813 LE |
1227 | //\r |
1228 | // Reset the device. This causes the hypervisor to forget about the virtio\r | |
1229 | // ring.\r | |
1230 | //\r | |
1231 | // We allocated said ring in EfiBootServicesData type memory, and code\r | |
1232 | // executing after ExitBootServices() is permitted to overwrite it.\r | |
1233 | //\r | |
1234 | Dev = Context;\r | |
1235 | Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, 0);\r | |
1236 | }\r | |
1237 | \r | |
1238 | \r | |
37078a63 | 1239 | //\r |
1240 | // Probe, start and stop functions of this driver, called by the DXE core for\r | |
1241 | // specific devices.\r | |
1242 | //\r | |
1243 | // The following specifications document these interfaces:\r | |
1244 | // - Driver Writer's Guide for UEFI 2.3.1 v1.01, 9 Driver Binding Protocol\r | |
1245 | // - UEFI Spec 2.3.1 + Errata C, 10.1 EFI Driver Binding Protocol\r | |
1246 | //\r | |
1247 | // The implementation follows:\r | |
1248 | // - Driver Writer's Guide for UEFI 2.3.1 v1.01\r | |
1249 | // - 5.1.3.4 OpenProtocol() and CloseProtocol()\r | |
37078a63 | 1250 | // - UEFI Spec 2.3.1 + Errata C\r |
1251 | // - 6.3 Protocol Handler Services\r | |
37078a63 | 1252 | //\r |
1253 | \r | |
1254 | EFI_STATUS\r | |
1255 | EFIAPI\r | |
1256 | VirtioScsiDriverBindingSupported (\r | |
1257 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
1258 | IN EFI_HANDLE DeviceHandle,\r | |
1259 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
1260 | )\r | |
1261 | {\r | |
56f65ed8 OM |
1262 | EFI_STATUS Status;\r |
1263 | VIRTIO_DEVICE_PROTOCOL *VirtIo;\r | |
37078a63 | 1264 | \r |
1265 | //\r | |
56f65ed8 OM |
1266 | // Attempt to open the device with the VirtIo set of interfaces. On success,\r |
1267 | // the protocol is "instantiated" for the VirtIo device. Covers duplicate open\r | |
37078a63 | 1268 | // attempts (EFI_ALREADY_STARTED).\r |
1269 | //\r | |
1270 | Status = gBS->OpenProtocol (\r | |
1271 | DeviceHandle, // candidate device\r | |
56f65ed8 OM |
1272 | &gVirtioDeviceProtocolGuid, // for generic VirtIo access\r |
1273 | (VOID **)&VirtIo, // handle to instantiate\r | |
37078a63 | 1274 | This->DriverBindingHandle, // requestor driver identity\r |
1275 | DeviceHandle, // ControllerHandle, according to\r | |
1276 | // the UEFI Driver Model\r | |
56f65ed8 | 1277 | EFI_OPEN_PROTOCOL_BY_DRIVER // get exclusive VirtIo access to\r |
37078a63 | 1278 | // the device; to be released\r |
1279 | );\r | |
1280 | if (EFI_ERROR (Status)) {\r | |
1281 | return Status;\r | |
1282 | }\r | |
1283 | \r | |
56f65ed8 OM |
1284 | if (VirtIo->SubSystemDeviceId != VIRTIO_SUBSYSTEM_SCSI_HOST) {\r |
1285 | Status = EFI_UNSUPPORTED;\r | |
37078a63 | 1286 | }\r |
1287 | \r | |
1288 | //\r | |
56f65ed8 | 1289 | // We needed VirtIo access only transitorily, to see whether we support the\r |
37078a63 | 1290 | // device or not.\r |
1291 | //\r | |
56f65ed8 | 1292 | gBS->CloseProtocol (DeviceHandle, &gVirtioDeviceProtocolGuid,\r |
37078a63 | 1293 | This->DriverBindingHandle, DeviceHandle);\r |
1294 | return Status;\r | |
1295 | }\r | |
1296 | \r | |
1297 | \r | |
1298 | EFI_STATUS\r | |
1299 | EFIAPI\r | |
1300 | VirtioScsiDriverBindingStart (\r | |
1301 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
1302 | IN EFI_HANDLE DeviceHandle,\r | |
1303 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
1304 | )\r | |
1305 | {\r | |
1306 | VSCSI_DEV *Dev;\r | |
1307 | EFI_STATUS Status;\r | |
1308 | \r | |
1309 | Dev = (VSCSI_DEV *) AllocateZeroPool (sizeof *Dev);\r | |
1310 | if (Dev == NULL) {\r | |
1311 | return EFI_OUT_OF_RESOURCES;\r | |
1312 | }\r | |
1313 | \r | |
56f65ed8 OM |
1314 | Status = gBS->OpenProtocol (DeviceHandle, &gVirtioDeviceProtocolGuid,\r |
1315 | (VOID **)&Dev->VirtIo, This->DriverBindingHandle,\r | |
37078a63 | 1316 | DeviceHandle, EFI_OPEN_PROTOCOL_BY_DRIVER);\r |
1317 | if (EFI_ERROR (Status)) {\r | |
1318 | goto FreeVirtioScsi;\r | |
1319 | }\r | |
1320 | \r | |
1321 | //\r | |
56f65ed8 | 1322 | // VirtIo access granted, configure virtio-scsi device.\r |
37078a63 | 1323 | //\r |
1324 | Status = VirtioScsiInit (Dev);\r | |
1325 | if (EFI_ERROR (Status)) {\r | |
56f65ed8 | 1326 | goto CloseVirtIo;\r |
37078a63 | 1327 | }\r |
1328 | \r | |
fbc80813 LE |
1329 | Status = gBS->CreateEvent (EVT_SIGNAL_EXIT_BOOT_SERVICES, TPL_CALLBACK,\r |
1330 | &VirtioScsiExitBoot, Dev, &Dev->ExitBoot);\r | |
1331 | if (EFI_ERROR (Status)) {\r | |
1332 | goto UninitDev;\r | |
1333 | }\r | |
1334 | \r | |
37078a63 | 1335 | //\r |
1336 | // Setup complete, attempt to export the driver instance's PassThru\r | |
1337 | // interface.\r | |
1338 | //\r | |
1339 | Dev->Signature = VSCSI_SIG;\r | |
1340 | Status = gBS->InstallProtocolInterface (&DeviceHandle,\r | |
1341 | &gEfiExtScsiPassThruProtocolGuid, EFI_NATIVE_INTERFACE,\r | |
1342 | &Dev->PassThru);\r | |
1343 | if (EFI_ERROR (Status)) {\r | |
fbc80813 | 1344 | goto CloseExitBoot;\r |
37078a63 | 1345 | }\r |
1346 | \r | |
1347 | return EFI_SUCCESS;\r | |
1348 | \r | |
fbc80813 LE |
1349 | CloseExitBoot:\r |
1350 | gBS->CloseEvent (Dev->ExitBoot);\r | |
1351 | \r | |
37078a63 | 1352 | UninitDev:\r |
1353 | VirtioScsiUninit (Dev);\r | |
1354 | \r | |
56f65ed8 OM |
1355 | CloseVirtIo:\r |
1356 | gBS->CloseProtocol (DeviceHandle, &gVirtioDeviceProtocolGuid,\r | |
37078a63 | 1357 | This->DriverBindingHandle, DeviceHandle);\r |
1358 | \r | |
1359 | FreeVirtioScsi:\r | |
1360 | FreePool (Dev);\r | |
1361 | \r | |
1362 | return Status;\r | |
1363 | }\r | |
1364 | \r | |
1365 | \r | |
1366 | EFI_STATUS\r | |
1367 | EFIAPI\r | |
1368 | VirtioScsiDriverBindingStop (\r | |
1369 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
1370 | IN EFI_HANDLE DeviceHandle,\r | |
1371 | IN UINTN NumberOfChildren,\r | |
1372 | IN EFI_HANDLE *ChildHandleBuffer\r | |
1373 | )\r | |
1374 | {\r | |
1375 | EFI_STATUS Status;\r | |
1376 | EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru;\r | |
1377 | VSCSI_DEV *Dev;\r | |
1378 | \r | |
1379 | Status = gBS->OpenProtocol (\r | |
1380 | DeviceHandle, // candidate device\r | |
1381 | &gEfiExtScsiPassThruProtocolGuid, // retrieve the SCSI iface\r | |
1382 | (VOID **)&PassThru, // target pointer\r | |
1383 | This->DriverBindingHandle, // requestor driver ident.\r | |
1384 | DeviceHandle, // lookup req. for dev.\r | |
1385 | EFI_OPEN_PROTOCOL_GET_PROTOCOL // lookup only, no new ref.\r | |
1386 | );\r | |
1387 | if (EFI_ERROR (Status)) {\r | |
1388 | return Status;\r | |
1389 | }\r | |
1390 | \r | |
1391 | Dev = VIRTIO_SCSI_FROM_PASS_THRU (PassThru);\r | |
1392 | \r | |
1393 | //\r | |
1394 | // Handle Stop() requests for in-use driver instances gracefully.\r | |
1395 | //\r | |
1396 | Status = gBS->UninstallProtocolInterface (DeviceHandle,\r | |
1397 | &gEfiExtScsiPassThruProtocolGuid, &Dev->PassThru);\r | |
1398 | if (EFI_ERROR (Status)) {\r | |
1399 | return Status;\r | |
1400 | }\r | |
1401 | \r | |
fbc80813 LE |
1402 | gBS->CloseEvent (Dev->ExitBoot);\r |
1403 | \r | |
37078a63 | 1404 | VirtioScsiUninit (Dev);\r |
1405 | \r | |
56f65ed8 | 1406 | gBS->CloseProtocol (DeviceHandle, &gVirtioDeviceProtocolGuid,\r |
37078a63 | 1407 | This->DriverBindingHandle, DeviceHandle);\r |
1408 | \r | |
1409 | FreePool (Dev);\r | |
1410 | \r | |
1411 | return EFI_SUCCESS;\r | |
1412 | }\r | |
1413 | \r | |
1414 | \r | |
1415 | //\r | |
1416 | // The static object that groups the Supported() (ie. probe), Start() and\r | |
1417 | // Stop() functions of the driver together. Refer to UEFI Spec 2.3.1 + Errata\r | |
1418 | // C, 10.1 EFI Driver Binding Protocol.\r | |
1419 | //\r | |
1420 | STATIC EFI_DRIVER_BINDING_PROTOCOL gDriverBinding = {\r | |
1421 | &VirtioScsiDriverBindingSupported,\r | |
1422 | &VirtioScsiDriverBindingStart,\r | |
1423 | &VirtioScsiDriverBindingStop,\r | |
1424 | 0x10, // Version, must be in [0x10 .. 0xFFFFFFEF] for IHV-developed drivers\r | |
1425 | NULL, // ImageHandle, to be overwritten by\r | |
1426 | // EfiLibInstallDriverBindingComponentName2() in VirtioScsiEntryPoint()\r | |
1427 | NULL // DriverBindingHandle, ditto\r | |
1428 | };\r | |
1429 | \r | |
1430 | \r | |
1431 | //\r | |
1432 | // The purpose of the following scaffolding (EFI_COMPONENT_NAME_PROTOCOL and\r | |
1433 | // EFI_COMPONENT_NAME2_PROTOCOL implementation) is to format the driver's name\r | |
1434 | // in English, for display on standard console devices. This is recommended for\r | |
1435 | // UEFI drivers that follow the UEFI Driver Model. Refer to the Driver Writer's\r | |
1436 | // Guide for UEFI 2.3.1 v1.01, 11 UEFI Driver and Controller Names.\r | |
1437 | //\r | |
1438 | // Device type names ("Virtio SCSI Host Device") are not formatted because the\r | |
1439 | // driver supports only that device type. Therefore the driver name suffices\r | |
1440 | // for unambiguous identification.\r | |
1441 | //\r | |
1442 | \r | |
1443 | STATIC\r | |
1444 | EFI_UNICODE_STRING_TABLE mDriverNameTable[] = {\r | |
1445 | { "eng;en", L"Virtio SCSI Host Driver" },\r | |
1446 | { NULL, NULL }\r | |
1447 | };\r | |
1448 | \r | |
1449 | STATIC\r | |
1450 | EFI_COMPONENT_NAME_PROTOCOL gComponentName;\r | |
1451 | \r | |
1452 | EFI_STATUS\r | |
1453 | EFIAPI\r | |
1454 | VirtioScsiGetDriverName (\r | |
1455 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
1456 | IN CHAR8 *Language,\r | |
1457 | OUT CHAR16 **DriverName\r | |
1458 | )\r | |
1459 | {\r | |
1460 | return LookupUnicodeString2 (\r | |
1461 | Language,\r | |
1462 | This->SupportedLanguages,\r | |
1463 | mDriverNameTable,\r | |
1464 | DriverName,\r | |
1465 | (BOOLEAN)(This == &gComponentName) // Iso639Language\r | |
1466 | );\r | |
1467 | }\r | |
1468 | \r | |
1469 | EFI_STATUS\r | |
1470 | EFIAPI\r | |
1471 | VirtioScsiGetDeviceName (\r | |
1472 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
1473 | IN EFI_HANDLE DeviceHandle,\r | |
1474 | IN EFI_HANDLE ChildHandle,\r | |
1475 | IN CHAR8 *Language,\r | |
1476 | OUT CHAR16 **ControllerName\r | |
1477 | )\r | |
1478 | {\r | |
1479 | return EFI_UNSUPPORTED;\r | |
1480 | }\r | |
1481 | \r | |
1482 | STATIC\r | |
1483 | EFI_COMPONENT_NAME_PROTOCOL gComponentName = {\r | |
1484 | &VirtioScsiGetDriverName,\r | |
1485 | &VirtioScsiGetDeviceName,\r | |
1486 | "eng" // SupportedLanguages, ISO 639-2 language codes\r | |
1487 | };\r | |
1488 | \r | |
1489 | STATIC\r | |
1490 | EFI_COMPONENT_NAME2_PROTOCOL gComponentName2 = {\r | |
1491 | (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) &VirtioScsiGetDriverName,\r | |
1492 | (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) &VirtioScsiGetDeviceName,\r | |
1493 | "en" // SupportedLanguages, RFC 4646 language codes\r | |
1494 | };\r | |
1495 | \r | |
1496 | \r | |
1497 | //\r | |
1498 | // Entry point of this driver.\r | |
1499 | //\r | |
1500 | EFI_STATUS\r | |
1501 | EFIAPI\r | |
1502 | VirtioScsiEntryPoint (\r | |
1503 | IN EFI_HANDLE ImageHandle,\r | |
1504 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
1505 | )\r | |
1506 | {\r | |
1507 | return EfiLibInstallDriverBindingComponentName2 (\r | |
1508 | ImageHandle,\r | |
1509 | SystemTable,\r | |
1510 | &gDriverBinding,\r | |
1511 | ImageHandle,\r | |
1512 | &gComponentName,\r | |
1513 | &gComponentName2\r | |
1514 | );\r | |
1515 | }\r |