granicus.if.org Git - esp-idf/blob - components/esp32/cpu_start.c

   1 // Copyright 2015-2017 Espressif Systems (Shanghai) PTE LTD
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 #include <stdint.h>
  16 #include <string.h>
  17
  18 #include "esp_attr.h"
  19 #include "esp_err.h"
  20
  21 #include "rom/ets_sys.h"
  22 #include "rom/uart.h"
  23 #include "rom/rtc.h"
  24 #include "rom/cache.h"
  25
  26 #include "soc/cpu.h"
  27 #include "soc/rtc.h"
  28 #include "soc/dport_reg.h"
  29 #include "soc/io_mux_reg.h"
  30 #include "soc/rtc_cntl_reg.h"
  31 #include "soc/timer_group_reg.h"
  32
  33 #include "driver/rtc_io.h"
  34
  35 #include "freertos/FreeRTOS.h"
  36 #include "freertos/task.h"
  37 #include "freertos/semphr.h"
  38 #include "freertos/queue.h"
  39 #include "freertos/portmacro.h"
  40
  41 #include "tcpip_adapter.h"
  42
  43 #include "esp_heap_caps_init.h"
  44 #include "sdkconfig.h"
  45 #include "esp_system.h"
  46 #include "esp_spi_flash.h"
  47 #include "nvs_flash.h"
  48 #include "esp_event.h"
  49 #include "esp_spi_flash.h"
  50 #include "esp_ipc.h"
  51 #include "esp_crosscore_int.h"
  52 #include "esp_dport_access.h"
  53 #include "esp_log.h"
  54 #include "esp_vfs_dev.h"
  55 #include "esp_newlib.h"
  56 #include "esp_brownout.h"
  57 #include "esp_int_wdt.h"
  58 #include "esp_task_wdt.h"
  59 #include "esp_phy_init.h"
  60 #include "esp_cache_err_int.h"
  61 #include "esp_coexist.h"
  62 #include "esp_panic.h"
  63 #include "esp_core_dump.h"
  64 #include "esp_app_trace.h"
  65 #include "esp_efuse.h"
  66 #include "esp_spiram.h"
  67 #include "esp_clk_internal.h"
  68 #include "esp_timer.h"
  69 #include "esp_pm.h"
  70 #include "pm_impl.h"
  71 #include "trax.h"
  72
  73 #define STRINGIFY(s) STRINGIFY2(s)
  74 #define STRINGIFY2(s) #s
  75
  76 void start_cpu0(void) __attribute__((weak, alias("start_cpu0_default"))) __attribute__((noreturn));
  77 void start_cpu0_default(void) IRAM_ATTR __attribute__((noreturn));
  78 #if !CONFIG_FREERTOS_UNICORE
  79 static void IRAM_ATTR call_start_cpu1() __attribute__((noreturn));
  80 void start_cpu1(void) __attribute__((weak, alias("start_cpu1_default"))) __attribute__((noreturn));
  81 void start_cpu1_default(void) IRAM_ATTR __attribute__((noreturn));
  82 static bool app_cpu_started = false;
  83 #endif //!CONFIG_FREERTOS_UNICORE
  84
  85 static void do_global_ctors(void);
  86 static void main_task(void* args);
  87 extern void app_main(void);
  88 extern esp_err_t esp_pthread_init(void);
  89
  90 extern int _bss_start;
  91 extern int _bss_end;
  92 extern int _rtc_bss_start;
  93 extern int _rtc_bss_end;
  94 extern int _init_start;
  95 extern void (*__init_array_start)(void);
  96 extern void (*__init_array_end)(void);
  97 extern volatile int port_xSchedulerRunning[2];
  98
  99 static const char* TAG = "cpu_start";
 100
 101 struct object { long placeholder[ 10 ]; };
 102 void __register_frame_info (const void *begin, struct object *ob);
 103 extern char __eh_frame[];
 104
 105 /*
 106  * We arrive here after the bootloader finished loading the program from flash. The hardware is mostly uninitialized,
 107  * and the app CPU is in reset. We do have a stack, so we can do the initialization in C.
 108  */
 109
 110 void IRAM_ATTR call_start_cpu0()
 111 {
 112 #if CONFIG_FREERTOS_UNICORE
 113     RESET_REASON rst_reas[1];
 114 #else
 115     RESET_REASON rst_reas[2];
 116 #endif
 117     cpu_configure_region_protection();
 118
 119     //Move exception vectors to IRAM
 120     asm volatile (\
 121                   "wsr    %0, vecbase\n" \
 122                   ::"r"(&_init_start));
 123
 124     rst_reas[0] = rtc_get_reset_reason(0);
 125
 126 #if !CONFIG_FREERTOS_UNICORE
 127     rst_reas[1] = rtc_get_reset_reason(1);
 128 #endif
 129
 130     // from panic handler we can be reset by RWDT or TG0WDT
 131     if (rst_reas[0] == RTCWDT_SYS_RESET || rst_reas[0] == TG0WDT_SYS_RESET
 132 #if !CONFIG_FREERTOS_UNICORE
 133         || rst_reas[1] == RTCWDT_SYS_RESET || rst_reas[1] == TG0WDT_SYS_RESET
 134 #endif
 135     ) {
 136         esp_panic_wdt_stop();
 137     }
 138
 139     // Temporary workaround for an ugly crash, until we allow > 192KB of static DRAM
 140     if ((intptr_t)&_bss_end > 0x3FFE0000) {
 141         // Can't use assert() or logging here because there's no .bss
 142         ets_printf("ERROR: Static .bss section extends past 0x3FFE0000. IDF cannot boot.\n");
 143         abort();
 144     }
 145
 146     //Clear BSS. Please do not attempt to do any complex stuff (like early logging) before this.
 147     memset(&_bss_start, 0, (&_bss_end - &_bss_start) * sizeof(_bss_start));
 148
 149     /* Unless waking from deep sleep (implying RTC memory is intact), clear RTC bss */
 150     if (rst_reas[0] != DEEPSLEEP_RESET) {
 151         memset(&_rtc_bss_start, 0, (&_rtc_bss_end - &_rtc_bss_start) * sizeof(_rtc_bss_start));
 152     }
 153
 154 #if CONFIG_SPIRAM_BOOT_INIT
 155     esp_spiram_init_cache();
 156     if (esp_spiram_init() != ESP_OK) {
 157         ESP_EARLY_LOGE(TAG, "Failed to init external RAM!");
 158         abort();
 159     }
 160 #endif
 161
 162     ESP_EARLY_LOGI(TAG, "Pro cpu up.");
 163
 164 #if !CONFIG_FREERTOS_UNICORE
 165     ESP_EARLY_LOGI(TAG, "Starting app cpu, entry point is %p", call_start_cpu1);
 166     //Flush and enable icache for APP CPU
 167     Cache_Flush(1);
 168     Cache_Read_Enable(1);
 169     esp_cpu_unstall(1);
 170     // Enable clock and reset APP CPU. Note that OpenOCD may have already
 171     // enabled clock and taken APP CPU out of reset. In this case don't reset
 172     // APP CPU again, as that will clear the breakpoints which may have already
 173     // been set.
 174     if (!DPORT_GET_PERI_REG_MASK(DPORT_APPCPU_CTRL_B_REG, DPORT_APPCPU_CLKGATE_EN)) {
 175         DPORT_SET_PERI_REG_MASK(DPORT_APPCPU_CTRL_B_REG, DPORT_APPCPU_CLKGATE_EN);
 176         DPORT_CLEAR_PERI_REG_MASK(DPORT_APPCPU_CTRL_C_REG, DPORT_APPCPU_RUNSTALL);
 177         DPORT_SET_PERI_REG_MASK(DPORT_APPCPU_CTRL_A_REG, DPORT_APPCPU_RESETTING);
 178         DPORT_CLEAR_PERI_REG_MASK(DPORT_APPCPU_CTRL_A_REG, DPORT_APPCPU_RESETTING);
 179     }
 180     ets_set_appcpu_boot_addr((uint32_t)call_start_cpu1);
 181
 182     while (!app_cpu_started) {
 183         ets_delay_us(100);
 184     }
 185 #else
 186     ESP_EARLY_LOGI(TAG, "Single core mode");
 187     DPORT_CLEAR_PERI_REG_MASK(DPORT_APPCPU_CTRL_B_REG, DPORT_APPCPU_CLKGATE_EN);
 188 #endif
 189
 190
 191 #if CONFIG_SPIRAM_MEMTEST
 192     bool ext_ram_ok=esp_spiram_test();
 193     if (!ext_ram_ok) {
 194         ESP_EARLY_LOGE(TAG, "External RAM failed memory test!");
 195         abort();
 196     }
 197 #endif
 198
 199     /* Initialize heap allocator. WARNING: This *needs* to happen *after* the app cpu has booted.
 200        If the heap allocator is initialized first, it will put free memory linked list items into
 201        memory also used by the ROM. Starting the app cpu will let its ROM initialize that memory,
 202        corrupting those linked lists. Initializing the allocator *after* the app cpu has booted
 203        works around this problem.
 204        With SPI RAM enabled, there's a second reason: half of the SPI RAM will be managed by the
 205        app CPU, and when that is not up yet, the memory will be inaccessible and heap_caps_init may
 206        fail initializing it properly. */
 207     heap_caps_init();
 208
 209     ESP_EARLY_LOGI(TAG, "Pro cpu start user code");
 210     start_cpu0();
 211 }
 212
 213 #if !CONFIG_FREERTOS_UNICORE
 214
 215 static void wdt_reset_cpu1_info_enable(void)
 216 {
 217     DPORT_REG_SET_BIT(DPORT_APP_CPU_RECORD_CTRL_REG, DPORT_APP_CPU_PDEBUG_ENABLE | DPORT_APP_CPU_RECORD_ENABLE);
 218     DPORT_REG_CLR_BIT(DPORT_APP_CPU_RECORD_CTRL_REG, DPORT_APP_CPU_RECORD_ENABLE);
 219 }
 220
 221 void IRAM_ATTR call_start_cpu1()
 222 {
 223     asm volatile (\
 224                   "wsr    %0, vecbase\n" \
 225                   ::"r"(&_init_start));
 226
 227     ets_set_appcpu_boot_addr(0);
 228     cpu_configure_region_protection();
 229
 230 #if CONFIG_CONSOLE_UART_NONE
 231     ets_install_putc1(NULL);
 232     ets_install_putc2(NULL);
 233 #else // CONFIG_CONSOLE_UART_NONE
 234     uartAttach();
 235     ets_install_uart_printf();
 236     uart_tx_switch(CONFIG_CONSOLE_UART_NUM);
 237 #endif
 238
 239     wdt_reset_cpu1_info_enable();
 240     ESP_EARLY_LOGI(TAG, "App cpu up.");
 241     app_cpu_started = 1;
 242     start_cpu1();
 243 }
 244 #endif //!CONFIG_FREERTOS_UNICORE
 245
 246 static void intr_matrix_clear(void)
 247 {
 248     //Clear all the interrupt matrix register
 249     for (int i = ETS_WIFI_MAC_INTR_SOURCE; i <= ETS_CACHE_IA_INTR_SOURCE; i++) {
 250         intr_matrix_set(0, i, ETS_INVALID_INUM);
 251 #if !CONFIG_FREERTOS_UNICORE
 252         intr_matrix_set(1, i, ETS_INVALID_INUM);
 253 #endif
 254     }
 255 }
 256
 257 void start_cpu0_default(void)
 258 {
 259     esp_err_t err;
 260     esp_setup_syscall_table();
 261
 262 #if CONFIG_SPIRAM_BOOT_INIT && (CONFIG_SPIRAM_USE_CAPS_ALLOC || CONFIG_SPIRAM_USE_MALLOC)
 263     esp_err_t r=esp_spiram_add_to_heapalloc();
 264     if (r != ESP_OK) {
 265         ESP_EARLY_LOGE(TAG, "External RAM could not be added to heap!");
 266         abort();
 267     }
 268 #if CONFIG_SPIRAM_MALLOC_RESERVE_INTERNAL
 269     r=esp_spiram_reserve_dma_pool(CONFIG_SPIRAM_MALLOC_RESERVE_INTERNAL);
 270     if (r != ESP_OK) {
 271         ESP_EARLY_LOGE(TAG, "Could not reserve internal/DMA pool!");
 272         abort();
 273     }
 274 #endif
 275 #if CONFIG_SPIRAM_USE_MALLOC
 276     heap_caps_malloc_extmem_enable(CONFIG_SPIRAM_MALLOC_ALWAYSINTERNAL);
 277 #endif
 278 #endif
 279
 280 //Enable trace memory and immediately start trace.
 281 #if CONFIG_ESP32_TRAX
 282 #if CONFIG_ESP32_TRAX_TWOBANKS
 283     trax_enable(TRAX_ENA_PRO_APP);
 284 #else
 285     trax_enable(TRAX_ENA_PRO);
 286 #endif
 287     trax_start_trace(TRAX_DOWNCOUNT_WORDS);
 288 #endif
 289     esp_clk_init();
 290     esp_perip_clk_init();
 291     intr_matrix_clear();
 292
 293 #ifndef CONFIG_CONSOLE_UART_NONE
 294 #ifdef CONFIG_PM_ENABLE
 295     const int uart_clk_freq = REF_CLK_FREQ;
 296     /* When DFS is enabled, use REFTICK as UART clock source */
 297     CLEAR_PERI_REG_MASK(UART_CONF0_REG(CONFIG_CONSOLE_UART_NUM), UART_TICK_REF_ALWAYS_ON);
 298 #else
 299     const int uart_clk_freq = APB_CLK_FREQ;
 300 #endif // CONFIG_PM_DFS_ENABLE
 301     uart_div_modify(CONFIG_CONSOLE_UART_NUM, (uart_clk_freq << 4) / CONFIG_CONSOLE_UART_BAUDRATE);
 302 #endif // CONFIG_CONSOLE_UART_NONE
 303
 304 #if CONFIG_BROWNOUT_DET
 305     esp_brownout_init();
 306 #endif
 307 #if CONFIG_DISABLE_BASIC_ROM_CONSOLE
 308     esp_efuse_disable_basic_rom_console();
 309 #endif
 310     rtc_gpio_force_hold_dis_all();
 311     esp_vfs_dev_uart_register();
 312     esp_reent_init(_GLOBAL_REENT);
 313 #ifndef CONFIG_CONSOLE_UART_NONE
 314     const char* default_uart_dev = "/dev/uart/" STRINGIFY(CONFIG_CONSOLE_UART_NUM);
 315     _GLOBAL_REENT->_stdin  = fopen(default_uart_dev, "r");
 316     _GLOBAL_REENT->_stdout = fopen(default_uart_dev, "w");
 317     _GLOBAL_REENT->_stderr = fopen(default_uart_dev, "w");
 318 #else
 319     _GLOBAL_REENT->_stdin  = (FILE*) &__sf_fake_stdin;
 320     _GLOBAL_REENT->_stdout = (FILE*) &__sf_fake_stdout;
 321     _GLOBAL_REENT->_stderr = (FILE*) &__sf_fake_stderr;
 322 #endif
 323     esp_timer_init();
 324     esp_set_time_from_rtc();
 325 #if CONFIG_ESP32_APPTRACE_ENABLE
 326     err = esp_apptrace_init();
 327     assert(err == ESP_OK && "Failed to init apptrace module on PRO CPU!");
 328 #endif
 329 #if CONFIG_SYSVIEW_ENABLE
 330     SEGGER_SYSVIEW_Conf();
 331 #endif
 332     err = esp_pthread_init();
 333     assert(err == ESP_OK && "Failed to init pthread module!");
 334
 335     do_global_ctors();
 336 #if CONFIG_INT_WDT
 337     esp_int_wdt_init();
 338 #endif
 339 #if CONFIG_TASK_WDT
 340     esp_task_wdt_init();
 341 #endif
 342     esp_cache_err_int_init();
 343     esp_crosscore_int_init();
 344     esp_ipc_init();
 345 #ifndef CONFIG_FREERTOS_UNICORE
 346     esp_dport_access_int_init();
 347 #endif
 348     spi_flash_init();
 349     /* init default OS-aware flash access critical section */
 350     spi_flash_guard_set(&g_flash_guard_default_ops);
 351 #ifdef CONFIG_PM_ENABLE
 352     esp_pm_impl_init();
 353 #ifdef CONFIG_PM_DFS_INIT_AUTO
 354     rtc_cpu_freq_t max_freq;
 355     rtc_clk_cpu_freq_from_mhz(CONFIG_ESP32_DEFAULT_CPU_FREQ_MHZ, &max_freq);
 356     esp_pm_config_esp32_t cfg = {
 357             .max_cpu_freq = max_freq,
 358             .min_cpu_freq = RTC_CPU_FREQ_XTAL
 359     };
 360     esp_pm_configure(&cfg);
 361 #endif //CONFIG_PM_DFS_INIT_AUTO
 362 #endif //CONFIG_PM_ENABLE
 363
 364 #if CONFIG_ESP32_ENABLE_COREDUMP
 365     esp_core_dump_init();
 366 #endif
 367
 368     portBASE_TYPE res = xTaskCreatePinnedToCore(&main_task, "main",
 369                                                 ESP_TASK_MAIN_STACK, NULL,
 370                                                 ESP_TASK_MAIN_PRIO, NULL, 0);
 371     assert(res == pdTRUE);
 372     ESP_LOGI(TAG, "Starting scheduler on PRO CPU.");
 373     vTaskStartScheduler();
 374     abort(); /* Only get to here if not enough free heap to start scheduler */
 375 }
 376
 377 #if !CONFIG_FREERTOS_UNICORE
 378 void start_cpu1_default(void)
 379 {
 380     // Wait for FreeRTOS initialization to finish on PRO CPU
 381     while (port_xSchedulerRunning[0] == 0) {
 382         ;
 383     }
 384 #if CONFIG_ESP32_TRAX_TWOBANKS
 385     trax_start_trace(TRAX_DOWNCOUNT_WORDS);
 386 #endif
 387 #if CONFIG_ESP32_APPTRACE_ENABLE
 388     esp_err_t err = esp_apptrace_init();
 389     assert(err == ESP_OK && "Failed to init apptrace module on APP CPU!");
 390 #endif
 391     //Take care putting stuff here: if asked, FreeRTOS will happily tell you the scheduler
 392     //has started, but it isn't active *on this CPU* yet.
 393     esp_cache_err_int_init();
 394     esp_crosscore_int_init();
 395     esp_dport_access_int_init();
 396
 397     ESP_EARLY_LOGI(TAG, "Starting scheduler on APP CPU.");
 398     xPortStartScheduler();
 399     abort(); /* Only get to here if FreeRTOS somehow very broken */
 400 }
 401 #endif //!CONFIG_FREERTOS_UNICORE
 402
 403 static void do_global_ctors(void)
 404 {
 405 #ifdef CONFIG_CXX_EXCEPTIONS
 406     static struct object ob;
 407     __register_frame_info( __eh_frame, &ob );
 408 #endif
 409
 410     void (**p)(void);
 411     for (p = &__init_array_end - 1; p >= &__init_array_start; --p) {
 412         (*p)();
 413     }
 414 }
 415
 416 static void main_task(void* args)
 417 {
 418     // Now that the application is about to start, disable boot watchdogs
 419     REG_CLR_BIT(TIMG_WDTCONFIG0_REG(0), TIMG_WDT_FLASHBOOT_MOD_EN_S);
 420     REG_CLR_BIT(RTC_CNTL_WDTCONFIG0_REG, RTC_CNTL_WDT_FLASHBOOT_MOD_EN);
 421 #if !CONFIG_FREERTOS_UNICORE
 422     // Wait for FreeRTOS initialization to finish on APP CPU, before replacing its startup stack
 423     while (port_xSchedulerRunning[1] == 0) {
 424         ;
 425     }
 426 #endif
 427     //Enable allocation in region where the startup stacks were located.
 428     heap_caps_enable_nonos_stack_heaps();
 429     app_main();
 430     vTaskDelete(NULL);
 431 }
 432