====== x86 Yocto Quickstart Guide ======
<alert type="warning" dismiss="true" icon="fa fa-info">Please visit GitHub for the latest build instructions: [[https://github.com/tq-systems/ci-meta-tqmx86|ci-meta-tqmx86 on GitHub]]</alert>
<panel>
===== Preface =====
The //meta-tqmx86// layer extends the //Yocto Project's// reference system //Poky// to provide support for all TQ Embedded x86 CPU Modules, including the @mod_name@.

<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-tqmx86|ci-meta-tqmx86]] which already provides all required yocto layers as git submodules instead of [[https://github.com/tq-systems/meta-tqmx86|meta-tqmx86]] to  build this BSP release. 
</callout>

<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-tqmx86// (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-tqmx86// with the @stk_name@, so instead of reinventing the wheel we will adhere to the very compact [[https://www.yoctoproject.org/docs/2.0/yocto-project-qs/yocto-project-qs.html|Yocto Project Quick Start]] and supply details specific to the @stk_name@ where necessary.\\
\\
For further details regarding //Yocto Project// please refer to its [[https://docs.yoctoproject.org/|official documentation]].
</callout>

</panel>
<panel type="primary">
===== Setup Build Host =====

//Yocto Project / Poky// requires a Linux build host, so first of all you need a development workstation (or a virtual machine) 
with a Linux distribution installed.

Please refer to section [[https://@yocto_doc_base_url@/@yocto_rel_ver_major@.@yocto_rel_ver_minor@/brief-yoctoprojectqs/index.html#compatible-linux-distribution|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/index.html#build-host-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 @host_os_name@ @host_os_version@ (@host_os_bits@) in a VMWare virtual machine.
</callout>
</panel>

<panel type="primary">
===== Image build instructions =====
<alert type="warning" icon="fa fa-warning">Please setup the build host as described in the [[.:yocto_quickstart#setup_build_host|Setup Build Host]] section above.</alert>

1. Create a local copy of @mtq_repos@
<code>
git clone --recurse-submodules https://github.com/tq-systems/ci-meta-tqmx86.git
</code>
2. Checkout BSP release on new local branch.
<code>
cd ci-meta-tqmx86
git checkout @yocto_rel_branch@.@yocto_rel_branch_module@.BSP.SW.@yocto_rel_branch_rev@ -b @yocto_local_branch_name@
</code>
3. Update git submodules:
<code>
git submodule sync
git submodule update --init
</code>
4. Configure Build:
<code>
export MACHINE=@machine@
export DISTRO=@poky@
</code>
4. Setup build environment((valid machines are\\ @mtq_machines@)):
<code>
source setup-environment build x86
</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-tqmx86 folder and execute the following command: 

<code>source setup-environment build</code>
</callout>
5. Build an Image for @stk_name@:
<code>
bitbake @mtq_image@
</code>
<alert type="success">The resulting image is: <code>tmp/deploy/images/@mtq_machine_default@/core-image-base-intel-corei7-64-tqmx86.wic</code></alert>\\ 
6. Write the Image((valid machines are\\ @mtq_machines@))((''TARGET_DEVICE'' has to be an SD card or USB Stick))
<code>
sudo dd if=tmp/deploy/images/@mtq_machine_default@/@mtq_image@-@mtq_machine_default@.wic of=TARGET_DEVICE
</code>
7. Boot the @stk_name@ from SD card or USB Stick 

\\
==== Use Linux Developement Kernel (Hardknott only!)====
with newer CPUs it is necessary to use a more current kernel version. In this case the intel developement kernel branch can be used. Please see the [[https://github.com/tq-systems/meta-tqmx86/blob/hardknott/README.md |README]] for the current version of the development kernel.
\\
To use the development kernel, the following line must be added to the conf/local.conf file:
<code>
PREFERRED_PROVIDER_virtual/kernel_intel-corei7-64-tqmx86 = "linux-intel-dev"
</code>
</panel>