]> granicus.if.org Git - esp-idf/blob - components/esp32/cpu_start.c
Add option to allocate external RAM using heap_alloc_caps
[esp-idf] / 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.h"
68 #include "esp_timer.h"
69 #include "trax.h"
70
71 #define STRINGIFY(s) STRINGIFY2(s)
72 #define STRINGIFY2(s) #s
73
74 void start_cpu0(void) __attribute__((weak, alias("start_cpu0_default"))) __attribute__((noreturn));
75 void start_cpu0_default(void) IRAM_ATTR __attribute__((noreturn));
76 #if !CONFIG_FREERTOS_UNICORE
77 static void IRAM_ATTR call_start_cpu1() __attribute__((noreturn));
78 void start_cpu1(void) __attribute__((weak, alias("start_cpu1_default"))) __attribute__((noreturn));
79 void start_cpu1_default(void) IRAM_ATTR __attribute__((noreturn));
80 static bool app_cpu_started = false;
81 #endif //!CONFIG_FREERTOS_UNICORE
82
83 static void do_global_ctors(void);
84 static void main_task(void* args);
85 extern void app_main(void);
86 extern esp_err_t esp_pthread_init(void);
87
88 extern int _bss_start;
89 extern int _bss_end;
90 extern int _rtc_bss_start;
91 extern int _rtc_bss_end;
92 extern int _init_start;
93 extern void (*__init_array_start)(void);
94 extern void (*__init_array_end)(void);
95 extern volatile int port_xSchedulerRunning[2];
96
97 static const char* TAG = "cpu_start";
98
99 struct object { long placeholder[ 10 ]; };
100 void __register_frame_info (const void *begin, struct object *ob);
101 extern char __eh_frame[];
102
103 /*
104  * We arrive here after the bootloader finished loading the program from flash. The hardware is mostly uninitialized,
105  * and the app CPU is in reset. We do have a stack, so we can do the initialization in C.
106  */
107
108 void IRAM_ATTR call_start_cpu0()
109 {
110 #if CONFIG_FREERTOS_UNICORE
111     RESET_REASON rst_reas[1];
112 #else
113     RESET_REASON rst_reas[2];
114 #endif
115     cpu_configure_region_protection();
116
117     //Move exception vectors to IRAM
118     asm volatile (\
119                   "wsr    %0, vecbase\n" \
120                   ::"r"(&_init_start));
121
122     rst_reas[0] = rtc_get_reset_reason(0);
123
124 #if !CONFIG_FREERTOS_UNICORE
125     rst_reas[1] = rtc_get_reset_reason(1);
126 #endif
127
128     // from panic handler we can be reset by RWDT or TG0WDT
129     if (rst_reas[0] == RTCWDT_SYS_RESET || rst_reas[0] == TG0WDT_SYS_RESET
130 #if !CONFIG_FREERTOS_UNICORE
131         || rst_reas[1] == RTCWDT_SYS_RESET || rst_reas[1] == TG0WDT_SYS_RESET
132 #endif
133     ) {
134         esp_panic_wdt_stop();
135     }
136
137     // Temporary workaround for an ugly crash, until we allow > 192KB of static DRAM
138     if ((intptr_t)&_bss_end > 0x3FFE0000) {
139         // Can't use assert() or logging here because there's no .bss
140         ets_printf("ERROR: Static .bss section extends past 0x3FFE0000. IDF cannot boot.\n");
141         abort();
142     }
143
144     //Clear BSS. Please do not attempt to do any complex stuff (like early logging) before this.
145     memset(&_bss_start, 0, (&_bss_end - &_bss_start) * sizeof(_bss_start));
146
147     /* Unless waking from deep sleep (implying RTC memory is intact), clear RTC bss */
148     if (rst_reas[0] != DEEPSLEEP_RESET) {
149         memset(&_rtc_bss_start, 0, (&_rtc_bss_end - &_rtc_bss_start) * sizeof(_rtc_bss_start));
150     }
151
152 #if CONFIG_SPIRAM_BOOT_INIT
153     if (esp_spiram_init() != ESP_OK) {
154         ESP_EARLY_LOGE(TAG, "Failed to init external RAM!");
155         abort();
156     }
157 #endif
158
159     ESP_EARLY_LOGI(TAG, "Pro cpu up.");
160
161 #if !CONFIG_FREERTOS_UNICORE
162     ESP_EARLY_LOGI(TAG, "Starting app cpu, entry point is %p", call_start_cpu1);
163     //Flush and enable icache for APP CPU
164     Cache_Flush(1);
165     Cache_Read_Enable(1);
166     esp_cpu_unstall(1);
167     // Enable clock and reset APP CPU. Note that OpenOCD may have already
168     // enabled clock and taken APP CPU out of reset. In this case don't reset
169     // APP CPU again, as that will clear the breakpoints which may have already
170     // been set.
171     if (!DPORT_GET_PERI_REG_MASK(DPORT_APPCPU_CTRL_B_REG, DPORT_APPCPU_CLKGATE_EN)) {
172         DPORT_SET_PERI_REG_MASK(DPORT_APPCPU_CTRL_B_REG, DPORT_APPCPU_CLKGATE_EN);
173         DPORT_CLEAR_PERI_REG_MASK(DPORT_APPCPU_CTRL_C_REG, DPORT_APPCPU_RUNSTALL);
174         DPORT_SET_PERI_REG_MASK(DPORT_APPCPU_CTRL_A_REG, DPORT_APPCPU_RESETTING);
175         DPORT_CLEAR_PERI_REG_MASK(DPORT_APPCPU_CTRL_A_REG, DPORT_APPCPU_RESETTING);
176     }
177     ets_set_appcpu_boot_addr((uint32_t)call_start_cpu1);
178
179     while (!app_cpu_started) {
180         ets_delay_us(100);
181     }
182 #else
183     ESP_EARLY_LOGI(TAG, "Single core mode");
184     DPORT_CLEAR_PERI_REG_MASK(DPORT_APPCPU_CTRL_B_REG, DPORT_APPCPU_CLKGATE_EN);
185 #endif
186
187
188 #if CONFIG_SPIRAM_MEMTEST
189     bool ext_ram_ok=esp_spiram_test();
190     if (!ext_ram_ok) {
191         ESP_EARLY_LOGE(TAG, "External RAM failed memory test!");
192         abort();
193     }
194 #endif
195
196     /* Initialize heap allocator. WARNING: This *needs* to happen *after* the app cpu has booted.
197        If the heap allocator is initialized first, it will put free memory linked list items into
198        memory also used by the ROM. Starting the app cpu will let its ROM initialize that memory,
199        corrupting those linked lists. Initializing the allocator *after* the app cpu has booted
200        works around this problem.
201        With SPI RAM enabled, there's a second reason: half of the SPI RAM will be managed by the
202        app CPU, and when that is not up yet, the memory will be inaccessible and heap_caps_init may
203        fail initializing it properly. */
204     heap_caps_init();
205
206     ESP_EARLY_LOGI(TAG, "Pro cpu start user code");
207     start_cpu0();
208 }
209
210 #if !CONFIG_FREERTOS_UNICORE
211
212 static void wdt_reset_cpu1_info_enable(void)
213 {
214     DPORT_REG_SET_BIT(DPORT_APP_CPU_RECORD_CTRL_REG, DPORT_APP_CPU_PDEBUG_ENABLE | DPORT_APP_CPU_RECORD_ENABLE);
215     DPORT_REG_CLR_BIT(DPORT_APP_CPU_RECORD_CTRL_REG, DPORT_APP_CPU_RECORD_ENABLE);
216 }
217
218 void IRAM_ATTR call_start_cpu1()
219 {
220     asm volatile (\
221                   "wsr    %0, vecbase\n" \
222                   ::"r"(&_init_start));
223
224     ets_set_appcpu_boot_addr(0);
225     cpu_configure_region_protection();
226
227 #if CONFIG_CONSOLE_UART_NONE
228     ets_install_putc1(NULL);
229     ets_install_putc2(NULL);
230 #else // CONFIG_CONSOLE_UART_NONE
231     uartAttach();
232     ets_install_uart_printf();
233     uart_tx_switch(CONFIG_CONSOLE_UART_NUM);
234 #endif
235
236     wdt_reset_cpu1_info_enable();
237     ESP_EARLY_LOGI(TAG, "App cpu up.");
238     app_cpu_started = 1;
239     start_cpu1();
240 }
241 #endif //!CONFIG_FREERTOS_UNICORE
242
243 static void intr_matrix_clear(void)
244 {
245     //Clear all the interrupt matrix register
246     for (int i = ETS_WIFI_MAC_INTR_SOURCE; i <= ETS_CACHE_IA_INTR_SOURCE; i++) {
247         intr_matrix_set(0, i, ETS_INVALID_INUM);
248 #if !CONFIG_FREERTOS_UNICORE
249         intr_matrix_set(1, i, ETS_INVALID_INUM);
250 #endif
251     }
252 }
253
254 void start_cpu0_default(void)
255 {
256     esp_err_t err;
257     esp_setup_syscall_table();
258
259 #if CONFIG_SPIRAM_BOOT_INIT && (CONFIG_SPIRAM_USE_CAPS_ALLOC || CONFIG_SPIRAM_USE_MALLOC)
260     esp_err_t r=esp_spiram_add_to_heapalloc();
261     if (r != ESP_OK) {
262         ESP_EARLY_LOGE(TAG, "External RAM could not be added to heap!");
263         abort();
264     }
265 #endif
266
267 //Enable trace memory and immediately start trace.
268 #if CONFIG_ESP32_TRAX
269 #if CONFIG_ESP32_TRAX_TWOBANKS
270     trax_enable(TRAX_ENA_PRO_APP);
271 #else
272     trax_enable(TRAX_ENA_PRO);
273 #endif
274     trax_start_trace(TRAX_DOWNCOUNT_WORDS);
275 #endif
276     esp_clk_init();
277     esp_perip_clk_init();
278     intr_matrix_clear();
279 #ifndef CONFIG_CONSOLE_UART_NONE
280     uart_div_modify(CONFIG_CONSOLE_UART_NUM, (rtc_clk_apb_freq_get() << 4) / CONFIG_CONSOLE_UART_BAUDRATE);
281 #endif
282 #if CONFIG_BROWNOUT_DET
283     esp_brownout_init();
284 #endif
285 #if CONFIG_DISABLE_BASIC_ROM_CONSOLE
286     esp_efuse_disable_basic_rom_console();
287 #endif
288     rtc_gpio_force_hold_dis_all();
289     esp_vfs_dev_uart_register();
290     esp_reent_init(_GLOBAL_REENT);
291 #ifndef CONFIG_CONSOLE_UART_NONE
292     const char* default_uart_dev = "/dev/uart/" STRINGIFY(CONFIG_CONSOLE_UART_NUM);
293     _GLOBAL_REENT->_stdin  = fopen(default_uart_dev, "r");
294     _GLOBAL_REENT->_stdout = fopen(default_uart_dev, "w");
295     _GLOBAL_REENT->_stderr = fopen(default_uart_dev, "w");
296 #else
297     _GLOBAL_REENT->_stdin  = (FILE*) &__sf_fake_stdin;
298     _GLOBAL_REENT->_stdout = (FILE*) &__sf_fake_stdout;
299     _GLOBAL_REENT->_stderr = (FILE*) &__sf_fake_stderr;
300 #endif
301     esp_timer_init();
302     esp_set_time_from_rtc();
303 #if CONFIG_ESP32_APPTRACE_ENABLE
304     err = esp_apptrace_init();
305     if (err != ESP_OK) {
306         ESP_EARLY_LOGE(TAG, "Failed to init apptrace module on CPU0 (%d)!", err);
307     }
308 #endif
309 #if CONFIG_SYSVIEW_ENABLE
310     SEGGER_SYSVIEW_Conf();
311 #endif
312     err = esp_pthread_init();
313     if (err != ESP_OK) {
314         ESP_EARLY_LOGE(TAG, "Failed to init pthread module (%d)!", err);
315     }
316
317     do_global_ctors();
318 #if CONFIG_INT_WDT
319     esp_int_wdt_init();
320 #endif
321 #if CONFIG_TASK_WDT
322     esp_task_wdt_init();
323 #endif
324     esp_cache_err_int_init();
325     esp_crosscore_int_init();
326     esp_ipc_init();
327 #ifndef CONFIG_FREERTOS_UNICORE
328     esp_dport_access_int_init();
329 #endif
330     spi_flash_init();
331     /* init default OS-aware flash access critical section */
332     spi_flash_guard_set(&g_flash_guard_default_ops);
333
334 #if CONFIG_ESP32_ENABLE_COREDUMP
335     esp_core_dump_init();
336 #endif
337
338     portBASE_TYPE res = xTaskCreatePinnedToCore(&main_task, "main",
339                                                 ESP_TASK_MAIN_STACK, NULL,
340                                                 ESP_TASK_MAIN_PRIO, NULL, 0);
341     assert(res == pdTRUE);
342     ESP_LOGI(TAG, "Starting scheduler on PRO CPU.");
343     vTaskStartScheduler();
344     abort(); /* Only get to here if not enough free heap to start scheduler */
345 }
346
347 #if !CONFIG_FREERTOS_UNICORE
348 void start_cpu1_default(void)
349 {
350 #if CONFIG_ESP32_TRAX_TWOBANKS
351     trax_start_trace(TRAX_DOWNCOUNT_WORDS);
352 #endif
353 #if CONFIG_ESP32_APPTRACE_ENABLE
354     esp_err_t err = esp_apptrace_init();
355     if (err != ESP_OK) {
356         ESP_EARLY_LOGE(TAG, "Failed to init apptrace module on CPU1 (%d)!", err);
357     }
358 #endif
359     // Wait for FreeRTOS initialization to finish on PRO CPU
360     while (port_xSchedulerRunning[0] == 0) {
361         ;
362     }
363     //Take care putting stuff here: if asked, FreeRTOS will happily tell you the scheduler
364     //has started, but it isn't active *on this CPU* yet.
365     esp_cache_err_int_init();
366     esp_crosscore_int_init();
367     esp_dport_access_int_init();
368
369     ESP_EARLY_LOGI(TAG, "Starting scheduler on APP CPU.");
370     xPortStartScheduler();
371     abort(); /* Only get to here if FreeRTOS somehow very broken */
372 }
373 #endif //!CONFIG_FREERTOS_UNICORE
374
375 static void do_global_ctors(void)
376 {
377     static struct object ob;
378     __register_frame_info( __eh_frame, &ob );
379
380     void (**p)(void);
381     for (p = &__init_array_end - 1; p >= &__init_array_start; --p) {
382         (*p)();
383     }
384 }
385
386 static void main_task(void* args)
387 {
388     // Now that the application is about to start, disable boot watchdogs
389     REG_CLR_BIT(TIMG_WDTCONFIG0_REG(0), TIMG_WDT_FLASHBOOT_MOD_EN_S);
390     REG_CLR_BIT(RTC_CNTL_WDTCONFIG0_REG, RTC_CNTL_WDT_FLASHBOOT_MOD_EN);
391 #if !CONFIG_FREERTOS_UNICORE
392     // Wait for FreeRTOS initialization to finish on APP CPU, before replacing its startup stack
393     while (port_xSchedulerRunning[1] == 0) {
394         ;
395     }
396 #endif
397     //Enable allocation in region where the startup stacks were located.
398     heap_caps_enable_nonos_stack_heaps();
399     app_main();
400     vTaskDelete(NULL);
401 }
402