intel_s1000: doc: Update doc with MCUbootloader support #12355

rgundi · 2019-01-07T10:19:26Z

The documentation for intel_s1000 is updated with the steps
to use it with MCUbootloader.

Signed-off-by: Rajavardhan Gundi [email protected]

zephyrbot · 2019-01-07T10:31:10Z

All checks are passing now.

Review history of this comment for details about previous failed status.
Note that some checks might have not completed yet.

nashif · 2019-01-07T16:52:18Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

replace MCUbootloader with MCUBoot Bootloader

Also, it's Zephyr on Intel S1000, not Intel S1000 on Zephyr.

sathishkuttan · 2019-01-07T17:49:55Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

Also, it's Zephyr on Intel S1000, not Intel S1000 on Zephyr.

sathishkuttan · 2019-01-07T17:50:58Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

USB DFU is not exactly over the "air", please remove "over the air". Also change "upgradation" to "upgrades".

Will this procedure (and upgrading the S1000 firmware) work on the board referenced at the top of this doc (https://software.intel.com/en-us/iot/speech-enabling-dev-kit)? I suspect not, and we need to be more explicit at the top of this doc about the board and procedures being documented here.

@dbkinder This procedure will work on the board referenced at the top of this doc.

sathishkuttan · 2019-01-07T17:53:23Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

This block is similar to the app build and should be able to use the zephyr-app-commands directive. See around line 136

zephyr-app-commands are applicable only to those apps which are within the zephyr tree. mcubootloader is outside of it.

see :app: directive (vs :zephyr-app:) at https://docs.zephyrproject.org/latest/documentation/doc-guidelines.html#zephyr-app-commands-directive

modified as suggested.

sathishkuttan · 2019-01-07T17:54:24Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

create_spi_flash utility is not available publicly. need to make it or a variant of it as part of the build system before updating the document.

ok. noted. I will keep this for the time being while i work on the utility

Removed this now. #12662 addresses this.

sathishkuttan · 2019-01-07T17:55:43Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

So, when the active image is switched to image1, will the DFU capability be lost? If the DFU capability is part of the image, then both image0 and image1 should have the capability.

That's correct. updated the doc.

dbkinder · 2019-01-08T22:12:16Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

add one more space on the indent...

Suggested change

`MCUboot with Zephyr`_ documentation for details.)

`MCUboot with Zephyr`_ documentation for details.)

dbkinder · 2019-01-08T22:13:53Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

Given the comment below, this title should likely be MCUBoot bootloader support (and adjust the title underline)

dbkinder · 2019-01-08T22:15:28Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

... and change all references to MCUBoot bootloader

Suggested change

MCUbootloader in conjuntion with USB DFU (Device Firmware Upgrade)

MCUBoot bootloader, in conjunction with USB DFU (Device Firmware Upgrade),

dbkinder · 2019-01-08T22:18:32Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

Suggested change

over the air can be used for Field upgradation of Intel S1000 Firmware.

can be used to upgrade Intel S1000 firmware.

dbkinder · 2019-01-08T22:19:16Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

Suggested change

The MCUbootloader source code itself is hosted in the

The MCUBoot bootloader source code is hosted in the

dbkinder · 2019-01-08T22:37:50Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

Suggested change

looking at boards/xtensa/intel_s1000_crb/intel_s1000_crb.dts. Refer to

looking at ``boards/xtensa/intel_s1000_crb/intel_s1000_crb.dts``. Refer to

dbkinder · 2019-01-08T22:38:57Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

Suggested change

In order to build an MCUboot-compatible Intel S1000 Firmware image

Build an MCUboot-compatible Intel S1000 Firmware image

dbkinder · 2019-01-08T22:39:24Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

Suggested change

(image0/image1), you need to do the following:

(image0/image1), by following these steps:

dbkinder · 2019-01-08T22:57:46Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

Need to indent the code-block directives to be within the bullet list items.
How about more simply:

1. Edit your application's :file:`.conf` file to enable the :option:`CONFIG_BOOTLOADER_MCUBOOT` option. 2. Use the ``scripts/imagetool.py`` script from the MCUboot GitHub repo`_ to sign the ``image0`` image (see `MCUboot with Zephyr`_ documentation for details): .. code-block:: console scripts/imgtool.py sign \ --key root-rsa-2048.pem \ --header-size 0x100 \ --align 8 \ --version 1.2 \ --slot-size 0x1D0000 \ ./zephyr/zephyr.bin \ signed-zephyr0.bin 3. Sign the ``image1`` upgrade image with the ``--pad`` option: .. code-block:: console scripts/imgtool.py sign \ --key root-rsa-2048.pem \ --header-size 0x100 \ --align 8 \ --version 1.2 \ --slot-size 0x1D0000 \ --pad ./zephyr/zephyr.bin \ signed-zephyr1.bin

dbkinder · 2019-01-08T23:04:10Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

Will this procedure (and upgrading the S1000 firmware) work on the board referenced at the top of this doc (https://software.intel.com/en-us/iot/speech-enabling-dev-kit)? I suspect not, and we need to be more explicit at the top of this doc about the board and procedures being documented here.

rgundi · 2019-01-09T07:46:35Z

@dbkinder @sathishkuttan addressed your comments. Plz have a look.

dbkinder

Docs look better, but still need to resolve use of ./create_spi_flash

dbkinder · 2019-01-17T00:39:00Z

boards/xtensa/intel_s1000_crb/doc/intel_s1000.rst

OK, but it's still here in this version of the documentation being reviewed.

rgundi · 2019-01-25T18:14:58Z

Docs look better, but still need to resolve use of ./create_spi_flash

The reference to create_spi_flash is now removed. Please review again.

dbkinder

+1 for docs, thanks!

The documentation for intel_s1000 is updated with the steps to use it with MCUbootloader. Signed-off-by: Rajavardhan Gundi <[email protected]>

rgundi · 2019-03-20T08:46:00Z

@nashif .. please check if this can be merged. Shippable failures seem to be unrelated.

nashif · 2019-12-21T04:16:55Z

stale

rgundi requested review from SavinayDharmappa, dbkinder, nashif and sathishkuttan January 7, 2019 10:19

rgundi force-pushed the mcuboot_doc branch from ff95c3f to 26a8709 Compare January 7, 2019 10:41

nashif requested changes Jan 7, 2019

View reviewed changes

sathishkuttan suggested changes Jan 7, 2019

View reviewed changes

dbkinder suggested changes Jan 8, 2019

View reviewed changes

rgundi force-pushed the mcuboot_doc branch from 26a8709 to 77426d6 Compare January 9, 2019 07:34

rgundi force-pushed the mcuboot_doc branch from 77426d6 to ee4e76b Compare January 10, 2019 04:24

dbkinder suggested changes Jan 17, 2019

View reviewed changes

rgundi force-pushed the mcuboot_doc branch from ee4e76b to fa72ae4 Compare January 25, 2019 18:10

rgundi force-pushed the mcuboot_doc branch 2 times, most recently from 6da0dc5 to 92eeccc Compare January 29, 2019 04:55

dbkinder approved these changes Feb 19, 2019

View reviewed changes

intel_s1000: doc: Update doc with mcubootloader support

280c5a5

The documentation for intel_s1000 is updated with the steps to use it with MCUbootloader. Signed-off-by: Rajavardhan Gundi <[email protected]>

rgundi force-pushed the mcuboot_doc branch from 92eeccc to 280c5a5 Compare March 20, 2019 07:34

galak added the area: Documentation label Mar 28, 2019

galak added this to the v1.14.0 milestone Mar 28, 2019

galak modified the milestones: v1.14.0, future Apr 16, 2019

nashif removed the request for review from SavinayDharmappa November 29, 2019 18:02

zephyrproject-rtos deleted a comment from codecov-io Dec 21, 2019

nashif added the Stale PR label Dec 21, 2019

nashif closed this Dec 21, 2019

	`MCUboot with Zephyr`_ documentation for details.)
	`MCUboot with Zephyr`_ documentation for details.)

	MCUbootloader in conjuntion with USB DFU (Device Firmware Upgrade)
	MCUBoot bootloader, in conjunction with USB DFU (Device Firmware Upgrade),

	over the air can be used for Field upgradation of Intel S1000 Firmware.
	can be used to upgrade Intel S1000 firmware.

	The MCUbootloader source code itself is hosted in the
	The MCUBoot bootloader source code is hosted in the

	looking at boards/xtensa/intel_s1000_crb/intel_s1000_crb.dts. Refer to
	looking at ``boards/xtensa/intel_s1000_crb/intel_s1000_crb.dts``. Refer to

	In order to build an MCUboot-compatible Intel S1000 Firmware image
	Build an MCUboot-compatible Intel S1000 Firmware image

	(image0/image1), you need to do the following:
	(image0/image1), by following these steps:

intel_s1000: doc: Update doc with MCUbootloader support #12355

intel_s1000: doc: Update doc with MCUbootloader support #12355

Uh oh!

Conversation

rgundi commented Jan 7, 2019

Uh oh!

zephyrbot commented Jan 7, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rgundi commented Jan 9, 2019

zephyrbot commented Jan 7, 2019 •

edited

Loading