Documentation Requests/Feedback

[ESP_Angus]

If I want to port the esptool.py to another language, is there a document somewhere specifying the protocol used to communicate with the ROM bootloader? Or do I have to infer it from the python source? I will do the latter if the former isn't available, but having documentation would speed up the process.

At the moment this is the case (infer it from the Python source.)

There is an out of date Wiki page here: https://github.com/espressif/esptool/wi ... l-Protocol but it predates esptool.py being an Espressif project, and doesn't cover ESP32 at all. I have been meaning to find time to update it, but haven't had time yet.

[SteveOfTheStow]

Is there any written protocol specification for developing an ESP-TOUCH client? The documentation here https://www.espressif.com/en/products/s ... /resources talks a bit about how it works at a very high level, and the API for the ESP32 and ESP8266, but there's nothing really describing the protocol a client has to send the SSID and password with. Would be nice to have that documented as opposed to reverse engineering it from the sample app.

[ESP_Lvxinyue]

Is there any written protocol specification for developing an ESP-TOUCH client? The documentation here https://www.espressif.com/en/products/s ... /resources talks a bit about how it works at a very high level, and the API for the ESP32 and ESP8266, but there's nothing really describing the protocol a client has to send the SSID and password with. Would be nice to have that documented as opposed to reverse engineering it from the sample app.

Hi, thanks for using the ESP-TOUCH technology. The protocol specification is not public.

[ninjaneer]

ESP8266_SDKSSL_User_Manual_EN_v1.4.pdf as referenced at:

https://github.com/espressif/esp-idf/bl ... /README.md

...is missing. I gave up and used mbedTLS directly based on their docs and examples.

[michprev]

Documentation of functions implemented in ROM would be also nice.

Technical reference manual also does not correspond with ESP-IDF (many registers / register bits are missing).
E. g.:

• DPORT_APP_CACHE_CTRL1_REG is missing (it is according to ESP-IDF very important to work around a hardware bug
• how to set pad hold feature of GPIO32 / GPIO33 ?
• how to set RTC function to RTC_GPIO / RTC_I2C ?
• in RTCIO_RTC_GPIO_OUT_REG it is possible to set output value of some pins that are input only, that is kind of misleading

As I would like to implement a custom SDK I believe that there is more I am about to discover

EDIT

• addresses of RTC registers are in sections 30.4 and 30.5 increased by 1 instead of 4
• setting CPU frequency is not well documented (RTC8M and RTC_CLK need to be calibrated, how to do that? when changing CPU frequency there is needed to set DBIAS voltage - how to set it correctly?)
• SPI flash options in SPI registers are not documented (e. g. SPI_FLASH_READ, SPI_FLASH_WREN in SPI_CMD_REG register)
• as I have read here https://github.com/espressif/esp-idf/is ... -368740348 it is very unclear how to correctly setup SPI timing; I am missing info about SPI mode - DMA incompatibility

The most critical si clock configuration section. Have no clue what is ANA_CONFIG_REG (0x6000E044), BBPLL, APLL (it has something to do with some internal I2C bus?)
Where in Figure 6: System Clock fits RTC 8 MHz clock divider https://github.com/espressif/esp-idf/bl ... #L698-L699 ?

Please give us complete scheme with all clock configuration options.

[RioLucrezio]

I have bought a esp32 devkitc and I have download the toolchain for writing some software for the board but I have not found the C Reference Guide or something like this with the compiler option and the libraries documentation; I have not found either the Linker (or builder) Reference and the Assembly Reference.
I hope that somebody knows where I can find these documents.

[ESP_Sprite]

For what it's worth, the compiler/linker is just standard gcc so you can use any documentation for the appropriate version of that. As a library reference, we have the programming guide here: https://esp-idf.readthedocs.io/en/latest/ . There is no assembly guide, sorry.

[RioLucrezio]

Thank you very much.
I think that is the same for "Make" documentation.

[ESP_Lvxinyue]

Documentation of functions implemented in ROM would be also nice.

Technical reference manual also does not correspond with ESP-IDF (many registers / register bits are missing).
E. g.:

• DPORT_APP_CACHE_CTRL1_REG is missing (it is according to ESP-IDF very important to work around a hardware bug
• how to set pad hold feature of GPIO32 / GPIO33 ?
• how to set RTC function to RTC_GPIO / RTC_I2C ?
• in RTCIO_RTC_GPIO_OUT_REG it is possible to set output value of some pins that are input only, that is kind of misleading

As I would like to implement a custom SDK I believe that there is more I am about to discover

EDIT

• addresses of RTC registers are in sections 30.4 and 30.5 increased by 1 instead of 4
• setting CPU frequency is not well documented (RTC8M and RTC_CLK need to be calibrated, how to do that? when changing CPU frequency there is needed to set DBIAS voltage - how to set it correctly?)
• SPI flash options in SPI registers are not documented (e. g. SPI_FLASH_READ, SPI_FLASH_WREN in SPI_CMD_REG register)
• as I have read here https://github.com/espressif/esp-idf/is ... -368740348 it is very unclear how to correctly setup SPI timing; I am missing info about SPI mode - DMA incompatibility

The most critical si clock configuration section. Have no clue what is ANA_CONFIG_REG (0x6000E044), BBPLL, APLL (it has something to do with some internal I2C bus?)
Where in Figure 6: System Clock fits RTC 8 MHz clock divider https://github.com/espressif/esp-idf/bl ... #L698-L699 ?

Please give us complete scheme with all clock configuration options.

Hi,

Thanks for your feedback.

For how to set pad hold feature and RTC function, please refer to chapter IO_MUX and GPIO Matrix, specifically in section 4.7: Pad Hold Feature, 4.8: I/O Pad Power Supplies and the register description section. More information about RTC clk calibration may be found in the IDF documentation.

The incorrect RTC register addresses have been corrected. Thank you. We are working on the mismatches between the TRM and ESP-IDF. Please keep updated by subscribing to Espressif email notification at: https://www.espressif.com/en/subscribe.

Thanks.

[Fulembar]

Hi everybody,

Our product is based on ESP32-wroom-32 module. To complete the documentation for exporting our product we require test reports RKS170508002-00A, RKS170508002-00B and RKS170508002-00C mentioned in your CE Declaration of Conformity from this link:
https://www.espressif.com/sites/default ... pendix.pdf

This is the product I am refering to: https://www.stemi.education/hexapod/

Can anybody point me to the person responsible for certification documentation to handle the situation? There is no appropriate contact on the "contact us" part of the web.

I hope I posted this question on the right place. If not, please moderate.

Thank you,
Luka