From 573876700b64d82e7a4dedb60d5b97f618ecfc39 Mon Sep 17 00:00:00 2001 From: XuanZe <119524428@qq.com> Date: Wed, 7 Mar 2018 15:46:38 +0800 Subject: [PATCH 1/6] fix : esp_partition_find missing `` `` Signed-off-by: krzychb --- components/spi_flash/README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/spi_flash/README.rst b/components/spi_flash/README.rst index ef4015049..ef4cb1f82 100644 --- a/components/spi_flash/README.rst +++ b/components/spi_flash/README.rst @@ -121,7 +121,7 @@ and perform operations on them. These functions are declared in ``esp_partition. - :cpp:func:`esp_partition_next` advances iterator to the next partition found - :cpp:func:`esp_partition_iterator_release` releases iterator returned by ``esp_partition_find`` - :cpp:func:`esp_partition_find_first` is a convenience function which returns structure - describing the first partition found by esp_partition_find + describing the first partition found by ``esp_partition_find`` - :cpp:func:`esp_partition_read`, :cpp:func:`esp_partition_write`, :cpp:func:`esp_partition_erase_range` are equivalent to :cpp:func:`spi_flash_read`, :cpp:func:`spi_flash_write`, :cpp:func:`spi_flash_erase_range`, but operate within partition boundaries From 53e01bfb96532e7c644bc453825308c7338c98b4 Mon Sep 17 00:00:00 2001 From: krzychb Date: Thu, 8 Mar 2018 10:03:32 +0100 Subject: [PATCH 2/6] Added missing link to sdkconfig --- docs/api-reference/storage/spi_flash.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-reference/storage/spi_flash.rst b/docs/api-reference/storage/spi_flash.rst index e95d93883..655e9a07d 100644 --- a/docs/api-reference/storage/spi_flash.rst +++ b/docs/api-reference/storage/spi_flash.rst @@ -40,7 +40,7 @@ CPU A as well and returns control to the calling code. Additionally, all API functions are protected with a mutex (s_flash_op_mutex). -In a single core environment (CONFIG_FREERTOS_UNICORE enabled), we simply +In a single core environment (:ref:`CONFIG_FREERTOS_UNICORE` enabled), we simply disable both caches, no inter-CPU communication takes place. API Reference - SPI Flash From 691b2ad8f3c2310b2f899b6aea8c7ff48f473f6f Mon Sep 17 00:00:00 2001 From: krzychb Date: Thu, 8 Mar 2018 10:34:55 +0100 Subject: [PATCH 3/6] Added / corrected README files for the SPI master / slave examples under peripherals --- examples/peripherals/spi_master/README.md | 5 +++++ examples/peripherals/spi_slave/README.md | 25 ++++++++--------------- 2 files changed, 14 insertions(+), 16 deletions(-) create mode 100644 examples/peripherals/spi_master/README.md diff --git a/examples/peripherals/spi_master/README.md b/examples/peripherals/spi_master/README.md new file mode 100644 index 000000000..a4c624fc0 --- /dev/null +++ b/examples/peripherals/spi_master/README.md @@ -0,0 +1,5 @@ +## SPI master example + +This code displays a simple graphics with varying pixel colors on the 320x240 LCD on an ESP-WROVER-KIT board. + +If you like to adopt this example to another type of display or pinout, check [manin/spi_master_example_main.c] for comments that explain some of implementation details. diff --git a/examples/peripherals/spi_slave/README.md b/examples/peripherals/spi_slave/README.md index 3b2222e20..2983d0805 100644 --- a/examples/peripherals/spi_slave/README.md +++ b/examples/peripherals/spi_slave/README.md @@ -1,22 +1,15 @@ ## SPI slave example -These two projects illustrate the SPI Slave driver. They're supposed to be flashed into two separate ESP32s connected to -eachother using the SPI pins defined in app_main.c. Once connected and flashed, they will use the spi master and spi slave -driver to communicate with eachother. The example also includes a handshaking line to allow the master to only poll the -slave when it is actually ready to parse a transaction. +These two projects illustrate the SPI Slave driver. They're supposed to be flashed into two separate ESP32s connected to eachother using the SPI pins defined in app_main.c. Once connected and flashed, they will use the spi master and spi slave driver to communicate with eachother. The example also includes a handshaking line to allow the master to only poll the slave when it is actually ready to parse a transaction. Please run wires between the following GPIOs between the slave and master to make the example function: -========= ====== ======= -Signal Slave Master -========= ====== ======= -Handshake GPIO2 GPIO2 -MOSI GPIO12 GPIO12 -MISO GPIO13 GPIO13 -SCLK GPIO15 GPIO15 -CS GPIO14 GPIO14 -========= ====== ======= +| Signal | Slave | Master | +|-----------|--------|--------| +| Handshake | GPIO2 | GPIO2 | +| MOSI | GPIO12 | GPIO12 | +| MISO | GPIO13 | GPIO13 | +| SCLK | GPIO15 | GPIO15 | +| CS | GPIO14 | GPIO14 | -Be aware that the example by default uses lines normally reserved for JTAG. If this is an issue, either because of hardwired -JTAG hardware or because of the need to do JTAG debugging, feel free to change the GPIO settings by editing defines in the top -of main.c in the master/slave source code. \ No newline at end of file +Be aware that the example by default uses lines normally reserved for JTAG. If this is an issue, either because of hardwired JTAG hardware or because of the need to do JTAG debugging, feel free to change the GPIO settings by editing defines in the top of main.c in the master/slave source code. \ No newline at end of file From ef76ae3d293672dae90305e359b636e72a4e6eb1 Mon Sep 17 00:00:00 2001 From: krzychb Date: Thu, 8 Mar 2018 12:33:21 +0100 Subject: [PATCH 4/6] Extra links in 'Resources' section --- docs/resources.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/resources.rst b/docs/resources.rst index 04378f38c..06c6236d0 100644 --- a/docs/resources.rst +++ b/docs/resources.rst @@ -6,10 +6,14 @@ Resources * Check the `Issues `_ section on GitHub if you find a bug or have a feature request. Please check existing `Issues `_ before opening a new one. -* If you're interested in contributing to ESP-IDF, please check the :doc:`contribute/index`. +* A comprehensive collection of `solutions `_, `practical applications `_, `components and drivers `_ based on ESP-IDF is avialable in `ESP32 IoT Solution `_ repository. In most of cases descriptions are provided both in English and in 中文. * To develop applications using Arduino platform, refer to `Arduino core for ESP32 WiFi chip `_. -* For additional ESP32 product related information, please refer to `documentation `_ section of `Espressif `_ site. +* Several `books `_ have been written about ESP32 and they are listed on `Espressif `__ web site. -* Mirror of this documentation is available under: https://dl.espressif.com/doc/esp-idf/latest/. +* If you're interested in contributing to ESP-IDF, please check the :doc:`contribute/index`. + +* For additional ESP32 product related information, please refer to `documentation `_ section of `Espressif `__ site. + +* Mirror of this documentation is available under: https://espressif-docs.readthedocs-hosted.com/projects/esp-idf/en/latest/ and https://dl.espressif.com/doc/esp-idf/latest/. From bf2a7fd2c91b124c5a34231dabef91a086ee34ea Mon Sep 17 00:00:00 2001 From: XuanZe <119524428@qq.com> Date: Fri, 9 Mar 2018 17:55:41 +0800 Subject: [PATCH 5/6] fix: fatfs link --- docs/api-reference/storage/wear-levelling.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-reference/storage/wear-levelling.rst b/docs/api-reference/storage/wear-levelling.rst index 63dc44058..a1306bcf7 100644 --- a/docs/api-reference/storage/wear-levelling.rst +++ b/docs/api-reference/storage/wear-levelling.rst @@ -3,7 +3,7 @@ See also -------- -- :doc:`FAT Filesystem <../../api-guides/partition-tables>` +- :doc:`FAT Filesystem <./fatfs>` - :doc:`Partition Table documentation <../../api-guides/partition-tables>` Application Example From e437c7d6ad70ee472e4ce0fe56ebdd992e883898 Mon Sep 17 00:00:00 2001 From: krzychb Date: Fri, 9 Mar 2018 16:39:26 +0100 Subject: [PATCH 6/6] Exposed important information regrading the flash bus signals --- docs/get-started/get-started-wrover-kit.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/get-started/get-started-wrover-kit.rst b/docs/get-started/get-started-wrover-kit.rst index dc6e4edb6..f13dffff4 100644 --- a/docs/get-started/get-started-wrover-kit.rst +++ b/docs/get-started/get-started-wrover-kit.rst @@ -225,7 +225,9 @@ SPI Flash / JP13 | 6 | CMD / GPIO11 | +---+--------------+ -The module's flash bus is connected to the pin header JP13 through 0-Ohm resistors R140 ~ R145. If the flash frequency needs to operate at 80 MHz, to improve integrity of the bus signals, it is recommended to desolder resistors R140 ~ R145. At this point, the module's flash bus is disconnected with the pin header JP13. +.. important:: + + The module's flash bus is connected to the pin header JP13 through 0-Ohm resistors R140 ~ R145. If the flash frequency needs to operate at 80 MHz, to improve integrity of the bus signals, it is recommended to desolder resistors R140 ~ R145. At this point, the module's flash bus is disconnected with the pin header JP13. .. _get-started-esp-wrover-jtag-header: