mirror of
https://github.com/openhwgroup/cva6.git
synced 2025-06-28 17:23:59 -04:00
Design documentation: AsciiDoc conversion (#2399)
This commit is contained in:
slgth
GitHub
parent
fd489a16fb
commit
e9648eaf8c
159 changed files with 19544 additions and 7229 deletions
|
|
@ -10,26 +10,128 @@
|
|||
#!/usr/bin/python3
|
||||
|
||||
import re
|
||||
import sys
|
||||
|
||||
from classes import Parameter
|
||||
from classes import PortIO
|
||||
from define_blacklist import define_blacklist
|
||||
from parameters_extractor import parameters_extractor
|
||||
from parameters_extractor import writeout_parameter_table
|
||||
from parameters_extractor import writeout_parameter_table_adoc
|
||||
|
||||
HEADER_RST = """\
|
||||
..
|
||||
Copyright 2024 Thales DIS France SAS
|
||||
Licensed under the Solderpad Hardware License, Version 2.1 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
|
||||
You may obtain a copy of the License at https://solderpad.org/licenses/
|
||||
|
||||
Original Author: Jean-Roch COULON - Thales
|
||||
|
||||
"""
|
||||
|
||||
HEADER_ADOC = """\
|
||||
////
|
||||
Copyright 2024 Thales DIS France SAS
|
||||
Licensed under the Solderpad Hardware License, Version 2.1 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
|
||||
You may obtain a copy of the License at https://solderpad.org/licenses/
|
||||
|
||||
Original Author: Jean-Roch COULON - Thales
|
||||
////
|
||||
|
||||
"""
|
||||
|
||||
def print_to_rst(pathout, target, module, ports, comments):
|
||||
fileout = f"{pathout}/port_{module}.rst"
|
||||
print("Output file " + fileout)
|
||||
|
||||
with open(fileout, "w", encoding="utf-8") as fout:
|
||||
fout.write(HEADER_RST)
|
||||
fout.write(f".. _CVA6_{module}_ports:\n\n")
|
||||
fout.write(f".. list-table:: **{module} module** IO ports\n")
|
||||
fout.write(" :header-rows: 1\n")
|
||||
fout.write("\n")
|
||||
fout.write(" * - Signal\n")
|
||||
fout.write(" - IO\n")
|
||||
fout.write(" - Description\n")
|
||||
fout.write(" - connexion\n")
|
||||
fout.write(" - Type\n")
|
||||
for i, port in enumerate(ports):
|
||||
fout.write("\n")
|
||||
fout.write(f" * - ``{port.name}``\n")
|
||||
fout.write(f" - {port.direction}\n")
|
||||
fout.write(f" - {port.description}\n")
|
||||
fout.write(f" - {port.connexion}\n")
|
||||
fout.write(f" - {port.data_type}\n")
|
||||
fout.write("\n")
|
||||
if len(comments) != 0:
|
||||
fout.write(
|
||||
f"Due to {target} configuration, some ports are tied to a static value. These ports do not appear in the above table, they are listed below\n"
|
||||
)
|
||||
fout.write("\n")
|
||||
for comment in comments:
|
||||
fout.write(f"| {comment[0]},\n| {comment[1]}\n")
|
||||
fout.write("\n")
|
||||
|
||||
def print_to_adoc(pathout, target, module, ports, comments):
|
||||
fileout = f"{pathout}/port_{module}.adoc"
|
||||
print("Output file " + fileout)
|
||||
|
||||
# format comments
|
||||
for comment in comments:
|
||||
for i in range(len(comment)):
|
||||
comment[i] = comment[i].replace('``', '`')
|
||||
comment[i] = comment[i].replace('|', '*')
|
||||
|
||||
with open(fileout, "w", encoding="utf-8") as fout:
|
||||
fout.write(HEADER_ADOC)
|
||||
|
||||
fout.write(f"[[_CVA6_{module}_ports]]\n\n")
|
||||
|
||||
fout.write(f".*{module} module* IO ports\n")
|
||||
fout.write("|===\n")
|
||||
fout.write("|Signal | IO | Description | connexion | Type\n\n")
|
||||
|
||||
for port in ports:
|
||||
fout.write(f"|`{port.name}` | {port.direction} | {port.description} | {port.connexion} | {port.data_type}\n\n")
|
||||
fout.write("|===\n")
|
||||
|
||||
if len(comments) != 0:
|
||||
fout.write(
|
||||
f"Due to {target} configuration, some ports are tied to a static value. These ports do not appear in the above table, they are listed below\n\n"
|
||||
)
|
||||
for comment in comments:
|
||||
fout.write(f"{comment[0]},::\n* {comment[1]}\n")
|
||||
fout.write("\n")
|
||||
|
||||
def main():
|
||||
PATH = "04_cv32a65x"
|
||||
generate_file_type = "adoc"
|
||||
[spec_number, target] = PATH.split("_")
|
||||
|
||||
print(spec_number, target)
|
||||
|
||||
# Parameters
|
||||
parameters = parameters_extractor(spec_number, target)
|
||||
|
||||
pathout = f"./{spec_number}_{target}/design/source"
|
||||
fileout = f"{pathout}/parameters_{target}.rst"
|
||||
writeout_parameter_table(fileout, parameters, target)
|
||||
if generate_file_type in ['rst']:
|
||||
fileout = f"{pathout}/parameters_{target}.rst"
|
||||
writeout_parameter_table(fileout, parameters, target)
|
||||
elif generate_file_type in ['adoc']:
|
||||
pathout = f"./{spec_number}_{target}/design/source"
|
||||
fileout = f"{pathout}/parameters.adoc"
|
||||
writeout_parameter_table_adoc(fileout, parameters, target)
|
||||
else:
|
||||
raise Exception("Format de sortie %s non pris en charge"%generate_file_type)
|
||||
|
||||
# User_cfg
|
||||
export_user_cfg_doc("01_cva6_user/user_cfg_doc.rst", parameters)
|
||||
|
||||
# Ports
|
||||
file = []
|
||||
file.append("../core/cva6.sv")
|
||||
file.append("../core/frontend/frontend.sv")
|
||||
|
|
@ -68,9 +170,7 @@ def main():
|
|||
comments = []
|
||||
a = re.match(r".*\/(.*).sv", filein)
|
||||
module = a.group(1)
|
||||
fileout = f"{pathout}/port_{module}.rst"
|
||||
print("Input file " + filein)
|
||||
print("Output file " + fileout)
|
||||
ports = []
|
||||
with open(filein, "r", encoding="utf-8") as fin:
|
||||
description = "none"
|
||||
|
|
@ -126,49 +226,16 @@ def main():
|
|||
description = "none"
|
||||
connexion = "none"
|
||||
|
||||
with open(fileout, "w", encoding="utf-8") as fout:
|
||||
fout.write(HEADER)
|
||||
fout.write(f".. _CVA6_{module}_ports:\n\n")
|
||||
fout.write(f".. list-table:: **{module} module** IO ports\n")
|
||||
fout.write(" :header-rows: 1\n")
|
||||
fout.write("\n")
|
||||
fout.write(" * - Signal\n")
|
||||
fout.write(" - IO\n")
|
||||
fout.write(" - Description\n")
|
||||
fout.write(" - connexion\n")
|
||||
fout.write(" - Type\n")
|
||||
for i, port in enumerate(ports):
|
||||
fout.write("\n")
|
||||
fout.write(f" * - ``{port.name}``\n")
|
||||
fout.write(f" - {port.direction}\n")
|
||||
fout.write(f" - {port.description}\n")
|
||||
fout.write(f" - {port.connexion}\n")
|
||||
fout.write(f" - {port.data_type}\n")
|
||||
fout.write("\n")
|
||||
if len(comments) != 0:
|
||||
fout.write(
|
||||
f"Due to {target} configuration, some ports are tied to a static value. These ports do not appear in the above table, they are listed below\n"
|
||||
)
|
||||
fout.write("\n")
|
||||
for comment in comments:
|
||||
fout.write(f"| {comment[0]},\n| {comment[1]}\n")
|
||||
fout.write("\n")
|
||||
|
||||
HEADER = """\
|
||||
..
|
||||
Copyright 2024 Thales DIS France SAS
|
||||
Licensed under the Solderpad Hardware License, Version 2.1 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
|
||||
You may obtain a copy of the License at https://solderpad.org/licenses/
|
||||
|
||||
Original Author: Jean-Roch COULON - Thales
|
||||
|
||||
"""
|
||||
if generate_file_type in ['rst']:
|
||||
print_to_rst(pathout, target, module, ports, comments)
|
||||
elif generate_file_type in ['adoc']:
|
||||
print_to_adoc(pathout, target, module, ports, comments)
|
||||
else:
|
||||
raise Exception("Format de sortie %s non pris en charge"%generate_file_type)
|
||||
|
||||
def export_user_cfg_doc(out_path, params):
|
||||
with open(out_path, "w", encoding="utf-8") as f:
|
||||
f.write(HEADER)
|
||||
f.write(HEADER_RST)
|
||||
f.write("""\
|
||||
.. _cva6_user_cfg_doc:
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue