3 This driver produces Extended SCSI Pass Thru Protocol instances for
6 The implementation is basic:
8 - No hotplug / hot-unplug.
10 - Although EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru() could be a good match
11 for multiple in-flight virtio-scsi requests, we stick to synchronous
14 - Timeouts are not supported for EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru().
16 - Only one channel is supported. (At the time of this writing, host-side
17 virtio-scsi supports a single channel too.)
19 - Only one request queue is used (for the one synchronous request).
21 - The ResetChannel() and ResetTargetLun() functions of
22 EFI_EXT_SCSI_PASS_THRU_PROTOCOL are not supported (which is allowed by the
23 UEFI 2.3.1 Errata C specification), although
24 VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET could be a good match. That would
25 however require client code for the control queue, which is deemed
28 Copyright (C) 2012, Red Hat, Inc.
29 Copyright (c) 2012 - 2014, Intel Corporation. All rights reserved.<BR>
30 Copyright (c) 2017, AMD Inc, All rights reserved.<BR>
32 This program and the accompanying materials are licensed and made available
33 under the terms and conditions of the BSD License which accompanies this
34 distribution. The full text of the license may be found at
35 http://opensource.org/licenses/bsd-license.php
37 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
38 WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
42 #include <IndustryStandard/VirtioScsi.h>
43 #include <Library/BaseMemoryLib.h>
44 #include <Library/DebugLib.h>
45 #include <Library/MemoryAllocationLib.h>
46 #include <Library/UefiBootServicesTableLib.h>
47 #include <Library/UefiLib.h>
48 #include <Library/VirtioLib.h>
50 #include "VirtioScsi.h"
54 Convenience macros to read and write configuration elements of the
55 virtio-scsi VirtIo device.
57 The following macros make it possible to specify only the "core parameters"
58 for such accesses and to derive the rest. By the time VIRTIO_CFG_WRITE()
59 returns, the transaction will have been completed.
61 @param[in] Dev Pointer to the VSCSI_DEV structure.
63 @param[in] Field A field name from VSCSI_HDR, identifying the virtio-scsi
64 configuration item to access.
66 @param[in] Value (VIRTIO_CFG_WRITE() only.) The value to write to the
67 selected configuration item.
69 @param[out] Pointer (VIRTIO_CFG_READ() only.) The object to receive the
70 value read from the configuration item. Its type must be
71 one of UINT8, UINT16, UINT32, UINT64.
74 @return Status codes returned by Virtio->WriteDevice() / Virtio->ReadDevice().
78 #define VIRTIO_CFG_WRITE(Dev, Field, Value) ((Dev)->VirtIo->WriteDevice ( \
80 OFFSET_OF_VSCSI (Field), \
81 SIZE_OF_VSCSI (Field), \
85 #define VIRTIO_CFG_READ(Dev, Field, Pointer) ((Dev)->VirtIo->ReadDevice ( \
87 OFFSET_OF_VSCSI (Field), \
88 SIZE_OF_VSCSI (Field), \
95 // UEFI Spec 2.3.1 + Errata C, 14.7 Extended SCSI Pass Thru Protocol specifies
96 // the PassThru() interface. Beside returning a status code, the function must
97 // set some fields in the EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET in/out
98 // parameter on return. The following is a full list of those fields, for
99 // easier validation of PopulateRequest(), ParseResponse(), and
100 // ReportHostAdapterError() below.
102 // - InTransferLength
103 // - OutTransferLength
104 // - HostAdapterStatus
109 // On any return from the PassThru() interface, these fields must be set,
110 // except if the returned status code is explicitly exempt. (Actually the
111 // implementation here conservatively sets these fields even in case not all
112 // of them would be required by the specification.)
117 Populate a virtio-scsi request from the Extended SCSI Pass Thru Protocol
120 The caller is responsible for pre-zeroing the virtio-scsi request. The
121 Extended SCSI Pass Thru Protocol packet is modified, to be forwarded outwards
122 by VirtioScsiPassThru(), if invalid or unsupported parameters are detected.
124 @param[in] Dev The virtio-scsi host device the packet targets.
126 @param[in] Target The SCSI target controlled by the virtio-scsi host
129 @param[in] Lun The Logical Unit Number under the SCSI target.
131 @param[in out] Packet The Extended SCSI Pass Thru Protocol packet the
132 function translates to a virtio-scsi request. On
133 failure this parameter relays error contents.
135 @param[out] Request The pre-zeroed virtio-scsi request to populate. This
136 parameter is volatile-qualified because we expect the
137 caller to append it to a virtio ring, thus
138 assignments to Request must be visible when the
142 @retval EFI_SUCCESS The Extended SCSI Pass Thru Protocol packet was valid,
143 Request has been populated.
145 @return Otherwise, invalid or unsupported parameters were
146 detected. Status codes are meant for direct forwarding
147 by the EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru()
155 IN CONST VSCSI_DEV
*Dev
,
158 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
,
159 OUT
volatile VIRTIO_SCSI_REQ
*Request
166 // bidirectional transfer was requested, but the host doesn't support it
168 (Packet
->InTransferLength
> 0 && Packet
->OutTransferLength
> 0 &&
169 !Dev
->InOutSupported
) ||
172 // a target / LUN was addressed that's impossible to encode for the host
174 Target
> 0xFF || Lun
>= 0x4000 ||
177 // Command Descriptor Block bigger than VIRTIO_SCSI_CDB_SIZE
179 Packet
->CdbLength
> VIRTIO_SCSI_CDB_SIZE
||
182 // From virtio-0.9.5, 2.3.2 Descriptor Table:
183 // "no descriptor chain may be more than 2^32 bytes long in total".
185 (UINT64
) Packet
->InTransferLength
+ Packet
->OutTransferLength
> SIZE_1GB
189 // this error code doesn't require updates to the Packet output fields
191 return EFI_UNSUPPORTED
;
196 // addressed invalid device
198 Target
> Dev
->MaxTarget
|| Lun
> Dev
->MaxLun
||
201 // invalid direction (there doesn't seem to be a macro for the "no data
202 // transferred" "direction", eg. for TEST UNIT READY)
204 Packet
->DataDirection
> EFI_EXT_SCSI_DATA_DIRECTION_BIDIRECTIONAL
||
207 // trying to receive, but destination pointer is NULL, or contradicting
208 // transfer direction
210 (Packet
->InTransferLength
> 0 &&
211 (Packet
->InDataBuffer
== NULL
||
212 Packet
->DataDirection
== EFI_EXT_SCSI_DATA_DIRECTION_WRITE
217 // trying to send, but source pointer is NULL, or contradicting transfer
220 (Packet
->OutTransferLength
> 0 &&
221 (Packet
->OutDataBuffer
== NULL
||
222 Packet
->DataDirection
== EFI_EXT_SCSI_DATA_DIRECTION_READ
228 // this error code doesn't require updates to the Packet output fields
230 return EFI_INVALID_PARAMETER
;
234 // Catch oversized requests eagerly. If this condition evaluates to false,
235 // then the combined size of a bidirectional request will not exceed the
236 // virtio-scsi device's transfer limit either.
238 if (ALIGN_VALUE (Packet
->OutTransferLength
, 512) / 512
239 > Dev
->MaxSectors
/ 2 ||
240 ALIGN_VALUE (Packet
->InTransferLength
, 512) / 512
241 > Dev
->MaxSectors
/ 2) {
242 Packet
->InTransferLength
= (Dev
->MaxSectors
/ 2) * 512;
243 Packet
->OutTransferLength
= (Dev
->MaxSectors
/ 2) * 512;
244 Packet
->HostAdapterStatus
=
245 EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN
;
246 Packet
->TargetStatus
= EFI_EXT_SCSI_STATUS_TARGET_GOOD
;
247 Packet
->SenseDataLength
= 0;
248 return EFI_BAD_BUFFER_SIZE
;
252 // target & LUN encoding: see virtio-0.9.5, Appendix I: SCSI Host Device,
253 // Device Operation: request queues
256 Request
->Lun
[1] = (UINT8
) Target
;
257 Request
->Lun
[2] = (UINT8
) (((UINT32
)Lun
>> 8) | 0x40);
258 Request
->Lun
[3] = (UINT8
) Lun
;
261 // CopyMem() would cast away the "volatile" qualifier before access, which is
262 // undefined behavior (ISO C99 6.7.3p5)
264 for (Idx
= 0; Idx
< Packet
->CdbLength
; ++Idx
) {
265 Request
->Cdb
[Idx
] = ((UINT8
*) Packet
->Cdb
)[Idx
];
274 Parse the virtio-scsi device's response, translate it to an EFI status code,
275 and update the Extended SCSI Pass Thru Protocol packet, to be returned by
276 the EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru() implementation.
278 @param[in out] Packet The Extended SCSI Pass Thru Protocol packet that has
279 been translated to a virtio-scsi request with
280 PopulateRequest(), and processed by the host. On
281 output this parameter is updated with response or
284 @param[in] Response The virtio-scsi response structure to parse. We expect
285 it to come from a virtio ring, thus it is qualified
289 @return PassThru() status codes mandated by UEFI Spec 2.3.1 + Errata C, 14.7
290 Extended SCSI Pass Thru Protocol.
297 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
,
298 IN CONST
volatile VIRTIO_SCSI_RESP
*Response
301 UINTN ResponseSenseLen
;
305 // return sense data (length and contents) in all cases, truncated if needed
307 ResponseSenseLen
= MIN (Response
->SenseLen
, VIRTIO_SCSI_SENSE_SIZE
);
308 if (Packet
->SenseDataLength
> ResponseSenseLen
) {
309 Packet
->SenseDataLength
= (UINT8
) ResponseSenseLen
;
311 for (Idx
= 0; Idx
< Packet
->SenseDataLength
; ++Idx
) {
312 ((UINT8
*) Packet
->SenseData
)[Idx
] = Response
->Sense
[Idx
];
316 // Report actual transfer lengths. The logic below covers all three
317 // DataDirections (read, write, bidirectional).
321 // | write ^ @ Residual (unprocessed)
323 // -+- @ OutTransferLength -+- @ InTransferLength
327 // V @ OutTransferLength + InTransferLength -+- @ 0
329 if (Response
->Residual
<= Packet
->InTransferLength
) {
330 Packet
->InTransferLength
-= Response
->Residual
;
333 Packet
->OutTransferLength
-= Response
->Residual
- Packet
->InTransferLength
;
334 Packet
->InTransferLength
= 0;
338 // report target status in all cases
340 Packet
->TargetStatus
= Response
->Status
;
343 // host adapter status and function return value depend on virtio-scsi
346 switch (Response
->Response
) {
347 case VIRTIO_SCSI_S_OK
:
348 Packet
->HostAdapterStatus
= EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OK
;
351 case VIRTIO_SCSI_S_OVERRUN
:
352 Packet
->HostAdapterStatus
=
353 EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN
;
356 case VIRTIO_SCSI_S_BAD_TARGET
:
358 // This is non-intuitive but explicitly required by the
359 // EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru() specification for
360 // disconnected (but otherwise valid) target / LUN addresses.
362 Packet
->HostAdapterStatus
=
363 EFI_EXT_SCSI_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND
;
366 case VIRTIO_SCSI_S_RESET
:
367 Packet
->HostAdapterStatus
= EFI_EXT_SCSI_STATUS_HOST_ADAPTER_BUS_RESET
;
370 case VIRTIO_SCSI_S_BUSY
:
371 Packet
->HostAdapterStatus
= EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OK
;
372 return EFI_NOT_READY
;
375 // Lump together the rest. The mapping for VIRTIO_SCSI_S_ABORTED is
376 // intentional as well, not an oversight.
378 case VIRTIO_SCSI_S_ABORTED
:
379 case VIRTIO_SCSI_S_TRANSPORT_FAILURE
:
380 case VIRTIO_SCSI_S_TARGET_FAILURE
:
381 case VIRTIO_SCSI_S_NEXUS_FAILURE
:
382 case VIRTIO_SCSI_S_FAILURE
:
384 Packet
->HostAdapterStatus
= EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OTHER
;
387 return EFI_DEVICE_ERROR
;
393 The function can be used to create a fake host adapter error.
395 When VirtioScsiPassThru() is failed due to some reasons then this function
396 can be called to construct a host adapter error.
398 @param[out] Packet The Extended SCSI Pass Thru Protocol packet that the host
399 adapter error shall be placed in.
402 @retval EFI_DEVICE_ERROR The function returns this status code
403 unconditionally, to be propagated by
404 VirtioScsiPassThru().
409 ReportHostAdapterError (
410 OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
413 Packet
->InTransferLength
= 0;
414 Packet
->OutTransferLength
= 0;
415 Packet
->HostAdapterStatus
= EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OTHER
;
416 Packet
->TargetStatus
= EFI_EXT_SCSI_STATUS_TARGET_GOOD
;
417 Packet
->SenseDataLength
= 0;
418 return EFI_DEVICE_ERROR
;
423 // The next seven functions implement EFI_EXT_SCSI_PASS_THRU_PROTOCOL
424 // for the virtio-scsi HBA. Refer to UEFI Spec 2.3.1 + Errata C, sections
425 // - 14.1 SCSI Driver Model Overview,
426 // - 14.7 Extended SCSI Pass Thru Protocol.
432 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
435 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
,
436 IN EFI_EVENT Event OPTIONAL
442 volatile VIRTIO_SCSI_REQ Request
;
443 volatile VIRTIO_SCSI_RESP
*Response
;
444 VOID
*ResponseBuffer
;
445 DESC_INDICES Indices
;
446 VOID
*RequestMapping
;
447 VOID
*ResponseMapping
;
449 VOID
*OutDataMapping
;
450 EFI_PHYSICAL_ADDRESS RequestDeviceAddress
;
451 EFI_PHYSICAL_ADDRESS ResponseDeviceAddress
;
452 EFI_PHYSICAL_ADDRESS InDataDeviceAddress
;
453 EFI_PHYSICAL_ADDRESS OutDataDeviceAddress
;
455 UINTN InDataNumPages
;
456 BOOLEAN OutDataBufferIsMapped
;
458 ZeroMem ((VOID
*) &Request
, sizeof (Request
));
460 Dev
= VIRTIO_SCSI_FROM_PASS_THRU (This
);
461 CopyMem (&TargetValue
, Target
, sizeof TargetValue
);
464 OutDataBufferIsMapped
= FALSE
;
467 Status
= PopulateRequest (Dev
, TargetValue
, Lun
, Packet
, &Request
);
468 if (EFI_ERROR (Status
)) {
473 // Map the virtio-scsi Request header buffer
475 Status
= VirtioMapAllBytesInSharedBuffer (
477 VirtioOperationBusMasterRead
,
480 &RequestDeviceAddress
,
482 if (EFI_ERROR (Status
)) {
483 return ReportHostAdapterError (Packet
);
487 // Map the input buffer
489 if (Packet
->InTransferLength
> 0) {
491 // Allocate a intermediate input buffer. This is mainly to handle the
493 // * caller submits a bi-directional request
494 // * we perform the request fine
495 // * but we fail to unmap the "InDataMapping"
497 // In that case simply returing the EFI_DEVICE_ERROR is not sufficient. In
498 // addition to the error code we also need to update Packet fields
499 // accordingly so that we report the full loss of the incoming transfer.
501 // We allocate a temporary buffer and map it with BusMasterCommonBuffer. If
502 // the Virtio request is successful then we copy the data from temporary
503 // buffer into Packet->InDataBuffer.
505 InDataNumPages
= EFI_SIZE_TO_PAGES ((UINTN
)Packet
->InTransferLength
);
506 Status
= Dev
->VirtIo
->AllocateSharedPages (
511 if (EFI_ERROR (Status
)) {
512 Status
= ReportHostAdapterError (Packet
);
513 goto UnmapRequestBuffer
;
516 ZeroMem (InDataBuffer
, Packet
->InTransferLength
);
518 Status
= VirtioMapAllBytesInSharedBuffer (
520 VirtioOperationBusMasterCommonBuffer
,
522 Packet
->InTransferLength
,
523 &InDataDeviceAddress
,
526 if (EFI_ERROR (Status
)) {
527 Status
= ReportHostAdapterError (Packet
);
528 goto FreeInDataBuffer
;
533 // Map the output buffer
535 if (Packet
->OutTransferLength
> 0) {
536 Status
= VirtioMapAllBytesInSharedBuffer (
538 VirtioOperationBusMasterRead
,
539 Packet
->OutDataBuffer
,
540 Packet
->OutTransferLength
,
541 &OutDataDeviceAddress
,
544 if (EFI_ERROR (Status
)) {
545 Status
= ReportHostAdapterError (Packet
);
546 goto UnmapInDataBuffer
;
549 OutDataBufferIsMapped
= TRUE
;
553 // Response header is bi-direction (we preset with host status and expect
554 // the device to update it). Allocate a response buffer which can be mapped
555 // to access equally by both processor and device.
557 Status
= Dev
->VirtIo
->AllocateSharedPages (
559 EFI_SIZE_TO_PAGES (sizeof *Response
),
562 if (EFI_ERROR (Status
)) {
563 Status
= ReportHostAdapterError (Packet
);
564 goto UnmapOutDataBuffer
;
567 Response
= ResponseBuffer
;
569 ZeroMem ((VOID
*)Response
, sizeof (*Response
));
572 // preset a host status for ourselves that we do not accept as success
574 Response
->Response
= VIRTIO_SCSI_S_FAILURE
;
577 // Map the response buffer with BusMasterCommonBuffer so that response
578 // buffer can be accessed by both host and device.
580 Status
= VirtioMapAllBytesInSharedBuffer (
582 VirtioOperationBusMasterCommonBuffer
,
585 &ResponseDeviceAddress
,
588 if (EFI_ERROR (Status
)) {
589 Status
= ReportHostAdapterError (Packet
);
590 goto FreeResponseBuffer
;
593 VirtioPrepare (&Dev
->Ring
, &Indices
);
596 // ensured by VirtioScsiInit() -- this predicate, in combination with the
597 // lock-step progress, ensures we don't have to track free descriptors.
599 ASSERT (Dev
->Ring
.QueueSize
>= 4);
606 RequestDeviceAddress
,
613 // enqueue "dataout" if any
615 if (Packet
->OutTransferLength
> 0) {
618 OutDataDeviceAddress
,
619 Packet
->OutTransferLength
,
626 // enqueue Response, to be written by the host
630 ResponseDeviceAddress
,
632 VRING_DESC_F_WRITE
| (Packet
->InTransferLength
> 0 ? VRING_DESC_F_NEXT
: 0),
637 // enqueue "datain" if any, to be written by the host
639 if (Packet
->InTransferLength
> 0) {
643 Packet
->InTransferLength
,
649 // If kicking the host fails, we must fake a host adapter error.
650 // EFI_NOT_READY would save us the effort, but it would also suggest that the
653 if (VirtioFlush (Dev
->VirtIo
, VIRTIO_SCSI_REQUEST_QUEUE
, &Dev
->Ring
,
654 &Indices
, NULL
) != EFI_SUCCESS
) {
655 Status
= ReportHostAdapterError (Packet
);
656 goto UnmapResponseBuffer
;
659 Status
= ParseResponse (Packet
, Response
);
662 // If virtio request was successful and it was a CPU read request then we
663 // have used an intermediate buffer. Copy the data from intermediate buffer
664 // to the final buffer.
666 if (InDataBuffer
!= NULL
) {
667 CopyMem (Packet
->InDataBuffer
, InDataBuffer
, Packet
->InTransferLength
);
671 Dev
->VirtIo
->UnmapSharedBuffer (Dev
->VirtIo
, ResponseMapping
);
674 Dev
->VirtIo
->FreeSharedPages (
676 EFI_SIZE_TO_PAGES (sizeof *Response
),
681 if (OutDataBufferIsMapped
) {
682 Dev
->VirtIo
->UnmapSharedBuffer (Dev
->VirtIo
, OutDataMapping
);
686 if (InDataBuffer
!= NULL
) {
687 Dev
->VirtIo
->UnmapSharedBuffer (Dev
->VirtIo
, InDataMapping
);
691 if (InDataBuffer
!= NULL
) {
692 Dev
->VirtIo
->FreeSharedPages (Dev
->VirtIo
, InDataNumPages
, InDataBuffer
);
696 Dev
->VirtIo
->UnmapSharedBuffer (Dev
->VirtIo
, RequestMapping
);
704 VirtioScsiGetNextTargetLun (
705 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
706 IN OUT UINT8
**TargetPointer
,
716 // the TargetPointer input parameter is unnecessarily a pointer-to-pointer
718 Target
= *TargetPointer
;
721 // Search for first non-0xFF byte. If not found, return first target & LUN.
723 for (Idx
= 0; Idx
< TARGET_MAX_BYTES
&& Target
[Idx
] == 0xFF; ++Idx
)
725 if (Idx
== TARGET_MAX_BYTES
) {
726 SetMem (Target
, TARGET_MAX_BYTES
, 0x00);
732 // see the TARGET_MAX_BYTES check in "VirtioScsi.h"
734 CopyMem (&LastTarget
, Target
, sizeof LastTarget
);
737 // increment (target, LUN) pair if valid on input
739 Dev
= VIRTIO_SCSI_FROM_PASS_THRU (This
);
740 if (LastTarget
> Dev
->MaxTarget
|| *Lun
> Dev
->MaxLun
) {
741 return EFI_INVALID_PARAMETER
;
744 if (*Lun
< Dev
->MaxLun
) {
749 if (LastTarget
< Dev
->MaxTarget
) {
752 CopyMem (Target
, &LastTarget
, sizeof LastTarget
);
756 return EFI_NOT_FOUND
;
762 VirtioScsiBuildDevicePath (
763 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
766 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
771 SCSI_DEVICE_PATH
*ScsiDevicePath
;
773 if (DevicePath
== NULL
) {
774 return EFI_INVALID_PARAMETER
;
777 CopyMem (&TargetValue
, Target
, sizeof TargetValue
);
778 Dev
= VIRTIO_SCSI_FROM_PASS_THRU (This
);
779 if (TargetValue
> Dev
->MaxTarget
|| Lun
> Dev
->MaxLun
|| Lun
> 0xFFFF) {
780 return EFI_NOT_FOUND
;
783 ScsiDevicePath
= AllocatePool (sizeof *ScsiDevicePath
);
784 if (ScsiDevicePath
== NULL
) {
785 return EFI_OUT_OF_RESOURCES
;
788 ScsiDevicePath
->Header
.Type
= MESSAGING_DEVICE_PATH
;
789 ScsiDevicePath
->Header
.SubType
= MSG_SCSI_DP
;
790 ScsiDevicePath
->Header
.Length
[0] = (UINT8
) sizeof *ScsiDevicePath
;
791 ScsiDevicePath
->Header
.Length
[1] = (UINT8
) (sizeof *ScsiDevicePath
>> 8);
792 ScsiDevicePath
->Pun
= TargetValue
;
793 ScsiDevicePath
->Lun
= (UINT16
) Lun
;
795 *DevicePath
= &ScsiDevicePath
->Header
;
802 VirtioScsiGetTargetLun (
803 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
804 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
805 OUT UINT8
**TargetPointer
,
809 SCSI_DEVICE_PATH
*ScsiDevicePath
;
813 if (DevicePath
== NULL
|| TargetPointer
== NULL
|| *TargetPointer
== NULL
||
815 return EFI_INVALID_PARAMETER
;
818 if (DevicePath
->Type
!= MESSAGING_DEVICE_PATH
||
819 DevicePath
->SubType
!= MSG_SCSI_DP
) {
820 return EFI_UNSUPPORTED
;
823 ScsiDevicePath
= (SCSI_DEVICE_PATH
*) DevicePath
;
824 Dev
= VIRTIO_SCSI_FROM_PASS_THRU (This
);
825 if (ScsiDevicePath
->Pun
> Dev
->MaxTarget
||
826 ScsiDevicePath
->Lun
> Dev
->MaxLun
) {
827 return EFI_NOT_FOUND
;
831 // a) the TargetPointer input parameter is unnecessarily a pointer-to-pointer
832 // b) see the TARGET_MAX_BYTES check in "VirtioScsi.h"
833 // c) ScsiDevicePath->Pun is an UINT16
835 Target
= *TargetPointer
;
836 CopyMem (Target
, &ScsiDevicePath
->Pun
, 2);
837 SetMem (Target
+ 2, TARGET_MAX_BYTES
- 2, 0x00);
839 *Lun
= ScsiDevicePath
->Lun
;
846 VirtioScsiResetChannel (
847 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
850 return EFI_UNSUPPORTED
;
856 VirtioScsiResetTargetLun (
857 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
862 return EFI_UNSUPPORTED
;
868 VirtioScsiGetNextTarget (
869 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
870 IN OUT UINT8
**TargetPointer
879 // the TargetPointer input parameter is unnecessarily a pointer-to-pointer
881 Target
= *TargetPointer
;
884 // Search for first non-0xFF byte. If not found, return first target.
886 for (Idx
= 0; Idx
< TARGET_MAX_BYTES
&& Target
[Idx
] == 0xFF; ++Idx
)
888 if (Idx
== TARGET_MAX_BYTES
) {
889 SetMem (Target
, TARGET_MAX_BYTES
, 0x00);
894 // see the TARGET_MAX_BYTES check in "VirtioScsi.h"
896 CopyMem (&LastTarget
, Target
, sizeof LastTarget
);
899 // increment target if valid on input
901 Dev
= VIRTIO_SCSI_FROM_PASS_THRU (This
);
902 if (LastTarget
> Dev
->MaxTarget
) {
903 return EFI_INVALID_PARAMETER
;
906 if (LastTarget
< Dev
->MaxTarget
) {
908 CopyMem (Target
, &LastTarget
, sizeof LastTarget
);
912 return EFI_NOT_FOUND
;
920 IN OUT VSCSI_DEV
*Dev
925 UINT64 RingBaseShift
;
927 UINT16 MaxChannel
; // for validation only
928 UINT32 NumQueues
; // for validation only
932 // Execute virtio-0.9.5, 2.2.1 Device Initialization Sequence.
934 NextDevStat
= 0; // step 1 -- reset device
935 Status
= Dev
->VirtIo
->SetDeviceStatus (Dev
->VirtIo
, NextDevStat
);
936 if (EFI_ERROR (Status
)) {
940 NextDevStat
|= VSTAT_ACK
; // step 2 -- acknowledge device presence
941 Status
= Dev
->VirtIo
->SetDeviceStatus (Dev
->VirtIo
, NextDevStat
);
942 if (EFI_ERROR (Status
)) {
946 NextDevStat
|= VSTAT_DRIVER
; // step 3 -- we know how to drive it
947 Status
= Dev
->VirtIo
->SetDeviceStatus (Dev
->VirtIo
, NextDevStat
);
948 if (EFI_ERROR (Status
)) {
953 // Set Page Size - MMIO VirtIo Specific
955 Status
= Dev
->VirtIo
->SetPageSize (Dev
->VirtIo
, EFI_PAGE_SIZE
);
956 if (EFI_ERROR (Status
)) {
961 // step 4a -- retrieve and validate features
963 Status
= Dev
->VirtIo
->GetDeviceFeatures (Dev
->VirtIo
, &Features
);
964 if (EFI_ERROR (Status
)) {
967 Dev
->InOutSupported
= (BOOLEAN
) ((Features
& VIRTIO_SCSI_F_INOUT
) != 0);
969 Status
= VIRTIO_CFG_READ (Dev
, MaxChannel
, &MaxChannel
);
970 if (EFI_ERROR (Status
)) {
973 if (MaxChannel
!= 0) {
975 // this driver is for a single-channel virtio-scsi HBA
977 Status
= EFI_UNSUPPORTED
;
981 Status
= VIRTIO_CFG_READ (Dev
, NumQueues
, &NumQueues
);
982 if (EFI_ERROR (Status
)) {
986 Status
= EFI_UNSUPPORTED
;
990 Status
= VIRTIO_CFG_READ (Dev
, MaxTarget
, &Dev
->MaxTarget
);
991 if (EFI_ERROR (Status
)) {
994 if (Dev
->MaxTarget
> PcdGet16 (PcdVirtioScsiMaxTargetLimit
)) {
995 Dev
->MaxTarget
= PcdGet16 (PcdVirtioScsiMaxTargetLimit
);
998 Status
= VIRTIO_CFG_READ (Dev
, MaxLun
, &Dev
->MaxLun
);
999 if (EFI_ERROR (Status
)) {
1002 if (Dev
->MaxLun
> PcdGet32 (PcdVirtioScsiMaxLunLimit
)) {
1003 Dev
->MaxLun
= PcdGet32 (PcdVirtioScsiMaxLunLimit
);
1006 Status
= VIRTIO_CFG_READ (Dev
, MaxSectors
, &Dev
->MaxSectors
);
1007 if (EFI_ERROR (Status
)) {
1010 if (Dev
->MaxSectors
< 2) {
1012 // We must be able to halve it for bidirectional transfers
1013 // (see EFI_BAD_BUFFER_SIZE in PopulateRequest()).
1015 Status
= EFI_UNSUPPORTED
;
1019 Features
&= VIRTIO_SCSI_F_INOUT
| VIRTIO_F_VERSION_1
|
1020 VIRTIO_F_IOMMU_PLATFORM
;
1023 // In virtio-1.0, feature negotiation is expected to complete before queue
1024 // discovery, and the device can also reject the selected set of features.
1026 if (Dev
->VirtIo
->Revision
>= VIRTIO_SPEC_REVISION (1, 0, 0)) {
1027 Status
= Virtio10WriteFeatures (Dev
->VirtIo
, Features
, &NextDevStat
);
1028 if (EFI_ERROR (Status
)) {
1034 // step 4b -- allocate request virtqueue
1036 Status
= Dev
->VirtIo
->SetQueueSel (Dev
->VirtIo
, VIRTIO_SCSI_REQUEST_QUEUE
);
1037 if (EFI_ERROR (Status
)) {
1040 Status
= Dev
->VirtIo
->GetQueueNumMax (Dev
->VirtIo
, &QueueSize
);
1041 if (EFI_ERROR (Status
)) {
1045 // VirtioScsiPassThru() uses at most four descriptors
1047 if (QueueSize
< 4) {
1048 Status
= EFI_UNSUPPORTED
;
1052 Status
= VirtioRingInit (Dev
->VirtIo
, QueueSize
, &Dev
->Ring
);
1053 if (EFI_ERROR (Status
)) {
1058 // If anything fails from here on, we must release the ring resources
1060 Status
= VirtioRingMap (
1066 if (EFI_ERROR (Status
)) {
1071 // Additional steps for MMIO: align the queue appropriately, and set the
1072 // size. If anything fails from here on, we must unmap the ring resources.
1074 Status
= Dev
->VirtIo
->SetQueueNum (Dev
->VirtIo
, QueueSize
);
1075 if (EFI_ERROR (Status
)) {
1079 Status
= Dev
->VirtIo
->SetQueueAlign (Dev
->VirtIo
, EFI_PAGE_SIZE
);
1080 if (EFI_ERROR (Status
)) {
1085 // step 4c -- Report GPFN (guest-physical frame number) of queue.
1087 Status
= Dev
->VirtIo
->SetQueueAddress (
1092 if (EFI_ERROR (Status
)) {
1097 // step 5 -- Report understood features and guest-tuneables.
1099 if (Dev
->VirtIo
->Revision
< VIRTIO_SPEC_REVISION (1, 0, 0)) {
1100 Features
&= ~(UINT64
)(VIRTIO_F_VERSION_1
| VIRTIO_F_IOMMU_PLATFORM
);
1101 Status
= Dev
->VirtIo
->SetGuestFeatures (Dev
->VirtIo
, Features
);
1102 if (EFI_ERROR (Status
)) {
1108 // We expect these maximum sizes from the host. Since they are
1109 // guest-negotiable, ask for them rather than just checking them.
1111 Status
= VIRTIO_CFG_WRITE (Dev
, CdbSize
, VIRTIO_SCSI_CDB_SIZE
);
1112 if (EFI_ERROR (Status
)) {
1115 Status
= VIRTIO_CFG_WRITE (Dev
, SenseSize
, VIRTIO_SCSI_SENSE_SIZE
);
1116 if (EFI_ERROR (Status
)) {
1121 // step 6 -- initialization complete
1123 NextDevStat
|= VSTAT_DRIVER_OK
;
1124 Status
= Dev
->VirtIo
->SetDeviceStatus (Dev
->VirtIo
, NextDevStat
);
1125 if (EFI_ERROR (Status
)) {
1130 // populate the exported interface's attributes
1132 Dev
->PassThru
.Mode
= &Dev
->PassThruMode
;
1133 Dev
->PassThru
.PassThru
= &VirtioScsiPassThru
;
1134 Dev
->PassThru
.GetNextTargetLun
= &VirtioScsiGetNextTargetLun
;
1135 Dev
->PassThru
.BuildDevicePath
= &VirtioScsiBuildDevicePath
;
1136 Dev
->PassThru
.GetTargetLun
= &VirtioScsiGetTargetLun
;
1137 Dev
->PassThru
.ResetChannel
= &VirtioScsiResetChannel
;
1138 Dev
->PassThru
.ResetTargetLun
= &VirtioScsiResetTargetLun
;
1139 Dev
->PassThru
.GetNextTarget
= &VirtioScsiGetNextTarget
;
1142 // AdapterId is a target for which no handle will be created during bus scan.
1143 // Prevent any conflict with real devices.
1145 Dev
->PassThruMode
.AdapterId
= 0xFFFFFFFF;
1148 // Set both physical and logical attributes for non-RAID SCSI channel. See
1149 // Driver Writer's Guide for UEFI 2.3.1 v1.01, 20.1.5 Implementing Extended
1150 // SCSI Pass Thru Protocol.
1152 Dev
->PassThruMode
.Attributes
= EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL
|
1153 EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL
;
1156 // no restriction on transfer buffer alignment
1158 Dev
->PassThruMode
.IoAlign
= 0;
1163 Dev
->VirtIo
->UnmapSharedBuffer (Dev
->VirtIo
, Dev
->RingMap
);
1166 VirtioRingUninit (Dev
->VirtIo
, &Dev
->Ring
);
1170 // Notify the host about our failure to setup: virtio-0.9.5, 2.2.2.1 Device
1171 // Status. VirtIo access failure here should not mask the original error.
1173 NextDevStat
|= VSTAT_FAILED
;
1174 Dev
->VirtIo
->SetDeviceStatus (Dev
->VirtIo
, NextDevStat
);
1176 Dev
->InOutSupported
= FALSE
;
1179 Dev
->MaxSectors
= 0;
1181 return Status
; // reached only via Failed above
1189 IN OUT VSCSI_DEV
*Dev
1193 // Reset the virtual device -- see virtio-0.9.5, 2.2.2.1 Device Status. When
1194 // VIRTIO_CFG_WRITE() returns, the host will have learned to stay away from
1195 // the old comms area.
1197 Dev
->VirtIo
->SetDeviceStatus (Dev
->VirtIo
, 0);
1199 Dev
->InOutSupported
= FALSE
;
1202 Dev
->MaxSectors
= 0;
1204 Dev
->VirtIo
->UnmapSharedBuffer (Dev
->VirtIo
, Dev
->RingMap
);
1205 VirtioRingUninit (Dev
->VirtIo
, &Dev
->Ring
);
1207 SetMem (&Dev
->PassThru
, sizeof Dev
->PassThru
, 0x00);
1208 SetMem (&Dev
->PassThruMode
, sizeof Dev
->PassThruMode
, 0x00);
1213 // Event notification function enqueued by ExitBootServices().
1219 VirtioScsiExitBoot (
1226 DEBUG ((DEBUG_VERBOSE
, "%a: Context=0x%p\n", __FUNCTION__
, Context
));
1228 // Reset the device. This causes the hypervisor to forget about the virtio
1231 // We allocated said ring in EfiBootServicesData type memory, and code
1232 // executing after ExitBootServices() is permitted to overwrite it.
1235 Dev
->VirtIo
->SetDeviceStatus (Dev
->VirtIo
, 0);
1240 // Probe, start and stop functions of this driver, called by the DXE core for
1241 // specific devices.
1243 // The following specifications document these interfaces:
1244 // - Driver Writer's Guide for UEFI 2.3.1 v1.01, 9 Driver Binding Protocol
1245 // - UEFI Spec 2.3.1 + Errata C, 10.1 EFI Driver Binding Protocol
1247 // The implementation follows:
1248 // - Driver Writer's Guide for UEFI 2.3.1 v1.01
1249 // - 5.1.3.4 OpenProtocol() and CloseProtocol()
1250 // - UEFI Spec 2.3.1 + Errata C
1251 // - 6.3 Protocol Handler Services
1256 VirtioScsiDriverBindingSupported (
1257 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1258 IN EFI_HANDLE DeviceHandle
,
1259 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1263 VIRTIO_DEVICE_PROTOCOL
*VirtIo
;
1266 // Attempt to open the device with the VirtIo set of interfaces. On success,
1267 // the protocol is "instantiated" for the VirtIo device. Covers duplicate open
1268 // attempts (EFI_ALREADY_STARTED).
1270 Status
= gBS
->OpenProtocol (
1271 DeviceHandle
, // candidate device
1272 &gVirtioDeviceProtocolGuid
, // for generic VirtIo access
1273 (VOID
**)&VirtIo
, // handle to instantiate
1274 This
->DriverBindingHandle
, // requestor driver identity
1275 DeviceHandle
, // ControllerHandle, according to
1276 // the UEFI Driver Model
1277 EFI_OPEN_PROTOCOL_BY_DRIVER
// get exclusive VirtIo access to
1278 // the device; to be released
1280 if (EFI_ERROR (Status
)) {
1284 if (VirtIo
->SubSystemDeviceId
!= VIRTIO_SUBSYSTEM_SCSI_HOST
) {
1285 Status
= EFI_UNSUPPORTED
;
1289 // We needed VirtIo access only transitorily, to see whether we support the
1292 gBS
->CloseProtocol (DeviceHandle
, &gVirtioDeviceProtocolGuid
,
1293 This
->DriverBindingHandle
, DeviceHandle
);
1300 VirtioScsiDriverBindingStart (
1301 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1302 IN EFI_HANDLE DeviceHandle
,
1303 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1309 Dev
= (VSCSI_DEV
*) AllocateZeroPool (sizeof *Dev
);
1311 return EFI_OUT_OF_RESOURCES
;
1314 Status
= gBS
->OpenProtocol (DeviceHandle
, &gVirtioDeviceProtocolGuid
,
1315 (VOID
**)&Dev
->VirtIo
, This
->DriverBindingHandle
,
1316 DeviceHandle
, EFI_OPEN_PROTOCOL_BY_DRIVER
);
1317 if (EFI_ERROR (Status
)) {
1318 goto FreeVirtioScsi
;
1322 // VirtIo access granted, configure virtio-scsi device.
1324 Status
= VirtioScsiInit (Dev
);
1325 if (EFI_ERROR (Status
)) {
1329 Status
= gBS
->CreateEvent (EVT_SIGNAL_EXIT_BOOT_SERVICES
, TPL_CALLBACK
,
1330 &VirtioScsiExitBoot
, Dev
, &Dev
->ExitBoot
);
1331 if (EFI_ERROR (Status
)) {
1336 // Setup complete, attempt to export the driver instance's PassThru
1339 Dev
->Signature
= VSCSI_SIG
;
1340 Status
= gBS
->InstallProtocolInterface (&DeviceHandle
,
1341 &gEfiExtScsiPassThruProtocolGuid
, EFI_NATIVE_INTERFACE
,
1343 if (EFI_ERROR (Status
)) {
1350 gBS
->CloseEvent (Dev
->ExitBoot
);
1353 VirtioScsiUninit (Dev
);
1356 gBS
->CloseProtocol (DeviceHandle
, &gVirtioDeviceProtocolGuid
,
1357 This
->DriverBindingHandle
, DeviceHandle
);
1368 VirtioScsiDriverBindingStop (
1369 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1370 IN EFI_HANDLE DeviceHandle
,
1371 IN UINTN NumberOfChildren
,
1372 IN EFI_HANDLE
*ChildHandleBuffer
1376 EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*PassThru
;
1379 Status
= gBS
->OpenProtocol (
1380 DeviceHandle
, // candidate device
1381 &gEfiExtScsiPassThruProtocolGuid
, // retrieve the SCSI iface
1382 (VOID
**)&PassThru
, // target pointer
1383 This
->DriverBindingHandle
, // requestor driver ident.
1384 DeviceHandle
, // lookup req. for dev.
1385 EFI_OPEN_PROTOCOL_GET_PROTOCOL
// lookup only, no new ref.
1387 if (EFI_ERROR (Status
)) {
1391 Dev
= VIRTIO_SCSI_FROM_PASS_THRU (PassThru
);
1394 // Handle Stop() requests for in-use driver instances gracefully.
1396 Status
= gBS
->UninstallProtocolInterface (DeviceHandle
,
1397 &gEfiExtScsiPassThruProtocolGuid
, &Dev
->PassThru
);
1398 if (EFI_ERROR (Status
)) {
1402 gBS
->CloseEvent (Dev
->ExitBoot
);
1404 VirtioScsiUninit (Dev
);
1406 gBS
->CloseProtocol (DeviceHandle
, &gVirtioDeviceProtocolGuid
,
1407 This
->DriverBindingHandle
, DeviceHandle
);
1416 // The static object that groups the Supported() (ie. probe), Start() and
1417 // Stop() functions of the driver together. Refer to UEFI Spec 2.3.1 + Errata
1418 // C, 10.1 EFI Driver Binding Protocol.
1420 STATIC EFI_DRIVER_BINDING_PROTOCOL gDriverBinding
= {
1421 &VirtioScsiDriverBindingSupported
,
1422 &VirtioScsiDriverBindingStart
,
1423 &VirtioScsiDriverBindingStop
,
1424 0x10, // Version, must be in [0x10 .. 0xFFFFFFEF] for IHV-developed drivers
1425 NULL
, // ImageHandle, to be overwritten by
1426 // EfiLibInstallDriverBindingComponentName2() in VirtioScsiEntryPoint()
1427 NULL
// DriverBindingHandle, ditto
1432 // The purpose of the following scaffolding (EFI_COMPONENT_NAME_PROTOCOL and
1433 // EFI_COMPONENT_NAME2_PROTOCOL implementation) is to format the driver's name
1434 // in English, for display on standard console devices. This is recommended for
1435 // UEFI drivers that follow the UEFI Driver Model. Refer to the Driver Writer's
1436 // Guide for UEFI 2.3.1 v1.01, 11 UEFI Driver and Controller Names.
1438 // Device type names ("Virtio SCSI Host Device") are not formatted because the
1439 // driver supports only that device type. Therefore the driver name suffices
1440 // for unambiguous identification.
1444 EFI_UNICODE_STRING_TABLE mDriverNameTable
[] = {
1445 { "eng;en", L
"Virtio SCSI Host Driver" },
1450 EFI_COMPONENT_NAME_PROTOCOL gComponentName
;
1454 VirtioScsiGetDriverName (
1455 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
1457 OUT CHAR16
**DriverName
1460 return LookupUnicodeString2 (
1462 This
->SupportedLanguages
,
1465 (BOOLEAN
)(This
== &gComponentName
) // Iso639Language
1471 VirtioScsiGetDeviceName (
1472 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
1473 IN EFI_HANDLE DeviceHandle
,
1474 IN EFI_HANDLE ChildHandle
,
1476 OUT CHAR16
**ControllerName
1479 return EFI_UNSUPPORTED
;
1483 EFI_COMPONENT_NAME_PROTOCOL gComponentName
= {
1484 &VirtioScsiGetDriverName
,
1485 &VirtioScsiGetDeviceName
,
1486 "eng" // SupportedLanguages, ISO 639-2 language codes
1490 EFI_COMPONENT_NAME2_PROTOCOL gComponentName2
= {
1491 (EFI_COMPONENT_NAME2_GET_DRIVER_NAME
) &VirtioScsiGetDriverName
,
1492 (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME
) &VirtioScsiGetDeviceName
,
1493 "en" // SupportedLanguages, RFC 4646 language codes
1498 // Entry point of this driver.
1502 VirtioScsiEntryPoint (
1503 IN EFI_HANDLE ImageHandle
,
1504 IN EFI_SYSTEM_TABLE
*SystemTable
1507 return EfiLibInstallDriverBindingComponentName2 (