opencos-eda 0.2.36__py3-none-any.whl → 0.2.39__py3-none-any.whl

opencos/tools/yosys.py

@@ -5,6 +5,7 @@ Contains classes for ToolYosys
 
 # pylint: disable=R0801 # (calling functions with same arguments)
 
+import os
 import shutil
 import subprocess
 
@@ -84,15 +85,44 @@ class CommonSynthYosys(CommandSynth, ToolYosys):
         ToolYosys.__init__(self, config=self.config)
 
         self.args.update({
+            'sta': False,
+            'liberty-file': '',
+            'sdc-file': '',
             'yosys-synth': 'synth',              # synth_xilinx, synth_altera, etc (see: yosys help)
             'yosys-pre-synth': ['prep', 'proc'], # command run in yosys prior to yosys-synth.
             'yosys-blackbox': [],                # list of modules that yosys will blackbox.
         })
+        self.args_help.update({
+            'sta': 'After running Yosys, run "sta" with --liberty-file.' \
+            + ' sta can be installed via: https://github.com/The-OpenROAD-Project/OpenSTA',
+            'sdc-file': '.sdc file to use with --sta, if not present will use auto constraints',
+            'liberty-file': 'Single liberty file for synthesis and sta,' \
+            + ' for example: github/OpenSTA/examples/nangate45_slow.lib.gz',
+            'yosys-synth': 'The synth command provided to Yosys, see: yosys help.',
+            'yosys-pre-synth': 'Yosys commands performed prior to running "synth"' \
+            + ' (or eda arg value for --yosys-synth)',
+            'yosys-blackbox': 'List of modules that yosys will blackbox, likely will need these' \
+            + ' in Verilog-2001 for yosys to read outside of slang and synth',
+        })
+
+        self.yosys_out_dir = ''
+        self.yosys_v_path = ''
+        self.full_work_dir = ''
+        self.blackbox_list = []
 
     def do_it(self) -> None:
         self.set_tool_defines()
         self.write_eda_config_and_args()
 
+        # Set up some dirs and filenames.
+        self.full_work_dir = self.args.get('work-dir', '')
+        if not self.full_work_dir:
+            self.error(f'work_dir={self.full_work_dir} is not set')
+        self.full_work_dir = os.path.abspath(self.full_work_dir)
+        self.yosys_out_dir = os.path.join(self.full_work_dir, 'yosys')
+        util.safe_mkdir(self.yosys_out_dir)
+        self.yosys_v_path = os.path.join(self.yosys_out_dir, f'{self.args["top"]}.v')
+
         if self.is_export_enabled():
             self.do_export()
             return
@@ -102,3 +132,108 @@ class CommonSynthYosys(CommandSynth, ToolYosys):
     def write_and_run_yosys_f_files(self, **kwargs) -> None:
         '''Derived classes must define, to run remainder of do_it() steps'''
         raise NotImplementedError
+
+
+    def create_yosys_synth_f(self) -> util.ShellCommandList:
+        '''Derived classes may define, if they wish to get a list of yosys commands'''
+        return util.ShellCommandList([])
+
+
+    def get_synth_command_lines(self) -> list:
+        '''Common yosys tcl after all blackbox and read_verilog commands'''
+
+        lines = []
+        lines += self.args.get('yosys-pre-synth', [])
+
+        synth_command = self.args.get('yosys-synth', 'synth')
+        if self.args['flatten-all']:
+            synth_command += ' -flatten'
+
+        lines.append(synth_command)
+
+
+        # TODO(drew): I need a blackbox flow here? Or a memory_libmap?
+        #   --> https://yosyshq.readthedocs.io/projects/yosys/en/latest/cmd/memory_libmap.html
+        # TODO(drew): can I run multiple liberty files?
+        if self.args['liberty-file']:
+            lines += [
+                'dfflibmap -liberty ' + self.args['liberty-file'],
+                #'memory_libmap -lib ' + self.args['liberty-file'], # Has to be unzipped?
+                'abc -liberty  ' + self.args['liberty-file'],
+            ]
+        lines += [
+            'opt_clean',
+            f'write_verilog {self.yosys_v_path}',
+            f'write_json {self.yosys_v_path}.json',
+        ]
+        return lines
+
+
+    def create_sta_f(self) -> util.ShellCommandList:
+        '''Returns command list, for running 'sta' on sta.f'''
+
+        if not self.args['sta']:
+            return []
+
+        if not self.args['liberty-file']:
+            self.error('--sta is set, but need to also set --liberty-file=<file>')
+
+        if self.args['sdc-file']:
+            if not os.path.exists(self.args['sdc-file']):
+                self.error(f'--sdc-file={self.args["sdc-file"]} file does not exist')
+
+        if not self.sta_exe:
+            self.error(f'--sta is set, but "sta" was not found in PATH, see: {self._URL}')
+
+        sta_command_list = util.ShellCommandList(
+            [ self.sta_exe, '-no_init', '-exit', 'sta.f' ],
+            tee_fpath = 'sta.log'
+        )
+
+        # Need to create sta.f:
+        if self.args['sdc-file']:
+            sdc_path = self.args['sdc-file']
+        else:
+            # Need to create sdc.f:
+            sdc_path = 'sdc.f'
+            self.create_sdc_f()
+
+        with open(os.path.join(self.args['work-dir'], 'sta.f'), 'w',
+                  encoding='utf-8') as f:
+            lines = [
+                'read_liberty ' + self.args['liberty-file'],
+                'read_verilog ' + self.yosys_v_path,
+                'link_design ' + self.args['top'],
+                'read_sdc ' + sdc_path,
+                'report_checks',
+            ]
+            f.write('\n'.join(lines))
+
+        return util.ShellCommandList(
+            sta_command_list,
+            tee_fpath = 'sta.log'
+        )
+
+
+    def create_sdc_f(self) -> None:
+        '''Returns None, creates sdc.f'''
+
+        if self.args['sdc-file']:
+            # already exists from args, return b/c nothing to create.
+            return
+
+        with open(os.path.join(self.args['work-dir'], 'sdc.f'), 'w',
+                  encoding='utf-8') as f:
+            clock_name = self.args['clock-name']
+            period = self.args['clock-ns']
+            name_not_equal_clocks_str = f'NAME !~ "{clock_name}"'
+            lines = [
+                f'create_clock -add -name {clock_name} -period {period} [get_ports ' \
+                + '{' + clock_name + '}];',
+                f'set_input_delay -max {self.args["idelay-ns"]} -clock {clock_name}' \
+                + ' [get_ports * -filter {DIRECTION == IN && ' \
+                + name_not_equal_clocks_str + '}];',
+                f'set_output_delay -max {self.args["odelay-ns"]} -clock {clock_name}' \
+                + ' [get_ports * -filter {DIRECTION == OUT}];',
+            ]
+            f.write('\n'.join(lines))

{opencos_eda-0.2.36.dist-info → opencos_eda-0.2.39.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.36
+Version: 0.2.39
 Summary: A simple Python package for wrapping RTL simuliatons and synthesis
 Author-email: Simon Sabato <simon@cognichip.ai>, Drew Ranck <drew@cognichip.ai>
 Project-URL: Homepage, https://github.com/cognichip/opencos

{opencos_eda-0.2.36.dist-info → opencos_eda-0.2.39.dist-info}/RECORD

@@ -3,44 +3,45 @@ opencos/_version.py,sha256=qN7iBoOv-v4tEZz-Pu9sVUJwefshJOsgdaddn8HcHio,510
 opencos/_waves_pkg.sv,sha256=1lbhQOVGc3t_R8czYjP40hssP0I3FlZOpHTkI7yKFbI,1251
 opencos/deps_helpers.py,sha256=Pgo3dO_QBHzGB0lE2B0uf2vWWDy3dSDN0pvW-eA6ocs,56939
 opencos/deps_schema.py,sha256=MhytzXwp071F14RwxqHt78ak8Qruoe4FeK5XSzkO2f0,14658
-opencos/eda.py,sha256=NCsSAnWANumzP2EzlsT-TvGUEuY8ONpHo-cvTcWC2wM,21261
-opencos/eda_base.py,sha256=Fi21IIKvYIzyj_vQtaqPwrUXDaszfIixoB80-TQMM2k,77455
-opencos/eda_config.py,sha256=CXfFVW4QOtP1gpMcX8JhCe93_aibcdbGoS7RAiYQnOs,8561
-opencos/eda_config_defaults.yml,sha256=4ryY9THfaeL2kclo5KLkC7F1_g7FbjVzDMQFdAsvTl0,9195
+opencos/eda.py,sha256=k0_7ppBBPFsQ8Jd0mJGOnc6llUNo2hryHwx8DZ_B_jU,18832
+opencos/eda_base.py,sha256=hpkcylto5V4WUZkA-R39ZeB3aKFplTuX82eX7d1gUbk,81657
+opencos/eda_config.py,sha256=FVp-dg9IVq78LZoh43kFYo9WXKfFxsMQMo6JGulEbEM,8818
+opencos/eda_config_defaults.yml,sha256=0tqs4paxCYZJshb2WW2GfaZyeh_l9ZUKWMh8hh17AWk,10235
 opencos/eda_config_max_verilator_waivers.yml,sha256=lTAU4IOEbUWVlPzuer1YYhIyxpPINeA4EJqcRIT-Ymk,840
-opencos/eda_config_reduced.yml,sha256=2mV9CiUEj_tyJnQsC9_k0RlxuBrky0zW1HX2xlDVEjU,1469
-opencos/eda_deps_bash_completion.bash,sha256=BmCZNnRBioiPf93qwjtOmIPdDeHes0ojS_s_k4jhMoo,1950
-opencos/eda_extract_targets.py,sha256=Qc4IEx82ZNY2bLNYY0htpB4XLT-Mr2JQfPriyRigWkI,3467
+opencos/eda_config_reduced.yml,sha256=cQ9jY4J7EvAbeHTiP6bvpDSVJAYiitjLZPSxxLKIEbk,1440
+opencos/eda_deps_bash_completion.bash,sha256=jMkQKY82HBgOnQeMdA1hMrXguRFtB52SMBxUemKovL4,1958
+opencos/eda_extract_targets.py,sha256=LLf8pGia0HxqXQFRck0E990EchbEdiFTC1fQyA8FZqs,4101
 opencos/eda_tool_helper.py,sha256=MxNd_ImyA13DZbzMol1R5H8tJZddJfqyDgFVR2ad374,1666
 opencos/export_helper.py,sha256=2SfzHM3m6b5Wh-OMgRWv5I_A95MHIYBn8-H_P3YC7ZQ,19680
 opencos/export_json_convert.py,sha256=KsP1ESmSWs8ouecDC5ikuwOFZNJtLjmiYOvYLeN5UZU,3768
-opencos/files.py,sha256=IB-hTRrVQx884GNqdJX1V1ikSRUS1Vwu-B3yX0AN6FI,1495
+opencos/files.py,sha256=z7HYk5j7cMyjK8e25xzCyyUzOnj9iZt9IpGJibbbh-U,1495
 opencos/names.py,sha256=LMhAE5UH5LEy4zqHp3rOe6tP26i_Dka6JOJzKMo_bkg,1201
 opencos/oc_cli.py,sha256=kj2OXvgxli2WPj4MQ4zTBb36eFtsP2gsqDdeNeWGL4E,132108
 opencos/pcie.py,sha256=VUJljaZJYgScAAx5yn7F6GoA8K9eTcw24otYZbkMpYs,3035
 opencos/peakrdl_cleanup.py,sha256=vLhSOVs6cEzsi_PwAP4pSXu5_ZMZjDvfK_WmHDLbDac,486
 opencos/seed.py,sha256=8TA2uXhBuT_lOaQdAKqdReYvfBWi_KuyQCFJzA2rOVM,549
 opencos/util.py,sha256=3rADW0tUzq69wdHsa2GB060N1jCAK2Dk0NLx6N6BMcc,27861
-opencos/commands/__init__.py,sha256=cHermtb27ZOUurW1UIGarQIJihH1oJvpFWwUbk6q2i0,858
+opencos/commands/__init__.py,sha256=d-8heMkBjjm6_yeduZgUv34lPfHVpj9MWP1ifpdjJws,916
 opencos/commands/build.py,sha256=jI5ul53qfwn6X-yfSdSQIcLBhGtzZUk7r_wKBBmKJI0,1425
 opencos/commands/elab.py,sha256=m6Gk03wSzX8UkcmReooK7turF7LpqO0IcdOZwJ8XiyI,1596
 opencos/commands/export.py,sha256=uGDI5_lUhyNB54gFjm9cWv9g_3waEOJN4wOC01oFlCY,3535
 opencos/commands/flist.py,sha256=rylcisH3X6UZGQY8WkSGHHIYWKi6o-JwtITz7gflsbY,8460
-opencos/commands/multi.py,sha256=__UF5If4WIY_9044gcGEQiU8MTGPro-q3kzQ4v0PMdI,26283
+opencos/commands/multi.py,sha256=1IH5Bk5xnKsNvtEsYy8a6bFmcyHSfrMVK-lLNdj6vlg,26449
 opencos/commands/open.py,sha256=unrpGckzg0FE5W3oARq8x0jX7hhV_uM9Oh5FgISHFAg,724
 opencos/commands/proj.py,sha256=MdHTOtQYG93_gT97dWuSyAgUxX2vi9FRhL0dtc-rM98,1096
 opencos/commands/sim.py,sha256=phATz_wR0BAH6B_IJ4zyzg_Hptp5hSEOe_-9NLaL_bY,14058
-opencos/commands/sweep.py,sha256=L4AYF3vQHR-fi0871f1CwrD0y4tydrsNpWSDjVf1xIA,8719
+opencos/commands/sweep.py,sha256=O0VSpzHHlE_1hM-Edp4d80PAnh2P2HCIwsGLnhkRHWM,9107
 opencos/commands/synth.py,sha256=quB-HWS4LKYTiFBHiYarQi4pMnRmt12wQTZpi14VvlE,4355
+opencos/commands/targets.py,sha256=_jRNhm2Fqj0fmMvTw6Ba39DCsRHf_r_uZCy_R064kpA,1472
 opencos/commands/upload.py,sha256=nlb4nlxrDCQPcabEmH3nP19g4PFILDqFDab4LwJ95Z4,796
 opencos/commands/waves.py,sha256=SRfjfsqhuszXHylQrgqYiUT3a5CQs9doxJQzuV4Ae0w,7055
 opencos/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 opencos/tests/custom_config.yml,sha256=TRoVM9ZFKPOA_8JmlpzaMhnGO1txmaD14N_8P1oqzew,257
-opencos/tests/helpers.py,sha256=M_XwM1vQmcrVEgfvpL7C23VPjiFhPpsCqhAH5ZZqAT4,8211
+opencos/tests/helpers.py,sha256=zzQQP8ZeNUwrvJRQVlpTnvz9yxFG0Jfuss50ZPjxa-c,8240
 opencos/tests/test_build.py,sha256=FQAxOpLVQShAHD_L5rqJctPeSAoqoOCNFI0RXflLuY0,387
 opencos/tests/test_deps_helpers.py,sha256=_nJSgLN6WVlMKqu6sCr29gjQyN3Jj-dVk8Ac64ygpJs,5928
 opencos/tests/test_deps_schema.py,sha256=mWTWI4wriGXC8UAnaeq_MIvWJOvf08-fPUqUgELptQ4,896
-opencos/tests/test_eda.py,sha256=HCUGCg9yVILIIyyey2XArllgtBV5XHeVVnL5AGglO7I,37786
+opencos/tests/test_eda.py,sha256=eraWvyJJHrlq4CVoeWakYckRG8RRUYtecJRzlcXX45Q,38545
 opencos/tests/test_eda_elab.py,sha256=75bJpOaoO8rn1FXFxiE4KSu5FdjZP1IbW6SyTCjM_ao,2553
 opencos/tests/test_eda_synth.py,sha256=C_1LzblTuK_lHFv_Hh8v3DKUN4hGfxoChYR77GricX4,2871
 opencos/tests/test_oc_cli.py,sha256=-ZmwVX_CPBXCGT9hXIBEr_XUSIGG2eky89YpSJIbRAg,731
@@ -53,23 +54,23 @@ opencos/tests/deps_files/non_sv_reqs/DEPS.yml,sha256=VZkahO1AKhD9GUV5lK8VwUONEi5
 opencos/tests/deps_files/tags_with_tools/DEPS.yml,sha256=-5U1qfJElgpVhmkLEu3lYuvDYva8kDlt6JOdB9jidmc,1377
 opencos/tests/deps_files/test_err_fatal/DEPS.yml,sha256=GnXIUJvshQWR9PlYxX67T53ejf5KhDbtD8sUJB4Rwd0,95
 opencos/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-opencos/tools/invio.py,sha256=xAkYkMFKIUZDU1PkHeydDuPFjpEF_TN-1uYv7ErH4hY,3296
+opencos/tools/invio.py,sha256=q9E9n6xsozDfar-1rLvJEZbCpPb_bQEy6WKEI3KS3dk,3163
 opencos/tools/invio_helpers.py,sha256=1au4CYmV5aC7DHjaZBNemydH6Eq0i-Yt5L3HyKfQOfY,7638
-opencos/tools/invio_yosys.py,sha256=a7GGuPgxyilves_EjE1DSZqetPr7n0fcQC-xxrzjqag,5714
-opencos/tools/iverilog.py,sha256=1SmkJAtG096ozIY6N19UtpD-YT1UKJAcMLJ9blfraP0,6413
-opencos/tools/modelsim_ase.py,sha256=x5xFWBNaln2lVLixN0Od0uNaLKN_Bt1q6a91QmhKoNA,13162
+opencos/tools/invio_yosys.py,sha256=4zWBeFKXHSyb5WSnf6ZpVG2UwoKF0SC-00I1_VqgXZM,6016
+opencos/tools/iverilog.py,sha256=oPaR654-3EHjyb6_r9Nj9VVaHrDAX7kSKztBAQRvNHU,6502
+opencos/tools/modelsim_ase.py,sha256=Y2Y-xC3ktby6z-dE3iipuqPkNl8eCmdi2Hb9mcwJTHA,13218
 opencos/tools/questa.py,sha256=AX_3USyf6eMcssH4b-8WLbCzz-cXYnQzlHvCyL9C7Og,7505
 opencos/tools/slang.py,sha256=74EDAAnN7mrrYxgxaPDaoRJZK7Se9B_HsW8Ioi2Nw44,7425
-opencos/tools/slang_yosys.py,sha256=8zLwScd3PjouuLQpLvpX837kGqYQiJ9bnButCwrmSqI,15047
+opencos/tools/slang_yosys.py,sha256=mw4AfutGjKyCj7NLrHDy2j3p0XC2H7uuBf9RkVQJYoQ,9856
 opencos/tools/surelog.py,sha256=JOMs8SqnzJ_ZL5mEdyyn3Z1r1Kc8hfbV3Pnen1YzxWA,4980
 opencos/tools/tabbycad_yosys.py,sha256=h9kkAi479cZzYfb4R9WBNY_JmR6BgVFj4s3VShnGpoA,7813
-opencos/tools/verilator.py,sha256=0ZHAkkUqnsM1A4B8-u6tff3lhl-cgfDUx-Dq7DaRwkI,18080
-opencos/tools/vivado.py,sha256=cL5IZdudqquddvZqHQGDVmaHSxgBZsMUmAq18q8AgoM,39134
-opencos/tools/yosys.py,sha256=Nov3zKyliZ6rHwMbH4f8XEkoo9H66T2-MN-KNQTjWFk,3530
-opencos_eda-0.2.36.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-opencos_eda-0.2.36.dist-info/licenses/LICENSE.spdx,sha256=8gn1610RMP6eFgT3Hm6q9VKXt0RvdTItL_oxMo72jII,189
-opencos_eda-0.2.36.dist-info/METADATA,sha256=bcp36pjsJ-jZgB8xXIiaYRKT86yOHYl_cBgKHaMVDDI,604
-opencos_eda-0.2.36.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-opencos_eda-0.2.36.dist-info/entry_points.txt,sha256=V8OE1lySAFcFQpDNJuVxVZteeSmDH-joLMhGvrxrvmg,164
-opencos_eda-0.2.36.dist-info/top_level.txt,sha256=J4JDP-LpRyJqPNeh9bSjx6yrLz2Mk0h6un6YLmtqql4,8
-opencos_eda-0.2.36.dist-info/RECORD,,
+opencos/tools/verilator.py,sha256=lxR7BSmeTc6YcL0UuXzIfJk7umVm8RfbU8rtYtbKUBg,18192
+opencos/tools/vivado.py,sha256=1dbQ-5oUUaUNIeMp07HArWG15spG81OuCwJ88qRNXU0,39102
+opencos/tools/yosys.py,sha256=aZnRFbsODYRe4BHbfxl6vfWeEP7WJYJk50gCZcn8Fu0,8902
+opencos_eda-0.2.39.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+opencos_eda-0.2.39.dist-info/licenses/LICENSE.spdx,sha256=8gn1610RMP6eFgT3Hm6q9VKXt0RvdTItL_oxMo72jII,189
+opencos_eda-0.2.39.dist-info/METADATA,sha256=C0mlmBaoqZTDtiqGpFH68SsN-i_XBG8505L2MIiUXcE,604
+opencos_eda-0.2.39.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+opencos_eda-0.2.39.dist-info/entry_points.txt,sha256=V8OE1lySAFcFQpDNJuVxVZteeSmDH-joLMhGvrxrvmg,164
+opencos_eda-0.2.39.dist-info/top_level.txt,sha256=J4JDP-LpRyJqPNeh9bSjx6yrLz2Mk0h6un6YLmtqql4,8
+opencos_eda-0.2.39.dist-info/RECORD,,