xtensa/esp32s2: add WiFi support on ESP32S2

Author: fdcavalcanti

Documentation/platforms/xtensa/esp32s2/index.rst

@@ -217,7 +217,7 @@ Timers       Yes
 Touch        Yes
 UART         Yes
 Watchdog     Yes
-Wifi         No
+Wifi         Yes
 ========== ======= =====
 
 Memory Map
@@ -364,6 +364,50 @@ audio subsystem and develop specific usages of the I2S peripheral.
 
 Please check for usage examples using the :doc:`ESP32-S2-Saola-1 </platforms/xtensa/esp32s2/boards/esp32s2-saola-1/index>`.
 
+Wi-Fi
+======
+
+.. tip:: Boards usually expose a ``wifi`` defconfig which enables Wi-Fi.
+
+A standard network interface will be configured and can be initialized such as::
+
+    nsh> ifup wlan0
+    nsh> wapi psk wlan0 mypasswd 3
+    nsh> wapi essid wlan0 myssid 1
+    nsh> renew wlan0
+
+In this case a connection to AP with SSID ``myssid`` is done, using ``mypasswd`` as
+password. IP address is obtained via DHCP using ``renew`` command. You can check
+the result by running ``ifconfig`` afterwards.
+
+.. tip:: Please refer to :ref:`ESP32 Wi-Fi Station Mode <esp32_wi-fi_sta>`
+  for more information.
+
+Wi-Fi SoftAP
+============
+
+It is possible to use ESP32-S2 as an Access Point (SoftAP).
+
+.. tip:: Boards usually expose a ``sta_softap`` defconfig which enables Wi-Fi
+   (STA + SoftAP).
+
+If you are using this board config profile you can run these commands to be able
+to connect your smartphone or laptop to your board::
+
+    nsh> ifup wlan1
+    nsh> dhcpd_start wlan1
+    nsh> wapi psk wlan1 mypasswd 3
+    nsh> wapi essid wlan1 nuttxap 1
+
+In this case, you are creating the access point ``nuttxapp`` in your board and to
+connect to it on your smartphone you will be required to type the password ``mypasswd``
+using WPA2.
+
+.. tip:: Please refer to :ref:`ESP32 Wi-Fi SoftAP Mode <esp32_wi-fi_softap>`
+  for more information.
+
+The ``dhcpd_start`` is necessary to let your board to associate an IP to your smartphone.
+
 Secure Boot and Flash Encryption
 ================================
 

arch/xtensa/include/esp32s2/irq.h

@@ -59,8 +59,12 @@
  *   sources.
  */
 
-/* RESERVED interrupts: 0, 1, 3, 4, 5, 6, 7, 8, 9 */
+/* RESERVED interrupts: 0, 1, 3, 4, 5, 6, 7, 8, 9
+ * 0 and 1 are the exception because it is required for WiFi.
+ */
 
+#define ESP32S2_PERIPH_MAC               0
+#define ESP32S2_PERIPH_MAC_NMI           1
 #define ESP32S2_PERIPH_PWR               2
 
 /* RESERVED interrupts: 10, 11, 12, 14 */
@@ -197,6 +201,9 @@
 #define ESP32S2_IRQ2PERIPH(irq)       ((irq) - XTENSA_IRQ_FIRSTPERIPH)
 #define ESP32S2_PERIPH2IRQ(id)        ((id) + XTENSA_IRQ_FIRSTPERIPH)
 
+#define ESP32S2_IRQ_MAC               (XTENSA_IRQ_FIRSTPERIPH + ESP32S2_PERIPH_MAC)
+#define ESP32S2_IRQ_MAC_NMI           (XTENSA_IRQ_FIRSTPERIPH + ESP32S2_PERIPH_MAC_NMI)
+
 #define ESP32S2_IRQ_PWR               (XTENSA_IRQ_FIRSTPERIPH + ESP32S2_PERIPH_PWR)
 
 #define ESP32S2_IRQ_UHCI0             (XTENSA_IRQ_FIRSTPERIPH + ESP32S2_PERIPH_UHCI0)
@@ -415,6 +422,7 @@
 #define ESP32S2_CPUINT_NMISET         0x00004000
 
 #define ESP32S2_CPUINT_MAC            0
+#define ESP32S2_CPUINT_PWR            0
 #define ESP32S2_CPUINT_TIMER0         6
 #define ESP32S2_CPUINT_SOFTWARE0      7
 #define ESP32S2_CPUINT_PROFILING      11

arch/xtensa/src/common/espressif/Kconfig

@@ -153,3 +153,191 @@ config ESPRESSIF_STORAGE_MTD_DEBUG
 endif # ESPRESSIF_SPIFLASH
 
 endmenu # SPI Flash Configuration
+
+config ESPRESSIF_WIRELESS
+	bool
+	default n
+	select NET
+	select ARCH_PHY_INTERRUPT
+	select ESP32S2_RNG if ARCH_CHIP_ESP32S2
+	select ESP32S2_RT_TIMER if ARCH_CHIP_ESP32S2
+	select ESP32S2_TIMER0 if ARCH_CHIP_ESP32S2
+	depends on ARCH_CHIP_ESP32S2
+	---help---
+		Enable Wireless support
+
+config ESPRESSIF_WIFI
+	bool "Wi-Fi"
+	default n
+	select ESPRESSIF_WIRELESS
+	---help---
+		Enable Wi-Fi support
+
+menu "Wi-Fi Configuration"
+	depends on ESPRESSIF_WIFI
+
+menu "ESP WPA-Supplicant"
+
+config WPA_WAPI_PSK
+	bool "Enable WAPI PSK support"
+	default n
+	---help---
+		Select this option to enable WAPI-PSK
+		which is a Chinese National Standard Encryption for Wireless LANs (GB 15629.11-2003).
+
+config WPA_SUITE_B_192
+	bool "Enable NSA suite B support with 192-bit key"
+	default n
+	select ESP_WIFI_GCMP_SUPPORT
+	select ESP_WIFI_GMAC_SUPPORT
+	---help---
+		Select this option to enable 192-bit NSA suite-B.
+		This is necessary to support WPA3 192-bit security.
+
+config ESP_WPA_DEBUG_PRINT
+	bool "Print debug messages from Espressif's WPA Supplicant"
+	default n
+	---help---
+		Select this option to print logging information from WPA supplicant,
+		this includes handshake information and key hex dumps depending
+		on the project logging level.
+
+		Enabling this could increase the build size ~60kb
+		depending on the project logging level.
+
+endmenu # ESP WPA-Supplicant
+
+choice ESPRESSIF_WIFI_MODE
+	prompt "ESP Wi-Fi mode"
+	default ESPRESSIF_WIFI_STATION
+
+config ESPRESSIF_WIFI_STATION
+	bool "Station mode"
+
+config ESPRESSIF_WIFI_SOFTAP
+	bool "SoftAP mode"
+
+config ESPRESSIF_WIFI_STATION_SOFTAP
+	bool "Station + SoftAP"
+
+endchoice # ESP Wi-Fi mode
+
+config ESP_WIFI_ENABLE_SAE_PK
+	bool "Enable SAE-PK"
+	default y
+	---help---
+		Select this option to enable SAE-PK
+
+config ESP_WIFI_ENABLE_WPA3_OWE_STA
+	bool "Enable OWE STA"
+	default y
+	---help---
+		Select this option to allow the device to establish OWE connection with eligible AP's.
+		PMF (Protected Management Frames) is a prerequisite feature for a WPA3 connection, it needs to be
+		explicitly configured before attempting connection. Please refer to the Wi-Fi Driver API Guide for details.
+
+config ESPRESSIF_WIFI_STATIC_RXBUF_NUM
+	int "Wi-Fi static RX buffer number"
+	default 10
+
+config ESPRESSIF_WIFI_DYNAMIC_RXBUF_NUM
+	int "Wi-Fi dynamic RX buffer number"
+	default 32
+
+config ESPRESSIF_WIFI_DYNAMIC_TXBUF_NUM
+	int "Wi-Fi dynamic TX buffer number"
+	default 32
+
+config ESPRESSIF_WIFI_TX_AMPDU
+	bool "Wi-Fi TX AMPDU"
+	default y
+
+config ESPRESSIF_WIFI_RX_AMPDU
+	bool "Wi-Fi RX AMPDU"
+	default y
+
+config ESPRESSIF_WIFI_RXBA_AMPDU_WZ
+	int "Wi-Fi RX BA AMPDU windown size"
+	default 6
+
+config ESPRESSIF_WLAN_PKTBUF_NUM
+	int "WLAN netcard packet buffer number per netcard"
+	default 16
+
+config ESP_WIFI_GCMP_SUPPORT
+	bool "WiFi GCMP Support(GCMP128 and GCMP256)"
+	default n
+	---help---
+		Select this option to enable GCMP support. GCMP support is compulsory for WiFi Suite-B support.
+
+config ESP_WIFI_GMAC_SUPPORT
+	bool "WiFi GMAC Support(GMAC128 and GMAC256)"
+	default n
+	---help---
+		Select this option to enable GMAC support. GMAC support is compulsory for WiFi 192-bit certification.
+
+config ESPRESSIF_WIFI_CONNECT_TIMEOUT
+	int "Connect timeout in second"
+	default 10
+	---help---
+		Max waiting time of connecting to AP.
+
+config ESPRESSIF_WIFI_SCAN_RESULT_SIZE
+	int "Scan result buffer"
+	default 4096
+	---help---
+		Maximum scan result buffer size.
+
+config ESPRESSIF_WIFI_STA_DISCONNECT_PM
+	bool "Power Management for station when disconnected"
+	default y
+	---help---
+		Select this option to enable power management for station when disconnected.
+		Chip will do modem-sleep when RF module is not in use anymore.
+
+choice ESPRESSIF_POWER_SAVE_MODE
+	prompt "Wi-Fi Power save mode"
+	default ESPRESSIF_POWER_SAVE_NONE
+	---help---
+		Wi-Fi supports the Modem-sleep mode which refers to the legacy power-saving mode in the IEEE 802.11 protocol.
+		Modem-sleep mode works in station-only mode and the station must connect to the AP first. If the Modem-sleep
+		mode is enabled, station will switch between active and sleep state periodically. In sleep state, RF, PHY and
+		BB are turned off in order to reduce power consumption. Station can keep connection with AP in modem-sleep mode.
+
+		Modem-sleep mode includes minimum and maximum power-saving modes.
+
+		In minimum power-saving mode, station wakes
+		up every DTIM to receive beacon. Broadcast data will not be lost because it is transmitted after DTIM.
+		However, it cannot save much more power if DTIM is short for DTIM is determined by AP.
+
+		In maximum power-saving mode, station wakes up in every listen interval to receive beacon. This listen interval
+		can be set to be longer than the AP DTIM period. Broadcast data may be lost because station may be in sleep
+		state at DTIM time. If listen interval is longer, more power is saved, but broadcast data is more easy to lose.
+		Listen interval can be configured by setting ESPRESSIF_WIFI_LISTEN_INTERVAL.
+
+		ESPRESSIF_POWER_SAVE_NONE disables Modem-sleep mode entirely. Disabling it increases power consumption, but
+		minimizes the delay in receiving Wi-Fi data in real time. When Modem-sleep mode is enabled, the delay in
+		receiving Wi-Fi data may be the same as the DTIM cycle (minimum power-saving mode) or the listening interval
+		(maximum power-saving mode). Setting ESPRESSIF_POWER_SAVE_NONE is suitable when high throughput is required.
+
+config ESPRESSIF_POWER_SAVE_NONE
+	bool "No power save"
+
+config ESPRESSIF_POWER_SAVE_MIN_MODEM
+	bool "Minimum modem power saving."
+
+config ESPRESSIF_POWER_SAVE_MAX_MODEM
+	bool "Maximum modem power saving"
+
+endchoice # ESPRESSIF_POWER_SAVE_MODE
+
+config ESPRESSIF_WIFI_LISTEN_INTERVAL
+	int "Wi-Fi listen interval"
+	depends on ESPRESSIF_POWER_SAVE_MAX_MODEM
+	default 3
+	---help---
+		Interval for station to listen to beacon from AP. The unit of listen interval is one beacon interval.
+		For example, if beacon interval is 100 ms and listen interval is 3, the interval for station to listen
+		to beacon is 300 ms.
+
+endmenu # ESPRESSIF_WIFI

arch/xtensa/src/common/espressif/Make.defs

@@ -47,4 +47,16 @@ CHIP_CSRCS += esp_spiflash_mtd.c
 endif
 endif
 
+ifeq ($(CONFIG_ESPRESSIF_WIRELESS),y)
+CHIP_CSRCS += esp_wireless.c
+ifeq ($(CONFIG_ESPRESSIF_WIFI),y)
+CHIP_CSRCS += esp_wifi_utils.c
+CHIP_CSRCS += esp_wlan.c
+endif
+endif
+
+ifeq ($(CONFIG_ESPRESSIF_WIRELESS),y)
+include common$(DELIM)espressif$(DELIM)Wireless.mk
+endif
+
 INCLUDES += ${INCDIR_PREFIX}$(ARCH_SRCDIR)$(DELIM)common$(DELIM)espressif$(DELIM)platform_include