Files
tt-support-tools/tt_tool.py
T
Kristaps Jurkans 793d8ce282 feat(datasheet): add typst datasheet flow
This is a squash of 5 commits in order to add the new datasheet flow.

fix(datasheet): ensure datasheet can use images properly

fix(datasheet): white page when funding was not specified

This was caused by creating a page before first checking whether there was any content for that page beforehand, so it would result in a rogue white page with no content.

fix(datasheet): missing analog pin tables

fix(datasheet): tweak pandoc settings

Switching from `gfm` to `markdown` should enable more formatting options. The extensions have been configured to be similar to `gfm` but provide some additional things, like `line_blocks` and `lists_without_preceding_blankline`s.
2025-12-02 16:38:00 +00:00

184 lines
4.5 KiB
Python
Executable File

#!/usr/bin/env python3
import argparse
import logging
import sys
from project import Project
if __name__ == "__main__":
parser = argparse.ArgumentParser(description="TT setup")
parser.add_argument("--project-dir", help="location of the project", default=".")
parser.add_argument(
"--yaml", help="the project's yaml configuration file", default="info.yaml"
)
parser.add_argument(
"--debug",
help="debug logging",
action="store_const",
dest="loglevel",
const=logging.DEBUG,
default=logging.INFO,
)
parser.add_argument(
"--openlane2",
help="use openlane 2",
action="store_const",
const=True,
default=True,
)
parser.add_argument(
"--ihp",
help="use IHP PDK",
action="store_const",
const=True,
default=False,
)
# reports & summaries
parser.add_argument(
"--print-cell-summary",
help="print summary",
action="store_const",
const=True,
default=False,
)
parser.add_argument(
"--print-cell-category",
help="print category",
action="store_const",
const=True,
default=False,
)
parser.add_argument(
"--print-stats",
help="print some stats from the run",
action="store_const",
const=True,
)
parser.add_argument(
"--print-warnings", help="print any warnings", action="store_const", const=True
)
parser.add_argument(
"--print-wokwi-id",
help="prints the Wokwi project id",
action="store_const",
const=True,
)
parser.add_argument(
"--print-top-module",
help="prints the name of the top module",
action="store_const",
const=True,
)
# documentation
parser.add_argument(
"--check-docs",
help="check the documentation part of the yaml",
action="store_const",
const=True,
)
parser.add_argument(
"--create-pdf",
help="create a datasheet for the current project",
action="store_const",
const=True,
)
parser.add_argument(
"--template-version",
help="set typst template version (default 1.0.0)",
default="1.0.0",
nargs="?",
)
parser.add_argument(
"--create-svg",
help="create a svg of the GDS layout",
action="store_const",
const=True,
)
parser.add_argument(
"--create-png",
help="create a png of the GDS layout",
action="store_const",
const=True,
)
# configure
parser.add_argument(
"--create-user-config",
help="create the user_config.json file with top module and source files",
action="store_const",
const=True,
)
parser.add_argument(
"--harden",
help="use a local OpenLane install to harden the project",
action="store_const",
const=True,
)
# FPGA
parser.add_argument(
"--create-fpga-bitstream",
help="create the FPGA bitstream",
action="store_const",
const=True,
)
args = parser.parse_args()
# setup log
log_format = logging.Formatter(
"%(asctime)s - %(module)-10s - %(levelname)-8s - %(message)s"
)
# configure the client logging
log = logging.getLogger("")
# has to be set to debug as is the root logger
log.setLevel(args.loglevel)
# create console handler and set level to info
ch = logging.StreamHandler(sys.stdout)
# create formatter for console
ch.setFormatter(log_format)
log.addHandler(ch)
project = Project(0, "unknown", args.project_dir, args, is_user_project=True)
project.post_clone_setup()
# handle the options
if args.check_docs:
project.check_docs()
if args.print_cell_summary or args.print_cell_category:
project.summarize()
if args.print_stats:
project.print_stats()
if args.print_warnings:
project.print_warnings()
if args.print_wokwi_id:
project.print_wokwi_id()
if args.print_top_module:
project.print_top_module()
if args.create_user_config:
project.create_user_config()
if args.harden:
project.harden()
if args.create_pdf:
project.create_project_datasheet(args.template_version)
if args.create_png:
project.create_png()
if args.create_svg:
project.create_svg()
if args.create_fpga_bitstream:
project.create_fpga_bitstream()