hardware/intel/scripts/set_attrs.py

#!/usr/bin/env python
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

import os, sys
import argparse

def set_attrs(fname, fname_out, dsp=False, verbose=True):
    """Set attributes to precompiled verilog code to indicate synthesis preference.

    Parameters
    ----------
    fname : str
        The name of input verilog source code file.

    fname_out : str
        The name of output verilog source code file.
    """
    out = ""
    with open(fname, 'rt') as fp:
        module = ''
        for idx, line in enumerate(fp):
            if 'module' in line:
                module = line[line.find('module')+7:line.find('(')]
                out += line
            elif " * " in line:
                if dsp:
                    line = line.replace(" * ", ' * (* multstyle="dsp" *) ')
                else:
                    line = line.replace(" * ", ' * (* multstyle="logic" *) ')
                if verbose:
                    print(fname_out+":"+str(idx+1)+": "+module+":"+line[1:line.find(";")+1])
                out += line
            elif "rA;" in line:
                line = line.replace("rA;", 'rA /* synthesis noprune */;')
                if verbose:
                    print(fname_out+":"+str(idx+1)+": "+module+":"+line[1:line.find(";")+1])
                out += line
            elif "rB;" in line:
                line = line.replace("rB;", 'rB /* synthesis noprune */;')
                if verbose:
                    print(fname_out+":"+str(idx+1)+": "+module+":"+line[1:line.find(";")+1])
                out += line
            elif "rC;" in line:
                line = line.replace("rC;", 'rC /* synthesis noprune */;')
                if verbose:
                    print(fname_out+":"+str(idx+1)+": "+module+":"+line[1:line.find(";")+1])
                out += line
            else:
                out += line
    with open(fname_out, 'wt') as fp:
        fp.write(out)

if __name__=="__main__":
    parser = argparse.ArgumentParser(description='Set attributes to precompiled ' +
                                     'verilog code to indicate synthesis preference')
    parser.add_argument('-i', '--input', type=str, default='VTA.DefaultDe10Config.v',
                        help='input verilog file to be decorated')
    parser.add_argument('-o', '--output', type=str, default='IntelShell.v',
                        help='decorated verilog file')
    parser.add_argument('--dsp', default=False, action='store_true',
                        help='use dsp instead of logic.')
    parser.add_argument('--verbose', default=False, action='store_true',
                        help='print output file name and decorated lines.')
    args = parser.parse_args()
    set_attrs(args.input, args.output, args.dsp, args.verbose)