Feature/windows gnu toolchain (#123)

* add support for Windows GNU toolchain

Co-authored-by: Sergio Gasquez Arcos <[email protected]>

Author: georgik

Install-RustToolchain.ps1

@@ -2,6 +2,9 @@
 param (
     [Parameter()]
     [String]
+    [ValidateSet("x86_64-pc-windows-msvc", "x86_64-pc-windows-gnu")]
+    $DefaultHost = "x86_64-pc-windows-msvc",
+    [String]
     $ExportFile = '',
     [String]
     $ToolchainVersion = '1.62.1.0',
@@ -22,14 +25,15 @@ $ExportContent = ""
 $RustcMinimalMinorVersion="55"
 
 "Processing configuration:"
+"-DefaultHost          = ${DefaultHost}"
 "-InstalltationMode    = ${InstallationMode}"
 "-LlvmVersion          = ${LlvmVersion}"
 "-ToolchainVersion     = ${ToolchainVersion}"
 "-ToolchainDestination = ${ToolchainDestination}"
 
 function InstallRust() {
     Invoke-WebRequest https://win.rustup.rs/x86_64 -OutFile rustup-init.exe
-    ./rustup-init.exe --default-toolchain stable -y
+    ./rustup-init.exe --default-host ${DefaultHost} --default-toolchain stable -y
     $env:PATH+=";$env:USERPROFILE\.cargo\bin"
     $ExportContent+="`n" + '$env:PATH+=";$env:USERPROFILE\.cargo\bin"'
 }
@@ -83,7 +87,7 @@ $Arch="x86_64-pc-windows-msvc"
 $EspFlashUrl="https://github.com/esp-rs/espflash/releases/latest/download/cargo-espflash-${Arch}.zip"
 $CargoBin="${env:USERPROFILE}\.cargo\bin"
 $EspFlashBin="${CargoBin}\cargo-espflash.exe"
-$RustDist="rust-${ToolchainVersion}-${Arch}"
+$RustDist="rust-${ToolchainVersion}-${DefaultHost}"
 $RustDistZipUrl="https://github.com/esp-rs/rust-build/releases/download/v${ToolchainVersion}/${RustDist}.zip"
 $IdfToolsPath="${HOME}/.espressif"
 $IdfToolXtensaElfClang="${IdfToolsPath}/tools/xtensa-esp32-elf-clang/${LlvmVersion}-${Arch}"

README.md

@@ -17,9 +17,12 @@ This repository contains:
     - [Linux and macOS](#linux-and-macos)
       - [Prerequisites](#prerequisites)
       - [Installation commands](#installation-commands)
-    - [Windows x64](#windows-x64)
-      - [Prerequisites](#prerequisites-1)
+    - [Windows x64 GNU](#windows-x86_64-gnu)
+      - [Prerequisites](#prerequisites-x86_64-gnu)
       - [Installation commands for PowerShell](#installation-commands-for-powershell)
+    - [Windows x64 MSVC](#windows-x86_64-msvc)
+      - [Prerequisites](#prerequisites-x86_64-msvc)
+      - [Installation commands for PowerShell](#installation-commands-for-powershell-1)
   - [RISC-V Installation](#riscv-installation)
   - [Building projects](#building-projects)
     - [Cargo first approach](#cargo-first-approach)
@@ -48,7 +51,7 @@ Invoke-WebRequest 'https://github.com/esp-rs/rust-build/releases/download/v1.62.
 
 ### Linux and macOS
 
-Following instructions are specific for ESP32 and ESP32-S series based on Xtensa architecture.
+The following instructions are specific for the ESP32 and ESP32-S series based on Xtensa architecture.
 
 Instructions for ESP-C series based on RISC-V architecture are described in [RISC-V section](#riscv-installation).
 
@@ -61,7 +64,7 @@ Instructions for ESP-C series based on RISC-V architecture are described in [RIS
     python3 python3-pip python3-venv libusb-1.0-0 libssl-dev pkg-config libtinfo5 libpython2.7
     ```
 
-No prerequisites are needed for macOS
+No prerequisites are needed for macOS.
 
 #### Installation commands
 
@@ -75,9 +78,9 @@ Run `./install-rust-toolchain.sh --help` for more information about arguments.
 
 Export variables are displayed at the end of the script.
 > **Note**
-> If the export variables are added into the shell startup script, the shell may need to be refreshed.
+> If the export variables are added to the shell startup script, the shell may need to be refreshed.
 
-Installation of different version of toolchain:
+Installation of different version of the toolchain:
 
 ```
 ./install-rust-toolchain.sh --toolchain-version 1.62.1.0 --export-file export-esp-rust.sh
@@ -99,13 +102,40 @@ source export-esp-rust.sh
 - `-t|--toolchain-version`: Xtensa Rust toolchain version
 - `-x|--clear-cache`: Removes cached distribution files. Possible values: [`YES, NO`]
 
-### Windows x64
+### Windows x86_64 GNU
 
-Following instructions are specific for ESP32 and ESP32-S series based on Xtensa architecture.
+The following instructions describe deployment with the GNU toolchain. If you're using Visual Studio with Windows 10 SDK, consider option [Windows x86_64 MSVC](#windows-x86_64-msvc).
+
+#### Prerequisites x86_64 GNU
+
+Install MinGW x86_64 e.g., from releases https://github.com/niXman/mingw-builds-binaries/releases and add bin to environment variable PATH
+
+```powershell
+choco install 7zip
+Invoke-WebRequest https://github.com/niXman/mingw-builds-binaries/releases/download/12.1.0-rt_v10-rev3/x86_64-12.1.0-release-posix-seh-rt_v10-rev3.7z -OutFile x86_64-12.1.0-release-posix-seh-rt_v10-rev3.7z
+7z e x86_64-12.1.0-release-posix-seh-rt_v10-rev3.7z
+$env:PATH+=";.....\x86_64-12.1.0-release-posix-seh-rt_v10-rev3\mingw64\bin"
+```
+
+Install ESP-IDF using Windows installer https://dl.espressif.com/dl/esp-idf/
+#### Installation commands for PowerShell
+
+Activate ESP-IDF PowerShell and enter following command:
+
+```powershell
+git clone https://github.com/esp-rs/rust-build.git
+cd rust-build
+./Install-RustToolchain.ps1 -DefaultHost x86_64-pc-windows-gnu  -ExportFile Export-EspRust.ps1
+source Export-EspRust.ps1
+```
+
+### Windows x86_64 MSVC
+
+The following instructions are specific for the ESP32 and ESP32-S series based on Xtensa architecture. If you do not have Visual Studio and Windows 10 SDK installed, consider the alternative option [Windows x86_64 GNU](#windows-x86_64-gnu).
 
 Instructions for ESP-C series based on RISC-V architecture are described  in [RISC-V section](#riscv-installation).
 
-#### Prerequisites
+#### Prerequisites x86_64 MSVC
 
 - Visual Studio - installed with option Desktop development with C++ - components: MSVCv142 - VS2019 C++ x86/64 build tools, Windows 10 SDK
 
@@ -128,16 +158,16 @@ cd rust-build
 
 Export variables are displayed at the end of the output from the script.
 
-Installation of different version of toolchain:
+Installation of different versions of toolchain:
 
 ```sh
-./Install-RustToolchain.ps1 --toolchain-version 1.62.1.0 --export-file Export-EspRust.ps1
+./Install-RustToolchain.ps1 -ToolchainVersion 1.62.1.0 -ExportFile Export-EspRust.ps1
 source ./Export-EspRust.ps1
 ```
 
 ## RISC-V Installation
 
-Following instructions are specific for ESP32-C based on RISC-V architecture.
+The following instructions are specific for ESP32-C based on RISC-V architecture.
 
 Install the RISC-V target for Rust:
 
@@ -213,11 +243,11 @@ When building for Xtensa targets, we need to [override the `esp` toolchain](http
 
 ## Containers with Rust ESP environment
 
-Alternatively, some container images, with pre-installed Rust and ESP-IDF, are published to Dockerhub and can be used to build Rust projects for ESP boards:
+Alternatively, some container images with pre-installed Rust and ESP-IDF, are published to Dockerhub and can be used to build Rust projects for ESP boards:
 
 - [idf-rust](https://hub.docker.com/r/espressif/idf-rust)
- - Some tags contains only the toolchain. The naming convention for those tags is: `<xtensa-version>`
- - Some tags contains full environment with esp-idf installed, [wokwi-server](https://github.com/MabezDev/wokwi-server)
+ - Some tags contain only the toolchain. The naming convention for those tags is: `<xtensa-version>`
+ - Some tags contain full environment with esp-idf installed, [wokwi-server](https://github.com/MabezDev/wokwi-server)
    and [web-flash](https://github.com/bjoernQ/esp-web-flash-server) to use them
    in Dev Containers. This tags are generated for `linux/arm64` and `linux/amd64`,
    and use the following naming convention: `<board>_<esp-idf>_<xtensa-version>`
@@ -229,7 +259,7 @@ Podman example with mapping multiple /dev/ttyUSB from host computer to the conta
 podman run --device /dev/ttyUSB0 --device /dev/ttyUSB1 -it docker.io/espressif/idf-rust-examples
 ```
 
-Docker (does not support flashing from container):
+Docker (does not support flashing from a container):
 
 ```sh
 docker run -it espressif/idf-rust-examples
@@ -239,7 +269,7 @@ If you are using the `idf-rust-examples` image, instructions will be displayed o
 
 ## Dev Containers
 
-Dev Container support is offered for VS Code, Gitpod and GitHub Codespaces,
+Dev Container support is offered for VS Code, Gitpod, and GitHub Codespaces,
 resulting in a fully working environment to develop for ESP boards in Rust,
 flash and simulate projects with Wokwi from the container.
 

Test-RustToolchain.ps1

@@ -2,6 +2,9 @@
 param (
     [Parameter()]
     [String]
+    [ValidateSet("x86_64-pc-windows-msvc", "x86_64-pc-windows-gnu")]
+    $DefaultHost = "x86_64-pc-windows-msvc",
+    [String]
     $ToolchainVersion = '1.62.1.0',
     [String]
     [ValidateSet("xtensa-esp32-espidf", "xtensa-esp32s2-espidf", "xtensa-esp32s3-espidf", "riscv32imc-esp-espidf")]
@@ -24,6 +27,7 @@ $ErrorActionPreference = "Stop"
 $RustStdDemo = "rust-esp32-std-demo"
 
 "Processing configuration:"
+"-DefaultHost      = ${DefaultHost}"
 "-Features         = ${Features}"
 "-LlvmVersion      = ${LlvmVersion}"
 "-Target           = ${Target}"
@@ -37,6 +41,7 @@ $ExportFile="Export-Rust-${ToolchainName}.ps1"
 
 if ("skip" -ne $InstallationMode) {
     ./Install-RustToolchain.ps1 `
+        -DefaultHost ${DefaultHost} `
         -ExportFile ${ExportFile} `
         -LlvmVersion ${LlvmVersion} `
         -InstallationMode ${InstallationMode} `

install-rust-toolchain.sh

@@ -427,6 +427,22 @@ function install_system_packages() {
     fi
 }
 
+function install_system_packages() {
+    if [ -z "${SYSTEM_PACKAGES}" ]; then
+        return
+    fi
+
+    echo "Installing system packages: ${SYSTEM_PACKAGES}"
+
+    if [[ ${ARCH} == "aarch64-apple-darwin" || ${ARCH} == "x86_64-apple-darwin" ]]; then
+        command -v brew || {
+            echo "Warning: Unable to find command brew. Skipping installation of system package."
+            return
+        }
+        brew list "${SYSTEM_PACKAGES}" || brew install "${SYSTEM_PACKAGES}"
+    fi
+}
+
 # Check required tooling - rustc, rustfmt
 command -v rustup || install_rustup
 

support/rust-build/Repackage-RustRelease.ps1

@@ -1,3 +1,10 @@
+[CmdletBinding()]
+param (
+    [Parameter()]
+    [String]
+    [ValidateSet("x86_64-pc-windows-msvc", "x86_64-pc-windows-gnu")]
+    $DefaultHost = "x86_64-pc-windows-msvc"
+)
 # Helper script to perform repackaging of Windows release
 
 # Stop on error
@@ -12,13 +19,13 @@ if (Test-Path -Path esp -PathType Container) {
 }
 
 mkdir esp
-7z e rust-${RustVersion}-x86_64-pc-windows-msvc.tar.xz
-7z x rust-${RustVersion}-x86_64-pc-windows-msvc.tar
-pushd rust-${RustVersion}-x86_64-pc-windows-msvc
+7z e rust-${RustVersion}-${DefaultHost}.tar.xz
+7z x rust-${RustVersion}-${DefaultHost}.tar
+pushd rust-${RustVersion}-${DefaultHost}
 cp -Recurse .\rustc\bin ..\esp\
 cp -Recurse .\rustc\lib ..\esp\
 cp -Recurse .\rustc\share ..\esp\
-cp -ErrorAction SilentlyContinue -Recurse .\rust-std-x86_64-pc-windows-msvc\lib\* ..\esp\lib\
+cp -ErrorAction SilentlyContinue -Recurse .\rust-std-${DefaultHost}\lib\* ..\esp\lib\
 popd
 7z e rust-src-${RustVersion}.tar.xz
 7z x rust-src-${RustVersion}.tar
@@ -32,4 +39,4 @@ Get-ChildItem -Path .\ -Filter *.pdb -Recurse -File -Name| ForEach-Object {
     Remove-Item -Path $_
 }
 
-7z a rust-${ReleaseVersion}-x86_64-pc-windows-msvc.zip esp/
+7z a rust-${ReleaseVersion}-${DefaultHost}.zip esp/

support/rust-build/x86_64-pc-windows-gnu/Prepare-BuildEnvironment.ps1

@@ -0,0 +1,5 @@
+Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
+
+choco install msys2 -y
+
+msys2_shell.cmd -mingw64

support/rust-build/x86_64-pc-windows-gnu/build-rust-toolchain-msys2.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+cd c:
+git clone --recursive https://github.com/esp-rs/rust.git r
+cd r
+
+python3 src/bootstrap/configure.py --experimental-targets=Xtensa --enable-extended --tools=clippy,cargo,rustfmt --dist-compression-formats='xz' --host 'x86_64-pc-windows-gnu'
+
+python3 x.py dist --stage 2

support/rust-build/x86_64-pc-windows-gnu/prepare-msys2.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+pacman -Sy pacman-mirrors
+
+pacman -S git \
+            make \
+            diffutils \
+            tar \
+            mingw-w64-x86_64-python \
+            mingw-w64-x86_64-cmake \
+            mingw-w64-x86_64-gcc \
+            mingw-w64-x86_64-ninja