xref: /openbmc/u-boot/drivers/fpga/zynqpl.c (revision e5c5301f)
1 /*
2  * (C) Copyright 2012-2013, Xilinx, Michal Simek
3  *
4  * (C) Copyright 2012
5  * Joe Hershberger <joe.hershberger@ni.com>
6  *
7  * SPDX-License-Identifier:	GPL-2.0+
8  */
9 
10 #include <common.h>
11 #include <asm/io.h>
12 #include <zynqpl.h>
13 #include <asm/sizes.h>
14 #include <asm/arch/hardware.h>
15 #include <asm/arch/sys_proto.h>
16 
17 #define DEVCFG_CTRL_PCFG_PROG_B		0x40000000
18 #define DEVCFG_ISR_FATAL_ERROR_MASK	0x00740040
19 #define DEVCFG_ISR_ERROR_FLAGS_MASK	0x00340840
20 #define DEVCFG_ISR_RX_FIFO_OV		0x00040000
21 #define DEVCFG_ISR_DMA_DONE		0x00002000
22 #define DEVCFG_ISR_PCFG_DONE		0x00000004
23 #define DEVCFG_STATUS_DMA_CMD_Q_F	0x80000000
24 #define DEVCFG_STATUS_DMA_CMD_Q_E	0x40000000
25 #define DEVCFG_STATUS_DMA_DONE_CNT_MASK	0x30000000
26 #define DEVCFG_STATUS_PCFG_INIT		0x00000010
27 #define DEVCFG_MCTRL_PCAP_LPBK		0x00000010
28 #define DEVCFG_MCTRL_RFIFO_FLUSH	0x00000002
29 #define DEVCFG_MCTRL_WFIFO_FLUSH	0x00000001
30 
31 #ifndef CONFIG_SYS_FPGA_WAIT
32 #define CONFIG_SYS_FPGA_WAIT CONFIG_SYS_HZ/100	/* 10 ms */
33 #endif
34 
35 #ifndef CONFIG_SYS_FPGA_PROG_TIME
36 #define CONFIG_SYS_FPGA_PROG_TIME	(CONFIG_SYS_HZ * 4) /* 4 s */
37 #endif
38 
39 int zynq_info(Xilinx_desc *desc)
40 {
41 	return FPGA_SUCCESS;
42 }
43 
44 #define DUMMY_WORD	0xffffffff
45 
46 /* Xilinx binary format header */
47 static const u32 bin_format[] = {
48 	DUMMY_WORD, /* Dummy words */
49 	DUMMY_WORD,
50 	DUMMY_WORD,
51 	DUMMY_WORD,
52 	DUMMY_WORD,
53 	DUMMY_WORD,
54 	DUMMY_WORD,
55 	DUMMY_WORD,
56 	0x000000bb, /* Sync word */
57 	0x11220044, /* Sync word */
58 	DUMMY_WORD,
59 	DUMMY_WORD,
60 	0xaa995566, /* Sync word */
61 };
62 
63 #define SWAP_NO		1
64 #define SWAP_DONE	2
65 
66 /*
67  * Load the whole word from unaligned buffer
68  * Keep in your mind that it is byte loading on little-endian system
69  */
70 static u32 load_word(const void *buf, u32 swap)
71 {
72 	u32 word = 0;
73 	u8 *bitc = (u8 *)buf;
74 	int p;
75 
76 	if (swap == SWAP_NO) {
77 		for (p = 0; p < 4; p++) {
78 			word <<= 8;
79 			word |= bitc[p];
80 		}
81 	} else {
82 		for (p = 3; p >= 0; p--) {
83 			word <<= 8;
84 			word |= bitc[p];
85 		}
86 	}
87 
88 	return word;
89 }
90 
91 static u32 check_header(const void *buf)
92 {
93 	u32 i, pattern;
94 	int swap = SWAP_NO;
95 	u32 *test = (u32 *)buf;
96 
97 	debug("%s: Let's check bitstream header\n", __func__);
98 
99 	/* Checking that passing bin is not a bitstream */
100 	for (i = 0; i < ARRAY_SIZE(bin_format); i++) {
101 		pattern = load_word(&test[i], swap);
102 
103 		/*
104 		 * Bitstreams in binary format are swapped
105 		 * compare to regular bistream.
106 		 * Do not swap dummy word but if swap is done assume
107 		 * that parsing buffer is binary format
108 		 */
109 		if ((__swab32(pattern) != DUMMY_WORD) &&
110 		    (__swab32(pattern) == bin_format[i])) {
111 			pattern = __swab32(pattern);
112 			swap = SWAP_DONE;
113 			debug("%s: data swapped - let's swap\n", __func__);
114 		}
115 
116 		debug("%s: %d/%x: pattern %x/%x bin_format\n", __func__, i,
117 		      (u32)&test[i], pattern, bin_format[i]);
118 		if (pattern != bin_format[i]) {
119 			debug("%s: Bitstream is not recognized\n", __func__);
120 			return 0;
121 		}
122 	}
123 	debug("%s: Found bitstream header at %x %s swapinng\n", __func__,
124 	      (u32)buf, swap == SWAP_NO ? "without" : "with");
125 
126 	return swap;
127 }
128 
129 static void *check_data(u8 *buf, size_t bsize, u32 *swap)
130 {
131 	u32 word, p = 0; /* possition */
132 
133 	/* Because buf doesn't need to be aligned let's read it by chars */
134 	for (p = 0; p < bsize; p++) {
135 		word = load_word(&buf[p], SWAP_NO);
136 		debug("%s: word %x %x/%x\n", __func__, word, p, (u32)&buf[p]);
137 
138 		/* Find the first bitstream dummy word */
139 		if (word == DUMMY_WORD) {
140 			debug("%s: Found dummy word at position %x/%x\n",
141 			      __func__, p, (u32)&buf[p]);
142 			*swap = check_header(&buf[p]);
143 			if (*swap) {
144 				/* FIXME add full bitstream checking here */
145 				return &buf[p];
146 			}
147 		}
148 		/* Loop can be huge - support CTRL + C */
149 		if (ctrlc())
150 			return 0;
151 	}
152 	return 0;
153 }
154 
155 
156 int zynq_load(Xilinx_desc *desc, const void *buf, size_t bsize)
157 {
158 	unsigned long ts; /* Timestamp */
159 	u32 partialbit = 0;
160 	u32 i, control, isr_status, status, swap, diff;
161 	u32 *buf_start;
162 
163 	/* Detect if we are going working with partial or full bitstream */
164 	if (bsize != desc->size) {
165 		printf("%s: Working with partial bitstream\n", __func__);
166 		partialbit = 1;
167 	}
168 
169 	buf_start = check_data((u8 *)buf, bsize, &swap);
170 	if (!buf_start)
171 		return FPGA_FAIL;
172 
173 	/* Check if data is postpone from start */
174 	diff = (u32)buf_start - (u32)buf;
175 	if (diff) {
176 		printf("%s: Bitstream is not validated yet (diff %x)\n",
177 		       __func__, diff);
178 		return FPGA_FAIL;
179 	}
180 
181 	if ((u32)buf < SZ_1M) {
182 		printf("%s: Bitstream has to be placed up to 1MB (%x)\n",
183 		       __func__, (u32)buf);
184 		return FPGA_FAIL;
185 	}
186 
187 	if ((u32)buf != ALIGN((u32)buf, ARCH_DMA_MINALIGN)) {
188 		u32 *new_buf = (u32 *)ALIGN((u32)buf, ARCH_DMA_MINALIGN);
189 
190 		printf("%s: Align buffer at %x to %x(swap %d)\n", __func__,
191 		       (u32)buf_start, (u32)new_buf, swap);
192 
193 		for (i = 0; i < (bsize/4); i++)
194 			new_buf[i] = load_word(&buf_start[i], swap);
195 
196 		swap = SWAP_DONE;
197 		buf = new_buf;
198 	} else if (swap != SWAP_DONE) {
199 		/* For bitstream which are aligned */
200 		u32 *new_buf = (u32 *)buf;
201 
202 		printf("%s: Bitstream is not swapped(%d) - swap it\n", __func__,
203 		       swap);
204 
205 		for (i = 0; i < (bsize/4); i++)
206 			new_buf[i] = load_word(&buf_start[i], swap);
207 
208 		swap = SWAP_DONE;
209 	}
210 
211 	/* Clear loopback bit */
212 	clrbits_le32(&devcfg_base->mctrl, DEVCFG_MCTRL_PCAP_LPBK);
213 
214 	if (!partialbit) {
215 		zynq_slcr_devcfg_disable();
216 
217 		/* Setting PCFG_PROG_B signal to high */
218 		control = readl(&devcfg_base->ctrl);
219 		writel(control | DEVCFG_CTRL_PCFG_PROG_B, &devcfg_base->ctrl);
220 		/* Setting PCFG_PROG_B signal to low */
221 		writel(control & ~DEVCFG_CTRL_PCFG_PROG_B, &devcfg_base->ctrl);
222 
223 		/* Polling the PCAP_INIT status for Reset */
224 		ts = get_timer(0);
225 		while (readl(&devcfg_base->status) & DEVCFG_STATUS_PCFG_INIT) {
226 			if (get_timer(ts) > CONFIG_SYS_FPGA_WAIT) {
227 				printf("%s: Timeout wait for INIT to clear\n",
228 				       __func__);
229 				return FPGA_FAIL;
230 			}
231 		}
232 
233 		/* Setting PCFG_PROG_B signal to high */
234 		writel(control | DEVCFG_CTRL_PCFG_PROG_B, &devcfg_base->ctrl);
235 
236 		/* Polling the PCAP_INIT status for Set */
237 		ts = get_timer(0);
238 		while (!(readl(&devcfg_base->status) &
239 			DEVCFG_STATUS_PCFG_INIT)) {
240 			if (get_timer(ts) > CONFIG_SYS_FPGA_WAIT) {
241 				printf("%s: Timeout wait for INIT to set\n",
242 				       __func__);
243 				return FPGA_FAIL;
244 			}
245 		}
246 	}
247 
248 	isr_status = readl(&devcfg_base->int_sts);
249 
250 	/* Clear it all, so if Boot ROM comes back, it can proceed */
251 	writel(0xFFFFFFFF, &devcfg_base->int_sts);
252 
253 	if (isr_status & DEVCFG_ISR_FATAL_ERROR_MASK) {
254 		debug("%s: Fatal errors in PCAP 0x%X\n", __func__, isr_status);
255 
256 		/* If RX FIFO overflow, need to flush RX FIFO first */
257 		if (isr_status & DEVCFG_ISR_RX_FIFO_OV) {
258 			writel(DEVCFG_MCTRL_RFIFO_FLUSH, &devcfg_base->mctrl);
259 			writel(0xFFFFFFFF, &devcfg_base->int_sts);
260 		}
261 		return FPGA_FAIL;
262 	}
263 
264 	status = readl(&devcfg_base->status);
265 
266 	debug("%s: Status = 0x%08X\n", __func__, status);
267 
268 	if (status & DEVCFG_STATUS_DMA_CMD_Q_F) {
269 		debug("%s: Error: device busy\n", __func__);
270 		return FPGA_FAIL;
271 	}
272 
273 	debug("%s: Device ready\n", __func__);
274 
275 	if (!(status & DEVCFG_STATUS_DMA_CMD_Q_E)) {
276 		if (!(readl(&devcfg_base->int_sts) & DEVCFG_ISR_DMA_DONE)) {
277 			/* Error state, transfer cannot occur */
278 			debug("%s: ISR indicates error\n", __func__);
279 			return FPGA_FAIL;
280 		} else {
281 			/* Clear out the status */
282 			writel(DEVCFG_ISR_DMA_DONE, &devcfg_base->int_sts);
283 		}
284 	}
285 
286 	if (status & DEVCFG_STATUS_DMA_DONE_CNT_MASK) {
287 		/* Clear the count of completed DMA transfers */
288 		writel(DEVCFG_STATUS_DMA_DONE_CNT_MASK, &devcfg_base->status);
289 	}
290 
291 	debug("%s: Source = 0x%08X\n", __func__, (u32)buf);
292 	debug("%s: Size = %zu\n", __func__, bsize);
293 
294 	/* flush(clean & invalidate) d-cache range buf */
295 	flush_dcache_range((u32)buf, (u32)buf +
296 			   roundup(bsize, ARCH_DMA_MINALIGN));
297 
298 	/* Set up the transfer */
299 	writel((u32)buf | 1, &devcfg_base->dma_src_addr);
300 	writel(0xFFFFFFFF, &devcfg_base->dma_dst_addr);
301 	writel(bsize >> 2, &devcfg_base->dma_src_len);
302 	writel(0, &devcfg_base->dma_dst_len);
303 
304 	isr_status = readl(&devcfg_base->int_sts);
305 
306 	/* Polling the PCAP_INIT status for Set */
307 	ts = get_timer(0);
308 	while (!(isr_status & DEVCFG_ISR_DMA_DONE)) {
309 		if (isr_status & DEVCFG_ISR_ERROR_FLAGS_MASK) {
310 			debug("%s: Error: isr = 0x%08X\n", __func__,
311 			      isr_status);
312 			debug("%s: Write count = 0x%08X\n", __func__,
313 			      readl(&devcfg_base->write_count));
314 			debug("%s: Read count = 0x%08X\n", __func__,
315 			      readl(&devcfg_base->read_count));
316 
317 			return FPGA_FAIL;
318 		}
319 		if (get_timer(ts) > CONFIG_SYS_FPGA_PROG_TIME) {
320 			printf("%s: Timeout wait for DMA to complete\n",
321 			       __func__);
322 			return FPGA_FAIL;
323 		}
324 		isr_status = readl(&devcfg_base->int_sts);
325 	}
326 
327 	debug("%s: DMA transfer is done\n", __func__);
328 
329 	/* Check FPGA configuration completion */
330 	ts = get_timer(0);
331 	while (!(isr_status & DEVCFG_ISR_PCFG_DONE)) {
332 		if (get_timer(ts) > CONFIG_SYS_FPGA_WAIT) {
333 			printf("%s: Timeout wait for FPGA to config\n",
334 			       __func__);
335 			return FPGA_FAIL;
336 		}
337 		isr_status = readl(&devcfg_base->int_sts);
338 	}
339 
340 	debug("%s: FPGA config done\n", __func__);
341 
342 	/* Clear out the DMA status */
343 	writel(DEVCFG_ISR_DMA_DONE, &devcfg_base->int_sts);
344 
345 	if (!partialbit)
346 		zynq_slcr_devcfg_enable();
347 
348 	return FPGA_SUCCESS;
349 }
350 
351 int zynq_dump(Xilinx_desc *desc, const void *buf, size_t bsize)
352 {
353 	return FPGA_FAIL;
354 }
355