Merge pull request #13614 from Staars/patch-2

port ESP32-HomeKit to ESP32-C3

lib/libesp32_div/ESP32-HomeKit/src/esp_mfi_debug.h

@@ -35,12 +35,12 @@ extern "C"{
 #define ESP_MFI_DEBUG_FL "\n"
 #define CONFIG_ESP_MFI_DEBUG_ENABLE
 #ifdef CONFIG_ESP_MFI_DEBUG_ENABLE
-#define ESP_MFI_DEBUG_ENABLE
+// #define ESP_MFI_DEBUG_ENABLE
 #endif /* CONFIG_ESP_MFI_DEBUG_ENABLE */
 
 #define CONFIG_ESP_MFI_ASSERT
 #ifdef CONFIG_ESP_MFI_ASSERT
-#define ESP_MFI_ASSERT_ENABLE
+// #define ESP_MFI_ASSERT_ENABLE
 #endif /* CONFIG_ESP_MFI_ASSERT */
 
 #define CONFIG_MFI_DEBUG_LEVEL_INIT 0

lib/libesp32_div/ESP32-HomeKit/src/port/bignum.h

@@ -13,68 +13,8 @@
 // limitations under the License.
 #pragma once
 
-#include_next "mbedtls/bignum.h"
+#if CONFIG_IDF_TARGET_ESP32
-#include "sdkconfig.h"
+#include "bignum_ESP32.h"
-
+#elif CONFIG_IDF_TARGET_ESP32C3
-/**
+#include "bignum_ESP32_C3.h"
- * This is a wrapper for the main mbedtls/bignum.h. This wrapper
+#endif
- * provides a few additional ESP32-only functions.
- *
- * This is because we don't set MBEDTLS_BIGNUM_ALT in the same way we
- * do for AES, SHA, etc. Because we still use most of the bignum.h
- * implementation and just replace a few hardware accelerated
- * functions (see MBEDTLS_MPI_EXP_MOD_ALT & MBEDTLS_MPI_MUL_MPI_ALT in
- * esp_config.h).
- *
- * @note Unlike the other hardware accelerator support functions in esp32/hwcrypto, there is no
- * generic "hwcrypto/bignum.h" header for using these functions without mbedTLS. The reason for this
- * is that all of the function implementations depend strongly upon the mbedTLS MPI implementation.
- */
-
-/**
- * @brief Lock access to RSA Accelerator (MPI/bignum operations)
- *
- * RSA Accelerator hardware unit can only be used by one
- * consumer at a time.
- *
- * @note This function is non-recursive (do not call it twice from the
- * same task.)
- *
- * @note You do not need to call this if you are using the mbedTLS bignum.h
- * API or esp_mpi_xxx functions. This function is only needed if you
- * want to call ROM RSA functions or access the registers directly.
- *
- */
-void esp_mpi_acquire_hardware(void);
-
-/**
- * @brief Unlock access to RSA Accelerator (MPI/bignum operations)
- *
- * Has to be called once for each call to esp_mpi_acquire_hardware().
- *
- * @note You do not need to call this if you are using the mbedTLS bignum.h
- * API or esp_mpi_xxx functions. This function is only needed if you
- * want to call ROM RSA functions or access the registers directly.
- */
-void esp_mpi_release_hardware(void);
-
-//#if CONFIG_MBEDTLS_HARDWARE_MPI
-
-/* @brief MPI modular mupltiplication function
- *
- * Calculates Z = (X * Y) mod M using MPI hardware acceleration.
- *
- * This is not part of the standard mbedTLS bignum API.
- *
- * @note All of X, Y & Z should be less than 4096 bit long or an error is returned.
- *
- * @param Z Result bignum, should be pre-initialised with mbedtls_mpi_init().
- * @param X First multiplication argument.
- * @param Y Second multiplication argument.
- * @param M Modulus value for result.
- *
- * @return 0 on success, mbedTLS MPI error codes on failure.
- */
-int esp_mpi_mul_mpi_mod(mbedtls_mpi *Z, const mbedtls_mpi *X, const mbedtls_mpi *Y, const mbedtls_mpi *M);
-
-//#endif // CONFIG_MBEDTLS_HARDWARE_MPI

lib/libesp32_div/ESP32-HomeKit/src/port/bignum_ESP32.c

@@ -21,6 +21,7 @@
  *
  */
 
+#if CONFIG_IDF_TARGET_ESP32
 #if __has_include("esp_idf_version.h")
 #include "esp_idf_version.h"
 #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 0, 0)
@@ -35,6 +36,9 @@
 #include "bignum_impl.h"
 #include <sys/param.h>
 #include <sys/lock.h>
+#if CONFIG_IDF_TARGET_ESP32C3
+#include "esp32c3/dport_access.h"
+#endif 
 
 static _lock_t mpi_lock;
 
@@ -284,3 +288,4 @@ void esp_mpi_mult_mpi_failover_mod_mult_hw_op(const mbedtls_mpi *X, const mbedtl
     start_op(RSA_MULT_START_REG);
 
 }
+#endif //CONFIG_IDF_TARGET_ESP32

lib/libesp32_div/ESP32-HomeKit/src/port/bignum_ESP32.h

@@ -0,0 +1,82 @@
+// Copyright 2015-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.
+#if CONFIG_IDF_TARGET_ESP32
+#pragma once
+
+#include_next "mbedtls/bignum.h"
+#include "sdkconfig.h"
+
+/**
+ * This is a wrapper for the main mbedtls/bignum.h. This wrapper
+ * provides a few additional ESP32-only functions.
+ *
+ * This is because we don't set MBEDTLS_BIGNUM_ALT in the same way we
+ * do for AES, SHA, etc. Because we still use most of the bignum.h
+ * implementation and just replace a few hardware accelerated
+ * functions (see MBEDTLS_MPI_EXP_MOD_ALT & MBEDTLS_MPI_MUL_MPI_ALT in
+ * esp_config.h).
+ *
+ * @note Unlike the other hardware accelerator support functions in esp32/hwcrypto, there is no
+ * generic "hwcrypto/bignum.h" header for using these functions without mbedTLS. The reason for this
+ * is that all of the function implementations depend strongly upon the mbedTLS MPI implementation.
+ */
+
+/**
+ * @brief Lock access to RSA Accelerator (MPI/bignum operations)
+ *
+ * RSA Accelerator hardware unit can only be used by one
+ * consumer at a time.
+ *
+ * @note This function is non-recursive (do not call it twice from the
+ * same task.)
+ *
+ * @note You do not need to call this if you are using the mbedTLS bignum.h
+ * API or esp_mpi_xxx functions. This function is only needed if you
+ * want to call ROM RSA functions or access the registers directly.
+ *
+ */
+void esp_mpi_acquire_hardware(void);
+
+/**
+ * @brief Unlock access to RSA Accelerator (MPI/bignum operations)
+ *
+ * Has to be called once for each call to esp_mpi_acquire_hardware().
+ *
+ * @note You do not need to call this if you are using the mbedTLS bignum.h
+ * API or esp_mpi_xxx functions. This function is only needed if you
+ * want to call ROM RSA functions or access the registers directly.
+ */
+void esp_mpi_release_hardware(void);
+
+//#if CONFIG_MBEDTLS_HARDWARE_MPI
+
+/* @brief MPI modular mupltiplication function
+ *
+ * Calculates Z = (X * Y) mod M using MPI hardware acceleration.
+ *
+ * This is not part of the standard mbedTLS bignum API.
+ *
+ * @note All of X, Y & Z should be less than 4096 bit long or an error is returned.
+ *
+ * @param Z Result bignum, should be pre-initialised with mbedtls_mpi_init().
+ * @param X First multiplication argument.
+ * @param Y Second multiplication argument.
+ * @param M Modulus value for result.
+ *
+ * @return 0 on success, mbedTLS MPI error codes on failure.
+ */
+int esp_mpi_mul_mpi_mod(mbedtls_mpi *Z, const mbedtls_mpi *X, const mbedtls_mpi *Y, const mbedtls_mpi *M);
+
+//#endif // CONFIG_MBEDTLS_HARDWARE_MPI
+#endif CONFIG_IDF_TARGET_ESP32

lib/libesp32_div/ESP32-HomeKit/src/port/bignum_ESP32_C3.c

@@ -0,0 +1,108 @@
+/**
+ * \brief  Multi-precision integer library, ESP-IDF hardware accelerated parts
+ *
+ *  based on mbedTLS implementation
+ *
+ *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
+ *  Additions Copyright (C) 2016-2020, Espressif Systems (Shanghai) PTE Ltd
+ *  SPDX-License-Identifier: Apache-2.0
+ *
+ *  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.
+ *
+ */
+
+#if CONFIG_IDF_TARGET_ESP32C3
+#if __has_include("esp_idf_version.h")
+#include "esp_idf_version.h"
+#endif
+
+#include <sys/param.h>
+#include "soc/hwcrypto_periph.h"
+#include "driver/periph_ctrl.h"
+#include "mbedtls/bignum.h"
+#include "bignum_impl.h"
+#include "soc/system_reg.h"
+#include "soc/periph_defs.h"
+#include "esp_crypto_lock.h"
+
+/* Copy mbedTLS MPI bignum 'mpi' to hardware memory block at 'mem_base'.
+
+   If hw_words is higher than the number of words in the bignum then
+   these additional words will be zeroed in the memory buffer.
+
+*/
+static inline void mpi_to_mem_block(uint32_t mem_base, const mbedtls_mpi *mpi, size_t num_words)
+{
+    uint32_t *pbase = (uint32_t *)mem_base;
+    uint32_t copy_words = MIN(num_words, mpi->n);
+
+    /* Copy MPI data to memory block registers */
+    for (int i = 0; i < copy_words; i++) {
+        pbase[i] = mpi->p[i];
+    }
+
+    /* Zero any remaining memory block data */
+    for (int i = copy_words; i < num_words; i++) {
+        pbase[i] = 0;
+    }
+}
+
+/* Read mbedTLS MPI bignum back from hardware memory block.
+
+   Reads num_words words from block.
+
+   Bignum 'x' should already be grown to at least num_words by caller (can be done while
+   calculation is in progress, to save some cycles)
+*/
+static inline void mem_block_to_mpi(mbedtls_mpi *x, uint32_t mem_base, int num_words)
+{
+
+    /* Copy data from memory block registers */
+    const size_t REG_WIDTH = sizeof(uint32_t);
+    for (size_t i = 0; i < num_words; i++) {
+        x->p[i] = REG_READ(mem_base + (i * REG_WIDTH));
+    }
+    /* Zero any remaining limbs in the bignum, if the buffer is bigger
+       than num_words */
+    for (size_t i = num_words; i < x->n; i++) {
+        x->p[i] = 0;
+    }
+
+}
+
+/* Begin an RSA operation. op_reg specifies which 'START' register
+   to write to.
+*/
+static inline void start_op(uint32_t op_reg)
+{
+    /* Clear interrupt status */
+    REG_WRITE(RSA_CLEAR_INTERRUPT_REG, 1);
+
+    /* Note: above REG_WRITE includes a memw, so we know any writes
+       to the memory blocks are also complete. */
+
+    REG_WRITE(op_reg, 1);
+}
+
+/* Wait for an RSA operation to complete.
+*/
+static inline void wait_op_complete(void)
+{
+    while (REG_READ(RSA_QUERY_INTERRUPT_REG) != 1)
+    { }
+
+    /* clear the interrupt */
+    REG_WRITE(RSA_CLEAR_INTERRUPT_REG, 1);
+}
+
+#endif //CONFIG_IDF_TARGET_ESP32C3

lib/libesp32_div/ESP32-HomeKit/src/port/bignum_ESP32_C3.h

@@ -0,0 +1,87 @@
+// Copyright 2015-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.
+#if CONFIG_IDF_TARGET_ESP32C3
+#pragma once
+
+#include_next "mbedtls/bignum.h"
+#include "sdkconfig.h"
+
+/**
+ * This is a wrapper for the main mbedtls/bignum.h. This wrapper
+ * provides a few additional ESP32-only functions.
+ *
+ * This is because we don't set MBEDTLS_BIGNUM_ALT in the same way we
+ * do for AES, SHA, etc. Because we still use most of the bignum.h
+ * implementation and just replace a few hardware accelerated
+ * functions (see MBEDTLS_MPI_EXP_MOD_ALT & MBEDTLS_MPI_MUL_MPI_ALT in
+ * esp_config.h).
+ *
+ * @note Unlike the other hardware accelerator support functions in esp32/hwcrypto, there is no
+ * generic "hwcrypto/bignum.h" header for using these functions without mbedTLS. The reason for this
+ * is that all of the function implementations depend strongly upon the mbedTLS MPI implementation.
+ */
+
+/**
+ * @brief Lock access to RSA Accelerator (MPI/bignum operations)
+ *
+ * RSA Accelerator hardware unit can only be used by one
+ * consumer at a time.
+ *
+ * @note This function is non-recursive (do not call it twice from the
+ * same task.)
+ *
+ * @note You do not need to call this if you are using the mbedTLS bignum.h
+ * API or esp_mpi_xxx functions. This function is only needed if you
+ * want to call ROM RSA functions or access the registers directly.
+ *
+ */
+void esp_mpi_acquire_hardware(void);
+
+/**
+ * @brief Unlock access to RSA Accelerator (MPI/bignum operations)
+ *
+ * Has to be called once for each call to esp_mpi_acquire_hardware().
+ *
+ * @note You do not need to call this if you are using the mbedTLS bignum.h
+ * API or esp_mpi_xxx functions. This function is only needed if you
+ * want to call ROM RSA functions or access the registers directly.
+ */
+void esp_mpi_release_hardware(void);
+
+//#if CONFIG_MBEDTLS_HARDWARE_MPI
+
+/* @brief MPI modular mupltiplication function
+ *
+ * Calculates Z = (X * Y) mod M using MPI hardware acceleration.
+ *
+ * This is not part of the standard mbedTLS bignum API.
+ *
+ * @note All of X, Y & Z should be less than 4096 bit long or an error is returned.
+ *
+ * @param Z Result bignum, should be pre-initialised with mbedtls_mpi_init().
+ * @param X First multiplication argument.
+ * @param Y Second multiplication argument.
+ * @param M Modulus value for result.
+ *
+ * @return 0 on success, mbedTLS MPI error codes on failure.
+ */
+int esp_mpi_mul_mpi_mod(mbedtls_mpi *Z, const mbedtls_mpi *X, const mbedtls_mpi *Y, const mbedtls_mpi *M);
+
+void esp_mpi_mul_mpi_mod_hw_op(const mbedtls_mpi *X, const mbedtls_mpi *Y, const mbedtls_mpi *M, const mbedtls_mpi *Rinv, mbedtls_mpi_uint Mprime, size_t num_words);
+static inline void mpi_to_mem_block(uint32_t mem_base, const mbedtls_mpi *mpi, size_t num_words);
+void esp_mpi_mul_mpi_hw_op(const mbedtls_mpi *X, const mbedtls_mpi *Y, size_t num_words);
+
+
+//#endif // CONFIG_MBEDTLS_HARDWARE_MPI
+#endif //CONFIG_IDF_TARGET_ESP32C3

lib/libesp32_div/ESP32-HomeKit/src/port/bignum_impl.h

@@ -10,7 +10,7 @@
    exponentiation instead.
 */
 
-#define CONFIG_IDF_TARGET_ESP32  1
+// #define CONFIG_IDF_TARGET_ESP32  1
 
 #if CONFIG_IDF_TARGET_ESP32
 #define ESP_MPI_USE_MONT_EXP
@@ -19,7 +19,7 @@
 //#define MBEDTLS_MPI_MUL_MPI_ALT
 #endif
 
-
+#if CONFIG_IDF_TARGET_ESP32
 int esp_mpi_exp_mod( mbedtls_mpi *Z, const mbedtls_mpi *X, const mbedtls_mpi *Y, const mbedtls_mpi *M, mbedtls_mpi *_Rinv );
 
 /**
@@ -86,7 +86,11 @@ int esp_mont_hw_op(mbedtls_mpi* Z, const mbedtls_mpi* X, const mbedtls_mpi* Y, c
  *
  */
 void esp_mpi_exp_mpi_mod_hw_op(const mbedtls_mpi *X, const mbedtls_mpi *Y, const mbedtls_mpi *M, const mbedtls_mpi *Rinv, mbedtls_mpi_uint Mprime, size_t hw_words);
-
+#endif //CONFIG_IDF_TARGET_ESP32
 #endif //ESP_MPI_USE_MONT_EXP
 
+#if CONFIG_IDF_TARGET_ESP32C3
+void esp_mpi_exp_mpi_mod_hw_op(const mbedtls_mpi *X, const mbedtls_mpi *Y, const mbedtls_mpi *M, const mbedtls_mpi *Rinv, mbedtls_mpi_uint Mprime, size_t num_words);
+#endif //CONFIG_IDF_TARGET_ESP32C3
+
 #endif

lib/libesp32_div/ESP32-HomeKit/src/port/esp_bignum.c

@@ -79,7 +79,7 @@ static inline size_t bits_to_words(size_t bits)
 /* Return the number of words actually used to represent an mpi
    number.
 */
-#if defined(MBEDTLS_MPI_EXP_MOD_ALT)
+#if defined(MBEDTLS_MPI_EXP_MOD_ALT) || defined(CONFIG_IDF_TARGET_ESP32C3)
 static size_t mpi_words(const mbedtls_mpi *mpi)
 {
     for (size_t i = mpi->n; i > 0; i--) {
@@ -369,6 +369,87 @@ cleanup:
 
 #endif /* MBEDTLS_MPI_EXP_MOD_ALT */
 
+#if CONFIG_IDF_TARGET_ESP32C3
+int esp_mpi_exp_mod( mbedtls_mpi *Z, const mbedtls_mpi *X, const mbedtls_mpi *Y, const mbedtls_mpi *M, mbedtls_mpi *_Rinv )
+{
+    int ret = 0;
+    size_t x_words = mpi_words(X);
+    size_t y_words = mpi_words(Y);
+    size_t m_words = mpi_words(M);
+
+
+    /* "all numbers must be the same length", so choose longest number
+       as cardinal length of operation...
+    */
+    size_t num_words = esp_mpi_hardware_words(MAX(m_words, MAX(x_words, y_words)));
+
+    mbedtls_mpi Rinv_new; /* used if _Rinv == NULL */
+    mbedtls_mpi *Rinv;    /* points to _Rinv (if not NULL) othwerwise &RR_new */
+    mbedtls_mpi_uint Mprime;
+
+    if (mbedtls_mpi_cmp_int(M, 0) <= 0 || (M->p[0] & 1) == 0) {
+        return MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
+    }
+
+    if (mbedtls_mpi_cmp_int(Y, 0) < 0) {
+        return MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
+    }
+
+    if (mbedtls_mpi_cmp_int(Y, 0) == 0) {
+        return mbedtls_mpi_lset(Z, 1);
+    }
+
+    if (num_words * 32 > SOC_RSA_MAX_BIT_LEN) {
+        return MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
+    }
+
+    /* Determine RR pointer, either _RR for cached value
+       or local RR_new */
+    if (_Rinv == NULL) {
+        mbedtls_mpi_init(&Rinv_new);
+        Rinv = &Rinv_new;
+    } else {
+        Rinv = _Rinv;
+    }
+    if (Rinv->p == NULL) {
+        MBEDTLS_MPI_CHK(calculate_rinv(Rinv, M, num_words));
+    }
+
+    Mprime = modular_inverse(M);
+
+    // Montgomery exponentiation: Z = X ^ Y mod M  (HAC 14.94)
+#ifdef ESP_MPI_USE_MONT_EXP
+    ret = mpi_montgomery_exp_calc(Z, X, Y, M, Rinv, num_words, Mprime) ;
+    MBEDTLS_MPI_CHK(ret);
+#else
+    esp_mpi_enable_hardware_hw_op();
+
+    esp_mpi_exp_mpi_mod_hw_op(X, Y, M, Rinv, Mprime, num_words);
+    ret = mbedtls_mpi_grow(Z, m_words);
+    if (ret != 0) {
+        esp_mpi_disable_hardware_hw_op();
+        goto cleanup;
+    }
+    esp_mpi_read_result_hw_op(Z, m_words);
+    esp_mpi_disable_hardware_hw_op();
+#endif
+
+    // Compensate for negative X
+    if (X->s == -1 && (Y->p[0] & 1) != 0) {
+        Z->s = -1;
+        MBEDTLS_MPI_CHK(mbedtls_mpi_add_mpi(Z, M, Z));
+    } else {
+        Z->s = 1;
+    }
+
+cleanup:
+    if (_Rinv == NULL) {
+        mbedtls_mpi_free(&Rinv_new);
+    }
+    return ret;
+}
+#endif //CONFIG_IDF_TARGET_ESP32C3
+
 
 
 #if defined(MBEDTLS_MPI_MUL_MPI_ALT) /* MBEDTLS_MPI_MUL_MPI_ALT */