Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 2.96 KB

README.md

File metadata and controls

79 lines (58 loc) · 2.96 KB
Raw

Zephyr SDK

The Zephyr Software Development Kit (SDK) includes the toolchains for all supported target architectures as well as the host tools, such as QEMU and OpenOCD, for testing and debugging the Zephyr RTOS.

The toolchains for the following target architectures are supported:

  • ARC (32-bit and 64-bit; ARCv1, ARCv2, ARCv3)
  • ARM (32-bit and 64-bit; ARMv6, ARMv7, ARMv8; A/R/M Profiles)
  • Microblaze (32-bit)
  • MIPS (32-bit and 64-bit)
  • Nios II
  • RISC-V (32-bit and 64-bit; RV32I, RV32E, RV64I)
  • x86 (32-bit and 64-bit)
  • Xtensa (sample_controller, intel_apl_adsp, intel_s1000, nxp_imx_adsp, nxp_imx8m_adsp, espressif_esp32, espressif_esp32s2, espressif_esp32s3)

The following host tools are available as part of the Zephyr SDK:

  • BOSSA
  • OpenOCD
  • QEMU
  • Xilinx QEMU

Releases

The Zephyr SDK bundle releases are available for the following host platforms:

  • Linux (AArch64, x86-64)
  • macOS (AArch64, x86-64)
  • Windows (x86-64)

These binaries can be downloaded from here:

https://github.com/zephyrproject-rtos/sdk-ng/releases

Build Process

The Zephyr Project maintains the infrastructure necessary to build and test the Zephyr SDK, and it is highly recommended to utilise this infrastructure for generating the Zephyr SDK binaries.

When you submit a pull request to the Zephyr SDK repository, CI will automatically build and test the Zephyr SDK with the changes in the pull request and upload the binaries to the pull request check run, which you can download for further local testing as necessary.

Locally building the Zephyr SDK is currently not supported because setting up the environment to do so is highly complex and the resource requirements far exceed what is found on common developer machines.

Workflow to Test Patches with Zephyr SDK

The following workflow can be used to test a patch for GCC, for example, building the SDK remotely:

  • Submit your DRAFT gcc PR to Zephyr's GCC fork (etc.)
  • Update .gitmodules in sdk-ng to point to the fork with your gcc commit(s)
  • Resync submodules (git submodule sync --recursive && cd gcc && git pull)
  • Checkout the gcc commit hash in sdk-ng's gcc submodule and commit the .gitmodule changes (git add .gitmodules gcc && git commit -s)
  • Submit a DRAFT PR to sdk-ng with the submodule change(s)

Zephyr's CI will then build a new toolchain, which will be available in the PR check step. Verify that the GCC fix behaves as expected with the generated SDK.

Release Process

To create a new Zephyr SDK release:

  • Update the VERSION file with the new version (e.g. 0.11.0 or 0.11.0-beta1)
  • On https://github.com/zephyrproject-rtos/sdk-ng/releases, create a new tag named with the version number prefixed with v (e.g. for the version 0.11.0, the tag name should be v0.11.0) and add the release information.
  • Once the release is published, CI will build the Zephyr SDK bundles for all supported host platforms and will upload the binaries to the release page.