commit 249a633cb64ed62083a0deeba593b83e5e1d4808
author Philipp Wagner <phw@lowrisc.org> Tue Jun 15 23:41:07 2021 +0100
committer Philipp Wagner <mail@philipp-wagner.com> Thu Jul 15 17:21:49 2021 +0100
tree 7edf1327151663598799a17264634bd2aa2db7af
parent bd46e9c75f9eee7b597e9a78457c98309dd059cf

[otbn/sw] Introduce otbn_dump_dmem()

A development helper function to dump (a subset of) OTBN's data memory.

Signed-off-by: Philipp Wagner <phw@lowrisc.org>

sw/device/lib/runtime/meson.build

diff --git a/sw/device/lib/runtime/meson.build b/sw/device/lib/runtime/meson.build
index e0db625..12eef7a 100644
--- a/sw/device/lib/runtime/meson.build
+++ b/sw/device/lib/runtime/meson.build
@@ -85,6 +85,7 @@
       sw_lib_dif_otbn,
       sw_lib_mmio,
       sw_lib_runtime_hart,
+      sw_lib_runtime_log,
     ]
   )
 )

sw/device/lib/runtime/otbn.c

diff --git a/sw/device/lib/runtime/otbn.c b/sw/device/lib/runtime/otbn.c
index d3921e4..2e721c4 100644
--- a/sw/device/lib/runtime/otbn.c
+++ b/sw/device/lib/runtime/otbn.c
@@ -5,6 +5,12 @@
 #include "sw/device/lib/runtime/otbn.h"
 
 #include "sw/device/lib/dif/dif_otbn.h"
+#include "sw/device/lib/runtime/log.h"
+
+/**
+ * Data width of big number subset, in bytes.
+ */
+const int kOtbnWlenBytes = 256 / 8;
 
 otbn_result_t otbn_func_ptr_to_imem_addr(const otbn_t *ctx, otbn_ptr_t ptr,
                                          uint32_t *imem_addr_otbn) {
@@ -174,3 +180,25 @@
   }
   return retval;
 }
+
+otbn_result_t otbn_dump_dmem(const otbn_t *ctx, uint32_t max_addr) {
+  if (ctx == NULL || max_addr % kOtbnWlenBytes != 0 ||
+      max_addr > dif_otbn_get_dmem_size_bytes(&ctx->dif)) {
+    return kOtbnBadArg;
+  }
+
+  if (max_addr == 0) {
+    max_addr = dif_otbn_get_dmem_size_bytes(&ctx->dif);
+  }
+
+  for (int i = 0; i < max_addr; i += kOtbnWlenBytes) {
+    uint32_t data[kOtbnWlenBytes / sizeof(uint32_t)];
+    dif_otbn_dmem_read(&ctx->dif, i, data, kOtbnWlenBytes);
+
+    LOG_INFO("DMEM @%04d: 0x%08x%08x%08x%08x%08x%08x%08x%08x",
+             i / kOtbnWlenBytes, data[7], data[6], data[5], data[4], data[3],
+             data[2], data[1], data[0]);
+  }
+
+  return kOtbnOk;
+}

sw/device/lib/runtime/otbn.h

diff --git a/sw/device/lib/runtime/otbn.h b/sw/device/lib/runtime/otbn.h
index b0cc9af..0082681 100644
--- a/sw/device/lib/runtime/otbn.h
+++ b/sw/device/lib/runtime/otbn.h
@@ -259,4 +259,14 @@
 otbn_result_t otbn_data_ptr_to_dmem_addr(const otbn_t *ctx, otbn_ptr_t ptr,
                                          uint32_t *dmem_addr_otbn);
 
+/**
+ * Writes a LOG_INFO message with the contents of each 256b DMEM word.
+ *
+ * @param ctx The context object.
+ * @param max_addr The highest address to dump. Set to 0 to output the whole
+ *                 DMEM. Must be a multiple of WLEN.
+ * @return The result of the operation.
+ */
+otbn_result_t otbn_dump_dmem(const otbn_t *ctx, uint32_t max_addr);
+
 #endif  // OPENTITAN_SW_DEVICE_LIB_RUNTIME_OTBN_H_