Code scrub for IdeBusDxe driver and PeiS3Lib.(undergoing)

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciDriverOverride.h

/** @file\r
\r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
\r
#ifndef _EFI_PCI_DRIVER_OVERRRIDE_H_\r
#define _EFI_PCI_DRIVER_OVERRRIDE_H_\r
\r
#define DRIVER_OVERRIDE_SIGNATURE SIGNATURE_32 ('d', 'r', 'o', 'v')\r
\r
typedef struct {\r
  UINT32          Signature;\r
  LIST_ENTRY      Link;\r
  EFI_HANDLE      DriverImageHandle;\r
} PCI_DRIVER_OVERRIDE_LIST;\r
\r
\r
#define DRIVER_OVERRIDE_FROM_LINK(a) \\r
  CR (a, PCI_DRIVER_OVERRIDE_LIST, Link, DRIVER_OVERRIDE_SIGNATURE)\r
\r
/**\r
  Initializes a PCI Driver Override Instance.\r
\r
  @param  PciIoDevice   Device instance.\r
\r
**/\r
VOID\r
InitializePciDriverOverrideInstance (\r
  PCI_IO_DEVICE  *PciIoDevice\r
  );\r
\r
/**\r
  Add an overriding driver image.\r
  \r
  @param PciIoDevice        Instance of PciIo device.\r
  @param DriverImageHandle  new added driver image.\r
  \r
  @retval EFI_OUT_OF_RESOURCES no memory resource for new driver instance.\r
  @retval EFI_SUCCESS       Success add driver.\r
**/\r
EFI_STATUS\r
AddDriver (\r
  IN PCI_IO_DEVICE     *PciIoDevice,\r
  IN EFI_HANDLE        DriverImageHandle\r
  );\r
\r
\r
/**\r
  Get a overriding driver image.\r
  @param  This                Pointer to instance of EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL.\r
  @param  DriverImageHandle   Override driver image.\r
  \r
  @retval EFI_SUCCESS                 Success to get driver image handle.\r
  @retval EFI_NOT_FOUND               can not find override driver image.\r
  @retval EFI_INVALID_PARAMETER       Invalid parameter.\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetDriver (\r
  IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL              *This,\r
  IN OUT EFI_HANDLE                                         *DriverImageHandle\r
  );\r
\r
#endif\r