Merge branch 'main' into readme_beautify

Author: leonardocavagnis

.github/ISSUE_TEMPLATE/compilation_bug_report.md

@@ -15,6 +15,7 @@ A clear and concise description of what the bug is.
 Issues without the full verbose output will be discarded as invalid.
 
 **Mandatory: attach the sketch**
+or a Minimal reproducible example
 Issues without the sketch will be discarded as invalid.
 
 **Additional context**

.github/ISSUE_TEMPLATE/miscellaneous_bug_report.md

@@ -1,6 +1,6 @@
 ---
 name: Miscellaneous bug report
-about: Sketch compile but doesn't upload, or similar issues
+about: Sketch compiles but doesn't upload, or similar issues
 title: ''
 labels: ''
 assignees: ''

.github/ISSUE_TEMPLATE/runtime_bug_report.md

@@ -1,6 +1,6 @@
 ---
 name: Runtime bug report
-about: Sketch compile and uploads but doesn't run correctly (or doesn't run at all)
+about: Sketch compiles and uploads but doesn't run correctly (or doesn't run at all)
 title: ''
 labels: ''
 assignees: ''
@@ -14,17 +14,19 @@ A clear and concise description of what the bug is.
 **Full verbose** compilation output, ideally with `arduino-cli` invocation or from IDE 2.3.3+
 Issues without the full verbose output will be discarded as invalid.
 
-**Output of debug UART**
-Complete output of the console crash, starting from
+**Output of Serial Monitor**
+1. If you have an USB-to-Serial adapter, paste the complete output of the console crash, starting from
 ```*** Booting Zephyr OS build v3.7...```
-Runtime issues without the **full UART output** will be discarded as invalid.
+2. If you don't, compile the sketch in `Debug` mode (see *Troubleshooting section* in README) and paste the output after invoking `sketch` command
+Runtime issues without the **full output** will be discarded as invalid.
 
 **Output of readelf**
+You can find the loaction of the elf file by compiling in Verbose mode and looking near the end of the compilation output (after `Linking everything together..`)
 Paste (or attach) the output of `arm-none-eabi-readelf -a $your_sketch_elf_file`
 
 **Optional: attach the elf file**
 
-**Output: attach the sketch**
+**Optional: attach the sketch**
 
 **Additional context**
 Add any other context about the problem here.

.github/workflows/package_core.yml

@@ -0,0 +1,32 @@
+name: Package core
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      ZEPHYR_SDK_INSTALL_DIR: /opt/zephyr-sdk-0.16.8
+    steps:
+      - name: Install toolchain
+        working-directory: /opt
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends git cmake wget python3-pip ninja-build
+          wget https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v0.16.8/zephyr-sdk-0.16.8_linux-x86_64_minimal.tar.xz
+          tar xf zephyr-sdk-0.16.8_linux-x86_64_minimal.tar.xz && cd zephyr-sdk-0.16.8 && ./setup.sh -t arm-zephyr-eabi -c
+
+      - uses: actions/checkout@v4
+
+      - name: Initialize
+        run: |
+          ./extra/bootstrap.sh
+          ./extra/build_all.sh
+          ./extra/package.sh `git describe --always`
+          mv ../arduino-core-zephyr-llext* .
+
+      - name: Archive core
+        uses: actions/upload-artifact@v3
+        with:
+          name: Core
+          path: arduino-core-zephyr-llext*

extra/package.sh

@@ -5,6 +5,9 @@ if [ ! -f platform.txt ]; then
   exit 2
 fi
 
+FOLDER=`basename $PWD`
+
 VERSION=$1
 
-tar  --exclude=extras/** --exclude=.git* --exclude=build --exclude=venv --exclude=samples -cjhf ../arduino-core-zephyr-llext-${VERSION}.tar.bz2 .
+cd ..
+tar  --exclude=extras/** --exclude=.git* --exclude=build --exclude=venv --exclude=samples -cjhf arduino-core-zephyr-llext-${VERSION}.tar.bz2 $FOLDER

loader/boards/arduino_nano_33_ble_sense.conf

@@ -33,10 +33,10 @@ CONFIG_ADC=y
 CONFIG_PWM=y
 
 CONFIG_LLEXT_STORAGE_WRITABLE=n
-CONFIG_SHELL_STACK_SIZE=1024
-CONFIG_HEAP_MEM_POOL_SIZE=32000
+CONFIG_SHELL_STACK_SIZE=2048
+CONFIG_HEAP_MEM_POOL_SIZE=16384
 CONFIG_LLEXT_HEAP_SIZE=96
-CONFIG_MAIN_STACK_SIZE=64768
+CONFIG_MAIN_STACK_SIZE=16384
 
 CONFIG_BT_RX_STACK_SIZE=4096
 CONFIG_BT_HCI_TX_STACK_SIZE=4096

loader/fixups.c

@@ -1,6 +1,6 @@
 #include <cmsis_core.h>
 #include <zephyr/init.h>
-void disable_mpu_rasr_xn(void)
+int disable_mpu_rasr_xn(void)
 {
 	uint32_t index;
 	/* Kept the max index as 8(irrespective of soc) because the sram
@@ -18,6 +18,7 @@ void disable_mpu_rasr_xn(void)
 		}
 #endif /* CONFIG_ARMV8_M_BASELINE || CONFIG_ARMV8_M_MAINLINE */
 	}
+	return 0;
 }
 
 #if defined(CONFIG_BOARD_ARDUINO_NANO_33_BLE)

loader/llext_exports.c

@@ -91,6 +91,7 @@ FORCE_EXPORT_SYM(cdc_acm_dte_rate_callback_set);
 #endif
 
 FORCE_EXPORT_SYM(k_timer_init);
+FORCE_EXPORT_SYM(k_fatal_halt);
 //FORCE_EXPORT_SYM(k_timer_user_data_set);
 //FORCE_EXPORT_SYM(k_timer_start);
 

loader/main.c

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+#include "zephyr/sys/printk.h"
 #include <zephyr/logging/log.h>
 LOG_MODULE_REGISTER(app);
 
@@ -12,8 +13,18 @@ LOG_MODULE_REGISTER(app);
 #include <zephyr/llext/llext.h>
 #include <zephyr/llext/buf_loader.h>
 #include <zephyr/shell/shell.h>
+#include <zephyr/shell/shell_uart.h>
 
 #include <stdlib.h>
+#include <zephyr/drivers/uart/cdc_acm.h>
+#include <zephyr/drivers/uart.h>
+#include <zephyr/usb/usb_device.h>
+
+#if DT_NODE_HAS_PROP(DT_PATH(zephyr_user), cdc_acm)
+const struct device *const usb_dev = DEVICE_DT_GET(DT_PHANDLE_BY_IDX(DT_PATH(zephyr_user), cdc_acm, 0));
+#endif
+
+static int enable_shell_usb(void);
 
 #ifdef CONFIG_USERSPACE
 K_THREAD_STACK_DEFINE(llext_stack, CONFIG_MAIN_STACK_SIZE);
@@ -58,11 +69,23 @@ static int loader(const struct shell *sh)
 		return -EINVAL;
 	}
 
+#if DT_NODE_HAS_PROP(DT_PATH(zephyr_user), cdc_acm) && CONFIG_SHELL
 	uint8_t debug = endptr[1];
 	if (debug != 0 && strcmp(k_thread_name_get(k_current_get()), "main") == 0) {
-		// starts the shell
+		// disables default shell on UART
+		shell_uninit(shell_backend_uart_get_ptr(), NULL);
+		// enables USB and starts the shell
+		usb_enable(NULL);
+		int dtr;
+		do {
+			// wait for the serial port to open
+			uart_line_ctrl_get(usb_dev, UART_LINE_CTRL_DTR, &dtr);
+			k_sleep(K_MSEC(100));
+		} while (!dtr);
+		enable_shell_usb();
 		return 0;
 	}
+#endif
 
 	int header_len = 16;
 
@@ -150,11 +173,26 @@ static int loader(const struct shell *sh)
 
 #if CONFIG_SHELL
 SHELL_CMD_REGISTER(sketch, NULL, "Run sketch", loader);
+
+#if DT_NODE_HAS_PROP(DT_PATH(zephyr_user), cdc_acm)
+static int enable_shell_usb(void)
+{
+	bool log_backend = CONFIG_SHELL_BACKEND_SERIAL_LOG_LEVEL > 0;
+	uint32_t level =
+		(CONFIG_SHELL_BACKEND_SERIAL_LOG_LEVEL > LOG_LEVEL_DBG) ?
+		CONFIG_LOG_MAX_LEVEL : CONFIG_SHELL_BACKEND_SERIAL_LOG_LEVEL;
+	static const struct shell_backend_config_flags cfg_flags =
+					SHELL_DEFAULT_BACKEND_CONFIG_FLAGS;
+
+	shell_init(shell_backend_uart_get_ptr(), usb_dev, cfg_flags, log_backend, level);
+
+	return 0;
+}
+#endif
 #endif
 
 int main(void)
 {
 	loader(NULL);
 	return 0;
-}
-
+}

west.yml

@@ -44,4 +44,4 @@ manifest:
     - name: ArduinoCore-API
       path: modules/lib/ArduinoCore-API
       revision: master
-      url: git@github.com:arduino/ArduinoCore-API
+      url: https://github.com/arduino/ArduinoCore-API