make.py

   1 #!/usr/bin/env python3
   2
   3 import sys, os, argparse, subprocess, struct
   4
   5 from mibuild.tools import write_to_file
   6 from migen.util.misc import autotype
   7 from migen.fhdl import simplify
   8
   9 from misoclib.gensoc import cpuif
  10 from misoclib.sdram.phy import initsequence
  11
  12 from misoc_import import misoc_import
  13
  14 def _get_args():
  15         parser = argparse.ArgumentParser(formatter_class=argparse.RawDescriptionHelpFormatter,
  16                 description="""\
  17 MiSoC - a high performance and small footprint SoC based on Migen.
  18
  19 This program builds and/or loads MiSoC components.
  20 One or several actions can be specified:
  21
  22 clean           delete previous build(s).
  23 build-bitstream build FPGA bitstream. Implies build-bios on targets with
  24                 integrated BIOS.
  25 build-headers   build software header files with CPU/CSR/IRQ/SDRAM_PHY definitions.
  26 build-csr-csv   save CSR map into CSV file.
  27 build-bios      build BIOS. Implies build-header.
  28
  29 load-bitstream  load bitstream into volatile storage.
  30 flash-bitstream load bitstream into non-volatile storage.
  31 flash-bios      load BIOS into non-volatile storage.
  32
  33 all             clean, build-bitstream, build-bios, flash-bitstream, flash-bios.
  34
  35 Load/flash actions use the existing outputs, and do not trigger new builds.
  36 """)
  37
  38         parser.add_argument("-t", "--target", default="mlabs_video", help="SoC type to build")
  39         parser.add_argument("-s", "--sub-target", default="", help="variant of the SoC type to build")
  40         parser.add_argument("-p", "--platform", default=None, help="platform to build for")
  41         parser.add_argument("-Ot", "--target-option", default=[], nargs=2, action="append", help="set target-specific option")
  42         parser.add_argument("-Op", "--platform-option", default=[], nargs=2, action="append", help="set platform-specific option")
  43         parser.add_argument("-X", "--external", default="", help="use external directory for targets, platforms and imports")
  44         parser.add_argument("--csr_csv", default="csr.csv", help="CSV file to save the CSR map into")
  45
  46         parser.add_argument("-d", "--decorate", default=[], action="append", help="apply simplification decorator to top-level")
  47         parser.add_argument("-Ob", "--build-option", default=[], nargs=2, action="append", help="set build option")
  48         parser.add_argument("-f", "--flash-proxy-dir", default=None, help="set search directory for flash proxy bitstreams")
  49
  50         parser.add_argument("action", nargs="+", help="specify an action")
  51
  52         return parser.parse_args()
  53
  54 if __name__ == "__main__":
  55         args = _get_args()
  56
  57         external_target = ""
  58         external_platform = ""
  59         if args.external:
  60                 external_target = os.path.join(args.external, "targets")
  61                 external_platform = os.path.join(args.external, "platforms")
  62                 sys.path.insert(1, os.path.abspath(args.external))
  63
  64         # create top-level SoC object
  65         target_module = misoc_import("targets", external_target, args.target)
  66         if args.sub_target:
  67                 top_class = getattr(target_module, args.sub_target)
  68         else:
  69                 top_class = target_module.default_subtarget
  70
  71         if args.platform is None:
  72                 platform_name = top_class.default_platform
  73         else:
  74                 platform_name = args.platform
  75         platform_module = misoc_import("mibuild.platforms", external_platform, platform_name)
  76         platform_kwargs = dict((k, autotype(v)) for k, v in args.platform_option)
  77         platform = platform_module.Platform(**platform_kwargs)
  78         if args.external:
  79                 platform.soc_ext_path = os.path.abspath(args.external)
  80
  81         build_name = top_class.__name__.lower() + "-" + platform_name
  82         top_kwargs = dict((k, autotype(v)) for k, v in args.target_option)
  83         soc = top_class(platform, **top_kwargs)
  84         soc.finalize()
  85
  86         # decode actions
  87         action_list = ["clean", "build-bitstream", "build-headers", "build-csr-csv", "build-bios",
  88                 "load-bitstream", "flash-bitstream", "flash-bios", "all"]
  89         actions = {k: False for k in action_list}
  90         for action in args.action:
  91                 if action in actions:
  92                         actions[action] = True
  93                 else:
  94                         print("Unknown action: "+action+". Valid actions are:")
  95                         for a in action_list:
  96                                 print("  "+a)
  97                         sys.exit(1)
  98
  99         print("""\
 100                 __  ___  _   ____     _____
 101                /  |/  / (_) / __/__  / ___/
 102               / /|_/ / / / _\ \/ _ \/ /__
 103              /_/  /_/ /_/ /___/\___/\___/
 104
 105 a high performance and small footprint SoC based on Migen
 106
 107 ====== Building for: ======
 108 Platform:  {}
 109 Target:    {}
 110 Subtarget: {}
 111 CPU type:  {}
 112 ===========================""".format(platform_name, args.target, top_class.__name__, soc.cpu_type))
 113
 114         # dependencies
 115         if actions["all"]:
 116                 actions["clean"] = True
 117                 actions["build-bitstream"] = True
 118                 actions["build-bios"] = True
 119                 actions["flash-bitstream"] = True
 120                 actions["flash-bios"] = True
 121         if actions["build-bitstream"] and hasattr(soc, "init_bios_memory"):
 122                 actions["build-bios"] = True
 123         if actions["build-bios"]:
 124                 actions["build-headers"] = True
 125
 126         if actions["clean"]:
 127                 subprocess.call(["rm", "-rf", "build/*"])
 128                 subprocess.call(["make", "-C", "software/libcompiler-rt", "clean"])
 129                 subprocess.call(["make", "-C", "software/libbase", "clean"])
 130                 subprocess.call(["make", "-C", "software/libnet", "clean"])
 131                 subprocess.call(["make", "-C", "software/bios", "clean"])
 132
 133         if actions["build-headers"]:
 134                 boilerplate = """/*
 135  * Platform:  {}
 136  * Target:    {}
 137  * Subtarget: {}
 138  * CPU type:  {}
 139  */
 140
 141 """.format(platform_name, args.target, top_class.__name__, soc.cpu_type)
 142                 cpu_mak = cpuif.get_cpu_mak(soc.cpu_type)
 143                 write_to_file("software/include/generated/cpu.mak", cpu_mak)
 144                 linker_output_format = cpuif.get_linker_output_format(soc.cpu_type)
 145                 write_to_file("software/include/generated/output_format.ld", linker_output_format)
 146
 147                 linker_regions = cpuif.get_linker_regions(soc.cpu_memory_regions)
 148                 write_to_file("software/include/generated/regions.ld", boilerplate + linker_regions)
 149                 try:
 150                         flash_boot_address = soc.flash_boot_address
 151                 except AttributeError:
 152                         flash_boot_address = None
 153                 mem_header = cpuif.get_mem_header(soc.cpu_memory_regions, flash_boot_address)
 154                 write_to_file("software/include/generated/mem.h", boilerplate + mem_header)
 155                 csr_header = cpuif.get_csr_header(soc.cpu_csr_regions, soc.interrupt_map)
 156                 write_to_file("software/include/generated/csr.h", boilerplate + csr_header)
 157                 for sdram_phy in ["sdrphy", "ddrphy"]:
 158                         if hasattr(soc, sdram_phy):
 159                                 sdram_phy_header = initsequence.get_sdram_phy_header(getattr(soc, sdram_phy))
 160                                 write_to_file("software/include/generated/sdram_phy.h", boilerplate + sdram_phy_header)
 161
 162         if actions["build-csr-csv"]:
 163                 csr_csv = cpuif.get_csr_csv(soc.cpu_csr_regions)
 164                 write_to_file(args.csr_csv, csr_csv)
 165
 166         if actions["build-bios"]:
 167                 ret = subprocess.call(["make", "-C", "software/bios"])
 168                 if ret:
 169                         raise OSError("BIOS build failed")
 170
 171         if actions["build-bitstream"]:
 172                 if hasattr(soc, "init_bios_memory"):
 173                         with open("software/bios/bios.bin", "rb") as bios_file:
 174                                 bios_data = []
 175                                 while True:
 176                                         w = bios_file.read(4)
 177                                         if not w:
 178                                                 break
 179                                         bios_data.append(struct.unpack(">I", w)[0])
 180                         soc.init_bios_memory(bios_data)
 181
 182                 for decorator in args.decorate:
 183                         soc = getattr(simplify, decorator)(soc)
 184                 build_kwargs = dict((k, autotype(v)) for k, v in args.build_option)
 185                 vns = platform.build(soc, build_name=build_name, **build_kwargs)
 186                 soc.do_exit(vns)
 187
 188         if actions["load-bitstream"] or actions["flash-bitstream"] or actions["flash-bios"]:
 189                 prog = platform.create_programmer()
 190                 if actions["load-bitstream"]:
 191                         prog.load_bitstream("build/" + build_name + platform.bitstream_ext)
 192                 if actions["flash-bitstream"]:
 193                         prog.set_flash_proxy_dir(args.flash_proxy_dir)
 194                         if prog.needs_bitreverse:
 195                                 flashbit = "build/" + build_name + ".fpg"
 196                                 subprocess.call(["tools/byteswap",
 197                                         "build/" + build_name + ".bin",
 198                                         flashbit])
 199                         else:
 200                                 flashbit = "build/" + build_name + ".bin"
 201                         prog.flash(0, flashbit)
 202                 if actions["flash-bios"]:
 203                         prog.set_flash_proxy_dir(args.flash_proxy_dir)
 204                         prog.flash(soc.cpu_reset_address, "software/bios/bios.bin")