MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Include / Protocol / BusSpecificDriverOverride.h

/** @file\r
  Bus Specific Driver Override protocol as defined in the UEFI 2.0 specification.\r
\r
  Bus drivers that have a bus specific algorithm for matching drivers to controllers are\r
  required to produce this protocol for each controller. For example, a PCI Bus Driver will produce an\r
  instance of this protocol for every PCI controller that has a PCI option ROM that contains one or\r
  more UEFI drivers. The protocol instance is attached to the handle of the PCI controller.\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_\r
#define _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_\r
\r
///\r
/// Global ID for the Bus Specific Driver Override Protocol\r
///\r
#define EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_GUID \\r
  { \\r
    0x3bc1b285, 0x8a15, 0x4a82, {0xaa, 0xbf, 0x4d, 0x7d, 0x13, 0xfb, 0x32, 0x65 } \\r
  }\r
\r
typedef struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL  EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL;\r
\r
//\r
// Prototypes for the Bus Specific Driver Override Protocol\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_\r
                                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
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER)(\r
  IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL              *This,\r
  IN OUT EFI_HANDLE                                         *DriverImageHandle\r
  );\r
\r
///\r
/// This protocol matches one or more drivers to a controller. This protocol is produced by a bus driver,\r
/// and it is installed on the child handles of buses that require a bus specific algorithm for matching\r
/// drivers to controllers.\r
///\r
struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL {\r
  EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER GetDriver;\r
};\r
\r
extern EFI_GUID gEfiBusSpecificDriverOverrideProtocolGuid;\r
\r
#endif\r