Merge branch 'bugfix/remove_remaining_rom_time_t_dependencies_v5.0' into 'release/v5.0'

Newlib: Add workaround for ROM Newlib stdio functions using 32-bit time_t callpath (v5.0)

See merge request espressif/esp-idf!19685

components/esp_rom/esp32/Kconfig.soc_caps.in

@@ -18,3 +18,7 @@ config ESP_ROM_HAS_JPEG_DECODE
 config ESP_ROM_SUPPORT_MULTIPLE_UART
     bool
     default y
+
+config ESP_ROM_NEEDS_SWSETUP_WORKAROUND
+    bool
+    default y

components/esp_rom/esp32/esp_rom_caps.h

@@ -1,16 +1,8 @@
-// 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.
+/*
+ * SPDX-FileCopyrightText: 2020-2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
 
 #pragma once
 
@@ -18,3 +10,4 @@
 #define ESP_ROM_HAS_CRC_BE              (1) // ROM CRC library supports Big Endian
 #define ESP_ROM_HAS_JPEG_DECODE         (1) // ROM has JPEG decode library
 #define ESP_ROM_SUPPORT_MULTIPLE_UART   (1) // ROM has multiple UARTs available for logging
+#define ESP_ROM_NEEDS_SWSETUP_WORKAROUND    (1) // ROM uses 32-bit time_t. A workaround is required to prevent printf functions from crashing

components/esp_rom/esp32c3/Kconfig.soc_caps.in

@@ -34,3 +34,7 @@ config ESP_ROM_HAS_ERASE_0_REGION_BUG
 config ESP_ROM_GET_CLK_FREQ
     bool
     default y
+
+config ESP_ROM_NEEDS_SWSETUP_WORKAROUND
+    bool
+    default y

components/esp_rom/esp32c3/esp_rom_caps.h

@@ -14,3 +14,4 @@
 #define ESP_ROM_HAS_RETARGETABLE_LOCKING    (1) // ROM was built with retargetable locking
 #define ESP_ROM_HAS_ERASE_0_REGION_BUG      (1) // ROM has esp_flash_erase_region(size=0) bug
 #define ESP_ROM_GET_CLK_FREQ                (1) // Get clk frequency with rom function `ets_get_cpu_frequency`
+#define ESP_ROM_NEEDS_SWSETUP_WORKAROUND    (1) // ROM uses 32-bit time_t. A workaround is required to prevent printf functions from crashing

components/esp_rom/esp32s2/Kconfig.soc_caps.in

@@ -10,3 +10,7 @@ config ESP_ROM_HAS_CRC_LE
 config ESP_ROM_SUPPORT_MULTIPLE_UART
     bool
     default y
+
+config ESP_ROM_NEEDS_SWSETUP_WORKAROUND
+    bool
+    default y

components/esp_rom/esp32s2/esp_rom_caps.h

@@ -1,18 +1,11 @@
-// 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.
+/*
+ * SPDX-FileCopyrightText: 2020-2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
 
 #pragma once
 
 #define ESP_ROM_HAS_CRC_LE            (1) // ROM CRC library supports Little Endian
 #define ESP_ROM_SUPPORT_MULTIPLE_UART (1) // ROM has multiple UARTs available for logging
+#define ESP_ROM_NEEDS_SWSETUP_WORKAROUND    (1) // ROM uses 32-bit time_t. A workaround is required to prevent printf functions from crashing

components/esp_rom/esp32s3/Kconfig.soc_caps.in

@@ -42,3 +42,7 @@ config ESP_ROM_GET_CLK_FREQ
 config ESP_ROM_HAS_HAL_WDT
     bool
     default y
+
+config ESP_ROM_NEEDS_SWSETUP_WORKAROUND
+    bool
+    default y

components/esp_rom/esp32s3/esp_rom_caps.h

@@ -16,3 +16,4 @@
 #define ESP_ROM_HAS_ERASE_0_REGION_BUG      (1) // ROM has esp_flash_erase_region(size=0) bug
 #define ESP_ROM_GET_CLK_FREQ                (1) // Get clk frequency with rom function `ets_get_cpu_frequency`
 #define ESP_ROM_HAS_HAL_WDT                 (1) // ROM has the implementation of Watchdog HAL driver
+#define ESP_ROM_NEEDS_SWSETUP_WORKAROUND    (1) // ROM uses 32-bit time_t. A workaround is required to prevent printf functions from crashing

components/esp_system/startup.c

@@ -65,6 +65,7 @@
 #include "esp_private/spi_flash_os.h"
 #include "esp_private/brownout.h"
 
+#include "esp_rom_caps.h"
 #include "esp_rom_sys.h"
 
 #if CONFIG_SPIRAM
@@ -306,6 +307,20 @@ static void do_core_init(void)
     _GLOBAL_REENT->_stdin  = fopen(default_stdio_dev, "r");
     _GLOBAL_REENT->_stdout = fopen(default_stdio_dev, "w");
     _GLOBAL_REENT->_stderr = fopen(default_stdio_dev, "w");
+#if ESP_ROM_NEEDS_SWSETUP_WORKAROUND
+    /*
+    - This workaround for printf functions using 32-bit time_t after the 64-bit time_t upgrade
+    - The 32-bit time_t usage is triggered through ROM Newlib functions printf related functions calling __swsetup_r() on
+      the first call to a particular file pointer (i.e., stdin, stdout, stderr)
+    - Thus, we call the toolchain version of __swsetup_r() now (before any printf calls are made) to setup all of the
+      file pointers. Thus, the ROM newlib code will never call the ROM version of __swsetup_r().
+    - See IDFGH-7728 for more details
+    */
+    extern int __swsetup_r(struct _reent *, FILE *);
+    __swsetup_r(_GLOBAL_REENT, _GLOBAL_REENT->_stdout);
+    __swsetup_r(_GLOBAL_REENT, _GLOBAL_REENT->_stderr);
+    __swsetup_r(_GLOBAL_REENT, _GLOBAL_REENT->_stdin);
+#endif // ESP_ROM_NEEDS_SWSETUP_WORKAROUND
 #else // defined(CONFIG_VFS_SUPPORT_IO) && !defined(CONFIG_ESP_CONSOLE_NONE)
     _REENT_SMALL_CHECK_INIT(_GLOBAL_REENT);
 #endif // defined(CONFIG_VFS_SUPPORT_IO) && !defined(CONFIG_ESP_CONSOLE_NONE)

tools/ci/check_copyright_ignore.txt

@@ -471,7 +471,6 @@ components/esp_pm/include/esp_private/pm_impl.h
 components/esp_pm/include/esp_private/pm_trace.h
 components/esp_pm/pm_locks.c
 components/esp_pm/test/test_pm.c
-components/esp_rom/esp32/esp_rom_caps.h
 components/esp_rom/esp32/ld/esp32.rom.api.ld
 components/esp_rom/esp32/ld/esp32.rom.eco3.ld
 components/esp_rom/esp32/ld/esp32.rom.ld
@@ -497,7 +496,6 @@ components/esp_rom/esp32h2/ld/esp32h2.rom.libgcc.ld
 components/esp_rom/esp32h2/ld/esp32h2.rom.newlib-nano.ld
 components/esp_rom/esp32h2/ld/esp32h2.rom.newlib.ld
 components/esp_rom/esp32h2/ld/esp32h2.rom.version.ld
-components/esp_rom/esp32s2/esp_rom_caps.h
 components/esp_rom/esp32s2/ld/esp32s2.rom.api.ld
 components/esp_rom/esp32s2/ld/esp32s2.rom.ld
 components/esp_rom/esp32s2/ld/esp32s2.rom.libgcc.ld