.. _installation: Installation ############ ``Option 1`` Follow The Official Zephyr Documentation ***************************************************** Follow the instructions_ from the official Zephyr documentation on setting up the tooling for your host operating system. .. _instructions: https://docs.zephyrproject.org/latest/develop/getting_started/index.html Creating a Workspace ==================== Use ``west init`` and ``west update`` to create an Atmosic SDK workspace as follows: .. code-block:: bash west init -m https://github.com/Atmosic/openair.git zephyrproject cd zephyrproject west update ``Option 2`` Using OpenAir Utility (atmoautil) ********************************************** Atmosic provides OpenAir Utility (atmoautil) to manage the Zephyr development environment by command line. The following steps install Atmosic OpenAir SDK source code and toolchain. This includes everything that is required by Zephyr’s Getting Started Guide together with additional tools and Python dependencies that Atmosic OpenAir SDK uses. Install Prerequisites ===================== Depending on your preferred development environment, install the following software tools: - The latest version of ``atmoautil``, a unified command-line utility for the Atmosic OpenAir SDK, is required. Please refer to the list of supported operating systems and `download `_ the appropriate installer. - Download SEGGER J-Link from the `J-Link Software and Documentation Pack `_ page. .. note:: If you encounter permission issues when running atmoautil: - On Linux, navigate to the directory containing the file and run ``chmod +x atmoautil`` to grant the file execute permission. - On Windows, simply right‑click atmoautil and select ``Run as administrator`` to open it with elevated privileges. Download ======== - `Windows 10/11 `_ - `Linux - Ubuntu 22.04 LTS `_ Install Atmosic OpenAir SDK toolchain ===================================== **1.** Open a terminal window and execute atmoautil command. .. code-block:: bash atmoautil **2.** Run the following command to install the toolchain. .. code-block:: bash (atmoautil) manager> toolchain_list ╔════════════════════════╗ ║ Toolchain Version List ║ ╚════════════════════════╝ 25.01.0 25.02.0 (atmoautil) manager> toolchain_install -v 25.02.0 ╔════════════════════════╗ ║ Download Toolchain ║ ╚════════════════════════╝ Downloading ════════════════════════════════════════════════ 100% 0:00:00 ╔════════════════════════╗ ║ Install Toolchain ║ ╚════════════════════════╝ Installing ════════════════════════════════════════════════ 100% 0:00:00 (atmoautil) manager> toolchain_list ╔════════════════════════╗ ║ Toolchain Version List ║ ╚════════════════════════╝ 25.01.0 25.02.0 [Installed] With the default location to install the toolchain (``C:/atmoa/toolchains`` on Windows, ``~/atmoa/toolchains`` on Linux), your directory structure now looks similar to this: .. code-block:: none atmoa └─── toolchains └─── In this simplified structure preview, ``toolchain-installation`` corresponds to the version name you installed. **3.** Launch development environment through atmoautil by ``toolchain_launch`` command. It will pop-up a new Windows command prompt which the title of the window shows “Atmosic Zephyr” for Windows user. Subsequently, go to the atmoa directory and create zephyrproject folder. (For the Windows user, ``cd C:\atmoa``, for the Linux user, ``cd ~/atmoa``) .. code-block:: bash toolchain_launch -v 25.02.0 **4.** Checkout source code from `GitHub `_. .. code-block:: bash west init -m https://github.com/Atmosic/openair.git zephyrproject cd zephyrproject west update **5.** Build sample - hello_world in Atmosic OpenAir SDK. .. code-block:: bash west build -p always -b //ns openair/samples/sysbuild/hello_world --sysbuild -T samples.sysbuild.hello_world.atm For Example: .. code-block:: bash (25.02.0) C:\atmoa\zephyrproject> west build -p always -b ATMEVK-3330e-QN-7//ns openair/samples/sysbuild/hello_world --sysbuild -T samples.sysbuild.hello_world.atm -- west build: generating a build system Loading Zephyr module(s) (Zephyr base): sysbuild_default -- Found Python3: C:/atmoa/toolchains/25.02.0/python/python.exe (found suitable version "3.10.11", minimum required is "3.10") found components: Interpreter -- Cache files will be written to: C:\atmoa\zephyrproject/zephyr/.cache -- Found west (found suitable version "1.3.0", minimum required is "0.14.0") -- Board: ATMEVK-3330e-QN-7, qualifiers: ATM33xx-5/ns Parsing D:/Project/zephyr/zephyrproject/zephyr/share/sysbuild/Kconfig Loaded configuration 'C:\atmoa\zephyrproject/build/_sysbuild/empty.conf' Merged configuration 'C:\atmoa\zephyrproject/build/_sysbuild/empty.conf' Merged configuration 'C:\atmoa\zephyrproject/build/zephyr/misc/generated/extra_kconfig_options.conf' Configuration saved to 'C:\atmoa\zephyrproject/build/zephyr/.config' Kconfig header saved to 'C:\atmoa\zephyrproject/build/_sysbuild/autoconf.h' -- ************************* * Running CMake for spe * ************************* **6.** [Windows] Install RDI driver if need **7.** Program firmware to Atmosic device .. code-block:: bash west flash --skip-rebuild --device --jlink --fast_load For Example: .. code-block:: bash (25.02.0) d:\atmoa\zephyrproject>west flash --skip-rebuild --device 900036842 --jlink --fast_load WARNING: Specifying runner options for multiple domains is experimental. If problems are experienced, please specify a single domain using '--domain ' -- west flash: using runner atmisp -- runners.atmisp: program address: 0x10000 Open On-Chip Debugger 0.12.0-00020-gaf2e30d6d (2024-04-23-16:10) Licensed under GNU GPL v2 For bug reports, read http://openocd.org/doc/doxygen/bugs.html Using JLINK JLINK serial 900036842 Info : J-Link OB-K22-Cortex-M compiled Oct 9 2024 11:01:11 Info : Hardware version: 1.00 Info : GPIO supported Info : VTarget = 3.300 V Info : clock speed 100 kHz Warn : gdb services need one or more targets defined Open On-Chip Debugger 0.12.0-00020-gaf2e30d6d (2024-04-23-16:10) Licensed under GNU GPL v2 For bug reports, read