diff --git a/components/hal/CMakeLists.txt b/components/hal/CMakeLists.txt index bcf4d99e04..39fd74d77a 100644 --- a/components/hal/CMakeLists.txt +++ b/components/hal/CMakeLists.txt @@ -141,7 +141,7 @@ if(NOT BOOTLOADER_BUILD) "xt_wdt_hal.c" "aes_hal.c" "esp32s3/brownout_hal.c" - "esp32s3/hmac_hal.c" + "hmac_hal.c" "esp32s3/touch_sensor_hal.c" "esp32s3/rtc_cntl_hal.c" "usb_dwc_hal.c") @@ -155,7 +155,7 @@ if(NOT BOOTLOADER_BUILD) "xt_wdt_hal.c" "aes_hal.c" "esp32c3/brownout_hal.c" - "esp32c3/hmac_hal.c" + "hmac_hal.c" "esp32c3/rtc_cntl_hal.c") endif() @@ -166,7 +166,7 @@ if(NOT BOOTLOADER_BUILD) "spi_slave_hd_hal.c" "aes_hal.c" "esp32h4/brownout_hal.c" - "esp32h4/hmac_hal.c" + "hmac_hal.c" "esp32h4/rtc_cntl_hal.c") endif() diff --git a/components/hal/esp32c3/hmac_hal.c b/components/hal/esp32c3/hmac_hal.c deleted file mode 100644 index 795c3e4247..0000000000 --- a/components/hal/esp32c3/hmac_hal.c +++ /dev/null @@ -1,83 +0,0 @@ -// Copyright 2020 Espressif Systems (Shanghai) PTE LTD -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#include "stdio.h" -#include "hal/hmac_hal.h" -#include "hal/hmac_ll.h" - -void hmac_hal_start(void) -{ - hmac_ll_wait_idle(); - hmac_ll_start(); -} - -uint32_t hmac_hal_configure(hmac_hal_output_t config, uint32_t key_id) -{ - hmac_ll_wait_idle(); - hmac_ll_config_output(config); - hmac_ll_config_hw_key_id(key_id); - hmac_ll_config_finish(); - hmac_ll_wait_idle(); - - uint32_t conf_error = hmac_ll_config_error(); - if (conf_error) { - hmac_ll_calc_finish(); - return 1; - } else if (config != HMAC_OUTPUT_USER) { - // In "downstream" mode, this will be the last hmac operation. Make sure HMAC is ready for - // the other peripheral. - hmac_ll_wait_idle(); - } - - return 0; -} - -void hmac_hal_write_one_block_512(const void *block) -{ - hmac_ll_wait_idle(); - hmac_ll_write_block_512(block); - hmac_ll_wait_idle(); - hmac_ll_msg_one_block(); -} - -void hmac_hal_write_block_512(const void *block) -{ - hmac_ll_wait_idle(); - hmac_ll_write_block_512(block); -} - -void hmac_hal_next_block_padding(void) -{ - hmac_ll_wait_idle(); - hmac_ll_msg_padding(); -} - -void hmac_hal_next_block_normal(void) -{ - hmac_ll_wait_idle(); - hmac_ll_msg_continue(); -} - -void hmac_hal_read_result_256(void *result) -{ - hmac_ll_wait_idle(); - hmac_ll_read_result_256(result); - hmac_ll_calc_finish(); -} - -void hmac_hal_clean(void) -{ - hmac_ll_wait_idle(); - hmac_ll_clean(); -} diff --git a/components/hal/esp32c3/include/hal/hmac_hal.h b/components/hal/esp32c3/include/hal/hmac_hal.h deleted file mode 100644 index e8e29d07fd..0000000000 --- a/components/hal/esp32c3/include/hal/hmac_hal.h +++ /dev/null @@ -1,109 +0,0 @@ -// Copyright 2020 Espressif Systems (Shanghai) PTE LTD -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -/******************************************************************************* - * NOTICE - * The hal is not public api, don't use it in application code. - * See readme.md in soc/include/hal/readme.md - ******************************************************************************/ - -#pragma once - -#include -#include - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * The HMAC peripheral can be configured to deliver its output to the user directly, or to deliver - * the output directly to another peripheral instead, e.g. the Digital Signature peripheral. - */ -typedef enum { - HMAC_OUTPUT_USER = 0, /**< Let user provide a message and read the HMAC result */ - HMAC_OUTPUT_DS = 1, /**< HMAC is provided to the DS peripheral to decrypt DS private key parameters */ - HMAC_OUTPUT_JTAG_ENABLE = 2, /**< HMAC is used to enable JTAG after soft-disabling it */ - HMAC_OUTPUT_ALL = 3 /**< HMAC is used for both as DS input for or enabling JTAG */ -} hmac_hal_output_t; - -/** - * @brief Make the peripheral ready for use. - * - * This triggers any further steps necessary after enabling the device - */ -void hmac_hal_start(void); - -/** - * @brief Configure which hardware key slot should be used and configure the target of the HMAC output. - * - * @note Writing out-of-range values is undefined behavior. The user has to ensure that the parameters are in range. - * - * @param config The target of the HMAC. Possible targets are described in \c hmac_hal_output_t. - * See the ESP32C3 TRM for more details. - * @param key_id The ID of the hardware key slot to be used. - * - * @return 0 if the configuration was successful, non-zero if not. - * An unsuccessful configuration means that the purpose value in the eFuse of the corresponding key slot - * doesn't match to supplied value of \c config. - */ -uint32_t hmac_hal_configure(hmac_hal_output_t config, uint32_t key_id); - -/** - * @brief Write a padded single-block message of 512 bits to the HMAC peripheral. - * - * The message must not be longer than one block (512 bits) and the padding has to be applied by software before - * writing. The padding has to be able to fit into the block after the message. - * For more information on HMAC padding, see the ESP32C3 TRM. - */ -void hmac_hal_write_one_block_512(const void *block); - -/** - * @brief Write a message block of 512 bits to the HMAC peripheral. - * - * This function must be used incombination with \c hmac_hal_next_block_normal() or \c hmac_hal_next_block_padding(). - * The first message block is written without any prerequisite. - * All message blocks which are not the last one, need a call to \c hmac_hal_next_block_normal() before, indicating - * to the hardware that a "normal", i.e. non-padded block will follow. This is even the case for a block which begins - * padding already but where the padding doesn't fit in (remaining message size > (block size - padding size)). - * Before writing the last block which contains the padding, a call to \c hmac_hal_next_block_padding() is necessary - * to indicate to the hardware that a block with padding will be written. - * - * For more information on HMAC padding, see the ESP32C3 TRM. - */ -void hmac_hal_write_block_512(const void *block); - -/** - * @brief Indicate to the hardware that a normal block will be written. - */ -void hmac_hal_next_block_normal(void); - -/** - * @brief Indicate to the hardware that a block with padding will be written. - */ -void hmac_hal_next_block_padding(void); - -/** - * @brief Read the 256 bit HMAC result from the hardware. - */ -void hmac_hal_read_result_256(void *result); - -/** - * @brief Clear (invalidate) the HMAC result provided to other hardware. - */ -void hmac_hal_clean(void); - -#ifdef __cplusplus -} -#endif diff --git a/components/hal/esp32s3/hmac_hal.c b/components/hal/esp32s3/hmac_hal.c deleted file mode 100644 index f39ca72f30..0000000000 --- a/components/hal/esp32s3/hmac_hal.c +++ /dev/null @@ -1,74 +0,0 @@ -/* - * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD - * - * SPDX-License-Identifier: Apache-2.0 - */ - -#include "hal/hmac_hal.h" -#include "hal/hmac_ll.h" - -void hmac_hal_start(void) -{ - hmac_ll_wait_idle(); - hmac_ll_start(); -} - -uint32_t hmac_hal_configure(hmac_hal_output_t config, uint32_t key_id) -{ - hmac_ll_wait_idle(); - hmac_ll_config_output(config); - hmac_ll_config_hw_key_id(key_id); - hmac_ll_config_finish(); - hmac_ll_wait_idle(); - - uint32_t conf_error = hmac_ll_config_error(); - if (conf_error) { - hmac_ll_calc_finish(); - return 1; - } else if (config != HMAC_OUTPUT_USER) { - // In "downstream" mode, this will be the last hmac operation. Make sure HMAC is ready for - // the other peripheral. - hmac_ll_wait_idle(); - } - - return 0; -} - -void hmac_hal_write_one_block_512(const void *block) -{ - hmac_ll_wait_idle(); - hmac_ll_write_block_512(block); - hmac_ll_wait_idle(); - hmac_ll_msg_one_block(); -} - -void hmac_hal_write_block_512(const void *block) -{ - hmac_ll_wait_idle(); - hmac_ll_write_block_512(block); -} - -void hmac_hal_next_block_padding(void) -{ - hmac_ll_wait_idle(); - hmac_ll_msg_padding(); -} - -void hmac_hal_next_block_normal(void) -{ - hmac_ll_wait_idle(); - hmac_ll_msg_continue(); -} - -void hmac_hal_read_result_256(void *result) -{ - hmac_ll_wait_idle(); - hmac_ll_read_result_256(result); - hmac_ll_calc_finish(); -} - -void hmac_hal_clean(void) -{ - hmac_ll_wait_idle(); - hmac_ll_clean(); -} diff --git a/components/hal/esp32s3/include/hal/hmac_hal.h b/components/hal/esp32s3/include/hal/hmac_hal.h deleted file mode 100644 index af6fb65af4..0000000000 --- a/components/hal/esp32s3/include/hal/hmac_hal.h +++ /dev/null @@ -1,101 +0,0 @@ -/* - * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD - * - * SPDX-License-Identifier: Apache-2.0 - */ - -/******************************************************************************* - * NOTICE - * The hal is not public api, don't use it in application code. - * See readme.md in soc/include/hal/readme.md - ******************************************************************************/ - -#pragma once - -#include -#include - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * The HMAC peripheral can be configured to deliver its output to the user directly, or to deliver - * the output directly to another peripheral instead, e.g. the Digital Signature peripheral. - */ -typedef enum { - HMAC_OUTPUT_USER = 0, /**< Let user provide a message and read the HMAC result */ - HMAC_OUTPUT_DS = 1, /**< HMAC is provided to the DS peripheral to decrypt DS private key parameters */ - HMAC_OUTPUT_JTAG_ENABLE = 2, /**< HMAC is used to enable JTAG after soft-disabling it */ - HMAC_OUTPUT_ALL = 3 /**< HMAC is used for both as DS input for or enabling JTAG */ -} hmac_hal_output_t; - -/** - * @brief Make the peripheral ready for use. - * - * This triggers any further steps necessary after enabling the device - */ -void hmac_hal_start(void); - -/** - * @brief Configure which hardware key slot should be used and configure the target of the HMAC output. - * - * @note Writing out-of-range values is undefined behavior. The user has to ensure that the parameters are in range. - * - * @param config The target of the HMAC. Possible targets are described in \c hmac_hal_output_t. - * See the ESP32S3 TRM for more details. - * @param key_id The ID of the hardware key slot to be used. - * - * @return 0 if the configuration was successful, non-zero if not. - * An unsuccessful configuration means that the purpose value in the eFuse of the corresponding key slot - * doesn't match to supplied value of \c config. - */ -uint32_t hmac_hal_configure(hmac_hal_output_t config, uint32_t key_id); - -/** - * @brief Write a padded single-block message of 512 bits to the HMAC peripheral. - * - * The message must not be longer than one block (512 bits) and the padding has to be applied by software before - * writing. The padding has to be able to fit into the block after the message. - * For more information on HMAC padding, see the ESP32S3 TRM. - */ -void hmac_hal_write_one_block_512(const void *block); - -/** - * @brief Write a message block of 512 bits to the HMAC peripheral. - * - * This function must be used incombination with \c hmac_hal_next_block_normal() or \c hmac_hal_next_block_padding(). - * The first message block is written without any prerequisite. - * All message blocks which are not the last one, need a call to \c hmac_hal_next_block_normal() before, indicating - * to the hardware that a "normal", i.e. non-padded block will follow. This is even the case for a block which begins - * padding already but where the padding doesn't fit in (remaining message size > (block size - padding size)). - * Before writing the last block which contains the padding, a call to \c hmac_hal_next_block_padding() is necessary - * to indicate to the hardware that a block with padding will be written. - * - * For more information on HMAC padding, see the ESP32S3 TRM. - */ -void hmac_hal_write_block_512(const void *block); - -/** - * @brief Indicate to the hardware that a normal block will be written. - */ -void hmac_hal_next_block_normal(void); - -/** - * @brief Indicate to the hardware that a block with padding will be written. - */ -void hmac_hal_next_block_padding(void); - -/** - * @brief Read the 256 bit HMAC result from the hardware. - */ -void hmac_hal_read_result_256(void *result); - -/** - * @brief Clear (invalidate) the HMAC result provided to other hardware. - */ -void hmac_hal_clean(void); - -#ifdef __cplusplus -} -#endif diff --git a/components/hal/esp32h4/hmac_hal.c b/components/hal/hmac_hal.c similarity index 100% rename from components/hal/esp32h4/hmac_hal.c rename to components/hal/hmac_hal.c diff --git a/components/hal/esp32h4/include/hal/hmac_hal.h b/components/hal/include/hal/hmac_hal.h similarity index 94% rename from components/hal/esp32h4/include/hal/hmac_hal.h rename to components/hal/include/hal/hmac_hal.h index b507caf3a0..b5eb6c4196 100644 --- a/components/hal/esp32h4/include/hal/hmac_hal.h +++ b/components/hal/include/hal/hmac_hal.h @@ -43,7 +43,7 @@ void hmac_hal_start(void); * @note Writing out-of-range values is undefined behavior. The user has to ensure that the parameters are in range. * * @param config The target of the HMAC. Possible targets are described in \c hmac_hal_output_t. - * See the ESP32H4 TRM for more details. + * See the TRM of your target chip for more details. * @param key_id The ID of the hardware key slot to be used. * * @return 0 if the configuration was successful, non-zero if not. @@ -57,7 +57,7 @@ uint32_t hmac_hal_configure(hmac_hal_output_t config, uint32_t key_id); * * The message must not be longer than one block (512 bits) and the padding has to be applied by software before * writing. The padding has to be able to fit into the block after the message. - * For more information on HMAC padding, see the ESP32H4 TRM. + * For more information on HMAC padding, see the TRM of your target chip. */ void hmac_hal_write_one_block_512(const void *block); @@ -72,7 +72,7 @@ void hmac_hal_write_one_block_512(const void *block); * Before writing the last block which contains the padding, a call to \c hmac_hal_next_block_padding() is necessary * to indicate to the hardware that a block with padding will be written. * - * For more information on HMAC padding, see the ESP32H4 TRM. + * For more information on HMAC padding, see the TRM of your target chip for more details. */ void hmac_hal_write_block_512(const void *block);