#!/usr/bin/env python3 # # This file is part of LiteX-Boards. # # Copyright (c) 2022 Icenowy Zheng # Copyright (c) 2022 Florent Kermarrec # SPDX-License-Identifier: BSD-2-Clause from migen import * from migen.genlib.resetsync import AsyncResetSynchronizer from litex.gen import * from litex.soc.cores.clock.gowin_gw2a import GW2APLL from litex.soc.integration.soc_core import * from litex.soc.integration.soc import SoCRegion from litex.soc.integration.builder import * from litex.soc.cores.led import LedChaser, WS2812 from litex.soc.cores.gpio import GPIOIn from litex.soc.cores.video import * from liteeth.phy.rmii import LiteEthPHYRMII from litex_boards.platforms import sipeed_tang_primer_20k from litedram.common import PHYPadsReducer from litedram.modules import MT41K64M16 from litedram.phy import GW2DDRPHY # CRG ---------------------------------------------------------------------------------------------- class _CRG(LiteXModule): def __init__(self, platform, sys_clk_freq, with_video_pll=False, with_dram=False): self.rst = Signal() self.cd_sys = ClockDomain() self.cd_por = ClockDomain() if with_dram: self.cd_init = ClockDomain() self.cd_sys2x = ClockDomain() self.cd_sys2x_i = ClockDomain() # # # self.stop = Signal() self.reset = Signal() # Clk clk27 = platform.request("clk27") # Power on reset (the onboard POR is not aware of reprogramming) por_count = Signal(16, reset=2**16-1) por_done = Signal() self.comb += self.cd_por.clk.eq(clk27) self.comb += por_done.eq(por_count == 0) self.sync.por += If(~por_done, por_count.eq(por_count - 1)) # PLL self.pll = pll = GW2APLL(devicename=platform.devicename, device=platform.device) self.comb += pll.reset.eq(~por_done) pll.register_clkin(clk27, 27e6) if with_dram: # 2:1 clock needed for DDR pll.create_clkout(self.cd_sys2x_i, 2*sys_clk_freq) self.specials += [ Instance("DHCEN", i_CLKIN = self.cd_sys2x_i.clk, i_CE = self.stop, o_CLKOUT = self.cd_sys2x.clk), Instance("CLKDIV", p_DIV_MODE = "2", i_CALIB = 0, i_HCLKIN = self.cd_sys2x.clk, i_RESETN = ~self.reset, o_CLKOUT = self.cd_sys.clk), ] # Init clock domain self.comb += self.cd_init.clk.eq(clk27) self.comb += self.cd_init.rst.eq(pll.reset) else: pll.create_clkout(self.cd_sys, sys_clk_freq) self.specials += AsyncResetSynchronizer(self.cd_sys, ~pll.locked | self.rst | self.reset) # Video PLL if with_video_pll: self.video_pll = video_pll = GW2APLL(devicename=platform.devicename, device=platform.device) video_pll.register_clkin(clk27, 27e6) self.cd_hdmi = ClockDomain() self.cd_hdmi5x = ClockDomain() video_pll.create_clkout(self.cd_hdmi5x, 125e6, margin=1e-3) self.specials += Instance("CLKDIV", p_DIV_MODE = "5", i_RESETN = 1, # Disable reset signal. i_CALIB = 0, # No calibration. i_HCLKIN = self.cd_hdmi5x.clk, o_CLKOUT = self.cd_hdmi.clk ) # BaseSoC ------------------------------------------------------------------------------------------ class BaseSoC(SoCCore): def __init__(self, toolchain="gowin", sys_clk_freq=48e6, with_spi_flash = False, with_led_chaser = True, with_rgb_led = False, with_buttons = True, with_video_terminal = False, with_ethernet = False, with_etherbone = False, eth_ip = "192.168.1.50", remote_ip = None, eth_dynamic_ip = False, dock = "standard", **kwargs): assert dock in ["standard", "lite"] platform = sipeed_tang_primer_20k.Platform(dock, toolchain=toolchain) if dock == "lite": with_led_chaser = False # No leds on core board nor on dock lite. # CRG -------------------------------------------------------------------------------------- with_dram = (kwargs.get("integrated_main_ram_size", 0) == 0) assert not (toolchain == "apicula" and with_dram) self.crg = _CRG(platform, sys_clk_freq, with_video_pll=with_video_terminal, with_dram=with_dram) # SoCCore ---------------------------------------------------------------------------------- SoCCore.__init__(self, platform, sys_clk_freq, ident="LiteX SoC on Tang Primer 20K", **kwargs) # DDR3 SDRAM ------------------------------------------------------------------------------- if with_dram: self.ddrphy = GW2DDRPHY( pads = platform.request("ddram"), sys_clk_freq = sys_clk_freq ) self.ddrphy.settings.rtt_nom = "disabled" self.comb += self.crg.stop.eq(self.ddrphy.init.stop) self.comb += self.crg.reset.eq(self.ddrphy.init.reset) self.add_sdram("sdram", phy = self.ddrphy, module = MT41K64M16(sys_clk_freq, "1:2"), l2_cache_size = kwargs.get("l2_size", 8192) ) # SPI Flash -------------------------------------------------------------------------------- if with_spi_flash: from litespi.modules import W25Q32JV as SpiFlashModule from litespi.opcodes import SpiNorFlashOpCodes as Codes self.add_spi_flash(mode="1x", module=SpiFlashModule(Codes.READ_1_1_1)) # Ethernet / Etherbone --------------------------------------------------------------------- if with_ethernet or with_etherbone: from liteeth.phy.rmii import LiteEthPHYRMII self.ethphy = LiteEthPHYRMII( clock_pads = self.platform.request("eth_clocks"), pads = self.platform.request("eth"), refclk_cd = None ) if with_ethernet: self.add_ethernet(phy=self.ethphy, dynamic_ip = eth_dynamic_ip, local_ip = eth_ip, remote_ip = remote_ip, with_timing_constraints = False ) if with_etherbone: self.add_etherbone(phy=self.ethphy, ip_address=eth_ip, with_timing_constraints=False) # Video ------------------------------------------------------------------------------------ if with_video_terminal: hdmi_pads = platform.request("hdmi") self.comb += hdmi_pads.hdp.eq(1) self.videophy = VideoHDMIPHY(hdmi_pads, clock_domain="hdmi") #self.add_video_colorbars(phy=self.videophy, timings="640x480@60Hz", clock_domain="hdmi") self.add_video_terminal(phy=self.videophy, timings="640x480@75Hz", clock_domain="hdmi") # Leds ------------------------------------------------------------------------------------- if with_led_chaser: self.leds = LedChaser( pads = platform.request_all("led"), sys_clk_freq = sys_clk_freq ) # RGB Led ---------------------------------------------------------------------------------- if with_rgb_led: self.rgb_led = WS2812( pad = platform.request("rgb_led"), nleds = 1, sys_clk_freq = sys_clk_freq ) self.bus.add_slave(name="rgb_led", slave=self.rgb_led.bus, region=SoCRegion( origin = 0x2000_0000, size = 4, )) # Buttons ---------------------------------------------------------------------------------- if with_buttons: self.buttons = GPIOIn(pads=~platform.request_all("btn_n")) # Build -------------------------------------------------------------------------------------------- def main(): from litex.build.parser import LiteXArgumentParser parser = LiteXArgumentParser(platform=sipeed_tang_primer_20k.Platform, description="LiteX SoC on Tang Primer 20K.") parser.add_target_argument("--dock", default="standard", help="Dock version (standard (default) or lite.") parser.add_target_argument("--flash", action="store_true", help="Flash Bitstream.") parser.add_target_argument("--sys-clk-freq", default=48e6, type=float, help="System clock frequency.") sdopts = parser.target_group.add_mutually_exclusive_group() sdopts.add_argument("--with-spi-sdcard", action="store_true", help="Enable SPI-mode SDCard support.") sdopts.add_argument("--with-sdcard", action="store_true", help="Enable SDCard support.") parser.add_target_argument("--with-spi-flash", action="store_true", help="Enable SPI Flash (MMAPed).") parser.add_target_argument("--with-video-terminal", action="store_true", help="Enable Video Terminal (HDMI).") ethopts = parser.target_group.add_mutually_exclusive_group() ethopts.add_argument("--with-ethernet", action="store_true", help="Add Ethernet.") ethopts.add_argument("--with-etherbone", action="store_true", help="Add EtherBone.") parser.add_target_argument("--eth-ip", default="192.168.1.50", help="Etherbone IP address.") parser.add_target_argument("--remote-ip", default="192.168.1.100", help="Remote IP address of TFTP server.") parser.add_target_argument("--eth-dynamic-ip", action="store_true", help="Enable dynamic Ethernet IP addresses setting.") args = parser.parse_args() soc = BaseSoC( toolchain = args.toolchain, sys_clk_freq = args.sys_clk_freq, with_spi_flash = args.with_spi_flash, with_video_terminal = args.with_video_terminal, with_ethernet = args.with_ethernet, with_etherbone = args.with_etherbone, eth_ip = args.eth_ip, remote_ip = args.remote_ip, eth_dynamic_ip = args.eth_dynamic_ip, dock = args.dock, **parser.soc_argdict ) if args.with_spi_sdcard: soc.add_spi_sdcard() if args.with_sdcard: soc.add_sdcard() builder = Builder(soc, **parser.builder_argdict) if args.build: builder.build(**parser.toolchain_argdict) if args.load: prog = soc.platform.create_programmer() prog.load_bitstream(builder.get_bitstream_filename(mode="sram")) if args.flash: prog = soc.platform.create_programmer() prog.flash(0, builder.get_bitstream_filename(mode="flash", ext=".fs"), external=True) if __name__ == "__main__": main()