[ot] scripts/opentitan: otptool.py: add optional top name for code generation

Signed-off-by: Emmanuel Blot <[email protected]>

Author: rivos-eblot

docs/opentitan/otptool.md

@@ -14,7 +14,7 @@ usage: otptool.py [-h] [-j HJSON] [-m VMEM] [-l SV] [-o FILE] [-r RAW]
                   [--erase PART:FIELD] [--clear-bit CLEAR_BIT]
                   [--set-bit SET_BIT] [--toggle-bit TOGGLE_BIT]
                   [--write ADDR/HEXBYTES] [--patch-token NAME=VALUE]
-                  [--out-kind {qemu,bmtest}] [-v] [-d]
+                  [--out-kind {qemu,bmtest}] [--top-name TOP_NAME] [-v] [-d]
 
 QEMU OT tool to manage OTP files.
 
@@ -69,6 +69,7 @@ Commands:
   --out-kind {qemu,bmtest}
                         select output format for code generation (default:
                         qemu)
+  --top-name TOP_NAME   optional top name for code generation (default: auto)
 
 Extras:
   -v, --verbose         increase verbosity
@@ -230,6 +231,9 @@ Fuse RAW images only use the v1 type.
   is only intended to corrupt the OTP content so that HW & SW behavior may be exercised should such
   a condition exists. See [Bit position syntax](#bit-syntax) for how to specify a bit.
 
+* `--top-name` defines the OpenTitan top name for some code generation feature. It overrides any
+  top name that may be automatically retrieved from the configuration file hierarchy.
+
 * `--write` overrides any data (not ECC). If can be combined with `--fix-ecc` to automatically
   rebuild the ECC of the data slot that have been altered. This option may be repeated. The argument
   should comply with the `offset/hexdata` syntax, where the _offset_ part is defined in the

python/qemu/ot/otp/descriptor.py

@@ -7,9 +7,10 @@
 """
 
 from logging import getLogger
-from typing import NamedTuple, TYPE_CHECKING, TextIO
+from typing import NamedTuple, Optional, TYPE_CHECKING, TextIO
 
-from ..util.misc import redent
+from ot.top import OpenTitanTop
+from ot.util.misc import redent
 from .partition import OtpPartition
 
 if TYPE_CHECKING:
@@ -160,11 +161,12 @@ def __init__(self, otpmap: 'OtpMap'):
         self._log = getLogger('otp.reg')
         self._otpmap = otpmap
 
-    def save(self, kind: str, hjname: str, scriptname: str, cfp: TextIO) \
-            -> None:
+    def save(self, kind: str, topname: Optional[str], hjname: str,
+             scriptname: str, cfp: TextIO) -> None:
         """Generate a source file with register definition for the partitions.
 
            :param kind: kind of generation output
+           :param topname: the name of the OpenTitan top
            :param hjname: the name of the input HJSON configuration file
            :param scriptname: the name of the script that generates this output
            :param cfp: the output text stream
@@ -199,11 +201,11 @@ def save(self, kind: str, hjname: str, scriptname: str, cfp: TextIO) \
                 slots.append(OtpSlotDescriptor(f'{part.name}_ZER', offset,
                                                OtpPartition.ZER_SIZE, True))
 
-        save(hjname, scriptname, cfp, slots)
+        save(topname, hjname, scriptname, cfp, slots)
 
-    def _save_qemu(self, hjname: str, scriptname: str, cfp: TextIO,
-                   slots: list[OtpSlotDescriptor]) -> None:
-        print(f'/* Generated from {hjname} with {scriptname} */')
+    def _save_qemu(self, topname: Optional[str], hjname: str, scriptname: str,
+                   cfp: TextIO, slots: list[OtpSlotDescriptor]) -> None:
+        print(f'/* Generated from {hjname} with {scriptname} */', file=cfp)
         print(file=cfp)
         for slot in slots:
             if slot.part:
@@ -293,12 +295,17 @@ def _save_qemu(self, hjname: str, scriptname: str, cfp: TextIO,
         #undef CASE_DIGEST
         }
         '''
+        if topname:
+            tname = OpenTitanTop.short_name(topname)
+            if tname:
+                code = code.replace('ot_otp_swcfg_reg_name',
+                                    f'ot_otp_{tname}_swcfg_reg_name')
         code = redent(code)
         code = code.replace('_CASES_', '\n        '.join(cases))
         print(redent(code), '', file=cfp)
 
-    def _save_bmtest(self, hjname: str, scriptname: str, cfp: TextIO,
-                     slots: list[OtpSlotDescriptor]) -> None:
+    def _save_bmtest(self, topname: Optional[str], hjname: str, scriptname: str,
+                     cfp: TextIO, slots: list[OtpSlotDescriptor]) -> None:
         # pylint: disable=unused-argument
         print(f'// Generated from {hjname} with {scriptname}', file=cfp)
         print(file=cfp)

scripts/opentitan/otptool.py

@@ -10,10 +10,12 @@
 
 from argparse import ArgumentParser, FileType
 from binascii import unhexlify
-from os.path import basename, dirname, join as joinpath, normpath
+from io import IOBase
+from os.path import (basename, dirname, isfile, join as joinpath, normpath,
+                     split as splitpath)
 from re import match as re_match
 from traceback import format_exception
-from typing import Optional
+from typing import Optional, Union
 import sys
 
 QEMU_PYPATH = joinpath(dirname(dirname(dirname(normpath(__file__)))),
@@ -28,6 +30,7 @@
     _EXC = exc
 from ot.otp import (OtpImage, OtpLifecycleExtension, OtpMap, OtpPartition,
                     OtpPartitionDesc, OtpRegisterDef)
+from ot.top import OpenTitanTop
 from ot.util.log import configure_loggers
 from ot.util.misc import HexInt, to_bool
 
@@ -50,6 +53,31 @@ def parse_lc_token(tkdesc: str) -> tuple[str, 'LifeCycleTokenPair']:
     return token_name, tkeng.build_from_text(tktext)
 
 
+def get_top_name(*filepaths: list[Union[str, IOBase]]) -> Optional[str]:
+    """Try to retrieve the top name from a list of configuration files.
+
+       :param filepaths: list of file path or file objects
+       :return: the name of the identified top, if found
+    """
+    for filepath in filepaths:
+        if not isinstance(filepath, str):
+            filepath = getattr(filepath, 'name', None)
+            if not filepath:
+                continue
+        if not isfile(filepath):
+            continue
+        fdir = dirname(filepath)
+        top_names = set(OpenTitanTop.names)
+        while fdir:
+            fdir, tail = splitpath(fdir)
+            top_prefix = 'top_'
+            if tail.startswith(top_prefix):
+                candidate = tail.removeprefix(top_prefix)
+                if candidate in top_names:
+                    return candidate
+        return None
+
+
 def main():
     """Main routine"""
     debug = True
@@ -143,6 +171,9 @@ def main():
                               default=outkinds[0],
                               help=f'select output format for code generation'
                                    f' (default: {outkinds[0]})')
+        commands.add_argument('--top-name',
+                              help='optional top name for code generation '
+                                   '(default: auto)')
         extra = argparser.add_argument_group(title='Extras')
         extra.add_argument('-v', '--verbose', action='count',
                            help='increase verbosity')
@@ -226,8 +257,11 @@ def main():
                 partdesc.save(args.out_kind, basename(args.otp_map.name),
                               basename(sys.argv[0]), output)
             elif args.generate == 'REGS':
+                topname = args.top_name
+                if not topname:
+                    topname = get_top_name(args.otp_map)
                 regdef = OtpRegisterDef(otpmap)
-                regdef.save(args.out_kind, basename(args.otp_map.name),
+                regdef.save(args.out_kind, topname, basename(args.otp_map.name),
                             basename(sys.argv[0]), output)
             elif args.generate == 'LCVAL':
                 lcext.save(args.out_kind, output, True)