Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,14 @@
'manual',
False,
),
(
'yocto/wrynose',
'wrynose.tex',
'Yocto Reference Manual Wrynose',
'PHYTEC Messtechnik GmbH',
'manual',
False,
),
(
'rauc/kirkstone',
'rauc-kirkstone.tex',
Expand Down Expand Up @@ -502,6 +510,14 @@
'manual',
False,
),
(
'rauc/wrynose',
'rauc-wrynose.tex',
'RAUC Update \\& Device Management Manual Wrynose',
'PHYTEC Messtechnik GmbH',
'manual',
False,
),
(
'coprocessor/coprocessor',
'coprocessor.tex',
Expand Down
1 change: 1 addition & 0 deletions source/rauc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ RAUC Manuals
.. toctree::
:maxdepth: 1

wrynose
walnascar
scarthgap
mickledore
Expand Down
62 changes: 62 additions & 0 deletions source/rauc/wrynose.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
.. Download links
.. _`static-pdf-dl`: ../_static/rauc-wrynose.pdf

.. RAUC
.. |yocto-codename| replace:: Wrynose
.. |rauc-manual| replace:: RAUC Update & Device Management Manual

.. References
.. |ref-rauc-switch-keyrings| replace:: :ref:`wrynose_rauc-switch-keyrings`
.. |ref-rauc-use-case-usb-update| replace:: :ref:`wrynose_rauc-use-case-usb-update`
.. |ref-rauc-use-case-http-streaming| replace:: :ref:`wrynose_rauc-use-case-http-streaming`
.. |ref-yocto-bsp-customization| replace:: :ref:`wrynose_bsp-customization`

===============================
|yocto-codename| -- RAUC Manual
===============================

.. sectnum::

.. only:: html

Documentation in pdf format: `Download <static-pdf-dl_>`_

+-------------------------------------+------------------+------------------+----------------+
| Compatible BSPs | BSP Release Type | BSP Release Date | BSP Status |
+=====================================+==================+==================+================+
| BSP-Yocto-Ampliphy-AM62x-PD26.1.0 | Major | 2026/09/29 | Released |
+-------------------------------------+------------------+------------------+----------------+
| BSP-Yocto-Ampliphy-AM62Ax-PD26.1.0 | Major | 2026/10/01 | Released |
+-------------------------------------+------------------+------------------+----------------+
| BSP-Yocto-Ampliphy-AM62Px-PD26.1.0 | Major | 2026/10/01 | Released |
+-------------------------------------+------------------+------------------+----------------+
| BSP-Yocto-Ampliphy-AM64x-PD26.1.0 | Major | 2026/09/30 | Released |
+-------------------------------------+------------------+------------------+----------------+
| BSP-Yocto-Ampliphy-AM67x-PD26.1.0 | Major | 2026/10/01 | Released |
+-------------------------------------+------------------+------------------+----------------+
| BSP-Yocto-NXP-i.MX95-PD26.1.0 | Major | 2026/10/01 | Released |
+-------------------------------------+------------------+------------------+----------------+

This manual was tested using the Yocto version |yocto-codename|.

.. _rauc-man-wrynose:

.. include:: common/intro.rsti
.. include:: common/system-config.rsti
.. include:: common/design-considerations.rsti
.. include:: common/initial-setup.rsti
.. include:: common/creating-bundles.rsti
.. include:: common/updating.rsti
.. _wrynose_rauc-switch-keyrings:
.. include:: common/switch-keyrings.rsti

Use Case Examples
=================
.. _wrynose_rauc-use-case-usb-update:
.. include:: common/use-case/usb-update.rsti
.. include:: common/use-case/downgrade-barrier.rsti
.. _wrynose_rauc-use-case-http-streaming:
.. include:: common/use-case/http-streaming.rsti
.. include:: common/use-case/adaptive-updates.rsti

.. include:: common/reference.rsti
1 change: 1 addition & 0 deletions source/yocto/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Yocto Manuals
:maxdepth: 1

master
wrynose
walnascar
scarthgap
mickledore
Expand Down
163 changes: 163 additions & 0 deletions source/yocto/wrynose.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
.. Download links
.. _`static-pdf-dl`: ../_static/wrynose.pdf

.. Yocto
.. |yocto-branch| replace:: wrynose
.. |yocto-codename| replace:: Wrynose
.. |yocto-ref-manual| replace:: Yocto Reference Manual
.. |distro| replace:: ampliphy-vendor

.. References
.. |ref-gen-source-mirrors| replace:: :ref:`wrynose_gen-source-mirrors`
.. |ref-temporary-method| replace:: :ref:`wrynose_temporary-method`
.. |ref-build-container| replace:: :ref:`using build-container <wrynose_build-container>`
.. |ref-phylinux-advanced-usage| replace:: :ref:`wrynose_phylinux-advanced-usage`

.. _layerindex: https://layers.openembedded.org/layerindex/branch/wrynose/layers/
.. _Bitbake: https://docs.yoctoproject.org/bitbake/2.18/index.html
.. _Toaster: https://docs.yoctoproject.org/dev/toaster-manual/index.html
.. _megamanual: https://docs.yoctoproject.org/dev/singleindex.html
.. _manual: https://docs.yoctoproject.org/dev/dev-manual/index.html
.. _Supported Distributions: https://docs.yoctoproject.org/dev/ref-manual/system-requirements.html#supported-linux-distributions
.. _Yocto Board Support Package: https://docs.yoctoproject.org/dev/bsp-guide/index.html
.. _Quick Build: https://docs.yoctoproject.org/dev/brief-yoctoprojectqs/index.html
.. _meta-security: https://layers.openembedded.org/layerindex/branch/wrynose/layer/meta-security/
.. _Yocto Documentation - Customizing Yocto builds: https://docs.yoctoproject.org/dev/singleindex.html#user-configuration
.. _Creating Layers: https://docs.yoctoproject.org/dev/dev-manual/layers.html#understanding-and-creating-layers
.. _Yocto - Devtool: https://docs.yoctoproject.org/dev/sdk-manual/extensible.html#using-devtool-in-your-sdk-workflow
.. _Devtool Quick Reference: https://docs.yoctoproject.org/dev/ref-manual/devtool-reference.html
.. _Autotools-Based Projects: https://docs.yoctoproject.org/dev/singleindex.html#autotools-based-projects
.. _Yocto - Kernel Development Manual: https://docs.yoctoproject.org/dev/kernel-dev/index.html
.. _Yocto - Development Manual: https://docs.yoctoproject.org/dev/dev-manual/index.html
.. _FEATURES: https://docs.yoctoproject.org/dev/ref-manual/features.html#features

================================
|yocto-codename| -- Yocto Manual
================================

.. sectnum::

.. only:: html

Documentation in pdf format: `Download <static-pdf-dl_>`_

+-------------------------------------+------------------+------------------+----------------+
| Compatible BSPs | BSP Release Type | BSP Release Date | BSP Status |
+=====================================+==================+==================+================+
| BSP-Yocto-Ampliphy-AM62x-PD26.1.0 | Major | 2026/09/29 | Released |
+-------------------------------------+------------------+------------------+----------------+
| BSP-Yocto-Ampliphy-AM62Ax-PD26.1.0 | Major | 2026/10/01 | Released |
+-------------------------------------+------------------+------------------+----------------+
| BSP-Yocto-Ampliphy-AM62Px-PD26.1.0 | Major | 2026/10/01 | Released |
+-------------------------------------+------------------+------------------+----------------+
| BSP-Yocto-Ampliphy-AM64x-PD26.1.0 | Major | 2026/09/30 | Released |
+-------------------------------------+------------------+------------------+----------------+
| BSP-Yocto-Ampliphy-AM67x-PD26.1.0 | Major | 2026/10/01 | Released |
+-------------------------------------+------------------+------------------+----------------+
| BSP-Yocto-NXP-i.MX95-PD26.1.0 | Major | 2026/10/01 | Released |
+-------------------------------------+------------------+------------------+----------------+

This manual applies to all |yocto-codename| based PHYTEC releases.

.. _yocto-man-wrynose:

.. include:: ../phytec-documentation.rsti

On top of these standard manuals and guides, PHYTEC will also provide Product
Change Notifications, Application Notes, and Technical Notes. These will be done
on a case-by-case basis. Most of the documentation can be found in the
applicable download page of our products.

.. include:: include/yocto-introduction.rsti

Compatible Linux Distributions
==============================

To build *Yocto* you need a compatible *Linux* host development machine. The
list of supported distributions can be found in the reference manual:
`Supported Distributions`_

.. include:: include/bsp-introduction.rsti

.. include:: include/prebuilt-images.rsti

.. include:: include/bsp-workspace-installation.rsti

.. include:: include/phylinux-documentation.rsti
:end-before: .. phylinux-advanced-usage-marker

.. _wrynose_phylinux-advanced-usage:

.. include:: include/phylinux-documentation.rsti
:start-after: .. phylinux-advanced-usage-marker

.. _wrynose_build-container:

.. include:: include/build-container.rsti

Working with Poky and Bitbake
=============================

.. include:: include/poky-bitbake/start-the-build.rsti
.. include:: include/poky-bitbake/images.rsti
.. include:: include/poky-bitbake/development-states.rsti
.. include:: include/poky-bitbake/bsp-features.rsti

.. _wrynose_bsp-customization:

BSP Customization
-----------------

To get you started with the BSP, we have summarized some basic tasks from the
*Yocto* official documentation. It describes how to add additional software to
the image, change the kernel and bootloader configuration, and integrate
patches for the kernel and bootloader.

Minor modifications, such as adding software, are done in the file
*build/conf/local.conf*. There you can overwrite global configuration variables
and make small modifications to recipes.

There are 2 ways to make major changes:

1. Either create your own layer and use *bbappend* files.
2. Add everything to PHYTEC's Distro layer *meta-ampliphy*.

Creating your own layer is described in the section Create your own Layer.

.. include:: include/poky-bitbake/bsp-customization/ampliphy-boot.rsti
.. include:: include/poky-bitbake/bsp-customization/features.rsti
.. include:: include/poky-bitbake/bsp-customization/disable-qtdemo.rsti
.. include:: include/poky-bitbake/bsp-customization/framebuffer-console.rsti
.. include:: include/poky-bitbake/bsp-customization/provided-tools.rsti
.. include:: include/poky-bitbake/bsp-customization/adding-software.rsti
.. include:: include/poky-bitbake/bsp-customization/adding-layers.rsti
.. include:: include/poky-bitbake/bsp-customization/create-layer.rsti
.. include:: include/poky-bitbake/bsp-customization/kernel-bootloader-recipe.rsti
.. _yocto-man-wrynose-kernel-and-bootloader-conf:
.. include:: include/poky-bitbake/bsp-customization/kernel-bootloader-config.rsti
.. _wrynose_temporary-method:
.. include:: include/poky-bitbake/bsp-customization/kernel-bootloader-patch-devtool.rsti
.. include:: include/poky-bitbake/bsp-customization/kernel-bootloader-patch-tmp.rsti
.. include:: include/poky-bitbake/bsp-customization/kernel-bootloader-localconf.rsti
.. include:: include/poky-bitbake/bsp-customization/adding-software-sustainable.rsti
.. include:: include/poky-bitbake/bsp-customization/adding-firmware-rootfs.rsti
.. include:: include/poky-bitbake/bsp-customization/change-ubootenv-bbappend.rsti
.. include:: include/poky-bitbake/bsp-customization/change-bareboxenv-bbappend.rsti
.. _wrynose_changing-net-config:
.. include:: include/poky-bitbake/bsp-customization/change-network-conf.rsti
.. include:: include/poky-bitbake/bsp-customization/change-wireless-network-conf.rsti
.. include:: include/poky-bitbake/bsp-customization/adding-opencv.rsti
.. include:: include/poky-bitbake/bsp-customization/adding-php-webruntime.rsti

Common Tasks
------------

.. include:: include/poky-bitbake/common-tasks/debugging-apps.rsti
.. _wrynose_gen-source-mirrors:
.. include:: include/poky-bitbake/common-tasks/gen-source-mirrors.rsti
.. include:: include/poky-bitbake/common-tasks/toolchains.rsti
.. include:: include/poky-bitbake/common-tasks/kernel-modules.rsti

.. include:: include/troubleshooting.rsti

.. include:: include/yocto-documentation.rsti
Loading