Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup secure-element-se05x page #677

Merged
merged 1 commit into from
Feb 6, 2024
Merged

Cleanup secure-element-se05x page #677

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 16 additions & 24 deletions source/reference-manual/security/secure-elements/se050-enablement.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,23 @@
Enabling SE05X
==============

This section demonstrates how to enable the SE05X middleware in
``meta-subscriber-overrides``.
This section demonstrates how to enable the SE05X middleware in ``meta-subscriber-overrides``.

.. note::
This procedure is valid for boards running OP-TEE 3.15.0 or newer.

Enable the `se05x` MACHINE_FEATURES for the target machine and provide the
correct OEFID for the `se05x` device in **lmp-factory-custom**. The OEFID value
can be found in `SE050 configurations`_.
Enable the ``se05x`` ``MACHINE_FEATURES`` for the target machine and provide the correct OEFID in ``lmp-factory-custom``.
The OEFID value can be found in `SE050 configurations`_.

**conf/machine/include/lmp-factory-custom.inc:**
``conf/machine/include/lmp-factory-custom.inc``:

.. prompt:: text

SE05X_OEFID:<machine> = "0xA1F4"
MACHINE_FEATURES:append:<machine> = " se05x"

.. note::
If set incorrectly, the correct OEFID value can be checked in the boot log:
If set incorrectly, the *correct* OEFID value can be checked in the boot log:

.. code-block:: none

Expand All @@ -32,12 +30,10 @@ can be found in `SE050 configurations`_.
I/TC: se050: Info: OEF ID
I/TC: se050: Info: a1.f4

This step is enough to enable SE05X for the supported machines for factories
created since v85.
This step is enough to enable SE05X for the supported machines for Factories created since LmP v85.

Push the changes to the ``meta-subscriber-overrides`` repository to trigger a
new build with SE05X support enabled. Be aware that an image created with SE05X
enabled does not boot on boards without the SE05X properly attached.
Push the changes to the ``meta-subscriber-overrides``, triggering a new build with SE05X support enabled.
Be aware that an image created with SE05X enabled does not boot on boards without the SE05X properly attached.

.. note::
Please be aware that at this moment only:
Expand All @@ -50,36 +46,32 @@ enabled does not boot on boards without the SE05X properly attached.

support SE05X integration without extra changes in LmP.

Special cases
Special Cases
-------------

1. For older factories created **before v85**, it is also needed to add the `se05x`
features to the **lmp-factory-image** build:
1. For Factories created **before v85**, it is also necessary to add ``se05x`` to the ``lmp-factory-image`` build:

**recipes-samples/images/lmp-factory-image.bb:**
``recipes-samples/images/lmp-factory-image.bb``:

.. prompt:: text

# Support for SE05X
require ${@bb.utils.contains('MACHINE_FEATURES', 'se05x', 'recipes-samples/images/lmp-feature-se05x.inc', '', d)}

2. If working with a different i.MX machine without SE05X LmP default support
(``imx6ullevk`` and ``imx8mm-lpddr4-evk``), also provide which SoC I2C bus
connects to the SE05X device:
2. If working with a different i.MX machine without default SE05X LmP support (``imx6ullevk`` and ``imx8mm-lpddr4-evk``),
also provide which SoC I2C bus connects to the SE05X device:

**recipes-security/optee/optee-os-fio_%.bbappend:**
``recipes-security/optee/optee-os-fio_%.bbappend``:

.. prompt:: text

EXTRA_OEMAKE:append:<machine> = " \
${@bb.utils.contains('MACHINE_FEATURES', 'se05x', 'CFG_IMX_I2C=y CFG_CORE_SE05X_I2C_BUS=<i2c_bus>', '', d)} \
"

Make sure to push the changes to the ``meta-subscriber-overrides`` repository
to trigger a build with the new configurations.
Make sure to push the changes to the ``meta-subscriber-overrides`` repo, triggering a build with the new configurations.

3. On STM32MP157 DK board Arduino Uno V3 expansion is used for connecting
SE05X board.
3. On STM32MP157 DK board, Arduino Uno V3 expansion is used for connecting the SE05X board.

.. _SE050 configurations:
https://www.nxp.com/docs/en/application-note/AN12436.pdf
Loading