Add the SDRAM parameter header file.

Change-Id: I9d48b5c9222a50695df00694a97f8c52729657e7

BUG=None.
TEST=None.

Review URL: http://codereview.chromium.org/6602078
Patch from Peer Chen <pchen@nvidia.com>.

2 files changed, 364 insertions, 5 deletions

diff --git a/nvboot_bct.h b/nvboot_bct.h
index 75ffb42..94f9625 100644
--- a/nvboot_bct.h
+++ b/nvboot_bct.h
@@ -24,6 +24,7 @@
 #define INCLUDED_NVBOOT_BCT_H
 
 #include <sys/types.h>
+#include "nvboot_sdram_param.h"
 
 /**
  * Defines the number of 32-bit words in the customer_data area of the BCT.
@@ -46,8 +47,6 @@
  */
 #define NVBOOT_MAX_BOOTLOADERS         4
 
-#define NVBOOT_BCT_USED_DATA_SIZE	2052
-
 /**
  * Defines the maximum number of device parameter sets in the BCT.
  * The value must be equal to (1 << # of device straps)
@@ -55,6 +54,12 @@
 #define NVBOOT_BCT_MAX_PARAM_SETS      4
 
 /**
+ * Defines the maximum number of SDRAM parameter sets in the BCT.
+ * The value must be equal to (1 << # of SDRAM straps)
+ */
+#define NVBOOT_BCT_MAX_SDRAM_SETS      4
+
+/**
  * Defines the number of entries (bits) in the bad block table.
  * The consequences of changing its value are as follows.  Using P as the
  * # of physical blocks in the boot loader and B as the value of this
@@ -99,6 +104,28 @@ typedef struct nvboot_hash_rec
 	u_int32_t hash[NVBOOT_CMAC_AES_HASH_LENGTH];
 } nvboot_hash;
 
+/// Defines the params that can be configured for NAND devices.
+typedef struct nvboot_nand_params_rec{
+	/**
+	 * Specifies the clock divider for the PLL_P 432MHz source.
+	 * If it is set to 18, then clock source to Nand controller is
+	 * 432 / 18 = 24MHz.
+	 */
+	u_int8_t clock_divider;
+
+	/// Specifies the value to be programmed to Nand Timing Register 1
+	u_int32_t nand_timing;
+
+	/// Specifies the value to be programmed to Nand Timing Register 2
+	u_int32_t nand_timing2;
+
+	/// Specifies the block size in log2 bytes
+	u_int8_t block_size_log2;
+
+	/// Specifies the page size in log2 bytes
+	u_int8_t page_size_log2;
+} nvboot_nand_params;
+
 /// Defines various data widths supported.
 typedef enum
 {
@@ -143,7 +170,6 @@ typedef struct nvboot_sdmmc_params_rec
 	 * data width cannot be used at the chosen clock frequency.
 	 */
 	u_int8_t max_power_class_supported;
-	u_int32_t reserved;
 } nvboot_sdmmc_params;
 
 typedef enum 
@@ -199,6 +225,8 @@ typedef struct nvboot_spiflash_params_rec
 * Defines the union of the parameters required by each device.
 */
 typedef union{
+	/// Specifies optimized parameters for NAND
+	nvboot_nand_params nand_params;
 	/// Specifies optimized parameters for eMMC and eSD
 	nvboot_sdmmc_params sdmmc_params;
 	/// Specifies optimized parameters for SPI NOR
@@ -216,6 +244,9 @@ typedef enum
 	/// Specifies a default (unset) value.
 	nvboot_dev_type_none = 0,
 
+	/// Specifies NAND.
+	nvboot_dev_type_nand,
+
 	/// Specifies SPI NOR.
 	nvboot_dev_type_spi = 3,
 
@@ -276,7 +307,8 @@ typedef struct nvboot_config_table_rec
 	u_int32_t num_param_sets;
 	nvboot_dev_type dev_type[NVBOOT_BCT_MAX_PARAM_SETS];
 	nvboot_dev_params dev_params[NVBOOT_BCT_MAX_PARAM_SETS];
-	u_int8_t bct_used_data[NVBOOT_BCT_USED_DATA_SIZE];
+	u_int32_t num_sdram_sets;
+	nvboot_sdram_params sdram_params[NVBOOT_BCT_MAX_SDRAM_SETS];
 	nvboot_badblock_table badblock_table;
 	u_int32_t bootloader_used;
 	nv_bootloader_info bootloader[NVBOOT_MAX_BOOTLOADERS];
@@ -285,5 +317,4 @@ typedef struct nvboot_config_table_rec
 	u_int8_t reserved[NVBOOT_BCT_RESERVED_SIZE];
 } nvboot_config_table;
 
-/** @} */
 #endif /* #ifndef INCLUDED_NVBOOT_BCT_H */
diff --git a/nvboot_sdram_param.h b/nvboot_sdram_param.h
new file mode 100644
index 0000000..03f2762
--- /dev/null
+++ b/nvboot_sdram_param.h
@@ -0,0 +1,328 @@
+/**
+ * Copyright (c) 2011 NVIDIA Corporation.  All rights reserved.
+ *
+ * See file CREDITS for list of people who contributed to this
+ * project.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ */
+
+/**
+ * Defines the SDRAM parameter structure.
+ *
+ * Note that PLLM is used by EMC.
+ */
+
+#ifndef INCLUDED_NVBOOT_SDRAM_PARAM_H
+#define INCLUDED_NVBOOT_SDRAM_PARAM_H
+
+#define NVBOOT_BCT_SDRAM_ARB_CONFIG_WORDS 27
+
+typedef enum 
+{
+	/// Specifies the memory type to be undefined
+	nvboot_memory_type_none = 0,
+
+	/// Specifies the memory type to be DDR SDRAM
+	nvboot_memory_type_ddr,
+
+	/// Specifies the memory type to be LPDDR SDRAM
+	nvboot_memory_type_lpddr,
+
+	/// Specifies the memory type to be DDR2 SDRAM
+	nvboot_memory_type_ddr2,
+
+	/// Specifies the memory type to be LPDDR2 SDRAM
+	nvboot_memory_type_lpddr2,
+
+	nvboot_memory_type_num,
+	nvboot_memory_type_force32 = 0x7FFFFFF
+} nvboot_memory_type;
+
+
+/**
+ * Defines the SDRAM parameter structure
+ */
+typedef struct nvboot_sdram_params_rec
+{
+	/// Specifies the type of memory device
+	nvboot_memory_type memory_type;
+
+	/// Specifies the CPCON value for PllM
+	u_int32_t pllm_charge_pump_setup_ctrl;
+	/// Specifies the LPCON value for PllM
+	u_int32_t pllm_loop_filter_setup_ctrl;
+	/// Specifies the M value for PllM
+	u_int32_t pllm_input_divider;
+	/// Specifies the N value for PllM
+	u_int32_t pllm_feedback_divider;
+	/// Specifies the P value for PllM
+	u_int32_t pllm_post_divider;
+	/// Specifies the time to wait for PLLM to lock (in microseconds)
+	u_int32_t pllm_stable_time;
+
+	/// Specifies the divider for the EMC Clock Source
+	u_int32_t emc_clock_divider;
+
+	///
+	/// Auto-calibration of EMC pads
+	///
+	/// Specifies the value for EMC_AUTO_CAL_INTERVAL
+	u_int32_t emc_auto_cal_interval;
+	/// Specifies the value for EMC_AUTO_CAL_CONFIG
+	/// Note: Trigger bits are set by the SDRAM code.
+	u_int32_t emc_auto_cal_config;   
+	/// Specifies the time for the calibration to
+	/// stabilize (in microseconds)
+	u_int32_t emc_auto_cal_wait;
+
+	/// Specifies the time to wait after pin programming (in microseconds)
+	/// Dram vendors require at least 200us.
+	u_int32_t emc_pin_program_wait;
+
+	///
+	/// Timing parameters required for the SDRAM 
+	///
+	/// Specifies the value for EMC_RC
+	u_int32_t emc_rc;
+	/// Specifies the value for EMC_RFC
+	u_int32_t emc_rfc;
+	/// Specifies the value for EMC_RAS
+	u_int32_t emc_ras;
+	/// Specifies the value for EMC_RP
+	u_int32_t emc_rp;
+	/// Specifies the value for EMC_R2W
+	u_int32_t emc_r2w;
+	/// Specifies the value for EMC_R2W
+	u_int32_t emc_w2r;
+	/// Specifies the value for EMC_R2P
+	u_int32_t emc_r2p;
+	/// Specifies the value for EMC_W2P
+	u_int32_t emc_w2p;
+	/// Specifies the value for EMC_RD_RCD
+	u_int32_t emc_rd_rcd;
+	/// Specifies the value for EMC_WR_RCD
+	u_int32_t emc_wr_rcd;
+	/// Specifies the value for EMC_RRD
+	u_int32_t emc_rrd;
+	/// Specifies the value for EMC_REXT
+	u_int32_t emc_rext;
+	/// Specifies the value for EMC_WDV
+	u_int32_t emc_wdv;
+	/// Specifies the value for EMC_QUSE
+	u_int32_t emc_quse;
+	/// Specifies the value for EMC_QRST
+	u_int32_t emc_qrst;
+	/// Specifies the value for EMC_QSAFE
+	u_int32_t emc_qsafe;
+	/// Specifies the value for EMC_RDV
+	u_int32_t emc_rdv;
+	/// Specifies the value for EMC_REFRESH
+	u_int32_t emc_refresh;
+	/// Specifies the value for EMC_BURST_REFRESH_NUM
+	u_int32_t emc_burst_refresh_num;
+	/// Specifies the value for EMC_PDEX2WR
+	u_int32_t emc_pdex2wr;
+	/// Specifies the value for EMC_PDEX2RD
+	u_int32_t emc_pdex2rd;
+	/// Specifies the value for EMC_PCHG2PDEN
+	u_int32_t emc_pchg2pden;
+	/// Specifies the value for EMC_ACT2PDEN
+	u_int32_t emc_act2pden;
+	/// Specifies the value for EMC_AR2PDEN
+	u_int32_t emc_ar2pden;
+	/// Specifies the value for EMC_RW2PDEN
+	u_int32_t emc_rw2pden;
+	/// Specifies the value for EMC_TXSR
+	u_int32_t emc_txsr;
+	/// Specifies the value for EMC_TCKE
+	u_int32_t emc_tcke;
+	/// Specifies the value for EMC_TFAW
+	u_int32_t emc_tfaw;
+	/// Specifies the value for EMC_TRPAB
+	u_int32_t emc_trpab;
+	/// Specifies the value for EMC_TCLKSTABLE
+	u_int32_t emc_tclkstable;
+	/// Specifies the value for EMC_TCLKSTOP
+	u_int32_t emc_tclkstop;
+	/// Specifies the value for EMC_TREFBW
+	u_int32_t emc_trefbw;
+	/// Specifies the value for EMC_QUSE_EXTRA
+	u_int32_t emc_quse_extra;
+
+	///
+	/// FBIO configuration values 
+	///
+	/// Specifies the value for EMC_FBIO_CFG1
+	u_int32_t emc_fbio_cfg1;
+	/// Specifies the value for EMC_FBIO_DQSIB_DLY
+	u_int32_t emc_fbio_dqsib_dly;
+	/// Specifies the value for EMC_FBIO_DQSIB_DLY_MSB
+	u_int32_t emc_fbio_dqsib_dly_msb;
+	/// Specifies the value for EMC_FBIO_QUSE_DLY
+	u_int32_t emc_fbio_quse_dly;
+	/// Specifies the value for EMC_FBIO_QUSE_DLY_MSB
+	u_int32_t emc_fbio_quse_dly_msb;
+	/// Specifies the value for EMC_FBIO_CFG5
+	u_int32_t emc_fbio_cfg5;
+	/// Specifies the value for EMC_FBIO_CFG6
+	u_int32_t emc_fbio_cfg6;
+	/// Specifies the value for EMC_FBIO_SPARE
+	u_int32_t emc_fbio_spare;
+
+	///
+	/// MRS command values
+	///
+	/// Specifies the value for EMC_MRS
+	u_int32_t emc_mrs;
+	/// Specifies the value for EMC_EMRS
+	u_int32_t emc_emrs;
+	/// Specifies the first  of a sequence of three values for EMC_MRW
+	u_int32_t emc_mrw1;
+	/// Specifies the second of a sequence of three values for EMC_MRW
+	u_int32_t emc_mrw2;
+	/// Specifies the third  of a sequence of three values for EMC_MRW
+	u_int32_t emc_mrw3;
+
+	/// Specifies the EMC_MRW reset command value
+	u_int32_t emc_mrw_reset_command;
+	/// Specifies the EMC Reset wait time (in microseconds)
+	u_int32_t emc_mrw_reset_ninit_wait;
+
+	/// Specifies the value for EMC_ADR_CFG
+	/// The same value is also used for MC_EMC_ADR_CFG
+	u_int32_t emc_adr_cfg;
+	/// Specifies the value for EMC_ADR_CFG_1
+	u_int32_t emc_adr_cfg1;
+
+	/// Specifies the value for MC_EMEM_CFG which holds the external memory
+	/// size (in KBytes)
+	/// EMEM_SIZE_KB must be <= (Device size in KB * Number of Devices)
+	u_int32_t mc_emem_Cfg;
+
+	/// Specifies the value for MC_LOWLATENCY_CONFIG
+	/// Mainly for LL_DRAM_INTERLEAVE: Some DRAMs do not support interleave
+	/// mode. If so, turn off this bit to get the correct low-latency path
+	/// behavior. Reset is ENABLED. 
+	u_int32_t mc_lowlatency_config;
+	/// Specifies the value for EMC_CFG
+	u_int32_t emc_cfg;
+	/// Specifies the value for EMC_CFG_2
+	u_int32_t emc_cfg2;
+	/// Specifies the value for EMC_DBG
+	u_int32_t emc_dbg;
+
+	/// Specifies the value for AHB_ARBITRATION_XBAR_CTRL.
+	/// This is used to set the Memory Inid done
+	u_int32_t ahb_arbitration_xbar_ctrl;
+
+	/// Specifies the value for EMC_CFG_DIG_DLL
+	/// Note: Trigger bits are set by the SDRAM code.
+	u_int32_t emc_cfg_dig_dll;
+	/// Specifies the value for EMC_DLL_XFORM_DQS
+	u_int32_t emc_dll_xform_dqs;
+	/// Specifies the value for EMC_DLL_XFORM_QUSE
+	u_int32_t emc_dll_xform_quse;
+
+	/// Specifies the delay after prgramming the PIN/NOP register during a
+	/// WarmBoot0 sequence (in microseconds)
+	u_int32_t warm_boot_wait;
+
+	/// Specifies the value for EMC_CTT_TERM_CTRL
+	u_int32_t emc_ctt_term_ctrl;
+
+	/// Specifies the value for EMC_ODT_WRITE
+	u_int32_t emc_odt_write;
+	/// Specifies the value for EMC_ODT_WRITE
+	u_int32_t emc_odt_read;
+
+	/// Specifies the value for EMC_ZCAL_REF_CNT
+	/// Only meaningful for LPDDR2. Set to 0 for all other memory types.
+	u_int32_t emc_zcal_ref_cnt;
+	/// Specifies the value for EMC_ZCAL_WAIT_CNT
+	/// Only meaningful for LPDDR2. Set to 0 for all other memory types.
+	u_int32_t emc_zcal_wait_cnt;
+	/// Specifies the value for EMC_ZCAL_MRW_CMD
+	/// Only meaningful for LPDDR2. Set to 0 for all other memory types.
+	u_int32_t emc_zcal_mrw_cmd;
+
+	/// Specifies the MRS command value for initilizing the mode register.
+	u_int32_t emc_mrs_reset_dll;
+	/// Specifies the MRW command for ZQ initialization of device 0
+	u_int32_t emc_mrw_zq_init_dev0;
+	/// Specifies the MRW command for ZQ initialization of device 1
+	u_int32_t emc_mrw_zq_init_dev1;
+	/// Specifies the wait time after programming a ZQ initialization
+	/// command (in microseconds)
+	u_int32_t emc_mrw_zq_init_wait;
+	/// Specifies the wait time after sending an MRS DLL reset command
+	/// (in microseconds)
+	u_int32_t emc_mrs_reset_dll_wait;
+	/// Specifies the first of two EMRS commands to initialize mode
+	/// registers
+	u_int32_t emc_emrs_emr2;
+	/// Specifies the second of two EMRS commands to initialize mode
+	/// registers
+	u_int32_t emc_emrs_emr3;
+	/// Specifies the EMRS command to enable the DDR2 DLL
+	u_int32_t emc_emrs_ddr2_dll_enable;
+	/// Specifies the MRS command to reset the DDR2 DLL
+	u_int32_t emc_mrs_ddr2_dll_reset;
+	/// Specifies the EMRS command to set OCD calibration
+	u_int32_t emc_emrs_ddr2_ocd_calib;
+	/// Specifies the wait between initializing DDR and setting OCD
+	/// calibration (in microseconds)
+	u_int32_t emc_ddr2_wait;
+
+	///
+	/// Clock trimmers
+	///
+	/// Specifies the value for EMC_CFG_CLKTRIM_0
+	u_int32_t emc_cfg_clktrim0;
+	/// Specifies the value for EMC_CFG_CLKTRIM_1
+	u_int32_t emc_cfg_clktrim1;
+	/// Specifies the value for EMC_CFG_CLKTRIM_2
+	u_int32_t emc_cfg_clktrim2;
+
+	///
+	/// Pad controls
+	///
+	/// Specifies the value for PMC_DDR_PWR
+	u_int32_t pmc_ddr_pwr;
+	/// Specifies the value for APB_MISC_GP_XM2CFGAPADCTRL
+	u_int32_t apb_misc_gp_xm2cfga_pad_ctrl;
+	/// Specifies the value for APB_MISC_GP_XM2CFGCPADCTRL
+	u_int32_t apb_misc_gp_xm2cfgc_pad_ctrl;
+	/// Specifies the value for APB_MISC_GP_XM2CFGCPADCTRL2
+	u_int32_t apb_misc_gp_xm2cfgc_pad_ctrl2;
+	/// Specifies the value for APB_MISC_GP_XM2CFGDPADCTRL
+	u_int32_t apb_misc_gp_xm2cfgd_pad_ctrl;
+	/// Specifies the value for APB_MISC_GP_XM2CFGDPADCTRL2
+	u_int32_t apb_misc_gp_xm2cfgd_pad_ctrl2;
+	/// Specifies the value for APB_MISC_GP_XM2CLKCFGPADCTRL
+	u_int32_t apb_misc_gp_xm2clkcfg_Pad_ctrl;
+	/// Specifies the value for APB_MISC_GP_XM2COMPPADCTRL
+	u_int32_t apb_misc_gp_xm2comp_pad_ctrl;
+	/// Specifies the value for APB_MISC_GP_XM2VTTGENPADCTRL
+	u_int32_t apb_misc_gp_xm2vttgen_pad_ctrl;
+
+	/// Specifies storage for arbitration configuration registers
+	/// Data passed through to the Bootloader but not used by the Boot ROM
+	u_int32_t arbitration_config[NVBOOT_BCT_SDRAM_ARB_CONFIG_WORDS];
+} nvboot_sdram_params;
+
+#endif /* #ifndef INCLUDED_NVBOOT_SDRAM_PARAM_H */
+