OpenRAM/compiler/datasheet/datasheet_gen.py

#!/usr/bin/env python3
"""
Datasheet Generator

TODO:
locate all port elements in .lib
Locate all timing elements in .lib
Diagram generation
Improve css
"""
import debug
from globals import OPTS

if OPTS.datasheet_gen:
    import flask_table
    import os, math
    import optparse
    import csv
    from deliverables import *
    from operating_conditions import *
    from timing_and_current_data import *
    from characterization_corners import *
    from datasheet import *
    from in_out import *
else:
    debug.warning("Python library flask_table not found. Skipping html datasheet generation. This can be installed with pip install flask-table.")



def process_name(corner):
    if corner == "TT":
        return "Typical - Typical"
    if corner == "SS":
        return "Slow - Slow"
    if corner == "FF":
        return "Fast - Fast"
    else:
        return "custom"

def parse_file(f,pages):
    with open(f) as csv_file:
        csv_reader = csv.reader(csv_file, delimiter=',')
        line_count = 0
        for row in csv_reader:
            found = 0
            NAME = row[0]
            NUM_WORDS = row[1]
            NUM_BANKS = row[2]
            NUM_RW_PORTS = row[3]
            NUM_W_PORTS = row[4]
            NUM_R_PORTS = row[5]
            TECH_NAME = row[6]
            TEMP = row[8]
            VOLT = row[7]
            PROC = row[9]
            MIN_PERIOD = row[10]
            OUT_DIR = row[11]
            LIB_NAME = row[12]
            WORD_SIZE = row[13]
            for sheet in pages:


                if sheet.name == row[0]:
                    found = 1
                    #if the .lib information is for an existing datasheet compare timing data

                    for item in sheet.operating:

                        if item.parameter == 'Operating Temperature':
                            if float(TEMP) > float(item.max):
                                item.typ = item.max
                                item.max = TEMP
                            if float(TEMP) < float(item.min):
                                item.typ = item.min
                                item.min = TEMP

                        if item.parameter == 'Power supply (VDD) range':
                            if float(VOLT) > float(item.max):
                                item.typ = item.max
                                item.max = VOLT
                            if float(VOLT) < float(item.min):
                                item.typ = item.min
                                item.min = VOLT

                        if item.parameter == 'Operating Frequncy (F)':
                            try:
                                if float(math.floor(1000/float(MIN_PERIOD)) < float(item.max)):
                                    item.max = str(math.floor(1000/float(MIN_PERIOD)))
                            except Exception:
                                pass



                    new_sheet.corners.append(characterization_corners_item(PROC,process_name(PROC),VOLT,TEMP,LIB_NAME.replace(OUT_DIR,'').replace(NAME,'')))
                    new_sheet.dlv.append(deliverables_item('.lib','Synthesis models','<a href="file://{0}">{1}</a>'.format(LIB_NAME,LIB_NAME.replace(OUT_DIR,''))))

            if found == 0:
                new_sheet = datasheet(NAME)
                pages.append(new_sheet)

                new_sheet.corners.append(characterization_corners_item(PROC,process_name(PROC),VOLT,TEMP,LIB_NAME.replace(OUT_DIR,'').replace(NAME,'')))

                new_sheet.operating.append(operating_conditions_item('Power supply (VDD) range',VOLT,VOLT,VOLT,'Volts'))
                new_sheet.operating.append(operating_conditions_item('Operating Temperature',TEMP,TEMP,TEMP,'Celsius'))
                try:
                    new_sheet.operating.append(operating_conditions_item('Operating Frequency (F)*','','',str(math.floor(1000/float(MIN_PERIOD))),'MHz'))
                except Exception:
                    new_sheet.operating.append(operating_conditions_item('Operating Frequency (F)*','','',"unknown",'MHz')) #analytical model fails to provide MIN_PERIOD
 
                new_sheet.timing.append(timing_and_current_data_item('Cycle time','2','3','4'))
                new_sheet.timing.append(timing_and_current_data_item('Access time','2','3','4'))
                new_sheet.timing.append(timing_and_current_data_item('Positive clk setup','2','3','4'))
                new_sheet.timing.append(timing_and_current_data_item('Positive clk hold','2','3','4'))
                new_sheet.timing.append(timing_and_current_data_item('RW setup','2','3','4'))
                new_sheet.timing.append(timing_and_current_data_item('RW hold','2','3','4'))
                new_sheet.timing.append(timing_and_current_data_item('AC current','2','3','4'))
                new_sheet.timing.append(timing_and_current_data_item('Standby current','2','3','4'))
                new_sheet.timing.append(timing_and_current_data_item('Area','2','3','4'))


                new_sheet.dlv.append(deliverables_item('.sp','SPICE netlists','<a href="file://{0}{1}.{2}">{1}.{2}</a>'.format(OUT_DIR,NAME,'sp')))
                new_sheet.dlv.append(deliverables_item('.v','Verilog simulation models','<a href="file://{0}{1}.{2}">{1}.{2}</a>'.format(OUT_DIR,NAME,'v')))
                new_sheet.dlv.append(deliverables_item('.gds','GDSII layout views','<a href="file://{0}{1}.{2}">{1}.{2}</a>'.format(OUT_DIR,NAME,'gds')))
                new_sheet.dlv.append(deliverables_item('.lef','LEF files','<a href="file://{0}{1}.{2}">{1}.{2}</a>'.format(OUT_DIR,NAME,'lef')))
                new_sheet.dlv.append(deliverables_item('.lib','Synthesis models','<a href="file://{0}">{1}</a>'.format(LIB_NAME,LIB_NAME.replace(OUT_DIR,''))))
                
                new_sheet.io.append(in_out_item('WORD_SIZE',WORD_SIZE))
                new_sheet.io.append(in_out_item('NUM_WORDS',NUM_WORDS))
                new_sheet.io.append(in_out_item('NUM_BANKS',NUM_BANKS))
                new_sheet.io.append(in_out_item('NUM_RW_PORTS',NUM_RW_PORTS))
                new_sheet.io.append(in_out_item('NUM_R_PORTS',NUM_R_PORTS))
                new_sheet.io.append(in_out_item('NUM_W_PORTS',NUM_W_PORTS))





class datasheet_gen():
     def datasheet_write(name):
        
        if OPTS.datasheet_gen:
            in_dir = OPTS.openram_temp
        
            if not (os.path.isdir(in_dir)):
                os.mkdir(in_dir)

            #if not (os.path.isdir(out_dir)):
            #    os.mkdir(out_dir)

            datasheets = []
            parse_file(in_dir + "/datasheet.info", datasheets)


            for sheets in datasheets:
                with open(name, 'w+') as f:
                    sheets.generate_html()
                    f.write(sheets.html)