===== Preface =====
<WRAP info round>
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.
</WRAP>

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>
<WRAP info round>
Please use //ci-meta-tq// instead of //meta-tq// to build this release of the BSP.
</WRAP>
The instructions on this page refer to the BSP and ancillary tools listed in the following table:

^ BSP Revision  ^  <label bsp_rev>BSP_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_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>  |

\\
<WRAP important round>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).</WRAP>

<WRAP info round>
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/brief-yoctoprojectqs.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://www.yoctoproject.org/docs/archived-documents/|official documentation]].
</WRAP>


===== Prerequisites  =====

//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 (preferably) recent 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.

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.

===== Yocto Project / Poky set-up =====

The [[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|Yocto Project Quick Start]] document explains how to set up //Yocto Project / Poky// and how to build images using the //meta-intel// layer.
Using this as a guideline, the following table describes how to use the //ci-meta-tq// layer for the <label stk_name>STK_NAME</label>.

^ Section  ^ Remarks / Instructions for //ci-meta-tq// & <label stk_name>STK_NAME</label>  ^
| [[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-welcome|Welcome!]]  | <wrap info round>Introduction and basic information about the //Yocto Project//</wrap>  |
| [[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|Setting Up to Use the Yocto Project]]  | <wrap info round>Description of basic requirements for using the //Yocto Project// (also cf. [[..:arm:<label mod_name>MOD_NAME</label>:linux:yocto:quickstart_yocto#Prerequisites]] above)</wrap>  |
| [[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-building-your-image|Building Your Images]]  | <WRAP info round>
This section provides step-by-step instructions for <label stk_name>STK_NAME</label>.
</WRAP><WRAP block>
==== Building an Image for Hardware ====
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_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>
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_local_branch_name>YOCTO_LOCAL_BRANCH_NAME</label>
</code>
5. Configure the Build((valid machines are\\ <label mtq_machines>MTQ_MACHINES</label>)):
<code>
$ source fsl-setup-release.sh -b <label mod_name_code>MOD_NAME_CODE</label>_build -e wayland
$ echo 'MACHINE = "<label mtq_machine_default>MTQ_MACHINE_DEFAULT</label>"' >> conf/local.conf
</code>
6. Build an Image for <label stk_name>STK_NAME</label>:
<code>
$ bitbake <label mtq_image>MTQ_IMAGE</label>
</code>
<wrap help round center 80%>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''</wrap>\\ 
7. 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=TARGET_DEVICE
</code>
8. Boot the <label stk_name>STK_NAME</label> from SD card (cf. [[..:arm:<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]])
</WRAP>  |