MdePkg/PciSegmentInfoLib: Add PciSegmentInfoLib class and instance.

The patch adds PciSegmentInfoLib library class which is used
by PciSegmentLib (commit in next patch) to support multiple
segment PCI configuration access.

BasePciSegmentInfoLibNull instance is added but it shouldn't be
used by any real platform.
Any single segment platform that wants to use PciSegmentLib could
use BasePciSegmentLibPci instance.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

6 files changed, 144 insertions, 0 deletions

diff --git a/MdePkg/Include/Library/PciSegmentInfoLib.h b/MdePkg/Include/Library/PciSegmentInfoLib.h
new file mode 100644
index 0000000000..588269a9ae
--- /dev/null
+++ b/MdePkg/Include/Library/PciSegmentInfoLib.h
@@ -0,0 +1,41 @@
+/** @file

+  Provides services to return segment information on a platform with multiple PCI segments.

+

+  This library is consumed by PciSegmentLib to support multiple segment PCI configuration access.

+

+  Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>

+  This program and the accompanying materials

+  are licensed and made available under the terms and conditions of the BSD License

+  which accompanies this distribution.  The full text of the license may be found at

+  http://opensource.org/licenses/bsd-license.php

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+**/

+

+#ifndef __PCI_SEGMENT_INFO_LIB__

+#define __PCI_SEGMENT_INFO_LIB__

+

+typedef struct {

+  UINT16               SegmentNumber;   ///< Segment number.

+  UINT64               BaseAddress;     ///< ECAM Base address.

+  UINT8                StartBusNumber;  ///< Start BUS number, for verifying the PCI Segment address.

+  UINT8                EndBusNumber;    ///< End BUS number, for verifying the PCI Segment address.

+} PCI_SEGMENT_INFO;

+

+/**

+  Return an array of PCI_SEGMENT_INFO holding the segment information.

+

+  Note: The returned array/buffer is owned by callee.

+

+  @param  Count  Return the count of segments.

+

+  @retval A callee owned array holding the segment information.

+**/

+PCI_SEGMENT_INFO *

+GetPciSegmentInfo (

+  UINTN  *Count

+  );

+

+#endif

diff --git a/MdePkg/Library/BasePciSegmentInfoLibNull/BasePciSegmentInfoLibNull.inf b/MdePkg/Library/BasePciSegmentInfoLibNull/BasePciSegmentInfoLibNull.inf
new file mode 100644
index 0000000000..5ae59fb2be
--- /dev/null
+++ b/MdePkg/Library/BasePciSegmentInfoLibNull/BasePciSegmentInfoLibNull.inf
@@ -0,0 +1,41 @@
+## @file

+# Instance of PCI SegmentInfo Library.

+#

+# Default PCI Segment Information Library that shouldn't be used by real platform.

+#

+# Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>

+#

+#  This program and the accompanying materials

+#  are licensed and made available under the terms and conditions of the BSD License

+#  which accompanies this distribution. The full text of the license may be found at

+#  http://opensource.org/licenses/bsd-license.php.

+#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+#

+#

+##

+

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = BasePciSegmentInfoLibNull

+  MODULE_UNI_FILE                = BasePciSegmentInfoLibNull.uni

+  FILE_GUID                      = 36B28584-C6AE-4B1B-A473-A51618EE525A

+  MODULE_TYPE                    = BASE

+  VERSION_STRING                 = 1.0

+  LIBRARY_CLASS                  = PciSegmentInfoLib

+

+#

+# The following information is for reference only and not required by the build tools.

+#

+#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC

+#

+

+[Sources]

+  PciSegmentInfoLib.c

+

+[Packages]

+  MdePkg/MdePkg.dec

+

+[LibraryClasses]

+  PcdLib

+  DebugLib

diff --git a/MdePkg/Library/BasePciSegmentInfoLibNull/BasePciSegmentInfoLibNull.uni b/MdePkg/Library/BasePciSegmentInfoLibNull/BasePciSegmentInfoLibNull.uni
new file mode 100644
index 0000000000..a956787637
--- /dev/null
+++ b/MdePkg/Library/BasePciSegmentInfoLibNull/BasePciSegmentInfoLibNull.uni
@@ -0,0 +1,20 @@
+// /** @file

+// Instance of PCI SegmentInfo Library.

+//

+// Default PCI Segment Information Library that shouldn't be used by real platform.

+//

+// Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>

+//

+// This program and the accompanying materials

+// are licensed and made available under the terms and conditions of the BSD License

+// which accompanies this distribution. The full text of the license may be found at

+// http://opensource.org/licenses/bsd-license.php.

+// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+//

+// **/

+

+

+#string STR_MODULE_ABSTRACT             #language en-US "Default instance of PCI SegmentInfo Library."

+

+#string STR_MODULE_DESCRIPTION          #language en-US "Default PCI Segment Information Library that shouldn't be used by real platform."

diff --git a/MdePkg/Library/BasePciSegmentInfoLibNull/PciSegmentInfoLib.c b/MdePkg/Library/BasePciSegmentInfoLibNull/PciSegmentInfoLib.c
new file mode 100644
index 0000000000..011a41450c
--- /dev/null
+++ b/MdePkg/Library/BasePciSegmentInfoLibNull/PciSegmentInfoLib.c
@@ -0,0 +1,38 @@
+/** @file

+  Default PCI Segment Information Library that returns one segment whose

+  segment base address equals to PcdPciExpressBaseAddress.

+

+  Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>

+  This program and the accompanying materials are

+  licensed and made available under the terms and conditions of

+  the BSD License which accompanies this distribution.  The full

+  text of the license may be found at

+  http://opensource.org/licenses/bsd-license.php.

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+**/

+

+#include <Base.h>

+#include <Library/PciSegmentInfoLib.h>

+#include <Library/DebugLib.h>

+

+/**

+  Return an array of PCI_SEGMENT_INFO holding the segment information.

+

+  Note: The returned array/buffer is owned by callee.

+

+  @param  Count  Return the count of segments.

+

+  @retval A callee owned array holding the segment information.

+**/

+PCI_SEGMENT_INFO *

+GetPciSegmentInfo (

+  UINTN  *Count

+  )

+{

+  ASSERT (FALSE);

+  *Count = 0;

+  return NULL;

+}

diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index 425004f9d8..ad13185ed6 100644
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -131,6 +131,9 @@
   ##  @libraryclass  Provides a service to retrieve the PE/COFF entry point from a PE/COFF image.

   PeCoffGetEntryPointLib|Include/Library/PeCoffGetEntryPointLib.h

 

+  ##  @libraryclass  Provides services to return the PCI segment information.

+  PciSegmentInfoLib|Include/Library/PciSegmentInfoLib.h

+

   ##  @libraryclass  Provides services to access PCI Configuration Space on a platform with multiple PCI segments.

   PciSegmentLib|Include/Library/PciSegmentLib.h

 

diff --git a/MdePkg/MdePkg.dsc b/MdePkg/MdePkg.dsc
index 010ce533d7..e553a702a3 100644
--- a/MdePkg/MdePkg.dsc
+++ b/MdePkg/MdePkg.dsc
@@ -69,6 +69,7 @@
   MdePkg/Library/BasePciLibCf8/BasePciLibCf8.inf

   MdePkg/Library/BasePciLibPciExpress/BasePciLibPciExpress.inf

   MdePkg/Library/BasePciSegmentLibPci/BasePciSegmentLibPci.inf

+  MdePkg/Library/BasePciSegmentInfoLibNull/BasePciSegmentInfoLibNull.inf

   MdePkg/Library/BasePeCoffGetEntryPointLib/BasePeCoffGetEntryPointLib.inf

   MdePkg/Library/BasePeCoffLib/BasePeCoffLib.inf

   MdePkg/Library/BasePeCoffExtraActionLibNull/BasePeCoffExtraActionLibNull.inf