This source file includes following definitions.
- zynq_fpga_write
- zynq_fpga_read
- zynq_fpga_set_irq
- zynq_step_dma
- zynq_fpga_isr
- zynq_fpga_has_sync
- zynq_fpga_ops_write_init
- zynq_fpga_ops_write
- zynq_fpga_ops_write_complete
- zynq_fpga_ops_state
- zynq_fpga_probe
- zynq_fpga_remove
1
2
3
4
5
6
7
8
9
10 #include <linux/clk.h>
11 #include <linux/completion.h>
12 #include <linux/delay.h>
13 #include <linux/dma-mapping.h>
14 #include <linux/fpga/fpga-mgr.h>
15 #include <linux/interrupt.h>
16 #include <linux/io.h>
17 #include <linux/iopoll.h>
18 #include <linux/module.h>
19 #include <linux/mfd/syscon.h>
20 #include <linux/of_address.h>
21 #include <linux/of_irq.h>
22 #include <linux/pm.h>
23 #include <linux/regmap.h>
24 #include <linux/string.h>
25 #include <linux/scatterlist.h>
26
27
28
29
30 #define SLCR_FPGA_RST_CTRL_OFFSET 0x240
31
32 #define SLCR_LVL_SHFTR_EN_OFFSET 0x900
33
34
35
36
37 #define CTRL_OFFSET 0x00
38
39 #define LOCK_OFFSET 0x04
40
41 #define INT_STS_OFFSET 0x0c
42
43 #define INT_MASK_OFFSET 0x10
44
45 #define STATUS_OFFSET 0x14
46
47 #define DMA_SRC_ADDR_OFFSET 0x18
48
49 #define DMA_DST_ADDR_OFFSET 0x1c
50
51 #define DMA_SRC_LEN_OFFSET 0x20
52
53 #define DMA_DEST_LEN_OFFSET 0x24
54
55 #define UNLOCK_OFFSET 0x34
56
57 #define MCTRL_OFFSET 0x80
58
59
60
61
62 #define CTRL_PCFG_PROG_B_MASK BIT(30)
63
64 #define CTRL_PCAP_PR_MASK BIT(27)
65
66 #define CTRL_PCAP_MODE_MASK BIT(26)
67
68 #define CTRL_PCAP_RATE_EN_MASK BIT(25)
69
70 #define CTRL_SEC_EN_MASK BIT(7)
71
72
73
74 #define MCTRL_PCAP_LPBK_MASK BIT(4)
75
76
77
78
79 #define STATUS_DMA_Q_F BIT(31)
80 #define STATUS_DMA_Q_E BIT(30)
81 #define STATUS_PCFG_INIT_MASK BIT(4)
82
83
84
85 #define IXR_DMA_DONE_MASK BIT(13)
86
87 #define IXR_D_P_DONE_MASK BIT(12)
88
89 #define IXR_PCFG_DONE_MASK BIT(2)
90 #define IXR_ERROR_FLAGS_MASK 0x00F0C860
91 #define IXR_ALL_MASK 0xF8F7F87F
92
93
94
95
96 #define DMA_INVALID_ADDRESS GENMASK(31, 0)
97
98 #define UNLOCK_MASK 0x757bdf0d
99
100 #define INIT_POLL_TIMEOUT 2500000
101
102 #define INIT_POLL_DELAY 20
103
104
105
106 #define DMA_SRC_LAST_TRANSFER 1
107
108 #define DMA_TIMEOUT_MS 5000
109
110
111
112 #define LVL_SHFTR_DISABLE_ALL_MASK 0x0
113
114 #define LVL_SHFTR_ENABLE_PS_TO_PL 0xa
115
116 #define LVL_SHFTR_ENABLE_PL_TO_PS 0xf
117
118 #define FPGA_RST_ALL_MASK 0xf
119
120 #define FPGA_RST_NONE_MASK 0x0
121
122 struct zynq_fpga_priv {
123 int irq;
124 struct clk *clk;
125
126 void __iomem *io_base;
127 struct regmap *slcr;
128
129 spinlock_t dma_lock;
130 unsigned int dma_elm;
131 unsigned int dma_nelms;
132 struct scatterlist *cur_sg;
133
134 struct completion dma_done;
135 };
136
137 static inline void zynq_fpga_write(struct zynq_fpga_priv *priv, u32 offset,
138 u32 val)
139 {
140 writel(val, priv->io_base + offset);
141 }
142
143 static inline u32 zynq_fpga_read(const struct zynq_fpga_priv *priv,
144 u32 offset)
145 {
146 return readl(priv->io_base + offset);
147 }
148
149 #define zynq_fpga_poll_timeout(priv, addr, val, cond, sleep_us, timeout_us) \
150 readl_poll_timeout(priv->io_base + addr, val, cond, sleep_us, \
151 timeout_us)
152
153
154 static inline void zynq_fpga_set_irq(struct zynq_fpga_priv *priv, u32 enable)
155 {
156 zynq_fpga_write(priv, INT_MASK_OFFSET, ~enable);
157 }
158
159
160 static void zynq_step_dma(struct zynq_fpga_priv *priv)
161 {
162 u32 addr;
163 u32 len;
164 bool first;
165
166 first = priv->dma_elm == 0;
167 while (priv->cur_sg) {
168
169 if (zynq_fpga_read(priv, STATUS_OFFSET) & STATUS_DMA_Q_F)
170 break;
171
172 addr = sg_dma_address(priv->cur_sg);
173 len = sg_dma_len(priv->cur_sg);
174 if (priv->dma_elm + 1 == priv->dma_nelms) {
175
176
177
178
179
180 addr |= DMA_SRC_LAST_TRANSFER;
181 priv->cur_sg = NULL;
182 } else {
183 priv->cur_sg = sg_next(priv->cur_sg);
184 priv->dma_elm++;
185 }
186
187 zynq_fpga_write(priv, DMA_SRC_ADDR_OFFSET, addr);
188 zynq_fpga_write(priv, DMA_DST_ADDR_OFFSET, DMA_INVALID_ADDRESS);
189 zynq_fpga_write(priv, DMA_SRC_LEN_OFFSET, len / 4);
190 zynq_fpga_write(priv, DMA_DEST_LEN_OFFSET, 0);
191 }
192
193
194
195
196
197
198
199 if (first && priv->cur_sg) {
200 zynq_fpga_set_irq(priv,
201 IXR_DMA_DONE_MASK | IXR_ERROR_FLAGS_MASK);
202 } else if (!priv->cur_sg) {
203
204
205
206
207 zynq_fpga_set_irq(priv,
208 IXR_D_P_DONE_MASK | IXR_ERROR_FLAGS_MASK);
209 }
210 }
211
212 static irqreturn_t zynq_fpga_isr(int irq, void *data)
213 {
214 struct zynq_fpga_priv *priv = data;
215 u32 intr_status;
216
217
218
219
220
221 spin_lock(&priv->dma_lock);
222 intr_status = zynq_fpga_read(priv, INT_STS_OFFSET);
223 if (!(intr_status & IXR_ERROR_FLAGS_MASK) &&
224 (intr_status & IXR_DMA_DONE_MASK) && priv->cur_sg) {
225 zynq_fpga_write(priv, INT_STS_OFFSET, IXR_DMA_DONE_MASK);
226 zynq_step_dma(priv);
227 spin_unlock(&priv->dma_lock);
228 return IRQ_HANDLED;
229 }
230 spin_unlock(&priv->dma_lock);
231
232 zynq_fpga_set_irq(priv, 0);
233 complete(&priv->dma_done);
234
235 return IRQ_HANDLED;
236 }
237
238
239
240
241
242 static bool zynq_fpga_has_sync(const u8 *buf, size_t count)
243 {
244 for (; count >= 4; buf += 4, count -= 4)
245 if (buf[0] == 0x66 && buf[1] == 0x55 && buf[2] == 0x99 &&
246 buf[3] == 0xaa)
247 return true;
248 return false;
249 }
250
251 static int zynq_fpga_ops_write_init(struct fpga_manager *mgr,
252 struct fpga_image_info *info,
253 const char *buf, size_t count)
254 {
255 struct zynq_fpga_priv *priv;
256 u32 ctrl, status;
257 int err;
258
259 priv = mgr->priv;
260
261 err = clk_enable(priv->clk);
262 if (err)
263 return err;
264
265
266 if (info->flags & FPGA_MGR_ENCRYPTED_BITSTREAM) {
267 ctrl = zynq_fpga_read(priv, CTRL_OFFSET);
268 if (!(ctrl & CTRL_SEC_EN_MASK)) {
269 dev_err(&mgr->dev,
270 "System not secure, can't use crypted bitstreams\n");
271 err = -EINVAL;
272 goto out_err;
273 }
274 }
275
276
277 if (!(info->flags & FPGA_MGR_PARTIAL_RECONFIG)) {
278 if (!zynq_fpga_has_sync(buf, count)) {
279 dev_err(&mgr->dev,
280 "Invalid bitstream, could not find a sync word. Bitstream must be a byte swapped .bin file\n");
281 err = -EINVAL;
282 goto out_err;
283 }
284
285
286 regmap_write(priv->slcr, SLCR_FPGA_RST_CTRL_OFFSET,
287 FPGA_RST_ALL_MASK);
288
289
290 regmap_write(priv->slcr, SLCR_LVL_SHFTR_EN_OFFSET,
291 LVL_SHFTR_DISABLE_ALL_MASK);
292
293 regmap_write(priv->slcr, SLCR_LVL_SHFTR_EN_OFFSET,
294 LVL_SHFTR_ENABLE_PS_TO_PL);
295
296
297
298
299
300
301
302 ctrl = zynq_fpga_read(priv, CTRL_OFFSET);
303 ctrl |= CTRL_PCFG_PROG_B_MASK;
304
305 zynq_fpga_write(priv, CTRL_OFFSET, ctrl);
306
307 err = zynq_fpga_poll_timeout(priv, STATUS_OFFSET, status,
308 status & STATUS_PCFG_INIT_MASK,
309 INIT_POLL_DELAY,
310 INIT_POLL_TIMEOUT);
311 if (err) {
312 dev_err(&mgr->dev, "Timeout waiting for PCFG_INIT\n");
313 goto out_err;
314 }
315
316 ctrl = zynq_fpga_read(priv, CTRL_OFFSET);
317 ctrl &= ~CTRL_PCFG_PROG_B_MASK;
318
319 zynq_fpga_write(priv, CTRL_OFFSET, ctrl);
320
321 err = zynq_fpga_poll_timeout(priv, STATUS_OFFSET, status,
322 !(status & STATUS_PCFG_INIT_MASK),
323 INIT_POLL_DELAY,
324 INIT_POLL_TIMEOUT);
325 if (err) {
326 dev_err(&mgr->dev, "Timeout waiting for !PCFG_INIT\n");
327 goto out_err;
328 }
329
330 ctrl = zynq_fpga_read(priv, CTRL_OFFSET);
331 ctrl |= CTRL_PCFG_PROG_B_MASK;
332
333 zynq_fpga_write(priv, CTRL_OFFSET, ctrl);
334
335 err = zynq_fpga_poll_timeout(priv, STATUS_OFFSET, status,
336 status & STATUS_PCFG_INIT_MASK,
337 INIT_POLL_DELAY,
338 INIT_POLL_TIMEOUT);
339 if (err) {
340 dev_err(&mgr->dev, "Timeout waiting for PCFG_INIT\n");
341 goto out_err;
342 }
343 }
344
345
346
347
348
349
350 ctrl = zynq_fpga_read(priv, CTRL_OFFSET);
351 if (info->flags & FPGA_MGR_ENCRYPTED_BITSTREAM)
352 zynq_fpga_write(priv, CTRL_OFFSET,
353 (CTRL_PCAP_PR_MASK | CTRL_PCAP_MODE_MASK
354 | CTRL_PCAP_RATE_EN_MASK | ctrl));
355 else
356 zynq_fpga_write(priv, CTRL_OFFSET,
357 (CTRL_PCAP_PR_MASK | CTRL_PCAP_MODE_MASK
358 | ctrl));
359
360
361
362 status = zynq_fpga_read(priv, STATUS_OFFSET);
363 if ((status & STATUS_DMA_Q_F) ||
364 (status & STATUS_DMA_Q_E) != STATUS_DMA_Q_E) {
365 dev_err(&mgr->dev, "DMA command queue not right\n");
366 err = -EBUSY;
367 goto out_err;
368 }
369
370
371 ctrl = zynq_fpga_read(priv, MCTRL_OFFSET);
372 zynq_fpga_write(priv, MCTRL_OFFSET, (~MCTRL_PCAP_LPBK_MASK & ctrl));
373
374 clk_disable(priv->clk);
375
376 return 0;
377
378 out_err:
379 clk_disable(priv->clk);
380
381 return err;
382 }
383
384 static int zynq_fpga_ops_write(struct fpga_manager *mgr, struct sg_table *sgt)
385 {
386 struct zynq_fpga_priv *priv;
387 const char *why;
388 int err;
389 u32 intr_status;
390 unsigned long timeout;
391 unsigned long flags;
392 struct scatterlist *sg;
393 int i;
394
395 priv = mgr->priv;
396
397
398
399
400 for_each_sg(sgt->sgl, sg, sgt->nents, i) {
401 if ((sg->offset % 8) || (sg->length % 4)) {
402 dev_err(&mgr->dev,
403 "Invalid bitstream, chunks must be aligned\n");
404 return -EINVAL;
405 }
406 }
407
408 priv->dma_nelms =
409 dma_map_sg(mgr->dev.parent, sgt->sgl, sgt->nents, DMA_TO_DEVICE);
410 if (priv->dma_nelms == 0) {
411 dev_err(&mgr->dev, "Unable to DMA map (TO_DEVICE)\n");
412 return -ENOMEM;
413 }
414
415
416 err = clk_enable(priv->clk);
417 if (err)
418 goto out_free;
419
420 zynq_fpga_write(priv, INT_STS_OFFSET, IXR_ALL_MASK);
421 reinit_completion(&priv->dma_done);
422
423
424 spin_lock_irqsave(&priv->dma_lock, flags);
425 priv->dma_elm = 0;
426 priv->cur_sg = sgt->sgl;
427 zynq_step_dma(priv);
428 spin_unlock_irqrestore(&priv->dma_lock, flags);
429
430 timeout = wait_for_completion_timeout(&priv->dma_done,
431 msecs_to_jiffies(DMA_TIMEOUT_MS));
432
433 spin_lock_irqsave(&priv->dma_lock, flags);
434 zynq_fpga_set_irq(priv, 0);
435 priv->cur_sg = NULL;
436 spin_unlock_irqrestore(&priv->dma_lock, flags);
437
438 intr_status = zynq_fpga_read(priv, INT_STS_OFFSET);
439 zynq_fpga_write(priv, INT_STS_OFFSET, IXR_ALL_MASK);
440
441
442
443
444
445
446
447 if (intr_status & IXR_ERROR_FLAGS_MASK) {
448 why = "DMA reported error";
449 err = -EIO;
450 goto out_report;
451 }
452
453 if (priv->cur_sg ||
454 !((intr_status & IXR_D_P_DONE_MASK) == IXR_D_P_DONE_MASK)) {
455 if (timeout == 0)
456 why = "DMA timed out";
457 else
458 why = "DMA did not complete";
459 err = -EIO;
460 goto out_report;
461 }
462
463 err = 0;
464 goto out_clk;
465
466 out_report:
467 dev_err(&mgr->dev,
468 "%s: INT_STS:0x%x CTRL:0x%x LOCK:0x%x INT_MASK:0x%x STATUS:0x%x MCTRL:0x%x\n",
469 why,
470 intr_status,
471 zynq_fpga_read(priv, CTRL_OFFSET),
472 zynq_fpga_read(priv, LOCK_OFFSET),
473 zynq_fpga_read(priv, INT_MASK_OFFSET),
474 zynq_fpga_read(priv, STATUS_OFFSET),
475 zynq_fpga_read(priv, MCTRL_OFFSET));
476
477 out_clk:
478 clk_disable(priv->clk);
479
480 out_free:
481 dma_unmap_sg(mgr->dev.parent, sgt->sgl, sgt->nents, DMA_TO_DEVICE);
482 return err;
483 }
484
485 static int zynq_fpga_ops_write_complete(struct fpga_manager *mgr,
486 struct fpga_image_info *info)
487 {
488 struct zynq_fpga_priv *priv = mgr->priv;
489 int err;
490 u32 intr_status;
491
492 err = clk_enable(priv->clk);
493 if (err)
494 return err;
495
496
497 zynq_fpga_write(priv, CTRL_OFFSET,
498 zynq_fpga_read(priv, CTRL_OFFSET) & ~CTRL_PCAP_PR_MASK);
499
500 err = zynq_fpga_poll_timeout(priv, INT_STS_OFFSET, intr_status,
501 intr_status & IXR_PCFG_DONE_MASK,
502 INIT_POLL_DELAY,
503 INIT_POLL_TIMEOUT);
504
505 clk_disable(priv->clk);
506
507 if (err)
508 return err;
509
510
511 if (!(info->flags & FPGA_MGR_PARTIAL_RECONFIG)) {
512
513 regmap_write(priv->slcr, SLCR_LVL_SHFTR_EN_OFFSET,
514 LVL_SHFTR_ENABLE_PL_TO_PS);
515
516
517 regmap_write(priv->slcr, SLCR_FPGA_RST_CTRL_OFFSET,
518 FPGA_RST_NONE_MASK);
519 }
520
521 return 0;
522 }
523
524 static enum fpga_mgr_states zynq_fpga_ops_state(struct fpga_manager *mgr)
525 {
526 int err;
527 u32 intr_status;
528 struct zynq_fpga_priv *priv;
529
530 priv = mgr->priv;
531
532 err = clk_enable(priv->clk);
533 if (err)
534 return FPGA_MGR_STATE_UNKNOWN;
535
536 intr_status = zynq_fpga_read(priv, INT_STS_OFFSET);
537 clk_disable(priv->clk);
538
539 if (intr_status & IXR_PCFG_DONE_MASK)
540 return FPGA_MGR_STATE_OPERATING;
541
542 return FPGA_MGR_STATE_UNKNOWN;
543 }
544
545 static const struct fpga_manager_ops zynq_fpga_ops = {
546 .initial_header_size = 128,
547 .state = zynq_fpga_ops_state,
548 .write_init = zynq_fpga_ops_write_init,
549 .write_sg = zynq_fpga_ops_write,
550 .write_complete = zynq_fpga_ops_write_complete,
551 };
552
553 static int zynq_fpga_probe(struct platform_device *pdev)
554 {
555 struct device *dev = &pdev->dev;
556 struct zynq_fpga_priv *priv;
557 struct fpga_manager *mgr;
558 struct resource *res;
559 int err;
560
561 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
562 if (!priv)
563 return -ENOMEM;
564 spin_lock_init(&priv->dma_lock);
565
566 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
567 priv->io_base = devm_ioremap_resource(dev, res);
568 if (IS_ERR(priv->io_base))
569 return PTR_ERR(priv->io_base);
570
571 priv->slcr = syscon_regmap_lookup_by_phandle(dev->of_node,
572 "syscon");
573 if (IS_ERR(priv->slcr)) {
574 dev_err(dev, "unable to get zynq-slcr regmap\n");
575 return PTR_ERR(priv->slcr);
576 }
577
578 init_completion(&priv->dma_done);
579
580 priv->irq = platform_get_irq(pdev, 0);
581 if (priv->irq < 0) {
582 dev_err(dev, "No IRQ available\n");
583 return priv->irq;
584 }
585
586 priv->clk = devm_clk_get(dev, "ref_clk");
587 if (IS_ERR(priv->clk)) {
588 dev_err(dev, "input clock not found\n");
589 return PTR_ERR(priv->clk);
590 }
591
592 err = clk_prepare_enable(priv->clk);
593 if (err) {
594 dev_err(dev, "unable to enable clock\n");
595 return err;
596 }
597
598
599 zynq_fpga_write(priv, UNLOCK_OFFSET, UNLOCK_MASK);
600
601 zynq_fpga_set_irq(priv, 0);
602 zynq_fpga_write(priv, INT_STS_OFFSET, IXR_ALL_MASK);
603 err = devm_request_irq(dev, priv->irq, zynq_fpga_isr, 0, dev_name(dev),
604 priv);
605 if (err) {
606 dev_err(dev, "unable to request IRQ\n");
607 clk_disable_unprepare(priv->clk);
608 return err;
609 }
610
611 clk_disable(priv->clk);
612
613 mgr = devm_fpga_mgr_create(dev, "Xilinx Zynq FPGA Manager",
614 &zynq_fpga_ops, priv);
615 if (!mgr)
616 return -ENOMEM;
617
618 platform_set_drvdata(pdev, mgr);
619
620 err = fpga_mgr_register(mgr);
621 if (err) {
622 dev_err(dev, "unable to register FPGA manager\n");
623 clk_unprepare(priv->clk);
624 return err;
625 }
626
627 return 0;
628 }
629
630 static int zynq_fpga_remove(struct platform_device *pdev)
631 {
632 struct zynq_fpga_priv *priv;
633 struct fpga_manager *mgr;
634
635 mgr = platform_get_drvdata(pdev);
636 priv = mgr->priv;
637
638 fpga_mgr_unregister(mgr);
639
640 clk_unprepare(priv->clk);
641
642 return 0;
643 }
644
645 #ifdef CONFIG_OF
646 static const struct of_device_id zynq_fpga_of_match[] = {
647 { .compatible = "xlnx,zynq-devcfg-1.0", },
648 {},
649 };
650
651 MODULE_DEVICE_TABLE(of, zynq_fpga_of_match);
652 #endif
653
654 static struct platform_driver zynq_fpga_driver = {
655 .probe = zynq_fpga_probe,
656 .remove = zynq_fpga_remove,
657 .driver = {
658 .name = "zynq_fpga_manager",
659 .of_match_table = of_match_ptr(zynq_fpga_of_match),
660 },
661 };
662
663 module_platform_driver(zynq_fpga_driver);
664
665 MODULE_AUTHOR("Moritz Fischer <moritz.fischer@ettus.com>");
666 MODULE_AUTHOR("Michal Simek <michal.simek@xilinx.com>");
667 MODULE_DESCRIPTION("Xilinx Zynq FPGA Manager");
668 MODULE_LICENSE("GPL v2");