[edk2-non-osi][PATCH v2 0/2] Introduce Silicon/Ampere and AmpereAltraBinPkg package

[edk2-non-osi][PATCH v2 0/2] Introduce Silicon/Ampere and AmpereAltraBinPkg package

[Vu Nguyen]

This patchset creates edk2-non-osi component holder for Ampere Silicon.
Included is PciePhyLib library that provides necessary functions to
initialize PCIe PHY on ARM64-based Ampere Altra processor. This library
will be used by all Ampere Altra platforms later.

The changes for this patchset can be found at:
https://github.com/AmpereComputing/edk2-non-osi/tree/add-PciePhyLib-v2

Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Ard Biesheuvel <ard.biesheuvel@arm.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Signed-off-by: Vu Nguyen <vunguyen@os.amperecomputing.com>

Version History:
V2:
  Remove PciePhyLib.lib binary from the commit
  Update header guard to align with coding standard

Vu Nguyen (2):
  AmpereAltraBinPkg: Add PciePhyLib library and header
  edk2-non-osi: Add AmpereAltraBinPkg maintainers

 Maintainers.txt                               |   4 +
 Silicon/Ampere/License.txt                    |  25 +++
 .../Ampere/AmpereAltraBinPkg/Ac01BinPkg.dec   |  16 ++
 .../Library/PciePhyLib/PciePhyLib.inf         |  23 +++
 .../Include/Library/PciePhyLib.h              | 165 ++++++++++++++++++
 .../Library/PciePhyLib/PciePhyLib.lib         | Bin 0 -> 26026 bytes
 6 files changed, 233 insertions(+)
 create mode 100644 Silicon/Ampere/License.txt
 create mode 100644 Silicon/Ampere/AmpereAltraBinPkg/Ac01BinPkg.dec
 create mode 100644 Silicon/Ampere/AmpereAltraBinPkg/Library/PciePhyLib/PciePhyLib.inf
 create mode 100644 Silicon/Ampere/AmpereAltraBinPkg/Include/Library/PciePhyLib.h
 create mode 100644 Silicon/Ampere/AmpereAltraBinPkg/Library/PciePhyLib/PciePhyLib.lib

-- 
2.17.1

[edk2-non-osi][PATCH v2 1/2] AmpereAltraBinPkg: Add PciePhyLib library and header

[Vu Nguyen]

Initialization library for PCIe PHY on Ampere Altra.

Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Ard Biesheuvel <ard.biesheuvel@arm.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Signed-off-by: Vu Nguyen <vunguyen@os.amperecomputing.com>
---
 Silicon/Ampere/License.txt                    |  25 +++
 .../Ampere/AmpereAltraBinPkg/Ac01BinPkg.dec   |  16 ++
 .../Library/PciePhyLib/PciePhyLib.inf         |  23 +++
 .../Include/Library/PciePhyLib.h              | 165 ++++++++++++++++++
 .../Library/PciePhyLib/PciePhyLib.lib         | Bin 0 -> 26026 bytes
 5 files changed, 229 insertions(+)
 create mode 100644 Silicon/Ampere/License.txt
 create mode 100644 Silicon/Ampere/AmpereAltraBinPkg/Ac01BinPkg.dec
 create mode 100644 Silicon/Ampere/AmpereAltraBinPkg/Library/PciePhyLib/PciePhyLib.inf
 create mode 100644 Silicon/Ampere/AmpereAltraBinPkg/Include/Library/PciePhyLib.h
 create mode 100644 Silicon/Ampere/AmpereAltraBinPkg/Library/PciePhyLib/PciePhyLib.lib

diff --git a/Silicon/Ampere/License.txt b/Silicon/Ampere/License.txt
new file mode 100644
index 000000000000..2fd43292fa64
--- /dev/null
+++ b/Silicon/Ampere/License.txt
@@ -0,0 +1,25 @@
+Copyright (c) 2020, Ampere Computing LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in
+   the documentation and/or other materials provided with the
+   distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
diff --git a/Silicon/Ampere/AmpereAltraBinPkg/Ac01BinPkg.dec b/Silicon/Ampere/AmpereAltraBinPkg/Ac01BinPkg.dec
new file mode 100644
index 000000000000..2a8ec5e693ec
--- /dev/null
+++ b/Silicon/Ampere/AmpereAltraBinPkg/Ac01BinPkg.dec
@@ -0,0 +1,16 @@
+## @file
+#
+# Copyright (c) 2020, Ampere Computing LLC. All rights reserved.<BR>
+#
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+#
+##
+
+[Defines]
+  DEC_SPECIFICATION              = 0x0001001B
+  PACKAGE_NAME                   = Ac01BinPkg
+  PACKAGE_GUID                   = 04F7CB64-0F97-4D05-86B8-34987F4E1B21
+  PACKAGE_VERSION                = 0.1
+
+[Includes]
+  Include
diff --git a/Silicon/Ampere/AmpereAltraBinPkg/Library/PciePhyLib/PciePhyLib.inf b/Silicon/Ampere/AmpereAltraBinPkg/Library/PciePhyLib/PciePhyLib.inf
new file mode 100644
index 000000000000..84b1b58ed58c
--- /dev/null
+++ b/Silicon/Ampere/AmpereAltraBinPkg/Library/PciePhyLib/PciePhyLib.inf
@@ -0,0 +1,23 @@
+## @file
+#
+# Copyright (c) 2020, Ampere Computing LLC. All rights reserved.<BR>
+#
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+#
+##
+
+[Defines]
+  INF_VERSION                    = 0x0001001B
+  BASE_NAME                      = PciePhyLib
+  FILE_GUID                      = F2AD0AD0-D4B6-11E3-9C1A-0800200C9A66
+  MODULE_TYPE                    = BASE
+  VERSION_STRING                 = 1.0
+  LIBRARY_CLASS                  = PciePhyLib
+
+[Binaries.AArch64]
+  LIB|PciePhyLib.lib|*
+
+[Packages]
+  MdePkg/MdePkg.dec
+  ArmPkg/ArmPkg.dec
+  ArmPlatformPkg/ArmPlatformPkg.dec
diff --git a/Silicon/Ampere/AmpereAltraBinPkg/Include/Library/PciePhyLib.h b/Silicon/Ampere/AmpereAltraBinPkg/Include/Library/PciePhyLib.h
new file mode 100644
index 000000000000..2f0817ea0da1
--- /dev/null
+++ b/Silicon/Ampere/AmpereAltraBinPkg/Include/Library/PciePhyLib.h
@@ -0,0 +1,165 @@
+/** @file
+
+  Copyright (c) 2020, Ampere Computing LLC. All rights reserved.<BR>
+
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#ifndef PCIE_PHY_LIB_H_
+#define PCIE_PHY_LIB_H_
+
+#define PHY_TX_PARAM_SIZE           2
+#define PHY_RX_PARAM_SIZE           2
+
+#define BUG_67112                   1
+#define UPDATE_SRAM                 0
+
+#define MULTWRITE_ENABLE            0
+#define MULTI_WR_EN                 0
+#define PHY_N_ADDR_OFFSET           0x40000
+#define SNPS_PHY0_BASE_ADDR         0x100000
+#define SNPS_PHY1_BASE_ADDR         (SNPS_PHY0_BASE_ADDR + PHY_N_ADDR_OFFSET)
+#define SNPS_PHY2_BASE_ADDR         (SNPS_PHY1_BASE_ADDR + PHY_N_ADDR_OFFSET)
+#define SNPS_PHY3_BASE_ADDR         (SNPS_PHY2_BASE_ADDR + PHY_N_ADDR_OFFSET)
+
+#define BROADCAST_PMA(Src)          ((Src | (0x5 << 12)) * 4)
+#define BROADCAST_RAW_PCS(Src)      ((Src | (0x6 << 12)) * 4)
+#define BROADCAST_RAW_PCS_AON(Src)  ((Src | (0x7 << 12)) * 4)
+
+#define PHY_CALIB_TO_VALUE          1000
+#define SRAM_INIT_TO_VALUE          1000
+#define MRDY_DELAY                  10
+
+#define SRAM_BYPASS_0               0
+#define SRAM_BYPASS_1               1
+#define SRAM_BYPASS_2               2
+#define SRAM_BYPASS_3               3
+
+#define SRAM_BOOTLOAD_BYPASS_0      0x1
+#define SRAM_BOOTLOAD_BYPASS_1      0x2
+#define SRAM_BOOTLOAD_BYPASS_2      0x4
+#define SRAM_BOOTLOAD_BYPASS_3      0x8
+
+#define SRIS_MODE_EN                0
+#define CLK_REF_SEL                 0
+#define CLK_SSC_SEL                 1
+
+#define CRP_SEL                     1
+#define MAX_PHY                     3
+
+#define LANE_PER_PHY_NUM_MAX        4
+
+#define HOST_SECURE_ACCESS(Addr)    (UINT64)(Addr | 0x40000000000000)
+#define STARTING_SRAM_ADDRESS       0x130000
+
+/*
+ * PCIe PHY error code
+ */
+typedef enum {
+  PHY_SRAM_UPDATE_FAIL = -1,
+  PHY_INIT_PASS = 0,
+  PHY_ROM_ECC_FAIL,
+  PHY_SRAM_ECC_FAIL,
+  PHY_CALIB_FAIL,
+  PHY_CALIB_TIMEOUT,
+  PHY_PLL_FAIL
+} PHY_STATUS;
+
+typedef enum {
+  PHY_DBG_ERROR = 0x0001,
+  PHY_DBG_INFO = 0x0002,
+  PHY_DBG_WARN = 0x0004,
+  PHY_DBG_VERBOSE = 0x0008,
+  GEN1 = 0,
+  GEN2 = 1,
+  GEN3 = 2,
+  GEN4 = 3,
+  CCIX = 4
+} PHY_DBG_FLAGS;
+
+typedef struct {
+  UINT8  IsCalBySram;
+  UINT32 PllSettings;
+  UINT64 TuneTxParam[PHY_RX_PARAM_SIZE];
+  UINT64 TuneRxParam[PHY_TX_PARAM_SIZE];
+} PHY_SETTING;
+
+/**
+ * struct serdes_plat_resource - Serdes Platform Operations
+ * @Puts: Prints string to serial console
+ * @PutInt: Prints 32-bit unsigned integer to serial console
+ * @PutHex: Prints 32-bit unsigned hex to serial console
+ * @PutHex64: Prints 64-bit unsigned hex to serial console
+ * @DebugPrint: Prints formated string to serial console
+ * @MmioRd: Reads 32-bit unsigned integer
+ * @MmioWr: Writes 32-bit unsigned integer
+ */
+typedef struct {
+  VOID  (*Puts)(CONST CHAR8 *Msg);
+  VOID  (*PutInt)(UINT32 Val);
+  VOID  (*PutHex)(UINT32 Val);
+  VOID  (*PutHex64)(UINT64 Val);
+  INT32 (*DebugPrint)(CONST CHAR8 *Fmt, ...);
+  VOID  (*MmioRd)(UINT64 Addr, UINT32 *Val);
+  VOID  (*MmioWr)(UINT64 Addr, UINT32 Val);
+  VOID  (*UsDelay)(UINT32 Val);
+} PHY_PLAT_RESOURCE;
+
+typedef struct {
+  UINT64            SdsAddr;          /* PHY base address */
+  UINT64            PcieCtrlInfo;     /* PCIe controller related information
+                                       * BIT0-1: SoC revision
+                                       *      0: Ampere Altra, 1: Ampere Altra Max, 2: Siryn
+                                       * BIT2  : SocketID (0: Socket0, 1: Socket1)
+                                       * BIT3  : Reserved
+                                       * BIT4-6: Root Complex context (RCA0/1/2/3 or RCB0/4/5/6)
+                                       * BIT7  : Reserved
+                                       * BIT8-9: PHY Numbers within RCA/RCB [0 to 3 each controls 4 lane]
+                                       *      0: x16, 1: x8 , 2:x4, 3: 0x2
+                                       * BIT10-11 : Gen
+                                       *      0: Gen1, 1: Gen2, 2: Gen3, 3: Gen4 + ESM
+                                       * BIT13-15 : Setting configuration selection
+                                       */
+  PHY_SETTING       PhySetting;       /* PHY input setting */
+  PHY_PLAT_RESOURCE *PhyPlatResource; /* Debug & misc function pointers */
+  PHY_DBG_FLAGS     Debug;
+} PHY_CONTEXT;
+
+/*
+ * Input:
+ *  Ctx    - Serdes context pointer
+ *
+ * Return:
+ *  PHY_STATUS - Return status
+ */
+PHY_STATUS
+SerdesSramUpdate (
+  PHY_CONTEXT *Ctx
+  );
+
+/*
+ * Input:
+ *  Ctx    - Serdes context pointer
+ *
+ * Return:
+ *  PHY_STATUS - Return status
+ */
+PHY_STATUS
+SerdesInitClkrst (
+  PHY_CONTEXT *Ctx
+  );
+
+/*
+ * Input:
+ *  Ctx    - Serdes context pointer
+ *
+ * Return:
+ *  PHY_STATUS - Return status
+ */
+PHY_STATUS
+SerdesInitCalib (
+  PHY_CONTEXT *Ctx
+  );
+
+#endif
diff --git a/Silicon/Ampere/AmpereAltraBinPkg/Library/PciePhyLib/PciePhyLib.lib b/Silicon/Ampere/AmpereAltraBinPkg/Library/PciePhyLib/PciePhyLib.lib
new file mode 100644
index 000000000000..88aaf2cd4adc
Binary files /dev/null and b/Silicon/Ampere/AmpereAltraBinPkg/Library/PciePhyLib/PciePhyLib.lib differ
-- 
2.17.1

[edk2-non-osi][PATCH v2 2/2] edk2-non-osi: Add AmpereAltraBinPkg maintainers

[Vu Nguyen]

Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Ard Biesheuvel <ard.biesheuvel@arm.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Signed-off-by: Vu Nguyen <vunguyen@os.amperecomputing.com>
---
 Maintainers.txt | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Maintainers.txt b/Maintainers.txt
index 7355c66d8ac1..e62b971caede 100644
--- a/Maintainers.txt
+++ b/Maintainers.txt
@@ -68,3 +68,7 @@ M: Kelly Steele <kelly.steele@intel.com>
 Silicon/Intel/Vlv2SocBinPkg
 M: Zailiang Sun <zailiang.sun@intel.com>
 M: Yi Qian <yi.qian@intel.com>
+
+Silicon/Ampere/AmpereAltraBinPkg
+M: Nhi Pham <nhi@os.amperecomputing.com>
+M: Vu Nguyen <vunguyen@os.amperecomputing.com>
-- 
2.17.1

Re: [edk2-non-osi][PATCH v2 0/2] Introduce Silicon/Ampere and AmpereAltraBinPkg package

[Leif Lindholm]

Hi Vu,

For the series:
Reviewed-by: Leif Lindholm <leif@nuviainc.com>

However, I'm not sure it makes sense to push this until there is some
platform in edk2-platforms that makes use of it. So I'm holding off on
that for now.

Best Regards,

Leif

On Thu, Dec 03, 2020 at 11:29:22 +0700, Vu Nguyen wrote:
> This patchset creates edk2-non-osi component holder for Ampere Silicon.
> Included is PciePhyLib library that provides necessary functions to
> initialize PCIe PHY on ARM64-based Ampere Altra processor. This library
> will be used by all Ampere Altra platforms later.
> 
> The changes for this patchset can be found at:
> https://github.com/AmpereComputing/edk2-non-osi/tree/add-PciePhyLib-v2
> 
> Cc: Leif Lindholm <leif@nuviainc.com>
> Cc: Ard Biesheuvel <ard.biesheuvel@arm.com>
> Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
> Signed-off-by: Vu Nguyen <vunguyen@os.amperecomputing.com>
> 
> Version History:
> V2:
>   Remove PciePhyLib.lib binary from the commit
>   Update header guard to align with coding standard
> 
> Vu Nguyen (2):
>   AmpereAltraBinPkg: Add PciePhyLib library and header
>   edk2-non-osi: Add AmpereAltraBinPkg maintainers
> 
>  Maintainers.txt                               |   4 +
>  Silicon/Ampere/License.txt                    |  25 +++
>  .../Ampere/AmpereAltraBinPkg/Ac01BinPkg.dec   |  16 ++
>  .../Library/PciePhyLib/PciePhyLib.inf         |  23 +++
>  .../Include/Library/PciePhyLib.h              | 165 ++++++++++++++++++
>  .../Library/PciePhyLib/PciePhyLib.lib         | Bin 0 -> 26026 bytes
>  6 files changed, 233 insertions(+)
>  create mode 100644 Silicon/Ampere/License.txt
>  create mode 100644 Silicon/Ampere/AmpereAltraBinPkg/Ac01BinPkg.dec
>  create mode 100644 Silicon/Ampere/AmpereAltraBinPkg/Library/PciePhyLib/PciePhyLib.inf
>  create mode 100644 Silicon/Ampere/AmpereAltraBinPkg/Include/Library/PciePhyLib.h
>  create mode 100644 Silicon/Ampere/AmpereAltraBinPkg/Library/PciePhyLib/PciePhyLib.lib
> 
> -- 
> 2.17.1
>