lowRISC · rivos-eblot · Apr 9, 2024 · Apr 8, 2024 · Apr 8, 2024 · Apr 9, 2024
diff --git a/.github/workflows/build_test.yaml b/.github/workflows/build_test.yaml
@@ -1,7 +1,8 @@
+---
 #------------------------------------------------------------------------------
 # QEMU OpenTitan CI
 #
-# Copyright (c) 2023 Rivos, Inc.
+# Copyright (c) 2023-2024 Rivos, Inc.
 # SPDX-License-Identifier: Apache License 2.0
 #------------------------------------------------------------------------------
 
@@ -12,12 +13,13 @@ jobs:
  runs-on: ubuntu-latest
  steps:
  - name: Install deps
- 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 apt-get update &&
- sudo apt-get install -y git make pkg-config clang-16 cmake ninja-build python3 rust-all
- libpixman-1-dev
+ 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 apt-get update &&
+ sudo apt-get install -y git make pkg-config clang-17 cmake ninja-build python3 rust-all \
+ libpixman-1-dev
  - name: Check out QEMU
  uses: actions/checkout@v4
  - name: Configure
@@ -26,7 +28,7 @@ jobs:
  git clean -dffx subprojects
  mkdir build-clang
  (cd build-clang &&
- ../configure --cc=clang-16 --disable-werror --target-list=riscv32-softmmu,riscv64-softmmu)
+ ../configure --cc=clang-17 --disable-werror --target-list=riscv32-softmmu,riscv64-softmmu)
  - name: Build
  run: |
  ninja -C build-clang &&
@@ -64,11 +66,12 @@ jobs:
  runs-on: ubuntu-latest
  steps:
  - name: Install tools
- 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 apt-get update &&
- sudo apt-get install -y clang-format-16
+ 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 apt-get update &&
+ sudo apt-get install -y clang-format-17
  - name: Check out QEMU
  uses: actions/checkout@v4
  - name: Check execution
@@ -80,17 +83,18 @@ jobs:
  needs: build-clang
  steps:
  - name: Install tools
- 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 apt-get update &&
- sudo apt-get install -y clang-tidy-16
+ 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 apt-get update &&
+ sudo apt-get install -y clang-tidy-17
  - name: Check out QEMU
  uses: actions/checkout@v4
  - name: Download QEMU source artifacts
  uses: actions/download-artifact@v3
  with:
-  name: qemu-src
+ name: qemu-src
  - name: Unpack source artifacts
  run: |
  tar xzf qemu-src-artifact.tar.gz
@@ -104,12 +108,13 @@ jobs:
  needs: build-clang
  steps:
  - name: Install tools
- run: sudo apt-get update &&
- sudo apt-get install -y libpixman-1-0
+ run: |
+ sudo apt-get update &&
+ sudo apt-get install -y libpixman-1-0
  - name: Download QEMU binary artifacts
  uses: actions/download-artifact@v3
  with:
-  name: qemu-bin
+ name: qemu-bin
  - name: Check machine availability
  run: |
  chmod +x ./qemu-system-riscv32 &&
@@ -129,12 +134,13 @@ jobs:
  runs-on: ubuntu-latest
  steps:
  - name: Install tools
- 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 apt-get update &&
- sudo apt-get install -y git make pkg-config gcc cmake ninja-build
- python3 rust-all libpixman-1-dev
+ 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 apt-get update &&
+ sudo apt-get install -y git make pkg-config gcc cmake ninja-build python3 rust-all \
+ libpixman-1-dev
  - name: Check out QEMU
  uses: actions/checkout@v4
  - name: Configure

diff --git a/.gitlab-ci.d/opentitan/build.yml b/.gitlab-ci.d/opentitan/build.yml
@@ -1,9 +1,5 @@
 #------------------------------------------------------------------------------
 # QEMU OpenTitan CI
-#
-# apk add llvm rust python3 clang16 clang16-extra-tools cmake ninja-build
-# samurai git make pkgconfig glib-dev pixman-dev zstd py3-pip
-# pip3 install pyelftools hjson
 #------------------------------------------------------------------------------
 
 build-clang:
@@ -23,11 +19,13 @@ build-clang:
  - git clean -dffx subprojects
  - mkdir build
  - cd build
- - ../configure --cc=clang-16 --disable-werror $QEMU_BUILD_OPTS
+ - ../configure --cc=clang-17 --disable-werror $QEMU_BUILD_OPTS
  --target-list=riscv32-softmmu,riscv64-softmmu,x86_64-linux-user
  - ninja
  - ninja qemu-img
  - strip qemu-system-riscv32 qemu-img
+ - QEMU_DIR="$(cd .. && pwd -P)"; cat compile_commands.json |
+ sed -E 's,'"$QEMU_DIR"',@QEMU_DIR@,g' > compile_commands.json.tpl
  - ../scripts/opentitan/swexit.py -t earlgrey -o exit_eg.bin
  - ../scripts/opentitan/swexit.py -t darjeeling -o exit_dj.bin
  artifacts:
@@ -39,7 +37,7 @@ build-clang:
  - build/*.h
  - build/qapi/*.h
  - build/trace/*.h
- - build/compile_commands.json
+ - build/compile_commands.json.tpl
  - build/qemu-system-riscv32
  - build/qemu-img
  - build/exit_*.bin
@@ -72,4 +70,6 @@ tidy:
  stage: build
  needs: ["build-clang"]
  script:
+ - QEMU_DIR="$(pwd -P)"; cat build/compile_commands.json.tpl |
+ sed -E 's,@QEMU_DIR@,'"$QEMU_DIR"',g' > build/compile_commands.json
  - scripts/opentitan/ot-tidy.sh --ci -p build
diff --git a/hw/opentitan/ot_gpio_dj.c b/hw/opentitan/ot_gpio_dj.c
@@ -256,7 +256,7 @@ static void ot_gpio_dj_in_change(void *opaque, int no, int level)
 {
  OtGpioDjState *s = opaque;
 
- trace_ot_gpio_in_change(s->ot_id, no, level<0, level> 0);
+ trace_ot_gpio_in_change(s->ot_id, no, level < 0, level > 0);
 
  g_assert(no < PARAM_NUM_IO);
 

diff --git a/hw/opentitan/ot_gpio_eg.c b/hw/opentitan/ot_gpio_eg.c
@@ -235,7 +235,7 @@ static void ot_gpio_eg_in_change(void *opaque, int no, int level)
 {
  OtGpioEgState *s = opaque;
 
- trace_ot_gpio_in_change(s->ot_id, no, level<0, level> 0);
+ trace_ot_gpio_in_change(s->ot_id, no, level < 0, level > 0);
 
  g_assert(no < PARAM_NUM_IO);
 

diff --git a/hw/opentitan/ot_pinmux_dj.c b/hw/opentitan/ot_pinmux_dj.c
@@ -156,7 +156,7 @@ REG32(WKUP_CAUSE,
 #define REGS_SIZE (REGS_COUNT * sizeof(uint32_t))
 #define CASE_SCALAR(_reg_) R_##_reg_
 #define CASE_RANGE(_reg_, _rpt_) R_##_reg_...(R_##_reg_ + (_rpt_) - (1u))
-#define PAD_ATTR_TO_IRQ(_pad_) ((int)((_pad_)&INT32_MAX))
+#define PAD_ATTR_TO_IRQ(_pad_) ((int)((_pad_) & INT32_MAX))
 #define PAD_ATTR_ENABLE(_en_) (((unsigned)!(_en_)) << 31u)
 
 static_assert((OT_PINMUX_PAD_ATTR_MASK | OT_PINMUX_PAD_ATTR_FORCE_MODE_MASK) <

diff --git a/hw/opentitan/ot_pinmux_eg.c b/hw/opentitan/ot_pinmux_eg.c
@@ -157,7 +157,7 @@ REG32(WKUP_CAUSE,
 #define REGS_SIZE (REGS_COUNT * sizeof(uint32_t))
 #define CASE_SCALAR(_reg_) R_##_reg_
 #define CASE_RANGE(_reg_, _rpt_) R_##_reg_...(R_##_reg_ + (_rpt_) - (1u))
-#define PAD_ATTR_TO_IRQ(_pad_) ((int)((_pad_)&INT32_MAX))
+#define PAD_ATTR_TO_IRQ(_pad_) ((int)((_pad_) & INT32_MAX))
 #define PAD_ATTR_ENABLE(_en_) (((unsigned)!(_en_)) << 31u)
 
 static_assert((OT_PINMUX_PAD_ATTR_MASK | OT_PINMUX_PAD_ATTR_FORCE_MODE_MASK) <

diff --git a/hw/opentitan/ot_spi_device.c b/hw/opentitan/ot_spi_device.c
@@ -337,7 +337,7 @@ static_assert(SPI_SRAM_END_OFFSET == 0xe80u, "Invalid SRAM definition");
 static_assert((1u << FIFO_PHASE_BIT) >= GENERIC_BUFFER_SIZE,
  "Invalid phase bit");
 #define FIFO_PTR_MASK ((1u << FIFO_PHASE_BIT) - 1u)
-#define FIFO_PTR(_ptr_) ((_ptr_)&FIFO_PTR_MASK)
+#define FIFO_PTR(_ptr_) ((_ptr_) & FIFO_PTR_MASK)
 #define FIFO_PHASE(_ptr_) ((bool)((_ptr_) >> (FIFO_PHASE_BIT)))
 #define FIFO_MAKE_PTR(_phase_, _ptr_) \
  ((((unsigned)(bool)(_phase_)) << FIFO_PHASE_BIT) | FIFO_PTR(_ptr_))
@@ -649,7 +649,7 @@ static const char *TPM_REG_NAMES[TPM_REGS_COUNT] = {
 #define JEDEC_ID_MASK (R_JEDEC_ID_ID_MASK | R_JEDEC_ID_MF_MASK)
 
 #define COMMAND_OPCODE(_cmd_info_) \
- ((uint8_t)((_cmd_info_)&CMD_INFO_OPCODE_MASK))
+ ((uint8_t)((_cmd_info_) & CMD_INFO_OPCODE_MASK))
 #define FLASH_SLOT(_name_) ((R_CMD_INFO_##_name_) - R_CMD_INFO_0)
 
 #define STATE_NAME_ENTRY(_st_) [_st_] = stringify(_st_)

diff --git a/hw/opentitan/ot_uart.c b/hw/opentitan/ot_uart.c
@@ -394,6 +394,8 @@ static uint64_t ot_uart_read(void *opaque, hwaddr addr, unsigned size)
  case OT_UART_RX_FIFO_SIZE:
  val32 |= R_STATUS_RXFULL_MASK;
  break;
+ default:
+ break;
  }
  /* report TXEMPTY+TXIDLE or TXFULL */
  switch (fifo8_num_used(&s->tx_fifo)) {
@@ -403,6 +405,8 @@ static uint64_t ot_uart_read(void *opaque, hwaddr addr, unsigned size)
  case OT_UART_TX_FIFO_SIZE:
  val32 |= R_STATUS_TXFULL_MASK;
  break;
+ default:
+ break;
  }
  if (!ot_uart_is_tx_enabled(s)) {
  val32 |= R_STATUS_TXIDLE_MASK;

diff --git a/include/exec/jtagstub.h b/include/exec/jtagstub.h
@@ -51,8 +51,8 @@ struct _TAPDataHandler {
  * @_ver_ Version
  */
 #define JTAG_IDCODE(_mfid_, _pnum_, _ver_) \
- ((((_ver_)&0xfu) << 28u) | (((_pnum_)&0xffffu) << 12u) | \
- (((_mfid_)&0x7ffu) << 1u) | 0b1)
+ ((((_ver_) & 0xfu) << 28u) | (((_pnum_) & 0xffffu) << 12u) | \
+ (((_mfid_) & 0x7ffu) << 1u) | 0b1)
 
 /*
  * Create JEDEC Manufacturer ID
@@ -61,7 +61,7 @@ struct _TAPDataHandler {
  * @_id_ Entry in JEDEC table
  */
 #define JEDEC_MANUFACTURER_ID(_tbl_, _id_) \
- (((((_tbl_)-1u) & 0xfu) << 7u) | ((_id_)&0x7fu))
+ (((((_tbl_)-1u) & 0xfu) << 7u) | ((_id_) & 0x7fu))
 
 /*
  * Start the JTAG server

diff --git a/include/hw/riscv/ibex_common.h b/include/hw/riscv/ibex_common.h
@@ -58,7 +58,7 @@ enum {
 /* ------------------------------------------------------------------------ */
 
 #define IBEX_JTAG_PART_NUM(_part_, _tap_) \
- ((((_part_)&0xfffu) << 4u) | ((_tap_)&0xfu))
+ ((((_part_) & 0xfffu) << 4u) | ((_tap_) & 0xfu))
 
 #define LOWRISC_JEDEC_MANUFACTURER_ID 0x6fu /* MSB is parity bit, ignored */
 #define LOWRISC_JEDEC_TABLE 13u
@@ -199,31 +199,31 @@ typedef struct {
  ((_addr_) | (((uint32_t)_flag_) & IBEX_MEMMAP_REGIDX_MASK))
 #define IBEX_MEMMAP_MAKE_REG_MASK(_flag_) (1u << (_flag_))
 #define IBEX_MEMMAP_DEFAULT_REG_MASK (1u << 0u)
-#define IBEX_MEMMAP_GET_REGIDX(_addr_) ((_addr_)&IBEX_MEMMAP_REGIDX_MASK)
+#define IBEX_MEMMAP_GET_REGIDX(_addr_) ((_addr_) & IBEX_MEMMAP_REGIDX_MASK)
 #define IBEX_MEMMAP_GET_ADDRESS(_addr_) ((_addr_) & ~IBEX_MEMMAP_REGIDX_MASK)
 
 #define IBEX_GPIO_GRP_BITS 5u
 #define IBEX_GPIO_GRP_COUNT (1u << (IBEX_GPIO_GRP_BITS))
 #define IBEX_GPIO_GRP_SHIFT (32u - IBEX_GPIO_GRP_BITS)
 #define IBEX_GPIO_GRP_MASK ((IBEX_GPIO_GRP_COUNT)-1u) << (IBEX_GPIO_GRP_SHIFT)
 #define IBEX_GPIO_IDX_MASK (~(IBEX_GPIO_GRP_MASK))
-#define IBEX_GPIO_GET_IDX(_idx_) ((_idx_)&IBEX_GPIO_IDX_MASK)
+#define IBEX_GPIO_GET_IDX(_idx_) ((_idx_) & IBEX_GPIO_IDX_MASK)
 #define IBEX_GPIO_GET_GRP(_idx_) \
  (((_idx_) & (IBEX_GPIO_GRP_MASK)) >> IBEX_GPIO_GRP_SHIFT)
 #define IBEX_GPIO_MAKE_GRPIDX(_grp_, _ix_) \
- (((_grp_) << IBEX_GPIO_GRP_SHIFT) | ((_ix_)&IBEX_GPIO_IDX_MASK))
+ (((_grp_) << IBEX_GPIO_GRP_SHIFT) | ((_ix_) & IBEX_GPIO_IDX_MASK))
 
 #define IBEX_DEVLINK_RMT_BITS 8u
 #define IBEX_DEVLINK_RMT_COUNT (1u << (IBEX_DEVLINK_RMT_BITS))
 #define IBEX_DEVLINK_RMT_SHIFT (32u - IBEX_DEVLINK_RMT_BITS)
 #define IBEX_DEVLINK_RMT_MASK \
  ((IBEX_DEVLINK_RMT_COUNT)-1u) << (IBEX_DEVLINK_RMT_SHIFT)
 #define IBEX_DEVLINK_IDX_MASK (~(IBEX_DEVLINK_RMT_MASK))
-#define IBEX_DEVLINK_DEVICE(_idx_) ((_idx_)&IBEX_DEVLINK_IDX_MASK)
+#define IBEX_DEVLINK_DEVICE(_idx_) ((_idx_) & IBEX_DEVLINK_IDX_MASK)
 #define IBEX_DEVLINK_REMOTE(_idx_) \
  (((_idx_) & (IBEX_DEVLINK_RMT_MASK)) >> IBEX_DEVLINK_RMT_SHIFT)
 #define IBEX_DEVLINK_MAKE_RMTDEV(_par_, _ix_) \
- (((_par_) << IBEX_DEVLINK_RMT_SHIFT) | ((_ix_)&IBEX_DEVLINK_IDX_MASK))
+ (((_par_) << IBEX_DEVLINK_RMT_SHIFT) | ((_ix_) & IBEX_DEVLINK_IDX_MASK))
 
 /* MemMapEntry that should be ignored (i.e. skipped, not mapped) */
 #define MEMMAPSKIP \

diff --git a/scripts/opentitan/clang-tidy.yml b/scripts/opentitan/clang-tidy.yml
@@ -20,6 +20,7 @@ Checks: '*,
  -hicpp-signed-bitwise,
  -llvmlibc-*,
  -llvm-include-order,
+ -misc-include-cleaner,
  -modernize-macro-to-enum,
  -performance-no-int-to-ptr,
  -readability-function-cognitive-complexity,

diff --git a/scripts/opentitan/ot-format.sh b/scripts/opentitan/ot-format.sh
@@ -3,9 +3,9 @@
 # Copyright (c) 2024 Rivos, Inc.
 # SPDX-License-Identifier: Apache2
 
-EXPECTED_VERSION="16"
+EXPECTED_VERSION="17"
 
-# find clang-format executable: either 'clang-format-16' or 'clang-format'
+# find clang-format executable: either 'clang-format-17' or 'clang-format'
 for ver_suffix in "-${EXPECTED_VERSION}" ""; do
  clangformat="$(which clang-format${ver_suffix} 2>/dev/null)"
  if [ -n "${clangformat}" ]; then

diff --git a/scripts/opentitan/ot-tidy.sh b/scripts/opentitan/ot-tidy.sh
@@ -3,9 +3,9 @@
 # Copyright (c) 2024 Rivos, Inc.
 # SPDX-License-Identifier: Apache2
 
-EXPECTED_VERSION="16"
+EXPECTED_VERSION="17"
 
-# find clang-tidy executable: either 'clang-tidy-16' or 'clang-tidy'
+# find clang-tidy executable: either 'clang-tidy-17' or 'clang-tidy'
 for ver_suffix in "-${EXPECTED_VERSION}" ""; do
  clangtidy="$(which clang-tidy${ver_suffix} 2>/dev/null)"
  if [ -n "${clangtidy}" ]; then

diff --git a/target/riscv/pmp.h b/target/riscv/pmp.h
@@ -22,7 +22,9 @@
 #ifndef RISCV_PMP_H
 #define RISCV_PMP_H
 
-#include "cpu.h"
+#ifndef RISCV_CPU_H
+#error must include cpu.h header
+#endif
 
 typedef enum {
  PMP_READ = 1 << 0,