Update the copyright notice format

[mirror_edk2.git] / DuetPkg / PciBusNoEnumerationDxe / PciDeviceSupport.h

/*++\r
\r
Copyright (c) 2005 - 2006, Intel Corporation. All rights reserved.<BR>\r
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
  PciDeviceSupport.h\r
  \r
Abstract:\r
\r
  \r
\r
Revision History\r
\r
--*/\r
\r
#ifndef _EFI_PCI_DEVICE_SUPPORT_H\r
#define _EFI_PCI_DEVICE_SUPPORT_H\r
\r
EFI_STATUS\r
InitializePciDevicePool (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
InsertPciDevice (\r
  PCI_IO_DEVICE *Bridge,\r
  PCI_IO_DEVICE *PciDeviceNode\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Bridge        - TODO: add argument description\r
  PciDeviceNode - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
DestroyPciDeviceTree (\r
  IN PCI_IO_DEVICE *Bridge\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Bridge  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
DestroyRootBridgeByHandle (\r
  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
RegisterPciDevice (\r
  IN  EFI_HANDLE                     Controller,\r
  IN  PCI_IO_DEVICE                  *PciIoDevice,\r
  OUT EFI_HANDLE                     *Handle OPTIONAL\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function registers the PCI IO device. It creates a handle for this PCI IO device \r
  (if the handle does not exist), attaches appropriate protocols onto the handle, does\r
  necessary initialization, and sets up parent/child relationship with its bus controller.\r
\r
Arguments:\r
\r
  Controller    - An EFI handle for the PCI bus controller.\r
  PciIoDevice   - A PCI_IO_DEVICE pointer to the PCI IO device to be registered.\r
  Handle        - A pointer to hold the EFI handle for the PCI IO device.\r
\r
Returns:\r
\r
  EFI_SUCCESS   - The PCI device is successfully registered.\r
  Others        - An error occurred when registering the PCI device.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
DeRegisterPciDevice (\r
  IN  EFI_HANDLE                     Controller,\r
  IN  EFI_HANDLE                     Handle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Controller  - TODO: add argument description\r
  Handle      - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
StartPciDevices (\r
  IN EFI_HANDLE                         Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL           *RemainingDevicePath\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Controller          - TODO: add argument description\r
  RemainingDevicePath - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
PCI_IO_DEVICE *\r
CreateRootBridge (\r
  IN EFI_HANDLE RootBridgeHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  RootBridgeHandle  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
PCI_IO_DEVICE *\r
GetRootBridgeByHandle (\r
  EFI_HANDLE RootBridgeHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  RootBridgeHandle  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS \r
InsertRootBridge (\r
  PCI_IO_DEVICE *RootBridge\r
);\r
\r
EFI_STATUS \r
DestroyRootBridge ( \r
   IN PCI_IO_DEVICE *RootBridge \r
);\r
\r
BOOLEAN\r
RootBridgeExisted (\r
  IN EFI_HANDLE RootBridgeHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  RootBridgeHandle  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
BOOLEAN\r
PciDeviceExisted (\r
  IN PCI_IO_DEVICE    *Bridge,\r
  IN PCI_IO_DEVICE    *PciIoDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Bridge      - TODO: add argument description\r
  PciIoDevice - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
PCI_IO_DEVICE *\r
ActiveVGADeviceOnTheSameSegment (\r
  IN PCI_IO_DEVICE        *VgaDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  VgaDevice - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
PCI_IO_DEVICE *\r
ActiveVGADeviceOnTheRootBridge (\r
  IN PCI_IO_DEVICE        *RootBridge\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  RootBridge  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
#endif\r