litex/misoclib/mem/litesata/example_designs/make.py

#!/usr/bin/env python3

import sys, os, argparse, subprocess, struct, importlib

from mibuild.tools import write_to_file
from migen.util.misc import autotype
from migen.fhdl import verilog, edif
from migen.fhdl.structure import _Fragment
from migen.bank.description import CSRStatus
from mibuild import tools
from mibuild.xilinx.common import *

from misoclib.soc import cpuif
from misoclib.mem.litesata.common import *

def _import(default, name):
	return importlib.import_module(default + "." + name)

def _get_args():
	parser = argparse.ArgumentParser(formatter_class=argparse.RawDescriptionHelpFormatter,
		description="""\
LiteSATA - based on Migen.

This program builds and/or loads LiteSATA components.
One or several actions can be specified:

clean           delete previous build(s).
build-rtl       build verilog rtl.
build-bitstream build-bitstream build FPGA bitstream.
build-csr-csv   save CSR map into CSV file.

load-bitstream  load bitstream into volatile storage.

all             clean, build-csr-csv, build-bitstream, load-bitstream.
""")

	parser.add_argument("-t", "--target", default="bist", help="Core type to build")
	parser.add_argument("-s", "--sub-target", default="", help="variant of the Core type to build")
	parser.add_argument("-p", "--platform", default=None, help="platform to build for")
	parser.add_argument("-Ot", "--target-option", default=[], nargs=2, action="append", help="set target-specific option")
	parser.add_argument("-Op", "--platform-option", default=[("programmer", "vivado")], nargs=2, action="append", help="set platform-specific option")
	parser.add_argument("--csr_csv", default="./test/csr.csv", help="CSV file to save the CSR map into")

	parser.add_argument("action", nargs="+", help="specify an action")

	return parser.parse_args()

# Note: misoclib need to be installed as a python library

if __name__ == "__main__":
	args = _get_args()

	# create top-level Core object
	target_module = _import("targets", args.target)
	if args.sub_target:
		top_class = getattr(target_module, args.sub_target)
	else:
		top_class = target_module.default_subtarget

	if args.platform is None:
		platform_name = top_class.default_platform
	else:
		platform_name = args.platform
	platform_module = _import("platforms", platform_name)
	platform_kwargs = dict((k, autotype(v)) for k, v in args.platform_option)
	platform = platform_module.Platform(**platform_kwargs)

	build_name = top_class.__name__.lower() +  "-" + platform_name
	top_kwargs = dict((k, autotype(v)) for k, v in args.target_option)
	soc = top_class(platform, **top_kwargs)
	soc.finalize()

	# decode actions
	action_list = ["clean", "build-csr-csv", "build-core", "build-bitstream", "load-bitstream", "all"]
	actions = {k: False for k in action_list}
	for action in args.action:
		if action in actions:
			actions[action] = True
		else:
			print("Unknown action: "+action+". Valid actions are:")
			for a in action_list:
				print("  "+a)
			sys.exit(1)


	revision = soc.sata_phy.revision
	has_bist = hasattr(soc.sata, "bist")
	user_ports = len(soc.sata.crossbar.users)

	print("""
       __   _ __      _______ _________
      / /  (_) /____ / __/ _ /_  __/ _ |
     / /__/ / __/ -_)\ \/ __ |/ / / __ |
    /____/_/\__/\__/___/_/ |_/_/ /_/ |_|

A small footprint and configurable SATA core
             powered by Migen

====== Building options: ======
{} / {} Gbps
System Clk: {} MHz (min: {} MHz)
User ports: {}
BIST: {}
===============================""".format(
	revision.replace("sata_", "SATA "), bitrates[revision],
	soc.clk_freq/1000000, frequencies[revision],
	user_ports,
	has_bist
	)
)

	# dependencies
	if actions["all"]:
		actions["build-csr-csv"] = True
		actions["build-bitstream"] = True
		actions["load-bitstream"] = True

	if actions["build-bitstream"]:
		actions["build-csr-csv"] = True
		actions["build-bitstream"] = True
		actions["load-bitstream"] = True

	if actions["clean"]:
		subprocess.call(["rm", "-rf", "build/*"])

	if actions["build-csr-csv"]:
		csr_csv = cpuif.get_csr_csv(soc.csr_regions)
		write_to_file(args.csr_csv, csr_csv)

	if actions["build-core"]:
		ios = soc.get_ios()
		if not isinstance(soc, _Fragment):
			soc = soc.get_fragment()
		platform.finalize(soc)
		so = {
			NoRetiming:					XilinxNoRetiming,
			MultiReg:					XilinxMultiReg,
			AsyncResetSynchronizer:		XilinxAsyncResetSynchronizer
		}
		src = verilog.convert(soc, ios, special_overrides=so)
		tools.write_to_file("build/litesata.v", src)

	if actions["build-bitstream"]:
		vns = platform.build(soc, build_name=build_name, run=True)
		if hasattr(soc, "do_exit") and vns is not None:
			if hasattr(soc.do_exit, '__call__'):
				soc.do_exit(vns)

	if actions["load-bitstream"]:
		prog = platform.create_programmer()
		prog.load_bitstream("build/" + build_name + platform.bitstream_ext)