Update Darjeeling implementation

.github/workflows/build_test.yaml

@@ -16,9 +16,9 @@ jobs:
         run: |
           wget -qO- https://apt.llvm.org/llvm-snapshot.gpg.key |
             sudo tee /etc/apt/trusted.gpg.d/apt.llvm.org.asc &&
-          sudo add-apt-repository "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-17 main" &&
+          sudo add-apt-repository "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-18 main" &&
           sudo apt-get update &&
-          sudo apt-get install -y git make pkg-config clang-17 cmake ninja-build python3 rust-all \
+          sudo apt-get install -y git make pkg-config clang-18 cmake ninja-build python3 rust-all \
             libpixman-1-dev
       - name: Check out QEMU
         uses: actions/checkout@v4
@@ -28,7 +28,7 @@ jobs:
           git clean -dffx subprojects
           mkdir build-clang
           (cd build-clang &&
-           ../configure --cc=clang-17 --disable-werror --target-list=riscv32-softmmu,riscv64-softmmu)
+           ../configure --cc=clang-18 --disable-werror --target-list=riscv32-softmmu,riscv64-softmmu)
       - name: Build
         run: |
           ninja -C build-clang &&
@@ -69,9 +69,9 @@ jobs:
         run: |
           wget -qO- https://apt.llvm.org/llvm-snapshot.gpg.key |
             sudo tee /etc/apt/trusted.gpg.d/apt.llvm.org.asc &&
-          sudo add-apt-repository "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-17 main" &&
+          sudo add-apt-repository "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-18 main" &&
           sudo apt-get update &&
-          sudo apt-get install -y clang-format-17
+          sudo apt-get install -y clang-format-18
       - name: Check out QEMU
         uses: actions/checkout@v4
       - name: Check execution
@@ -86,9 +86,9 @@ jobs:
         run: |
           wget -qO- https://apt.llvm.org/llvm-snapshot.gpg.key |
             sudo tee /etc/apt/trusted.gpg.d/apt.llvm.org.asc &&
-          sudo add-apt-repository "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-17 main" &&
+          sudo add-apt-repository "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-18 main" &&
           sudo apt-get update &&
-          sudo apt-get install -y clang-tidy-17
+          sudo apt-get install -y clang-tidy-18
       - name: Check out QEMU
         uses: actions/checkout@v4
       - name: Download QEMU source artifacts
@@ -137,7 +137,7 @@ jobs:
         run: |
           wget -qO- https://apt.llvm.org/llvm-snapshot.gpg.key |
           sudo tee /etc/apt/trusted.gpg.d/apt.llvm.org.asc &&
-          sudo add-apt-repository "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-16 main" &&
+          sudo add-apt-repository "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-18 main" &&
           sudo apt-get update &&
           sudo apt-get install -y git make pkg-config gcc cmake ninja-build python3 rust-all \
             libpixman-1-dev

.gitlab-ci.d/opentitan/build.yml

@@ -19,7 +19,7 @@ build-clang:
     - git clean -dffx subprojects
     - mkdir build
     - cd build
-    - ../configure --cc=clang-17 --disable-werror $QEMU_BUILD_OPTS
+    - ../configure --cc=clang-18 --disable-werror $QEMU_BUILD_OPTS
         --target-list=riscv32-softmmu,riscv64-softmmu,x86_64-linux-user
     - ninja
     - ninja qemu-img

.gitlab-ci.d/opentitan/qemu-ot.yml

@@ -1,9 +1,9 @@
 variables:
-  BAREMETAL_REF: "240506-1"
+  BAREMETAL_REF: "240531-1"
   QEMU_BUILD_OPTS: ""
 
 include:
   - local: '/.gitlab-ci.d/opentitan/build.yml'
-  - local: '/.gitlab-ci.d/opentitan/pylint.yml'
+  - local: '/.gitlab-ci.d/opentitan/pylint-ot.yml'
   - local: '/.gitlab-ci.d/opentitan/ot-smoke.yml'
   - local: '/.gitlab-ci.d/opentitan/ot-bmtests.yml'

docs/opentitan/dtm.md

@@ -82,8 +82,8 @@ Extras:
   operation, `--file` argument is mandatory. The content of the binary file is copied into the
   memory, starting at the `--address`. See also the `--elf` option for uploading applications.
 
-* `-P` specify the TCP port of the JTAG server in the QEMU VM, should match the port part of `-jtag`
-  option for invoking QEMU.
+* `-P` specify the TCP port of the JTAG server in the QEMU VM, should follow the TCP setting of the
+  `-chardev socket,id=taprbb,...` option for invoking QEMU.
 
 * `-Q` do not send QEMU a request for termination when this script exits.
 
@@ -106,7 +106,8 @@ Extras:
 
 ### Examples
 
-Running QEMU VM with the `-jtag tcp::3335` option:
+Running QEMU VM with the `-chardev socket,id=taprbb,host=localhost,port=3335,server=on,wait=off`
+option:
 
 * Retrieve JTAG/DTM/DM information and `mtvec` CSR value
   ````sh

docs/opentitan/jtag-dm.md

@@ -46,7 +46,8 @@ See also [JTAG mailbox](jtagmbx.md) and [Life Controller](lc_ctrl_dmi.md) for ot
 The JTAG server supports the Remote Bitbang Protocol which is compatible with other tools such as
 Spike and [OpenOCD](https://github.com/riscv/riscv-openocd).
 
-QEMU should be started with an option such as `-jtag tcp::3335` so that the JTAG server is
+QEMU should be started with an option such as:
+`-chardev socket,id=taprbb,host=localhost,port=3335,server=on,wait=off` so that the JTAG server is
 instantiated and listens for incoming connection on TCP port 3335.
 
 #### Remote termination feature
@@ -58,16 +59,7 @@ example.
 It is nevertheless possible to disable this feature and ignore the remote exit request so that
 multiple JTAG sessions can be run without terminating the QEMU VM.
 
-To disable this feature, use the `quit` option: `-jtag tcp::3335,quit=off`.
-
-#### macOS
-
-If you want to avoid the boring pop-up window from macOS
-```
-Do you want the application “qemu-system-riscv32” to accept incoming network connections?
-```
-restrict the listening interfaces to the localhost with `-jtag tcp:localhost:3335` as QEMU defaults
-to listening on all interfaces, _i.e._ 0.0.0.0
+To disable this feature, use the `quit` option: `-global tap-ctrl-rbb,quit=off`.
 
 #### Implementation
 

docs/opentitan/jtagmbx.md

@@ -28,17 +28,9 @@ where:
   `P` is the private OT bus
   `D` is the debug bus
 
-QEMU should be started with an option such as `-jtag tcp::3335` so that the JTAG server is
-instantiated and listen for incoming connection on TCP port 3335.
-
-#### macOS
-
-If you want to avoid the boring pop-up window from macOS
-```
-Do you want the application “qemu-system-riscv32” to accept incoming network connections?
-```
-restrict the listening interfaces to the localhost with `-jtag tcp:localhost:3335` as QEMU defaults
-to listening on all interfaces, _i.e._ 0.0.0.0
+QEMU should be started with an option such as:
+`-chardev socket,id=taprbb,host=localhost,port=3335,server=on,wait=off` so that the JTAG server is
+instantiated and listens for incoming connection on TCP port 3335.
 
 ## Communicating with JTAG server and JTAG MailBox using Python
 

docs/opentitan/lc_ctrl_dmi.md

@@ -25,17 +25,9 @@ where:
   `P` is the private OT bus
   `D` is the debug bus
 
-QEMU should be started with an option such as `-jtag tcp::3335` so that the JTAG server is
-instantiated and listen for incoming connection on TCP port 3335.
-
-#### macOS
-
-If you want to avoid the boring pop-up window from macOS
-```
-Do you want the application “qemu-system-riscv32” to accept incoming network connections?
-```
-restrict the listening interfaces to the localhost with `-jtag tcp:localhost:3335` as QEMU defaults
-to listening on all interfaces, _i.e._ 0.0.0.0
+QEMU should be started with an option such as:
+`-chardev socket,id=taprbb,host=localhost,port=3335,server=on,wait=off` so that the JTAG server is
+instantiated and listens for incoming connection on TCP port 3335.
 
 ## Communicating with JTAG server and Life Cycle controller using Python
 

docs/opentitan/otpdm.md

@@ -67,8 +67,8 @@ Extras:
 
 * `-l` specify the length of the TAP instruction register length.
 
-* `-P` specify the TCP port of the JTAG server in the QEMU VM, should match the port part of `-jtag`
-       option for invoking QEMU.
+* `-P` specify the TCP port of the JTAG server in the QEMU VM, should follow the TCP setting of the
+  `-chardev socket,id=taprbb,...` option for invoking QEMU.
 
 * `-p` select a partition using its name. See option `-L` to get a list of valid partition names.
        Requires option `-j`.
@@ -85,7 +85,8 @@ Extras:
 
 ### Examples
 
-Running QEMU VM with the `-jtag tcp::3335` option:
+Running QEMU VM with the `-chardev socket,id=taprbb,host=localhost,port=33355,server=on,wait=off`
+option:
 
 * List all supported partitions
   ````sh

docs/opentitan/pymod.md

@@ -0,0 +1,20 @@
+# Python modules for OpenTitan machines
+
+The communication ports of the OpenTitan machines exposed through CharDev devices can be used
+to access the devices from the local host (or also from a remote host when the CharDev is created
+using a TCP socket).
+
+* `scripts/jtag`: JTAG / TAP controller client, using the _Remote BitBang Protocol_
+* `scripts/opentitan/ot`: OpenTitan tools (common to OpenTitan and Rivos SCS machines)
+  * `dtm`: Debug Transport Module support,
+  * `dm`: RISC-V Debug Module support,
+  * `lc_ctrl`: [Life Cycle controller](lc_ctrl_dmi.md) over JTAG/DMI support,
+  * `mailbox`: support for accessing the responder and the requester sides of the DOE mailbox. Also
+    support the [JTAG mailbox](jtagmbx.md) for accessing the mailbox from a JTAG/DMI link.
+  * `otp`: support for parsing and verifing OTP VMEM images, as well as generating and decoding QEMU
+    RAW image files.
+  * `util`: miscellaneous utililies such as ELF format tools and logging utilities
+  * `devproxy`: implementation of the communication channel with the QEMU devproxy device.
+
+Please check the [Python tools](tools,md) documentation for details and scripts that rely
+on these APIs.

docs/opentitan/pyot.md

@@ -5,10 +5,12 @@
 ## Usage
 
 ````text
-usage: pyot.py [-h] [-D DELAY] [-i N] [-L LOG_FILE] [-M LOG] [-m MACHINE] [-Q OPTS] [-q QEMU]
-               [-p DEVICE] [-t TRACE] [-S FIRST_SOC] [-s] [-U] [-b file] [-c JSON] [-e] [-f RAW]
-               [-K] [-l file] [-O RAW] [-o VMEM] [-r ELF] [-w CSV] [-x file] [-X] [-F TEST]
-               [-k SECONDS] [-R] [-T FACTOR] [-Z] [-v] [-d]
+usage: pyot.py [-h] [-D DELAY] [-i ICOUNT] [-L LOG_FILE] [-M LOG] [-m MACHINE]
+               [-Q OPTS] [-q QEMU] [-p DEVICE] [-t TRACE] [-S FIRST_SOC] [-s]
+               [-U] [-b file] [-c JSON] [-e] [-f RAW] [-K] [-l file] [-O RAW]
+               [-o VMEM] [-r ELF] [-w CSV] [-x file] [-X] [-F TEST]
+               [-k SECONDS] [-z] [-R] [-T FACTOR] [-Z] [-v] [-d] [--log-time]
+               [--debug LOGGER] [--info LOGGER] [--warn LOGGER]
 
 OpenTitan QEMU unit test sequencer.
 
@@ -18,53 +20,64 @@ options:
 Virtual machine:
   -D DELAY, --start-delay DELAY
                         QEMU start up delay before initial comm
-  -i N, --icount N      virtual instruction counter with 2^N clock ticks per inst.
+  -i ICOUNT, --icount ICOUNT
+                        virtual instruction counter with 2^ICOUNT clock ticks
+                        per inst. or 'auto'
   -L LOG_FILE, --log_file LOG_FILE
                         log file for trace and log messages
   -M LOG, --log LOG     log message types
   -m MACHINE, --machine MACHINE
                         virtual machine (default to ot-earlgrey)
   -Q OPTS, --opts OPTS  QEMU verbatim option (can be repeated)
-  -q QEMU, --qemu QEMU  path to qemu application (default: build/qemu-system-riscv32)
+  -q QEMU, --qemu QEMU  path to qemu application (default: build/qemu-system-
+                        riscv32)
   -p DEVICE, --device DEVICE
                         serial port device name (default to localhost:8000)
   -t TRACE, --trace TRACE
                         trace event definition file
   -S FIRST_SOC, --first-soc FIRST_SOC
                         Identifier of the first SoC, if any
   -s, --singlestep      enable "single stepping" QEMU execution mode
-  -U, --muxserial       enable multiple virtual UARTs to be muxed into same host output channel
+  -U, --muxserial       enable multiple virtual UARTs to be muxed into same
+                        host output channel
 
 Files:
   -b file, --boot file  bootloader 0 file
   -c JSON, --config JSON
                         path to configuration file
   -e, --embedded-flash  generate an embedded flash image file
   -f RAW, --flash RAW   SPI flash image file
-  -K, --keep-tmp        Do not automatically remove temporary files and dirs on exit
+  -K, --keep-tmp        Do not automatically remove temporary files and dirs
+                        on exit
   -l file, --loader file
                         ROM trampoline to execute, if any
   -O RAW, --otp-raw RAW
                         OTP image file
   -o VMEM, --otp VMEM   OTP VMEM file
-  -r ELF, --rom ELF     ROM file
+  -r ELF, --rom ELF     ROM file (can be repeated, in load order)
   -w CSV, --result CSV  path to output result file
   -x file, --exec file  application to load
   -X, --rom-exec        load application as ROM image (default: as kernel)
 
 Execution:
   -F TEST, --filter TEST
-                        run tests with matching filter, prefix with "!" to exclude matching tests
+                        run tests with matching filter, prefix with "!" to
+                        exclude matching tests
   -k SECONDS, --timeout SECONDS
                         exit after the specified seconds (default: 60 secs)
+  -z, --list            show a list of tests to execute and exit
   -R, --summary         show a result summary
   -T FACTOR, --timeout-factor FACTOR
                         timeout factor
   -Z, --zero            do not error if no test can be executed
 
 Extras:
   -v, --verbose         increase verbosity
-  -d, --debug           enable debug mode
+  -d                    enable debug mode
+  --log-time            show local time in log messages
+  --debug LOGGER        assign debug level to logger(s)
+  --info LOGGER         assign info level to logger(s)
+  --warn LOGGER         assign warning level to logger(s)
 ````
 
 This tool may be used in two ways, which can be combined:
@@ -79,14 +92,8 @@ This tool may be used in two ways, which can be combined:
 * `-D` / `--start-delay` VM start up delay. Grace period to wait for the VM to start up before
   attempting to communicate with its char devices.
 * `-i` / `--icount` to specify virtual instruction counter with 2^N clock ticks per instruction.
-  This option if often used with two specific values:
-   * `-i 0` can be used to improve time synchronisation between the virtual CPU and the virtual HW:
-     as many OpenTitan tests rely on specific CPU clock counts for the HW to complete some action,
-     running QEMU without this option tends to favor CPU execution speed over HW emulation. With
-     this option, the vCPU is better synchronized, trying to emulate a 1GHz-clock vCPU.
-   * `-i 6` can be used to slow down vCPU virtual clock to a ~10-15MHz clock pace, which better
-     matches the expected FPGA-based lowRISC CPU.
-  Note that this option slows down the execution of guest applications.
+  Use 'auto' to enable QEMU adaptive icount counter. Note that this option slows down the execution
+  of guest applications.
 * `-L` / `--log_file` specify the log file for trace and log messages from QEMU.
 * `-M` / `--log` specify which log message types should be logged; most useful types are:
   * `in_asm` for guest instruction disassembly,
@@ -134,7 +141,7 @@ This tool may be used in two ways, which can be combined:
 * `-r` / `--rom` specify a ROM ELF file. Without a ROM file, it is unlikely to start up any regular
   application since the emulated lowRISC vCPU is preconfigured with a locked PMP, as the real HW.
   When no ROM is specified, test applications are executed immediately, as a replacement of the ROM
-  executable.
+  executable. This option may be repeated, to load several ROMs, in the same order as specified
 * `-w` / `--result` specify an output CSV report file where the result of all the QEMU sessions,
   one per test, are reported.
 * `-x` / ` --exec` specify a ROM extension, an application or a test to execute. This option is
@@ -154,12 +161,16 @@ This tool may be used in two ways, which can be combined:
 * `-Z`, `--zero` do not report an error if no test can be executed with the specified filters and
    detected test applications. Default behavior is to report an error should such a condition arise,
    as it likely comes from a misconfiguration or build issue.
+* `-z` / `--list` list all tests to be executed and exit
 
-### File options
+### Extras
 
 * `-v` / `--verbose` can be repeated to increase verbosity of the script, mostly for debug purpose.
-* `-d` / `--debug` only useful to debug the script, reports any Python traceback to the standard
-  error stream.
+* `-d` only useful to debug the script, reports any Python traceback to the standard error stream.
+* `--log-time` show local time before each logged message
+* `--debug` enable the debug level for the selected logger, may be repeated
+* `--info` enable the info level for the selected logger, may be repeated
+* `--warn` enable the warning level for the selected logger, may be repeated
 
 ## Configuration file
 

docs/opentitan/tools.md

@@ -50,9 +50,7 @@ directory to help with these tasks.
 
 ## Python modules
 
-* Available from `scripts/jtag` and `scripts/opentitan/ot`
-* [JTAG mailbox](jtagmbx.md) provides an API to access the system side of the mailbox over JTAG/DMI
-* [LC DMI](lc_ctrl_dmi.md) provides an API to control the Life Cycle controller over JTAG/DMI
+See [Python modules](pymod.md) documentation.
 
 ## Configuration files
 

hw/Kconfig

@@ -71,6 +71,9 @@ source xtensa/Kconfig
 # Ibex Demo System devices
 source ibexdemo/Kconfig
 
+# JTAG devices
+source jtag/Kconfig
+
 # OpenTitan devices
 source opentitan/Kconfig
 

hw/jtag/Kconfig

@@ -0,0 +1,8 @@
+# JTAG devices
+
+config TAP_CTRL
+    bool
+
+config TAP_CTRL_RBB
+    select TAP_CTRL
+    bool

hw/jtag/meson.build

@@ -0,0 +1,2 @@
+system_ss.add(when: 'CONFIG_TAP_CTRL', if_true: files('tap_ctrl.c'))
+system_ss.add(when: 'CONFIG_TAP_CTRL_RBB', if_true: files('tap_ctrl_rbb.c'))