@@ Line 1: / Line 1: @@
-<includeonly>
+<includeonly>{{#vardefine:GITHUB_WARNING|{{#ifexpr: {{#var:YOCTO_VERSION}} < 2.3 |{{Note|'''Warning:''' Due to a GitHub policy change, it is necessary to add HTTPS mirrors to local.conf for Yocto Morty and older. Please refer to [[:Yocto_Common_Errors#GitHub Git protocol on port 9418|Yocto Common Errors]].}}}}}}<!--
-{{#switch:{{#var:PLATFORM_OS}}|Debian=
+--> {{PageHeader|{{#var:HARDWARE_NAME}} - Yocto {{#var:YOCTO_NAME}} {{#var:YOCTO_VERSION}} based on {{#varexists:FSLC_BSP_VERSION|FSL Community BSP {{#var:FSLC_BSP_VERSION}}|NXP BSP {{#var:FSL_BSP_VERSION}}}} with {{#var:FSL_BSP_VERSION}} Linux release}} {{DocImage|category1=Yocto|category2={{#var:HARDWARE_NAME}}}} __toc__
-<pre>vari@yocto-{{#var:MACHINE_NAME}}$ bitbake var-recovery-image</pre> |
-<pre>vari@yocto-{{#var:MACHINE_NAME}}$ VAR_RECOVERY_TARGET_ROOTFS="var-image-swupdate" bitbake var-recovery-image</pre>
+<!-- Set local variables
+--> {{#varexists: META_VARISCITE_SDK |
+|
+{{#vardefine:META_VARISCITE_SDK | {{#var:META_VARISCITE_REPO}}}}
+}}<!--
+-->{{#vardefine:UBUNTU_COMPAT|16.04}}<!--
+-->{{#vardefine:UBUNTU_COMPAT|{{#ifeq:{{#var:YOCTO_NAME}}|Morty|14.04/16.04|{{#var:UBUNTU_COMPAT}}}}}}<!--
+-->{{#vardefine:UBUNTU_COMPAT|{{#ifeq:{{#var:YOCTO_NAME}}|Zeus|18.04|{{#var:UBUNTU_COMPAT}}}}}}<!--
+-->{{#vardefine:UBUNTU_COMPAT|{{#ifexpr: {{#var:YOCTO_VERSION}} >= 3.1|18.04/20.04|{{#var:UBUNTU_COMPAT}}}}}}<!--
+-->{{#vardefine:UBUNTU_COMPAT|{{#ifexpr: {{#var:YOCTO_VERSION}} >= 4.0|18.04/20.04/22.04|{{#var:UBUNTU_COMPAT}}}}}}<!--
+-->{{#vardefine:UBUNTU_COMPAT|{{#ifexpr: {{#var:YOCTO_VERSION}} >= 4.2|20.04/22.04|{{#var:UBUNTU_COMPAT}}}}}}
+= Installing required packages =
+Please make sure your host PC is running Ubuntu {{#var:UBUNTU_COMPAT}} 64-bit and is up to date:
+  $ sudo apt-get update && sudo apt-get dist-upgrade
+Then, install the following packages:
+  {{#if:{{#var:BUILD_YOCTO_IN_DOCKER_CONTAINER}}|
+  $ sudo apt-get install python3 python3-pip python3-pexpect \
+  python3-git python3-jinja2 python3-subunit python3-git liblz4-tool \
+  python3-jinja2 python3-subunit curl zstd
+For Ubuntu 20.04 and earlier, install python2:
+ $ sudo apt-get install python python-pysqlite2
+{{#ifexpr:{{#rpos:{{#var:UBUNTU_COMPAT}}|16.04}} >= 0|{{Ubuntu16_Python}}|}}<!--
+-->{{#ifexpr:{{#rpos:{{#var:UBUNTU_COMPAT}}|22.04}} >= 0|{{Ubuntu22_Python}}|}}
+Install Docker:
+ $ sudo apt update && sudo apt install docker.io qemu-user-static
+Give permissions to run Docker without sudo:
+ $ sudo usermod -aG docker ${USER}
+{{Note|'''Note:''' Logout and login again for permissions to take effect.}}
+|
+  $ sudo apt-get install gawk wget git diffstat unzip texinfo gcc-multilib \
+  build-essential chrpath socat cpio python3 python3-pip python3-pexpect \
+  xz-utils debianutils iputils-ping libsdl1.2-dev xterm libyaml-dev libssl-dev
+  $ sudo apt-get install autoconf libtool libglib2.0-dev libarchive-dev \
+  sed cvs subversion coreutils texi2html docbook-utils \
+  help2man make gcc g++ desktop-file-utils libgl1-mesa-dev libglu1-mesa-dev \
+  mercurial automake groff curl lzop asciidoc u-boot-tools dos2unix mtd-utils pv \
+  libncurses5 libncurses5-dev libncursesw5-dev libelf-dev zlib1g-dev bc rename \
+  zstd libgnutls28-dev
+  {{#ifexpr: {{#var:YOCTO_VERSION}} >= 3.1|
+  $ sudo apt-get install python3-git liblz4-tool python3-jinja2 python3-subunit locales libacl1
+  |
+  $ sudo apt-get install python-git
+  }}
+For Ubuntu 20.04 and earlier, install python2:
+ $ sudo apt-get install python python-pysqlite2
+{{#ifexpr:{{#rpos:{{#var:UBUNTU_COMPAT}}|16.04}} >= 0|{{Ubuntu16_Python}}|}}<!--
+-->{{#ifexpr:{{#rpos:{{#var:UBUNTU_COMPAT}}|22.04}} >= 0|{{Ubuntu22_Python}}|}}
+{{Note|'''Note:''' Variscite provides Docker containers that can be used for a development environment as an alternative to using a virtual machine or a dedicated computer.
+To learn more, please see Variscite's [[Docker_Build_Environment | Docker Build Environment]] guide.}}
 }}
-* Boot the board using the created SD card. See more info {{Varlink|{{#var:GUIDE_NAME}} Build Release#Boot_the_board_with_a_bootable_SD_card|{{#var:RELEASE_LINK}}|here}}.
-* Install the demo image to the eMMC{{#ifeq: {{#var:SOC_SERIES}} | imx8 |&nbsp;using|. Either use the installation icons on the desktop (which will be updated with the "-u" parameter by the var-create-yocto-sdcard.sh script, when the recovery image used is {{#var:SWUPDATE_IMAGE_NAME}}), or use}} the {{#var:INSTALL_SCRIPT|install_yocto.sh}} script {{#ifeq: {{#var:SOC_SERIES}} | imx8||manually,}} with the "-u" parameter.
+= Reference documentation =
+  {{#lst:Yocto_Platform_Customization|YOCTO_DOC_{{#var:YOCTO_VERSION}}}} <!--
+-->{{#if:{{#var:FSLC_BSP_VERSION}}|{{#lst:Yocto_Platform_Customization|YOCTO_DOC_FSLC_BSP_{{#var:FSLC_BSP_VERSION}}}}|}} <!--
+-->{{#lst:Yocto_Platform_Customization|YOCTO_DOC_FSL_BSP_{{#var:FSL_BSP_VERSION}}}}
+= Download Yocto {{#var:YOCTO_NAME}} based on {{#varexists:FSLC_BSP_VERSION|Freescale Community BSP {{#var:FSLC_BSP_VERSION}}|NXP BSP {{#var:FSL_BSP_VERSION}}}} =
+Configure git user and email:
+ $ git config --global user.name "Your Name"
+ $ git config --global user.email "Your Email"
+Fetch and install the Google [https://gerrit.googlesource.com/git-repo/ git-repo] tool:
+ $ mkdir -p ~/bin
+ # For Ubuntu 20.04 and older, install repo 2.32 according to https://gerrit.googlesource.com/git-repo/+/HEAD/docs/python-support.md:
+ $ curl https://commondatastorage.googleapis.com/git-repo-downloads/repo-2.32 > ~/bin/repo
+ # For Ubuntu 22.04 and newer, install the latest repo tool:
+ $ curl https://commondatastorage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
+ # Give repo execute permissions and add it to the path:
+ $ chmod a+x ~/bin/repo
+ $ export PATH=~/bin:$PATH
+Create a build directory:
+ $ mkdir {{#var:BUILD_FOLDER}}
+ $ cd {{#var:BUILD_FOLDER}}
+Now, choose between downloading a release tag, and downloading the latest revision (recommended) and '''follow only one of the next two bullet sections''', accordingly:<br>
+<br>
+* '''Download the latest revision (recommended)'''<br>
+ {{#varexists: YOCTO_MANIFEST |
+ $ repo init -u {{#var:YOCTO_GIT}} -b {{#var:YOCTO_BRANCH}} -m {{#var:YOCTO_MANIFEST}}
+ $ repo sync -j$(nproc)
+|
+ $ repo init -u {{#var:YOCTO_GIT}} -b {{#var:YOCTO_BRANCH}}
+ $ repo sync -j$(nproc)
+ }}
+<br>
+or<br>
+<br>
+* Download a release tag<br>
+Each release in https://github.com/varigit/variscite-bsp-platform/releases corresponds to a tag.<br>
+The tags are also listed in https://github.com/varigit/variscite-bsp-platform/tags<br>
+To specify a specific release/tag, run the following:
+ $ repo init -u https://github.com/varigit/variscite-bsp-platform.git -b refs/tags/TAG_NAME
+ For example:
+ {{#varexists: YOCTO_MANIFEST |
+ $ repo init -u https://github.com/varigit/variscite-bsp-platform.git -b refs/tags/{{#var:RELEASE_NAME}} -m {{#var:YOCTO_MANIFEST}}
+ $ repo sync -j$(nproc)
+|
+ $ repo init -u https://github.com/varigit/variscite-bsp-platform.git -b refs/tags/{{#var:RELEASE_NAME}}
+ $ repo sync -j$(nproc)
+}}
+{{#if:{{#var:BUILD_YOCTO_IN_DOCKER_CONTAINER}}|
+Start a Ubuntu Docker container:
+ $ ./var-start-container.sh {{Note|'''Note:''' After Ubuntu Docker container is started you can see the shell prompt similar to: '''vari@yocto-{{#var:DOCKER_CONTAINER_INFO}}:/workdir$'''.}}
+}}
+= Setup and build Yocto =
+== Supported images ==
+{{#switch: {{#var:SOC_SERIES}} | imx8 | imx9=
+The following images are provided by Variscite for evaluation purpose
+* '''fsl-image-gui''': Default Variscite demo image with GUI and without any Qt{{#var:QT_VER}} content. This image recipe works for Xwayland and Wayland backends.
+{{#if:{{#var:YOCTO_SUPPORT_CHROMIUM}}|
+* '''fsl-image-gui-chromium''': Extends fsl-image-gui image with Chromium web browser.
+|}}
+* '''fsl-image-qt{{#var:QT_VER}}''': Extends fsl-image-gui image with Qt{{#var:QT_VER}} support and various Qt samples for Xwayland and Wayland backends.
+|
+The following images are provided by Variscite for evaluation purpose
+* '''fsl-image-gui''': Default Variscite demo image with GUI and without any Qt{{#var:QT_VER}} content. This image recipe works on all backends for {{#ifeq: {{#var:BUILD_DISTRO}} | fslc-x11 | X11, |}} Frame Buffer, Wayland and XWayland and the content is optimized to fit 512MB NAND flash.
+* '''fsl-image-qt{{#var:QT_VER}}''': Extends fsl-image-gui image with Qt{{#var:QT_VER}} support and various Qt samples for {{#ifeq: {{#var:BUILD_DISTRO}} | fslc-x11 | X11, |}} Frame Buffer, Wayland and XWayland backends.
+{{Note| Will result in image size greater than 512 MB, which will not fit into NAND flash. Use SD card or eMMC to test.}}
+}}
+{{#switch: {{#var:SOC_SERIES}} | imx8 | imx9=
+|
+The following images are provided by FSL Community BSP:
+* '''fsl-image-machine-test''': A console-only image that includes gstreamer packages{{#if:{{#var:GSTREAMER_SUPPORT}}|, Freescale’s multimedia packages (VPU and GPU),|}} and test and benchmark applications.
+* '''fsl-image-mfgtool-initramfs''': Small image to be used with Manufacturing Tool (mfg-tool) in a production environment.
+{{#if:{{#var:GSTREAMER_SUPPORT}}|
+* '''fsl-image-multimedia'''/'''fsl-image-multimedia-full''': A console-only image that includes gstreamer packages and Freescale’s multimedia packages (VPU and GPU).
+|}}
+}}
+See the list of Yocto Project’s reference images in [https://www.yoctoproject.org/docs/{{#var:YOCTO_VERSION}}/ref-manual/ref-manual.html#ref-images Yocto Project Reference Manual]
+== Supported distros ==
+The following distros can be used:
+{{#switch: {{#var:SOC_SERIES}} | imx8 | imx9=
+{{#varexists: FSLC_BSP_VERSION |
+* '''fslc-xwayland''': Distro for Wayland with X11. This distro includes both wayland and X11 features.
+* '''fslc-wayland''': Distro for Wayland without X11. This distro includes wayland feature but doesn’t have x11 support.
+|
+* '''fsl-imx-wayland''': Distro for Wayland without X11. This distro includes wayland feature but doesn’t have X11 support.
+* '''fsl-imx-xwayland''': Distro for Wayland with X11. This distro includes both wayland and X11 emulation features.
+}}
+|
+{{#ifeq: {{#var:BUILD_DISTRO_FB}} | fslc-framebuffer |
+{{#ifeq: {{#var:BUILD_DISTRO}} | fslc-x11 |
+* '''fslc-x11''': Distro for X11 without wayland. This distro include x11 feature and doesn’ has wayland support.
+|
+{{note| For this Yocto release, NXP/Vivante do no longer provide GPU accelerations for X11 native backend.}}
+}}
+* '''fslc-framebuffer''': Distro for Framebuffer graphical backend. This distro doesn’t include X11 and wayland features.
+* '''fslc-wayland''': Distro for Wayland without X11. This distro includes wayland feature but doesn’t have x11 support.
+* '''fslc-xwayland''': Distro for Wayland with X11. This distro includes both wayland and X11 emulation features.
+|
+* '''fsl-imx-x11''': Distro for X11 without wayland. This distro include x11 feature and doesn’ has wayland support.
+* '''fsl-imx-fb''': Distro for Framebuffer graphical backend. This distro doesn’t include X11 and wayland features.
+* '''fsl-imx-wayland''': Distro for Wayland without X11. This distro includes wayland feature but doesn’t have x11 support.
+* '''fsl-imx-xwayland''': Distro for Wayland with X11. This distro includes both wayland and X11 emulation features.
+}}
+}}
+Note: Also [http://www.informit.com/articles/article.aspx?p=2514911&seqNum=4 standard Poky distros] can be used
+{{#if:{{#var:GSTREAMER_SUPPORT}}|
+== GStreamer support ==
+{{#switch: {{#var:SOC_SERIES}} | imx8 | imx9=
+|
+FSL community BSP comes with [https://github.com/Freescale/gstreamer-imx/blob/master/README.md gstreamer-imx], a set of GStreamer1.0 plugins for i.MX platform, which make use of the i.MX multimedia capabilities.<br>
+Some of the multimedia plugins do not work well with X11 and Wayland backends.<br>
+To get the most from gstreamer-imx, it is recommended to use fslc-framebufer distro with one of the demo images
+}}
+|}}
+== {{#ifeq: {{#var:BUILD_FOLDER_X11}} | build_x11 | Build X11 | Build XWayland }} GUI demo image ==
+{{#lst:Yocto_Platform_Customization|YOCTO_ENV_SETUP_X}}
+{{#lst:Yocto_Platform_Customization|YOCTO_ENV_SETUP_X_SHORT}}
+{{#vardefine:SHELL_PROMPT|{{#if:{{#var:BUILD_YOCTO_IN_DOCKER_CONTAINER}}|vari@yocto-{{#var:DOCKER_CONTAINER_INFO}}:/workdir/{{#var:BUILD_FOLDER_ENV}}$|$}}}}
+{{#var:GITHUB_WARNING}}
+<br>
+Optional steps: [[#local.conf customization|local.conf customization]]
+launch bitbake:
+ Without Qt content:
+ {{#var:SHELL_PROMPT}} bitbake fsl-image-gui
+ {{#if:{{#var:YOCTO_SUPPORT_CHROMIUM}}|
+ Or with Chromium:
+ {{#var:SHELL_PROMPT}} bitbake fsl-image-gui-chromium
+|}}
+ Or with Qt content:
+ {{#var:SHELL_PROMPT}} bitbake fsl-image-qt{{#var:QT_VER}}
+{{#switch: {{#var:SOC_SERIES}} | imx8 | imx9=
+|
+{{#if:{{#var:GSTREAMER_SUPPORT}}|
+NOTE: Some of the [https://github.com/Freescale/gstreamer-imx/blob/master/docs/blitter-architecture.md blitter-based i.MX GStreamer plugins] do not work with X11 and Wayland backends. To get the most of the i.MX GPU/VPU acceleration, use the fslc-framebuffer backend.
+|}}
+== Build console-only demo image {{#if:{{#var:GSTREAMER_SUPPORT}}|with Freescale’s multimedia packages (VPU and GPU)|}} ==
+ $ cd {{#var:BUILD_FOLDER}}
+ $ MACHINE={{#var:MACHINE_NAME}} DISTRO={{#var:BUILD_DISTRO_FB}} {{#var:BUILD_SCR_CMD}} {{#var:BUILD_FOLDER_FB}}
+{{#var:GITHUB_WARNING}}
+<br>
+Optional steps: [[#local.conf customization|local.conf customization]]
+<pre>
+Without Qt content:
+$ bitbake fsl-image-gui
+{{#if:{{#var:YOCTO_SUPPORT_CHROMIUM}}|
+Or with Chromium:
+$ bitbake fsl-image-gui-chromium
+|}}
+Or with Qt content:
+$ bitbake fsl-image-qt{{#var:QT_VER}}
+</pre>
+}}
+== local.conf customization ==
+=== Change the downloads directory ===
+Create a /opt/yocto_downloads directory and set its permissions:
+<pre>
+$ sudo mkdir /opt/yocto_downloads
+$ sudo chmod 777 /opt/yocto_downloads/
+</pre>
+Direct downloads to it, by replacing 'DL_DIR ?= "${BSPDIR}/downloads/"' with 'DL_DIR = "/opt/yocto_downloads/"' in conf/local.conf under your build directory:
+<pre>
+$ sed -i 's/DL_DIR ?= "${BSPDIR}\/downloads/DL_DIR = "\/opt\/yocto_downloads/g' conf/local.conf
+</pre>
+=== Add Qt creator and Eclipse debug support to your images ===
+{{#ifexpr: {{#var:YOCTO_VERSION}} > 2.4 |
+Append the following to the conf/local.conf file in your Yocto build directory, to add Eclipse debug support to your images:
+<pre>
+EXTRA_IMAGE_FEATURES = " \
+    eclipse-debug \
+    ssh-server-openssh \
+    "
+</pre>
+Append the following to the conf/local.conf file in your Yocto build directory, to add Qt creator debug support to your images:
+<pre>
+EXTRA_IMAGE_FEATURES = " \
+    qtcreator-debug \
+    ssh-server-openssh \
+    "
+</pre>
+|
+Append the following to the conf/local.conf file in your Yocto build directory, to add Eclipse debug and Qt creator support to your images:
+<pre>
+EXTRA_IMAGE_FEATURES = " \
+    debug-tweaks \
+    tools-debug \
+    eclipse-debug \
+    "
+IMAGE_INSTALL_append = " \
+    tcf-agent \
+    openssh-sftp-server \
+    "
+</pre>
+}}
+{{#switch: {{#var:SOC_SERIES}} | imx8 | imx9=
+|
+{{#ifeq: {{#var:RELEASE_LINK}} | RELEASE_ZEUS_V1.0_DART-6UL |
+=== Use SysV instead of systemd init ===
+Apply this [https://github.com/varigit/meta-variscite-imx/commit/209a3615706d472c511e9647c267ded5b314c692 patch] to the meta-variscite-imx layer
+|
+=== Use systemd instead of SysV init ===
+{{#ifeq: {{#rpos:{{#var:RELEASE_LINK}}|RELEASE_ZEUS_V1}} | 0 |
+Comment out the last 4 lines of file [https://github.com/varigit/meta-variscite-imx/blob/zeus-imx-5.4.3-var01/conf/machine/imx6ul-var-dart.conf#L82-L85 ~/var-fsl-yocto/sources/meta-variscite-imx/conf/machine/imx6ul-var-dart.conf]
+|
+Append the following to the conf/local.conf file in your Yocto build directory, to use systemd instead of SysV init in your images:
+<pre>
+DISTRO_FEATURES_append = " systemd"
+DISTRO_FEATURES_BACKFILL_CONSIDERED_append = " sysvinit"
+VIRTUAL-RUNTIME_init_manager = "systemd"
+VIRTUAL-RUNTIME_initscripts = ""
+IMX_DEFAULT_DISTRO_FEATURES_append = " systemd"
+</pre>
+}}
+}}
+}}
+=== Create a read-only root file system ===
+Append the following to the conf/local.conf file in your Yocto build directory, to create a read-only rootfs:
+<pre>
+EXTRA_IMAGE_FEATURES += "read-only-rootfs"
+</pre>
+== Build Results ==
+The resulting images are located in tmp/deploy/images/{{#var:MACHINE_NAME}}.
+{{#lst:Yocto_Platform_Customization|{{#var:YOCTO_BUILD_RESULTS_SECTION}}}}
+{{#ifexpr: {{#var:YOCTO_VERSION}} < 4.1
+    | {{Yocto_Create_Bootable_SD_Legacy}}
+    | {{Yocto_Create_Bootable_SD}}
+}}
+= Boot the board with a bootable SD card =
+{{#ifeq: {{#var:HARDWARE_NAME}} | DART-6UL |
+Note: <span style="color:red">The WiFi is not operational when booting from SD card</span>, as the WiFi and SD card are using the same SDIO interface.<br>
+A typical use-case is to boot from an SD card, flash the eMMC/NAND flash, and re-boot from the eMMC/NAND flash to have the WiFi operational.
+|}}
+{{#ifeq: {{#var:HARDWARE_NAME}} | DART-MX8M |
+Note: <span style="color:red">The WiFi is not operational when booting from SD card</span>, as the WiFi and SD card are using the same SDIO interface.<br>
+A typical use-case is to boot from an SD card, flash the eMMC, and re-boot from the eMMC to have the WiFi operational.
+|}}
+== Setting the Boot Mode ==
+{{#lst:Yocto_Platform_Customization|{{#var:YOCTO_BOOT_BOARD_SECTION}}}}
+{{#ifeq: {{#var:HARDWARE_NAME}} | VAR-SOM-MX8X|
+|
+== Automatic device tree selection in U-Boot ==
+As shown in the [[#Build_Results| Build Results]] table above, we have different kernel device trees, corresponding to our different H/W configurations.<br>
+{{#ifeq: {{#var:HARDWARE_NAME}} | DART-MX8M |
+We implemented a script in U-Boot's environment, which sets the fdt_file environment variable based on the detected version of the carrier board revision.<br>
+This file is actually a symbolic link, pointing to the real dtb file. The symbolic link can be set manually and defaults to the LVDS display configuration<br>
+(when using the install_yocto.sh script with a display parameter, this script automatically sets this symbolic link to the appropriate dtb file).<br>
+|
+We implemented a script in U-Boot's environment, which sets the fdt_file environment variable based on the detected hardware.
+}}
+=== Enable/Disable automatic device tree selection ===
+To enable the automatic device tree selection in U-Boot (already enabled by default):
+<pre>
+$ setenv fdt_file undefined
+$ saveenv
+</pre>
+To disable the automatic device tree selection in U-Boot, set the device tree file manually:
+<pre>
+$ setenv fdt_file YOUR_DTB_FILE
+$ saveenv
+</pre>
+{{#switch: {{#var:SOC_SERIES}} | imx8 | imx9=
+Useful example: To list all files in the /boot directory (where the dtb files are by default) of an SD card:
+ $ ls mmc {{#var:U-BOOT_SD_DEV}}:1 /boot
+|
+Useful example: To list all files in the boot partition (where the dtb files are by default) of an SD card:
+<pre>
+$ ls mmc 0:1
+</pre>
+}}
+<!-- Make NOTE for DART-6UL only -->
+{{#ifeq: {{#var:HARDWARE_NAME}} | DART-6UL |
+{{note|Comment:<br>Make sure you don't set an inappropriate dtb file, like a dtb with nand on a SOM that has eMMC, or a dtb for mx6ull on a SOM with an mx6ul SOC.|info}}
+|}}
+}}
+= Flash images to NAND/eMMC =
+Please refer to {{Varlink2|Yocto NAND Flash Burning|{{#var:RELEASE_LINK}}}} guide.
+= Yocto Image Customization =
+== Update Yocto {{#var:YOCTO_NAME}} to latest revision ==
+From time to time we update the Yocto sources (especially meta-variscite) with new features and bug fixes.<br>
+Follow the '''Download the latest revision (recommended)''' bullet section of the [[#Download Yocto {{#var:YOCTO_NAME}} based on Freescale Community BSP|Download Yocto {{#var:YOCTO_NAME}} based on Freescale Community BSP]] step again to update your tree to the latest revision, and rebuild your image.
+== Update Yocto {{#var:YOCTO_NAME}} to a release tag ==
+Follow the '''Download a release tag''' bullet section of the [[#Download Yocto {{#var:YOCTO_NAME}} based on Freescale Community BSP|Download Yocto {{#var:YOCTO_NAME}} based on Freescale Community BSP]] step to update your tree to a release tag, and rebuild your image.
+== Forcing Clean Build ==
+ In order to update the kernel, U-Boot and rootfs:
+ {{#var:SHELL_PROMPT}} bitbake -c cleanall u-boot-variscite linux-variscite kernel-module-imx-gpu-viv ti-compat-wireless-wl18xx wl18xx-firmware cryptodev-module
+ for GUI image
+ {{#var:SHELL_PROMPT}} bitbake -c clean fsl-image-gui
+ for Qt{{#var:QT_VER}} image
+ {{#var:SHELL_PROMPT}} bitbake -c clean fsl-image-qt{{#var:QT_VER}}
+{{#switch: {{#var:SOC_SERIES}} | imx8 | imx9=
+|
+== Qt{{#var:QT_VER}} for Embedded Linux ==
+To run Qt{{#var:QT_VER}} applications without X11 backend the platform specific plugins (e.g. EGLFS or LinuxFB) should be configured with QT_QPA_PLATFORM environment variable or with -platform command-line.
+{{Note| See more information on Qt{{#var:QT_VER}} customization for Embedded Linux [http://doc.qt.io/qt-5.6/embedded-linux.html here]}}
+{{#ifeq: {{#var:HARDWARE_NAME}} | VAR-SOM-MX6 |
+=== Configure EGLFS Plugin ===
+<pre>
+export QT_QPA_EGLFS_PHYSICAL_HEIGHT=95
+export QT_QPA_EGLFS_PHYSICAL_WIDTH=160
+export QT_QPA_EGLFS_HEIGHT=480
+export QT_QPA_EGLFS_WIDTH=800
+export QT_EGLFS_IMX6_NO_FB_MULTI_BUFFER=1
+export QT_QPA_EGLFS_DEPTH=24
+export QT_QPA_PLATFORM=eglfs
+</pre>
+|
+=== Configure LinuxFB Plugin ===
+{{#var:HARDWARE_NAME}} supports only LinuxFB plugin
+<pre>
+export QT_QPA_PLATFORM=linuxfb:fb=/dev/fb0:size=800x480:mmSize=160x95
+</pre>
+LinuxFB plugin is optimized for not accelerated platforms, but do not provide rotation capabilities.
+If required you may be interested in reading [https://borkedlabs.com/blog/2015/06-01-qt{{#var:QT_VER}}-linuxfb-rotation-for-lcds this article], providing a dedicate patch and usage instructions.
+{{#ifeq: {{#var:QT5_FB_SUPPORT_ROTATION}} | true |
+The patch proposed in the above article has been ported in the Yocto BSP and the rotation option is available for linuxfb plugin.
+|
+To integrate the patch in yocto BSP, you are supposed to:
+* copy the plane patch in the folder
+   {{#var:BUILD_FOLDER}}/sources/{{#var:META_VARISCITE_SDK}}/dynamic-layers/qt{{#var:QT_VER}}-layer/recipes-qt/qt{{#var:QT_VER}}/qtbase
+* add the reference patch in the SRC_URI_append section of file
+   {{#var:BUILD_FOLDER}}/sources/{{#var:META_VARISCITE_SDK}}/dynamic-layers/qt{{#var:QT_VER}}-layer/recipes-qt/qt{{#var:QT_VER}}/qtbase_%.bbappend
+}}
+}}
+=== Configure Touch Input ===
+When no windowing system is present, the mouse, keyboard, and touch input are read directly via evdev or tslib.
+==== Evdev ====
+By default, the Qt{{#var:QT_VER}} uses automatic device discovery based on libudev.
+In case you want to override the default touchscreen configuration the following parameters can be used:
+*/dev/input/... - Specifies the name of the input device. When not given, Qt looks for a suitable device either via libudev or by walking through the available nodes.
+* rotate - On some touch screens the coordinates must be rotated, which is done by setting rotate to 90, 180, or 270.
+* invertx and inverty - To invert the X or Y coordinates in the input events, pass invertx or inverty.
+<pre>export QT_QPA_EVDEV_TOUCHSCREEN_PARAMETERS='/dev/input/touchscreen0'</pre>
+==== Tslib ====
+Tslib is used for resistive single-touch touchscreens and should be pre-configured with:
+<pre>
+export TSLIB_TSEVENTTYPE='INPUT'
+export TSLIB_TSDEVICE='/dev/input/touchscreen0'
+export TSLIB_CALIBFILE='/etc/pointercal'
+export TSLIB_CONFFILE='/etc/ts.conf'
+export TSLIB_CONSOLEDEVICE='none'
+export TSLIB_FBDEVICE='/dev/fb0'
+export TSLIB_PLUGINDIR='/usr/lib/ts'
+export QT_QPA_EGLFS_TSLIB=1
+export QT_QPA_FB_TSLIB=1
+</pre>
+It is recommended to put the above setup inside /etc/profile.d/tslib.sh.
+=== Running Qt{{#var:QT_VER}} Applications ===
+ $ cd /usr/share/cinematicexperience-1.0; ./Qt5_CinematicExperience --platform {{#var:QT_PLATFORM_PLUGIN}}
+ $ cd /usr/share/qt5everywheredemo-1.0; ./QtDemo --platform {{#var:QT_PLATFORM_PLUGIN}}
+ $ cd /usr/share/qtsmarthome-1.0; ./smarthome --platform {{#var:QT_PLATFORM_PLUGIN}}
+== UBIFS ==
+By default we create ubifs image for 512MB NAND flash size.
+You can change the size by editing {{#var:BUILD_FOLDER}}/sources/{{#var:META_VARISCITE_REPO}}/conf/machine/include/variscite.inc <br>and comment / uncomment the relevant section based on size.
+}}
+{{#if:{{#var:GSTREAMER_SUPPORT}}|
+== DDR size and Contiguous Memory Allocator ==
+By default Freescale allocates 256MB of RAM to the Contiguous Memory allocator.
+This is for proper operation of the IPU VPU, X11 etc.
+On VAR-SOM-SOLO with 256MB DDR RAM size, it will cause a kernel freeze during boot.
+Adding cma=32MB to the bootargs parameters is required to fix.
+|}}
+= Make changes to the rootfs =
+The following is usually not the recommended way to work with Yocto.<br>
+You should usually create new specific recipes (.bb files) and/or append to specific present recipes by using .bbappend files.<br>
+However, if you are not yet experienced enough with Yocto, and you just want to quickly add your files to the resultant file system (or make any other change to it), you can do it in a general way, by using the following variable:
+<pre>
+ROOTFS_POSTPROCESS_COMMAND
+    Specifies a list of functions to call once the OpenEmbedded build system has created the root filesystem.
+    You can specify functions separated by semicolons:
+         ROOTFS_POSTPROCESS_COMMAND += "function; ... "
+    If you need to pass the root filesystem path to a command within a function, you can use ${IMAGE_ROOTFS},
+    which points to the directory that becomes the root filesystem image. See the IMAGE_ROOTFS variable for more information.
+</pre>
+The functions will be called right after the root filesystem is created and right before it is packed to images (.{{#var:SDCARD_IMG_EXT}}, .ubi, .tar.gz, etc.).<br>
+== Example ==
+Let's say you have your files that you want to put in the filesystem arranged on your host under a directory called /my_rootfs_additions, like the following:
+<pre>
+my_rootfs_additions/
+├── data
+│   ├── example.m4v
+│   └── example.bin
+├── etc
+│   └── example.conf
+└── home
+    └── root
+        └── .example
+</pre>
+And let's say you want to build the fsl-image-gui image.<br>
+<br>
+Create a file called {{#var:BUILD_FOLDER}}/sources/{{#var:META_VARISCITE_REPO}}/recipes-images/images/fsl-image-gui.bbappend<br>
+with the following content:
+<pre>
+add_my_files() {
+    cp -r /my_rootfs_additions/*  ${IMAGE_ROOTFS}/
+}
+ROOTFS_POSTPROCESS_COMMAND += "add_my_files;"
+</pre>
+Now, when you bitbake fsl-image-gui, the files in /my_rootfs_additions will be added to the rootfs (be careful when overwriting files).<br>
+= Useful Bitbake commands =
+[http://elinux.org/Bitbake_Cheat_Sheet Bitbake Cheat Sheet]
+[https://community.freescale.com/docs/DOC-94953 Useful bitbake commands]
+[https://community.freescale.com/docs/DOC-94874 i.MX Yocto Project: ltib versus bitbake]
 </includeonly>

Template:YOCTO ENV SETUP X SHORT FF: Difference between revisions

Latest revision as of 21:49, 28 October 2024