Removed cross references from PciCf8Lib and PciExpressLib class to PciLib class.

[mirror_edk2.git] / EdkModulePkg / Bus / Pci / PciBus / Dxe / PciEnumeratorSupport.h

/*++\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
Module Name:\r
\r
  PciEnumeratorSupport.h\r
  \r
Abstract:\r
\r
  PCI Bus Driver\r
\r
Revision History\r
\r
--*/\r
\r
#ifndef _EFI_PCI_ENUMERATOR_SUPPORT_H\r
#define _EFI_PCI_ENUMERATOR_SUPPORT_H\r
\r
EFI_STATUS\r
PciDevicePresent (\r
  IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *PciRootBridgeIo,\r
  PCI_TYPE00                          *Pci,\r
  UINT8                               Bus,\r
  UINT8                               Device,\r
  UINT8                               Func\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciRootBridgeIo - TODO: add argument description\r
  Pci             - TODO: add argument description\r
  Bus             - TODO: add argument description\r
  Device          - TODO: add argument description\r
  Func            - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
PciPciDeviceInfoCollector (\r
  IN PCI_IO_DEVICE                      *Bridge,\r
  UINT8                                 StartBusNumber\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Bridge          - TODO: add argument description\r
  StartBusNumber  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
PciSearchDevice (\r
  IN PCI_IO_DEVICE                      *Bridge,\r
  PCI_TYPE00                            *Pci,\r
  UINT8                                 Bus,\r
  UINT8                                 Device,\r
  UINT8                                 Func,\r
  PCI_IO_DEVICE                         **PciDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Bridge    - TODO: add argument description\r
  Pci       - TODO: add argument description\r
  Bus       - TODO: add argument description\r
  Device    - TODO: add argument description\r
  Func      - TODO: add argument description\r
  PciDevice - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
PCI_IO_DEVICE             *\r
GatherDeviceInfo (\r
  IN PCI_IO_DEVICE                    *Bridge,\r
  IN PCI_TYPE00                       *Pci,\r
  UINT8                               Bus,\r
  UINT8                               Device,\r
  UINT8                               Func\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Bridge  - TODO: add argument description\r
  Pci     - TODO: add argument description\r
  Bus     - TODO: add argument description\r
  Device  - TODO: add argument description\r
  Func    - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
PCI_IO_DEVICE             *\r
GatherPpbInfo (\r
  IN PCI_IO_DEVICE                    *Bridge,\r
  IN PCI_TYPE00                       *Pci,\r
  UINT8                               Bus,\r
  UINT8                               Device,\r
  UINT8                               Func\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Bridge  - TODO: add argument description\r
  Pci     - TODO: add argument description\r
  Bus     - TODO: add argument description\r
  Device  - TODO: add argument description\r
  Func    - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
PCI_IO_DEVICE             *\r
GatherP2CInfo (\r
  IN PCI_IO_DEVICE                    *Bridge,\r
  IN PCI_TYPE00                       *Pci,\r
  UINT8                               Bus,\r
  UINT8                               Device,\r
  UINT8                               Func\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Bridge  - TODO: add argument description\r
  Pci     - TODO: add argument description\r
  Bus     - TODO: add argument description\r
  Device  - TODO: add argument description\r
  Func    - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_DEVICE_PATH_PROTOCOL  *\r
CreatePciDevicePath (\r
  IN  EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath,\r
  IN  PCI_IO_DEVICE            *PciIoDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  ParentDevicePath  - TODO: add argument description\r
  PciIoDevice       - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
BarExisted (\r
  IN PCI_IO_DEVICE *PciIoDevice,\r
  IN UINTN         Offset,\r
  OUT UINT32       *BarLengthValue,\r
  OUT UINT32       *OriginalBarValue\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciIoDevice       - TODO: add argument description\r
  Offset            - TODO: add argument description\r
  BarLengthValue    - TODO: add argument description\r
  OriginalBarValue  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
PciTestSupportedAttribute (\r
  IN PCI_IO_DEVICE                      *PciIoDevice,\r
  IN UINT16                             *Command,\r
  IN UINT16                             *BridgeControl,\r
  IN UINT16                             *OldCommand,\r
  IN UINT16                             *OldBridgeControl\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciIoDevice       - TODO: add argument description\r
  Command           - TODO: add argument description\r
  BridgeControl     - TODO: add argument description\r
  OldCommand        - TODO: add argument description\r
  OldBridgeControl  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
PciSetDeviceAttribute (\r
  IN PCI_IO_DEVICE                      *PciIoDevice,\r
  IN UINT16                             Command,\r
  IN UINT16                             BridgeControl,\r
  IN UINTN                              Option\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciIoDevice   - TODO: add argument description\r
  Command       - TODO: add argument description\r
  BridgeControl - TODO: add argument description\r
  Option        - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
GetFastBackToBackSupport (\r
  IN PCI_IO_DEVICE                      *PciIoDevice,\r
  IN UINT8                              StatusIndex\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciIoDevice - TODO: add argument description\r
  StatusIndex - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
DetermineDeviceAttribute (\r
  IN PCI_IO_DEVICE                      *PciIoDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciIoDevice - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
UpdatePciInfo (\r
  IN PCI_IO_DEVICE  *PciIoDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciIoDevice - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
VOID\r
SetNewAlign (\r
  IN UINT64 *Alignment,\r
  IN UINT64 NewAlignment\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Alignment     - TODO: add argument description\r
  NewAlignment  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
UINTN\r
PciParseBar (\r
  IN PCI_IO_DEVICE  *PciIoDevice,\r
  IN UINTN          Offset,\r
  IN UINTN          BarIndex\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciIoDevice - TODO: add argument description\r
  Offset      - TODO: add argument description\r
  BarIndex    - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
InitializePciDevice (\r
  IN PCI_IO_DEVICE *PciIoDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciIoDevice - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
InitializePpb (\r
  IN PCI_IO_DEVICE *PciIoDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciIoDevice - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
InitializeP2C (\r
  IN PCI_IO_DEVICE *PciIoDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciIoDevice - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
PCI_IO_DEVICE             *\r
CreatePciIoDevice (\r
  IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *PciRootBridgeIo,\r
  IN PCI_TYPE00                       *Pci,\r
  UINT8                               Bus,\r
  UINT8                               Device,\r
  UINT8                               Func\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciRootBridgeIo - TODO: add argument description\r
  Pci             - TODO: add argument description\r
  Bus             - TODO: add argument description\r
  Device          - TODO: add argument description\r
  Func            - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
PciEnumeratorLight (\r
  IN EFI_HANDLE                    Controller\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Controller  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
PciGetBusRange (\r
  IN     EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR  **Descriptors,\r
  OUT    UINT16                             *MinBus,\r
  OUT    UINT16                             *MaxBus,\r
  OUT    UINT16                             *BusRange\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Descriptors - TODO: add argument description\r
  MinBus      - TODO: add argument description\r
  MaxBus      - TODO: add argument description\r
  BusRange    - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
StartManagingRootBridge (\r
  IN PCI_IO_DEVICE *RootBridgeDev\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  RootBridgeDev - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
BOOLEAN\r
IsPciDeviceRejected (\r
  IN PCI_IO_DEVICE *PciIoDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciIoDevice - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
#endif\r