-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Applied style guidelines where possible. Moved the introduction page to the index/ToC page, so as to provide an overview for the section up front. Checked rendered output in browser, focusing on visual elements. No issues spotted. This commit addresses FFTK-2995 Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
- Loading branch information
Showing
15 changed files
with
215 additions
and
268 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,17 @@ | ||
.. _ref-pg-lmp-base: | ||
|
||
DISTRO lmp-base for easy Kernel Image access | ||
-------------------------------------------- | ||
``DISTRO lmp-base`` for Easy Kernel Image Access | ||
--------------------------------------------------- | ||
|
||
The default distro used by a FoundriesFactory is ``lmp``, designed to | ||
provide a secure and updatable environment needed during the operation | ||
of an end product. However this distro configuration is not ideal during | ||
the porting process. Therefore we also support another distro | ||
configuration: ``lmp-base``, which provides an easier development | ||
environment as it has a boot directory which includes the Linux Kernel | ||
image and the DTB file, and a read-writable rootfs. See detailed | ||
information on how lmp and lmp-base differ :ref:`ref-linux-distro`. | ||
The default distro used by a Factory is ``lmp``. | ||
It is designed to provide the secure and updatable environment needed for the operation of an end product. | ||
However, this distro configuration is not ideal during the porting process. | ||
Therefore we also support another distro configuration: ``lmp-base``. | ||
This provides an easier development environment, | ||
as it has a boot directory which includes the Linux Kernel image and the DTB file, and a read-writable rootfs. | ||
See detailed information on how lmp and lmp-base differ under :ref:`ref-linux-distro`. | ||
|
||
In the following sections, the focus is on the boot flow (1) show | ||
on :numref:`ref-pg-boot-flow-diagram`. | ||
This boot flow is common on the i.MX8 and i.MX8M SoC families. It is | ||
also common for i.MX6 and i.MX7 SoC families, however TF-A is not | ||
supported for these SoC families and is excluded from the boot flow. | ||
In the following sections, the focus is on the boot flow (1) shown previous on :numref:`ref-pg-boot-flow-diagram`. | ||
This boot flow is common on the i.MX8 and i.MX8M SoC families. | ||
It is also common for i.MX6 and i.MX7 SoC families, however TF-A is not supported for these SoC families, | ||
and is excluded from the boot flow. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,11 @@ | ||
.. _ref-pg-lmp-factory-custom: | ||
|
||
Lmp-factory-custom | ||
^^^^^^^^^^^^^^^^^^ | ||
``lmp-factory-custom`` | ||
^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
A FoundriesFactory includes a file | ||
(``conf/machine/include/lmp-factory-custom.inc``) which can be used to | ||
replace or extend options as defined by ``meta-lmp``. It works to | ||
customize the overall behavior of LmP focusing on the target machine. | ||
Your Factory includes a file, ``conf/machine/include/lmp-factory-custom.inc``. | ||
This can be used to replace or extend options as defined by ``meta-lmp``. | ||
It works to customize the overall behavior of LmP, focusing on the target machine. | ||
|
||
This applies to cases when the porting does not | ||
create a new machine configuration file and only overrides the definition from | ||
an existing machine. | ||
This applies to cases when the porting does not create a new machine configuration file, | ||
and only overrides the definition from an existing machine. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,24 @@ | ||
.. _ref-pg-description: | ||
|
||
What is needed before porting the board to the LmP | ||
================================================== | ||
Requirements Before Porting to the LmP | ||
====================================== | ||
|
||
It is out of the scope of this guide to detail the steps of creating a | ||
BSP including the bootloader or the operating system support and other | ||
critical packages - the recommendation is to search for the SoC vendor | ||
porting guide which usually details how to port the default BSP to | ||
another board. | ||
It is out of the scope of this guide to detail the steps of creating a BSP with | ||
bootloader, operating system support, and other critical packages. | ||
The recommendation is to search for the SoC vendor porting guide. | ||
This usually details how to port the default BSP to another board. | ||
|
||
LmP provides a set of bootloaders and operating systems updated with the | ||
latest known vulnerability fixes. The recommendation is to have those | ||
packages as a base for creating the new needed BSP which leads to the | ||
creation of append files for the recipes of those packages. | ||
LmP provides a set of bootloaders and operating systems updated with the latest known vulnerability fixes. | ||
The recommendation is to use these packages as a base for creating the new BSP. | ||
This leads to the creation of append files (`.bbappend``) for the recipes of the packages. | ||
|
||
LmP supports a wide variety of SoC families from different vendors with | ||
different boot flows. The following image shows three examples of boot | ||
flow currently supported by LmP: | ||
LmP supports a wide variety of SoC families—from different vendors with different boot flows. | ||
The following image shows three examples of boot flow currently supported by LmP: | ||
|
||
.. _ref-pg-boot-flow-diagram: | ||
|
||
.. figure:: /_static/porting-guide/boot-flow-diagram.jpg | ||
:align: center | ||
:width: 300 | ||
|
||
Different boot flow being executed by machines supported by LmP | ||
Different boot flow being executed by machines supported by LmP |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,19 @@ | ||
.. _ref-pg-reference-board: | ||
|
||
Finding a similar reference board already supported | ||
--------------------------------------------------- | ||
Finding a Similar Supported Reference Board | ||
------------------------------------------- | ||
|
||
For some projects, it is easy to understand which reference board is | ||
closest to the one being included. It is common that in early stages, | ||
the project starts using a reference board, and when that is the case, the | ||
reference board is obvious; is only a matter of searching | ||
:ref:`ref-linux-supported` to check if this is supported. | ||
For some projects, it is easy to understand which reference board is closest to the one being ported. | ||
It is common that in early stages, the project starts with a reference board. | ||
When that is the case, the reference board is obvious; is only a matter of searching :ref:`ref-linux-supported` to check if this is supported. | ||
|
||
In the other case when it is not an obvious answer, the task of | ||
searching for the closest reference board is looking for what | ||
reference board shares the same SoC which is usually described in the | ||
machine configuration file by the tag ``@SOC``. | ||
The other case is when it is not an obvious answer. | ||
The task of searching for the closest reference board requires looking for one which shares the same SoC. | ||
This is usually described in the machine configuration file by the tag ``@SOC``. | ||
|
||
If searching for ``@SOC`` through the meta-layers brings more than one | ||
machine with the same SoC used on the project, the suggestion here is to | ||
prefer the machine from the SoC vendor. | ||
When searching for ``@SOC`` through the meta-layers, you may find more than one machine with the same SoC. | ||
The suggestion here is to prefer the machine from the SoC vendor. | ||
|
||
The SoC vendor is usually present on the tag ``@NAME`` in the machine | ||
configuration file. | ||
The SoC vendor is usually present on the tag ``@NAME`` in the machine configuration file. | ||
|
||
In this document, there are several examples where i.MX8M Mini EVK is | ||
used as a reference board. | ||
In this document, there are several examples where i.MX8M Mini EVK is used as a reference board. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.