[sival/hmac] Add Hmac Endianness Test

Signed-off-by: Ramesh Prakash <[email protected]>
Add HMAC endianness test as per the chip_hmac_testplan.hjson

hw/top_earlgrey/data/ip/chip_hmac_testplan.hjson

@@ -161,7 +161,7 @@
       si_stage: SV3
       lc_states: ["PROD"]
       tests: []
-      bazel: []
+      bazel: ["//sw/device/tests:hmac_endianness_test"]
     }
     {
       name: chip_sw_hmac_secure_wipe

sw/device/tests/BUILD

@@ -7386,3 +7386,27 @@ opentitan_test(
         "//sw/device/lib/testing/test_framework:ottf_main",
     ],
 )
+
+opentitan_test(
+    name = "hmac_endianness_test",
+    srcs = ["hmac_endianness_test.c"],
+    exec_env = dicts.add(
+        EARLGREY_SILICON_OWNER_ROM_EXT_ENVS,
+        {
+            "//hw/top_earlgrey:sim_verilator": None,
+            "//hw/top_earlgrey:fpga_cw340_sival": None,
+        },
+    ),
+    verilator = verilator_params(
+        timeout = "long",
+    ),
+    deps = [
+        "//hw/top_earlgrey/sw/autogen:top_earlgrey",
+        "//sw/device/lib/arch:device",
+        "//sw/device/lib/base:mmio",
+        "//sw/device/lib/dif:hmac",
+        "//sw/device/lib/runtime:log",
+        "//sw/device/lib/testing:hmac_testutils",
+        "//sw/device/lib/testing/test_framework:ottf_main",
+    ],
+)

sw/device/tests/hmac_endianness_test.c

@@ -0,0 +1,185 @@
+// Copyright lowRISC contributors (OpenTitan project).
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+#include "sw/device/lib/arch/device.h"
+#include "sw/device/lib/base/abs_mmio.h"
+#include "sw/device/lib/base/bitfield.h"
+#include "sw/device/lib/base/memory.h"
+#include "sw/device/lib/base/mmio.h"
+#include "sw/device/lib/dif/dif_hmac.h"
+#include "sw/device/lib/runtime/log.h"
+#include "sw/device/lib/testing/hmac_testutils.h"
+#include "sw/device/lib/testing/test_framework/check.h"
+#include "sw/device/lib/testing/test_framework/ottf_main.h"
+
+#include "hmac_regs.h"
+#include "hw/top_earlgrey/sw/autogen/top_earlgrey.h"
+#include "sw/device/lib/dif/autogen/dif_hmac_autogen.h"
+
+OTTF_DEFINE_TEST_CONFIG();
+
+static const dif_hmac_transaction_t kHmacconfig_littled_littlem = {
+    .digest_endianness = kDifHmacEndiannessLittle,
+    .message_endianness = kDifHmacEndiannessLittle,
+};
+
+static const dif_hmac_transaction_t kHmacconfig_littled_bigm = {
+    .digest_endianness = kDifHmacEndiannessLittle,
+    .message_endianness = kDifHmacEndiannessBig,
+};
+
+static const dif_hmac_transaction_t kHmacconfig_bigd_littlem = {
+    .digest_endianness = kDifHmacEndiannessBig,
+    .message_endianness = kDifHmacEndiannessLittle,
+};
+
+static const dif_hmac_transaction_t kHmacconfig_bigd_bigm = {
+    .digest_endianness = kDifHmacEndiannessBig,
+    .message_endianness = kDifHmacEndiannessBig,
+};
+
+static const char kData[142] =
+    "Every one suspects himself of at least one of "
+    "the cardinal virtues, and this is mine: I am "
+    "one of the few honest people that I have ever "
+    "known";
+
+static const char kData2[8] = "Help Us ";
+static const char kData2_endian[8] = "pleH sU ";
+// static const char kData2_endian[8] = " sU pleH";
+
+static const dif_hmac_digest_t kExpectedShaDigest = {
+    .digest =
+        {
+            0xd6c6c94e,
+            0xf7cff519,
+            0x45c76d42,
+            0x9d37a8b8,
+            0xe2762fe9,
+            0x71ff68cb,
+            0x68e236af,
+            0x3dc296dc,
+        },
+};
+
+static const dif_hmac_digest_t kExpectedShaDigest_bigendian = {
+    .digest =
+        {
+            0x4ec9c6d6,
+            0x19f5cff7,
+            0x426dc745,
+            0xb8a8379d,
+            0xe92f76e2,
+            0xcb68ff71,
+            0xaf36e268,
+            0xdc96c23d,
+        },
+};
+
+static const dif_hmac_digest_t kExpectedShaDigest_shortmessage = {
+    .digest =
+        {
+            0x8ce72131,
+            0xd5ac567a,
+            0x234045e8,
+            0x04f2ac21,
+            0x29e62b92,
+            0x99255af0,
+            0x392a3664,
+            0x31066f19,
+        },
+};
+
+static const dif_hmac_digest_t kExpectedShaDigest_shortmessage_bigendian = {
+    .digest =
+        {
+            0x3121e78c,
+            0x7a56acd5,
+            0xe8454023,
+            0x21acf204,
+            0x922be629,
+            0xf05a2599,
+            0x64362a39,
+            0x196f0631,
+        },
+};
+
+/**
+ * Initialize the HMAC engine. Return `true` if the configuration is valid.
+ */
+static void test_setup(mmio_region_t base_addr, dif_hmac_t *hmac) {
+  CHECK_DIF_OK(dif_hmac_init(base_addr, hmac));
+}
+static void test_start_endian_cfg(const dif_hmac_t *hmac, const uint8_t *key,
+                                  const dif_hmac_transaction_t config) {
+  // Let a null key indicate we are operating in SHA256-only mode.
+  if (key == NULL) {
+    CHECK_DIF_OK(dif_hmac_mode_sha256_start(hmac, config));
+  } else {
+    CHECK_DIF_OK(dif_hmac_mode_hmac_start(hmac, key, config));
+  }
+}
+
+/**
+ * Kick off the HMAC (or SHA256) run.
+ */
+static void run_hmac(const dif_hmac_t *hmac) {
+  CHECK_DIF_OK(dif_hmac_process(hmac));
+}
+
+static void run_test_endianness(const dif_hmac_t *hmac, const char *data,
+                                size_t len, const uint8_t *key,
+                                const dif_hmac_transaction_t config,
+                                const dif_hmac_digest_t *expected_digest) {
+  test_start_endian_cfg(hmac, key, config);
+  CHECK_STATUS_OK(hmac_testutils_push_message(hmac, data, len));
+  CHECK_STATUS_OK(hmac_testutils_fifo_empty_polled(hmac));
+  CHECK_STATUS_OK(hmac_testutils_check_message_length(hmac, len * 8));
+  run_hmac(hmac);
+  CHECK_STATUS_OK(
+      hmac_testutils_finish_and_check_polled(hmac, expected_digest));
+}
+
+bool test_main(void) {
+  LOG_INFO("Running HMAC DIF test...");
+  dif_hmac_t hmac;
+  test_setup(mmio_region_from_addr(TOP_EARLGREY_HMAC_BASE_ADDR), &hmac);
+
+  LOG_INFO(
+      "Running test SHA256 pass little-endian digest and little-endian "
+      "message...");
+  run_test_endianness(&hmac, kData, sizeof(kData), NULL,
+                      kHmacconfig_littled_littlem, &kExpectedShaDigest);
+
+  LOG_INFO(
+      "Running test SHA256 with big-endian digest,little-endian message "
+      "config...");
+  run_test_endianness(&hmac, kData, sizeof(kData), NULL,
+                      kHmacconfig_bigd_littlem, &kExpectedShaDigest_bigendian);
+
+  LOG_INFO(
+      "Running test SHA256 pass with big-endian digest,big endian message "
+      "config... ");
+  run_test_endianness(&hmac, kData2, sizeof(kData2), NULL,
+                      kHmacconfig_bigd_bigm,
+                      &kExpectedShaDigest_shortmessage_bigendian);
+
+  LOG_INFO(
+      "Running test SHA256 pass little-endian digest, big endian message "
+      "config... ");
+  run_test_endianness(&hmac, kData2, sizeof(kData2), NULL,
+                      kHmacconfig_littled_bigm,
+                      &kExpectedShaDigest_shortmessage);
+
+  LOG_INFO(
+      "Running test SHA256 pass big-endian digest, little endian message "
+      "config \n"
+      " with input message byte-swapped to verify the in-built byteswap "
+      "function..");
+  run_test_endianness(&hmac, kData2_endian, sizeof(kData2_endian), NULL,
+                      kHmacconfig_bigd_littlem,
+                      &kExpectedShaDigest_shortmessage_bigendian);
+
+  return true;
+}