Skip to content
Snippets Groups Projects
Commit 1c854b14 authored by Tobias Kahlki's avatar Tobias Kahlki
Browse files

readme: Update and clean-up

- Updated old infos
- Renamed G&F to SECO North
- Updated URLs
- Fixed some spelling errors


(cherry picked from commit 1ab3758a)
parent 94b6340e
No related branches found
No related tags found
1 merge request!199readme: Update and clean-up
Pipeline #17406 passed with stage
in 15 seconds
Yocto Dunfell repository for Garz & Fricke Platforms
Yocto Dunfell Repository for SECO North Platforms
======================================================
This layer provides support for Garz & Fricke platforms to be used with the
This layer provides support for SECO North platforms to be used with the
Yocto Project.
This layer depends on:
......@@ -14,48 +14,48 @@ Description
------------------------------------------------------
These repositories contain all the source code and metadata to build images and
packages for Garz & Fricke devices based on the NXP i.MX6, i.MX6ULL and i.MX8MM
processors.
packages for SECO North devices based on the NXP i.MX6, i.MX6ULL, i.MX8MM and
i.MX8MP processors.
The build system is based on the Yocto project, further information and
documentation can be found at http://docs.yoctoproject.org/. The Yocto project
The build system is based on the Yocto Project, further information and
documentation can be found at http://docs.yoctoproject.org/. The Yocto Project
uses so called 'layers' containing the metadata to build all needed packages,
while the package sources are downloaded during the build.
The Garz & Fricke Yocto is based on the base layers from poky
(git://git.yoctoproject.org/poky) and openembedded
(git://git.openembedded.org/meta-openembedded). QT5 support is included the
The SECO North Yocto is based on the base layers from Poky
(git://git.yoctoproject.org/poky) and OpenEmbedded
(git://git.openembedded.org/meta-openembedded). Qt5 support is included in the
meta-qt5 layer (git://code.qt.io/yocto/meta-qt5).
For the ```imx8m``` platform Tanaro the BSP from Freescale
For the ```imx8m``` platforms the BSP from Freescale
(git://github.com/Freescale/meta-freescale) is included for GPU and VPU drivers
and tools.
For the ```imx6``` based platforms (SANT*) GPU and VPU drivers the etnaviv driver is
For the ```imx6``` based platforms (SAN*) GPU and VPU drivers the etnaviv driver is
used, included in the mainline opensource layers.
This Garz & Fricke specific part comes as two parts layers:
The SECO North specific parts come as two layers:
* ```meta-guf-machine```
(https://gitlab.com/garz-fricke/yocto/layers/meta-guf-machine)
(https://git.seco.com/seco-ne/yocto/layers/meta-guf-machine)
This part is intended to hold all recipes needed to build the BSP for
Garz & Fricke Boards
This part is intended to contain all recipes needed to build the BSP for
SECO North boards
* ```meta-guf-distro```
(https://gitlab.com/garz-fricke/yocto/layers/meta-guf-distro)
(https://git.seco.com/seco-ne/yocto/layers/meta-guf-distro)
This part is intended to hold recipes that make up the Garz & Fricke
This layer is intended to contain recipes that make up the SECO North
distribution including the base image: guf-image.
The Garz & Fricke manifest repository
(https://gitlab.com/garz-fricke/yocto/manifest) contains the so called manifest
The SECO North manifest repository
(https://git.seco.com/seco-ne/yocto/manifest) contains the so-called manifest
(default.xml) for the repo tool (https://gerrit.googlesource.com/git-repo). The
manifest file contains a list of all layers and there specific revisions needed
to build the image for Garz&Fricke devices, the repo tool itself reads this
manifest and handles the clone and directory setup for you.
manifest file contains a list of all layers and their specific revisions needed
to build the image for SECO North devices, the repo tool itself reads this
manifest and handles the download and directory setup for you.
Getting started
Getting Started
=====================================================
Preparing the host system
......@@ -63,19 +63,17 @@ Preparing the host system
There are some requirements to the host system.
### Ubuntu 20.04.2
Tested distribution is currently **Ubuntu 20.04.2 LTS**.
Tested distribution is currently **Ubuntu 20.04.2 LTS**.
ISO-Installation-Image: https://releases.ubuntu.com/20.04/ubuntu-20.04.2.0-desktop-amd64.iso
This should work as virtual machine (Virtual box ...) or baremetal installation.
This should work as virtual machine (VirtualBox, Qemu, etc.) or bare-metal installations.
#### Yocto related base software
Needed tools are listed in the yocto documentation
http://docs.yoctoproject.org/brief-yoctoprojectqs/brief-yoctoprojectqs.html#compatible-linux-distribution:
https://docs.yoctoproject.org/ref-manual/system-requirements.html#required-packages-for-the-build-host:
Execute the following commands to install them:
```sh
......@@ -91,17 +89,17 @@ Additionally needed:
sudo apt install -y quilt curl flex bison libssl-dev
```
#### Development tools
#### Development Tools
```sh
sudo apt install git minicom gdb-multiarch crossbuild-essential-armhf \
meld gedit nano cscope quilt qtcreator
```
#### Install repo tool
#### Install the Repo Tool
If available the tool can also be installed from the distributions package
manager. This directly downloads the latest version from google.
manager. This directly downloads the latest version from Google.
```sh
mkdir ~/bin # once
......@@ -111,9 +109,9 @@ echo "export PATH=${PATH}:~/bin" >> ~/.bashrc # once
source ~/.bashrc
```
### Gitlab access
### GitLab Access
To download source code from gitlab the generation of a ssh key pair is needed.
To download source code from GitLab the generation of a ssh key pair is needed.
SSH key for GitLab (https://docs.gitlab.com/ee/ssh/README.html#generating-a-new-ssh-key-pair):
......@@ -123,31 +121,31 @@ cat ~/.ssh/id_ed25529.pub
(copy and add the key content to your GitLab Profile User Settings -> SSH keys)
```
### Local Git setup:
### Local Git Setup
```sh
git config --global user.name "Surname Name" # use your name instead
git config --global user.email name.provider.com # use your email instead
```
Download the Garz & Fricke Yocto layers
Download the SECO North Yocto layers
------------------------------------------------------
The steps are to create a local build dir and use repo to download all needed
files. After that the build directory gets setup for one specific machine
(```imx6guf```, ```imx6ullguf``` or ```imx8mguf```) and distribution
(```guf-wayland```)
files. After that, the build directory is set up for one specific machine
(```imx6guf```, ```imx6ullguf```, ```imx8mguf``` or ```imx8mpguf```) and distribution
(```guf-wayland```).
### Download source code
### Download Source Code
```sh
mkdir -p ~/projects/yocto-dunfell
cd ~/projects/yocto-dunfell
repo init -u ssh://git@gitlab.com/garz-fricke/yocto/manifest.git -b dunfell
repo init -u ssh://git@git.seco.com:4444/seco-ne/yocto/manifest.git -b dunfell
repo sync
```
The repo tool stores its meta data in a hidden subdirectory called ```.repo```.
The repo tool stores its metadata in a hidden subdirectory called ```.repo```.
The manifest file is stored at ```.repo/manifests/default.xml``` and is used
for the sync command which actually downloads the sources.
......@@ -182,25 +180,31 @@ yocto-dunfell$ tree -L 2 -a
To get the build environment ready run
for Garz & Fricke i.MX6Q/DL platfroms:
For SECO North i.MX6Q/DL platforms:
```sh
MACHINE=imx6guf DISTRO=guf-wayland source ./setup-environment build
```
for Garz & Fricke i.MX6ULL platforms:
For SECO North i.MX6ULL platforms:
```sh
MACHINE=imx6ullguf DISTRO=guf-wayland source ./setup-environment build
```
for Garz & Fricke i.MX8M platforms (Tanaro):
For SECO North i.MX8M platforms (TANARO):
```sh
MACHINE=imx8mguf DISTRO=guf-wayland source ./setup-environment build
```
Build the default Garz & Fricke image
For SECO North i.MX8MP platforms (Trizeps VIII+):
```sh
MACHINE=imx8mpguf DISTRO=guf-wayland source ./setup-environment build
```
Build the default SECO North image
```sh
bitbake guf-image
......@@ -209,18 +213,18 @@ bitbake guf-image
Installation
---------------------------------------------------
### imx6 based machines
### i.MX6 Based Machines
After the image was built the files are located under
```yocto-dunfell/build/tmp/deploy/images/imx6guf/```. The files needed are
installation file ```fng_install.sh``` and the root file system
```guf-image-imx6guf.tar.gz```. The files can be used in a Flash-N-Go System
``yocto-dunfell/build/tmp/deploy/images/imx6guf/``. The files needed are
installation file ``fng_install.sh`` and the root file system
``guf-image-imx6guf.tar.gz``. The files can be used in a Flash-N-Go System
installation process. See
http://support.garz-fricke.com/products/Santaro/Flash-N-Go/FNGSystem/FNGSystem-15.1-r8673/Flash-N-Go-System-15.1-r8673-Manual.pdf
for more informatiuon.
for more information.
### imx8 based machines (Tanaro)
### i.MX8M Based Machines
See release page:
https://gitlab.com/garz-fricke/yocto/layers/meta-guf-distro/-/releases/0.1
https://git.seco.com/seco-ne/yocto/layers/meta-guf-distro/-/releases/0.1
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment