MdePkg/Include/Protocol/BusSpecificDriverOverride.h

   1 /** @file
   2   Bus Specific Driver Override protocol as defined in the UEFI 2.0 specification.
   3
   4   Bus drivers that have a bus specific algorithm for matching drivers to controllers are
   5   required to produce this protocol for each controller. For example, a PCI Bus Driver will produce an
   6   instance of this protocol for every PCI controller that has a PCI option ROM that contains one or
   7   more UEFI drivers. The protocol instance is attached to the handle of the PCI controller.
   8
   9   Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
  10   SPDX-License-Identifier: BSD-2-Clause-Patent
  11
  12 **/
  13
  14 #ifndef _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_
  15 #define _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_
  16
  17 ///
  18 /// Global ID for the Bus Specific Driver Override Protocol
  19 ///
  20 #define EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_GUID \
  21   { \
  22     0x3bc1b285, 0x8a15, 0x4a82, {0xaa, 0xbf, 0x4d, 0x7d, 0x13, 0xfb, 0x32, 0x65 } \
  23   }
  24
  25 typedef struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL  EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL;
  26
  27 //
  28 // Prototypes for the Bus Specific Driver Override Protocol
  29 //
  30
  31 /**
  32   Uses a bus specific algorithm to retrieve a driver image handle for a controller.
  33
  34   @param  This                  A pointer to the EFI_BUS_SPECIFIC_DRIVER_
  35                                 OVERRIDE_PROTOCOL instance.
  36   @param  DriverImageHandle     On input, a pointer to the previous driver image handle returned
  37                                 by GetDriver(). On output, a pointer to the next driver
  38                                 image handle. Passing in a NULL, will return the first driver
  39                                 image handle.
  40
  41   @retval EFI_SUCCESS           A bus specific override driver is returned in DriverImageHandle.
  42   @retval EFI_NOT_FOUND         The end of the list of override drivers was reached.
  43                                 A bus specific override driver is not returned in DriverImageHandle.
  44   @retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a
  45                                 previous call to GetDriver().
  46
  47 **/
  48 typedef
  49 EFI_STATUS
  50 (EFIAPI *EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER)(
  51   IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL              *This,
  52   IN OUT EFI_HANDLE                                         *DriverImageHandle
  53   );
  54
  55 ///
  56 /// This protocol matches one or more drivers to a controller. This protocol is produced by a bus driver,
  57 /// and it is installed on the child handles of buses that require a bus specific algorithm for matching
  58 /// drivers to controllers.
  59 ///
  60 struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL {
  61   EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER GetDriver;
  62 };
  63
  64 extern EFI_GUID gEfiBusSpecificDriverOverrideProtocolGuid;
  65
  66 #endif