OvmfPkg/LsiScsiDxe/LsiScsi.h

   1 /** @file
   2
   3   Internal definitions for the LSI 53C895A SCSI driver, which produces
   4   Extended SCSI Pass Thru Protocol instances for LSI 53C895A SCSI devices.
   5
   6   Copyright (C) 2020, SUSE LLC.
   7
   8   SPDX-License-Identifier: BSD-2-Clause-Patent
   9
  10 **/
  11
  12 #ifndef _LSI_SCSI_DXE_H_
  13 #define _LSI_SCSI_DXE_H_
  14
  15 typedef struct {
  16   UINT32                          Signature;
  17   UINT8                           MaxTarget;
  18   UINT8                           MaxLun;
  19   EFI_EXT_SCSI_PASS_THRU_MODE     PassThruMode;
  20   EFI_EXT_SCSI_PASS_THRU_PROTOCOL PassThru;
  21 } LSI_SCSI_DEV;
  22
  23 #define LSI_SCSI_DEV_SIGNATURE SIGNATURE_32 ('L','S','I','S')
  24
  25 #define LSI_SCSI_FROM_PASS_THRU(PassThruPtr) \
  26   CR (PassThruPtr, LSI_SCSI_DEV, PassThru, LSI_SCSI_DEV_SIGNATURE)
  27
  28
  29 //
  30 // Probe, start and stop functions of this driver, called by the DXE core for
  31 // specific devices.
  32 //
  33 // The following specifications document these interfaces:
  34 // - Driver Writer's Guide for UEFI 2.3.1 v1.01, 9 Driver Binding Protocol
  35 // - UEFI Spec 2.3.1 + Errata C, 10.1 EFI Driver Binding Protocol
  36 //
  37
  38 EFI_STATUS
  39 EFIAPI
  40 LsiScsiControllerSupported (
  41   IN EFI_DRIVER_BINDING_PROTOCOL *This,
  42   IN EFI_HANDLE                  ControllerHandle,
  43   IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath OPTIONAL
  44   );
  45
  46 EFI_STATUS
  47 EFIAPI
  48 LsiScsiControllerStart (
  49   IN EFI_DRIVER_BINDING_PROTOCOL *This,
  50   IN EFI_HANDLE                  ControllerHandle,
  51   IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath OPTIONAL
  52   );
  53
  54 EFI_STATUS
  55 EFIAPI
  56 LsiScsiControllerStop (
  57   IN EFI_DRIVER_BINDING_PROTOCOL *This,
  58   IN EFI_HANDLE                  ControllerHandle,
  59   IN UINTN                       NumberOfChildren,
  60   IN EFI_HANDLE                  *ChildHandleBuffer
  61   );
  62
  63
  64 //
  65 // The next seven functions implement EFI_EXT_SCSI_PASS_THRU_PROTOCOL
  66 // for the LSI 53C895A SCSI Controller. Refer to UEFI Spec 2.3.1 + Errata C,
  67 // sections
  68 // - 14.1 SCSI Driver Model Overview,
  69 // - 14.7 Extended SCSI Pass Thru Protocol.
  70 //
  71
  72 EFI_STATUS
  73 EFIAPI
  74 LsiScsiPassThru (
  75   IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,
  76   IN UINT8                                          *Target,
  77   IN UINT64                                         Lun,
  78   IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,
  79   IN EFI_EVENT                                      Event     OPTIONAL
  80   );
  81
  82 EFI_STATUS
  83 EFIAPI
  84 LsiScsiGetNextTargetLun (
  85   IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
  86   IN OUT UINT8                       **TargetPointer,
  87   IN OUT UINT64                      *Lun
  88   );
  89
  90 EFI_STATUS
  91 EFIAPI
  92 LsiScsiBuildDevicePath (
  93   IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
  94   IN UINT8                           *Target,
  95   IN UINT64                          Lun,
  96   IN OUT EFI_DEVICE_PATH_PROTOCOL    **DevicePath
  97   );
  98
  99 EFI_STATUS
 100 EFIAPI
 101 LsiScsiGetTargetLun (
 102   IN  EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
 103   IN  EFI_DEVICE_PATH_PROTOCOL        *DevicePath,
 104   OUT UINT8                           **TargetPointer,
 105   OUT UINT64                          *Lun
 106   );
 107
 108 EFI_STATUS
 109 EFIAPI
 110 LsiScsiResetChannel (
 111   IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This
 112   );
 113
 114 EFI_STATUS
 115 EFIAPI
 116 LsiScsiResetTargetLun (
 117   IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
 118   IN UINT8                           *Target,
 119   IN UINT64                          Lun
 120   );
 121
 122 EFI_STATUS
 123 EFIAPI
 124 LsiScsiGetNextTarget (
 125   IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
 126   IN OUT UINT8                       **TargetPointer
 127   );
 128
 129
 130 //
 131 // The purpose of the following scaffolding (EFI_COMPONENT_NAME_PROTOCOL and
 132 // EFI_COMPONENT_NAME2_PROTOCOL implementation) is to format the driver's name
 133 // in English, for display on standard console devices. This is recommended for
 134 // UEFI drivers that follow the UEFI Driver Model. Refer to the Driver Writer's
 135 // Guide for UEFI 2.3.1 v1.01, 11 UEFI Driver and Controller Names.
 136 //
 137 // Device type names ("LSI 53C895A SCSI Controller") are not formatted because
 138 // the driver supports only that device type. Therefore the driver name
 139 // suffices for unambiguous identification.
 140 //
 141
 142 EFI_STATUS
 143 EFIAPI
 144 LsiScsiGetDriverName (
 145   IN  EFI_COMPONENT_NAME_PROTOCOL *This,
 146   IN  CHAR8                       *Language,
 147   OUT CHAR16                      **DriverName
 148   );
 149
 150 EFI_STATUS
 151 EFIAPI
 152 LsiScsiGetDeviceName (
 153   IN  EFI_COMPONENT_NAME_PROTOCOL *This,
 154   IN  EFI_HANDLE                  DeviceHandle,
 155   IN  EFI_HANDLE                  ChildHandle,
 156   IN  CHAR8                       *Language,
 157   OUT CHAR16                      **ControllerName
 158   );
 159
 160 #endif // _LSI_SCSI_DXE_H_