switchboard-hw 0.3.0__cp314-cp314-macosx_11_0_arm64.whl

switchboard/sbtcp.py

@@ -0,0 +1,345 @@
+#!/usr/bin/env python3
+
+# Command-line tool that bridges Switchboard packets over TCP.
+
+# Copyright (c) 2024 Zero ASIC Corporation
+# This code is licensed under Apache License 2.0 (see LICENSE for details)
+
+# reference for setting up Python TCP connections:
+# https://realpython.com/python-sockets/#echo-client-and-server
+
+# reference for non-blocking socket programming:
+# https://stackoverflow.com/a/16745561
+
+import time
+import socket
+import argparse
+import numpy as np
+
+from switchboard import PySbRx, PySbTx, PySbPacket
+
+SB_PACKET_SIZE_BYTES = 60
+
+
+def tcp2sb(outputs, conn):
+    while True:
+        # receive data from TCP
+        data_rx_from_tcp = bytes([])
+
+        while len(data_rx_from_tcp) < SB_PACKET_SIZE_BYTES:
+            b = conn.recv(SB_PACKET_SIZE_BYTES - len(data_rx_from_tcp))
+
+            if len(b) == 0:
+                # connection is not alive anymore
+                return
+
+            data_rx_from_tcp += b
+
+        # convert to a switchboard packet
+        p = bytes2sb(data_rx_from_tcp)
+
+        # figure out which queue this packet is going to
+        for rule, output in outputs:
+            if rule_matches(rule, p.destination):
+                output.send(p)
+                break
+        else:
+            raise Exception(f"No rule for destination {p.destination}")
+
+
+def sb2tcp(inputs, conn):
+    tcp_data_to_send = bytes([])
+
+    while True:
+        # get a switchboard packet
+        while True:
+            # select input and queue its next run as last
+            destination, sbrx = inputs.pop(0)
+            inputs.append((destination, sbrx))
+
+            # try to receive a packet from this input
+            p = sbrx.recv(blocking=False)
+
+            if p is not None:
+                if destination is not None:
+                    p.destination = destination
+                break
+
+        # convert the switchboard packet to bytes
+        tcp_data_to_send = sb2bytes(p)
+
+        # send the packet out over TCP
+        while len(tcp_data_to_send) > 0:
+            n = conn.send(tcp_data_to_send)
+
+            if n == 0:
+                # connection is not alive anymore
+                return
+
+            tcp_data_to_send = tcp_data_to_send[n:]
+
+
+def run_client(host, port, quiet=False, max_rate=None, inputs=None, outputs=None, run_once=False):
+    """
+    Connect to a server, retrying until a connection is made.
+    """
+
+    # initialize PySbRx/PySbTx objects if needed
+
+    inputs, outputs = normalize_inputs_and_outputs(
+        inputs=inputs, outputs=outputs, max_rate=max_rate)
+
+    # connect to the server in a loop
+    while True:
+        if not quiet:
+            print(f'Waiting for server (host={host}, port={port})')
+        while True:
+            try:
+                conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+                conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
+                conn.connect((host, port))
+                break
+            except ConnectionRefusedError:
+                time.sleep(1)
+        if not quiet:
+            print(f'Connected to server (host={host}, port={port})')
+
+        # communicate with the server
+        if outputs is not None:
+            tcp2sb(outputs=outputs, conn=conn)
+        elif inputs is not None:
+            sb2tcp(inputs=inputs, conn=conn)
+
+        if run_once:
+            break
+
+
+def run_server(host, port=0, quiet=False, max_rate=None, run_once=False, outputs=None, inputs=None):
+    """
+    Accepts client connections in a loop until Ctrl-C is pressed.
+    """
+
+    # initialize PySbRx/PySbTx objects if needed
+
+    inputs, outputs = normalize_inputs_and_outputs(
+        inputs=inputs, outputs=outputs, max_rate=max_rate)
+
+    # create the server socket
+    server_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    server_socket.setsockopt(socket.SOL_SOCKET,
+        socket.SO_REUSEADDR, 1)  # allow port to be reused immediately
+    server_socket.bind((host, port))
+    server_socket.listen()
+
+    # accept client connections in a loop
+    while True:
+        # accept a client
+        if not quiet:
+            print(f'Waiting for client (host={host}, port={port})')
+        conn, _ = server_socket.accept()
+        if not quiet:
+            print(f'Connected to client (host={host}, port={port})')
+
+        # communicate with the client
+        if outputs is not None:
+            tcp2sb(outputs=outputs, conn=conn)
+        elif inputs is not None:
+            sb2tcp(inputs=inputs, conn=conn)
+
+        if run_once:
+            break
+
+
+def normalize_inputs_and_outputs(inputs, outputs, max_rate):
+    if outputs is not None:
+        assert inputs is None, 'Cannot specify both inputs and outputs'
+        outputs = normalize_outputs(outputs, max_rate)
+    else:
+        assert inputs is not None, 'Must specify either inputs or outputs'
+        inputs = normalize_inputs(inputs, max_rate)
+
+    return inputs, outputs
+
+
+def normalize_outputs(outputs, max_rate):
+    retval = []
+
+    for rule, output in outputs:
+        output = convert_to_queue(q=output, cls=PySbTx, max_rate=max_rate)
+        retval.append((rule, output))
+
+    return retval
+
+
+def normalize_inputs(inputs, max_rate):
+    retval = []
+
+    for input in inputs:
+        if not isinstance(input, (list, tuple)):
+            destination, input = None, input
+        else:
+            destination, input = input
+
+        input = convert_to_queue(q=input, cls=PySbRx, max_rate=max_rate)
+
+        retval.append((destination, input))
+
+    return retval
+
+
+def sb2bytes(p):
+    # construct a bytes object from a Switchboard packet
+    arr = np.concatenate((
+        np.array([p.destination, p.flags], dtype=np.uint32),
+        p.data.view(np.uint32)
+    ))
+    return arr.tobytes()
+
+
+def bytes2sb(b):
+    # construct a Switchboard packet from a bytes object
+    arr = np.frombuffer(b, dtype=np.uint32)
+    return PySbPacket(arr[0], arr[1], arr[2:].view(np.uint8))
+
+
+def convert_to_queue(q, cls, max_rate=None):
+    if isinstance(q, cls):
+        # note that None is passed through
+        return q
+    elif isinstance(q, str):
+        kwargs = {}
+
+        if max_rate is not None:
+            kwargs['max_rate'] = max_rate
+
+        return cls(q, **kwargs)
+    else:
+        raise TypeError(f'{q} must be a string or {cls.__name__}; got {type(q)}')
+
+
+def rule_matches(rule, addr):
+    if rule == '*':
+        return True
+    elif isinstance(rule, int):
+        return addr == rule
+    elif isinstance(rule, range):
+        return rule.start <= addr < rule.stop
+    elif isinstance(rule, (list, tuple)):
+        # return True if any subrules match
+        for subrule in rule:
+            if rule_matches(subrule, addr):
+                return True
+
+        # otherwise return False
+        return False
+    else:
+        raise Exception(f'Unsupported rule type: {type(rule)}')
+
+
+def parse_rule(rule):
+    subrules = rule.split(',')
+
+    retval = []
+
+    for subrule in subrules:
+        if subrule == '*':
+            retval.append('*')
+        elif '-' in subrule:
+            start, stop = subrule.split('-')
+            start = int(start)
+            stop = int(stop)
+            retval.append(range(start, stop + 1))
+        else:
+            retval.append(int(subrule))
+
+    return retval
+
+
+def start_tcp_bridge(inputs=None, outputs=None, host='localhost', port=5555,
+    quiet=True, max_rate=None, mode='auto', run_once=False):
+
+    kwargs = dict(
+        host=host,
+        port=port,
+        quiet=quiet,
+        max_rate=max_rate,
+        run_once=run_once
+    )
+
+    target = None
+
+    if mode == 'client':
+        target = run_client
+    elif mode == 'server':
+        target = run_server
+
+    if outputs is not None:
+        kwargs['outputs'] = outputs
+        if mode == 'auto':
+            target = run_server
+    elif inputs is not None:
+        kwargs['inputs'] = inputs
+        if mode == 'auto':
+            target = run_client
+    else:
+        raise Exception('Must specify "outputs" or "inputs" argument.')
+
+    assert target is not None, 'Could not determine whether to run the bridge as a client or server'
+
+    import multiprocessing
+
+    p = multiprocessing.Process(target=target, kwargs=kwargs, daemon=True)
+    p.start()
+
+    return p
+
+
+def get_parser():
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument('--outputs', type=str, default=None, nargs='+', help="Space-separated"
+        " dictionary of queues to write to.  For example, 0:a.q 1-2:b.q 3,5-7:c.q *:d.q means"
+        " that packets sent to destination 0 are routed to a.q, packets sent to destinations 1"
+        " or 2 are routed to b.q, packets sent to destinations 3, 5, 6, or 7 are routed to c.q,"
+        " and all other packets are routed to d.q")
+    parser.add_argument('--inputs', type=str, default=None, nargs='+', help="Space-separated"
+        " list of queues to read from, for example a.q b.q c.q")
+    parser.add_argument('--port', type=int, default=5555, help="TCP port used for"
+        " sending and receiving packets.")
+    parser.add_argument('--host', type=str, default="localhost", help="IP address or hostname"
+        " used sending/receiving packets.")
+    parser.add_argument('-q', action='store_true', help="Quiet mode: doesn't print anything.")
+    parser.add_argument('--max-rate', type=float, default=None, help='Maximum rate at which'
+        ' queues are read or written.')
+    parser.add_argument('--run-once', action='store_true', help="Process only one connection"
+        " in server mode, then exit.")
+
+    return parser
+
+
+def main():
+    # parse command-line arguments
+
+    parser = get_parser()
+    args = parser.parse_args()
+
+    # main logic
+
+    if args.outputs is not None:
+        # parse the output mapping
+        outputs = []
+        for output in args.outputs:
+            rule, output = output.split(':')
+            outputs.append((parse_rule(rule), output))
+
+        run_server(outputs=outputs, host=args.host, port=args.port,
+            quiet=args.q, max_rate=args.max_rate, run_once=args.run_once)
+    elif args.inputs is not None:
+        run_client(inputs=args.inputs, host=args.host, port=args.port,
+            quiet=args.q, max_rate=args.max_rate)
+    else:
+        raise ValueError("Must specify either --inputs or --outputs")
+
+
+if __name__ == "__main__":
+    main()

switchboard/sc/morty/uniquify.py

@@ -0,0 +1,67 @@
+# Copyright (c) 2024 Zero ASIC Corporation
+# This code is licensed under Apache License 2.0 (see LICENSE for details)
+
+from siliconcompiler import Task
+
+
+class UniquifyVerilogModules(Task):
+
+    def __init__(self):
+        super().__init__()
+
+        self.add_parameter(
+            name='suffix',
+            type='str',
+            help='suffix to be added to the end of module names'
+        )
+
+        self.add_parameter(
+            name='prefix',
+            type='str',
+            help='prefix to be added to the beginning of module names'
+        )
+
+    def tool(self):
+        return "morty"
+
+    def task(self):
+        return "uniquify_verilog_modules"
+
+    def setup(self):
+        super().setup()
+
+        self.set_exe("morty")
+
+        self.add_input_file(ext="sv")
+        self.add_output_file(ext="sv")
+
+    def runtime_options(self):
+        options = super().runtime_options()
+
+        idirs = []
+        for lib, fileset in self.project.get_filesets():
+            idirs.extend(lib.get_idir(fileset))
+
+        cmdlist = []
+
+        prefix = self.get("var", "prefix")
+        if prefix:
+            cmdlist.extend(['--prefix', prefix])
+
+        suffix = self.get("var", "suffix")
+        if suffix:
+            cmdlist.extend(['--suffix', suffix])
+
+        out_file = f"outputs/{self.design_topmodule}.sv"
+
+        cmdlist.extend(['-o', out_file])
+
+        for value in idirs:
+            cmdlist.append('-I' + value)
+
+        input_file = f"inputs/{self.design_topmodule}.sv"
+
+        options.extend(cmdlist)
+        options.append(input_file)
+
+        return options

switchboard/sc/sed/sed_remove.py

@@ -0,0 +1,47 @@
+# Copyright (c) 2024 Zero ASIC Corporation
+# This code is licensed under Apache License 2.0 (see LICENSE for details)
+
+from siliconcompiler import Task
+
+
+class SedRemove(Task):
+
+    def __init__(self):
+        super().__init__()
+
+        self.add_parameter(
+            name="to_remove",
+            type="[str]",
+            help="strings to remove from the Verilog source file"
+        )
+
+    def tool(self):
+        return "sed"
+
+    def task(self):
+        return "remove"
+
+    def setup(self):
+        super().setup()
+
+        self.set_exe("sed")
+
+        self.add_input_file(ext="sv")
+        self.add_output_file(ext="sv")
+
+    def runtime_options(self):
+        options = super().runtime_options()
+
+        to_remove = self.get("var", "to_remove")
+
+        script = [f's/{elem}//g' for elem in to_remove]
+        script += [f'w outputs/{self.design_topmodule}.sv']
+        script = '; '.join(script)
+
+        options.extend(["-n", f'{script}', ])
+
+        input_file = f"inputs/{self.design_topmodule}.sv"
+
+        options.append(input_file)
+
+        return options

switchboard/sc/standalone_netlist_flow.py

@@ -0,0 +1,25 @@
+from siliconcompiler import Flowgraph
+from siliconcompiler.tools.surelog.parse import ElaborateTask
+
+from switchboard.sc.sed.sed_remove import SedRemove
+from switchboard.sc.morty.uniquify import UniquifyVerilogModules
+
+
+class StandaloneNetlistFlow(Flowgraph):
+    def __init__(self, name: str = None):
+        if name is None:
+            name = "standalone-netlist-flow"
+        super().__init__(name)
+
+        self.node("parse", ElaborateTask)
+        self.node("remove", SedRemove)
+        self.node("uniquify", UniquifyVerilogModules)
+
+        self.edge("parse", "remove")
+        self.edge("remove", "uniquify")
+
+
+##################################################
+if __name__ == "__main__":
+    flow = StandaloneNetlistFlow()
+    flow.write_flowgraph(f"{flow.name}.png")

switchboard/switchboard.py

@@ -0,0 +1,53 @@
+# Switchboard CLI
+
+# Copyright (c) 2024 Zero ASIC Corporation
+# This code is licensed under Apache License 2.0 (see LICENSE for details)
+
+from argparse import ArgumentParser
+from pathlib import Path
+
+
+def path():
+    return Path(__file__).resolve().parent
+
+
+def inspect(file, format):
+    import shutil
+    import tempfile
+
+    with tempfile.NamedTemporaryFile() as temp:
+        shutil.copyfile(file, temp.name)
+
+        if format == 'sb':
+            from switchboard import PySbRx
+            rx = PySbRx(temp.name, fresh=False)
+        elif format == 'umi':
+            from switchboard import UmiTxRx
+            rx = UmiTxRx(rx_uri=temp.name, fresh=False)
+        else:
+            raise ValueError(f'Format not supported: "{format}"')
+
+        while True:
+            rxp = rx.recv(False)
+
+            if rxp is not None:
+                print(rxp)
+            else:
+                break
+
+
+def main():
+    parser = ArgumentParser()
+    parser.add_argument('--path', action='store_true')
+    parser.add_argument('-i', '--inspect', type=str, default=None, help='Print the contents'
+        ' of the given switchboard queue.')
+    parser.add_argument('-f', '--format', type=str, default='sb', choices=['sb', 'umi'],
+        help='Format assumed for the contents of the switchboard queue passed via the'
+        ' -i/--inspect argument.')
+
+    args = parser.parse_args()
+
+    if args.path:
+        print(path())
+    elif args.inspect is not None:
+        inspect(file=args.inspect, format=args.format)

switchboard/test_util.py

@@ -0,0 +1,46 @@
+# General utilities for working with switchboard
+
+# Copyright (c) 2024 Zero ASIC Corporation
+# This code is licensed under Apache License 2.0 (see LICENSE for details)
+
+import subprocess
+from pathlib import Path
+
+
+def test_cmd(args, expected=None, path=None):
+    # determine where the command should be run
+    if path is not None:
+        path = Path(path)
+        if path.is_file():
+            cwd = path.resolve().parent
+        elif path.is_dir():
+            cwd = path.resolve()
+        else:
+            raise ValueError(f"Provided path doesn't exist: {path}")
+    else:
+        cwd = None
+
+    # run the command, capturing the output
+    if isinstance(args, str):
+        args = [args]
+    args = [str(arg) for arg in args]
+
+    process = subprocess.Popen(args, stdout=subprocess.PIPE,
+        stderr=subprocess.STDOUT, bufsize=1, text=True, cwd=cwd)
+
+    # print output while saving it
+    stdout = ''
+    for line in process.stdout:
+        print(line, end='')
+        stdout += line
+
+    # make sure that process exits cleanly
+    returncode = process.wait()
+    assert returncode == 0, f'Exited with non-zero code: {returncode}'
+
+    # check the results
+    if expected is not None:
+        if isinstance(expected, str):
+            expected = [expected]
+        for elem in expected:
+            assert elem in stdout

switchboard/uart_xactor.py

@@ -0,0 +1,66 @@
+#!/usr/bin/env python3
+
+# Copyright (c) 2024 Zero ASIC Corporation
+# This code is licensed under Apache License 2.0 (see LICENSE for details)
+
+"""
+UMI/UART Transactor.
+"""
+
+import numpy as np
+
+
+class uart_xactor:
+    REG_TX = 0
+    REG_RX = 4
+    REG_SR = 8
+
+    REGF_SR_RXEMPTY_MASK = 1 << 0
+    REGF_SR_RXFULL_MASK = 1 << 1
+    REGF_SR_TXEMPTY_MASK = 1 << 8
+    REGF_SR_TXFULL_MASK = 1 << 9
+
+    def __init__(self, umi, encoding='ascii'):
+        self.encoding = encoding
+        self.umi = umi
+
+    def read_byte(self):
+        c8 = None
+        while True:
+            sr = self.umi.read(self.REG_SR, np.uint32)
+            if (sr & self.REGF_SR_RXEMPTY_MASK) == 0:
+                rx = self.umi.read(self.REG_RX, np.uint32)
+                c8 = rx & 0xff
+                break
+        return bytes([c8])
+
+    def readline(self, size=-1, end='\n'):
+        line = ""
+
+        while size < 0 or len(line) < size:
+            c8 = self.read_byte()
+            if c8 == end.encode(self.encoding):
+                break
+            line += c8.decode(self.encoding)
+        return line
+
+    def write_byte(self, b):
+        while True:
+            sr = self.umi.read(self.REG_SR, np.uint32)
+            if (sr & self.REGF_SR_TXFULL_MASK) == 0:
+                self.umi.write(self.REG_TX, np.uint32(b))
+                break
+
+    # File-like ops
+    def write(self, string):
+        for b in string:
+            self.write_byte(b)
+
+    # On streaming UART, reading until EOF doesn't make sense
+    # So we default the size arg to 1
+    def read(self, size=1):
+        data = bytes(0)
+        while size < 0 or len(data) < size:
+            b = self.read_byte()
+            data += b
+        return data