===== Preface =====


The //meta-tq// layer extends the //Yocto Project's// reference system //Poky// to provide support for a selection of TQ Embedded CPU Modules, including the <label mod_name>MOD_NAME</label>.
<WRAP hide>
It uses the same codebase as the [[..:arm:<label mod_name>MOD_NAME</label>:linux:ptxdist:overview|PTXdist based TQ Linux BSPs]] and therefore provides the same versions of U-Boot and Linux kernel, but doesn't define a specific root filesystem configuration.
</WRAP>
<callout type="primary" icon="true">
Because of the dependencies to the other yocto layers we recommend to use [[https://github.com/tq-systems/ci-meta-tq|ci-meta-tq]] which already provides all required yocto layers as git submodules instead of [[https://github.com/tq-systems/meta-tq|meta-tq]] to  build this BSP release. 
</callout>
The instructions on this page refer to the BSP and ancillary tools listed in the following table:
<grid>
<col sm="6">
<panel no-body="true">
^ BSP Revision  ^  <label yocto_rel_branch_rev>YOCTO_REL_BRANCH_REV</label>  ^
^ ++meta-tq release|\\ [[https://github.com/tq-systems/ci-meta-tq/releases|all releases]]++  |  [[https://github.com/tq-systems/ci-meta-tq/releases/tag/<label yocto_rel_branch>YOCTO_REL_BRANCH</label>.<label mod_name_mtq>MOD_NAME_MTQ</label>.BSP.SW.<label bsp_rev>BSP_REV</label>|<label yocto_rel_branch>YOCTO_REL_BRANCH</label>.<label mod_name_mtq>MOD_NAME_MTQ</label>.BSP.SW.<label bsp_rev>BSP_REV</label>]]  |
^ Yocto Project / Poky Release  |  ++<label yocto_rel_ver_major>YOCTO_REL_VER_MAJOR</label>.<label yocto_rel_ver_minor>YOCTO_REL_VER_MINOR</label> - <label yocto_rel_name>YOCTO_REL_NAME</label>|\\ ''git clone -b <label yocto_rel_branch>YOCTO_REL_BRANCH</label> git:%%//%%git.yoctoproject.org%%/%%poky.git''\\ [[https://<label yocto_rel_base_url>YOCTO_REL_BASE_URL</label>/yocto-<label yocto_rel_ver_major>YOCTO_REL_VER_MAJOR</label>.<label yocto_rel_ver_minor>YOCTO_REL_VER_MINOR</label>/<label yocto_rel_tarball>YOCTO_REL_TARBALL</label>|<label yocto_rel_tarball>YOCTO_REL_TARBALL</label>]]++  |
^ Target machine((i.e. value for [[https://<label yocto_doc_base_url>YOCTO_DOC_BASE_URL</label>/<label yocto_rel_ver_major>YOCTO_REL_VER_MAJOR</label>.<label yocto_rel_ver_minor>YOCTO_REL_VER_MINOR</label>/ref-manual/ref-manual.html#var-MACHINE|MACHINE]] variable))  |  <label mtq_machines>MTQ_MACHINES</label>  |
^ U-Boot  |  <label uboot_version>UBOOT_VERSION</label>  |
^ Linux Kernel  |  <label linux_kernel>LINUX_KERNEL</label>  |
</panel>
</col>
</grid>
<alert type="warning" icon="fa fa-warning">It's strongly recommended to use **git** for downloading both the //Yocto Project / Poky// Release as well as //ci-meta-tq// (instead of downloading archives and extracting them)</alert>

<callout type="info" icon="true">
The goal of these wiki pages is to get you started using //ci-meta-tq// with the <label stk_name>STK_NAME</label>, so instead of reinventing the wheel we will adhere to the very compact [[https://<label yocto_doc_base_url>YOCTO_DOC_BASE_URL</label>/<label yocto_rel_ver_major>YOCTO_REL_VER_MAJOR</label>.<label yocto_rel_ver_minor>YOCTO_REL_VER_MINOR</label>/brief-yoctoprojectqs/index.html |Yocto Project Quick Start]] and supply details specific to the <label stk_name>STK_NAME</label> where necessary.\\
\\
For further details regarding //Yocto Project// <label yocto_rel_ver_major>YOCTO_REL_VER_MAJOR</label>.<label yocto_rel_ver_minor>YOCTO_REL_VER_MINOR</label> - <label yocto_rel_name>YOCTO_REL_NAME</label> please refer to its [[https://docs.yoctoproject.org/|official documentation]].
</callout>

===== Prerequisites  =====

<panel type="primary" title="Build Host">

//Yocto Project / Poky// requires a Linux build host, so first of all you need a development workstation (or a virtual machine((for testing purposes //Yocto Project// provides a ready to use virtual machine called [[https://www.yoctoproject.org/tools-resources/projects/build-appliance|Build Appliance]]))) 
with a Linux distribution installed.

Please refer to section [[https://<label yocto_doc_base_url>YOCTO_DOC_BASE_URL</label>/<label yocto_rel_ver_major>YOCTO_REL_VER_MAJOR</label>.<label yocto_rel_ver_minor>YOCTO_REL_VER_MINOR</label>/brief-yoctoprojectqs/brief-yoctoprojectqs.html#brief-compatible-distro|Compatible Linux Distribution]] of the //Yocto Project Quick Start// for supported linux distributions and section [[https://<label yocto_doc_base_url>YOCTO_DOC_BASE_URL</label>/<label yocto_rel_ver_major>YOCTO_REL_VER_MAJOR</label>.<label yocto_rel_ver_minor>YOCTO_REL_VER_MINOR</label>/brief-yoctoprojectqs/brief-yoctoprojectqs.html#brief-build-system-packages|Build Host Packages]] for required build host packages for those distributions.

<callout type="info" icon="true">
The instructions on this page have been tested on <label host_os_name>HOST_OS_NAME</label> <label host_os_version>HOST_OS_VERSION</label> (<label host_os_bits>HOST_OS_BITS</label>) in a VMWare virtual machine.
</callout>
Although not required by //Yocto Project / Poky//, we also recommend to configure and run a [[en:tftp|tftp server]] (for image download / update) and an [[en:nfs|nfs server]] (for network mounted root filesystem) on your development host.
</panel>

===== Yocto BSP Build Instructions =====

<panel type="primary" title=" Yocto Hardknott BSP">
<alert type="warning" icon="fa fa-warning">Please setup the build host as described in the [[.:quickstart_yocto#Prerequisites]] section above .</alert>

1. Open a new terminal and create a directory for the BSP build e.g. in the home directory and navigate to that directory.
<code>
mkdir -p ~/workspace/<label yocto_rel_branch>YOCTO_REL_BRANCH</label>.<label yocto_rel_branch_module>YOCTO_REL_BRANCH_MODULE</label>.BSP.SW.<label yocto_rel_branch_rev>YOCTO_REL_BRANCH_REV</label>
cd ~/workspace/<label yocto_rel_branch>YOCTO_REL_BRANCH</label>.<label yocto_rel_branch_module>YOCTO_REL_BRANCH_MODULE</label>.BSP.SW.<label yocto_rel_branch_rev>YOCTO_REL_BRANCH_REV</label>
</code>   
2. Create a local copy of <label mtq_repos>MTQ_REPOS</label>
<code>
$ git clone --recurse-submodules https://github.com/tq-systems/ci-meta-tq.git
</code>
3. Checkout BSP release on new local branch.
<code>
$ cd ci-meta-tq
$ git checkout <label yocto_rel_branch>YOCTO_REL_BRANCH</label>.<label yocto_rel_branch_module>YOCTO_REL_BRANCH_MODULE</label>.BSP.SW.<label yocto_rel_branch_rev>YOCTO_REL_BRANCH_REV</label> -b <label yocto_local_branch_name>YOCTO_LOCAL_BRANCH_NAME</label>
</code>
4. Update git submodules:
<code>
$ git submodule sync
$ git submodule update --init
</code>
5. Setup local branch to track the remote branch.
<code>
git branch -u origin/<label yocto_remote_branch_name>YOCTO_REMOTE_BRANCH_NAME</label>
</code>
6. Export the environment DISTRO and MACHINE((valid machines are\\ <label mtq_machines>MTQ_MACHINES</label>)) variable:
<code>
$ export DISTRO=<label distro_env>DISTRO_ENV</label>
$ export MACHINE=<label machine_env>MACHINE_ENV</label>
</code>
7. Configure the Build:
<code>
$ source setup-environment <label mod_name_code>MOD_NAME_CODE</label>_build <label ci_mtq_build_cfg>CI_MTQ_CFG</label>
</code>
<callout type="info" icon="true">Each time a new terminal is opened, the build environment must be reinitialised. The command described above is intended for the initial build space initialisation.  
To return to an existing buildspace open up a new terminal and navigate to the ci-meta-tq folder and execute the following command: 

<code>
source setup-environment <label mod_name_code>MOD_NAME_CODE</label>_build
</code>
</callout>
8. Build an Image for <label stk_name>STK_NAME</label>:
<accordion collapsed="true">
<panel title="Image with debug features and packages">
<code>
$ bitbake <label mtq_image>MTQ_IMAGE</label>-debug
</code>
</panel>
<panel title="Image without debug features and root login">
<code>
$ bitbake <label mtq_image>MTQ_IMAGE</label>
</code>
</panel>
</accordion>
<alert type="info" icon="fa fa-info">The resulting image is ''tmp/deploy/images/<label mtq_machine_default>MTQ_MACHINE_DEFAULT</label>((valid machines are\\ <label mtq_machines>MTQ_MACHINES</label>))/<label mtq_image>MTQ_IMAGE</label>-<label mtq_machine_default>MTQ_MACHINE_DEFAULT</label>((valid machines are\\ <label mtq_machines>MTQ_MACHINES</label>)).wic''</alert>\\
9. Write the Image((valid machines are\\ <label mtq_machines>MTQ_MACHINES</label>))((''TARGET_DEVICE'' has to be an SD card))
<code>
$ sudo dd if=tmp/deploy/images/<label mtq_machine_default>MTQ_MACHINE_DEFAULT</label>/<label mtq_image>MTQ_IMAGE</label>-<label mtq_machine_default>MTQ_MACHINE_DEFAULT</label>.wic of=/dev/<TARGET_DEVICE>
</code>
<alert type="info" icon="fa fa-info">Please see [[./deployment_yocto#create_sd_card_with_bsp_image|Create SD Card with BSP Image]] for detailed instructions.</alert>
10. Boot the <label stk_name>STK_NAME</label> from SD card (cf. [[<label lang>LANG</label>:<label mod_arch>MOD_ARCH</label>:<label mod_name>MOD_NAME</label>:<label mb_name_code>MB_NAME_CODE</label>:dip_switches|<label mb_name>MB_NAME</label> DIP switch settings]])  |
</panel>
===== Old Yocto Release Build Instructions =====

<accordion collapsed="true">
<panel type="default" title="Yocto Zeus BSP"> 
<alert type="warning" icon="fa fa-warning">Please setup the build host as described in the //Yocto Project Quick Start// sections [[https://www.yoctoproject.org/docs/3.0.3/brief-yoctoprojectqs/brief-yoctoprojectqs.html#brief-compatible-distro|Compatible Linux Distribution]] and [[https://www.yoctoproject.org/docs/3.0.3/brief-yoctoprojectqs/brief-yoctoprojectqs.html#brief-build-system-packages|Build Host Packages]].</alert>

1. Create a local copy of <label mtq_repos>MTQ_REPOS</label>
<code>
$ git clone --recurse-submodules https://github.com/tq-systems/ci-meta-tq.git
</code>
2. Checkout BSP release on new local branch.
<code>
$ cd ci-meta-tq
$ git checkout <label yocto_zeus_rel_branch>YOCTO_ZEUS_REL_BRANCH</label>.<label yocto_zeus_rel_branch_module>YOCTO_ZEUS_REL_BRANCH_MODULE</label>.BSP.SW.<label yocto_zeus_rel_branch_rev>YOCTO_ZEUS_REL_BRANCH_REV</label> -b <label yocto_zeus_local_branch_name>YOCTO_ZEUS_LOCAL_BRANCH_NAME</label>
</code>
3. Update git submodules:
<code>
$ git submodule update --init
$ git submodule sync
</code>
4. Setup local branch to track the remote branch.
<code>
git branch -u origin/<label yocto_zeus_remote_branch_name>YOCTO_ZEUS_REMOTE_BRANCH_NAME</label>
</code>
5. Configure the Build((valid machines are\\ <label mtq_machines_zeus>MTQ_MACHINES_ZEUS</label>)):
<code>
$ source imx-setup-release.sh -b <label mod_name_code>MOD_NAME_CODE</label>_build -e wayland
$ echo 'MACHINE = "<label mtq_machine_default_zeus>MTQ_MACHINE_DEFAULT_ZEUS</label>"' >> conf/local.conf
</code>
<callout type="info" icon="true">Each time a new terminal is opened, the build environment must be reinitialised. The command described above is intended for the initial build space initialisation.  
To return to an existing buildspace open up a new terminal and navigate to the ci-meta-tq folder and execute the following command: 

<code>source setup-environment tqma8mpxl_build</code>
</callout>
6. Build an Image for <label stk_name>STK_NAME</label>:
<code>
$ bitbake <label mtq_image>MTQ_IMAGE</label>
</code>
<alert type="info" icon="fa fa-info">The resulting image is ''tmp/deploy/images/<label mtq_machine_default_zeus>MTQ_MACHINE_DEFAULT_ZEUS</label>((valid machines are\\ <label mtq_machines_zeus>MTQ_MACHINES_ZEUS</label>))/<label mtq_image_zeus>MTQ_IMAGE_ZEUS</label>-<label mtq_machine_default_zeus>MTQ_MACHINE_DEFAULT_ZEUS</label>((valid machines are\\ <label mtq_machines_zeus>MTQ_MACHINES_ZEUS</label>)).wic''</alert>\\ 
7. Write the Image((valid machines are\\ <label mtq_machines_zeus>MTQ_MACHINES_ZEUS</label>))((''TARGET_DEVICE'' has to be an SD card))
<code>
$ sudo dd if=tmp/deploy/images/<label mtq_machine_default_zeus>MTQ_MACHINE_DEFAULT_ZEUS</label>/<label mtq_image_zeus>MTQ_IMAGE_ZEUS</label>-<label mtq_machine_default_zeus>MTQ_MACHINE_DEFAULT_ZEUS</label>.wic of=/dev/<TARGET_DEVICE>
</code>
<alert type="info" icon="fa fa-info">Please see [[./deployment_yocto#create_sd_card_with_bsp_image|Create SD Card with BSP Image]] for detailed instructions.</alert>

8. Boot the <label stk_name>STK_NAME</label> from SD card (cf. [[<label lang>LANG</label>:<label mod_arch>MOD_ARCH</label>:<label mod_name>MOD_NAME</label>:<label mb_name_code>MB_NAME_CODE</label>:dip_switches|<label mb_name>MB_NAME</label> DIP switch settings]])  |
</panel>
</accordion>