wh_test_nvm_flash.h

/*
 * Copyright (C) 2024 wolfSSL Inc.
 *
 * This file is part of wolfHSM.
 *
 * wolfHSM is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * wolfHSM is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with wolfHSM.  If not, see <http://www.gnu.org/licenses/>.
 */
/*
 * test/wh_test_nvm_flash.h
 *
 */
#ifndef TEST_WH_TEST_NVM_FLASH_H_
#define TEST_WH_TEST_NVM_FLASH_H_

#include "wolfhsm/wh_nvm_flash.h"

/*
 * Runs all the NVM flash tests using a RAM-based flash memory simulator, and
 * optionally using a POSIX file simulator if WOLFHSM_CFG_TEST_POSIX is defined.
 * Returns 0 on success, and a non-zero error code on failure
 */
int whTest_NvmFlash(void);

/*
 * Runs low-level flash tests on a custom NVM flash configuration. Useful to
 * test your FLASH HAL implementation. This will erase the first partition.
 * Returns 0 on success, and a non-zero error code on failure
 */
int whTest_FlashCfg(const whFlashCb* fcb, void* fctx, const void* cfg);

/*
 * Runs NVM flash tests on a custom NVM flash configuration. Useful to test your
 * NVM HAL implementation
 * Returns 0 on success, and a non-zero error code on failure
 */
int whTest_NvmFlashCfg(whNvmFlashConfig* cfg);

#endif /* TEST_WH_TEST_NVM_FLASH_H_ */