[ot] hw/opentitan: ot_spi_device: add trace events for passthrough mode

Signed-off-by: Alice Ziuziakowska <[email protected]>

Author: ziuziakowska

hw/opentitan/ot_spi_device.c

@@ -997,7 +997,7 @@ ot_spi_device_flash_match_command_slot(OtSPIDeviceState *s, uint8_t cmd)
         }
     }
 
-    trace_ot_spi_device_flash_ignored_command(s->ot_id, "unmatched", cmd);
+    trace_ot_spi_device_flash_unmatched_command(s->ot_id, cmd);
     return false;
 }
 
@@ -1521,46 +1521,55 @@ static bool ot_spi_device_flash_try_intercept_hw_command(OtSPIDeviceState *s)
     SpiDeviceFlash *f = &s->flash;
 
     uint32_t intercept_val32 = s->spi_regs[R_INTERCEPT_EN];
+    bool intercepted = false;
+
     switch (f->slot) {
     case SLOT_HW_READ_STATUS1:
     case SLOT_HW_READ_STATUS2:
     case SLOT_HW_READ_STATUS3:
         if (FIELD_EX32(intercept_val32, INTERCEPT_EN, STATUS)) {
             ot_spi_device_flash_decode_read_status(s);
-            return true;
+            intercepted = true;
         }
-        return false;
+        break;
     case SLOT_HW_READ_JEDEC:
         if (FIELD_EX32(intercept_val32, INTERCEPT_EN, JEDEC)) {
             ot_spi_device_flash_decode_read_jedec(s);
-            return true;
+            intercepted = true;
         }
-        return false;
+        break;
     case SLOT_HW_READ_SFDP:
         if (FIELD_EX32(intercept_val32, INTERCEPT_EN, SFDP)) {
             ot_spi_device_flash_decode_read_sfdp(s);
-            return true;
+            intercepted = true;
         }
-        return false;
+        break;
     case SLOT_HW_READ_NORMAL:
     case SLOT_HW_READ_FAST:
     case SLOT_HW_READ_DUAL:
     case SLOT_HW_READ_QUAD:
     case SLOT_HW_READ_DUAL_IO:
     case SLOT_HW_READ_QUAD_IO:
         /* We try to intercept at every read after an address is given */
-        return false;
+        break;
     case SLOT_HW_EN4B:
     case SLOT_HW_EX4B:
         ot_spi_device_flash_decode_addr4_enable(s);
-        return true;
+        intercepted = true;
+        break;
     case SLOT_HW_WREN:
     case SLOT_HW_WRDI:
         /* These HW commands cannot be intercepted */
-        return false;
+        break;
     default:
-        return false;
+        break;
     }
+
+    if (intercepted) {
+        trace_ot_spi_device_flash_intercepted_command(s->ot_id, f->slot);
+    }
+
+    return intercepted;
 }
 
 static void
@@ -1601,9 +1610,13 @@ ot_spi_device_flash_passthrough_addr(OtSPIDeviceState *s, uint8_t rx)
     f->buffer[f->pos] = rx;
     if (f->cmd_addr_swap_en) {
         unsigned byte_sel = (f->len - f->pos - 1u);
-        rx = ot_spi_device_swap_byte_data(rx, byte_sel,
-                                          s->spi_regs[R_ADDR_SWAP_MASK],
-                                          s->spi_regs[R_ADDR_SWAP_DATA]);
+        uint8_t swapped_rx =
+            ot_spi_device_swap_byte_data(rx, byte_sel,
+                                         s->spi_regs[R_ADDR_SWAP_MASK],
+                                         s->spi_regs[R_ADDR_SWAP_DATA]);
+        trace_ot_spi_device_flash_swap_byte(s->ot_id, "address", byte_sel, rx,
+                                            swapped_rx);
+        rx = swapped_rx;
     }
 
     (void)ssi_transfer(s->spi, (uint32_t)rx);
@@ -1648,9 +1661,13 @@ ot_spi_device_flash_passthrough_payload(OtSPIDeviceState *s, uint8_t rx)
 
     g_assert(f->cmd_payload_swap_en);
 
-    rx = ot_spi_device_swap_byte_data(rx, f->pos,
-                                      s->spi_regs[R_PAYLOAD_SWAP_MASK],
-                                      s->spi_regs[R_PAYLOAD_SWAP_DATA]);
+    uint8_t swapped_rx =
+        ot_spi_device_swap_byte_data(rx, f->pos,
+                                     s->spi_regs[R_PAYLOAD_SWAP_MASK],
+                                     s->spi_regs[R_PAYLOAD_SWAP_DATA]);
+    trace_ot_spi_device_flash_swap_byte(s->ot_id, "payload", f->pos, rx,
+                                        swapped_rx);
+    rx = swapped_rx;
 
     (void)ssi_transfer(s->spi, (uint32_t)rx);
 
@@ -1668,6 +1685,8 @@ static uint8_t ot_spi_device_flash_passthrough_read(OtSPIDeviceState *s)
         if (f->slot >= SLOT_HW_READ_NORMAL && f->slot <= SLOT_HW_READ_QUAD_IO) {
             if (ot_spi_device_get_command_address_size(s) != 0u) {
                 if (ot_spi_device_is_mailbox_match(s, f->address)) {
+                    trace_ot_spi_device_flash_intercept_mailbox(s->ot_id,
+                                                                f->address);
                     uint8_t *mbx = (uint8_t *)&s->sram[SPI_SRAM_MBX_OFFSET];
                     uint8_t tx = mbx[f->address & (SPI_SRAM_MBX_SIZE - 1u)];
                     f->address += 1u;
@@ -1727,6 +1746,7 @@ ot_spi_device_flash_transfer_passthrough(OtSPIDeviceState *s, uint8_t rx)
 
         if (ot_spi_device_flash_passthrough_filter(s, rx)) {
             /* command opcode is filtered, discard all bytes untl next CS */
+            trace_ot_spi_device_flash_filtered_command(s->ot_id, rx);
             FLASH_CHANGE_STATE(s, IDLE);
             BUS_CHANGE_STATE(s, DISCARD);
             break;

hw/opentitan/trace-events

@@ -548,18 +548,22 @@ ot_spi_device_flash_transfer(const char *id, const char *dir, uint8_t byte) "%s:
 ot_spi_device_flash_byte_unexpected(const char *id, uint8_t rx) "%s: unexpected byte 0x%02x after completed command"
 ot_spi_device_flash_change_state(const char *id, int line, const char *prev, int preval, const char *next, int nextval) "%s: @%d: %s[%d] -> %s[%d]"
 ot_spi_device_flash_cross_buffer(const char *id, const char *msg, uint32_t addr) "%s: %s 0x%08x"
-ot_spi_device_flash_disabled_slot(const char *id, uint8_t cmd, unsigned slot) "%s: cmd 0x%02x matched, disabled slot %u"
+ot_spi_device_flash_disabled_slot(const char *id, uint8_t cmd, unsigned slot) "%s: cmd 0x%02x matched disabled slot %u"
 ot_spi_device_flash_exec(const char *id, const char *cmd) "%s: %s"
-ot_spi_device_flash_ignored_command(const char *id, const char* msg, uint8_t cmd) "%s: %s cmd 0x%02x"
-ot_spi_device_flash_new_command(const char *id, const char* type, uint8_t cmd, unsigned slot) "%s: %s CMD 0x%02X slot %u"
+ot_spi_device_flash_filtered_command(const char *id, uint8_t cmd) "%s: filtered cmd %02x"
+ot_spi_device_flash_intercepted_command(const char *id, unsigned slot) "%s: intercepted HW cmd slot %u"
+ot_spi_device_flash_intercept_mailbox(const char *id, uint32_t addr) "%s: intercepted read addr:0x%08x to mailbox region"
+ot_spi_device_flash_new_command(const char *id, const char* type, uint8_t cmd, unsigned slot) "%s: %s CMD 0x%02x slot %u"
 ot_spi_device_flash_overflow(const char *id, const char *msg) "%s: %s"
 ot_spi_device_flash_pace(const char *id, const char *msg, bool pending) "%s: %s: %u"
 ot_spi_device_flash_payload(const char *id, unsigned fpos, unsigned idx, unsigned len) "%s: pos:%u idx:%u len:%u"
 ot_spi_device_flash_push_address(const char *id, uint32_t address) "%s: 0x%08x"
 ot_spi_device_flash_set_read_addr(const char *id, uint32_t addr) "%s: 0x%08x"
+ot_spi_device_flash_swap_byte(const char *id, const char *type, unsigned byte_num, uint8_t prev, uint8_t cur) "%s: swapped %s byte %u 0x%02x -> 0x%02x"
 ot_spi_device_flash_read_status(const char *id, unsigned slot, uint8_t status) "%s: sr[%u] 0x%02x"
 ot_spi_device_flash_read_threshold(const char *id, uint32_t addr, uint32_t threshold) "%s: 0x%08x @ 0x%08x"
 ot_spi_device_flash_unknown_command(const char *id, uint8_t opcode) "%s: 0x%02x"
+ot_spi_device_flash_unmatched_command(const char *id, uint8_t cmd) "%s: unmatched cmd 0x%02x"
 ot_spi_device_flash_upload(const char *id, unsigned slot, uint32_t cmd_info, bool busy) "%s: slot:%d info:0x%08x busy:%u"
 ot_spi_device_gen_fifo_error(const char *id, const char *msg) "%s: %s"
 ot_spi_device_gen_phase(const char *id, const char *func, unsigned off, unsigned lim, bool phase) "%s: %s off:0x%03x lim:0x%03x ph:%u"