Benjamin Cabé

Zephyr 3.5 has been out for a week (here’s the announcement blog post if you missed it!), and earlier this week we celebrated the release by having a live stream where many maintainers as well as our release managers Fabio and Johan joined me to discuss some of the additions to 3.5.

Catch up with the recording on YouTube, and consider subscribing to the channel if you haven’t already to be notified of upcoming videos and live streams.

The main development branch is now open again, so it’s time for for this week’s update!

Documentation improvements

• I have said it many times and will say it again: you don’t have to contribute code to help make Zephyr better! Helping us improve our documentation is also highly appreciated 🙂
  
  When browsing docs.zephyrproject.org you now have the opportunity to directly open an issue regarding the documentation page you are currently browsing.
  
  Furthermore, the page footer now indicates the last time someone updated the contents of a page. This can give you a hint about how up-to-date the information you are reading is.

• In an effort to better document all the APIs in Zephyr, a new CI task is generating a documentation coverage report for all the public headers.
  
  All contributors and maintainers are encouraged to look at the report to see if there’s areas where Doxygen comments might be missing. Reports are generated for each pull request (e.g. https://builds.zephyrproject.io/zephyr/pr/12345/api-coverage/) and are also available for main here: https://docs.zephyrproject.org/api-coverage/latest/.

New configdefault Kconfig keyword

In order to make it easier for developers to define custom default values downstream without needing to re-specify dependencies of the symbols they which to “override”, a new configdefault extension to Kconfig allows to do just that.

Jordan Yates, who contributed this extension, shared the following example which I think is pretty self-explanatory:

config MY_COMPANY_APPS
    bool "Apply defaults for internal applications"

configdefault BT
     default y if MY_COMPANY_APPS
configdefault MCUMGR
    default y if MY_COMPANY_APPS && BT

See PR #51316 for more background and details, as well as Zephyr documentation.

west 1.2.0

A new 1.2.0 version of west was released ahead of Zephyr 3.5.0, and I wanted to call out a welcome addition to the list of commands.

west grep allows you to… well… grep for content across your entire workspace. This can be really useful when you want to look for something both in the Zephyr codebase and in the various HALs (or any other module really).

More at https://github.com/zephyrproject-rtos/west/releases/tag/v1.2.0

Boards & SoCs

• The DA14695 Development Kit USB is a low cost development board for DA14695 MCU from Renesas. (PR #60086)
• The DSP core of NXP MIMXRT595-EVK is now supported. (PR #61356)
• The Panasonic PAN1783 evaluation board is a development board for the nRF5340 from Nordic Semiconductor. (PR #63104)

• The MikroElektronika ACCEL 13 Click shield is now supported. It features an IIS2DLPC ultra-low power 3-axis accelerometer sensor in a mikroBUS form factor. (PR #63297)
• Added RTC driver for Atmel SAM series. (PR #63962)
• Added CAN controller driver added for Nuvoton numaker series. (PR #64018)
• Added crypto and RTC drivers for Renesas Smartbond. (PR #60238, #63983)

Drivers

• Several LCD displays from SparkFun expose a so-called SerLCD interface, and there is now an auxiliary display driver available for them. (PR #61445)
• Driver added for MEMSIC MC3419 3-axis accelerometer sensor. (PR #62095)
• Some AMD SoCs feature a temperature sensor that can be accessed using a “Sideband Temperature Sensor Interface” (SB-TSI in short). A new driver has been added with PR #60818.
• The ADXL367 is an ultra-low power, 3-axis accelerometer that consumes only 0.89 μA at a 100 Hz output data rate and 180 nA when in motion-triggered wake-up mode! You will have guessed that it now has a driver, added with PR #63800. 🙂 Note that both SPI and I2C are available.
• Introduced new battery charging properties (ex. “health”, precharge current”, …) and support for the BQ24190 from Texas Instruments. (PR #62551)

Miscellaneous

• In Devicetree, a parent node now “inherits” all dependencies from its child nodes. (PR #62417)
• CoAP library now supports echo and request-tag from RFC9175. (PR #63913)
• The handling of unexpected TCP packets within Zephyr’s TCP stack has been improved. A reset (RST) packet is now sent in response to unexpected TCP packets. (PR #64029)
• Network sockets now leverage the recently introduced “object cores”. You may use the net sockets shell command to access socket information and statistics. (PR #63339)
• IPv4-to-IPv6 mapping is now supported. (PR #63579)

A big thank you to the 24 individuals who had their first pull request accepted since my last post, 💙 🙌: @TomzBench, @karthi012, @marnold-b, @davedesro, @mimbriani, @dennisgr102, @pkoscik, @augustozanellato, @yf13, @Spice-Weasel, @jpmur, @martincalsyn, @nandogalliard, @yeweizy, @mgritz, @pres2300, @photonthunder, @sousapedro596, @FranciszekPin, @Alex-T-Stark, @quic-lingutla, @hlukasz, @arun-mani-tech, and @akaiserUS.

As always, I very much welcome your thoughts and feedback in the comments below!

If you enjoyed this article, don’t forget to subscribe to this blog to be notified of upcoming publications! And of course, you can also always find me on Twitter and Mastodon.

Catch up on all previous issues of the Zephyr Weekly Update:

Apologies for missing last week’s update. Last Friday was the feature freeze for Zephyr 3.5 and everyone, including myself, was pretty busy trying to push everything over the finish line!

Because of the feature freeze, no significant changes happened in the last week, so this update will still pretty much feel like a “weekly”, I guess 🙂 I will try to keep it short (…ish) since I am preparing a full write-up about what’s new in Zephyr 3.5, and I don’t want to spoil all the fun! I would also like to apologize to the Bluetooth contributors and maintainers in particular as I’m pretty sure I am missing important stuff — I definitely spotted lots of stabilization and bug fixing but if I forgot something important, please let me know in the comments or on Discord!

Also, remember to join Peter and me next Wednesday, Oct. 11, for our 3rd Zephyr Tech Talk, where we’ll discuss everything you need to know about Renode! I’d actually recommend you “RSVP” on LinkedIn, as this is the best way to make sure you will get a reminder as we go live. You can also of course spread the word in your network, if you feel like it.

Linkable loadable extensions (llext)

The newly introduced Linkable Loadable Extensions (llext) subsystem makes it possible to dynamically extend the functionality of an application at runtime. Extensions can be loaded from pre-compiled ELF formatted data which is verified, loaded, and linked with other extensions.

As often, an example is worth a thousand words and I encourage you to use the llext shell commands to get a feel of what it’s all about. A dedicated sample will give you all the instructions you need to build a “Hello World” binary, and then dynamically load it and invoke it using shell commands (there is even a command to load the hex-encoded binary, so you can actually do the whole thing without leaving your Zephyr shell!).

uart:~$ llext help
llext - Loadable extension commands
Subcommands:
  list          :List loaded extensions and their size in memory
  load_hex      :Load an elf file encoded in hex directly from the shell input.
                 Syntax:
                 <ext_name> <ext_hex_string>
  unload        :Unload an extension by name. Syntax:
                 <ext_name>
  list_symbols  :List extension symbols. Syntax:
                 <ext_name>
  call_fn       :Call extension function with prototype void fn(void). Syntax:
                 <ext_name> <function_name>

I am really excited about what’s going to come next now that one of the most requested feature since many years is basically unlocked. There’s still a lot that needs to be done (as an example, in this initial version, one may need to disable memory protection for llext to work…) but that makes things even more exciting! (PR #57086)

Binary descriptors

Binary descriptors are a new feature that makes it super simple to describe data objects (think: “model number” of your device, “kernel version”, etc.) that end up being linked at a known offset in your binary.

Like I just said, binary descriptors are really easy to use:

#include <zephyr/bindesc.h>

BINDESC_STR_DEFINE(app_version, BINDESC_ID_APP_VERSION_STRING, "1.2.3");

“Standard” binary descriptors such as build time, or kernel version, can be enabled without having to change anything in your code, just by enabling the dedicating Kconfig options.

A new west bindesc command has been introduced to allow developers to read binary descriptors in .bin, .hex, .elf, or .uf2 binary files.

You may want to check out the new code sample to familiarize yourself with the different macros and tools surrounding binary descriptors.

(PR #54464)

Object cores

Object cores are a new kernel debugging tool that can be used to both identify and perform operations on registered objects.

Kernel objects such as semaphores, message queues, etc. may now (if enabled via the dedicated CONFIG_OBJ_CORE_ * Kconfig options) embed a new “object core” that can be used to gather and access all sorts of statistics about the object.

The documentation page for this new feature is quite frankly excellent, so I would recommend you check it out as it’s gonna do a better job than I ever will at explaining things!

(PR #59075)

Boards & SoCs

• As everyone is talking about the Raspberry Pi 5 these days, this will likely not get all the attention it deserves, but did you know that Zephyr now supports Raspberry Pi 4 Model B?
  It is very early stage and very few peripherals are supported at the moment, but the idea of being able to run Zephyr on an MPU board that many people already have handy is very cool. And it’s always nice to see new Arm64 SoCs and boards being added!
  (PR #62320).
• Support for Nucleo U5A5ZJ-Q was added. As a reminder the U5 series features Arm® Cortex®-M33 cadenced at up to 160 MHz, and the “U” stands for ultra low-power 🙂 (PR #63144)

Drivers

• Added TMAG5170 3d Hall effect sensor driver. It is a pretty complete driver with power management, CRC-based error detection, trigger mode, … so you may want to bookmark it for next time you need to write a sensor driver! (PR #61346)
• New HM330X particle sensor driver. I actually wrote this driver as it’s a sensor that I’ve been using to monitor dust levels in my pottery studio. It’s proven to be very accurate and reliable even when running 24/7 which, to be honest, is not always the case for “cheap” maker-oriented sensors. I think it might have been my first sensor driver contribution to the project, and I have to admit it went pretty smoothly! (PR #62786)
• New Microchip CAN-FD MCP251xFD driver, “an important addition to the existing range of Zephyr CAN drivers” to quote Brix, one of the maintainer of the CAN subsytem. (PR #59968)
• New DMA driver for NXP SMARTDMA. This IP is is a custom peripheral intended for graphics acceleration on the NXP RT595 (PR #57616)
• STM32 I2C driver now supports 10-bit addressing (PR #60620)
• RTC driver for STM32 now supports sub-second ticks (note that this increases power consumption). (PR #61580)
• New PWM pulse capture driver for S32K344. (PR #62695)
• Added eDMA support for S32K344. (PR #61311)
• New bit-bang driver for MDIO. (PR #56679)
• New ALTERA Parallel I/O (PIO) driver. It supports calibration, setting/getting alarms, and alarm callbacks. (PR #61162)
• New Ambiq AM1805 RTC driver. (PR #62357)
• Support has been added for Intel eMMC host controller. (PR #61108)
• New vertical decoder API for decoding sensor data. (PR #61022)
• adc_read_dt() function to read from an ADC by providing a Devicetree node . (PR #63010)

Miscellaneous

• When using MCUboot, the Kconfig option CONFIG_MCUBOOT_BOOTLOADER_NO_DOWNGRADE allows an application to know whether downgrade prevention is enabled. (PR #63053)
• New Bluetooth code sample for HCI UART using the Async API. (PR #59880)
• LwM2M client now supports CoAP blockwise transfer for GET and FETCH operations. (PR #61858)
• New ICMP API to allow applications to send and receive IPv4 or IPv6 ICMP Echo Request messages. (PR #62942)
• The obsolete neural_net driver and experimental Gaussian & Neural Accelerator API have been removed. (PR #62796 and #63300)
• You can now test the WebUSB code sample directly from the Zephyr documentation. (PR #62420)

A big thank you to the 21 individuals who had their first pull request accepted in the past 2 weeks, 💙 🙌: @moritzstoetter, @ivaniushkov, @fkwasowi, @nik012003, @meshium, @jandriea, @hlord2000, @wouterh, @srisurya1, @JeroenReeskamp, @bjda, @Fladdan, @zohavas, @lifenggitacc, @dcorbeil, @stasys0, @AirChandler, @lindblandro, @graffiti, @rahul-sin, and @tbr-tt.

As always, I very much welcome your thoughts and feedback in the comments below. See you in two weeks, as I don’t think next week will see any noteworthy update as the final release approaches.

If you enjoyed this article, don’t forget to subscribe to this blog to be notified of upcoming publications! And of course, you can also always find me on Twitter and Mastodon.

Catch up on all previous issues of the Zephyr Weekly Update:

There is one week to go until the feature freeze for Zephyr 3.5, and also just about a week to participate in this year’s Zephyr Developer survey.

Whether you are using Zephyr for work or just for a pet project, we’d love to hear from you and understand what you love about the project and the community, and what you’d want to see improved. I promise it should take you less than 10 minutes to fill out, and your input will be incredibly useful to shape the future of the project.

Understanding and troubleshooting initialization levels

Understanding initialization levels and how all the various drivers “light up” when a Zephyr application starts can be pretty intimidating.

That’s why you will likely appreciate the introduction of a new tool making things very visual when it comes to the bootstrapping of your application.

The new initlevels target in west gives you a quick way to dump the list of init functions that are being called at each stage of the booting process. (PR #62459)

Let’s say I want to use this with the newly added LVGL demo apps, running on an M5Stack Core2.

 west build -t initlevels -p -b m5stack_core2 -s .\samples\modules\lvgl\demos\ --  -DCONFIG_LV_Z_DEMO_MUSIC=y

The output would be as follows, giving me a good overview of when each driver is kicking in, and making it easier to spot potential bugs in the bootstrap sequence of my application.

EARLY
PRE_KERNEL_1
  __init___device_dts_ord_5: clock_control_esp32_init(__device_dts_ord_5)
  __init_statics_init_pre: statics_init(NULL)
  __init___device_dts_ord_11: gpio_esp32_init(__device_dts_ord_11)
  __init___device_dts_ord_13: gpio_esp32_init(__device_dts_ord_13)
  __init___device_dts_ord_58: entropy_esp32_init(__device_dts_ord_58)
  __init___device_dts_ord_61: uart_esp32_init(__device_dts_ord_61)
  __init_uart_console_init: uart_console_init(NULL)
PRE_KERNEL_2
  __init_sys_clock_driver_init: sys_clock_driver_init(NULL)
POST_KERNEL
  __init_enable_logger: enable_logger(NULL)
  __init_enable_shell_uart: enable_shell_uart(NULL)
  __init_malloc_prepare: malloc_prepare(NULL)
  __init_k_sys_work_q_init: k_sys_work_q_init(NULL)
  __init___device_dts_ord_12: i2c_esp32_init(__device_dts_ord_12)
  __init___device_dts_ord_25: mfd_axp192_init(__device_dts_ord_25)
  __init___device_dts_ord_84: spi_esp32_init(__device_dts_ord_84)
  __init___device_dts_ord_80: regulator_axp192_init(__device_dts_ord_80)
  __init___device_dts_ord_81: regulator_axp192_init(__device_dts_ord_81)
  __init___device_dts_ord_82: regulator_axp192_init(__device_dts_ord_82)
  __init___device_dts_ord_85: regulator_axp192_init(__device_dts_ord_85)
  __init___device_dts_ord_26: gpio_axp192_init(__device_dts_ord_26)
  __init_gpio_hogs_init: gpio_hogs_init(NULL)
  __init___device_dts_ord_86: ili9xxx_init(__device_dts_ord_86)
  __init___device_dts_ord_14: ft5336_init(__device_dts_ord_14)
  __init___device_dts_ord_15: NULL(__device_dts_ord_15)
APPLICATION
  __init_lvgl_init: lvgl_init(NULL)

Running LVGL demos is now (much) easier!

Thanks to Fabian’s excellent work in PR #62904, running one of the default LVGL ‘demo’ apps has become significantly easier this week.

Check out the instructions of the newly added code sample to get started in no time. It’s really exciting to see all the improvements being made around all things GUI recently!

By the way, in case you didn’t know, LVGL code can also run in an HTML canvas, which I find really cool.

Boards & SoCs

• MPU/MMU-based stack guard is now enabled on ARM64. If you enable CONFIG_ARM64_STACK_PROTECTION, the system will trigger a fatal error if the current process stack overflows. This is done by preceding all stack areas with a fixed guard region. (PR #62902)
• The Nuvoton NPCX7M6FB evaluation board is a development platform to for Nuvoton NPCX7 series of microcontrollers. It features an Arm Cortex-M4F MCU, with 256 KB RAM / 64 KB ROM — now supported! (PR #62799)

Drivers

• hwinfo driver is now available for TI SimpleLink CC13xx/CC26xx series. It allows to retrieve the device ID and to access the cause of reset. (PR #62537)
• STMPE811 touch controller is now supported. (PR #61826)
• RAM disk driver (which I didn’t know Zephyr had until today!) can now be easily configured directly via Devicetree. It now also supports multiple instances. (PR #60149)

/ {
	ramdisk0 {
		compatible = "zephyr,ram-disk";
		disk-name = "RAM";
		sector-size = <512>;
		sector-count = <192>;
	};
};

• The MCAN driver now supports statistics. It can be enabled using Kconfig CONFIG_CAN_STATS. (PR #62758)
• New driver for NXP VREF. (PR #56822)
• LTC2990 Quad I2C Voltage, Current and Temperature Monitor (no less!) from Analog Devices is now supported. (PR #60842)
• On all STM32 ADC, it is no longer possible to read sensor channels (Vref, Vbat or temperature) using the ADC driver, and the dedicated sensor driver should be used instead. (PR #62345)
• The driver for the LIS2DH accelerometer can now trigger an interrupt when a single tap is detected. (PR #62498)
• Various improvements to the NVMe disk driver. (PR #62820)

Miscellaneous

• When using the modem subsystem to describe “chat scripts” (ex. “If I send you this AT command, I’m interested in capturing this portion of your response”), you can now dynamically create chat scripts.
  This makes it possible to adapt to the runtime conditions, as the parameters of the various commands, or the expected responses, might not always be known at build time. (PR #62703)
  By the way, don’t forget to join us on Wednesday for our second episode of the Zephyr Tech Talks, as this will be your chance to learn more about the new modem subsystem from its author 🙂
• A new lwm2m create shell command makes it easy to create and register new LWM2M objects on the fly. (PR #62869)
  Note to self: I need to prepare some demos around using LWM2M with Zephyr at some point 🙂
• If you’re using the USB Device stack for building some kind of audio gadget, you can now expose volume control functionality to the host. (PR #60973)
• SO_REUSEADDR and SO_REUSEPORT socket options are now supported, making it possible to have multiple sockets bound to the same local IP-port combination (PR #61885)
• The shell commands settings read and settings write now accept an optional ‘type’ argument. Ex:

settings write string foo bar
settings write hex key2 c0ffee

A big thank you to the 9 individuals who had their first pull request accepted this week, 💙 🙌: @raitraak-rrk, @kapbh, @iandmorris, @gwa-storck, @kunoh, @icsys-aal, @aaronyegx, @SawXu, and @TaiJuWu.

As always, please feel free to jump in with your thoughts or questions in the comments below. See you next week!

If you enjoyed this article, don’t forget to subscribe to this blog to be notified of upcoming publications! And of course, you can also always find me on Twitter and Mastodon.

Catch up on all previous issues of the Zephyr Weekly Update: