From effc49f864a62795befd55c6874f77793b36d69e Mon Sep 17 00:00:00 2001 From: Gunar Schorcht Date: Thu, 16 Dec 2021 13:18:52 +0100 Subject: [PATCH] cpu/esp32: small documentation fix --- cpu/esp32/doc.txt | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/cpu/esp32/doc.txt b/cpu/esp32/doc.txt index ceaf0c3280..3a4df53cf3 100644 --- a/cpu/esp32/doc.txt +++ b/cpu/esp32/doc.txt @@ -1401,11 +1401,11 @@ Furthermore, the following configuration parameters have to be defined:
-Parameter | Default | Description -:------------------|:--------------------------|:------------ -ESP_WIFI_SSID | "RIOT_AP" | SSID of the AP to be used. -ESP_WIFI_PASS | - | Passphrase used for the AP as clear text (max. 64 chars). -ESP_WIFI_STACKSIZE | #THREAD_STACKSIZE_DEFAULT | Stack size used for the WiFi netdev driver thread. +Parameter | Default | Description +:-------------------|:--------------------------|:------------ +#ESP_WIFI_SSID | "RIOT_AP" | SSID of the AP to be used. +#ESP_WIFI_PASS | - | Passphrase used for the AP as clear text (max. 64 chars). +#ESP_WIFI_STACKSIZE | #THREAD_STACKSIZE_DEFAULT | Stack size used for the WiFi netdev driver thread.
@@ -1452,15 +1452,19 @@ following configuration parameters have to be defined:
-Parameter | Default | Description -:------------------|:----------|:------------ -ESP_WIFI_SSID | "RIOT_AP" | SSID of the AP to be used. -ESP_WIFI_EAP_ID | none | Optional anonymous identity used in phase 1 (outer) EAP authentication. If it is not defined, the user name defined for phase 2 (inner) EAP authentication is used as identity in phase 1. -ESP_WIFI_EAP_USER | none | User name used in phase 2 (inner) EAP authentication. -ESP_WIFI_EAP_PASS | none | Password used in phase 2 (inner) EAP authentication. -ESP_WIFI_STACKSIZE | #THREAD_STACKSIZE_DEFAULT | Stack size used for the WiFi netdev driver thread. +Parameter | Default | Description +:-------------------|:----------|:------------ +#ESP_WIFI_SSID | "RIOT_AP" | SSID of the AP to be used. +ESP_WIFI_EAP_ID | none | Optional anonymous identity used in phase 1 (outer) EAP authentication.[1] +ESP_WIFI_EAP_USER | none | User name used in phase 2 (inner) EAP authentication. +ESP_WIFI_EAP_PASS | none | Password used in phase 2 (inner) EAP authentication. +#ESP_WIFI_STACKSIZE | #THREAD_STACKSIZE_DEFAULT | Stack size used for the WiFi netdev driver thread. -
+
+ +[1] If the optional anonymous identy `ESP_WIFI_EAP_ID` is not defined, the user +name `ESP_WIFI_EAP_USER` defined for phase 2 (inner) EAP authentication is used +as identity in phase 1. These configuration parameter definitions, as well as enabling the `esp_wifi` module, can be done either in the makefile of the project or at make command