Fix TPM2_CreatePrimary: Endorsement timeout, polish

Author: gojimmypi

IDE/Espressif/components/wolfssl/include/user_settings.h

@@ -647,7 +647,7 @@ Turn on timer debugging (used when CPU cycles not available)
 
 /* Choices are I2C or SPI*/
 /* WOLFTPM_I2C or not; when not defined, assumes SPI. */
-#define WOLFTPM_I2C
+/* #define WOLFTPM_I2C */
 
 /* Enable the wolfTPM example HAL in tpm_io.h */
 #define WOLFTPM_EXAMPLE_HAL
@@ -656,8 +656,10 @@ Turn on timer debugging (used when CPU cycles not available)
 #define WOLFTPM_INCLUDE_IO_FILE
 
 /* The default TPM_TIMEOUT_TRIES is 1,000,000 but can be overridden.
- * A value of 10000 is much more appropriate for the ESP32: */
-#define TPM_TIMEOUT_TRIES 10000
+ * A value of 10000 is much more appropriate for the ESP32.
+ * The extra long delay is for TPM2_CreatePrimary: Endorsement operations,
+ * which can take up to 60 seconds */
+#define TPM_TIMEOUT_TRIES 300000
 
 /* If not defined here, TPM_I2C_TRIES is set to a default value of 10 */
 /* #define TPM_I2C_TRIES 10 */

hal/tpm_io_espressif.c

@@ -440,23 +440,70 @@ int TPM2_IoCb_Espressif_I2C(TPM2_CTX* ctx, int isRead, word32 addr,
 /* end WOLFTPM_I2C */
 
 #else /* If not I2C, it must be SPI  */
-
-/* FSPI (HOST_SPI2) on esp32-s3-wroom */
-#ifndef PIN_NUM_MISO
-    #define PIN_NUM_MISO 13
-#endif
-#ifndef PIN_NUM_MOSI
-    #define PIN_NUM_MOSI 11
-#endif
-#ifndef PIN_NUM_CLK
-    #define PIN_NUM_CLK  12
-#endif
-#ifndef PIN_NUM_CS
-    #define PIN_NUM_CS   10
+/*---------------------------------------------------------------------------*/
+
+#define SPI_CLOCK_MHZ (10 * 1000 * 1000) /* 10MHz, but tested up to 22MHz */
+
+/* If failures are encountered, try hardware reset of TPM device. */
+#if defined(CONFIG_IDF_TARGET_ESP32S3)
+    /* NOTE: on esp, 64 byte limit includes data and header!!! */
+    #define SPI_MAX_TRANSFER 64
+
+    /* FSPI (HOST_SPI2) on esp32-s3-wroom */
+    #ifndef PIN_NUM_MISO
+        #define PIN_NUM_MISO 13
+    #endif
+    #ifndef PIN_NUM_MOSI
+        #define PIN_NUM_MOSI 11
+    #endif
+    #ifndef PIN_NUM_CLK
+        #define PIN_NUM_CLK  12
+    #endif
+    #ifndef PIN_NUM_CS
+        #define PIN_NUM_CS   10
+    #endif
+#elif defined(CONFIG_IDF_TARGET_ESP32C6)
+    #define SPI_MAX_TRANSFER 1024
+    #ifndef PIN_NUM_MISO
+        #define PIN_NUM_MISO 2 /* orange */
+    #endif
+    #ifndef PIN_NUM_MOSI
+        #define PIN_NUM_MOSI 7 /* yellow */
+    #endif
+    #ifndef PIN_NUM_CLK
+        #define PIN_NUM_CLK  6  /* gray */
+    #endif
+    #ifndef PIN_NUM_CS
+        /* Set to 10 on ESP32-C6 despite documentation that states 16
+         * Tested on ESP32-C6-DevKitC-1 */
+        #define PIN_NUM_CS   10
+        /* Allow software control */
+        #define PIN_NUM_SPICS_IO -1
+    #endif
+#else
+    #define SPI_MAX_TRANSFER 64
+    #ifndef PIN_NUM_MISO
+        #error PIN_NUM_MISO undefined
+    #endif
+    #ifndef PIN_NUM_MOSI
+        #error PIN_NUM_MOSI undefined
+    #endif
+    #ifndef PIN_NUM_CLK
+        #error PIN_NUM_CLK undefined
+    #endif
+    #ifndef PIN_NUM_CS
+        #error PIN_NUM_CS undefined
+    #endif
 #endif
 
-/* NOTE: on esp, 64 byte limit includes data and header!!! */
-#define SPI_MAX_TRANSFER 64
+/* Set spi_device_interface_config_t.spics_io_num = PIN_NUM_SPICS_IO
+ *     to -1 to let software control.
+ *     to CS Pin = PIN_NUM_CS for hardware control.
+ * See tpm_spi_acquire() and tpm_spi_release()
+ * Software control still requires CS pin  */
+#ifndef PIN_NUM_SPICS_IO
+    #define PIN_NUM_SPICS_IO PIN_NUM_CS
+#endif
 
 /* TPM data storing SPI handles & timeouts */
 static struct TPM_DATA {
@@ -475,12 +522,12 @@ static int esp_spi_master_init() {
         .sclk_io_num = PIN_NUM_CLK,
         .quadwp_io_num = -1,
         .quadhd_io_num = -1,
-        .max_transfer_sz = 64
+        .max_transfer_sz = SPI_MAX_TRANSFER
     };
     const spi_device_interface_config_t dev_cfg = {
-        .clock_speed_hz = 10*1000*1000, /* 10MHz, but tested up to 22MHz */
+        .clock_speed_hz = SPI_CLOCK_MHZ,
         .mode = 0,
-        .spics_io_num = PIN_NUM_CS,
+        .spics_io_num = PIN_NUM_SPICS_IO, /* -1 for SW or PIN_NUM_CS */
         .queue_size = 1,
         .pre_cb = NULL,
         .post_cb = NULL,
@@ -531,7 +578,7 @@ int tpm_spi_raw_transfer (const byte *data_out, byte *data_in, size_t cnt) {
 
     /* Maximum transfer size is 64 byte because we don't use DMA. */
     if (cnt > SPI_MAX_TRANSFER) {
-        printf("tpm_io_espressif: cnt %d\n", cnt);
+        ESP_LOGE(TAG, "tpm_io_espressif: cnt %d\n", cnt);
         return -1;
     }
 

wolftpm/tpm2_types.h

@@ -493,6 +493,8 @@ typedef int64_t  INT64;
     #endif
     #include <unistd.h>
     #define XTPM_WAIT() usleep(XTPM_WAIT_POLLING_US);
+#elif defined(WOLFSSL_ESPIDF)
+    #define XTPM_WAIT() vTaskDelay(pdMS_TO_TICKS(1))
 #endif
 #ifndef XTPM_WAIT
     #define XTPM_WAIT() /* just poll without delay by default */