treewide: Merge remote-tracking branch 'arduino/main' into reunite-with-arduino-repo

Conflicts:
	.gitignore
	CMakeLists.txt
	README.md
	cores/arduino/Arduino.h
	cores/arduino/main.cpp
	cores/arduino/zephyrCommon.cpp
	cores/arduino/zephyrPrint.cpp
	cores/arduino/zephyrPrint.h
	cores/arduino/zephyrSerial.cpp
	cores/arduino/zephyrSerial.h
	documentation/variants.md
	samples/analog_input/CMakeLists.txt
	samples/attach_interrupt/CMakeLists.txt
	samples/blinky_arduino/CMakeLists.txt
	samples/button_press_led/CMakeLists.txt
	samples/fade/CMakeLists.txt
	samples/hello_arduino/CMakeLists.txt
	samples/i2cdemo/CMakeLists.txt
	samples/serial_event/CMakeLists.txt
	samples/spi_controller/CMakeLists.txt
	samples/threads_arduino/CMakeLists.txt
	variants/arduino_nano_33_ble_nrf52840_sense/variant.h
	west.yml

Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>

Author: soburi

.gitignore

@@ -1 +1,11 @@
+/build/
+/distrib/
+/firmwares/*
+/venv/
+llext-edk/
+cflags.txt
+cxxflags.txt
+includes.txt
+syms-dynamic.ld
+syms-static.ld
 rust/Cargo.lock

CMakeLists.txt

@@ -13,9 +13,11 @@ if (CONFIG_ARDUINO_API)
     set(variant_dir variants/default)
   endif()
 
-  add_subdirectory(cores)
-  add_subdirectory(libraries)
-  zephyr_include_directories(${variant_dir})
+  if (CONFIG_ARDUINO_API AND NOT CONFIG_LLEXT)
+    add_subdirectory(cores)
+    add_subdirectory(libraries)
+    zephyr_include_directories(${variant_dir})
+  endif()
 
   if (CONFIG_USE_ARDUINO_API_RUST_IMPLEMENTATION)
     # quote from https://github.com/zephyrproject-rtos/zephyr-lang-rust/blob/main/CMakeLists.txt

Kconfig

@@ -42,3 +42,23 @@ config ARDUINO_MAX_TONES
 	  If set to a negative value, the maximum number will be determined from the
 	  system's digital pin configuration.
 endif
+
+if USB_DEVICE_STACK_NEXT
+
+config USB_DEVICE_PRODUCT
+	string "USB Device Product"
+	default "Arduino Generic board"
+
+config USB_DEVICE_MANUFACTURER
+	string "USB Device Manufacturer"
+	default "Arduino"
+
+config USB_DEVICE_VID
+	hex "USB Device Vendor ID"
+	default 0x2341
+
+config USB_DEVICE_PID
+	hex "USB Device Product ID"
+	default 0x0001
+
+endif

README.gsoc.md

@@ -0,0 +1,55 @@
+# GSoC 2022 Project: Arduino Core API module for Zephyr
+
+![](https://dhruvag2000.github.io/Blog-GSoC22/assets/images/website_header.png)
+
+The **Arduino Core API** module for zephyr leverages the power of Zephyr under an Arduino-C++ style abtraction layer thus helping zephyr new-comers to start using it without worrying about learning about new APIs and libraries. See the project documentation folder for detailed documentation on these topics:
+
+* [Using external Arduino Libraries](/documentation/arduino_libs.md)
+* [Adding custom boards/ variants](/documentation/variants.md)
+
+## Adding Arduino Core API to Zephyr
+
+* **Pre requisites:** It is assumed that you have zephyrproject configured and installed on your system as per the official [Get Started Guide](https://docs.zephyrproject.org/latest/develop/getting_started/index.html). The recommended path to install is `~/zephyrproject` as specified in the guide. If you have zephyr installed in a custom path you may need to make changes to the CMakeLists.txt file in the sample code directory when building these samples.
+
+* Add following entry to `west.yml` file in `manifest/projects` subtree of Zephyr:
+```
+# Arduino API repository.
+- name: Arduino-Core-Zephyr
+  path: modules/lib/Arduino-Zephyr-API
+  revision: main
+  url: https://github.com/zephyrproject-rtos/gsoc-2022-arduino-core
+```
+
+* Then, clone the repository by running
+
+```sh
+west update
+```
+
+* **Note:** For ***Linux users only*** there exists an ``install.sh`` script in this project that can be run to quickly link the ArduinoCore-API to this module.
+If you are able to run that script successfully then you can skip the next steps.
+
+* To "complete" the core you need to copy or symlink the api folder from the [ArduinoCore-API](https://github.com/arduino/ArduinoCore-API.git) repo to the target's ``cores/arduino`` folder:
+```sh
+$ git clone git@github.com:arduino/ArduinoCore-API # Any location
+$ ln -s /<your>/<location>/ArduinoCore-API/api cores/arduino/.
+```
+The `cores` folder can be found at `~/zephyrproject/modules/lib/Arduino-Zephyr-API/cores`.
+
+**Known Bug(s):**
+
+__NOTE:__ You can skip this step as well if you ran ``install.sh``.
+
+**Maintainers**:
+- [DhruvaG2000](https://github.com/DhruvaG2000)
+- [soburi](https://github.com/soburi)
+- [szczys](https://github.com/szczys)
+- [beriberikix](https://github.com/beriberikix)
+- [alvarowolfx](https://github.com/alvarowolfx)
+
+## License
+Please note that the current license is Apache 2. Previously it was LGPL 2.1 but after careful review it was determined that no LGPL code or derivates was used and the more permissive license was chosen.
+
+**Additional Links**
+* [Official Project Blog](https://dhruvag2000.github.io/Blog-GSoC22/)
+* Golioth's Article: [Zephyr + Arduino: a Google Summer of Code story](https://blog.golioth.io/zephyr-arduino-a-google-summer-of-code-story/)

cores/arduino/Arduino.h

@@ -12,12 +12,16 @@
 #include <zephyr/drivers/gpio.h>
 #include <zephyr/drivers/pwm.h>
 #include <zephyr/drivers/adc.h>
+#include <zephyr/drivers/dac.h>
 #include <zephyr/drivers/i2c.h>
+#include <math.h>
 
+#if DT_PROP_LEN(DT_PATH(zephyr_user), digital_pin_gpios) > 0
+/* Note: DT_REG_ADDR needs an expanded argument or it will not work properly */
+#define DIGITAL_PIN_MATCHES(dev_pha, pin, dev, num)                                                \
+	(((dev == DT_REG_ADDR(dev_pha)) && (num == pin)) ? 1 : 0)
 #define DIGITAL_PIN_EXISTS(n, p, i, dev, num)                                                      \
-	(((dev == DT_REG_ADDR(DT_PHANDLE_BY_IDX(n, p, i))) && (num == DT_PHA_BY_IDX(n, p, i, pin))) ?  \
-		 1 :                                                                                       \
-		 0)
+	DIGITAL_PIN_MATCHES(DT_PHANDLE_BY_IDX(n, p, i), DT_PHA_BY_IDX(n, p, i, pin), dev, num)
 
 /* Check all pins are defined only once */
 #define DIGITAL_PIN_CHECK_UNIQUE(i, _)                                                             \
@@ -31,6 +35,12 @@
 #endif
 
 #undef DIGITAL_PIN_CHECK_UNIQUE
+#endif
+
+// Helper macro to get Arduino pin number from device tree alias
+#define DIGITAL_PIN_GPIOS_FIND_NODE(node)                                                          \
+	DIGITAL_PIN_GPIOS_FIND_PIN(DT_REG_ADDR(DT_PHANDLE_BY_IDX(node, gpios, 0)),                     \
+							   DT_PHA_BY_IDX(node, gpios, 0, pin))
 
 /* Return the index of it if matched, oterwise return 0 */
 #define LED_BUILTIN_INDEX_BY_REG_AND_PINNUM(n, p, i, dev, num)                                     \
@@ -79,7 +89,9 @@
  * enum digitalPins { D0, D1, ... LED... NUM_OF_DIGITAL_PINS };
  */
 enum digitalPins {
+#if DT_PROP_LEN(DT_PATH(zephyr_user), digital_pin_gpios) > 0
 	DT_FOREACH_PROP_ELEM_SEP(DT_PATH(zephyr_user), digital_pin_gpios, DN_ENUMS, (, )),
+#endif
 	NUM_OF_DIGITAL_PINS
 };
 
@@ -93,19 +105,53 @@ enum analogPins {
 	DT_FOREACH_PROP_ELEM(DT_PATH(zephyr_user), adc_pin_gpios, AN_ENUMS)
 };
 
+// We provide analogReadResolution APIs
+void analogReadResolution(int bits);
+
+#endif
+
+#ifdef CONFIG_DAC
+
+#undef DAC0
+#undef DAC1
+#undef DAC2
+#undef DAC3
+#define DAC_ENUMS(n, p, i) DAC##i = i,
+
+enum dacPins {
+	DT_FOREACH_PROP_ELEM(DT_PATH(zephyr_user), dac_channels, DAC_ENUMS) NUM_OF_DACS
+};
+
 #endif
 
 void interrupts(void);
 void noInterrupts(void);
 
 int digitalPinToInterrupt(pin_size_t pin);
 
+#define digitalPinToPort(x)    (x)
+#define digitalPinToBitMask(x) (x)
+#define portOutputRegister(x)  (x)
+#define portInputRegister(x)   (x)
+
+void analogReadResolution(int bits);
+void analogWriteResolution(int bits);
+
 #include <variant.h>
 
 #if !defined(LED_BUILTIN) && defined(ZARD_LED_BUILTIN)
 #define LED_BUILTIN ZARD_LED_BUILTIN
 #endif // LED_BUILTIN
 
 #ifdef __cplusplus
+#include <SerialUSB.h>
 #include <zephyrSerial.h>
+#include <strings.h>
+#include <api/itoa.h>
+#include <time_macros.h>
+#include <overloads.h>
+
+// Allow namespace-less operations if Arduino.h is included
+using namespace arduino;
+
 #endif // __cplusplus

cores/arduino/CMakeLists.txt

@@ -13,6 +13,8 @@ if(NOT DEFINED ARDUINO_BUILD_PATH)
 
 zephyr_sources(zephyrSerial.cpp)
 zephyr_sources(zephyrCommon.cpp)
+zephyr_sources(USB.cpp)
+zephyr_sources(itoa.cpp)
 
 if(CONFIG_USE_ARDUINO_API_RUST_IMPLEMENTATION)
   zephyr_sources(zephyrPrint.cpp)
@@ -21,6 +23,7 @@ endif()
 
 if(DEFINED CONFIG_ARDUINO_ENTRY)
 zephyr_sources(main.cpp)
+zephyr_sources(threads.cpp)
 endif()
 
 endif()

cores/arduino/SerialUSB.h

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) Arduino s.r.l. and/or its affiliated companies
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include <zephyrSerial.h>
+
+#if defined(CONFIG_USB_DEVICE_STACK_NEXT)
+#include <zephyr/usb/usbd.h>
+extern "C" struct usbd_context *usbd_init_device(usbd_msg_cb_t msg_cb);
+#endif
+
+namespace arduino {
+
+class SerialUSB_ : public ZephyrSerial {
+
+public:
+	SerialUSB_(const struct device *dev) : ZephyrSerial(dev) {
+	}
+
+	void begin(unsigned long baudrate, uint16_t config);
+
+	void begin(unsigned long baudrate) {
+		begin(baudrate, SERIAL_8N1);
+	}
+
+	operator bool() override;
+	size_t write(const uint8_t *buffer, size_t size) override;
+
+	size_t write(const uint8_t data) override {
+		return write(&data, 1);
+	}
+
+	void flush() override;
+
+protected:
+	uint32_t dtr = 0;
+	uint32_t baudrate;
+	static void baudChangeHandler(const struct device *dev, uint32_t rate);
+
+private:
+	bool started = false;
+
+#if defined(CONFIG_USB_DEVICE_STACK_NEXT)
+	struct usbd_context *_usbd;
+	int enable_usb_device_next();
+	static void usbd_next_cb(struct usbd_context *const ctx, const struct usbd_msg *msg);
+	static int usb_disable();
+#endif
+};
+} // namespace arduino
+
+#if (DT_NODE_HAS_PROP(DT_PATH(zephyr_user), cdc_acm) &&                                            \
+	 (CONFIG_USB_CDC_ACM || CONFIG_USBD_CDC_ACM_CLASS))
+extern arduino::SerialUSB_ Serial;
+#endif

cores/arduino/USB.cpp

@@ -0,0 +1,110 @@
+/*
+ * Copyright (c) Arduino s.r.l. and/or its affiliated companies
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/devicetree.h>
+#include <zephyr/drivers/uart.h>
+#include <zephyr/drivers/uart/cdc_acm.h>
+#include <zephyr/usb/usb_device.h>
+#include <SerialUSB.h>
+
+#if ((DT_NODE_HAS_PROP(DT_PATH(zephyr_user), cdc_acm)) &&                                          \
+	 (CONFIG_USB_CDC_ACM || CONFIG_USBD_CDC_ACM_CLASS))
+const struct device *const usb_dev =
+	DEVICE_DT_GET(DT_PHANDLE_BY_IDX(DT_PATH(zephyr_user), cdc_acm, 0));
+
+void __attribute__((weak)) _on_1200_bps() {
+	NVIC_SystemReset();
+}
+
+void arduino::SerialUSB_::baudChangeHandler(const struct device *dev, uint32_t rate) {
+	(void)dev; // unused
+	if (rate == 1200) {
+		usb_disable();
+		_on_1200_bps();
+	}
+}
+
+#if defined(CONFIG_USB_DEVICE_STACK_NEXT)
+int arduino::SerialUSB_::usb_disable() {
+	// To avoid Cannot perform port reset: 1200-bps touch: setting DTR to OFF: protocol error
+	k_sleep(K_MSEC(100));
+	return usbd_disable(Serial._usbd);
+}
+
+void arduino::SerialUSB_::usbd_next_cb(struct usbd_context *const ctx, const struct usbd_msg *msg) {
+	if (usbd_can_detect_vbus(ctx)) {
+		if (msg->type == USBD_MSG_VBUS_READY) {
+			usbd_enable(ctx);
+		}
+
+		if (msg->type == USBD_MSG_VBUS_REMOVED) {
+			usbd_disable(ctx);
+		}
+	}
+
+	if (msg->type == USBD_MSG_CDC_ACM_LINE_CODING) {
+		uint32_t baudrate;
+		uart_line_ctrl_get(Serial.uart, UART_LINE_CTRL_BAUD_RATE, &baudrate);
+		Serial.baudChangeHandler(nullptr, baudrate);
+	}
+}
+
+int arduino::SerialUSB_::enable_usb_device_next(void) {
+	int err;
+
+	_usbd = usbd_init_device(arduino::SerialUSB_::usbd_next_cb);
+	if (_usbd == NULL) {
+		return -ENODEV;
+	}
+
+	if (!usbd_can_detect_vbus(_usbd)) {
+		err = usbd_enable(_usbd);
+		if (err) {
+			return err;
+		}
+	}
+	return 0;
+}
+#endif /* defined(CONFIG_USB_DEVICE_STACK_NEXT) */
+
+void arduino::SerialUSB_::begin(unsigned long baudrate, uint16_t config) {
+	if (!started) {
+#ifndef CONFIG_USB_DEVICE_STACK_NEXT
+		usb_enable(NULL);
+#ifndef CONFIG_CDC_ACM_DTE_RATE_CALLBACK_SUPPORT
+#warning "Can't read CDC baud change, please enable CONFIG_CDC_ACM_DTE_RATE_CALLBACK_SUPPORT"
+#else
+		cdc_acm_dte_rate_callback_set(usb_dev, SerialUSB_::baudChangeHandler);
+#endif
+#else
+		enable_usb_device_next();
+#endif
+		ZephyrSerial::begin(baudrate, config);
+		started = true;
+	}
+}
+
+arduino::SerialUSB_::operator bool() {
+	uart_line_ctrl_get(uart, UART_LINE_CTRL_DTR, &dtr);
+	return dtr;
+}
+
+size_t arduino::SerialUSB_::write(const uint8_t *buffer, size_t size) {
+	if (!Serial) {
+		return 0;
+	}
+	return arduino::ZephyrSerial::write(buffer, size);
+}
+
+void arduino::SerialUSB_::flush() {
+	if (!Serial) {
+		return;
+	}
+	arduino::ZephyrSerial::flush();
+}
+
+arduino::SerialUSB_ Serial(usb_dev);
+#endif