3 Internal definitions for the virtio-scsi driver, which produces Extended SCSI
4 Pass Thru Protocol instances for virtio-scsi devices.
6 Copyright (C) 2012, Red Hat, Inc.
8 This program and the accompanying materials are licensed and made available
9 under the terms and conditions of the BSD License which accompanies this
10 distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
14 WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #ifndef _VIRTIO_SCSI_DXE_H_
19 #define _VIRTIO_SCSI_DXE_H_
21 #include <Protocol/ComponentName.h>
22 #include <Protocol/DriverBinding.h>
23 #include <Protocol/ScsiPassThruExt.h>
25 #include <IndustryStandard/Virtio.h>
29 // This driver supports 2-byte target identifiers and 4-byte LUN identifiers.
31 // EFI_EXT_SCSI_PASS_THRU_PROTOCOL provides TARGET_MAX_BYTES bytes for target
32 // identification, and 8 bytes for LUN identification.
34 // EFI_EXT_SCSI_PASS_THRU_MODE.AdapterId is also a target identifier,
35 // consisting of 4 bytes. Make sure TARGET_MAX_BYTES can accomodate both
36 // AdapterId and our target identifiers.
38 #if TARGET_MAX_BYTES < 4
39 # error "virtio-scsi requires TARGET_MAX_BYTES >= 4"
43 #define VSCSI_SIG SIGNATURE_32 ('V', 'S', 'C', 'S')
47 // Parts of this structure are initialized / torn down in various functions
48 // at various call depths. The table to the right should make it easier to
51 // field init function init depth
52 // ---------------- ------------------ ----------
53 UINT32 Signature
; // DriverBindingStart 0
54 VIRTIO_DEVICE_PROTOCOL
*VirtIo
; // DriverBindingStart 0
55 BOOLEAN InOutSupported
; // VirtioScsiInit 1
56 UINT16 MaxTarget
; // VirtioScsiInit 1
57 UINT32 MaxLun
; // VirtioScsiInit 1
58 UINT32 MaxSectors
; // VirtioScsiInit 1
59 VRING Ring
; // VirtioRingInit 2
60 EFI_EXT_SCSI_PASS_THRU_PROTOCOL PassThru
; // VirtioScsiInit 1
61 EFI_EXT_SCSI_PASS_THRU_MODE PassThruMode
; // VirtioScsiInit 1
64 #define VIRTIO_SCSI_FROM_PASS_THRU(PassThruPointer) \
65 CR (PassThruPointer, VSCSI_DEV, PassThru, VSCSI_SIG)
69 // Probe, start and stop functions of this driver, called by the DXE core for
72 // The following specifications document these interfaces:
73 // - Driver Writer's Guide for UEFI 2.3.1 v1.01, 9 Driver Binding Protocol
74 // - UEFI Spec 2.3.1 + Errata C, 10.1 EFI Driver Binding Protocol
79 VirtioScsiDriverBindingSupported (
80 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
81 IN EFI_HANDLE DeviceHandle
,
82 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
88 VirtioScsiDriverBindingStart (
89 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
90 IN EFI_HANDLE DeviceHandle
,
91 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
97 VirtioScsiDriverBindingStop (
98 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
99 IN EFI_HANDLE DeviceHandle
,
100 IN UINTN NumberOfChildren
,
101 IN EFI_HANDLE
*ChildHandleBuffer
106 // The next seven functions implement EFI_EXT_SCSI_PASS_THRU_PROTOCOL
107 // for the virtio-scsi HBA. Refer to UEFI Spec 2.3.1 + Errata C, sections
108 // - 14.1 SCSI Driver Model Overview,
109 // - 14.7 Extended SCSI Pass Thru Protocol.
115 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
118 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
,
119 IN EFI_EVENT Event OPTIONAL
125 VirtioScsiGetNextTargetLun (
126 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
127 IN OUT UINT8
**Target
,
134 VirtioScsiBuildDevicePath (
135 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
138 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
144 VirtioScsiGetTargetLun (
145 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
146 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
154 VirtioScsiResetChannel (
155 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
161 VirtioScsiResetTargetLun (
162 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
170 VirtioScsiGetNextTarget (
171 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*This
,
172 IN OUT UINT8
**Target
177 // The purpose of the following scaffolding (EFI_COMPONENT_NAME_PROTOCOL and
178 // EFI_COMPONENT_NAME2_PROTOCOL implementation) is to format the driver's name
179 // in English, for display on standard console devices. This is recommended for
180 // UEFI drivers that follow the UEFI Driver Model. Refer to the Driver Writer's
181 // Guide for UEFI 2.3.1 v1.01, 11 UEFI Driver and Controller Names.
183 // Device type names ("Virtio SCSI Host Device") are not formatted because the
184 // driver supports only that device type. Therefore the driver name suffices
185 // for unambiguous identification.
190 VirtioScsiGetDriverName (
191 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
193 OUT CHAR16
**DriverName
199 VirtioScsiGetDeviceName (
200 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
201 IN EFI_HANDLE DeviceHandle
,
202 IN EFI_HANDLE ChildHandle
,
204 OUT CHAR16
**ControllerName
207 #endif // _VIRTIO_SCSI_DXE_H_