2 * Copyright (c) 2013 Thomas Skibo
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * Zynq-700 SLCR driver. Provides hooks for cpu_reset and PL control stuff.
31 * In the future, maybe MIO control, clock control, etc. could go here.
33 * Reference: Zynq-7000 All Programmable SoC Technical Reference Manual.
34 * (v1.4) November 16, 2012. Xilinx doc UG585.
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
40 #include <sys/param.h>
41 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/module.h>
46 #include <sys/mutex.h>
47 #include <sys/resource.h>
48 #include <sys/sysctl.h>
51 #include <machine/bus.h>
52 #include <machine/resource.h>
53 #include <machine/stdarg.h>
55 #include <dev/fdt/fdt_common.h>
56 #include <dev/ofw/ofw_bus.h>
57 #include <dev/ofw/ofw_bus_subr.h>
59 #include <arm/xilinx/zy7_slcr.h>
61 struct zy7_slcr_softc {
64 struct resource *mem_res;
67 static struct zy7_slcr_softc *zy7_slcr_softc_p;
68 extern void (*zynq7_cpu_reset);
70 #define ZSLCR_LOCK(sc) mtx_lock(&(sc)->sc_mtx)
71 #define ZSLCR_UNLOCK(sc) mtx_unlock(&(sc)->sc_mtx)
72 #define ZSLCR_LOCK_INIT(sc) \
73 mtx_init(&(sc)->sc_mtx, device_get_nameunit((sc)->dev), \
75 #define ZSLCR_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx);
77 #define RD4(sc, off) (bus_read_4((sc)->mem_res, (off)))
78 #define WR4(sc, off, val) (bus_write_4((sc)->mem_res, (off), (val)))
80 #define ZYNQ_DEFAULT_PS_CLK_FREQUENCY 33333333 /* 33.3 Mhz */
82 SYSCTL_NODE(_hw, OID_AUTO, zynq, CTLFLAG_RD, 0, "Xilinx Zynq-7000");
84 static char zynq_bootmode[64];
85 SYSCTL_STRING(_hw_zynq, OID_AUTO, bootmode, CTLFLAG_RD, zynq_bootmode, 0,
88 static char zynq_pssid[100];
89 SYSCTL_STRING(_hw_zynq, OID_AUTO, pssid, CTLFLAG_RD, zynq_pssid, 0,
92 static uint32_t zynq_reboot_status;
93 SYSCTL_INT(_hw_zynq, OID_AUTO, reboot_status, CTLFLAG_RD, &zynq_reboot_status,
94 0, "Zynq REBOOT_STATUS register");
96 static int ps_clk_frequency;
97 SYSCTL_INT(_hw_zynq, OID_AUTO, ps_clk_frequency, CTLFLAG_RD, &ps_clk_frequency,
98 0, "Zynq PS_CLK Frequency");
100 static int io_pll_frequency;
101 SYSCTL_INT(_hw_zynq, OID_AUTO, io_pll_frequency, CTLFLAG_RD, &io_pll_frequency,
102 0, "Zynq IO PLL Frequency");
104 static int arm_pll_frequency;
105 SYSCTL_INT(_hw_zynq, OID_AUTO, arm_pll_frequency, CTLFLAG_RD,
106 &arm_pll_frequency, 0, "Zynq ARM PLL Frequency");
108 static int ddr_pll_frequency;
109 SYSCTL_INT(_hw_zynq, OID_AUTO, ddr_pll_frequency, CTLFLAG_RD,
110 &ddr_pll_frequency, 0, "Zynq DDR PLL Frequency");
113 zy7_slcr_unlock(struct zy7_slcr_softc *sc)
116 /* Unlock SLCR with magic number. */
117 WR4(sc, ZY7_SLCR_UNLOCK, ZY7_SLCR_UNLOCK_MAGIC);
121 zy7_slcr_lock(struct zy7_slcr_softc *sc)
124 /* Lock SLCR with magic number. */
125 WR4(sc, ZY7_SLCR_LOCK, ZY7_SLCR_LOCK_MAGIC);
129 zy7_slcr_cpu_reset(void)
131 struct zy7_slcr_softc *sc = zy7_slcr_softc_p;
133 /* Unlock SLCR registers. */
136 /* This has something to do with a work-around so the fsbl will load
137 * the bitstream after soft-reboot. It's very important.
139 WR4(sc, ZY7_SLCR_REBOOT_STAT,
140 RD4(sc, ZY7_SLCR_REBOOT_STAT) & 0xf0ffffff);
143 WR4(sc, ZY7_SLCR_PSS_RST_CTRL, ZY7_SLCR_PSS_RST_CTRL_SOFT_RESET);
149 /* Assert PL resets and disable level shifters in preparation of programming
150 * the PL (FPGA) section. Called from zy7_devcfg.c.
153 zy7_slcr_preload_pl(void)
155 struct zy7_slcr_softc *sc = zy7_slcr_softc_p;
162 /* Unlock SLCR registers. */
165 /* Assert top level output resets. */
166 WR4(sc, ZY7_SLCR_FPGA_RST_CTRL, ZY7_SLCR_FPGA_RST_CTRL_RST_ALL);
168 /* Disable all level shifters. */
169 WR4(sc, ZY7_SLCR_LVL_SHFTR_EN, 0);
171 /* Lock SLCR registers. */
177 /* After PL configuration, enable level shifters and deassert top-level
178 * PL resets. Called from zy7_devcfg.c. Optionally, the level shifters
179 * can be left disabled but that's rare of an FPGA application. That option
180 * is controlled by a sysctl in the devcfg driver.
183 zy7_slcr_postload_pl(int en_level_shifters)
185 struct zy7_slcr_softc *sc = zy7_slcr_softc_p;
192 /* Unlock SLCR registers. */
195 if (en_level_shifters)
196 /* Enable level shifters. */
197 WR4(sc, ZY7_SLCR_LVL_SHFTR_EN, ZY7_SLCR_LVL_SHFTR_EN_ALL);
199 /* Deassert top level output resets. */
200 WR4(sc, ZY7_SLCR_FPGA_RST_CTRL, 0);
202 /* Lock SLCR registers. */
208 /* Override cgem_set_refclk() in gigabit ethernet driver
209 * (sys/dev/cadence/if_cgem.c). This function is called to
210 * request a change in the gem's reference clock speed.
213 cgem_set_ref_clk(int unit, int frequency)
215 struct zy7_slcr_softc *sc = zy7_slcr_softc_p;
221 /* Find suitable divisor pairs. Round result to nearest khz
224 for (div1 = 1; div1 <= ZY7_SLCR_GEM_CLK_CTRL_DIVISOR1_MAX; div1++) {
225 div0 = (io_pll_frequency + div1 * frequency / 2) /
227 if (div0 > 0 && div0 <= ZY7_SLCR_GEM_CLK_CTRL_DIVISOR_MAX &&
228 ((io_pll_frequency / div0 / div1) + 500) / 1000 ==
229 (frequency + 500) / 1000)
233 if (div1 > ZY7_SLCR_GEM_CLK_CTRL_DIVISOR1_MAX)
238 /* Unlock SLCR registers. */
241 /* Modify GEM reference clock. */
242 WR4(sc, unit ? ZY7_SLCR_GEM1_CLK_CTRL : ZY7_SLCR_GEM0_CLK_CTRL,
243 (div1 << ZY7_SLCR_GEM_CLK_CTRL_DIVISOR1_SHIFT) |
244 (div0 << ZY7_SLCR_GEM_CLK_CTRL_DIVISOR_SHIFT) |
245 ZY7_SLCR_GEM_CLK_CTRL_SRCSEL_IO_PLL |
246 ZY7_SLCR_GEM_CLK_CTRL_CLKACT);
248 /* Lock SLCR registers. */
257 * PL clocks management function
260 zy7_pl_fclk_set_source(int unit, int source)
262 struct zy7_slcr_softc *sc = zy7_slcr_softc_p;
270 /* Unlock SLCR registers. */
273 /* Modify FPGAx source. */
274 reg = RD4(sc, ZY7_SLCR_FPGA_CLK_CTRL(unit));
275 reg &= ~(ZY7_SLCR_FPGA_CLK_CTRL_SRCSEL_MASK);
276 reg |= (source << ZY7_SLCR_FPGA_CLK_CTRL_SRCSEL_SHIFT);
277 WR4(sc, ZY7_SLCR_FPGA_CLK_CTRL(unit), reg);
279 /* Lock SLCR registers. */
288 zy7_pl_fclk_get_source(int unit)
290 struct zy7_slcr_softc *sc = zy7_slcr_softc_p;
299 /* Modify GEM reference clock. */
300 reg = RD4(sc, ZY7_SLCR_FPGA_CLK_CTRL(unit));
301 source = (reg & ZY7_SLCR_FPGA_CLK_CTRL_SRCSEL_MASK) >>
302 ZY7_SLCR_FPGA_CLK_CTRL_SRCSEL_SHIFT;
304 /* ZY7_PL_FCLK_SRC_IO is actually b0x */
305 if ((source & 2) == 0)
306 source = ZY7_PL_FCLK_SRC_IO;
314 zy7_pl_fclk_set_freq(int unit, int frequency)
316 struct zy7_slcr_softc *sc = zy7_slcr_softc_p;
325 source = zy7_pl_fclk_get_source(unit);
327 case ZY7_PL_FCLK_SRC_IO:
328 base_frequency = io_pll_frequency;
331 case ZY7_PL_FCLK_SRC_ARM:
332 base_frequency = arm_pll_frequency;
335 case ZY7_PL_FCLK_SRC_DDR:
336 base_frequency = ddr_pll_frequency;
343 /* Find suitable divisor pairs. Round result to nearest khz
346 for (div1 = 1; div1 <= ZY7_SLCR_FPGA_CLK_CTRL_DIVISOR_MAX; div1++) {
347 div0 = (base_frequency + div1 * frequency / 2) /
349 if (div0 > 0 && div0 <= ZY7_SLCR_FPGA_CLK_CTRL_DIVISOR_MAX &&
350 ((base_frequency / div0 / div1) + 500) / 1000 ==
351 (frequency + 500) / 1000)
355 if (div1 > ZY7_SLCR_FPGA_CLK_CTRL_DIVISOR_MAX)
360 /* Unlock SLCR registers. */
363 /* Modify FPGAx reference clock. */
364 reg = RD4(sc, ZY7_SLCR_FPGA_CLK_CTRL(unit));
365 reg &= ~(ZY7_SLCR_FPGA_CLK_CTRL_DIVISOR1_MASK |
366 ZY7_SLCR_FPGA_CLK_CTRL_DIVISOR0_MASK);
367 reg |= (div1 << ZY7_SLCR_FPGA_CLK_CTRL_DIVISOR1_SHIFT) |
368 (div0 << ZY7_SLCR_FPGA_CLK_CTRL_DIVISOR0_SHIFT);
369 WR4(sc, ZY7_SLCR_FPGA_CLK_CTRL(unit), reg);
371 /* Lock SLCR registers. */
376 return (base_frequency / div0 / div1);
380 zy7_pl_fclk_get_freq(int unit)
382 struct zy7_slcr_softc *sc = zy7_slcr_softc_p;
392 source = zy7_pl_fclk_get_source(unit);
394 case ZY7_PL_FCLK_SRC_IO:
395 base_frequency = io_pll_frequency;
398 case ZY7_PL_FCLK_SRC_ARM:
399 base_frequency = arm_pll_frequency;
402 case ZY7_PL_FCLK_SRC_DDR:
403 base_frequency = ddr_pll_frequency;
412 /* Modify FPGAx reference clock. */
413 reg = RD4(sc, ZY7_SLCR_FPGA_CLK_CTRL(unit));
414 div1 = (reg & ZY7_SLCR_FPGA_CLK_CTRL_DIVISOR1_MASK) >>
415 ZY7_SLCR_FPGA_CLK_CTRL_DIVISOR1_SHIFT;
416 div0 = (reg & ZY7_SLCR_FPGA_CLK_CTRL_DIVISOR0_MASK) >>
417 ZY7_SLCR_FPGA_CLK_CTRL_DIVISOR0_SHIFT;
427 frequency = (base_frequency / div0 / div1);
429 frequency = (frequency + 500) / 1000;
430 frequency = frequency * 1000;
436 zy7_pl_fclk_enable(int unit)
438 struct zy7_slcr_softc *sc = zy7_slcr_softc_p;
445 /* Unlock SLCR registers. */
448 WR4(sc, ZY7_SLCR_FPGA_THR_CTRL(unit), 0);
449 WR4(sc, ZY7_SLCR_FPGA_THR_CNT(unit), 0);
451 /* Lock SLCR registers. */
460 zy7_pl_fclk_disable(int unit)
462 struct zy7_slcr_softc *sc = zy7_slcr_softc_p;
469 /* Unlock SLCR registers. */
472 WR4(sc, ZY7_SLCR_FPGA_THR_CTRL(unit), 0);
473 WR4(sc, ZY7_SLCR_FPGA_THR_CNT(unit), 1);
475 /* Lock SLCR registers. */
484 zy7_pl_fclk_enabled(int unit)
486 struct zy7_slcr_softc *sc = zy7_slcr_softc_p;
493 reg = RD4(sc, ZY7_SLCR_FPGA_THR_CNT(unit));
500 zy7_pl_level_shifters_enabled()
502 struct zy7_slcr_softc *sc = zy7_slcr_softc_p;
510 reg = RD4(sc, ZY7_SLCR_LVL_SHFTR_EN);
513 return (reg == ZY7_SLCR_LVL_SHFTR_EN_ALL);
517 zy7_pl_level_shifters_enable()
519 struct zy7_slcr_softc *sc = zy7_slcr_softc_p;
526 WR4(sc, ZY7_SLCR_LVL_SHFTR_EN, ZY7_SLCR_LVL_SHFTR_EN_ALL);
532 zy7_pl_level_shifters_disable()
534 struct zy7_slcr_softc *sc = zy7_slcr_softc_p;
541 WR4(sc, ZY7_SLCR_LVL_SHFTR_EN, 0);
547 zy7_slcr_probe(device_t dev)
550 if (!ofw_bus_status_okay(dev))
553 if (!ofw_bus_is_compatible(dev, "xlnx,zy7_slcr"))
556 device_set_desc(dev, "Zynq-7000 slcr block");
561 zy7_slcr_attach(device_t dev)
563 struct zy7_slcr_softc *sc = device_get_softc(dev);
569 uint32_t arm_pll_ctrl;
570 uint32_t ddr_pll_ctrl;
571 uint32_t io_pll_ctrl;
572 static char *bootdev_names[] = {
573 "JTAG", "Quad-SPI", "NOR", "(3?)",
574 "NAND", "SD Card", "(6?)", "(7?)"
577 /* Allow only one attach. */
578 if (zy7_slcr_softc_p != NULL)
585 /* Get memory resource. */
587 sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
589 if (sc->mem_res == NULL) {
590 device_printf(dev, "could not allocate memory resources.\n");
594 /* Hook up cpu_reset. */
595 zy7_slcr_softc_p = sc;
596 zynq7_cpu_reset = zy7_slcr_cpu_reset;
598 /* Read info and set sysctls. */
599 bootmode = RD4(sc, ZY7_SLCR_BOOT_MODE);
600 snprintf(zynq_bootmode, sizeof(zynq_bootmode),
601 "0x%x: boot device: %s", bootmode,
602 bootdev_names[bootmode & ZY7_SLCR_BOOT_MODE_BOOTDEV_MASK]);
604 pss_idcode = RD4(sc, ZY7_SLCR_PSS_IDCODE);
605 snprintf(zynq_pssid, sizeof(zynq_pssid),
606 "0x%x: manufacturer: 0x%x device: 0x%x "
607 "family: 0x%x sub-family: 0x%x rev: 0x%x",
609 (pss_idcode & ZY7_SLCR_PSS_IDCODE_MNFR_ID_MASK) >>
610 ZY7_SLCR_PSS_IDCODE_MNFR_ID_SHIFT,
611 (pss_idcode & ZY7_SLCR_PSS_IDCODE_DEVICE_MASK) >>
612 ZY7_SLCR_PSS_IDCODE_DEVICE_SHIFT,
613 (pss_idcode & ZY7_SLCR_PSS_IDCODE_FAMILY_MASK) >>
614 ZY7_SLCR_PSS_IDCODE_FAMILY_SHIFT,
615 (pss_idcode & ZY7_SLCR_PSS_IDCODE_SUB_FAMILY_MASK) >>
616 ZY7_SLCR_PSS_IDCODE_SUB_FAMILY_SHIFT,
617 (pss_idcode & ZY7_SLCR_PSS_IDCODE_REVISION_MASK) >>
618 ZY7_SLCR_PSS_IDCODE_REVISION_SHIFT);
620 zynq_reboot_status = RD4(sc, ZY7_SLCR_REBOOT_STAT);
622 /* Derive PLL frequencies from PS_CLK. */
623 node = ofw_bus_get_node(dev);
624 if (OF_getprop(node, "clock-frequency", &cell, sizeof(cell)) > 0)
625 ps_clk_frequency = fdt32_to_cpu(cell);
627 ps_clk_frequency = ZYNQ_DEFAULT_PS_CLK_FREQUENCY;
629 arm_pll_ctrl = RD4(sc, ZY7_SLCR_ARM_PLL_CTRL);
630 ddr_pll_ctrl = RD4(sc, ZY7_SLCR_DDR_PLL_CTRL);
631 io_pll_ctrl = RD4(sc, ZY7_SLCR_IO_PLL_CTRL);
633 /* Determine ARM PLL frequency. */
634 if (((arm_pll_ctrl & ZY7_SLCR_PLL_CTRL_BYPASS_QUAL) == 0 &&
635 (arm_pll_ctrl & ZY7_SLCR_PLL_CTRL_BYPASS_FORCE) != 0) ||
636 ((arm_pll_ctrl & ZY7_SLCR_PLL_CTRL_BYPASS_QUAL) != 0 &&
637 (bootmode & ZY7_SLCR_BOOT_MODE_PLL_BYPASS) != 0))
638 /* PLL is bypassed. */
639 arm_pll_frequency = ps_clk_frequency;
641 arm_pll_frequency = ps_clk_frequency *
642 ((arm_pll_ctrl & ZY7_SLCR_PLL_CTRL_FDIV_MASK) >>
643 ZY7_SLCR_PLL_CTRL_FDIV_SHIFT);
645 /* Determine DDR PLL frequency. */
646 if (((ddr_pll_ctrl & ZY7_SLCR_PLL_CTRL_BYPASS_QUAL) == 0 &&
647 (ddr_pll_ctrl & ZY7_SLCR_PLL_CTRL_BYPASS_FORCE) != 0) ||
648 ((ddr_pll_ctrl & ZY7_SLCR_PLL_CTRL_BYPASS_QUAL) != 0 &&
649 (bootmode & ZY7_SLCR_BOOT_MODE_PLL_BYPASS) != 0))
650 /* PLL is bypassed. */
651 ddr_pll_frequency = ps_clk_frequency;
653 ddr_pll_frequency = ps_clk_frequency *
654 ((ddr_pll_ctrl & ZY7_SLCR_PLL_CTRL_FDIV_MASK) >>
655 ZY7_SLCR_PLL_CTRL_FDIV_SHIFT);
657 /* Determine IO PLL frequency. */
658 if (((io_pll_ctrl & ZY7_SLCR_PLL_CTRL_BYPASS_QUAL) == 0 &&
659 (io_pll_ctrl & ZY7_SLCR_PLL_CTRL_BYPASS_FORCE) != 0) ||
660 ((io_pll_ctrl & ZY7_SLCR_PLL_CTRL_BYPASS_QUAL) != 0 &&
661 (bootmode & ZY7_SLCR_BOOT_MODE_PLL_BYPASS) != 0))
662 /* PLL is bypassed. */
663 io_pll_frequency = ps_clk_frequency;
665 io_pll_frequency = ps_clk_frequency *
666 ((io_pll_ctrl & ZY7_SLCR_PLL_CTRL_FDIV_MASK) >>
667 ZY7_SLCR_PLL_CTRL_FDIV_SHIFT);
669 /* Lock SLCR registers. */
676 zy7_slcr_detach(device_t dev)
678 struct zy7_slcr_softc *sc = device_get_softc(dev);
680 bus_generic_detach(dev);
682 /* Release memory resource. */
683 if (sc->mem_res != NULL)
684 bus_release_resource(dev, SYS_RES_MEMORY,
685 rman_get_rid(sc->mem_res), sc->mem_res);
687 zy7_slcr_softc_p = NULL;
688 zynq7_cpu_reset = NULL;
690 ZSLCR_LOCK_DESTROY(sc);
695 static device_method_t zy7_slcr_methods[] = {
697 DEVMETHOD(device_probe, zy7_slcr_probe),
698 DEVMETHOD(device_attach, zy7_slcr_attach),
699 DEVMETHOD(device_detach, zy7_slcr_detach),
704 static driver_t zy7_slcr_driver = {
707 sizeof(struct zy7_slcr_softc),
709 static devclass_t zy7_slcr_devclass;
711 DRIVER_MODULE(zy7_slcr, simplebus, zy7_slcr_driver, zy7_slcr_devclass, 0, 0);
712 MODULE_VERSION(zy7_slcr, 1);