zara
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

drivers: firmware: nrf_ironside: Update the spelling 

s/IRONside/IronSide/g

Signed-off-by: Grzegorz Swiderski <grzegorz.swiderski@nordicsemi.no>
pull/92566/merge
Grzegorz Swiderski 4 weeks ago committed by Daniel DeGrasse
parent
0903efa882
commit
75dd614437
16 changed files with 56 additions and 56 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      boards/nordic/nrf54h20dk/nrf54h20dk_nrf54h20_cpuapp_iron_0_9_0.yaml
  2. 2
      boards/nordic/nrf54h20dk/nrf54h20dk_nrf54h20_cpurad_iron_0_9_0.yaml
  3. 22
      drivers/firmware/nrf_ironside/Kconfig
  4. 6
      drivers/firmware/nrf_ironside/dvfs.c
  5. 2
      dts/bindings/firmware/nordic,ironside-call.yaml
  6. 14
      include/zephyr/drivers/firmware/nrf_ironside/boot_report.h
  7. 8
      include/zephyr/drivers/firmware/nrf_ironside/call.h
  8. 2
      include/zephyr/drivers/firmware/nrf_ironside/cpuconf.h
  9. 10
      include/zephyr/drivers/firmware/nrf_ironside/dvfs.h
  10. 12
      include/zephyr/drivers/firmware/nrf_ironside/update.h
  11. 2
      samples/boards/nordic/nrf_ironside/update/Kconfig
  12. 20
      samples/boards/nordic/nrf_ironside/update/README.rst
  13. 4
      samples/boards/nordic/nrf_ironside/update/sample.yaml
  14. 2
      samples/boards/nordic/nrf_ironside/update/src/main.c
  15. 2
      soc/nordic/nrf54h/Kconfig.soc
  16. 2
      soc/nordic/nrf92/Kconfig.soc

2
boards/nordic/nrf54h20dk/nrf54h20dk_nrf54h20_cpuapp_iron_0_9_0.yaml
Unescape View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
identifier: nrf54h20dk/nrf54h20/cpuapp/iron identifier: nrf54h20dk/nrf54h20/cpuapp/iron
name: nRF54H20-DK-nRF54H20-Application (IRONside compatible) (revision 0.9.0) name: nRF54H20-DK-nRF54H20-Application (IronSide compatible) (revision 0.9.0)
type: mcu type: mcu
arch: arm arch: arm
toolchain: toolchain:

2
boards/nordic/nrf54h20dk/nrf54h20dk_nrf54h20_cpurad_iron_0_9_0.yaml
Unescape View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
identifier: nrf54h20dk/nrf54h20/cpurad/iron identifier: nrf54h20dk/nrf54h20/cpurad/iron
name: nRF54H20-DK-nRF54H20-Radio (IRONside SE compatible) (revision 0.9.0) name: nRF54H20-DK-nRF54H20-Radio (IronSide SE compatible) (revision 0.9.0)
type: mcu type: mcu
arch: arm arch: arm
toolchain: toolchain:

22
drivers/firmware/nrf_ironside/Kconfig
Unescape View File

@ -5,7 +5,7 @@ config NRF_IRONSIDE
bool bool
depends on SOC_NRF54H20_IRON || SOC_NRF9280_IRON depends on SOC_NRF54H20_IRON || SOC_NRF9280_IRON
help help
This is selected by drivers interacting with Nordic IRONside firmware. This is selected by drivers interacting with Nordic IronSide firmware.
config NRF_IRONSIDE_CALL config NRF_IRONSIDE_CALL
bool bool
@ -14,44 +14,44 @@ config NRF_IRONSIDE_CALL
select EVENTS select EVENTS
select MBOX select MBOX
help help
This is selected by features that require support for IRONside calls. This is selected by features that require support for IronSide calls.
if NRF_IRONSIDE_CALL if NRF_IRONSIDE_CALL
config NRF_IRONSIDE_CALL_INIT_PRIORITY config NRF_IRONSIDE_CALL_INIT_PRIORITY
int "IRONside calls' initialization priority" int "IronSide calls' initialization priority"
default 41 default 41
help help
Initialization priority of IRONside calls. It must be below MBOX_INIT_PRIORITY, Initialization priority of IronSide calls. It must be below MBOX_INIT_PRIORITY,
but higher than the priority of any feature that selects NRF_IRONSIDE_CALL. but higher than the priority of any feature that selects NRF_IRONSIDE_CALL.
endif # NRF_IRONSIDE_CALL endif # NRF_IRONSIDE_CALL
menu "Nordic IRONside services" menu "Nordic IronSide services"
depends on SOC_NRF54H20_IRON || SOC_NRF9280_IRON depends on SOC_NRF54H20_IRON || SOC_NRF9280_IRON
config NRF_IRONSIDE_CPUCONF_SERVICE config NRF_IRONSIDE_CPUCONF_SERVICE
bool "IRONside CPUCONF service" bool "IronSide CPUCONF service"
depends on SOC_NRF54H20_CPUAPP || SOC_NRF9280_CPUAPP depends on SOC_NRF54H20_CPUAPP || SOC_NRF9280_CPUAPP
select NRF_IRONSIDE_CALL select NRF_IRONSIDE_CALL
help help
Service used to boot local domain cores. Service used to boot local domain cores.
config NRF_IRONSIDE_UPDATE_SERVICE config NRF_IRONSIDE_UPDATE_SERVICE
bool "IRONside update service" bool "IronSide update service"
select NRF_IRONSIDE_CALL select NRF_IRONSIDE_CALL
help help
Service used to update the IRONside SE firmware. Service used to update the IronSide SE firmware.
config NRF_IRONSIDE_BOOT_REPORT config NRF_IRONSIDE_BOOT_REPORT
bool "IRONside boot report" bool "IronSide boot report"
depends on $(dt_nodelabel_exists,ironside_se_boot_report) depends on $(dt_nodelabel_exists,ironside_se_boot_report)
select NRF_IRONSIDE select NRF_IRONSIDE
help help
Support for parsing the Boot Report populated by Nordic IRONside firmware. Support for parsing the Boot Report populated by Nordic IronSide firmware.
config NRF_IRONSIDE_DVFS_SERVICE config NRF_IRONSIDE_DVFS_SERVICE
bool "IRONside DVFS service" bool "IronSide DVFS service"
depends on SOC_NRF54H20_CPUAPP depends on SOC_NRF54H20_CPUAPP
select NRF_IRONSIDE_CALL select NRF_IRONSIDE_CALL
help help

6
drivers/firmware/nrf_ironside/dvfs.c
Unescape View File

@ -15,7 +15,7 @@ static enum ironside_dvfs_oppoint current_dvfs_oppoint = IRONSIDE_DVFS_OPP_HIGH;
#define ABB_STATUSANA_LOCKED_L_Msk (0x1UL << ABB_STATUSANA_LOCKED_L_Pos) #define ABB_STATUSANA_LOCKED_L_Msk (0x1UL << ABB_STATUSANA_LOCKED_L_Pos)
#define ABB_STATUSANA_REG_OFFSET (0x102UL) #define ABB_STATUSANA_REG_OFFSET (0x102UL)
#else #else
#error "Unsupported SoC series for IRONside DVFS" #error "Unsupported SoC series for IronSide DVFS"
#endif #endif
struct dvfs_hsfll_data_t { struct dvfs_hsfll_data_t {
@ -133,8 +133,8 @@ static inline bool ironside_dvfs_is_abb_locked(NRF_ABB_Type *abb)
} }
/** /**
* @brief Request DVFS oppoint change from IRONside secure domain. * @brief Request DVFS oppoint change from IronSide secure domain.
* This function will send a request over IPC to the IRONside secure domain * This function will send a request over IPC to the IronSide secure domain
* This function is synchronous and will return when the request is completed. * This function is synchronous and will return when the request is completed.
* *
* @param oppoint @ref enum ironside_dvfs_oppoint * @param oppoint @ref enum ironside_dvfs_oppoint

2
dts/bindings/firmware/nordic,ironside-call.yaml
Unescape View File

@ -1,7 +1,7 @@
# Copyright (c) 2025 Nordic Semiconductor ASA # Copyright (c) 2025 Nordic Semiconductor ASA
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
description: IPC configuration for Nordic IRONside calls description: IPC configuration for Nordic IronSide calls
compatible: "nordic,ironside-call" compatible: "nordic,ironside-call"

14
include/zephyr/drivers/firmware/nrf_ironside/boot_report.h
Unescape View File

@ -9,14 +9,14 @@
#include <stdint.h> #include <stdint.h>
#include <stddef.h> #include <stddef.h>
/** Constant used to check if an Nordic IRONside SE boot report has been written. */ /** Constant used to check if an Nordic IronSide SE boot report has been written. */
#define IRONSIDE_BOOT_REPORT_MAGIC (0x4d69546fUL) #define IRONSIDE_BOOT_REPORT_MAGIC (0x4d69546fUL)
/** Length of the local domain context buffer in bytes. */ /** Length of the local domain context buffer in bytes. */
#define IRONSIDE_BOOT_REPORT_LOCAL_DOMAIN_CONTEXT_SIZE (16UL) #define IRONSIDE_BOOT_REPORT_LOCAL_DOMAIN_CONTEXT_SIZE (16UL)
/** Length of the random data buffer in bytes. */ /** Length of the random data buffer in bytes. */
#define IRONSIDE_BOOT_REPORT_RANDOM_DATA_SIZE (32UL) #define IRONSIDE_BOOT_REPORT_RANDOM_DATA_SIZE (32UL)
/** @brief IRONside version structure. */ /** @brief IronSide version structure. */
struct ironside_version { struct ironside_version {
/** Wrapping sequence number ranging from 1-126, incremented for each release. */ /** Wrapping sequence number ranging from 1-126, incremented for each release. */
uint8_t seqnum; uint8_t seqnum;
@ -43,13 +43,13 @@ struct ironside_boot_report_uicr_error {
} description; } description;
}; };
/** @brief IRONside boot report. */ /** @brief IronSide boot report. */
struct ironside_boot_report { struct ironside_boot_report {
/** Magic value used to identify valid boot report */ /** Magic value used to identify valid boot report */
uint32_t magic; uint32_t magic;
/** Firmware version of IRONside SE. */ /** Firmware version of IronSide SE. */
struct ironside_version ironside_se_version; struct ironside_version ironside_se_version;
/** Firmware version of IRONside SE recovery firmware. */ /** Firmware version of IronSide SE recovery firmware. */
struct ironside_version ironside_se_recovery_version; struct ironside_version ironside_se_recovery_version;
/** Copy of SICR.UROT.UPDATE.STATUS.*/ /** Copy of SICR.UROT.UPDATE.STATUS.*/
uint32_t ironside_update_status; uint32_t ironside_update_status;
@ -64,9 +64,9 @@ struct ironside_boot_report {
}; };
/** /**
* @brief Get a pointer to the IRONside boot report. * @brief Get a pointer to the IronSide boot report.
* *
* @param[out] report Will be set to point to the IRONside boot report. * @param[out] report Will be set to point to the IronSide boot report.
* *
* @retval 0 if successful. * @retval 0 if successful.
* @retval -EFAULT if the magic field in the report is incorrect. * @retval -EFAULT if the magic field in the report is incorrect.

8
include/zephyr/drivers/firmware/nrf_ironside/call.h
Unescape View File

@ -8,7 +8,7 @@
#include <stdint.h> #include <stdint.h>
/** @brief Maximum number of arguments to an IRONside call. /** @brief Maximum number of arguments to an IronSide call.
* *
* This is chosen so that the containing message buffer size is minimal but * This is chosen so that the containing message buffer size is minimal but
* cache line aligned. * cache line aligned.
@ -50,7 +50,7 @@ struct ironside_call_buf {
*/ */
/** /**
* @brief Allocate memory for an IRONside call. * @brief Allocate memory for an IronSide call.
* *
* This function will block when no buffers are available, until one is * This function will block when no buffers are available, until one is
* released by another thread on the client side. * released by another thread on the client side.
@ -60,7 +60,7 @@ struct ironside_call_buf {
struct ironside_call_buf *ironside_call_alloc(void); struct ironside_call_buf *ironside_call_alloc(void);
/** /**
* @brief Dispatch an IRONside call. * @brief Dispatch an IronSide call.
* *
* This function will block until a response is received from the server. * This function will block until a response is received from the server.
* *
@ -71,7 +71,7 @@ struct ironside_call_buf *ironside_call_alloc(void);
void ironside_call_dispatch(struct ironside_call_buf *buf); void ironside_call_dispatch(struct ironside_call_buf *buf);
/** /**
* @brief Release an IRONside call buffer. * @brief Release an IronSide call buffer.
* *
* This function must be called after processing the response. * This function must be called after processing the response.
* *

2
include/zephyr/drivers/firmware/nrf_ironside/cpuconf.h
Unescape View File

@ -63,7 +63,7 @@ BUILD_ASSERT(IRONSIDE_CPUCONF_NUM_ARGS <= NRF_IRONSIDE_CALL_NUM_ARGS);
* If the given msg_size is less than that, the remaining bytes are set to zero. * If the given msg_size is less than that, the remaining bytes are set to zero.
* *
* @retval 0 on success or if the CPU has already booted. * @retval 0 on success or if the CPU has already booted.
* @retval Positive non-0 error status if reported by IRONside call. * @retval Positive non-0 error status if reported by IronSide call.
* @retval -IRONSIDE_CPUCONF_ERROR_WRONG_CPU if cpu is unrecognized * @retval -IRONSIDE_CPUCONF_ERROR_WRONG_CPU if cpu is unrecognized
* @retval -IRONSIDE_CPUCONF_ERROR_MESSAGE_TOO_LARGE if msg_size is greater than * @retval -IRONSIDE_CPUCONF_ERROR_MESSAGE_TOO_LARGE if msg_size is greater than
* IRONSIDE_CPUCONF_SERVICE_MSG_MAX_SIZE. * IRONSIDE_CPUCONF_SERVICE_MSG_MAX_SIZE.

10
include/zephyr/drivers/firmware/nrf_ironside/dvfs.h
Unescape View File

@ -18,15 +18,15 @@ enum ironside_dvfs_oppoint {
}; };
/** /**
* @brief Number of DVFS oppoints supported by IRONside. * @brief Number of DVFS oppoints supported by IronSide.
* *
* This is the number of different DVFS oppoints that can be set on IRONside. * This is the number of different DVFS oppoints that can be set on IronSide.
* The oppoints are defined in the `ironside_dvfs_oppoint` enum. * The oppoints are defined in the `ironside_dvfs_oppoint` enum.
*/ */
#define IRONSIDE_DVFS_OPPOINT_COUNT (3) #define IRONSIDE_DVFS_OPPOINT_COUNT (3)
/** /**
* @name IRONside DVFS service error codes. * @name IronSide DVFS service error codes.
* @{ * @{
*/ */
@ -49,10 +49,10 @@ enum ironside_dvfs_oppoint {
* @} * @}
*/ */
/* IRONside call identifiers with implicit versions. /* IronSide call identifiers with implicit versions.
* *
* With the initial "version 0", the service ABI is allowed to break until the * With the initial "version 0", the service ABI is allowed to break until the
* first production release of IRONside SE. * first production release of IronSide SE.
*/ */
#define IRONSIDE_CALL_ID_DVFS_SERVICE_V0 3 #define IRONSIDE_CALL_ID_DVFS_SERVICE_V0 3

12
include/zephyr/drivers/firmware/nrf_ironside/update.h
Unescape View File

@ -30,10 +30,10 @@
/** Length of the update signature in bytes. */ /** Length of the update signature in bytes. */
#define IRONSIDE_UPDATE_SIGNATURE_LENGTH (64) #define IRONSIDE_UPDATE_SIGNATURE_LENGTH (64)
/* IRONside call identifiers with implicit versions. /* IronSide call identifiers with implicit versions.
* *
* With the initial "version 0", the service ABI is allowed to break until the * With the initial "version 0", the service ABI is allowed to break until the
* first production release of IRONside SE. * first production release of IronSide SE.
*/ */
#define IRONSIDE_CALL_ID_UPDATE_SERVICE_V0 1 #define IRONSIDE_CALL_ID_UPDATE_SERVICE_V0 1
@ -43,7 +43,7 @@
#define IRONSIDE_UPDATE_SERVICE_RETCODE_IDX (0) #define IRONSIDE_UPDATE_SERVICE_RETCODE_IDX (0)
/** /**
* @brief IRONside update blob. * @brief IronSide update blob.
*/ */
struct ironside_update_blob { struct ironside_update_blob {
uint8_t manifest[IRONSIDE_UPDATE_MANIFEST_LENGTH]; uint8_t manifest[IRONSIDE_UPDATE_MANIFEST_LENGTH];
@ -53,9 +53,9 @@ struct ironside_update_blob {
}; };
/** /**
* @brief Request a firmware upgrade of the IRONside SE. * @brief Request a firmware upgrade of the IronSide SE.
* *
* This invokes the IRONside SE update service. The device must be restarted for the update * This invokes the IronSide SE update service. The device must be restarted for the update
* to be installed. Check the update status in the application boot report to see if the update * to be installed. Check the update status in the application boot report to see if the update
* was successfully installed. * was successfully installed.
* *
@ -63,7 +63,7 @@ struct ironside_update_blob {
* *
* @retval -IRONSIDE_UPDATE_ERROR_NOT_PERMITTED if missing access to the update candidate. * @retval -IRONSIDE_UPDATE_ERROR_NOT_PERMITTED if missing access to the update candidate.
* @retval -IRONSIDE_UPDATE_ERROR_SICR_WRITE_FAILED if writing update parameters to SICR failed. * @retval -IRONSIDE_UPDATE_ERROR_SICR_WRITE_FAILED if writing update parameters to SICR failed.
* @returns Positive non-0 error status if reported by IRONside call. * @returns Positive non-0 error status if reported by IronSide call.
* @returns 0 on a successful request (although the update itself may still fail). * @returns 0 on a successful request (although the update itself may still fail).
* *
*/ */

2
samples/boards/nordic/nrf_ironside/update/Kconfig
Unescape View File

@ -6,6 +6,6 @@ config UPDATE_BLOB_ADDRESS
default 0xe100000 default 0xe100000
help help
Address of the update blob. The default value matches the placement of the Address of the update blob. The default value matches the placement of the
update blobs delivered with the IRONside SE firmware. update blobs delivered with the IronSide SE firmware.
source "Kconfig.zephyr" source "Kconfig.zephyr"

20
samples/boards/nordic/nrf_ironside/update/README.rst
Unescape View File

@ -1,24 +1,24 @@
.. zephyr:code-sample:: nrf_ironside_update .. zephyr:code-sample:: nrf_ironside_update
:name: Nordic IRONside SE firmware update :name: Nordic IronSide SE firmware update
Update the Nordic IRONside SE firmware. Update the Nordic IronSide SE firmware.
Overview Overview
******** ********
The Nordic IRONside SE Update sample updates the IRONside SE firmware on a SoC that already has IRONside SE installed. The Nordic IronSide SE Update sample updates the IronSide SE firmware on a SoC that already has IronSide SE installed.
It can update both the main image and the recovery image of IRONside SE using the IRONside SE firmware release ZIP file. It can update both the main image and the recovery image of IronSide SE using the IronSide SE firmware release ZIP file.
Update procedure Update procedure
**************** ****************
The update procedure works as follows: The update procedure works as follows:
1. The application invokes the IRONside SE update service and passes the parameters that correspond to the location of the HEX file of the IRONside SE firmware update. 1. The application invokes the IronSide SE update service and passes the parameters that correspond to the location of the HEX file of the IronSide SE firmware update.
#. The application prints the return value of the service call and outputs information from the update HEX file. #. The application prints the return value of the service call and outputs information from the update HEX file.
#. After the service call completes, the IRONside SE firmware updates the internal state of the device. #. After the service call completes, the IronSide SE firmware updates the internal state of the device.
#. The firmware installs the update during the next device boot. #. The firmware installs the update during the next device boot.
This operation can take several seconds. This operation can take several seconds.
@ -29,9 +29,9 @@ Building and running the application for nrf54h20dk/nrf54h20/cpuapp/iron
************************************************************************ ************************************************************************
.. note:: .. note::
You can use this application only when there is already a version of IRONside SE installed on the device. You can use this application only when there is already a version of IronSide SE installed on the device.
1. Unzip the IRONside SE release ZIP to get the update hex file: 1. Unzip the IronSide SE release ZIP to get the update hex file:
.. code-block:: console .. code-block:: console
@ -39,13 +39,13 @@ Building and running the application for nrf54h20dk/nrf54h20/cpuapp/iron
#. Program the appropriate update hex file from the release ZIP using one (not both) of the following commands: #. Program the appropriate update hex file from the release ZIP using one (not both) of the following commands:
a) To update IRONside SE firmware: a) To update IronSide SE firmware:
.. code-block:: console .. code-block:: console
nrfutil device program --traits jlink --firmware update/ironside_se_update.hex nrfutil device program --traits jlink --firmware update/ironside_se_update.hex
b) To update IRONside SE recovery firmware: b) To update IronSide SE recovery firmware:
.. code-block:: console .. code-block:: console

4
samples/boards/nordic/nrf_ironside/update/sample.yaml
Unescape View File

@ -1,6 +1,6 @@
sample: sample:
name: Nordic IRONside SE update service name: Nordic IronSide SE update service
description: Demonstrates how to update the Nordic IRONside SE firmware description: Demonstrates how to update the Nordic IronSide SE firmware
common: common:
build_only: true build_only: true
tags: nrf_ironside tags: nrf_ironside

2
samples/boards/nordic/nrf_ironside/update/src/main.c
Unescape View File

@ -28,7 +28,7 @@ int main(void)
LOG_HEXDUMP_INF((void *)report->random_data, sizeof(report->random_data), "random data"); LOG_HEXDUMP_INF((void *)report->random_data, sizeof(report->random_data), "random data");
err = ironside_update(update); err = ironside_update(update);
LOG_INF("IRONside update retval: 0x%x", err); LOG_INF("IronSide update retval: 0x%x", err);
if (err == 0) { if (err == 0) {
LOG_HEXDUMP_INF(update->manifest, sizeof(update->manifest), "Update manifest:"); LOG_HEXDUMP_INF(update->manifest, sizeof(update->manifest), "Update manifest:");

2
soc/nordic/nrf54h/Kconfig.soc
Unescape View File

@ -36,7 +36,7 @@ config SOC_NRF54H20_CPUFLPR
config SOC_NRF54H20_IRON config SOC_NRF54H20_IRON
bool bool
help help
Indicates that local domain firmware is compatible with Nordic IRONside SE. Indicates that local domain firmware is compatible with Nordic IronSide SE.
config SOC config SOC
default "nrf54h20" if SOC_NRF54H20 default "nrf54h20" if SOC_NRF54H20

2
soc/nordic/nrf92/Kconfig.soc
Unescape View File

@ -65,7 +65,7 @@ config SOC_NRF9280_CPUPPR
config SOC_NRF9280_IRON config SOC_NRF9280_IRON
bool bool
help help
Indicates that local domain firmware is compatible with Nordic IRONside SE. Indicates that local domain firmware is compatible with Nordic IronSide SE.
config SOC config SOC
default "nrf9280" if SOC_NRF9280 default "nrf9280" if SOC_NRF9280

Write Preview
Loading…
Cancel
Save