===== 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 @mod_name@.
<WRAP hide>
It uses the same codebase as the [[..:arm:@mod_name@: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="info" icon="true">As starting point tq provides ci-meta-tq that covers the dependencies of meta-tq to the other yocto layers. So for the first build 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  ^  @bsp_rev@  ^
^ ++ci-meta-tq release|\\ [[https://github.com/tq-systems/ci-meta-tq/releases|all releases]]++  |  [[https://github.com/tq-systems/ci-meta-tq/releases/tag/@yocto_rel_branch@.@mod_name_mtq@.BSP.SW.@bsp_rev@|@yocto_rel_branch@.@mod_name_mtq@.BSP.SW.@bsp_rev@]]  |
^ Yocto Project / Poky Release  |  @yocto_rel_ver_major@.@yocto_rel_ver_minor@  |
^ Target machine((i.e. value for [[https://@yocto_doc_base_url@/@yocto_rel_ver_major@.@yocto_rel_ver_minor@/ref-manual/ref-manual.html#var-MACHINE|MACHINE]] variable))  |  @mtq_machines@  |
^ U-Boot  |  @uboot_version@  |
^ Linux Kernel  |  @linux_kernel@  |
</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 @stk_name@, so instead of reinventing the wheel we will adhere to the very compact [[https://@yocto_doc_base_url@/@yocto_rel_ver_major@.@yocto_rel_ver_minor@/brief-yoctoprojectqs/brief-yoctoprojectqs.html|Yocto Project Quick Start]] and supply details specific to the @stk_name@ where necessary.\\
\\
For further details regarding //Yocto Project// @yocto_rel_ver_major@.@yocto_rel_ver_minor@ - @yocto_rel_name@ please refer to its [[https://www.yoctoproject.org/docs/archived-documents/|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://@yocto_doc_base_url@/@yocto_rel_ver_major@.@yocto_rel_ver_minor@/brief-yoctoprojectqs/brief-yoctoprojectqs.html#brief-compatible-distro|Compatible Linux Distribution]] of the //Yocto Project Quick Start// for supported linux distributions and section [[https://@yocto_doc_base_url@/@yocto_rel_ver_major@.@yocto_rel_ver_minor@/brief-yoctoprojectqs/brief-yoctoprojectqs.html#brief-build-system-packages|Build Host Packages]] for required build host packages for those distributions.

<callout type="primary" icon="true">
The instructions on this page have been tested on @host_os_name@ @host_os_version@ (@host_os_bits@) 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 Build instructions =====

<panel type="primary" title="BSP build instructions">

<alert type="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 afterwards enter the new directory.
<code>
$ mkdir -p ~/workspace/@yocto_rel_branch@.@yocto_rel_branch_module@.BSP.SW.@yocto_rel_branch_rev@
$ cd ~/workspace/@yocto_rel_branch@.@yocto_rel_branch_module@.BSP.SW.@yocto_rel_branch_rev@
</code>
2. Create a local copy of @mtq_repos@
<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 @yocto_rel_branch@.@yocto_rel_branch_module@.BSP.SW.@yocto_rel_branch_rev@ -b @yocto_remote_branch_name@
</code>
4. Update git submodules:
<code>
$ git submodule update --init
$ git submodule sync
</code>
5. Download [[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/rz-cortex-a-mpus/rzg-linux-platform/rzg-marketplace/verified-linux-package/rzg2-mlp-eva|RZ/G Multimedia Package]] and extract it into the sources folder in the BSP directroy.
<callout type="info" icon="true">
For licensing reasons TQ Systems is not allowed to provide the RZ/G Multimedia Package with the TQMaRZG2x BSP sources. Downloading the RZ/G requires at least a registration on the Renesas website, there are two packages that can be downladed the **Evaluation Version** and the **Product Version** both packages have the same features, but the Evaluation version has a one hour runtime limitation. A reset must be issued after an hour to reactivate the Evaluation RZ/G Multimedia Package. For further information please see Quickstart Guide that is delivered with the STKaRZG2x.
</callout>
e.g. 
<code> 
$ tar -C ~/workspace/rocko.TQMaRZG2x.BSP.SW.0010/ci-meta-tq/sources -zxvf ~/Downloads/RZG2_Group_Evaluation_Software_Package_for_Linux_@rzg2_mmp_version@.tar.gz
</code>
6. The meta-rzg2 layer provides a script to deploy the RZ/G Multimedia Package into the right place. Navigate to the meta-rzg2 Yocto layer and execute the **copy_proprietary_softwares** script:
<code>
$ cd ~/workspace/rocko.TQMaRZG2x.BSP.SW.0010/ci-meta-tq/sources/meta-rzg2
$ sh docs/sample/copyscript/copy_proprietary_softwares.sh -f ~/workspace/rocko.TQMaRZG2x.BSP.SW.0010/ci-meta-tq/sources/proprietary
$ cd ../../
</code>
7. Export the environment DISTRO and MACHINE((valid machines are\\ @mtq_machines@)) environment variable:
<code>
$ export DISTRO=@distro_env@
$ export MACHINE=@machine_env@
</code>
8. Setup local branch to track the remote branch.
<code>
$ git branch -u origin/@yocto_local_branch_name@
</code>
9. Configure the Build:
<code>
$ source setup-environment @mod_name_code@_build @ci_mtq_build_cfg@
</code>
10.Build an Image for @stk_name@:
<accordion collapsed="true">
<panel title="Image with debug features/root login">
<code>
bitbake @mtq_image@-debug
</code>
</panel>
<panel title="Image without debug features/root login">
<code>
bitbake @mtq_image@
</code>
</panel>
</accordion>
<wrap help round center 80%>The resulting image is ''tmp/deploy/images/@mtq_machine_default@((valid machines are\\ @mtq_machines@))/@mtq_image@-@mtq_machine_default@((valid machines are\\ @mtq_machines@)).wic''</wrap>\\ 
11. Write the Image((valid machines are\\ @mtq_machines@))((''TARGET_DEVICE'' has to be an SD card))
<code>
$ sudo dd if=tmp/deploy/images/@mtq_machine_default@/@mtq_image@-@mtq_machine_default@.wic of=TARGET_DEVICE
</code>
12. Boot the @stk_name@ from SD card (cf. [[@lang@:@mod_arch@:@mod_name@:@mb_name_code@:dip_switches|@mb_name@ DIP switch settings]])  |
</panel>