MdePkg/Include/Protocol/BusSpecificDriverOverride.h

   1 /** @file
   2   Bus Specific Driver Override protocol as defined in the UEFI 2.0 specification.
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_
  16 #define _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_
  17
  18 //
  19 // Global ID for the Bus Specific Driver Override Protocol
  20 //
  21 #define EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_GUID \
  22   { \
  23     0x3bc1b285, 0x8a15, 0x4a82, {0xaa, 0xbf, 0x4d, 0x7d, 0x13, 0xfb, 0x32, 0x65 } \
  24   }
  25
  26 typedef struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL  EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL;
  27
  28 //
  29 // Prototypes for the Bus Specific Driver Override Protocol
  30 //
  31
  32 /**
  33   Uses a bus specific algorithm to retrieve a driver image handle for a controller.
  34
  35   @param  This                  A pointer to the EFI_BUS_SPECIFIC_DRIVER_
  36                                 OVERRIDE_PROTOCOL instance.
  37   @param  DriverImageHandle     On input, a pointer to the previous driver image handle returned
  38                                 by GetDriver(). On output, a pointer to the next driver
  39                                 image handle. Passing in a NULL, will return the first driver
  40                                 image handle.
  41
  42   @retval EFI_SUCCESS           A bus specific override driver is returned in DriverImageHandle.
  43   @retval EFI_NOT_FOUND         The end of the list of override drivers was reached.
  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 // Interface structure for the Bus Specific Driver Override Protocol
  57 //
  58 struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL {
  59   EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER GetDriver;
  60 };
  61
  62 extern EFI_GUID gEfiBusSpecificDriverOverrideProtocolGuid;
  63
  64 #endif