IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDriverOverride.h

   1 /**@file
   2
   3 Copyright (c) 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 **/
  13
  14
  15 #ifndef _EFI_PCI_DRIVER_OVERRRIDE_H
  16 #define _EFI_PCI_DRIVER_OVERRRIDE_H
  17
  18 #define DRIVER_OVERRIDE_SIGNATURE EFI_SIGNATURE_32 ('d', 'r', 'o', 'v')
  19
  20 typedef struct {
  21   UINT32          Signature;
  22   LIST_ENTRY      Link;
  23   EFI_HANDLE      DriverImageHandle;
  24 } PCI_DRIVER_OVERRIDE_LIST;
  25
  26
  27 #define DRIVER_OVERRIDE_FROM_LINK(a) \
  28   CR (a, PCI_DRIVER_OVERRIDE_LIST, Link, DRIVER_OVERRIDE_SIGNATURE)
  29
  30 /**
  31   Initializes a PCI Driver Override Instance
  32
  33   @param  PciIoDevice   Device instance
  34
  35   @retval EFI_SUCCESS Operation success
  36 **/
  37 EFI_STATUS
  38 InitializePciDriverOverrideInstance (
  39   PCI_IO_DEVICE  *PciIoDevice
  40   );
  41
  42 /**
  43   Add an overriding driver image
  44
  45   @param PciIoDevice        Instance of PciIo device
  46   @param DriverImageHandle  new added driver image
  47
  48   @retval EFI_OUT_OF_RESOURCES no memory resource for new driver instance
  49   @retval EFI_SUCCESS       Success add driver
  50 **/
  51 EFI_STATUS
  52 AddDriver (
  53   IN PCI_IO_DEVICE     *PciIoDevice,
  54   IN EFI_HANDLE        DriverImageHandle
  55   );
  56
  57
  58 /**
  59   Get a overriding driver image
  60   @param  This                Pointer to instance of EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL
  61   @param  DriverImageHandle   Override driver image,
  62
  63   @retval EFI_SUCCESS                 Success to get driver image handle
  64   @retval EFI_NOT_FOUND               can not find override driver image
  65   @retval EFI_INVALID_PARAMETER       Invalid parameter
  66 **/
  67 EFI_STATUS
  68 EFIAPI
  69 GetDriver (
  70   IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL              *This,
  71   IN OUT EFI_HANDLE                                         *DriverImageHandle
  72   );
  73
  74 #endif