Rough file architecture

ZigEmbeddedGroup · Sep 23, 2023 · 01287dd · 01287dd
1 parent 1087f58
commit 01287dd
Show file tree

Hide file tree

Showing 41 changed files with 1,773 additions and 25 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -11,6 +11,7 @@ jobs:
     strategy:
       matrix:
         os: [windows-latest, macos-latest, ubuntu-latest]
+        dir: espressif-esp  generic  gigadevice-gd32  microchip-atmega  nordic-nrf5x  nxp-lpc  rp2040  stmicro-stm32
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -21,4 +22,5 @@ jobs:
           version: 0.11.0
 
       - name: Build examples
+        working-directory: ${{ matrix.dir }}
         run: zig build
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,9 @@
 zig-cache/
-dev-scripts/
-zig-out
+zig-out/
+
+ezpkg.sh
+
+.vscode
+
 .envrc
+shell.nix
diff --git a/espressif-esp/blinky/blinky.zig b/espressif-esp/blinky/blinky.zig
@@ -0,0 +1,57 @@
+const std = @import("std");
+const microzig = @import("microzig");
+const peripherals = microzig.chip.peripherals;
+const TIMG0 = peripherals.TIMG0;
+const RTC_CNTL = peripherals.RTC_CNTL;
+const INTERRUPT_CORE0 = peripherals.INTERRUPT_CORE0;
+const GPIO = peripherals.GPIO;
+
+const dogfood: u32 = 0x50D83AA1;
+const super_dogfood: u32 = 0x8F1D312A;
+
+pub fn main() !void {
+    TIMG0.WDTWPROTECT.raw = dogfood;
+    TIMG0.WDTCONFIG0.raw = 0;
+    TIMG0.WDTWPROTECT.raw = 0;
+
+    RTC_CNTL.WDTWPROTECT.raw = dogfood;
+    RTC_CNTL.WDTCONFIG0.raw = 0;
+    RTC_CNTL.WDTWPROTECT.raw = 0;
+
+    RTC_CNTL.SWD_WPROTECT.raw = super_dogfood;
+    RTC_CNTL.SWD_CONF.modify(.{ .SWD_DISABLE = 1 });
+    RTC_CNTL.SWD_WPROTECT.raw = 0;
+
+    INTERRUPT_CORE0.CPU_INT_ENABLE.raw = 0;
+
+    microzig.hal.gpio.init(LED_R_PIN, .{
+        .direction = .output,
+        .direct_io = true,
+    });
+    microzig.hal.gpio.init(LED_G_PIN, .{
+        .direction = .output,
+        .direct_io = true,
+    });
+    microzig.hal.gpio.init(LED_B_PIN, .{
+        .direction = .output,
+        .direct_io = true,
+    });
+
+    microzig.hal.uart.write(0, "Hello from Zig!\r\n");
+
+    while (true) {
+        GPIO.OUT.modify(.{ .DATA_ORIG = (1 << LED_R_PIN) });
+        microzig.hal.uart.write(0, "R");
+        microzig.core.experimental.debug.busy_sleep(100_000);
+        GPIO.OUT.modify(.{ .DATA_ORIG = (1 << LED_G_PIN) });
+        microzig.hal.uart.write(0, "G");
+        microzig.core.experimental.debug.busy_sleep(100_000);
+        GPIO.OUT.modify(.{ .DATA_ORIG = (1 << LED_B_PIN) });
+        microzig.hal.uart.write(0, "B");
+        microzig.core.experimental.debug.busy_sleep(100_000);
+    }
+}
+
+const LED_R_PIN = 3; // GPIO
+const LED_G_PIN = 16; // GPIO
+const LED_B_PIN = 17; // GPIO
diff --git a/build.zig → espressif-esp/build.zig b/build.zig → espressif-esp/build.zig
diff --git a/espressif-esp/build.zig.zon b/espressif-esp/build.zig.zon
@@ -0,0 +1,14 @@
+.{
+    .name = "microzig-espressif-esp-examples",
+    .version = "0.1.0",
+    .dependencies = .{
+        .microzig = .{
+            .url = "https://github.com/ZigEmbeddedGroup/microzig/archive/c6c9ec4516f57638e751141085c9d76120990312.tar.gz",
+            .hash = "1220af58bdaa721b8189f3a7adfda660517dd354463463388e96d69fe4ceccf80b92",
+        },
+        .esp = .{
+            .url = "https://github.com/ZigEmbeddedGroup/espressif-esp/archive/59b8ca028915c0d6224ec88dbf4db19afbb559c0.tar.gz",
+            .hash = "1220f6e5f22416fdc63442cd8869fcaa35f9abf30d878ea3d80073176677dc6f8a65",
+        },
+    },
+}
diff --git a/ezpkg.sh b/ezpkg.sh
diff --git a/generic/build.zig b/generic/build.zig
@@ -0,0 +1,84 @@
+const std = @import("std");
+const rp2040 = @import("rp2040");
+const stm32 = @import("stm32");
+const lpc = @import("lpc");
+const gd32 = @import("gd32");
+const nrf5x = @import("nrf5x");
+const esp = @import("esp");
+const atmega = @import("atmega");
+
+pub fn build(b: *std.Build) void {
+    const microzig = @import("microzig").init(b, "microzig");
+    const optimize = b.standardOptimizeOption(.{});
+
+    const TargetDesc = struct {
+        target: @import("microzig").Target,
+        name: []const u8,
+    };
+
+    const available_targets = [_]TargetDesc{
+        // RP2040
+        .{ .name = "pico", .target = rp2040.boards.raspberry_pi.pico },
+        .{ .name = "rp2040-eth", .target = rp2040.boards.waveshare.rp2040_eth },
+        .{ .name = "rp2040-plus-4m", .target = rp2040.boards.waveshare.rp2040_plus_4m },
+        .{ .name = "rp2040-plus-16m", .target = rp2040.boards.waveshare.rp2040_plus_16m },
+        .{ .name = "rp2040-matrix", .target = rp2040.boards.waveshare.rp2040_matrix },
+
+        // STM32
+        .{ .name = "stm32f103x8", .target = stm32.chips.stm32f103x8 },
+        .{ .name = "stm32f303vc", .target = stm32.chips.stm32f303vc },
+        .{ .name = "stm32f407vg", .target = stm32.chips.stm32f407vg },
+        .{ .name = "stm32f429zit6u", .target = stm32.chips.stm32f429zit6u },
+        .{ .name = "stm32f3discovery", .target = stm32.boards.stm32f3discovery },
+        .{ .name = "stm32f4discovery", .target = stm32.boards.stm32f4discovery },
+        .{ .name = "stm3240geval", .target = stm32.boards.stm3240geval },
+        .{ .name = "stm32f429idiscovery", .target = stm32.boards.stm32f429idiscovery },
+
+        // NXP LPC
+        .{ .name = "lpc176x5x", .target = lpc.chips.lpc176x5x },
+        .{ .name = "mbed-lpc1768", .target = lpc.boards.mbed.lpc1768 },
+
+        // GigaDevice GD32
+        .{ .name = "gd32vf103xb", .target = gd32.chips.gd32vf103xb },
+        .{ .name = "gd32vf103x8", .target = gd32.chips.gd32vf103x8 },
+        .{ .name = "sipeed-longan_nano", .target = gd32.boards.sipeed.longan_nano },
+
+        // Nordic Nrf5x
+        .{ .name = "nrf52832", .target = nrf5x.chips.nrf52832 },
+        .{ .name = "nrf52840", .target = nrf5x.chips.nrf52840 },
+        .{ .name = "nrf52840-dongle", .target = nrf5x.boards.nordic.nRF52840_Dongle }, // TODO: Add support for DFU files!
+
+        // RISC-V Espressif ESP
+        .{ .name = "esp32-c3", .target = esp.chips.esp32_c3 }, // TODO: Add support for Espressif Update Binaries
+
+        // Microchip ATmega
+        // TODO: Fix compiler bugs
+        // - https://github.com/ziglang/zig/issues/17219
+        // .{ .name = "atmega328p", .target = atmega.chips.atmega328p },
+        // .{ .name = "arduino-nano", .target = atmega.boards.arduino.nano },
+        // .{ .name = "arduino-uno-rev3", .target = atmega.boards.arduino.uno_rev3 },
+    };
+
+    for (available_targets) |dest| {
+        // `addFirmware` basically works like addExecutable, but takes a
+        // `microzig.Target` for target instead of a `std.zig.CrossTarget`.
+        //
+        // The target will convey all necessary information on the chip,
+        // cpu and potentially the board as well.
+        const firmware = microzig.addFirmware(b, .{
+            .name = b.fmt("empty-{s}", .{dest.name}),
+            .target = dest.target,
+            .optimize = optimize,
+            .source_file = .{ .path = "src/empty.zig" },
+        });
+
+        // `installFirmware()` is the MicroZig pendant to `Build.installArtifact()`
+        // and allows installing the firmware as a typical firmware file.
+        //
+        // This will also install into `$prefix/firmware` instead of `$prefix/bin`.
+        microzig.installFirmware(b, firmware, .{});
+
+        // For debugging, we also always install the firmware as an ELF file
+        microzig.installFirmware(b, firmware, .{ .format = .elf });
+    }
+}
diff --git a/build.zig.zon → generic/build.zig.zon b/build.zig.zon → generic/build.zig.zon
@@ -1,5 +1,5 @@
 .{
-    .name = "microzig-examples",
+    .name = "microzig-generic-examples",
     .version = "0.1.0",
     .dependencies = .{
         .microzig = .{

diff --git a/src/blinky.zig → generic/src/blinky.zig b/src/blinky.zig → generic/src/blinky.zig
diff --git a/src/empty.zig → generic/src/empty.zig b/src/empty.zig → generic/src/empty.zig
diff --git a/gigadevice-gd32/build.zig b/gigadevice-gd32/build.zig
@@ -0,0 +1,84 @@
+const std = @import("std");
+const rp2040 = @import("rp2040");
+const stm32 = @import("stm32");
+const lpc = @import("lpc");
+const gd32 = @import("gd32");
+const nrf5x = @import("nrf5x");
+const esp = @import("esp");
+const atmega = @import("atmega");
+
+pub fn build(b: *std.Build) void {
+    const microzig = @import("microzig").init(b, "microzig");
+    const optimize = b.standardOptimizeOption(.{});
+
+    const TargetDesc = struct {
+        target: @import("microzig").Target,
+        name: []const u8,
+    };
+
+    const available_targets = [_]TargetDesc{
+        // RP2040
+        .{ .name = "pico", .target = rp2040.boards.raspberry_pi.pico },
+        .{ .name = "rp2040-eth", .target = rp2040.boards.waveshare.rp2040_eth },
+        .{ .name = "rp2040-plus-4m", .target = rp2040.boards.waveshare.rp2040_plus_4m },
+        .{ .name = "rp2040-plus-16m", .target = rp2040.boards.waveshare.rp2040_plus_16m },
+        .{ .name = "rp2040-matrix", .target = rp2040.boards.waveshare.rp2040_matrix },
+
+        // STM32
+        .{ .name = "stm32f103x8", .target = stm32.chips.stm32f103x8 },
+        .{ .name = "stm32f303vc", .target = stm32.chips.stm32f303vc },
+        .{ .name = "stm32f407vg", .target = stm32.chips.stm32f407vg },
+        .{ .name = "stm32f429zit6u", .target = stm32.chips.stm32f429zit6u },
+        .{ .name = "stm32f3discovery", .target = stm32.boards.stm32f3discovery },
+        .{ .name = "stm32f4discovery", .target = stm32.boards.stm32f4discovery },
+        .{ .name = "stm3240geval", .target = stm32.boards.stm3240geval },
+        .{ .name = "stm32f429idiscovery", .target = stm32.boards.stm32f429idiscovery },
+
+        // NXP LPC
+        .{ .name = "lpc176x5x", .target = lpc.chips.lpc176x5x },
+        .{ .name = "mbed-lpc1768", .target = lpc.boards.mbed.lpc1768 },
+
+        // GigaDevice GD32
+        .{ .name = "gd32vf103xb", .target = gd32.chips.gd32vf103xb },
+        .{ .name = "gd32vf103x8", .target = gd32.chips.gd32vf103x8 },
+        .{ .name = "sipeed-longan_nano", .target = gd32.boards.sipeed.longan_nano },
+
+        // Nordic Nrf5x
+        .{ .name = "nrf52832", .target = nrf5x.chips.nrf52832 },
+        .{ .name = "nrf52840", .target = nrf5x.chips.nrf52840 },
+        .{ .name = "nrf52840-dongle", .target = nrf5x.boards.nordic.nRF52840_Dongle }, // TODO: Add support for DFU files!
+
+        // RISC-V Espressif ESP
+        .{ .name = "esp32-c3", .target = esp.chips.esp32_c3 }, // TODO: Add support for Espressif Update Binaries
+
+        // Microchip ATmega
+        // TODO: Fix compiler bugs
+        // - https://github.com/ziglang/zig/issues/17219
+        // .{ .name = "atmega328p", .target = atmega.chips.atmega328p },
+        // .{ .name = "arduino-nano", .target = atmega.boards.arduino.nano },
+        // .{ .name = "arduino-uno-rev3", .target = atmega.boards.arduino.uno_rev3 },
+    };
+
+    for (available_targets) |dest| {
+        // `addFirmware` basically works like addExecutable, but takes a
+        // `microzig.Target` for target instead of a `std.zig.CrossTarget`.
+        //
+        // The target will convey all necessary information on the chip,
+        // cpu and potentially the board as well.
+        const firmware = microzig.addFirmware(b, .{
+            .name = b.fmt("empty-{s}", .{dest.name}),
+            .target = dest.target,
+            .optimize = optimize,
+            .source_file = .{ .path = "src/empty.zig" },
+        });
+
+        // `installFirmware()` is the MicroZig pendant to `Build.installArtifact()`
+        // and allows installing the firmware as a typical firmware file.
+        //
+        // This will also install into `$prefix/firmware` instead of `$prefix/bin`.
+        microzig.installFirmware(b, firmware, .{});
+
+        // For debugging, we also always install the firmware as an ELF file
+        microzig.installFirmware(b, firmware, .{ .format = .elf });
+    }
+}
diff --git a/gigadevice-gd32/build.zig.zon b/gigadevice-gd32/build.zig.zon
@@ -0,0 +1,14 @@
+.{
+    .name = "microzig-gigadevice-gd32-examples",
+    .version = "0.1.0",
+    .dependencies = .{
+        .microzig = .{
+            .url = "https://github.com/ZigEmbeddedGroup/microzig/archive/c6c9ec4516f57638e751141085c9d76120990312.tar.gz",
+            .hash = "1220af58bdaa721b8189f3a7adfda660517dd354463463388e96d69fe4ceccf80b92",
+        },
+        .gd32 = .{
+            .url = "https://github.com/ZigEmbeddedGroup/gigadevice-gd32/archive/9324753cc3b8e7afe83fcda085bcfe76681a3be3.tar.gz",
+            .hash = "122043ff4dcbc342f25dbb936b0d9eaa701ac3509e2cbe6764be37b90d31c7a385d0",
+        },
+    },
+}
diff --git a/microchip-atmega/build.zig b/microchip-atmega/build.zig
@@ -0,0 +1,84 @@
+const std = @import("std");
+const rp2040 = @import("rp2040");
+const stm32 = @import("stm32");
+const lpc = @import("lpc");
+const gd32 = @import("gd32");
+const nrf5x = @import("nrf5x");
+const esp = @import("esp");
+const atmega = @import("atmega");
+
+pub fn build(b: *std.Build) void {
+    const microzig = @import("microzig").init(b, "microzig");
+    const optimize = b.standardOptimizeOption(.{});
+
+    const TargetDesc = struct {
+        target: @import("microzig").Target,
+        name: []const u8,
+    };
+
+    const available_targets = [_]TargetDesc{
+        // RP2040
+        .{ .name = "pico", .target = rp2040.boards.raspberry_pi.pico },
+        .{ .name = "rp2040-eth", .target = rp2040.boards.waveshare.rp2040_eth },
+        .{ .name = "rp2040-plus-4m", .target = rp2040.boards.waveshare.rp2040_plus_4m },
+        .{ .name = "rp2040-plus-16m", .target = rp2040.boards.waveshare.rp2040_plus_16m },
+        .{ .name = "rp2040-matrix", .target = rp2040.boards.waveshare.rp2040_matrix },
+
+        // STM32
+        .{ .name = "stm32f103x8", .target = stm32.chips.stm32f103x8 },
+        .{ .name = "stm32f303vc", .target = stm32.chips.stm32f303vc },
+        .{ .name = "stm32f407vg", .target = stm32.chips.stm32f407vg },
+        .{ .name = "stm32f429zit6u", .target = stm32.chips.stm32f429zit6u },
+        .{ .name = "stm32f3discovery", .target = stm32.boards.stm32f3discovery },
+        .{ .name = "stm32f4discovery", .target = stm32.boards.stm32f4discovery },
+        .{ .name = "stm3240geval", .target = stm32.boards.stm3240geval },
+        .{ .name = "stm32f429idiscovery", .target = stm32.boards.stm32f429idiscovery },
+
+        // NXP LPC
+        .{ .name = "lpc176x5x", .target = lpc.chips.lpc176x5x },
+        .{ .name = "mbed-lpc1768", .target = lpc.boards.mbed.lpc1768 },
+
+        // GigaDevice GD32
+        .{ .name = "gd32vf103xb", .target = gd32.chips.gd32vf103xb },
+        .{ .name = "gd32vf103x8", .target = gd32.chips.gd32vf103x8 },
+        .{ .name = "sipeed-longan_nano", .target = gd32.boards.sipeed.longan_nano },
+
+        // Nordic Nrf5x
+        .{ .name = "nrf52832", .target = nrf5x.chips.nrf52832 },
+        .{ .name = "nrf52840", .target = nrf5x.chips.nrf52840 },
+        .{ .name = "nrf52840-dongle", .target = nrf5x.boards.nordic.nRF52840_Dongle }, // TODO: Add support for DFU files!
+
+        // RISC-V Espressif ESP
+        .{ .name = "esp32-c3", .target = esp.chips.esp32_c3 }, // TODO: Add support for Espressif Update Binaries
+
+        // Microchip ATmega
+        // TODO: Fix compiler bugs
+        // - https://github.com/ziglang/zig/issues/17219
+        // .{ .name = "atmega328p", .target = atmega.chips.atmega328p },
+        // .{ .name = "arduino-nano", .target = atmega.boards.arduino.nano },
+        // .{ .name = "arduino-uno-rev3", .target = atmega.boards.arduino.uno_rev3 },
+    };
+
+    for (available_targets) |dest| {
+        // `addFirmware` basically works like addExecutable, but takes a
+        // `microzig.Target` for target instead of a `std.zig.CrossTarget`.
+        //
+        // The target will convey all necessary information on the chip,
+        // cpu and potentially the board as well.
+        const firmware = microzig.addFirmware(b, .{
+            .name = b.fmt("empty-{s}", .{dest.name}),
+            .target = dest.target,
+            .optimize = optimize,
+            .source_file = .{ .path = "src/empty.zig" },
+        });
+
+        // `installFirmware()` is the MicroZig pendant to `Build.installArtifact()`
+        // and allows installing the firmware as a typical firmware file.
+        //
+        // This will also install into `$prefix/firmware` instead of `$prefix/bin`.
+        microzig.installFirmware(b, firmware, .{});
+
+        // For debugging, we also always install the firmware as an ELF file
+        microzig.installFirmware(b, firmware, .{ .format = .elf });
+    }
+}