Merge branch 'swiftlang:main' into main

Author: ebariaux

.github/actions/install-swift/action.yml

@@ -4,16 +4,15 @@ description: Installs the Swift specified by a .swift-version file
 runs:
   using: "composite"
   steps:
-    # - name: "Cache: Swift"
-    #   id: cache-swift
-    #   uses: actions/cache@v4
-    #   with:
-    #     path: "$HOME/.local/share/swiftly"
-    #     key: swift-${{ hashFiles('.swift-version') }}
-
     - name: Setup Environment
       shell: bash
       run: |
+        mkdir -p "$HOME/.local/share"
+
+        export SWIFTLY_TOOLCHAINS_DIR="$HOME/.local/share/swiftly/toolchains"
+        echo "SWIFTLY_TOOLCHAINS_DIR=$SWIFTLY_TOOLCHAINS_DIR" >> $GITHUB_ENV
+        echo "SWIFTLY_TOOLCHAINS_DIR=$SWIFTLY_TOOLCHAINS_DIR" >> $HOME/.bashrc
+
         export SWIFTLY_HOME_DIR="$HOME/.local/share/swiftly"
         echo "SWIFTLY_HOME_DIR=$SWIFTLY_HOME_DIR" >> $GITHUB_ENV
         echo "SWIFTLY_HOME_DIR=$SWIFTLY_HOME_DIR" >> $HOME/.bashrc
@@ -25,15 +24,15 @@ runs:
         echo "PATH=$SWIFTLY_BIN_DIR:$PATH" >> $GITHUB_ENV
         echo "PATH=\$SWIFTLY_BIN_DIR:\$PATH" >> $HOME/.bashrc
 
-    - name: "Restore: Swift"
+    - name: Restore Swift
       uses: actions/cache/restore@v4
       id: cache-swift
       with:
         path: "~/.local/share/swiftly"
-        key: swift-${{ hashFiles('**/.swift-version') }}
+        key: swift-${{ runner.os }}-${{ hashFiles('**/.swift-version', '.github/actions/install-swift/action.yml') }}
 
     - name: Install `apt` Dependencies
-      if: steps.cache-swift.outputs.cache-hit != 'true'
+      if: runner.os == 'Linux' && steps.cache-swift.outputs.cache-hit != 'true'
       shell: bash
       run: |
         SUDO=$(if [[ $EUID -ne 0 ]]; then echo sudo; fi)
@@ -43,29 +42,47 @@ runs:
         DEBIAN_FRONTEND: noninteractive
 
     - name: Install Swiftly
-      if: steps.cache-swift.outputs.cache-hit != 'true'
+      if: runner.os == 'Linux' && steps.cache-swift.outputs.cache-hit != 'true'
       shell: bash
       run: |
+        SWIFTLY_VERSION=1.0.1
         UNAME=$(uname -m)
-        curl -O "https://download.swift.org/swiftly/linux/swiftly-$UNAME.tar.gz"
-        tar zxf "swiftly-$UNAME.tar.gz"
+        SWIFTLY_TGZ=swiftly-$SWIFTLY_VERSION-$UNAME.tar.gz
+        curl -O "https://download.swift.org/swiftly/linux/$SWIFTLY_TGZ"
+        tar zxf "$SWIFTLY_TGZ"
         ./swiftly init \
           --skip-install \
           --assume-yes \
           --quiet-shell-followup \
           --no-modify-profile
 
+    - name: Install Swiftly
+      if: runner.os == 'macOS' && steps.cache-swift.outputs.cache-hit != 'true'
+      shell: bash
+      run: |
+        SWIFTLY_VERSION=1.0.1
+        SWIFTLY_PKG=swiftly-$SWIFTLY_VERSION.pkg
+        curl -O "https://download.swift.org/swiftly/darwin/$SWIFTLY_PKG"
+        pkgutil --check-signature $SWIFTLY_PKG
+        pkgutil --verbose --expand $SWIFTLY_PKG $SWIFTLY_HOME_DIR
+        tar -C $SWIFTLY_HOME_DIR -xvf $SWIFTLY_HOME_DIR/swiftly-*/Payload
+        "$SWIFTLY_BIN_DIR/swiftly" init \
+          --skip-install \
+          --assume-yes \
+          --quiet-shell-followup \
+          --no-modify-profile
+
     - name: Install Swift
       if: steps.cache-swift.outputs.cache-hit != 'true'
       shell: bash
       run: swiftly install --post-install-file ./out.sh
 
-    - name: "Save: Swift"
+    - name: Save Swift
       if: steps.cache-swift.outputs.cache-hit != 'true'
       uses: actions/cache/save@v4
       with:
         path: "~/.local/share/swiftly"
-        key: swift-${{ hashFiles('**/.swift-version') }}
+        key: swift-${{ runner.os }}-${{ hashFiles('**/.swift-version', '.github/actions/install-swift/action.yml') }}
 
     - name: Print Swift Version
       shell: bash

.github/workflows/build-stm.yml renamed to .github/workflows/build-stm32-elf.yml

@@ -1,4 +1,4 @@
-name: STM32
+name: STM32 ELF
 
 on:
   push:
@@ -15,16 +15,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        example: [stm32-blink, stm32-lvgl]
+        example: [stm32-lvgl]
 
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
 
-      - name: Fixup for running locally in act
-        if: ${{ env.ACT }}
-        run: echo /opt/acttoolcache/node/18.20.8/x64/bin >> $GITHUB_PATH
-
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
@@ -36,21 +32,11 @@ jobs:
       - name: Install Swift
         uses: ./.github/actions/install-swift
 
-      - name: Set environment variables
-        run: |
-          echo "STM_BOARD=STM32F746G_DISCOVERY" >> $GITHUB_ENV
-
       - name: Build ${{ matrix.example }}
         working-directory: ${{ matrix.example }}
         run: |
           if [[ -f ./fetch-dependencies.sh ]]; then
             ./fetch-dependencies.sh
           fi
 
-          if [[ -f ./build-elf.sh ]]; then
-            ./build-elf.sh
-          fi
-
-          if [[ -f Makefile ]]; then
-            make
-          fi
+          make

.github/workflows/build-stm32-macho.yml

@@ -0,0 +1,34 @@
+name: STM32 Macho
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    types: [opened, reopened, synchronize, ready_for_review]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build
+    runs-on: [self-hosted, macos, sequoia, ARM64]
+
+    strategy:
+      fail-fast: false
+      matrix:
+        example: [stm32-blink, stm32-lcd-logo, stm32-neopixel, stm32-uart-echo]
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: 3.11
+
+      - name: Install Swift
+        uses: ./.github/actions/install-swift
+
+      - name: Build ${{ matrix.example }}
+        working-directory: ${{ matrix.example }}
+        run: make

.swift-version

@@ -1 +1 @@
-main-snapshot-2025-06-01
+main-snapshot-2025-09-06

.swiftformatignore

@@ -1,6 +1,7 @@
 ./harmony/*
-./stm32-lvgl/*
+./stm32-blink/Sources/STM32F7X6/*
 ./stm32-lcd-logo/Sources/STM32F7X6/*
+./stm32-lvgl/*
 ./stm32-lvgl/Sources/Registers/*
 ./stm32-neopixel/Sources/STM32F7X6/*
 ./stm32-uart-echo/Sources/STM32F7X6/*

Documentation/README.md

@@ -2,5 +2,5 @@ Documentation for Embedded Swift
 ================================
 
 Documentation for Embedded Swift can be found at these locations:
-- [in rendered form](https://swiftpackageindex.com/swiftlang/swift-embedded-examples/documentation/embeddedswift)
+- [in rendered form at docs.swift.org](https://docs.swift.org/embedded/documentation/embedded/)
 - [DocC source code](/Sources/EmbeddedSwift/Documentation.docc)

README.md

@@ -12,7 +12,7 @@ This repository is a set of demonstration projects of **Embedded Swift**. Embedd
 
 Each example in this repository contains build and deployment instructions, however there are a couple common steps needed for many of the examples included below:
 
-1. Install [`swift`](https://swift.org) using the [instructions here](https://swiftpackageindex.com/swiftlang/swift-embedded-examples/main/documentation/embeddedswift/installembeddedswift).
+1. Install [`swift`](https://swift.org) using the [instructions here](https://docs.swift.org/embedded/documentation/embedded/installembeddedswift).
 
 2. Install [`uv`](https://github.com/astral-sh/uv), "an extremely fast Python package and project manager", using the [instructions here](https://docs.astral.sh/uv/getting-started/installation/).
 
@@ -30,7 +30,7 @@ Each example in this repository contains build and deployment instructions, howe
 | [rpi-pico-blink-sdk](./rpi-pico-blink-sdk) | Raspberry Pi Pico, Pico 2 | Pico SDK | Blink an LED repeatedly with Swift & the Pico SDK. | <img width="300" src="https://github.com/swiftlang/swift-embedded-examples/assets/1186214/f2c45c18-f9a4-48b4-a941-1298ecc942cb"> |
 | [rpi-pico-blink](./rpi-pico-blink) | Raspberry Pi Pico | None  | Blink an LED repeatedly. | <img width="300" src="https://github.com/swiftlang/swift-embedded-examples/assets/1186214/f2c45c18-f9a4-48b4-a941-1298ecc942cb"> |
 | [rpi-pico2-neopixel](./rpi-pico2-neopixel) | Raspberry Pi Pico 2 | None | Control Neopixel LEDs using the RP2350 PIO. | <img width="300" src="rpi-pico2-neopixel/assets/images/example.jpg"> |
-| [rpi-picow-blink-sdk](./rpi-picow-blink-sdk) | Raspberry Pi Pico W | Pico SDK | Blink an LED to signal 'SOS' in Morse code repeatedly with Swift & the Pico SDK. | <img width="300" src="https://github.com/swiftlang/swift-embedded-examples/assets/26223064/a4949a2e-1887-4325-8f5f-a681963c93d7"> |
+| [rpi-picow-blink-sdk](./rpi-picow-blink-sdk) | Raspberry Pi Pico W, Pico 2W | Pico SDK | Blink an LED to signal 'SOS' in Morse code repeatedly with Swift & the Pico SDK. | <img width="300" src="https://github.com/swiftlang/swift-embedded-examples/assets/26223064/a4949a2e-1887-4325-8f5f-a681963c93d7"> |
 | [stm32-blink](./stm32-blink) | STM32F746G-DISCO | None | Blink an LED repeatedly. | <img width="300" src="https://github.com/swiftlang/swift-embedded-examples/assets/1186214/739e98fd-a438-4a64-a7aa-9dddee25034b"> |
 | [stm32-lcd-logo](./stm32-lcd-logo) | STM32F746G-DISCO | None | Animate the Swift Logo on the built-in LCD. | <img width="300" src="https://github.com/swiftlang/swift-embedded-examples/assets/1186214/9e117d81-e808-493e-a20c-7284ea630f37"> |
 | [stm32-lvgl](./stm32-lvgl) | STM32F746G-DISCO | – | Baremetal setup of LCD, touch panel, DRAM, using the LLVM Embedded toolchain for ARM. Renders graphics, animations, and reacts to user input via LVGL. Includes a macOS/Linux SDL based host simulation app. | <img width="300" src="https://github.com/user-attachments/assets/3b4fefd3-1656-4768-9c64-6cbcb3ff9665"> |
@@ -53,6 +53,7 @@ Note that the SDK integration examples (Pico SDK, Zephyr SDK, etc.) are not reco
 | [EmbeddedSwift nRF52 Examples](https://github.com/nelcea/EmbeddedSwift-nRF52-Examples) | nRF52840 (Development Kit) | A collection of examples using Embedded Swift on top of nRF Connect SDK (Zephyr). |
 | [Swatak](https://github.com/nelcea/EmbeddedSwift-nRF52-Swatak) | nRF52840 (Seeed Studio XIAO) | A reaction time game inspired by BATAK© boards, implemented in Embedded Swift using nRF Connect SDK. |
 | [swift-picosystem-example](https://github.com/jerrodputman/swift-picosystem-example) | PicoSystem | An Embedded Swift demo running on the Pimoroni PicoSystem |
+| [pico-swift-sh1106](https://github.com/mkbrwr/pico-swift-sh1106) | Pico 2 | Display Driver for SH1106 |
 | [PlaydateKit](https://github.com/finnvoor/PlaydateKit) | Playdate | A full featured framework for building Playdate games using Embedded Swift. |
 | [swift-playdate-examples](https://github.com/swiftlang/swift-playdate-examples) | Playdate | An Embedded Swift game running on Playdate by Panic. |
 | [swift-stm32c011-examples](https://github.com/xtremekforever/swift-stm32c011-examples) | STM32 | Examples of running Embedded Swift on the STM32C011, which is a tiny MCU with only 6KB of SRAM and 32KB of flash. |

Sources/EmbeddedSwift/Documentation.docc/GuidedExamples/PicoGuide.md

@@ -23,7 +23,7 @@ $ export PICO_SDK_PATH=...       # location to your Pico SDK
 $ export PICO_TOOLCHAIN_PATH=... # location to the Arm Embedded Toolchain
 ```
 
-If you have the Wi-Fi enabled Pico W board instead of the regular Pico, note that you will need a slightly different setup described in the [Pico W example project](https://github.com/swiftlang/swift-embedded-examples/tree/main/rpi-picow-blink-sdk), and just specifying `PICO_BOARD=pico_w` is not going to work.
+If you have the Wi-Fi enabled Pico W / Pico 2W board instead of the regular Pico, note that you will need a slightly different setup described in the [Pico W example project](https://github.com/swiftlang/swift-embedded-examples/tree/main/rpi-picow-blink-sdk), and just specifying `PICO_BOARD=pico_w` is not going to work.
 
 Install [CMake 3.29](https://cmake.org/) or newer.
 

Sources/EmbeddedSwift/Documentation.docc/SDKSupport/Baremetal.md

@@ -67,7 +67,7 @@ Swift MMIO provides strongly-typed access to memory-mapped hardware and can auto
 gpioa.odr.write { $0.odr5 = true } // Set pin 5 high
 ```
 
-See [Swift MMIO](https://github.com/swiftlang/swift-mmio/) for details and <doc:STM32BaremetalGuide> for a guided example of using it.
+See [Swift MMIO](https://github.com/apple/swift-mmio/) for details and <doc:STM32BaremetalGuide> for a guided example of using it.
 
 ## Creating a linker script and data segment relocation