Software APIs
otbn_isa_test.c
1 // Copyright lowRISC contributors (OpenTitan project).
2 // Licensed under the Apache License, Version 2.0, see LICENSE for details.
3 // SPDX-License-Identifier: Apache-2.0
4 
5 #include "sw/device/lib/dif/dif_otbn.h"
6 #include "sw/device/lib/testing/entropy_testutils.h"
7 #include "sw/device/lib/testing/otbn_testutils.h"
8 #include "sw/device/lib/testing/test_framework/check.h"
9 #include "sw/device/lib/testing/test_framework/ottf_main.h"
10 
11 #include "hw/top_earlgrey/sw/autogen/top_earlgrey.h"
12 
13 /**
14  * This test runs every instruction in OTBN's ISA and checks the result.
15  *
16  * It reuses the `smoke_test.s` script used in OTBN's Design Verification,
17  * but with accesses the `RND` and `KEY_*` WSRs removed.
18  * The result in `w1` and `w2` are downstream of the `KEY_*`,
19  * loads and so are not checked.
20  *
21  * The zero register and `x1` stack register are ignored.
22  */
23 OTTF_DEFINE_TEST_CONFIG();
24 
25 OTBN_DECLARE_APP_SYMBOLS(smoke_test);
26 OTBN_DECLARE_SYMBOL_ADDR(smoke_test, gpr_state);
27 OTBN_DECLARE_SYMBOL_ADDR(smoke_test, wdr_state);
28 
29 static const otbn_app_t kAppSmokeTest = OTBN_APP_T_INIT(smoke_test);
30 static const otbn_addr_t kGprState = OTBN_ADDR_T_INIT(smoke_test, gpr_state);
31 static const otbn_addr_t kWdrState = OTBN_ADDR_T_INIT(smoke_test, wdr_state);
32 
33 enum {
34  kNumExpectedGprs = 30,
35  kNumExpectedWdrs = 32,
36  kExpectedInstrCount = 284,
37 };
38 
39 // The expected values of the GPRs and WDRs are taken from
40 // `hw/ip/otbn/dv/smoke/smoke_expected.txt`.
41 static const uint32_t kExpectedGprs[kNumExpectedGprs] = {
42  0xd0beb513, 0xa0be911a, 0x717d462d, 0xcfffdc07, 0xf0beb51b, 0x80be9112,
43  0x70002409, 0xd0beb533, 0x00000510, 0xd0beb169, 0xfad44c00, 0x000685f5,
44  0xffa17d6a, 0x4c000000, 0x00000034, 0xfffffff4, 0xfacefeed, 0xd0beb533,
45  0x00000123, 0x00000123, 0xcafef010, 0x89c9b54f, 0x00000052, 0x00000020,
46  0x00000016, 0x0000001a, 0x00400000, 0x00018000, 0x00000000, 0x00000804};
47 
48 static const uint32_t kExpectedWdrs[kNumExpectedWdrs][8] = {
49  [0] = {0x0f09b7c8, 0x25769434, 0x6978ad1b, 0x67a8c221, 0x5466a52c,
50  0x73880075, 0xf9dbff5e, 0x37adadae},
51  [1] = {0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000,
52  0x00000000, 0x00000000, 0x00000000},
53  [2] = {0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000,
54  0x00000000, 0x00000000, 0x00000000},
55  [3] = {0xed103473, 0x431165e5, 0x0357f208, 0x7245a2d0, 0x22168ae8,
56  0x34745ffa, 0xbbc28370, 0x23a776b0},
57  [4] = {0xb9dd0141, 0xedbc1090, 0xd024bed4, 0x1cf04d7a, 0xeee357b5,
58  0xdf1f0aa4, 0x888f503c, 0xce52215b},
59  [5] = {0xdbff9bdb, 0xbaeebbbb, 0xf9bfd9ff, 0xefbafaaf, 0x99fdf9df,
60  0xabebbfef, 0xbbb9f9df, 0xfafeeeae},
61  [6] = {0x11109898, 0x8822aa2a, 0x09981808, 0x828aa820, 0x88189108,
62  0x8888a00a, 0x00088990, 0x28a88802},
63  [7] = {0xcaef0343, 0x32cc1191, 0xf027c1f7, 0x6d30528f, 0x11e568d7,
64  0x23631fe5, 0xbbb1704f, 0xd25666ac},
65  [8] = {0xac896525, 0x679944c4, 0x9641a791, 0x386507da, 0x77830eb1,
66  0x76364ab0, 0xddd71629, 0x870333f9},
67  [9] = {0xcccccd55, 0x555554cc, 0xcccccd55, 0x555554cc, 0xb4d6d555,
68  0x35d9da9b, 0xf2c374c3, 0xd7c12b4d},
69  [10] = {0xf0cd30f0, 0x45114443, 0xd30cf2cd, 0x1045054f, 0x32ced2ed,
70  0x54144010, 0x1112d2ed, 0x05011151},
71  [11] = {0xbbbc3433, 0x77dd55d5, 0xc334b4c4, 0x7d7557df, 0x44b43bc4,
72  0x77775ff5, 0xccc4433c, 0xd75777fd},
73  [12] = {0x22229a9a, 0xcd32ab2b, 0x299b1b2a, 0xd2caad35, 0xab1aa22a,
74  0xccccb54a, 0x332aa9a2, 0x2caccd53},
75  [13] = {0x97ba66a7, 0x20896565, 0xa689a3aa, 0x4a25a045, 0x43c8b58a,
76  0x1252555a, 0x5564a69a, 0xa1a55408},
77  [14] = {0x7956327a, 0xbcee9991, 0x630e74e6, 0x8dba5ca7, 0x2c59e406,
78  0xac10254c, 0xd09a8aec, 0x5ec45f47},
79  [15] = {0xac896524, 0xbcee9a19, 0x9641a791, 0x8dba5d2f, 0x77830eb1,
80  0xcb8ba005, 0xddd71629, 0xdc58894e},
81  [16] = {0xb9dd0141, 0xedbc1090, 0xd024bed4, 0x1cf04d7a, 0xeee357b5,
82  0xdf1f0aa4, 0x888f503c, 0xce52215b},
83  [17] = {0x33333331, 0x55555555, 0x33333333, 0x55555555, 0x33333333,
84  0x55555555, 0x33333333, 0x55555555},
85  [18] = {0x53769ada, 0x9866bb3b, 0x69be586e, 0xc79af825, 0x22168a4e,
86  0x34745fe9, 0xbbc28381, 0x23a7769f},
87  [19] = {0x00000000, 0x00000000, 0x09981800, 0x828aa801, 0x8818910a,
88  0x8888a009, 0x00088982, 0x28a88800},
89  [20] = {0xb9dd0130, 0xedbc10a1, 0x69be57c3, 0xc79af825, 0x887cf14e,
90  0x89c9b54f, 0x2228e9d6, 0x78fccc06},
91  [21] = {0xdbff9bfa, 0xbaeebbbb, 0xf9bfd9ee, 0xefbafabd, 0x887cf1ee,
92  0x89c9b54f, 0x2228e9d6, 0x78fccc06},
93  [22] = {0xdbff9db7, 0xbaeebbbb, 0xf9bfd9ee, 0xefbafabd, 0x887cf1ee,
94  0x89c9b54f, 0x2228e9d6, 0x78fccc06},
95  [23] = {0xdbff99f3, 0xbaeebbbb, 0xf9bfd9ee, 0xefbafabd, 0x887cf1ee,
96  0x89c9b54f, 0x2228e9d6, 0x78fccc06},
97  [24] = {0x1234abcd, 0xd0beb533, 0xcafed00d, 0xdeadbeef, 0xfacefeed,
98  0xaaaaaaaa, 0xbbbbbbbb, 0xcccccccc},
99  [25] = {0x1234abcd, 0xd0beb533, 0xcafed00d, 0xdeadbeef, 0xfacefeed,
100  0xaaaaaaaa, 0xbbbbbbbb, 0xcccccccc},
101  [26] = {0xdbff9bfa, 0xbaeebbbb, 0xf9bfd9ee, 0xefbafabd, 0x887cf1ee,
102  0x89c9b54f, 0x2228e9d6, 0x78fccc06},
103  [27] = {0x11109898, 0x8822aa2a, 0x09981808, 0x828aa820, 0x88189108,
104  0x8888a00a, 0x00088990, 0x28a88802},
105  [28] = {0xcaef0343, 0x32cc1191, 0xf027c1f7, 0x6d30528f, 0x11e568d7,
106  0x23631fe5, 0xbbb1704f, 0xd25666ac},
107  [29] = {0xeb0953c2, 0xe0654fef, 0x63388709, 0x5763bcdf, 0x26628bdb,
108  0x64341d3c, 0x9f24f0c1, 0x4f0d4b81},
109  [30] = {0x68ba2fa1, 0xb55098e0, 0x4efa2ec9, 0xaee49292, 0xab123192,
110  0xffa3d88b, 0xe9ee7ac7, 0x2167f87d},
111  [31] = {0x0f09b7c8, 0x25769434, 0x6978ad1b, 0x67a8c221, 0x5466a52c,
112  0x73880075, 0xf9dbff5e, 0x37adadae},
113 };
114 
115 bool test_main(void) {
116  // Initialise the entropy source and OTBN
117  dif_otbn_t otbn;
118  CHECK_STATUS_OK(entropy_testutils_auto_mode_init());
119  CHECK_DIF_OK(
120  dif_otbn_init(mmio_region_from_addr(TOP_EARLGREY_OTBN_BASE_ADDR), &otbn));
121 
122  // Load the Smoke Test App
123  CHECK_STATUS_OK(otbn_testutils_load_app(&otbn, kAppSmokeTest));
124  CHECK_STATUS_OK(otbn_testutils_execute(&otbn));
125  CHECK_STATUS_OK(otbn_testutils_wait_for_done(&otbn, kDifOtbnErrBitsNoError));
126 
127  // Check the instruction count is what was expected.
128  uint32_t instruction_count;
129  CHECK_DIF_OK(dif_otbn_get_insn_cnt(&otbn, &instruction_count));
130  CHECK(kExpectedInstrCount == instruction_count,
131  "Expected OTBN to execute %d instructions, but it exected %d",
132  kExpectedInstrCount, instruction_count);
133 
134  // Check the GPR registers of interest hold the expected values.
135  uint32_t gpr_state[kNumExpectedGprs];
136  CHECK_STATUS_OK(otbn_testutils_read_data(&otbn, sizeof(kExpectedGprs),
137  kGprState, &gpr_state));
138  CHECK_ARRAYS_EQ(gpr_state, kExpectedGprs, kNumExpectedGprs);
139 
140  // Check the WDR registers of interest hold the expected values.
141  uint32_t wdr_state[kNumExpectedWdrs][8];
142  CHECK_STATUS_OK(otbn_testutils_read_data(&otbn, sizeof(kExpectedWdrs),
143  kWdrState, &wdr_state));
144 
145  CHECK_ARRAYS_EQ(wdr_state[0], kExpectedWdrs[0], 8,
146  "w0 didn't match the expected value.");
147  // We ignore register w1 and w2.
148  for (size_t i = 3; i < kNumExpectedWdrs; ++i) {
149  CHECK_ARRAYS_EQ(wdr_state[i], kExpectedWdrs[i], 8,
150  "w%d didn't match the expected value.", i);
151  };
152  return true;
153 }
Return to OpenTitan Documentation