MdePkg/Include/Protocol/BusSpecificDriverOverride.h

   1 /** @file
   2   Bus Specific Driver Override protocol as defined in the EFI 1.1 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   Module Name:  BusSpecificDriverOverride.h
  14
  15 **/
  16
  17 #ifndef _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_
  18 #define _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_
  19
  20 //
  21 // Global ID for the Bus Specific Driver Override Protocol
  22 //
  23 #define EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_GUID \
  24   { \
  25     0x3bc1b285, 0x8a15, 0x4a82, {0xaa, 0xbf, 0x4d, 0x7d, 0x13, 0xfb, 0x32, 0x65 } \
  26   }
  27
  28 typedef struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL  EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL;
  29
  30 //
  31 // Prototypes for the Bus Specific Driver Override Protocol
  32 //
  33
  34 /**
  35   Uses a bus specific algorithm to retrieve a driver image handle for a controller.
  36
  37   @param  This                  A pointer to the EFI_BUS_SPECIFIC_DRIVER_
  38                                 OVERRIDE_PROTOCOL instance.
  39   @param  DriverImageHandle     On input, a pointer to the previous driver image handle returned
  40                                 by GetDriver(). On output, a pointer to the next driver
  41                                 image handle. Passing in a NULL, will return the first driver
  42                                 image handle.
  43
  44   @retval EFI_SUCCESS           A bus specific override driver is returned in DriverImageHandle.
  45   @retval EFI_NOT_FOUND         The end of the list of override drivers was reached.
  46   @retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a
  47                                 previous call to GetDriver().
  48
  49 **/
  50 typedef
  51 EFI_STATUS
  52 (EFIAPI *EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER) (
  53   IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL              *This,
  54   IN OUT EFI_HANDLE                                         *DriverImageHandle
  55   );
  56
  57 //
  58 // Interface structure for the Bus Specific Driver Override Protocol
  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