MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/PciSegmentLib.h

   1 /** @file\r
   2   Include file of PciSegmentPciRootBridgeIo Library.\r
   3 \r
   4   Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
   5   This program and the accompanying materials are\r
   6   licensed and made available under the terms and conditions of\r
   7   the BSD License which accompanies this distribution.  The full\r
   8   text of the license may be found at\r
   9   http://opensource.org/licenses/bsd-license.php.\r
  10 \r
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
  13 \r
  14 **/\r
  15 \r
  16 #ifndef __DXE_PCI_SEGMENT_LIB__\r
  17 #define __DXE_PCI_SEGMENT_LIB__\r
  18 \r
  19 \r
  20 #include <Protocol/PciRootBridgeIo.h>\r
  21 \r
  22 #include <Library/PciSegmentLib.h>\r
  23 #include <Library/BaseLib.h>\r
  24 #include <Library/MemoryAllocationLib.h>\r
  25 #include <Library/UefiBootServicesTableLib.h>\r
  26 #include <Library/DebugLib.h>\r
  27 \r
  28 #include <IndustryStandard/Acpi.h>\r
  29 \r
  30 typedef struct {\r
  31   EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL    *PciRootBridgeIo;\r
  32   UINT32                             SegmentNumber;\r
  33   UINT64                             MinBusNumber;\r
  34   UINT64                             MaxBusNumber;\r
  35 } PCI_ROOT_BRIDGE_DATA;\r
  36 \r
  37 /**\r
  38   Assert the validity of a PCI Segment address.\r
  39   A valid PCI Segment address should not contain 1's in bits 28..31 and 48..63\r
  40 \r
  41   @param  A The address to validate.\r
  42   @param  M Additional bits to assert to be zero.\r
  43 \r
  44 **/\r
  45 #define ASSERT_INVALID_PCI_SEGMENT_ADDRESS(A,M) \\r
  46   ASSERT (((A) & (0xffff0000f0000000ULL | (M))) == 0)\r
  47 \r
  48 /**\r
  49   Translate PCI Lib address into format of PCI Root Bridge I/O Protocol\r
  50 \r
  51   @param  A  The address that encodes the PCI Bus, Device, Function and\r
  52              Register.\r
  53 \r
  54 **/\r
  55 #define PCI_TO_PCI_ROOT_BRIDGE_IO_ADDRESS(A) \\r
  56   ((((UINT32)(A) << 4) & 0xff000000) | (((UINT32)(A) >> 4) & 0x00000700) | (((UINT32)(A) << 1) & 0x001f0000) | (LShiftU64((A) & 0xfff, 32)))\r
  57 \r
  58 #endif\r