Re-add FreeRTOS examples, update spellcheck

Author: earlephilhower

.github/workflows/pull-request.yml

@@ -20,8 +20,8 @@ jobs:
     - name: Run codespell
       uses: codespell-project/actions-codespell@v2
       with:
-        skip: ./ArduinoCore-API,./libraries/ESP8266SdFat,./libraries/Adafruit_TinyUSB_Arduino,./libraries/LittleFS/lib,./tools/pyserial,./pico-sdk,./.github,./docs/i2s.rst,./cores/rp2040/api,./libraries/FreeRTOS,./tools/libbearssl/bearssl,./include,./libraries/WiFi/examples/BearSSL_Server,./ota/uzlib,./libraries/http-parser/lib,./libraries/WebServer/examples/HelloServerBearSSL/HelloServerBearSSL.ino,./libraries/HTTPUpdateServer/examples/SecureBearSSLUpdater/SecureBearSSLUpdater.ino,./.git,./libraries/FatFS/lib/fatfs,./libraries/FatFS/src/diskio.h,./libraries/FatFS/src/ff.cpp,./libraries/FatFS/src/ffconf.h,./libraries/FatFS/src/ffsystem.cpp,./libraries/FatFS/src/ff.h,./libraries/lwIP_WINC1500/src/driver,./libraries/lwIP_WINC1500/src/common,./libraries/lwIP_WINC1500/src/bus_wrapper,./libraries/lwIP_WINC1500/src/spi_flash,./libraries/WiFi/examples/BearSSL_Validation/certs.h
-        ignore_words_list: ser,dout,shiftIn,acount,froms
+        skip: ./ArduinoCore-API,./libraries/ESP8266SdFat,./libraries/Adafruit_TinyUSB_Arduino,./libraries/LittleFS/lib,./tools/pyserial,./pico-sdk,./.github,./docs/i2s.rst,./cores/rp2040/api,./FreeRTOS,./tools/libbearssl/bearssl,./include,./libraries/WiFi/examples/BearSSL_Server,./ota/uzlib,./libraries/http-parser/lib,./libraries/WebServer/examples/HelloServerBearSSL/HelloServerBearSSL.ino,./libraries/HTTPUpdateServer/examples/SecureBearSSLUpdater/SecureBearSSLUpdater.ino,./.git,./libraries/FatFS/lib/fatfs,./libraries/FatFS/src/diskio.h,./libraries/FatFS/src/ff.cpp,./libraries/FatFS/src/ffconf.h,./libraries/FatFS/src/ffsystem.cpp,./libraries/FatFS/src/ff.h,./libraries/lwIP_WINC1500/src/driver,./libraries/lwIP_WINC1500/src/common,./libraries/lwIP_WINC1500/src/bus_wrapper,./libraries/lwIP_WINC1500/src/spi_flash,./libraries/WiFi/examples/BearSSL_Validation/certs.h
+        ignore_words_list: ser,dout,shiftIn,acount,froms,ThirdParty
     - name: Check boards.txt was not edited after makeboards.py
       run: |
         ./tools/makeboards.py

libraries/rp2040/examples/Multicore-FreeRTOS/Multicore-FreeRTOS.ino

@@ -0,0 +1,87 @@
+// Demonstrates a simple use of the setup1()/loop1() functions
+// for a multiprocessor run.
+
+// Will output something like, where C0 is running on core 0 and
+// C1 is on core 1, in parallel.
+
+// 11:23:07.507 -> C0: Blue leader standing by...
+// 11:23:07.507 -> C1: Red leader standing by...
+// 11:23:07.507 -> C1: Stay on target...
+// 11:23:08.008 -> C1: Stay on target...
+// 11:23:08.505 -> C0: Blue leader standing by...
+// 11:23:08.505 -> C1: Stay on target...
+// 11:23:09.007 -> C1: Stay on target...
+// 11:23:09.511 -> C0: Blue leader standing by...
+// 11:23:09.511 -> C1: Stay on target...
+// 11:23:10.015 -> C1: Stay on target...
+
+// Released to the public domain
+#include <FreeRTOS.h>
+#include <task.h>
+#include <map>
+#include <EEPROM.h>
+
+std::map<eTaskState, const char *> eTaskStateName { {eReady, "Ready"}, { eRunning, "Running" }, {eBlocked, "Blocked"}, {eSuspended, "Suspended"}, {eDeleted, "Deleted"} };
+void ps() {
+  int tasks = uxTaskGetNumberOfTasks();
+  TaskStatus_t *pxTaskStatusArray = new TaskStatus_t[tasks];
+  unsigned long runtime;
+  tasks = uxTaskGetSystemState( pxTaskStatusArray, tasks, &runtime );
+  Serial.printf("# Tasks: %d\n", tasks);
+  Serial.println("ID, NAME, STATE, PRIO, CYCLES");
+  for (int i=0; i < tasks; i++) {
+    Serial.printf("%d: %-16s %-10s %d %lu\n", i, pxTaskStatusArray[i].pcTaskName, eTaskStateName[pxTaskStatusArray[i].eCurrentState], (int)pxTaskStatusArray[i].uxCurrentPriority, pxTaskStatusArray[i].ulRunTimeCounter);
+  }
+  delete[] pxTaskStatusArray;
+}
+
+
+void blink(void *param) {
+  (void) param;
+  delay(500);
+  pinMode(LED_BUILTIN, OUTPUT);
+  while (true) {
+    digitalWrite(LED_BUILTIN, LOW);
+    delay(750);
+    digitalWrite(LED_BUILTIN, HIGH);
+    delay(250);
+  }
+}
+
+
+void setup() {
+  TaskHandle_t blinkTask;
+  Serial.begin(115200);
+  xTaskCreate(blink, "BLINK", 256, nullptr, 1, &blinkTask);
+#if defined(PICO_CYW43_SUPPORTED)
+  // The PicoW WiFi chip controls the LED, and only core 0 can make calls to it safely
+  vTaskCoreAffinitySet(blinkTask, 1 << 0);
+#endif
+  delay(5000);
+}
+
+volatile int val = 0;
+void loop() {
+  Serial.printf("C0: Blue leader standing by...\n");
+  ps();
+  Serial.printf("val: %d\n", val);
+  delay(1000);
+}
+
+// Running on core1
+void setup1() {
+  delay(5000);
+  Serial.printf("C1: Red leader standing by...\n");
+}
+
+void loop1() {
+  static int x = 0;
+  Serial.printf("C1: Stay on target...\n");
+  val++;
+  if (++x < 10) {
+    EEPROM.begin(512);
+    EEPROM.write(0,x);
+    EEPROM.commit();
+  }
+  delay(1000);
+}

libraries/rp2040/examples/PSRAMTest/PSRAMTest.ino

@@ -0,0 +1,64 @@
+/*
+  PSRAM Test
+
+  This section of code tests the onboard ram of RP2350 based boards with external
+  PSRAM.
+
+  This example code is in the public domain.
+
+*/
+
+#if !defined(RP2350_PSRAM_CS)
+
+void setup() {
+  Serial.println("This example needs an RP2350 with PSRAM attached");
+}
+
+void loop() {
+}
+
+#else
+
+#define CHUNK_SIZE 131072
+uint8_t tmp[CHUNK_SIZE];
+uint8_t mems[1024 * 1024 * 8] PSRAM;
+
+// the setup function runs once when you press reset or power the board
+void setup() {
+  // initialize digital pin LED_BUILTIN as an output.
+  pinMode(LED_BUILTIN, OUTPUT);
+  while (!Serial) {
+    delay(10);
+  }
+  Serial.begin(115200);
+  Serial.printf("Memory size: %d\r\n", rp2040.getPSRAMSize());
+}
+
+// the loop function runs over and over again forever
+void loop() {
+  int i;
+  static int cntr = 1;
+
+  uint8_t *mem = mems;
+  Serial.printf("%05d: Filling %d memory locations @0x%p with random values and verifying in %d byte chunks.\r\n", cntr++, rp2040.getPSRAMSize(), mem, CHUNK_SIZE);
+
+  for (size_t m = 0; m < (rp2040.getPSRAMSize() / CHUNK_SIZE); m++) {
+    for (i = 0; i < CHUNK_SIZE; i++) {
+      tmp[i] = (char)random(0, 255);
+      mem[i] = tmp[i];
+    }
+
+    for (i = 0; i < CHUNK_SIZE; i++) {
+      if (mem[i] != tmp[i]) {
+        Serial.printf("Memory error @0x%p(%d), was 0x%02x, should be 0x%02x\n", mem, i, *mem, tmp[i]);
+        delay(10);
+      }
+    }
+    Serial.write('.');
+    Serial.flush();
+    mem += CHUNK_SIZE;
+  }
+  Serial.printf("\nDone, testing %d bytes again\r\n", rp2040.getPSRAMSize());
+}
+
+#endif // RAM_CHIP_SELECT

libraries/rp2040/examples/StaticMulticore-FreeRTOS/StaticMulticore-FreeRTOS.ino

@@ -0,0 +1,94 @@
+/* The code in this example is mostly derived from the official FreeRTOS
+ * code examples.
+ * 
+ * For more information on static allocation and to read the original
+ * code visit the following links:
+ * https://www.freertos.org/Static_Vs_Dynamic_Memory_Allocation.html
+ * https://www.freertos.org/xTaskCreateStatic.html
+ * https://www.freertos.org/xSemaphoreCreateMutexStatic.html
+ */
+
+#include <FreeRTOS.h>
+#include <task.h>
+#include <semphr.h>
+
+#define SERIAL_PORT Serial
+#define BLINK_ON_TIME   250
+#define BLINK_OFF_TIME  500
+
+/* Dimensions of the buffer that the task being created will use as its stack.
+  NOTE:  This is the number of words the stack will hold, not the number of
+  bytes.  For example, if each stack item is 32-bits, and this is set to 100,
+  then 400 bytes (100 * 32-bits) will be allocated. */
+#define STACK_SIZE 200
+
+/* Structure that will hold the TCB of the task being created. */
+StaticTask_t xTaskBuffer_A;
+StaticTask_t xTaskBuffer_B;
+
+/* Buffer that the task being created will use as its stack.  Note this is
+  an array of StackType_t variables.  The size of StackType_t is dependent on
+  the RTOS port. */
+StackType_t xStack_A[ STACK_SIZE ];
+StackType_t xStack_B[ STACK_SIZE ];
+
+SemaphoreHandle_t xSemaphore = NULL;
+StaticSemaphore_t xMutexBuffer;
+
+TaskHandle_t ledOnTask, ledOffTask;
+
+void setup() {
+  SERIAL_PORT.begin(115200);
+  pinMode(LED_BUILTIN, OUTPUT);
+
+  /* Create a mutex semaphore without using any dynamic memory
+    allocation.  The mutex's data structures will be saved into
+    the xMutexBuffer variable. */
+  xSemaphore = xSemaphoreCreateMutexStatic( &xMutexBuffer );
+
+  ledOnTask = xTaskCreateStatic(led_ON, "led_ON", STACK_SIZE, NULL, configMAX_PRIORITIES - 1, xStack_A, &xTaskBuffer_A);
+#if defined(PICO_CYW43_SUPPORTED)
+  // The PicoW WiFi chip controls the LED, and only core 0 can make calls to it safely
+  vTaskCoreAffinitySet(ledOnTask, 1 << 0);
+#endif
+  ledOffTask = xTaskCreateStatic(led_OFF, "led_OFF", STACK_SIZE, NULL, configMAX_PRIORITIES - 1, xStack_B, &xTaskBuffer_B);
+#if defined(PICO_CYW43_SUPPORTED)
+  // The PicoW WiFi chip controls the LED, and only core 0 can make calls to it safely
+  vTaskCoreAffinitySet(ledOffTask, 1 << 0);
+#endif
+  }
+
+void led_ON(void *pvParameters)
+{
+  (void) pvParameters;
+  delay(100);
+  while (1)
+  {
+    xSemaphoreTake( xSemaphore, ( TickType_t ) portMAX_DELAY );
+    SERIAL_PORT.println("LED ON!");
+    digitalWrite(LED_BUILTIN, HIGH);
+    delay(BLINK_ON_TIME);
+    xSemaphoreGive( xSemaphore );
+    delay(1);
+  }
+}
+
+void led_OFF(void *pvParameters)
+{
+  (void) pvParameters;
+  delay(100);
+  while (1)
+  {
+    xSemaphoreTake( xSemaphore, ( TickType_t ) portMAX_DELAY );
+    SERIAL_PORT.println("LED OFF!");
+    digitalWrite(LED_BUILTIN, LOW);
+    delay(BLINK_OFF_TIME);
+    xSemaphoreGive( xSemaphore );
+    delay(1);
+  }
+}
+
+void loop() {
+  SERIAL_PORT.println("Hello!");
+  delay(1000);
+}