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