Espressif IoT Development Framework. Official development framework for ESP32.
Go to file
Ivan Grokhotkov 2e9c06b584 Merge branch 'bugfix/rom_int_functions' into 'master'
Fix broken WiFi due to intr allocation code.

TL;DR: The dynamic interrupt allocation code fixed something up to the point it broke. This code breaks off the broken code, fixing everything.

The dynamic allocated interrupt patch also fixed a bug in FreeRTOSs interrupt handling for two cores, which caused the two cores to (most of the time) have exactly the same interrupts enabled. This made WiFi fail: it would wait on a semaphore but never figure out the other core had set the semaphore, so it would keep waiting in the idle task for ever. This was caused by both the cross-core interrupt as well as the tick interrupt being disabled.

The culplrit for this appeared to be the WiFi driver, which enabled a FRC2 interrupt. The code enabling this, through a respectable amount of defines, called a rom function which called a HAL function... which was configured in such a way that it worked okay if both CPUs happened to have the same interrupts set, but broke as soon as that was not the case, possibly setting only the interrupt that was enabled and clearing all others.

The fix for this is to not use the ROM functions, but provide our own instead. Fortunately, this can be done without changes in the WiFi libs.

This MR also addresses a potentially dangerous ESP_LOG as well as some, according to the ISA document, needed rsyncs in the interrupt enable/disable code. It also marks int 9 and 10 as reserved, the WiFi code seems to use this.

See merge request !308
2016-12-13 14:16:57 +08:00
components Put ets_isr_* functions into IRAM. Original fns were in ROM so people may expect them to work when flash cache is out. 2016-12-13 13:24:01 +08:00
docs Merge branch 'feature/esptool_flash_encryption' into 'master' 2016-12-12 06:50:46 +08:00
examples Merge branch 'feature/intr_alloc' into 'master' 2016-12-09 14:00:39 +08:00
make Merge branch 'feature/make_size' into 'master' 2016-12-13 07:25:35 +08:00
tools Merge branch 'feature/intr_alloc' into 'master' 2016-12-09 14:00:39 +08:00
.gitignore add unit tests to esp-idf 2016-11-22 14:45:50 +08:00
.gitlab-ci.yml remove not used code as rm -rf always return 0 2016-12-12 09:31:06 +08:00
.gitmodules Secure boot: initial image signature support 2016-11-14 11:08:42 +11:00
add_path.sh add_path.sh: Use non-bash-specific instructions 2016-09-12 18:39:20 +10:00
CONTRIBUTING.rst docs: Hyperlinks to guides 2016-11-21 10:24:12 +08:00
Kconfig build system: fix setting C**FLAGS from project makefile 2016-10-20 17:17:54 +08:00
LICENSE Initial public version 2016-08-17 23:08:22 +08:00
README.md Back to .md format 2016-11-01 01:20:04 +08:00

Using Espressif IoT Development Framework with the ESP32

alt text

Setting Up ESP-IDF

In the docs directory you will find per-platform setup guides:

Finding A Project

As well as the esp-idf-template project mentioned in the setup guide, esp-idf comes with some example projects in the examples directory.

Once you've found the project you want to work with, change to its directory and you can configure and build it:

Configuring your project

make menuconfig

Compiling your project

make all

... will compile app, bootloader and generate a partition table based on the config.

Flashing your project

When make all finishes, it will print a command line to use esptool.py to flash the chip. However you can also do this from make by running:

make flash

This will flash the entire project (app, bootloader and partition table) to a new chip. The settings for serial port flashing can be configured with make menuconfig.

You don't need to run make all before running make flash, make flash will automatically rebuild anything which needs it.

Compiling & Flashing Just the App

After the initial flash, you may just want to build and flash just your app, not the bootloader and partition table:

  • make app - build just the app.
  • make app-flash - flash just the app.

make app-flash will automatically rebuild the app if it needs it.

(There's no downside to reflashing the bootloader and partition table each time, if they haven't changed.)

The Partition Table

Once you've compiled your project, the "build" directory will contain a binary file with a name like "my_app.bin". This is an ESP32 image binary that can be loaded by the bootloader.

A single ESP32's flash can contain multiple apps, as well as many different kinds of data (calibration data, filesystems, parameter storage, etc). For this reason a partition table is flashed to offset 0x4000 in the flash.

Each entry in the partition table has a name (label), type (app, data, or something else), subtype and the offset in flash where the partition is loaded.

The simplest way to use the partition table is to make menuconfig and choose one of the simple predefined partition tables:

  • "Single factory app, no OTA"
  • "Factory app, two OTA definitions"

In both cases the factory app is flashed at offset 0x10000. If you make partition_table then it will print a summary of the partition table.

For more details about partition tables and how to create custom variations, view the docs/partition-tables.rst file.

Resources