MdeModulePkg: Apply uncrustify changes

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

/** @file\r
  Functions declaration for Bus Specific Driver Override protocol.\r
\r
Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\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
//\r
// PCI driver override driver image list\r
//\r
typedef struct {\r
  UINT32                      Signature;\r
  LIST_ENTRY                  Link;\r
  EFI_HANDLE                  DriverImageHandle;\r
  EFI_DEVICE_PATH_PROTOCOL    *DriverImagePath;\r
} PCI_DRIVER_OVERRIDE_LIST;\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   PCI Device instance.\r
\r
**/\r
VOID\r
InitializePciDriverOverrideInstance (\r
  IN OUT PCI_IO_DEVICE  *PciIoDevice\r
  );\r
\r
/**\r
  Add an overriding driver image.\r
\r
  @param PciIoDevice        Instance of PciIo device.\r
  @param DriverImageHandle  Image handle of newly added driver image.\r
  @param DriverImagePath    Device path of newly added driver image.\r
\r
  @retval EFI_SUCCESS          Successfully added driver.\r
  @retval EFI_OUT_OF_RESOURCES No memory resource for new driver instance.\r
  @retval other                Some error occurred when locating gEfiLoadedImageProtocolGuid.\r
\r
**/\r
EFI_STATUS\r
AddDriver (\r
  IN PCI_IO_DEVICE             *PciIoDevice,\r
  IN EFI_HANDLE                DriverImageHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL  *DriverImagePath\r
  );\r
\r
/**\r
  Uses a bus specific algorithm to retrieve a driver image handle for a controller.\r
\r
  @param  This                  A pointer to the EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL instance.\r
  @param  DriverImageHandle     On input, a pointer to the previous driver image handle returned\r
                                by GetDriver(). On output, a pointer to the next driver\r
                                image handle. Passing in a NULL, will return the first driver\r
                                image handle.\r
\r
  @retval EFI_SUCCESS           A bus specific override driver is returned in DriverImageHandle.\r
  @retval EFI_NOT_FOUND         The end of the list of override drivers was reached.\r
                                A bus specific override driver is not returned in DriverImageHandle.\r
  @retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a\r
                                previous call to GetDriver().\r
\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