Attention

You are viewing an older version of the documentation. The latest version is v3.3.

xenomai-poky

The following section is applicable to:

../_images/linux1.png

This section provides the steps to build an ECI xenomai-poky (ECI-X) image.

Prerequisite

Make sure that you complete the steps in Setting up ECI Build before proceeding to build an ECI xenomai-poky image.

Building ECI ``xenomai-poky`` Image

The ECI xenomai-poky Yocto target image provides a set of software utilities and the Xenomai3/i-pipe Cobalt preemptive & priority scheduling Linux OS runtime co-kernel to realize a real-time capable OS without a hypervisor. Do the following to build the image:

  1. Run the setup script:

    $ ./setup.sh
    ../_images/setup1.png

  2. A list of pre-configured use cases will be displayed. Select custom to start configuring a custom build.

    ../_images/use-cases1.png

  3. A list of available build targets will be displayed. Select xenomai-poky from the list.

    ../_images/019.png

  4. A list of features available for xenomai-poky will be displayed. Select or deselect the features that you want to include in the image. Use the arrow keys to scroll through the list of options and use the spacebar to toggle the state. Press enter to finalize the selection.

    ../_images/028.png

    The following table lists the available options:

    Feature Option

    Description

    SDK (build tools and dev pkgs)

    Adds GCC and Make to the target image.

    SSH Server

    Adds an SSH server to the target image.

    EC Protocol Bridge

    Edge Control Protocol Bridge bridges various industrial protocols together, effectively providing a translation from one protocol to another.

    CODESYS Software PLC

    CODESYS Software PLC provides a Linux runtime that allows control applications to execute on Linux-based systems. This feature requires a CODESYS .deb file to be added to the build environment.

    Kernel Debug*

    Enables Kernel debug capabilities on the target.

    Graphical Windowing System*

    Adds XFCE - a X11 based graphical window manager to the target image.

    Robot Operating System 2 (Foxy)

    Provides core essentials of ROS2 software

    XDP & BPF

    Allows packets to be reflected, filtered, or redirected without traversing networking stack. Selecting this feature will add eBPF and XDP features to the target image.

    Kubernetes

    Adds binaries required to join a Kubernetes cluster.

    Castle Lake Dependencies

    Adds kernel modules and tools necessary to support an Castle Lake Client.

    Intel® In-Band Manageability

    Intel® In-band Manageability enables an administrator to perform critical Device Management operations over-the-air remotely from the cloud. Selecting this feature will add Intel In-Band Manageability software to the target image.

    Intel® Functional Safety (EHL/Sbl)

    Enables Intel® Elkhart Lake Functional Safety (FuSa) Software Package.

    Note:

    Functional Safety features are only supported on Intel Atom® x6000E Series processors.

    Intel® Edge Insights for Industrial (Intel® EII)

    Enables Intel® Edge Insights for Industrial features.

    *Experimental*

    Enables experimental features.

    Important

    (*) For best real-time performance, it is recommended that you do not enable Graphical Windowing System or Kernel Debug features.

    Note

    The resulting OS will be headless (non-graphical) unless the Graphical Windowing System feature is selected.

    The setup script will begin configuring the assets needed to build the target image. Depending on the feature options selected and the state of the build environment, a few notifications might be displayed:

    • Build directory already exists

      If the setup script is not building the target for the first time, the script will prompt: Build directory ecs-xenomai-<poky/deby> already exists. Do you want to clean the cached build? y/[n]

      ../_images/048.png

      Press n to retain the target build cache, or press y to delete target build cache.

      Note

      It is recommended that you delete the target build cache if the target source was modified or the previous build was incomplete. Retaining the target build cache will reduce the build time, but might cause build errors if the target source was modified or the previous build was incomplete. If build errors occur, rerun the setup script and choose y at this prompt.

    For all other notifications, click the following links:

  5. After setting up the build target, the script will prompt: Do you want to run an automated build? y/[n].

    ../_images/A.png

    To perform an automated build, press y at the prompt.

    ../_images/A.png

The build typically takes a very long time. A Linux build system with the recommended specifications might take about 1-2 hours to complete. A Linux build system with the minimum specifications might take over 6 hours to complete. Refer Linux Build System for the recommended specifications..

../_images/B1.png

After the build completes, refer Installing ECI-X to create a bootable USB flash drive to install the ECI image.