[PATCH edk2-platforms 30/41] Platform/NXP: LS2088A RDB Board Library

[Meenakshi Aggarwal <meenakshi.aggarwal@nxp.com>]

From: Wasim Khan <wasim.khan@nxp.com>

Library to provide board specific timings for LS2088ARDB
board with interfacing to IFC controller for accessing
NOR, NAND and FPGA.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Wasim Khan <wasim.khan@nxp.com>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>
---
 .../NXP/LS2088aRdbPkg/Include/IfcBoardSpecific.h   | 114 +++++++++++++++++++++
 .../NXP/LS2088aRdbPkg/Library/BoardLib/BoardLib.c  |  69 +++++++++++++
 .../LS2088aRdbPkg/Library/BoardLib/BoardLib.inf    |  28 +++++
 3 files changed, 211 insertions(+)
 create mode 100644 Platform/NXP/LS2088aRdbPkg/Include/IfcBoardSpecific.h
 create mode 100644 Platform/NXP/LS2088aRdbPkg/Library/BoardLib/BoardLib.c
 create mode 100644 Platform/NXP/LS2088aRdbPkg/Library/BoardLib/BoardLib.inf

diff --git a/Platform/NXP/LS2088aRdbPkg/Include/IfcBoardSpecific.h b/Platform/NXP/LS2088aRdbPkg/Include/IfcBoardSpecific.h
new file mode 100644
index 0000000..174a242
--- /dev/null
+++ b/Platform/NXP/LS2088aRdbPkg/Include/IfcBoardSpecific.h
@@ -0,0 +1,114 @@
+/** IfcBoardSpecificLib.h
+
+  IFC Flash Board Specific Macros and structure
+
+  Copyright 2017-2018 NXP
+
+  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 __IFC__BOARD_SPECIFIC_H__
+#define __IFC__BOARD_SPECIFIC_H__
+
+#include <Ifc.h>
+
+// On board flash support
+#define IFC_NAND_BUF_BASE    0x530000000ULL
+
+// On board Inegrated flash Controller chip select configuration
+#define IFC_NOR_CS    IFC_CS0
+#define IFC_NAND_CS   IFC_CS2
+#define IFC_FPGA_CS   IFC_CS3
+
+
+/* board-specific NAND timing */
+#define NAND_FTIM0     (IFC_FTIM0_NAND_TCCST(0x0e) | \
+                       IFC_FTIM0_NAND_TWP(0x30)   | \
+                       IFC_FTIM0_NAND_TWCHT(0x0e) | \
+                       IFC_FTIM0_NAND_TWH(0x14))
+
+#define NAND_FTIM1     (IFC_FTIM1_NAND_TADLE(0x64) | \
+                       IFC_FTIM1_NAND_TWBE(0xab)  | \
+                       IFC_FTIM1_NAND_TRR(0x1c)   | \
+                       IFC_FTIM1_NAND_TRP(0x30))
+
+#define NAND_FTIM2     (IFC_FTIM2_NAND_TRAD(0x1e) | \
+                       IFC_FTIM2_NAND_TREH(0x14) | \
+                       IFC_FTIM2_NAND_TWHRE(0x3c))
+
+#define NAND_FTIM3     0x0
+
+#define IFC_NAND_BASE_PHYS    0x30000000
+#define NAND_CSPR      (IFC_CSPR_PHYS_ADDR(IFC_NAND_BASE_PHYS) \
+                       | IFC_CSPR_PORT_SIZE_8 \
+                       | IFC_CSPR_MSEL_NAND \
+                       | IFC_CSPR_V)
+
+#define NAND_CSPR_EXT  0x0
+#define NAND_AMASK     0xFFFF0000
+
+#define NAND_CSOR      (IFC_CSOR_NAND_ECC_ENC_EN /* ECC on encode */ \
+                       | IFC_CSOR_NAND_ECC_DEC_EN /* ECC on decode */ \
+                       | IFC_CSOR_NAND_ECC_MODE_4 /* 4-bit ECC */ \
+                       | IFC_CSOR_NAND_RAL_3       /* RAL = 3 Bytes */ \
+                       | IFC_CSOR_NAND_PGS_4K      /* Page Size = 4K */ \
+                       | IFC_CSOR_NAND_SPRZ_224     /* Spare size = 224 */ \
+                       | IFC_CSOR_NAND_PB(7))     /* 2^7 Pages Per Block */
+
+// board-specific NOR timing
+#define NOR_FTIM0      (IFC_FTIM0_NOR_TACSE(0x4) | \
+                       IFC_FTIM0_NOR_TEADC(0x5) | \
+                       IFC_FTIM0_NOR_TEAHC(0x5))
+
+#define NOR_FTIM1      (IFC_FTIM1_NOR_TACO(0x35) | \
+                       IFC_FTIM1_NOR_TRAD_NOR(0x1a) | \
+                       IFC_FTIM1_NOR_TSEQRAD_NOR(0x13))
+
+#define NOR_FTIM2      (IFC_FTIM2_NOR_TCS(0x4) | \
+                       IFC_FTIM2_NOR_TCH(0x4) | \
+                       IFC_FTIM2_NOR_TWPH(0xe) | \
+                       IFC_FTIM2_NOR_TWP(0x1c))
+
+#define NOR_FTIM3      0x04000000
+
+#define IFC_FLASH_BASE_PHYS   0x80000000
+#define NOR_CSPR       (IFC_CSPR_PHYS_ADDR(IFC_FLASH_BASE_PHYS) \
+                       | IFC_CSPR_PORT_SIZE_16 \
+                       | IFC_CSPR_MSEL_NOR        \
+                       | IFC_CSPR_V)
+
+#define NOR_CSPR_EXT   0x0
+#define NOR_AMASK      IFC_AMASK(128*1024*1024)
+#define NOR_CSOR       IFC_CSOR_NOR_ADM_SHIFT(12)
+
+// board-specific fpga timing
+#define FPGA_BASE_PHYS 0x20000000
+#define FPGA_CSPR_EXT  0x0
+#define FPGA_CSPR      (IFC_CSPR_PHYS_ADDR(FPGA_BASE_PHYS) | \
+                       IFC_CSPR_PORT_SIZE_8 | \
+                       IFC_CSPR_MSEL_GPCM | \
+                       IFC_CSPR_V)
+
+#define FPGA_AMASK     IFC_AMASK(64 * 1024)
+#define FPGA_CSOR      IFC_CSOR_NOR_ADM_SHIFT(12)
+
+#define FPGA_FTIM0     (IFC_FTIM0_GPCM_TACSE(0xe) | \
+                       IFC_FTIM0_GPCM_TEADC(0xe) | \
+                       IFC_FTIM0_GPCM_TEAHC(0xe))
+
+#define FPGA_FTIM1     (IFC_FTIM1_GPCM_TACO(0xff) | \
+                       IFC_FTIM1_GPCM_TRAD(0x3f))
+
+#define FPGA_FTIM2     (IFC_FTIM2_GPCM_TCS(0xf) | \
+                       IFC_FTIM2_GPCM_TCH(0xf) | \
+                       IFC_FTIM2_GPCM_TWP(0x3e))
+
+#define FPGA_FTIM3 0x0
+
+#endif //__IFC__BOARD_SPECIFIC_H__
diff --git a/Platform/NXP/LS2088aRdbPkg/Library/BoardLib/BoardLib.c b/Platform/NXP/LS2088aRdbPkg/Library/BoardLib/BoardLib.c
new file mode 100644
index 0000000..936b789
--- /dev/null
+++ b/Platform/NXP/LS2088aRdbPkg/Library/BoardLib/BoardLib.c
@@ -0,0 +1,69 @@
+/** @file
+
+  Copyright 2017-2018 NXP
+
+  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 <IfcBoardSpecific.h>
+
+VOID
+GetIfcNorFlashTimings (
+  IN IFC_TIMINGS * NorIfcTimings
+  )
+{
+  NorIfcTimings->Ftim[0] = NOR_FTIM0;
+  NorIfcTimings->Ftim[1] = NOR_FTIM1;
+  NorIfcTimings->Ftim[2] = NOR_FTIM2;
+  NorIfcTimings->Ftim[3] = NOR_FTIM3;
+  NorIfcTimings->Cspr = NOR_CSPR;
+  NorIfcTimings->CsprExt = NOR_CSPR_EXT;
+  NorIfcTimings->Amask = NOR_AMASK;
+  NorIfcTimings->Csor = NOR_CSOR;
+  NorIfcTimings->CS = IFC_NOR_CS;
+
+  return ;
+}
+
+VOID
+GetIfcFpgaTimings (
+  IN IFC_TIMINGS  *FpgaIfcTimings
+  )
+{
+  FpgaIfcTimings->Ftim[0] = FPGA_FTIM0;
+  FpgaIfcTimings->Ftim[1] = FPGA_FTIM1;
+  FpgaIfcTimings->Ftim[2] = FPGA_FTIM2;
+  FpgaIfcTimings->Ftim[3] = FPGA_FTIM3;
+  FpgaIfcTimings->Cspr = FPGA_CSPR;
+  FpgaIfcTimings->CsprExt = FPGA_CSPR_EXT;
+  FpgaIfcTimings->Amask = FPGA_AMASK;
+  FpgaIfcTimings->Csor = FPGA_CSOR;
+  FpgaIfcTimings->CS = IFC_FPGA_CS;
+
+  return;
+}
+
+VOID
+GetIfcNandFlashTimings (
+  IN IFC_TIMINGS * NandIfcTimings
+  )
+{
+  NandIfcTimings->Ftim[0] = NAND_FTIM0;
+  NandIfcTimings->Ftim[1] = NAND_FTIM1;
+  NandIfcTimings->Ftim[2] = NAND_FTIM2;
+  NandIfcTimings->Ftim[3] = NAND_FTIM3;
+  NandIfcTimings->Cspr = NAND_CSPR;
+  NandIfcTimings->CsprExt = NAND_CSPR_EXT;
+  NandIfcTimings->Amask = NAND_AMASK;
+  NandIfcTimings->Csor = NAND_CSOR;
+  NandIfcTimings->CS = IFC_NAND_CS;
+
+  return;
+}
diff --git a/Platform/NXP/LS2088aRdbPkg/Library/BoardLib/BoardLib.inf b/Platform/NXP/LS2088aRdbPkg/Library/BoardLib/BoardLib.inf
new file mode 100644
index 0000000..5df84b1
--- /dev/null
+++ b/Platform/NXP/LS2088aRdbPkg/Library/BoardLib/BoardLib.inf
@@ -0,0 +1,28 @@
+#  @file
+#
+#  Copyright 2017-2018 NXP
+#
+#  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                    = 0x0001001A
+  BASE_NAME                      = BoardLib
+  FILE_GUID                      = 13eacf2a-4338-48f4-88de-6ce4618e1a53
+  MODULE_TYPE                    = BASE
+  VERSION_STRING                 = 1.0
+  LIBRARY_CLASS                  = BoardLib
+
+[Sources.common]
+  BoardLib.c
+
+[Packages]
+  MdePkg/MdePkg.dec
+  Platform/NXP/LS2088aRdbPkg/LS2088aRdbPkg.dec
+  Silicon/NXP/NxpQoriqLs.dec
-- 
1.9.1