Skip to content

Commit efa26b7

Browse files
authored
Merge pull request #484 from david-cermak/fix/modem_docs_ota
fix(modem): Documented some tips on failing OTA
2 parents 7b77794 + adde6df commit efa26b7

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

docs/esp_modem/en/README.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ Switching between manual modes
120120
The diagram below depicts allowed transitions between manual CMUX modes
121121

122122
::
123+
123124
+------------------------------------
124125
| |
125126
+----------+ +-------------+ +------------+ +----------+
@@ -187,8 +188,18 @@ Is defined using standard configuration structures for ``DTE`` and
187188
Known issues
188189
------------
189190

190-
There are certain issues, especially in using CMUX mode which you can
191-
experience with some devices:
191+
There are certain typical issues you might experience when working with esp_modem. This section elaborates on these problems and offers workarounds.
192+
193+
When using UART terminal, you might find running OTA over https quite unstable, exhibiting frequent UART buffer overflows.
194+
The reason for that is that ESP32's UART is interrupt driven, so while performing computational extensive tasks with TLS session,
195+
we need to timely interrupt to process incoming data. Here'are few suggestions to mitigate the impact:
196+
* Move UART ISR to IRAM
197+
* Increase internal UART rx buffer size
198+
* Increase UART terminal task priority
199+
* Use UART flow control
200+
If none of the above helps, you can check the test ``target_ota``, which performs OTA in two steps -- first read the data, then pass the data to mbedTLS. See the test ``README.md`` for more details.
201+
202+
Potential issues when using CMUX mode and these devices:
192203

193204
1) Some modems (e.g. A76xx serries) use 2 bytes CMUX payload, which
194205
might cause buffer overflow when trying to defragment the payload.

0 commit comments

Comments
 (0)