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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
/* SPDX-License-Identifier: GPL-2.0-or-later */
#include <console/console.h>
#include <spi-generic.h>
#include <spi_flash.h>
#include <string.h>
#include <timer.h>
#include <types.h>
#include "spi_flash_internal.h"
void spi_flash_fill_rpmc_caps(struct spi_flash *flash)
{
struct sfdp_rpmc_info rpmc_info;
flash->rpmc_caps.rpmc_available = false;
if (spi_flash_get_sfdp_rpmc(flash, &rpmc_info) != CB_SUCCESS)
return;
if (rpmc_info.monotonic_counter_size != SFDP_RPMC_COUNTER_BITS_32) {
printk(BIOS_WARNING, "RPMC: unexpected counter size\n");
return;
}
flash->rpmc_caps.poll_op2_ext_stat = rpmc_info.busy_polling_method ==
SFDP_RPMC_POLL_OP2_EXTENDED_STATUS;
flash->rpmc_caps.number_of_counters = rpmc_info.number_of_counters;
flash->rpmc_caps.op1_write_cmd = rpmc_info.op1_write_command;
flash->rpmc_caps.op2_read_cmd = rpmc_info.op2_read_command;
flash->rpmc_caps.rpmc_available = true;
}
static bool spi_flash_rpmc_is_available(const struct spi_flash *flash)
{
return flash->rpmc_caps.rpmc_available;
}
#define RPMC_OP2_READ_BUF_EXT_STATUS_OFFSET 0
#define RPMC_OP2_READ_BUF_TAG_OFFSET 1
#define RPMC_OP2_READ_BUF_COUNTER_DATA_OFFSET (1 + SPI_RPMC_TAG_LEN)
#define RPMC_OP2_READ_BUF_SIGNATURE_OFFSET (1 + SPI_RPMC_TAG_LEN + SPI_RPMC_COUNTER_DATA_LEN)
/*
* 'extended_status', 'tag', 'counter_data', and 'signature' may be NULL if the caller
* doesn't need the value. 'tag' must be a SPI_RPMC_TAG_LEN bytes long buffer, 'signature'
* must be a SPI_RPMC_SIG_LEN bytes long buffer. When only 'extended_status' is non-NULL, only
* the extended status is read back.
*/
static enum cb_err spi_flash_rpmc_op2_read(const struct spi_flash *flash,
uint8_t *extended_status, uint8_t *tag,
uint8_t *counter_data, uint8_t *signature)
{
int cmd_ret;
const bool only_check_extended_status = extended_status != NULL && tag == NULL &&
counter_data == NULL && signature == NULL;
/* command and dummy byte */
uint8_t write_buf[1 + 1];
/* extended status, tag, counter data, signature */
uint8_t read_buf[1 + SPI_RPMC_TAG_LEN + SPI_RPMC_COUNTER_DATA_LEN + SPI_RPMC_SIG_LEN];
write_buf[0] = flash->rpmc_caps.op2_read_cmd;
write_buf[1] = 0x00; /* dummy byte */
cmd_ret = spi_flash_cmd_multi(&flash->spi, write_buf, sizeof(write_buf), read_buf,
only_check_extended_status ? 1 : sizeof(read_buf));
if (cmd_ret)
return CB_ERR;
if (extended_status != NULL)
*extended_status = read_buf[RPMC_OP2_READ_BUF_EXT_STATUS_OFFSET];
if (tag != NULL)
memcpy(tag, &read_buf[RPMC_OP2_READ_BUF_TAG_OFFSET], SPI_RPMC_TAG_LEN);
if (counter_data != NULL)
memcpy(counter_data, &read_buf[RPMC_OP2_READ_BUF_COUNTER_DATA_OFFSET],
SPI_RPMC_COUNTER_DATA_LEN);
if (signature != NULL)
memcpy(signature, &read_buf[RPMC_OP2_READ_BUF_SIGNATURE_OFFSET],
SPI_RPMC_SIG_LEN);
return CB_SUCCESS;
}
static enum cb_err spi_flash_rpmc_op2_get_exteded_status(const struct spi_flash *flash,
uint8_t *extended_status)
{
return spi_flash_rpmc_op2_read(flash, extended_status, NULL, NULL, NULL);
}
#define RPMC_OP2_EXT_STATUS_SUCCESS BIT(7)
#define RPMC_OP2_EXT_STATUS_ERR_FATAL BIT(5)
#define RPMC_OP2_EXT_STATUS_ERR_BAD_COUNTER BIT(4)
#define RPMC_OP2_EXT_STATUS_ERR_UNINITIALIZED BIT(3)
#define RPMC_OP2_EXT_STATUS_ERR_INVALID BIT(2)
#define RPMC_OP2_EXT_STATUS_ERR_OTHER BIT(1)
#define RPMC_OP2_EXT_STATUS_POLL_BUSY BIT(0)
static bool spi_flash_rpmc_is_extended_status_successful(uint8_t extended_status)
{
return extended_status & RPMC_OP2_EXT_STATUS_SUCCESS;
}
static void spi_flash_rpmc_print_extended_status_error(uint8_t extended_status)
{
if (extended_status & RPMC_OP2_EXT_STATUS_POLL_BUSY)
printk(BIOS_WARNING, "SPI flash RPMC is busy\n");
if (extended_status & RPMC_OP2_EXT_STATUS_ERR_OTHER)
printk(BIOS_ERR, "SPI flash RPMC other error\n");
if (extended_status & RPMC_OP2_EXT_STATUS_ERR_INVALID)
printk(BIOS_ERR, "SPI flash RPMC invalid input\n");
if (extended_status & RPMC_OP2_EXT_STATUS_ERR_UNINITIALIZED)
printk(BIOS_ERR, "SPI flash RPMC uninitialized\n");
if (extended_status & RPMC_OP2_EXT_STATUS_ERR_BAD_COUNTER)
printk(BIOS_ERR, "SPI flash RPMC counter mismatch\n");
if (extended_status & RPMC_OP2_EXT_STATUS_ERR_FATAL)
printk(BIOS_ERR, "SPI flash RPMC fatal error\n");
}
static enum cb_err spi_flash_rpmc_check_extended_status(const struct spi_flash *flash)
{
uint8_t extended_status;
if (spi_flash_rpmc_op2_get_exteded_status(flash, &extended_status) != CB_SUCCESS)
return CB_ERR;
if (spi_flash_rpmc_is_extended_status_successful(extended_status))
return CB_SUCCESS;
spi_flash_rpmc_print_extended_status_error(extended_status);
return CB_ERR;
}
static enum cb_err spi_flash_rpmc_poll_op2(const struct spi_flash *flash, uint64_t timeout_ms)
{
unsigned int attempt = 0;
uint8_t extended_status;
struct stopwatch sw;
stopwatch_init_msecs_expire(&sw, timeout_ms);
do {
attempt++;
if (spi_flash_rpmc_op2_get_exteded_status(flash, &extended_status)) {
printk(BIOS_WARNING,
"SPI command failed on attempt %d\n", attempt);
return CB_ERR;
}
if ((extended_status & RPMC_OP2_EXT_STATUS_POLL_BUSY) == 0)
return CB_SUCCESS;
} while (!stopwatch_expired(&sw));
printk(BIOS_WARNING, "SPI RPMC poll timeout at %lld msec after %d attempts\n",
stopwatch_duration_msecs(&sw), attempt);
return CB_ERR;
}
static enum cb_err spi_flash_rpmc_wait_ready(const struct spi_flash *flash,
uint64_t timeout_ms)
{
if (!flash->rpmc_caps.poll_op2_ext_stat) {
/* poll read status */
if (spi_flash_cmd_wait_ready(flash, timeout_ms))
return CB_ERR;
} else {
/* poll RPMC OP2 extended status */
if (spi_flash_rpmc_poll_op2(flash, timeout_ms) != CB_SUCCESS)
return CB_ERR;
}
return CB_SUCCESS;
}
static bool spi_flash_rpmc_is_valid_counter_addr(const struct spi_flash *flash,
uint8_t counter_addr)
{
return counter_addr < flash->rpmc_caps.number_of_counters;
}
/* TODO: replace with proper value read from SFDP?! */
#define SPI_FLASH_RPMC_TIMEOUT_MS 200
#define RPMC_OP1_CMD_WRITE_ROOT_KEY_REGISTER 0x00
#define RPMC_OP1_CMD_UPDATE_HMAC_KEY_REGISTER 0x01
#define RPMC_OP1_CMD_INCREMENT_MONOTONIC_COUNTER 0x02
#define RPMC_OP1_CMD_REQUEST_MONOTONIC_COUNTER 0x03
enum cb_err spi_flash_rpmc_write_root_key(const struct spi_flash *flash, uint8_t counter_addr,
const uint8_t *root_key,
const uint8_t *truncated_signature)
{
/* command, command type, counter address, reserved, root key, truncated signature */
uint8_t buf[1 + 1 + 1 + 1 + SPI_RPMC_ROOT_KEY_LEN + SPI_RPMC_TRUNCTAED_SIG_LEN];
if (!spi_flash_rpmc_is_available(flash))
return CB_ERR;
if (!spi_flash_rpmc_is_valid_counter_addr(flash, counter_addr))
return CB_ERR;
buf[0] = flash->rpmc_caps.op1_write_cmd;
buf[1] = RPMC_OP1_CMD_WRITE_ROOT_KEY_REGISTER;
buf[2] = counter_addr;
buf[3] = 0x00; /* reserved */
memcpy(&buf[4], root_key, SPI_RPMC_ROOT_KEY_LEN);
memcpy(&buf[4 + SPI_RPMC_ROOT_KEY_LEN], truncated_signature,
SPI_RPMC_TRUNCTAED_SIG_LEN);
if (spi_flash_cmd_multi(&flash->spi, buf, sizeof(buf), NULL, 0))
return CB_ERR;
if (spi_flash_rpmc_wait_ready(flash, SPI_FLASH_RPMC_TIMEOUT_MS) != CB_SUCCESS)
return CB_ERR;
if (spi_flash_rpmc_check_extended_status(flash) != CB_SUCCESS)
return CB_ERR;
return CB_SUCCESS;
}
enum cb_err spi_flash_rpmc_update_hmac_key(const struct spi_flash *flash, uint8_t counter_addr,
uint8_t *key_data, const uint8_t *signature)
{
/* command, command type, counter address, reserved, key data, signature */
uint8_t buf[1 + 1 + 1 + 1 + SPI_RPMC_KEY_DATA_LEN + SPI_RPMC_SIG_LEN];
if (!spi_flash_rpmc_is_available(flash))
return CB_ERR;
if (!spi_flash_rpmc_is_valid_counter_addr(flash, counter_addr))
return CB_ERR;
buf[0] = flash->rpmc_caps.op1_write_cmd;
buf[1] = RPMC_OP1_CMD_UPDATE_HMAC_KEY_REGISTER;
buf[2] = counter_addr;
buf[3] = 0x00; /* reserved */
memcpy(&buf[4], key_data, SPI_RPMC_KEY_DATA_LEN);
memcpy(&buf[4 + SPI_RPMC_KEY_DATA_LEN], signature, SPI_RPMC_SIG_LEN);
if (spi_flash_cmd_multi(&flash->spi, buf, sizeof(buf), NULL, 0))
return CB_ERR;
if (spi_flash_rpmc_wait_ready(flash, SPI_FLASH_RPMC_TIMEOUT_MS) != CB_SUCCESS)
return CB_ERR;
if (spi_flash_rpmc_check_extended_status(flash) != CB_SUCCESS)
return CB_ERR;
return CB_SUCCESS;
}
enum cb_err spi_flash_rpmc_increment(const struct spi_flash *flash, uint8_t counter_addr,
const uint8_t *counter_data, const uint8_t *signature)
{
/* command, command type, counter address, reserved, counter data, signature */
uint8_t buf[1 + 1 + 1 + 1 + SPI_RPMC_COUNTER_DATA_LEN + SPI_RPMC_SIG_LEN];
if (!spi_flash_rpmc_is_available(flash))
return CB_ERR;
if (!spi_flash_rpmc_is_valid_counter_addr(flash, counter_addr))
return CB_ERR;
buf[0] = flash->rpmc_caps.op1_write_cmd;
buf[1] = RPMC_OP1_CMD_INCREMENT_MONOTONIC_COUNTER;
buf[2] = counter_addr;
buf[3] = 0x00; /* reserved */
memcpy(&buf[4], counter_data, SPI_RPMC_COUNTER_DATA_LEN);
memcpy(&buf[4 + SPI_RPMC_COUNTER_DATA_LEN], signature, SPI_RPMC_SIG_LEN);
if (spi_flash_cmd_multi(&flash->spi, buf, sizeof(buf), NULL, 0))
return CB_ERR;
if (spi_flash_rpmc_wait_ready(flash, SPI_FLASH_RPMC_TIMEOUT_MS) != CB_SUCCESS)
return CB_ERR;
if (spi_flash_rpmc_check_extended_status(flash) != CB_SUCCESS)
return CB_ERR;
return CB_SUCCESS;
}
enum cb_err spi_flash_rpmc_request(const struct spi_flash *flash, uint8_t counter_addr,
const uint8_t *tag, const uint8_t *signature,
uint8_t *counter_data, uint8_t *signature_out)
{
/* command, command type, counter address, reserved, tag, signature */
uint8_t buf[1 + 1 + 1 + 1 + SPI_RPMC_TAG_LEN + SPI_RPMC_SIG_LEN];
uint8_t extended_status;
if (!spi_flash_rpmc_is_available(flash))
return CB_ERR;
if (!spi_flash_rpmc_is_valid_counter_addr(flash, counter_addr))
return CB_ERR;
buf[0] = flash->rpmc_caps.op1_write_cmd;
buf[1] = RPMC_OP1_CMD_REQUEST_MONOTONIC_COUNTER;
buf[2] = counter_addr;
buf[3] = 0x00; /* reserved */
memcpy(&buf[4], tag, SPI_RPMC_TAG_LEN);
memcpy(&buf[4 + SPI_RPMC_TAG_LEN], signature, SPI_RPMC_SIG_LEN);
if (spi_flash_cmd_multi(&flash->spi, buf, sizeof(buf), NULL, 0))
return CB_ERR;
if (spi_flash_rpmc_wait_ready(flash, SPI_FLASH_RPMC_TIMEOUT_MS) != CB_SUCCESS)
return CB_ERR;
/*
* Since we need to read back more than just the extended status for this command and
* want to avoid unnecessary SPI transactions, spi_flash_rpmc_check_extended_status
* isn't used here.
*/
if (spi_flash_rpmc_op2_read(flash, &extended_status, NULL, counter_data, signature_out)
!= CB_SUCCESS)
return CB_ERR;
if (!spi_flash_rpmc_is_extended_status_successful(extended_status)) {
spi_flash_rpmc_print_extended_status_error(extended_status);
return CB_ERR;
}
return CB_SUCCESS;
}
|
