Skip to content

doc: Documentation issue in 'samples/boards/nordic/nrf_ironside/update/README' #100457

@falcuun

Description

@falcuun

Describe the bug

The page, at the very bottom, suggests checking the SDFW version by using "nrfutil x-read" which now does not work and should instead be "nrfutil device read"

But also, instead of using the raw x-read value, the users should be suggested to use: nrfutil device x-ironside-boot-report-read

This command provides a much more user-friendly way of reading the version of IronSide SDFW.

Example output:

<SERIAL_NUMBER>
Magic                            SET
IronSide SE version              22.2.0-live+14
IronSide SE recovery FW version  23.1.0-live+19
IronSide update status           0xffffffff
Init status:
  Boot error                     NONE (0x00)
  UICR status                    SUCCESS (0x00)
Boot mode flags                  None (0x0000)
Init context:
  Boot reason                    DEFAULT (0x00)
Random data:
  5a eb 6b 54 d9 5a 10
  34 49 85 75 bb 55 91
  78 75 42 da d2 fc 33
  10 61 bf 29 bf c7 03
  1d bd b6 bb
Device info UUID                 Not supported

If reading the raw bytes is still required, an example command that will return a correct value would be: nrfutil device read --address 0x2f88fd04 --json --bytes 16 --skip-overhead

This returns something that looks like:

{"devices":[{"memoryData":[{"startAddress":"0x2f88fd04","values":[14,0,2,22,108,105,118,101,0,0,0,0,0,0,0,0]}],"name":"memory-read","serialNumber":"<SERIAL_NUMBER>"}]}

But the x-ironside-boot-report-read is a much cleaner approach, in my opinion.

Regression

  • This is a regression.

Steps to reproduce

No response

Relevant log output

Impact

Annoyance – Minor irritation; no significant impact on usability or functionality.

Environment

  • Page: samples/boards/nordic/nrf_ironside/update/README
  • Version: main
  • SHA-1: b4c18e8

Additional Context

This issue was reported from the online documentation page using the 'Report an issue' button.

Metadata

Metadata

Labels

bugThe issue is a bug, or the PR is fixing a bugplatform: nRFNordic nRFx

Type

Projects

Status

Backlog

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions