add documentation about boot messages and mode meaning

blackketter · Nov 14, 2015 · 9db6504 · 9db6504
1 parent 5c7b407
commit 9db6504
Showing 1 changed file with 49 additions and 0 deletions.
diff --git a/doc/boards.md b/doc/boards.md
@@ -162,3 +162,52 @@ ESPxx Hardware
 
 ### Improved Stability
 ![ESP improved stability](ESP_improved_stability.png)
+
+### Boot Messages and Modes
+
+The ESP module checks at every boot the Pins 0, 2 and 15.
+based on them its boots in different modes:
+
+| GPIO15 | GPIO0 | GPIO2 | Mode                             |
+| ------ | ----- | ----- | -------------------------------- |
+| 0V     | 0V    | 3.3V  | Uart Bootloader                  |
+| 0V     | 3.3V  | 3.3V  | Boot sketch (SPI flash)          |
+| 3.3V   | x     | x     | SDIO mode (not used for Arduino) |
+
+
+at startup the ESP prints out the current boot mode example:
+```
+rst cause:2, boot mode:(3,6)
+```
+
+#### rst cause
+
+| Number | Description            |
+| ------ | ---------------------- |
+| 0      | unknown                |
+| 1      | normal boot            |
+| 2      | reset pin              |
+| 3      | software reset         |
+| 4      | watchdog reset         | 
+
+
+#### boot mode
+
+the first value respects the pin setup of the Pins 0, 2 and 15.
+
+| Number | GPIO15 | GPIO0 | GPIO2 | Mode       |
+| ------ | ------ | ----- | ----- | ---------- |
+| 0      | 0V     | 0V    | 0V    | Not valid  |
+| 1      | 0V     | 0V    | 3.3V  | Uart       |
+| 2      | 0V     | 3.3V  | 0V    | Not valid  |
+| 3      | 0V     | 3.3V  | 3.3V  | Flash      |
+| 4      | 3.3V   | 0V    | 0V    | SDIO       |
+| 5      | 3.3V   | 0V    | 3.3V  | SDIO       |
+| 6      | 3.3V   | 3.3V  | 0V    | SDIO       |
+| 7      | 3.3V   | 3.3V  | 3.3V  | SDIO       |
+
+Note:
+
+number = ((GPIO15 << 2) | (GPIO0 << 1) | GPIO2);
+
+