acassis commented on code in PR #19236: URL: https://github.com/apache/nuttx/pull/19236#discussion_r3500883560
########## Documentation/platforms/arm/rtl8720f/boards/rtl8720f_evb/index.rst: ########## @@ -0,0 +1,105 @@ +============ +RTL8720F EVB +============ + +.. tags:: chip:rtl8720f, arch:arm, vendor:realtek + +.. todo:: + + Add a photo of the RTL8720F EVB board here as ``rtl8720f_evb.png`` in this + directory, referenced with a ``.. figure::`` directive. + +The RTL8720F EVB is a Realtek RTL8720F (dual-core Wi-Fi Host Controller) +evaluation board. NuttX runs on the KM4TZ (Cortex-M33, secure world) +application core as the Wi-Fi host; the KM4NS network processor runs the +prebuilt vendor Wi-Fi firmware. See the +:doc:`RTL8720F chip documentation <../../index>` for the SoC architecture, +memory map and vendor-SDK dependency. + +Features +======== + +* RTL8720F dual-core Wi-Fi Host Controller (KM4TZ Cortex-M33 secure host + + KM4NS NP) +* 2.4 GHz Wi-Fi (station and SoftAP) +* SPI NOR flash (shared with the NP, XIP) +* LOG-UART console + +Supported in this NuttX port: + +* NSH shell over the LOG-UART console (NuttX owns LOG-UART RX directly; the NP + shell is disabled) +* littlefs persistent storage mounted at ``/data`` (a dedicated SPI NOR flash + partition), backing the Wi-Fi key-value store +* Wi-Fi station and SoftAP through the ``wapi`` tool +* DHCP client (STA) and DHCP server (SoftAP) + +.. note:: + + The Wi-Fi MAC/PHY is driven by the prebuilt vendor firmware on the KM4NS + network processor. NuttX is the Wi-Fi host and exchanges frames with the NP + over the on-chip IPC transport; see the chip documentation. + +Buttons and LEDs +================ + +This NuttX port does not wire any user buttons or LEDs. + +Configurations +============== + +.. code:: console + + $ ./tools/configure.sh rtl8720f_evb:<config-name> + +nsh +--- + +Networking-enabled NSH with littlefs at ``/data`` and the ``wapi`` Wi-Fi tool. +The console is the LOG-UART at 1500000 8N1 (the rate is configured by the +bootloader and inherited by NuttX). The Wi-Fi examples below are available from +this configuration. + +Wi-Fi +===== + +Station (connect to an AP):: + + nsh> wapi psk wlan0 <password> 3 + nsh> wapi essid wlan0 <ssid> 1 + nsh> renew wlan0 + +SoftAP (become an access point, with a DHCP server for clients):: + + nsh> wapi mode wlan0 3 + nsh> wapi psk wlan0 <password> 3 + nsh> wapi essid wlan0 <ssid> 1 + nsh> ifconfig wlan0 192.168.4.1 netmask 255.255.255.0 + nsh> dhcpd_start wlan0 + +Stop the SoftAP with ``wapi essid wlan0 <ssid> 0``. + +Building and Flashing +===================== + +The build auto-fetches the Realtek ``ameba-rtos`` SDK on first use and a +Realtek ``arm-none-eabi`` toolchain must be on ``PATH``; see the +:doc:`chip documentation <../../index>` for both. + +.. code:: console + + $ ./tools/configure.sh rtl8720f_evb:nsh + $ make + +This produces ``nuttx/app.bin`` (the NuttX KM4TZ image2), ``boot.bin`` and the +NP (KM4NS) image, ready to flash with the Realtek tooling. Review Comment: @raulcxw please add the instruction, programmer model used and the flashing command. Otherwise a beginner will not know how to use it ########## Documentation/platforms/arm/rtl8721dx/boards/pke8721daf/index.rst: ########## @@ -0,0 +1,104 @@ +========== +PKE8721DAF +========== + +.. tags:: chip:rtl8721dx, arch:arm, vendor:realtek + +.. figure:: PKE8721DAF.png + :scale: 50 % + :align: center + :alt: Realtek PKE8721DAF development board + + The PKE8721DAF development board. + +The PKE8721DAF is a Realtek RTL8721Dx (dual-core Wi-Fi Host Controller) +development board. NuttX runs on the KM4 (Cortex-M33) application core as the +Wi-Fi host; the KM0 network processor runs the prebuilt vendor Wi-Fi firmware. +See the :doc:`RTL8721Dx chip documentation <../../index>` for the SoC +architecture, memory map and vendor-SDK dependency. + +Features +======== + +* RTL8721Dx dual-core Wi-Fi Host Controller (KM4 Cortex-M33 host + KM0 NP) +* 2.4 GHz Wi-Fi (station and SoftAP) +* SPI NOR flash (shared with the NP, XIP) +* LOG-UART console + +Supported in this NuttX port: + +* NSH shell over the LOG-UART console +* littlefs persistent storage mounted at ``/data`` (a dedicated SPI NOR flash + partition), backing the Wi-Fi key-value store +* Wi-Fi station and SoftAP through the ``wapi`` tool +* DHCP client (STA) and DHCP server (SoftAP) + +.. note:: + + The Wi-Fi MAC/PHY is driven by the prebuilt vendor firmware on the KM0 + network processor. NuttX is the Wi-Fi host and exchanges frames with the NP + over the on-chip IPC transport; see the chip documentation. + +Buttons and LEDs +================ + +This NuttX port does not wire any user buttons or LEDs. + +Configurations +============== + +.. code:: console + + $ ./tools/configure.sh pke8721daf:<config-name> + +nsh +--- + +Networking-enabled NSH with littlefs at ``/data`` and the ``wapi`` Wi-Fi tool. +The console is the LOG-UART at 1500000 8N1 (the rate is configured by the +bootloader and inherited by NuttX). The Wi-Fi examples below are available from +this configuration. + +Wi-Fi +===== + +Station (connect to an AP):: + + nsh> wapi psk wlan0 <password> 3 + nsh> wapi essid wlan0 <ssid> 1 + nsh> renew wlan0 + +SoftAP (become an access point, with a DHCP server for clients):: + + nsh> wapi mode wlan0 3 + nsh> wapi psk wlan0 <password> 3 + nsh> wapi essid wlan0 <ssid> 1 + nsh> ifconfig wlan0 192.168.4.1 netmask 255.255.255.0 + nsh> dhcpd_start wlan0 + +Stop the SoftAP with ``wapi essid wlan0 <ssid> 0``. + +Building and Flashing +===================== + +The build auto-fetches the Realtek ``ameba-rtos`` SDK on first use and a +Realtek ``arm-none-eabi`` toolchain must be on ``PATH``; see the +:doc:`chip documentation <../../index>` for both. + +.. code:: console + + $ ./tools/configure.sh pke8721daf:nsh + $ make + +This produces ``nuttx/app.bin`` (the NuttX KM4 image2), ``boot.bin`` and the +NP (KM0) image, ready to flash with the Realtek tooling. Review Comment: Ditto -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
