OvmfPkg/OvmfXen: Creating an ELF header

[mirror_edk2.git] / OvmfPkg / VirtioScsiDxe / VirtioScsi.h

/** @file\r
\r
  Internal definitions for the virtio-scsi driver, which produces Extended SCSI\r
  Pass Thru Protocol instances for virtio-scsi devices.\r
\r
  Copyright (C) 2012, Red Hat, Inc.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _VIRTIO_SCSI_DXE_H_\r
#define _VIRTIO_SCSI_DXE_H_\r
\r
#include <Protocol/ComponentName.h>\r
#include <Protocol/DriverBinding.h>\r
#include <Protocol/ScsiPassThruExt.h>\r
\r
#include <IndustryStandard/Virtio.h>\r
\r
\r
//\r
// This driver supports 2-byte target identifiers and 4-byte LUN identifiers.\r
//\r
// EFI_EXT_SCSI_PASS_THRU_PROTOCOL provides TARGET_MAX_BYTES bytes for target\r
// identification, and 8 bytes for LUN identification.\r
//\r
// EFI_EXT_SCSI_PASS_THRU_MODE.AdapterId is also a target identifier,\r
// consisting of 4 bytes. Make sure TARGET_MAX_BYTES can accommodate both\r
// AdapterId and our target identifiers.\r
//\r
#if TARGET_MAX_BYTES < 4\r
#  error "virtio-scsi requires TARGET_MAX_BYTES >= 4"\r
#endif\r
\r
\r
#define VSCSI_SIG SIGNATURE_32 ('V', 'S', 'C', 'S')\r
\r
typedef struct {\r
  //\r
  // Parts of this structure are initialized / torn down in various functions\r
  // at various call depths. The table to the right should make it easier to\r
  // track them.\r
  //\r
  //                              field              init function       init depth\r
  //                              ----------------   ------------------  ----------\r
  UINT32                          Signature;      // DriverBindingStart  0\r
  VIRTIO_DEVICE_PROTOCOL          *VirtIo;        // DriverBindingStart  0\r
  EFI_EVENT                       ExitBoot;       // DriverBindingStart  0\r
  BOOLEAN                         InOutSupported; // VirtioScsiInit      1\r
  UINT16                          MaxTarget;      // VirtioScsiInit      1\r
  UINT32                          MaxLun;         // VirtioScsiInit      1\r
  UINT32                          MaxSectors;     // VirtioScsiInit      1\r
  VRING                           Ring;           // VirtioRingInit      2\r
  EFI_EXT_SCSI_PASS_THRU_PROTOCOL PassThru;       // VirtioScsiInit      1\r
  EFI_EXT_SCSI_PASS_THRU_MODE     PassThruMode;   // VirtioScsiInit      1\r
  VOID                            *RingMap;       // VirtioRingMap       2\r
} VSCSI_DEV;\r
\r
#define VIRTIO_SCSI_FROM_PASS_THRU(PassThruPointer) \\r
        CR (PassThruPointer, VSCSI_DEV, PassThru, VSCSI_SIG)\r
\r
\r
//\r
// Probe, start and stop functions of this driver, called by the DXE core for\r
// specific devices.\r
//\r
// The following specifications document these interfaces:\r
// - Driver Writer's Guide for UEFI 2.3.1 v1.01, 9 Driver Binding Protocol\r
// - UEFI Spec 2.3.1 + Errata C, 10.1 EFI Driver Binding Protocol\r
//\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioScsiDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
  IN EFI_HANDLE                  DeviceHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioScsiDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
  IN EFI_HANDLE                  DeviceHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioScsiDriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
  IN EFI_HANDLE                  DeviceHandle,\r
  IN UINTN                       NumberOfChildren,\r
  IN EFI_HANDLE                  *ChildHandleBuffer\r
  );\r
\r
\r
//\r
// The next seven functions implement EFI_EXT_SCSI_PASS_THRU_PROTOCOL\r
// for the virtio-scsi HBA. Refer to UEFI Spec 2.3.1 + Errata C, sections\r
// - 14.1 SCSI Driver Model Overview,\r
// - 14.7 Extended SCSI Pass Thru Protocol.\r
//\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioScsiPassThru (\r
  IN     EFI_EXT_SCSI_PASS_THRU_PROTOCOL            *This,\r
  IN     UINT8                                      *Target,\r
  IN     UINT64                                     Lun,\r
  IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r
  IN     EFI_EVENT                                  Event   OPTIONAL\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioScsiGetNextTargetLun (\r
  IN     EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r
  IN OUT UINT8                           **Target,\r
  IN OUT UINT64                          *Lun\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioScsiBuildDevicePath (\r
  IN     EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r
  IN     UINT8                           *Target,\r
  IN     UINT64                          Lun,\r
  IN OUT EFI_DEVICE_PATH_PROTOCOL        **DevicePath\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioScsiGetTargetLun (\r
  IN  EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r
  IN  EFI_DEVICE_PATH_PROTOCOL        *DevicePath,\r
  OUT UINT8                           **Target,\r
  OUT UINT64                          *Lun\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioScsiResetChannel (\r
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioScsiResetTargetLun (\r
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r
  IN UINT8                           *Target,\r
  IN UINT64                          Lun\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioScsiGetNextTarget (\r
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r
  IN OUT UINT8                       **Target\r
  );\r
\r
\r
//\r
// The purpose of the following scaffolding (EFI_COMPONENT_NAME_PROTOCOL and\r
// EFI_COMPONENT_NAME2_PROTOCOL implementation) is to format the driver's name\r
// in English, for display on standard console devices. This is recommended for\r
// UEFI drivers that follow the UEFI Driver Model. Refer to the Driver Writer's\r
// Guide for UEFI 2.3.1 v1.01, 11 UEFI Driver and Controller Names.\r
//\r
// Device type names ("Virtio SCSI Host Device") are not formatted because the\r
// driver supports only that device type. Therefore the driver name suffices\r
// for unambiguous identification.\r
//\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioScsiGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL *This,\r
  IN  CHAR8                       *Language,\r
  OUT CHAR16                      **DriverName\r
  );\r
\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioScsiGetDeviceName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL *This,\r
  IN  EFI_HANDLE                  DeviceHandle,\r
  IN  EFI_HANDLE                  ChildHandle,\r
  IN  CHAR8                       *Language,\r
  OUT CHAR16                      **ControllerName\r
  );\r
\r
#endif // _VIRTIO_SCSI_DXE_H_\r