MicroZig Documentation

The virtual-io module provides a Zig I/O implementation that simulates a file system entirely in RAM. It is designed for testing or environments where disk access is undesirable or unavailable.

Key characteristics:

• In-Memory Storage: All I/O operations that would normally touch the disk are redirected to RAM, backed by a hash map.
• Directory Structure: It maintains a simulated directory structure and file contents within the hash map.
• Strict Isolation: Any I/O operation that cannot be satisfied within the RAM-backed structure will fail.

regz is a Zig code generator designed for microcontrollers. It converts vendor-provided register description files—such as ARM's System View Description (SVD) or AVR's ATDF—into a single Zig file. This generated file allows you to interact with hardware registers using a type-safe, structured API.

const regs = @import("nrf52.zig").registers;

pub fn main() void {
    regs.P0.PIN_CNF[17].modify(.{
        .DIR = 1,
        .INPUT = 1,
        .PULL = 0,
        .DRIVE = 0,
        .SENSE = 0,
    });
    regs.P0.OUT.modify(.{ .PIN17 = 1 });
}

The port/nordic/nrf5x directory provides Hardware Abstraction Layers (HALs) and register definitions specifically for Nordic nRF5x series devices. This port is designed to facilitate embedded development on these chips using Zig.

Currently, Renode emulation support is available for the nrf52840 development kit.

Sorcerer is a suite of tools designed for visualizing and generating MicroZig register definitions. It supports SVD, ATDF, and Embassy formats and uses regz to generate type-safe Zig code. It consists of two main components:

• Sorcerer (GUI): A graphical application for browsing, editing, and searching register definitions, viewing generated Zig code, and managing patch files.
• sorcerer-cli: A lightweight command-line tool for generating register code without GUI dependencies.

The NXP MCX port includes the following example projects:

• Blinky (src/blinky.zig): A basic LED blink example.
• GPIO input (src/gpio_input.zig): An example that toggles an LED upon a button press.

This port provides Hardware Abstraction Layer (HAL) and register definitions for the NXP MCX series microcontrollers.

Supported Hardware: Currently, only the MCXA153 is supported.

Data Source: Register definitions are derived from the official NXP MCUXpresso SVD files located at: https://github.com/nxp-mcuxpresso/mcux-soc-svd/.

Demos for the raspberrypi-rp2xxx BSP are categorized by hardware compatibility:

• Chip Agnostic: Code that runs on both RP2040 (Pico 1) and RP2350 (Pico 2) without modification (e.g., watchdog timer, USB device, basic blinky).
• RP2040 Only: Examples utilizing features or HAL functionality currently specific to the RP2040 (e.g., ADC, I2C bus scan, SPI host, PIO square wave).
• RP2350 Only: Reserved for future features unique to the RP2350 (e.g., HSTX).
• CYW43: Specific to wireless boards (Pico W and Pico2 W) because the LED is driven via the CYW43 wireless chip rather than standard GPIO.

Note: All demos compatible with the standard Pico are also compatible with the RP2040-Plus without modification.