Preface

The instructions on this page have been tested on @host_os_name@ @host_os_version@ (@host_os_bits@) in a VMWare virtual machine.

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@.

It uses the same codebase as the 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.

The instructions on this page refer to the BSP and ancillary tools listed in the following table:

BSP Revision1) @bsp_rev@
meta-tq release @mod_name@.BSP.SW.@mtq_reltag@
Yocto Project / Poky Release @yocto_rel_ver_major@.@yocto_rel_ver_minor@ - @yocto_rel_name@
Target machine2) @mod_name_code@-@mb_name_code@
U-Boot @uboot_version@
Linux Kernel @linux_kernel@


It's strongly recommended to use git for downloading both the Yocto Project / Poky Release as well as meta-tq (instead of downloading archives and extracting them).

The goal of these wiki pages is to get you started using meta-tq with the @stk_name@, so instead of reinventing the wheel we will adhere to the very compact 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 official documentation.

Prerequisites

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

Please refer to section The Linux Distribution of the Yocto Project Quick Start for supported linux distributions and section The 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 tftp server (for image download / update) and an nfs server (for network mounted root filesystem) on your development host.

Yocto Project / Poky set-up

The 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 meta-tq layer for the @stk_name@.

Section Remarks / Instructions for meta-tq & @stk_name@
Welcome! Introduction and basic information about the Yocto Project
Introducing the Yocto Project Development Environment
Setting Up to Use the Yocto Project Description of basic requirements for using the Yocto Project (also cf. Prerequisites above)
Yocto Project Release Instructions on how to install a release of the Yocto Project on the Build Host

$ git checkout @yocto_rel_branch@

will not work unless you change into the poky directory (i.e. the freshly cloned Poky repository).

Alternatively you can clone the Poky repository and checkout branch @yocto_rel_branch@ in one step by executing 

$ git clone -b @yocto_rel_branch@ git://git.yoctoproject.org/poky.git
Building Images

This section provides step-by-step instructions for

  1. Building An Image for Emulation4)
  2. Building An Image for Hardware5)

To sucessfully build an image for hardware you have to carry out steps from both subsections6) as follows.

Building an Image for Emulation

1. Be Sure Your Build Host is Set Up: See above
2. Check Out Your Branch: 

$ git checkout @yocto_rel_branch@

You can skip this step if you checked out branch @yocto_rel_branch@ already when/after cloning the poky repository.
3. Initialize the Build Environment: 

$ source oe-init-build-env

The above is absolutely required, otherwise the subsequent steps will not work!
5. - 7. You can skip these steps, they are not required for using meta-tq.

Building an Image for Hardware

1. Create a Local Copy of the meta-tq Repository: 

$ cd $HOME/poky
$ git clone -b @yocto_rel_branch@ https://github.com/tq-systems/meta-tq.git

2. Configure the Build: 

$ cd $HOME/poky/build
$ bitbake-layers add-layer "../meta-tq"
$ echo 'MACHINE = "@mod_name_code@-@mb_name_code@"' >> conf/local.conf

3. Build an Image for @stk_name@: 

$ bitbake core-image-minimal

The resulting image is tmp/deploy/images/@mod_name_code@-@mb_name_code@/core-image-minimal-@mod_name_code@-@mb_name_code@.wic
4. Write the Image7) 

$ sudo dd if=tmp/deploy/images/@mod_name_code@-@mb_name_code@/core-image-minimal-@mod_name_code@-@mb_name_code@.wic of=TARGET_DEVICE

5. Boot the @stk_name@ from SD card (cf. @mb_name@ DIP switche settings)

1)
refers to the revision of the PTXdist based TQ Linux BSP, which provides the codebase of U-Boot and Linux kernel
2)
i.e. value for MACHINE variable
3)
for testing purposes Yocto Project provides a ready to use virtual machine called Build Appliance
4)
7 steps, explicitly aims at emulation using qemu
5)
5 steps, targets real hardware
6)
subsection headings may be missing in Yocto Project Quick Start (depends on Poky version)
7)
TARGET_DEVICE has to be an SD card

Disclaimer
TQ-Systems GmbH provides the Board Support Packages (BSP) free of charge. The software included in the shipment has been configured individually for the starter kits. The software is only intended to evaluate the module. The use of the Board Support Packages (BSP) is only allowed within the scope of functionality described by TQ-Systems GmbH. TQ-Systems GmbH does not accept any liability for all further changes of the Board Support Package and for any damage resulting from its use.