OvmfPkg/LsiScsiDxe/LsiScsi.c

   1 /** @file
   2
   3   This driver produces Extended SCSI Pass Thru Protocol instances for
   4   LSI 53C895A SCSI devices.
   5
   6   Copyright (C) 2020, SUSE LLC.
   7
   8   SPDX-License-Identifier: BSD-2-Clause-Patent
   9
  10 **/
  11
  12 #include <Library/UefiLib.h>
  13 #include <Uefi/UefiSpec.h>
  14
  15 #include "LsiScsi.h"
  16
  17 //
  18 // Probe, start and stop functions of this driver, called by the DXE core for
  19 // specific devices.
  20 //
  21 // The following specifications document these interfaces:
  22 // - Driver Writer's Guide for UEFI 2.3.1 v1.01, 9 Driver Binding Protocol
  23 // - UEFI Spec 2.3.1 + Errata C, 10.1 EFI Driver Binding Protocol
  24 //
  25
  26 EFI_STATUS
  27 EFIAPI
  28 LsiScsiControllerSupported (
  29   IN EFI_DRIVER_BINDING_PROTOCOL *This,
  30   IN EFI_HANDLE                  ControllerHandle,
  31   IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath OPTIONAL
  32   )
  33 {
  34   return EFI_UNSUPPORTED;
  35 }
  36
  37 EFI_STATUS
  38 EFIAPI
  39 LsiScsiControllerStart (
  40   IN EFI_DRIVER_BINDING_PROTOCOL *This,
  41   IN EFI_HANDLE                  ControllerHandle,
  42   IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath OPTIONAL
  43   )
  44 {
  45   return EFI_SUCCESS;
  46 }
  47
  48 EFI_STATUS
  49 EFIAPI
  50 LsiScsiControllerStop (
  51   IN EFI_DRIVER_BINDING_PROTOCOL *This,
  52   IN EFI_HANDLE                  ControllerHandle,
  53   IN UINTN                       NumberOfChildren,
  54   IN EFI_HANDLE                  *ChildHandleBuffer
  55   )
  56 {
  57   return EFI_SUCCESS;
  58 }
  59
  60 //
  61 // The static object that groups the Supported() (ie. probe), Start() and
  62 // Stop() functions of the driver together. Refer to UEFI Spec 2.3.1 + Errata
  63 // C, 10.1 EFI Driver Binding Protocol.
  64 //
  65 STATIC
  66 EFI_DRIVER_BINDING_PROTOCOL gDriverBinding = {
  67   &LsiScsiControllerSupported,
  68   &LsiScsiControllerStart,
  69   &LsiScsiControllerStop,
  70   0x10, // Version, must be in [0x10 .. 0xFFFFFFEF] for IHV-developed drivers
  71   NULL, // ImageHandle, to be overwritten by
  72         // EfiLibInstallDriverBindingComponentName2() in LsiScsiEntryPoint()
  73   NULL  // DriverBindingHandle, ditto
  74 };
  75
  76
  77 //
  78 // Entry point of this driver
  79 //
  80 EFI_STATUS
  81 EFIAPI
  82 LsiScsiEntryPoint (
  83   IN EFI_HANDLE       ImageHandle,
  84   IN EFI_SYSTEM_TABLE *SystemTable
  85   )
  86 {
  87   return EfiLibInstallDriverBindingComponentName2 (
  88            ImageHandle,
  89            SystemTable,
  90            &gDriverBinding,
  91            ImageHandle, // The handle to install onto
  92            NULL, // TODO Component name
  93            NULL  // TODO Component name
  94            );
  95 }