Update docs

Author: earlephilhower

docs/freertos.rst

@@ -15,13 +15,19 @@ To enable FreeRTOS, simply add
 
     #include <FreeRTOS.h>
 
-to your sketch and it will be included and enabled automatically.
+to your sketch and select ``Tools->Operating System->FreeRTOS SMP`` to enable it.
+
+When using Platform.IO you need to add the following define to your .ini file:
+
+.. code::
+
+    -D__FREERTOS=1
 
 Configuration and Predefined Tasks
 ----------------------------------
 
 FreeRTOS is configured with 8 priority levels (0 through 7) and a process for
-``setup()/loop()``, ``setup1()/loop1()``, and the USB port will be created.  The task
+``setup()/loop()``, ``setup1()/loop1()``, LWIP, and the USB port will be created.  The task
 quantum is 1 millisecond (i.e. 1,000 switches per second).
 
 ``setup()`` and ``loop()`` are assigned to only run on core 0, while ``setup1()`` and ``loop1()``

docs/platformio.rst

@@ -350,8 +350,8 @@ FreeRTOS support can be activated by adding
 
 .. code:: ini
 
-    ; Set the compiler flag.  Still need to #include <FreeRTOF.h> in your application
-    build_flags = -D__FREERTOS
+    ; Enable FreeRTOS Support
+    build_flags = -DPIO_FRAMEWORK_ARDUINO_ENABLE_FREERTOS
 
 to the ``platformio.ini``.
 

docs/wifi.rst

@@ -24,8 +24,6 @@ Supported Features
 Important Information
 ---------------------
 
-Please note that WiFi on the Pico W is a work-in-progress and there are some important caveats:
-
 * Adding WiFi increases flash usage by over 220KB
 
   * There is a 220KB binary firmware blob for the WiFi chip (CYW43-series) which the Pico W uses, even to control the onboard LED.
@@ -34,17 +32,14 @@ Please note that WiFi on the Pico W is a work-in-progress and there are some imp
 
   * LWIP, the TCP/IP driver, requires preallocated buffers to allow it to run in non-polling mode (i.e. packets can be sent and received in the background without the application needing to explicitly do anything).
 
-* The WiFi driver is a little limited as of now, but fully functional for sending and receiving data
+* The WiFi driver has some limitations stemming from the upstream SDK:
 
   * Extensible Authentication Protocol (EAP) is not supported
 
   * Combined STA/AP mode is not supported
 
-* Multicore is supported, but only core 0 may run ``WiFi`` related code.
-
-  * FreeRTOS is supported only on core 0 and from within ``setup`` and ``loop``, not tasks, due to the requirement for a very different LWIP implementation.  PRs always appreciated!
+* Multicore is supported, but only core 0 may run ``WiFi`` related code when in bare metal.  When using FreeRTOS, any Task on any core can perform networking operations.
 
-  * LEAmDNS (``MDNS``) is not supported in FreeRTOS due to internal IRQ-time memory allocations.  Instead, use the SimpleMDNS library ( ``#include <SimpleMDNS.h>`` ) which has no such allocations.
 
 The WiFi library borrows much work from the `ESP8266 Arduino Core <https://github.com/esp8266/Arduino>`__ , especially the ``WiFiClient`` and ``WiFiServer`` classes.
 

tools/platformio-build.py

@@ -95,6 +95,14 @@ def is_pio_build():
 else:
     libpicow = File(os.path.join(FRAMEWORK_DIR, "lib", chip, "liblwip.a"))
 
+if "PIO_FRAMEWORK_ARDUINO_ENABLE_FREERTOS" in flatten_cppdefines:
+    env.Append(
+        CPPDEFINES=[
+            ("__FREERTOS", 1)
+        ]
+    )
+
+
 env.Append(
     ASFLAGS=env.get("CCFLAGS", [])[:],
 )