Skip to content

Commit

Permalink
Fix atm33evk documentation table formatting for ISP (zephyrproject-rt…
Browse files Browse the repository at this point in the history
…os#5)

* Follow proper reStructuredText constructs for formatting the
documentation on the ISP Tool.
  • Loading branch information
hzarnani authored Jul 19, 2024
1 parent f68f9c4 commit 9e3075a
Showing 1 changed file with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions boards/arm/atm33evk/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -283,22 +283,26 @@ Atmosic In-System Programming (ISP) Tool
This SDK ships with a tool called Atmosic In-System Programming Tool
(ISP) for bundling all three types of binaries -- OTP NVDS, flash NVDS, and
flash -- into a single binary archive.
-----------------------------------------------------------------------

+---------------+-----------------------------------------------------+
| Binary Type | Description |
-----------------------------------------------------------------------
+---------------+-----------------------------------------------------+
| .bin | binary file, contains flash or nvds data only. |
-----------------------------------------------------------------------
+---------------+-----------------------------------------------------+
| .elf | elf file, a common standard file format, consists |
| | of elf headers and flash data. |
-----------------------------------------------------------------------
+---------------+-----------------------------------------------------+
| .nvm | OTP NVDS file, contains OTP nvds data. |
-----------------------------------------------------------------------
+---------------+-----------------------------------------------------+

The ISP tool, which is also shipped as a stand-alone package, can then be used
to unpack the components of the archive and download them on a device.

west atm_arch commands
======================
atm isp archive tool
::

atm isp archive tool
-atm_isp_path ATM_ISP_PATH, --atm_isp_path ATM_ISP_PATH
specify atm_isp exe path path
-d, --debug debug enabled, default false
Expand Down Expand Up @@ -326,7 +330,9 @@ atm isp archive tool

Generate atm isp file
=====================
$ west atm_arch -o ATMEVK-3330-QN-5_beacon.atm \
::

west atm_arch -o ATMEVK-3330-QN-5_beacon.atm \
-p build/ATMEVK-3330-QN-5_ns/zephyr/samples/bluetooth/beacon/zephyr/partition_info.map \
--app_file build/ATMEVK-3330-QN-5_ns/zephyr/samples/bluetooth/beacon/zephyr/zephyr.signed.bin \
--mcuboot_file build/ATMEVK-3330-QN-5/bootloader/mcuboot/boot/zephyr/zephyr/zephyr.bin \
Expand All @@ -335,13 +341,17 @@ Generate atm isp file

Show atm isp file
=================
$ west atm_arch -i ATMEVK-3330-QN-5_beacon.atm \
::

west atm_arch -i ATMEVK-3330-QN-5_beacon.atm \
--atm_isp_path modules/hal/atmosic_lib/tools/atm_isp \
--show

Flash atm isp file
==================
$ west atm_arch -i ATMEVK-3330-QN-5_beacon.atm \
::

west atm_arch -i ATMEVK-3330-QN-5_beacon.atm \
--atm_isp_path modules/hal/atmosic_lib/tools/atm_isp \
--openocd_pkg_root=modules/hal/atmosic_lib \
--burn
Expand Down

0 comments on commit 9e3075a

Please sign in to comment.