PciDriverOverride.h revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
a72f7ea693101cc48bafbb4db6bb437d828011c4ql/** @file
9aa73b6813b3fd35e78fcc44fd17535e765e504cQin Michael Li Functions declaration for Bus Specific Driver Override protoocl.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4qlCopyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
a72f7ea693101cc48bafbb4db6bb437d828011c4qlThis program and the accompanying materials
a72f7ea693101cc48bafbb4db6bb437d828011c4qlare licensed and made available under the terms and conditions of the BSD License
a72f7ea693101cc48bafbb4db6bb437d828011c4qlwhich accompanies this distribution. The full text of the license may be found at
a72f7ea693101cc48bafbb4db6bb437d828011c4qlhttp://opensource.org/licenses/bsd-license.php
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4qlTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
a72f7ea693101cc48bafbb4db6bb437d828011c4qlWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql**/
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql#ifndef _EFI_PCI_DRIVER_OVERRRIDE_H_
a72f7ea693101cc48bafbb4db6bb437d828011c4ql#define _EFI_PCI_DRIVER_OVERRRIDE_H_
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql#define DRIVER_OVERRIDE_SIGNATURE SIGNATURE_32 ('d', 'r', 'o', 'v')
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql//
a72f7ea693101cc48bafbb4db6bb437d828011c4ql// PCI driver override driver image list
a72f7ea693101cc48bafbb4db6bb437d828011c4ql//
a72f7ea693101cc48bafbb4db6bb437d828011c4qltypedef struct {
a72f7ea693101cc48bafbb4db6bb437d828011c4ql UINT32 Signature;
a72f7ea693101cc48bafbb4db6bb437d828011c4ql LIST_ENTRY Link;
a72f7ea693101cc48bafbb4db6bb437d828011c4ql EFI_HANDLE DriverImageHandle;
a72f7ea693101cc48bafbb4db6bb437d828011c4ql} PCI_DRIVER_OVERRIDE_LIST;
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql#define DRIVER_OVERRIDE_FROM_LINK(a) \
a72f7ea693101cc48bafbb4db6bb437d828011c4ql CR (a, PCI_DRIVER_OVERRIDE_LIST, Link, DRIVER_OVERRIDE_SIGNATURE)
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql/**
a72f7ea693101cc48bafbb4db6bb437d828011c4ql Initializes a PCI Driver Override Instance.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql @param PciIoDevice PCI Device instance.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
9aa73b6813b3fd35e78fcc44fd17535e765e504cQin Michael Li**/
9aa73b6813b3fd35e78fcc44fd17535e765e504cQin Michael LiVOID
9aa73b6813b3fd35e78fcc44fd17535e765e504cQin Michael LiInitializePciDriverOverrideInstance (
9aa73b6813b3fd35e78fcc44fd17535e765e504cQin Michael Li IN OUT PCI_IO_DEVICE *PciIoDevice
a72f7ea693101cc48bafbb4db6bb437d828011c4ql );
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql/**
a72f7ea693101cc48bafbb4db6bb437d828011c4ql Add an overriding driver image.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql @param PciIoDevice Instance of PciIo device.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql @param DriverImageHandle new added driver image.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql @retval EFI_SUCCESS Successfully added driver.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql @retval EFI_OUT_OF_RESOURCES No memory resource for new driver instance.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql @retval other Some error occurred when locating gEfiLoadedImageProtocolGuid.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql**/
a72f7ea693101cc48bafbb4db6bb437d828011c4qlEFI_STATUS
a72f7ea693101cc48bafbb4db6bb437d828011c4qlAddDriver (
a72f7ea693101cc48bafbb4db6bb437d828011c4ql IN PCI_IO_DEVICE *PciIoDevice,
a72f7ea693101cc48bafbb4db6bb437d828011c4ql IN EFI_HANDLE DriverImageHandle
a72f7ea693101cc48bafbb4db6bb437d828011c4ql );
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql/**
a72f7ea693101cc48bafbb4db6bb437d828011c4ql Uses a bus specific algorithm to retrieve a driver image handle for a controller.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql @param This A pointer to the EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL instance.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql @param DriverImageHandle On input, a pointer to the previous driver image handle returned
a72f7ea693101cc48bafbb4db6bb437d828011c4ql by GetDriver(). On output, a pointer to the next driver
a72f7ea693101cc48bafbb4db6bb437d828011c4ql image handle. Passing in a NULL, will return the first driver
a72f7ea693101cc48bafbb4db6bb437d828011c4ql image handle.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql @retval EFI_SUCCESS A bus specific override driver is returned in DriverImageHandle.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql @retval EFI_NOT_FOUND The end of the list of override drivers was reached.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql A bus specific override driver is not returned in DriverImageHandle.
a72f7ea693101cc48bafbb4db6bb437d828011c4ql @retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a
a72f7ea693101cc48bafbb4db6bb437d828011c4ql previous call to GetDriver().
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql**/
a72f7ea693101cc48bafbb4db6bb437d828011c4qlEFI_STATUS
a72f7ea693101cc48bafbb4db6bb437d828011c4qlEFIAPI
a72f7ea693101cc48bafbb4db6bb437d828011c4qlGetDriver (
a72f7ea693101cc48bafbb4db6bb437d828011c4ql IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL *This,
a72f7ea693101cc48bafbb4db6bb437d828011c4ql IN OUT EFI_HANDLE *DriverImageHandle
a72f7ea693101cc48bafbb4db6bb437d828011c4ql );
a72f7ea693101cc48bafbb4db6bb437d828011c4ql
a72f7ea693101cc48bafbb4db6bb437d828011c4ql#endif
a72f7ea693101cc48bafbb4db6bb437d828011c4ql