Skip to content

Support 128-bit flash programming units #524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aidangarske wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support 128-bit flash programming units #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/build-and-test-whnvmtool.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,13 @@ jobs:
- name: Build and test NVM tool with NVM flash CRC ASAN
run: cd tools/whnvmtool && make clean && make check WOLFSSL_DIR=../../wolfssl NVM_FLASH_CRC=1 ASAN=1

- name: Build and test NVM tool with 16-byte flash units
run: cd tools/whnvmtool && make clean && make check WOLFSSL_DIR=../../wolfssl FLASH_UNIT_SIZE=16 NVM_FLASH_CRC=1 ASAN=1

# Build and test with DEBUG=1
- name: Build and test NVM tool with DEBUG
run: cd tools/whnvmtool && make clean && make check WOLFSSL_DIR=../../wolfssl DEBUG=1

# Build and test with DEBUG_VERBOSE=1 (includes DEBUG)
- name: Build and test NVM tool with DEBUG_VERBOSE
run: cd tools/whnvmtool && make clean && make check WOLFSSL_DIR=../../wolfssl DEBUG_VERBOSE=1

5 changes: 5 additions & 0 deletions .github/workflows/build-and-test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,11 @@ jobs:
- name: Build and test NVM flash CRC ASAN
run: cd test && make clean && make -j NVM_FLASH_CRC=1 ASAN=1 WOLFSSL_DIR=../wolfssl && make run

# Build and test with 16-byte flash programming units
- name: Build and test 16-byte NVM flash units
if: matrix.group == 'base'
run: cd test && make clean && make -j FLASH_UNIT_SIZE=16 NVM_FLASH_CRC=1 ASAN=1 WOLFSSL_DIR=../wolfssl && make run

# Build and test with LMS and XMSS both in verify-only mode
- name: Build and test DMA ASAN LMS/XMSS verify-only
if: matrix.group == 'pq-dma'
Expand Down
95 changes: 58 additions & 37 deletions src/wh_nvm_flash.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ enum {
/* MSW of state variables (nfState) must be set to this pattern when written
* to flash to prevent hardware on certain chipsets from confusing zero values
* with erased flash */
static const whFlashUnit BASE_STATE = 0x1234567800000000ULL;
#define BASE_STATE 0x1234567800000000ULL

#ifdef WOLFHSM_CFG_NVM_FLASH_CRC16
/* With CRC16 enabled, the object start and count state words carry a CRC in
Expand All @@ -56,9 +56,10 @@ static const whFlashUnit BASE_STATE = 0x1234567800000000ULL;
* The epoch word and all partition state words keep the full BASE_STATE
* magic. The remaining 0x12/0x34 bytes still keep every state word distinct
* from erased flash. */
static const whFlashUnit CRC_BASE_STATE = 0x1234000000000000ULL;
#define NF_STATE_CRC_PACK(_crc) (((whFlashUnit)(uint16_t)(_crc)) << 32)
#define NF_STATE_CRC_EXTRACT(_unit) ((uint16_t)(((_unit) >> 32) & 0xFFFFULL))
#define CRC_BASE_STATE 0x1234000000000000ULL
#define NF_STATE_CRC_PACK(_crc) (((uint64_t)(uint16_t)(_crc)) << 32)
#define NF_STATE_CRC_EXTRACT(_unit) \
((uint16_t)((WHFU_TO_U64(_unit) >> 32) & 0xFFFFULL))
#endif

/* On-flash layout of the state of an Object or Directory*/
Expand Down Expand Up @@ -221,9 +222,9 @@ static int nfMemState_Read(whNvmFlashContext* context, uint32_t offset,
return ret;
}

state->epoch = buffer.epoch;
state->start = buffer.start;
state->count = buffer.count;
state->epoch = (uint32_t)WHFU_TO_U64(buffer.epoch);
state->start = (uint32_t)WHFU_TO_U64(buffer.start);
state->count = (uint32_t)WHFU_TO_U64(buffer.count);
#ifdef WOLFHSM_CFG_NVM_FLASH_CRC16
state->crc_meta = NF_STATE_CRC_EXTRACT(buffer.start);
state->crc_data = NF_STATE_CRC_EXTRACT(buffer.count);
Expand All @@ -242,8 +243,8 @@ static int nfMemState_Read(whNvmFlashContext* context, uint32_t offset,
return ret;
}

state->epoch = buffer.epoch;
state->start = buffer.start;
state->epoch = (uint32_t)WHFU_TO_U64(buffer.epoch);
state->start = (uint32_t)WHFU_TO_U64(buffer.start);
#ifdef WOLFHSM_CFG_NVM_FLASH_CRC16
state->crc_meta = NF_STATE_CRC_EXTRACT(buffer.start);
#endif
Expand Down Expand Up @@ -441,7 +442,7 @@ static int nfPartition_ReadParseMemDirectory(whNvmFlashContext* context, int par
static int nfPartition_ProgramEpoch(whNvmFlashContext* context,
int partition, uint32_t epoch)
{
whFlashUnit unit = BASE_STATE | epoch;
whFlashUnit unit = WHFU_VALUE(BASE_STATE | epoch);

if ((context == NULL) || (context->cb == NULL)) {
return WH_ERROR_BADARGS;
Expand All @@ -459,7 +460,7 @@ static int nfPartition_ProgramEpoch(whNvmFlashContext* context,
static int nfPartition_ProgramStart(whNvmFlashContext* context,
int partition, uint32_t start)
{
whFlashUnit unit = BASE_STATE | start;
whFlashUnit unit = WHFU_VALUE(BASE_STATE | start);

if ((context == NULL) || (context->cb == NULL)) {
return WH_ERROR_BADARGS;
Expand All @@ -477,7 +478,7 @@ static int nfPartition_ProgramStart(whNvmFlashContext* context,
static int nfPartition_ProgramCount(whNvmFlashContext* context,
int partition, uint32_t count)
{
whFlashUnit unit = BASE_STATE | count;
whFlashUnit unit = WHFU_VALUE(BASE_STATE | count);

if ((context == NULL) || (context->cb == NULL)) {
return WH_ERROR_BADARGS;
Expand Down Expand Up @@ -588,8 +589,8 @@ static int nfObject_ProgramBegin(whNvmFlashContext* context, int partition,
{
int rc = 0;
uint32_t object_offset = 0;
whFlashUnit state_epoch = BASE_STATE | epoch;
whFlashUnit state_start = BASE_STATE | start;
whFlashUnit state_epoch = WHFU_VALUE(BASE_STATE | epoch);
whFlashUnit state_start = WHFU_VALUE(BASE_STATE | start);

if ( (context == NULL) ||
(context->cb == NULL) ||
Expand All @@ -599,7 +600,8 @@ static int nfObject_ProgramBegin(whNvmFlashContext* context, int partition,

#ifdef WOLFHSM_CFG_NVM_FLASH_CRC16
/* Start word carries the metadata CRC in place of the low magic half */
state_start = CRC_BASE_STATE | NF_STATE_CRC_PACK(crc_meta) | start;
state_start = WHFU_VALUE(CRC_BASE_STATE | NF_STATE_CRC_PACK(crc_meta) |
start);
#else
(void)crc_meta;
#endif
Expand Down Expand Up @@ -672,16 +674,17 @@ static int nfObject_ProgramFinish(whNvmFlashContext* context, int partition,
{
int rc;
uint32_t object_offset = 0;
whFlashUnit state_count = BASE_STATE | WHFU_BYTES2UNITS(byte_count);
whFlashUnit state_count = WHFU_VALUE(BASE_STATE |
WHFU_BYTES2UNITS(byte_count));

if ((context == NULL) || (context->cb == NULL)) {
return WH_ERROR_BADARGS;
}

#ifdef WOLFHSM_CFG_NVM_FLASH_CRC16
/* Count word carries the data CRC in place of the low magic half */
state_count = CRC_BASE_STATE | NF_STATE_CRC_PACK(crc_data) |
WHFU_BYTES2UNITS(byte_count);
state_count = WHFU_VALUE(CRC_BASE_STATE | NF_STATE_CRC_PACK(crc_data) |
WHFU_BYTES2UNITS(byte_count));
#else
(void)crc_data;
#endif
Expand Down Expand Up @@ -1012,13 +1015,12 @@ static int nfIdList_Contains(whNvmId list_count, const whNvmId* id_list,

int wh_NvmFlash_Init(void* c, const void* cf)
{
whNvmFlashContext* context = c;
const whNvmFlashConfig* config = cf;
int ret = WH_ERROR_OK;
whNvmFlashContext* context = c;
const whNvmFlashConfig* config = cf;
uint32_t partition_size = 0;
int ret = WH_ERROR_OK;

if ( (context == NULL) ||
(config == NULL) ||
(config->cb == NULL)) {
if ((context == NULL) || (config == NULL) || (config->cb == NULL)) {
return WH_ERROR_BADARGS;
}

Expand All @@ -1028,14 +1030,30 @@ int wh_NvmFlash_Init(void* c, const void* cf)
if (ret == WH_ERROR_OK) {
/* Initialize and setup context */
memset(context, 0, sizeof(*context));
context->cb = config->cb;
context->cb = config->cb;
context->flash = config->context;

/* Get partition size from flash device */
if (context->cb->PartitionSize != NULL) {
context->partition_units =
context->cb->PartitionSize(context->flash) /
WHFU_BYTES_PER_UNIT;
if (context->cb->PartitionSize == NULL) {
ret = WH_ERROR_BADARGS;
}
else {
partition_size = context->cb->PartitionSize(context->flash);
if (((partition_size % WHFU_BYTES_PER_UNIT) != 0) ||
((partition_size / WHFU_BYTES_PER_UNIT) <
NF_PARTITION_DATA_OFFSET)) {
ret = WH_ERROR_BADARGS;
}
else {
context->partition_units = partition_size / WHFU_BYTES_PER_UNIT;
}
}

if (ret != WH_ERROR_OK) {
if (context->cb->Cleanup != NULL) {
(void)context->cb->Cleanup(context->flash);
}
return ret;
}

/* Unlock the both partitions */
Expand All @@ -1051,22 +1069,25 @@ int wh_NvmFlash_Init(void* c, const void* cf)
(void)nfPartition_ReadMemState(context, 1, &part_states[1]);

/* Decide which directory should be active */
if ( (part_states[0].status == NF_STATUS_USED) &&
(part_states[1].status != NF_STATUS_USED)) {
if ((part_states[0].status == NF_STATUS_USED) &&
(part_states[1].status != NF_STATUS_USED)) {
context->active = 0;
context->state = part_states[context->active];
} else if ( (part_states[0].status != NF_STATUS_USED) &&
(part_states[1].status == NF_STATUS_USED)) {
}
else if ((part_states[0].status != NF_STATUS_USED) &&
(part_states[1].status == NF_STATUS_USED)) {
context->active = 1;
context->state = part_states[context->active];
} else if ( (part_states[0].status == NF_STATUS_USED) &&
(part_states[1].status == NF_STATUS_USED)) {
}
else if ((part_states[0].status == NF_STATUS_USED) &&
(part_states[1].status == NF_STATUS_USED)) {
/* Check which has larger epoch */
context->active =
(part_states[1].epoch > part_states[0].epoch);
context->state = part_states[context->active];
} else if ( (part_states[0].status == NF_STATUS_FREE) &&
(part_states[1].status == NF_STATUS_FREE)) {
}
else if ((part_states[0].status == NF_STATUS_FREE) &&
(part_states[1].status == NF_STATUS_FREE)) {
/* Both are blank. Set active to 0 and initialize */
context->active = 0;
ret = nfPartition_ProgramInit(context, context->active);
Expand Down
4 changes: 4 additions & 0 deletions test/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,10 @@ ifeq ($(NVM_FLASH_CRC),1)
DEF += -DWOLFHSM_CFG_NVM_FLASH_CRC16
endif

ifneq ($(FLASH_UNIT_SIZE),)
DEF += -DWOLFHSM_CFG_FLASH_UNIT_SIZE=$(FLASH_UNIT_SIZE)
endif

# Build LMS/XMSS in verify-only mode (omits private-key, sign, and keygen
# paths). May be combined to exercise the mixed (one verify-only) case.
ifeq ($(LMS_VERIFY_ONLY),1)
Expand Down
Loading
Loading