Tools/Source/TianoTools/Include/Protocol/PlatformDriverOverride.h

   1 /** @file
   2   Platform 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:  PlatformDriverOverride.h
  14
  15 **/
  16
  17 #ifndef __EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_H__
  18 #define __EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_H__
  19
  20 //
  21 // Global ID for the Platform Driver Override Protocol
  22 //
  23 #define EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_GUID \
  24   { \
  25     0x6b30c738, 0xa391, 0x11d4, {0x9a, 0x3b, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
  26   }
  27
  28 typedef struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL  EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL;
  29
  30 //
  31 // Prototypes for the Platform Driver Override Protocol
  32 //
  33
  34 /**
  35   Retrieves the image handle of the platform override driver for a controller in the system.
  36
  37   @param  This                  A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_
  38                                 PROTOCOL instance.
  39   @param  ControllerHandle      The device handle of the controller to check if a driver override
  40                                 exists.
  41   @param  DriverImageHandle     On input, a pointer to the previous driver image handle returned
  42                                 by GetDriver(). On output, a pointer to the next driver
  43                                 image handle.
  44
  45   @retval EFI_SUCCESS           The driver override for ControllerHandle was returned in
  46                                 DriverImageHandle.
  47   @retval EFI_NOT_FOUND         A driver override for ControllerHandle was not found.
  48   @retval EFI_INVALID_PARAMETER The handle specified by ControllerHandle is not a valid handle.
  49   @retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a
  50                                 previous call to GetDriver().
  51
  52 **/
  53 typedef
  54 EFI_STATUS
  55 (EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER) (
  56   IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL              *This,
  57   IN     EFI_HANDLE                                     ControllerHandle,
  58   IN OUT EFI_HANDLE                                     *DriverImageHandle
  59   );
  60
  61 /**
  62   Retrieves the device path of the platform override driver for a controller in the system.
  63
  64   @param  This                  A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_
  65                                 PROTOCOL instance.
  66   @param  ControllerHandle      The device handle of the controller to check if a driver override
  67                                 exists.
  68   @param  DriverImageHandle     On input, a pointer to the previous driver image handle returned
  69                                 by GetDriverPath(). On output, a pointer to the next driver
  70                                 device path.
  71
  72   @retval EFI_SUCCESS           The driver override for ControllerHandle was returned in
  73                                 DriverImageHandle.
  74   @retval EFI_UNSUPPORTED       The operation is not supported.
  75   @retval EFI_NOT_FOUND         A driver override for ControllerHandle was not found.
  76   @retval EFI_INVALID_PARAMETER The handle specified by ControllerHandle is not a valid handle.
  77   @retval EFI_INVALID_PARAMETER DriverImagePath is not a device path that was returned on a
  78                                 previous call to GetDriverPath().
  79
  80 **/
  81 typedef
  82 EFI_STATUS
  83 (EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER_PATH) (
  84   IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL              *This,
  85   IN     EFI_HANDLE                                     ControllerHandle,
  86   IN OUT EFI_DEVICE_PATH_PROTOCOL                       **DriverImagePath
  87   );
  88
  89 /**
  90   Used to associate a driver image handle with a device path that was returned on a prior call to the
  91   GetDriverPath() service. This driver image handle will then be available through the
  92   GetDriver() service.
  93
  94   @param  This                  A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_
  95                                 PROTOCOL instance.
  96   @param  ControllerHandle      The device handle of the controller.
  97   @param  DriverImagePath       A pointer to the driver device path that was returned in a prior
  98                                 call to GetDriverPath().
  99   @param  DriverImageHandle     The driver image handle that was returned by LoadImage()
 100                                 when the driver specified by DriverImagePath was loaded
 101                                 into memory.
 102
 103   @retval EFI_SUCCESS           The association between DriverImagePath and
 104                                 DriverImageHandle was established for the controller specified
 105                                 by ControllerHandle.
 106   @retval EFI_UNSUPPORTED       The operation is not supported.
 107   @retval EFI_NOT_FOUND         DriverImagePath is not a device path that was returned on a prior
 108                                 call to GetDriverPath() for the controller specified by
 109                                 ControllerHandle.
 110   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid device handle.
 111   @retval EFI_INVALID_PARAMETER DriverImagePath is not a valid device path.
 112   @retval EFI_INVALID_PARAMETER DriverImageHandle is not a valid image handle.
 113
 114 **/
 115 typedef
 116 EFI_STATUS
 117 (EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_DRIVER_LOADED) (
 118   IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL          *This,
 119   IN EFI_HANDLE                                     ControllerHandle,
 120   IN EFI_DEVICE_PATH_PROTOCOL                       *DriverImagePath,
 121   IN EFI_HANDLE                                     DriverImageHandle
 122   );
 123
 124 //
 125 // Interface structure for the Platform Driver Override Protocol
 126 //
 127 struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL {
 128   EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER       GetDriver;
 129   EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER_PATH  GetDriverPath;
 130   EFI_PLATFORM_DRIVER_OVERRIDE_DRIVER_LOADED    DriverLoaded;
 131 };
 132
 133 extern EFI_GUID gEfiPlatformDriverOverrideProtocolGuid;
 134
 135 #endif