1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3  * Copyright Altera Corporation (C) 2012-2015
4  */
5 
6 #ifndef _SEQUENCER_H_
7 #define _SEQUENCER_H_
8 
9 #define RW_MGR_NUM_DM_PER_WRITE_GROUP (rwcfg->mem_data_mask_width \
10 	/ rwcfg->mem_if_write_dqs_width)
11 #define RW_MGR_NUM_TRUE_DM_PER_WRITE_GROUP (rwcfg->true_mem_data_mask_width \
12 	/ rwcfg->mem_if_write_dqs_width)
13 
14 #define RW_MGR_NUM_DQS_PER_WRITE_GROUP (rwcfg->mem_if_read_dqs_width \
15 	/ rwcfg->mem_if_write_dqs_width)
16 #define NUM_RANKS_PER_SHADOW_REG (rwcfg->mem_number_of_ranks / NUM_SHADOW_REGS)
17 
18 #define RW_MGR_RUN_SINGLE_GROUP_OFFSET		0x0
19 #define RW_MGR_RUN_ALL_GROUPS_OFFSET		0x0400
20 #define RW_MGR_RESET_READ_DATAPATH_OFFSET	0x1000
21 #define RW_MGR_SET_CS_AND_ODT_MASK_OFFSET	0x1400
22 #define RW_MGR_INST_ROM_WRITE_OFFSET		0x1800
23 #define RW_MGR_AC_ROM_WRITE_OFFSET		0x1C00
24 
25 #define NUM_SHADOW_REGS			1
26 
27 #define RW_MGR_RANK_NONE		0xFF
28 #define RW_MGR_RANK_ALL			0x00
29 
30 #define RW_MGR_ODT_MODE_OFF		0
31 #define RW_MGR_ODT_MODE_READ_WRITE	1
32 
33 #define NUM_CALIB_REPEAT		1
34 
35 #define NUM_READ_TESTS			7
36 #define NUM_READ_PB_TESTS		7
37 #define NUM_WRITE_TESTS			15
38 #define NUM_WRITE_PB_TESTS		31
39 
40 #define PASS_ALL_BITS			1
41 #define PASS_ONE_BIT			0
42 
43 /* calibration stages */
44 #define CAL_STAGE_NIL			0
45 #define CAL_STAGE_VFIFO			1
46 #define CAL_STAGE_WLEVEL		2
47 #define CAL_STAGE_LFIFO			3
48 #define CAL_STAGE_WRITES		4
49 #define CAL_STAGE_FULLTEST		5
50 #define CAL_STAGE_REFRESH		6
51 #define CAL_STAGE_CAL_SKIPPED		7
52 #define CAL_STAGE_CAL_ABORTED		8
53 #define CAL_STAGE_VFIFO_AFTER_WRITES	9
54 
55 /* calibration substages */
56 #define CAL_SUBSTAGE_NIL		0
57 #define CAL_SUBSTAGE_GUARANTEED_READ	1
58 #define CAL_SUBSTAGE_DQS_EN_PHASE	2
59 #define CAL_SUBSTAGE_VFIFO_CENTER	3
60 #define CAL_SUBSTAGE_WORKING_DELAY	1
61 #define CAL_SUBSTAGE_LAST_WORKING_DELAY	2
62 #define CAL_SUBSTAGE_WLEVEL_COPY	3
63 #define CAL_SUBSTAGE_WRITES_CENTER	1
64 #define CAL_SUBSTAGE_READ_LATENCY	1
65 #define CAL_SUBSTAGE_REFRESH		1
66 
67 #define SCC_MGR_GROUP_COUNTER_OFFSET		0x0000
68 #define SCC_MGR_DQS_IN_DELAY_OFFSET		0x0100
69 #define SCC_MGR_DQS_EN_PHASE_OFFSET		0x0200
70 #define SCC_MGR_DQS_EN_DELAY_OFFSET		0x0300
71 #define SCC_MGR_DQDQS_OUT_PHASE_OFFSET		0x0400
72 #define SCC_MGR_OCT_OUT1_DELAY_OFFSET		0x0500
73 #define SCC_MGR_IO_OUT1_DELAY_OFFSET		0x0700
74 #define SCC_MGR_IO_IN_DELAY_OFFSET		0x0900
75 
76 /* HHP-HPS-specific versions of some commands */
77 #define SCC_MGR_DQS_EN_DELAY_GATE_OFFSET	0x0600
78 #define SCC_MGR_IO_OE_DELAY_OFFSET		0x0800
79 #define SCC_MGR_HHP_GLOBALS_OFFSET		0x0A00
80 #define SCC_MGR_HHP_RFILE_OFFSET		0x0B00
81 #define SCC_MGR_AFI_CAL_INIT_OFFSET		0x0D00
82 
83 #define SDR_PHYGRP_SCCGRP_ADDRESS		(SOCFPGA_SDR_ADDRESS | 0x0)
84 #define SDR_PHYGRP_PHYMGRGRP_ADDRESS		(SOCFPGA_SDR_ADDRESS | 0x1000)
85 #define SDR_PHYGRP_RWMGRGRP_ADDRESS		(SOCFPGA_SDR_ADDRESS | 0x2000)
86 #define SDR_PHYGRP_DATAMGRGRP_ADDRESS		(SOCFPGA_SDR_ADDRESS | 0x4000)
87 #define SDR_PHYGRP_REGFILEGRP_ADDRESS		(SOCFPGA_SDR_ADDRESS | 0x4800)
88 
89 #define PHY_MGR_CAL_RESET		(0)
90 #define PHY_MGR_CAL_SUCCESS		(1)
91 #define PHY_MGR_CAL_FAIL		(2)
92 
93 #define CALIB_SKIP_DELAY_LOOPS		(1 << 0)
94 #define CALIB_SKIP_ALL_BITS_CHK		(1 << 1)
95 #define CALIB_SKIP_DELAY_SWEEPS		(1 << 2)
96 #define CALIB_SKIP_VFIFO		(1 << 3)
97 #define CALIB_SKIP_LFIFO		(1 << 4)
98 #define CALIB_SKIP_WLEVEL		(1 << 5)
99 #define CALIB_SKIP_WRITES		(1 << 6)
100 #define CALIB_SKIP_FULL_TEST		(1 << 7)
101 #define CALIB_SKIP_ALL			(CALIB_SKIP_VFIFO | \
102 				CALIB_SKIP_LFIFO | CALIB_SKIP_WLEVEL | \
103 				CALIB_SKIP_WRITES | CALIB_SKIP_FULL_TEST)
104 #define CALIB_IN_RTL_SIM			(1 << 8)
105 
106 /* Scan chain manager command addresses */
107 #define READ_SCC_OCT_OUT2_DELAY			0
108 #define READ_SCC_DQ_OUT2_DELAY			0
109 #define READ_SCC_DQS_IO_OUT2_DELAY		0
110 #define READ_SCC_DM_IO_OUT2_DELAY		0
111 
112 /* HHP-HPS-specific values */
113 #define SCC_MGR_HHP_EXTRAS_OFFSET			0
114 #define SCC_MGR_HHP_DQSE_MAP_OFFSET			1
115 
116 /* PHY Debug mode flag constants */
117 #define PHY_DEBUG_IN_DEBUG_MODE 0x00000001
118 #define PHY_DEBUG_ENABLE_CAL_RPT 0x00000002
119 #define PHY_DEBUG_ENABLE_MARGIN_RPT 0x00000004
120 #define PHY_DEBUG_SWEEP_ALL_GROUPS 0x00000008
121 #define PHY_DEBUG_DISABLE_GUARANTEED_READ 0x00000010
122 #define PHY_DEBUG_ENABLE_NON_DESTRUCTIVE_CALIBRATION 0x00000020
123 
124 struct socfpga_sdr_rw_load_manager {
125 	u32	load_cntr0;
126 	u32	load_cntr1;
127 	u32	load_cntr2;
128 	u32	load_cntr3;
129 };
130 
131 struct socfpga_sdr_rw_load_jump_manager {
132 	u32	load_jump_add0;
133 	u32	load_jump_add1;
134 	u32	load_jump_add2;
135 	u32	load_jump_add3;
136 };
137 
138 struct socfpga_sdr_reg_file {
139 	u32 signature;
140 	u32 debug_data_addr;
141 	u32 cur_stage;
142 	u32 fom;
143 	u32 failing_stage;
144 	u32 debug1;
145 	u32 debug2;
146 	u32 dtaps_per_ptap;
147 	u32 trk_sample_count;
148 	u32 trk_longidle;
149 	u32 delays;
150 	u32 trk_rw_mgr_addr;
151 	u32 trk_read_dqs_width;
152 	u32 trk_rfsh;
153 };
154 
155 /* parameter variable holder */
156 struct param_type {
157 	u32	read_correct_mask;
158 	u32	read_correct_mask_vg;
159 	u32	write_correct_mask;
160 	u32	write_correct_mask_vg;
161 };
162 
163 
164 /* global variable holder */
165 struct gbl_type {
166 	uint32_t phy_debug_mode_flags;
167 
168 	/* current read latency */
169 
170 	uint32_t curr_read_lat;
171 
172 	/* error code */
173 
174 	uint32_t error_substage;
175 	uint32_t error_stage;
176 	uint32_t error_group;
177 
178 	/* figure-of-merit in, figure-of-merit out */
179 
180 	uint32_t fom_in;
181 	uint32_t fom_out;
182 
183 	/*USER Number of RW Mgr NOP cycles between
184 	write command and write data */
185 	uint32_t rw_wl_nop_cycles;
186 };
187 
188 struct socfpga_sdr_scc_mgr {
189 	u32	dqs_ena;
190 	u32	dqs_io_ena;
191 	u32	dq_ena;
192 	u32	dm_ena;
193 	u32	__padding1[4];
194 	u32	update;
195 	u32	__padding2[7];
196 	u32	active_rank;
197 };
198 
199 /* PHY manager configuration registers. */
200 struct socfpga_phy_mgr_cfg {
201 	u32	phy_rlat;
202 	u32	reset_mem_stbl;
203 	u32	mux_sel;
204 	u32	cal_status;
205 	u32	cal_debug_info;
206 	u32	vfifo_rd_en_ovrd;
207 	u32	afi_wlat;
208 	u32	afi_rlat;
209 };
210 
211 /* PHY manager command addresses. */
212 struct socfpga_phy_mgr_cmd {
213 	u32	inc_vfifo_fr;
214 	u32	inc_vfifo_hard_phy;
215 	u32	fifo_reset;
216 	u32	inc_vfifo_fr_hr;
217 	u32	inc_vfifo_qr;
218 };
219 
220 struct socfpga_data_mgr {
221 	u32	__padding1;
222 	u32	t_wl_add;
223 	u32	mem_t_add;
224 	u32	t_rl_add;
225 };
226 #endif /* _SEQUENCER_H_ */
227