1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
//======================================================================
//
// fpga_mkm.v
// ----------
// Top level module for the FPGA based Master Key Memory (MKM).
//
//
// Author: Joachim Strombergson
// Copyright (c) 2019, NORDUnet A/S
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// - Neither the name of the NORDUnet nor the names of its contributors may
// be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
// PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//======================================================================
module fpga_mkm(
input wire clk,
// SPI slave interface ports.
input wire ss,
input wire sclk,
input wire mosi,
output wire miso,
// Tamper and alarm.
input wire tamper,
output wire alarm,
// We will use red LEDs to indicate tamper event.
output wire rled1,
output wire rled2,
output wire rled3,
output wire rled4,
// We will use the green LED to indicate loaded key.
output wire gled5
);
//----------------------------------------------------------------
// Internal constant and parameter definitions.
//----------------------------------------------------------------
localparam CTRL_IDLE = 0;
localparam CTRL_ALARM = 1;
localparam CTRL_DONE = 3;
localparam MEM_BYTES = 32;
localparam CMD_WRITE_BYTES = 8'h37;
localparam CMD_READ_BYTES = 8'h93;
localparam CMD_GET_STATUS = 8'hca;
localparam STAT_KEY_NOT_LOADED = 8'hdb;
localparam STAT_KEY_LOADED = 8'hbd;
localparam STAT_TAMPER_DETECTED = 8'ha5;
//----------------------------------------------------------------
// Registers including update variables and write enable.
//----------------------------------------------------------------
reg [7 : 0] key_mem [0 : (MEM_BYTES - 1)];
reg [21 : 0] alarm_counter_reg = 22'h0;
reg tamper_reg = 1'h0;
reg tamper_new;
reg tamper_we;
reg key_loaded_reg = 1'h0;
reg key_loaded_new;
reg key_loaded_we;
reg miso_reg = 1'h0;
reg [1 : 0] fpga_mkm_ctrl_reg = CTRL_IDLE;
reg [1 : 0] fpga_mkm_ctrl_new;
reg fpga_mkm_ctrl_we;
wire spi_active;
wire rx_byte_available;
wire [7 : 0] rx_byte;
reg tx_byte_load;
reg [7 : 0] tx_byte_reg;
reg [7 : 0] tx_byte_new;
reg tx_byte_we;
//----------------------------------------------------------------
// Concurrent connectivity for ports etc.
//----------------------------------------------------------------
assign rled1 = alarm_counter_reg[21];
assign rled2 = alarm_counter_reg[21];
assign rled3 = alarm_counter_reg[21];
assign rled4 = alarm_counter_reg[21];
assign gled5 = key_loaded_reg;
//----------------------------------------------------------------
// Module instantiations.
//----------------------------------------------------------------
fpga_mkm_spi_slave spi_slave(
.clk(clk),
.ss(ss),
.sclk(sclk),
.mosi(mosi),
.miso(miso),
.spi_active(spi_active),
.rx_byte_available(rx_byte_available),
.rx_byte(rx_byte),
.tx_byte_load(tx_byte),
.tx_byte(tx_byte_reg)
);
//----------------------------------------------------------------
// reg_update
//----------------------------------------------------------------
always @ (posedge clk or negedge tamper)
begin : reg_update
integer i;
if (!tamper)
begin
for (i = 0 ; i < MEM_BYTES ; i = i + 1)
key_mem[i] <= 8'h0;
key_loaded_reg <= 1'h0;
tamper_reg <= 1'h1;
end
else
begin
alarm_counter_reg <= alarm_counter_reg + 1;
if (tamper_we)
tamper_reg <= tamper_new;
if (key_loaded_we)
key_loaded_reg <= key_loaded_new;
if (fpga_mkm_ctrl_we)
fpga_mkm_ctrl_reg <= fpga_mkm_ctrl_new;
end
end
//----------------------------------------------------------------
// fpga_mkm_ctrl_fsm
//----------------------------------------------------------------
always @*
begin : fpga_mkm_ctrl_fsm
tamper_new = 1'h0;
tamper_we = 1'h0;
key_loaded_new = 1'h0;
key_loaded_we = 1'h0;
fpga_mkm_ctrl_new = CTRL_IDLE;
fpga_mkm_ctrl_we = 1'h0;
case (fpga_mkm_ctrl_reg)
CTRL_IDLE:
begin
if (spi_active)
begin
fpga_mkm_ctrl_new = CTRL_CMD;
fpga_mkm_ctrl_we = 1'h1;
end
end
CTRL_ALARM:
begin
end
default:
begin
end
endcase // case (fpga_mkm_ctrl_reg)
end
endmodule // fpga_mkm
//======================================================================
// EOF fpga_mkm.v
//======================================================================
|
