Commit Graph

208 Commits

Author SHA1 Message Date
Almir Okato 879348be07 docs: espressif: update documentation after ESP-IDF submodule removal
Signed-off-by: Almir Okato <almir.okato@espressif.com>
2023-07-24 10:03:18 -03:00
David Brown 2c1c5d145a docs: Update security to use github reporting
Hackerone hasn't turned out to be particularly useful.  Fortunately, github now
has a mechanism to directly report security vulnerabilities within the project's
pages.  Update the docs to show this as the preferred vulnerability reporting
mechanism.

Signed-off-by: David Brown <david.brown@linaro.org>
2023-06-15 08:29:08 -06:00
Jamie McCrae a6aef32619 docs: release: Add note on zephyr release
Adds details on updating the zephyr version file for releases.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-05-25 14:20:28 -06:00
Jamie McCrae abb18a31a3 docs: Add note on addition of image state/image set state commands
Adds a note that both of these functions are now (optionally)
supported in serial recovery mode.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-05-25 14:19:20 -06:00
Jamie McCrae 52605e5051 release-notes: Add note on zcbor encoder fix
Adds a note that the zcbor encoder buffer size has been fixed.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2023-05-25 14:17:20 -06:00
Jamie McCrae b388829846 docs: Add not on CDDL code being replaced
Adds a note that the CDDL function code has been replaced with
zcbor function calls.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-05-15 10:22:51 +02:00
David Vincze 4395b80976 boot: Restore and extend the usage of 0x22 TLV (ECDSA256)
The IMAGE_TLV_ECDSA256 TLV has been put out of use by
commit 63d2346da4.
This commit reverts this part of that patch and at the
same time it extends the usage of this TLV to cover all types
of curves (replacing the newly introduced 0x25 TLV type)
while retaining its value (0x22) for backward compatibility.
Rename IMAGE_TLV_ECDSA256 to IMAGE_TLV_ECDSA_SIG.

Change-Id: I904f292db775c38f26a5e9a87c5f414165efc173
Signed-off-by: David Vincze <david.vincze@arm.com>
2023-04-28 11:40:31 +02:00
Roland Mikhel c725cee102 docs: Add release note snippet for ECDSA TLV
Signed-off-by: Roland Mikhel <roland.mikhel@arm.com>
Change-Id: I6837467e985af644f124ae8a9cceb0f68736ec84
2023-04-26 13:27:44 +02:00
Roland Mikhel 63d2346da4 bootutil: Remove curve specific ECDSA TLVs
Remove those TLVs that are tied to a specific curve and update
the image validation logic to look for the new generic TLV

Signed-off-by: Roland Mikhel <roland.mikhel@arm.com>
Change-Id: I924f2742424bc255fbed1b0941648baa88f60147
2023-04-26 13:27:44 +02:00
Jamie McCrae 7a8a8f6794 docs: Add release note change for zcbor version
Adds a release note file indicating that zcbor files have been
updated to version 0.7.0

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-04-26 13:11:56 +02:00
dependabot[bot] b4a0d1b7a5 build(deps): bump nokogiri from 1.14.2 to 1.14.3 in /docs
Bumps [nokogiri](https://github.com/sparklemotion/nokogiri) from 1.14.2 to 1.14.3.
- [Release notes](https://github.com/sparklemotion/nokogiri/releases)
- [Changelog](https://github.com/sparklemotion/nokogiri/blob/main/CHANGELOG.md)
- [Commits](https://github.com/sparklemotion/nokogiri/compare/v1.14.2...v1.14.3)

---
updated-dependencies:
- dependency-name: nokogiri
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-04-26 13:07:19 +02:00
David Vincze 4e07d8f75f docs: add release note snippet for dumpinfo
Change-Id: I8f3041bff9a842edc53029ba993e21e56adde86c
Signed-off-by: David Vincze <david.vincze@arm.com>
2023-04-12 10:01:14 +02:00
Roland Mikhel c050573dd9 docs: Add release note for p224 removal
Signed-off-by: Roland Mikhel <roland.mikhel@arm.com>
Change-Id: I63d8b38e1d7a15fdc20e36daf768ffd26ac6469c
2023-04-11 07:05:38 +02:00
Roland Mikhel 3d92a6cb59 imgtool: Remove P224 curve references
Imgtool does not provide support for P224
curve, just a placeholder function that
says it's not currently implemented.
This has now been removed as P224 support
had been removed from the boot code too.

Signed-off-by: Roland Mikhel <roland.mikhel@arm.com>
Change-Id: I477d8e273085f38f35eaf9a591584f3e937d748d
2023-04-11 07:05:38 +02:00
Roland Mikhel 206b914852 bootutil: Remove P224 curve
Signed-off-by: Roland Mikhel <roland.mikhel@arm.com>
Change-Id: I49fad7ede202de4e3c710bf4aa1df195a310b037
2023-04-11 07:05:38 +02:00
Andrzej Puzdrowski cdf9de094e doc/readme-zephyr: document the serial recovery
Added description on serial recovery mode features and
its configuration.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
Signed-off-by: Anna Kielar <anna.kielar@nordicsemi.no>
2023-03-24 13:11:30 +01:00
Andrzej Puzdrowski 4e9d86aa08 doc: Added serial recovery documentation
Added description on what is the serial recovery protocol
in general.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
Signed-off-by: Anna Kielar <anna.kielar@nordicsemi.no>

fix
2023-03-24 13:11:30 +01:00
David Brown d2dfa1bd20 docs: Create release notes for 1.10.0 release
Signed-off-by: David Brown <david.brown@linaro.org>
2023-03-20 13:50:47 -06:00
David Brown 4337feed06 docs: Describe the release note snippet requirement
Add mention of the release note requirements to the SubmittingPatches
file so that developers are more likely to see and comply.

Signed-off-by: David Brown <david.brown@linaro.org>
2023-03-20 13:49:38 -06:00
David Brown d4184ebdb9 docs: Setup template for release note process
Add some guidelines for release notes that developers can use to create
release note snippets as features and fixes are implemented.  This will
greatly reduce the work needed at release time.

Signed-off-by: David Brown <david.brown@linaro.org>
2023-03-20 13:49:38 -06:00
Jamie McCrae 0b7b7ae655 docs: zephyr: Add note on swap-using-scratch
Adds details on how to use the swap-using-scratch algorithm and
associated risks.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-02-28 08:18:57 -07:00
dependabot[bot] c00f332c41 build(deps): bump nokogiri from 1.13.8 to 1.14.2 in /docs
Bumps [nokogiri](https://github.com/sparklemotion/nokogiri) from 1.13.8 to 1.14.2.
- [Release notes](https://github.com/sparklemotion/nokogiri/releases)
- [Changelog](https://github.com/sparklemotion/nokogiri/blob/main/CHANGELOG.md)
- [Commits](https://github.com/sparklemotion/nokogiri/compare/v1.13.8...v1.14.2)

---
updated-dependencies:
- dependency-name: nokogiri
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-02-24 12:04:03 +01:00
dependabot[bot] ccc8f8c855 build(deps): bump activesupport from 6.0.3.6 to 6.0.6.1 in /docs
Bumps [activesupport](https://github.com/rails/rails) from 6.0.3.6 to 6.0.6.1.
- [Release notes](https://github.com/rails/rails/releases)
- [Changelog](https://github.com/rails/rails/blob/v7.0.4.2/activesupport/CHANGELOG.md)
- [Commits](https://github.com/rails/rails/compare/v6.0.3.6...v6.0.6.1)

---
updated-dependencies:
- dependency-name: activesupport
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-02-23 20:02:05 -03:00
hasheddan 85b4e0bf54 Use full links for Cypress and Sim usage instructions
The relative links do not work on the docs website due to the files not
living in the docs/ directory. This updates to link directly to the
GitHub source so that users are not dropped onto a 404 page.

Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
2023-02-14 12:29:08 -07:00
Almir Okato 8724081f90 doc: espressif: Add warning note for Flash Encryption with Serial Recovery usage
Signed-off-by: Almir Okato <almir.okato@espressif.com>
2022-12-22 09:11:19 -03:00
Almir Okato 84da51b646 espressif: add downgrade prevention feature
Signed-off-by: Almir Okato <almir.okato@espressif.com>
2022-12-19 11:02:55 -03:00
Tamas Ban 04efc2e861 docs: fix FIH example command in design.md
Signed-off-by: Tamas Ban <tamas.ban@arm.com>
Change-Id: I3ce8177ad6ae8196b7deb4176c4441f41bbc475a
2022-12-16 13:06:11 +01:00
Almir Okato fc1eabf6bb boot_serial: espressif: ESP32-S3 serial recovery mode interface
Add the serial adapter for ESP32-S3 for boot recovery and MCUMGR
communication.

Signed-off-by: Almir Okato <almir.okato@espressif.com>
2022-11-11 11:22:00 -03:00
Almir Okato 4099583c12 boot_serial: espressif: ESP32-S2 serial recovery mode interface
Add the serial adapter for ESP32-S2 for boot recovery and MCUMGR
communication.

Signed-off-by: Almir Okato <almir.okato@espressif.com>
2022-11-11 11:22:00 -03:00
Andrzej Puzdrowski a6a5c08f08 doc/redame-zephyr:
Public key is handled by the build-system
since a while.

This patch reflect this in the documentation.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
Co-authored-by: Francesco Domenico Servidio <francesco.servidio@nordicsemi.no>
2022-10-17 16:58:45 +02:00
Andrzej Puzdrowski 7500156915 doc/readme-zephyr:
Zephyr-port has switched to use DT node labels instead of
label properties for partition assignment.

Also usage of west is recommended way to work with the project.

Documentation was actualized to reflect these principles.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
Co-authored-by: Francesco Domenico Servidio <francesco.servidio@nordicsemi.no>
2022-10-17 16:58:45 +02:00
Fabio Utzig 4e2cdfe82f imgtool: change getpub exporting format parameter
Update a previous PR were PEM exporting was added to the `--lang`
parameter, even though PEM is not a source code language per se.

This PR adds `--encoding/-e` to `getpub` command, for exporting
in formats other than a language source code. `--lang` is left with
a deprecation message, so it could be removed in a future version.
The default behavior of exporting source code in C was preserved.

Signed-off-by: Fabio Utzig <utzig@apache.org>
2022-09-29 19:31:02 -03:00
Almir Okato 09cca3815a boot_serial: espressif: ESP32-C3 serial recovery mode
Signed-off-by: Almir Okato <almir.okato@espressif.com>
2022-09-29 11:37:13 -03:00
Fabio Utzig 6f286779a6 imgtool: add option to export public PEM
Update `getpub` with new `lang` option, "pem", which allows exporting a
public key as a PEM file. This can later be distributed to be used for
encrypting an image, and gets away with having to use openssl for this
step.

Signed-off-by: Fabio Utzig <utzig@apache.org>
2022-09-22 11:34:43 -06:00
dependabot[bot] e00f24baf6 build(deps): bump nokogiri from 1.12.5 to 1.13.8 in /docs
Bumps [nokogiri](https://github.com/sparklemotion/nokogiri) from 1.12.5 to 1.13.8.
- [Release notes](https://github.com/sparklemotion/nokogiri/releases)
- [Changelog](https://github.com/sparklemotion/nokogiri/blob/main/CHANGELOG.md)
- [Commits](https://github.com/sparklemotion/nokogiri/compare/v1.12.5...v1.13.8)

---
updated-dependencies:
- dependency-name: nokogiri
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: Fabio Utzig <utzig@apache.org>
2022-09-05 17:48:58 -03:00
dependabot[bot] 45811234d8 build(deps): bump tzinfo from 1.2.9 to 1.2.10 in /docs
Bumps [tzinfo](https://github.com/tzinfo/tzinfo) from 1.2.9 to 1.2.10.
- [Release notes](https://github.com/tzinfo/tzinfo/releases)
- [Changelog](https://github.com/tzinfo/tzinfo/blob/master/CHANGES.md)
- [Commits](https://github.com/tzinfo/tzinfo/compare/v1.2.9...v1.2.10)

---
updated-dependencies:
- dependency-name: tzinfo
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: Fabio Utzig <utzig@apache.org>
2022-09-05 17:48:58 -03:00
Almir Okato e8cbc0d0f1 boot_serial: espressif: ESP32 serial recovery mode interface
Add the serial adapter for ESP32 for boot recovery and MCUMGR
communication.

Signed-off-by: Almir Okato <almir.okato@espressif.com>

espressif: Configure console via bootloader_support functions

Signed-off-by: Gustavo Henrique Nihei <gustavo.nihei@espressif.com>
2022-07-19 11:07:04 -03:00
David Brown e802cd4846 docs: Fix case of Cypress readme file
Fix the case of the cypress readme to fix dead links in the docs.

Signed-off-by: David Brown <david.brown@linaro.org>
2022-05-17 11:20:13 -06:00
Almir Okato fa173df366 espressif: Add warning for unsupported chip revision
Added checking and warning for ESP32, ESP32-S2, ESP32-C3, ESP32-S3
unsupported chip revisions on their initialization.

Made respectively changes for build system and documentation.

Signed-off-by: Almir Okato <almir.okato@espressif.com>
2022-05-09 15:55:23 -03:00
Almir Okato a1d641d59e espressif:esp32: Add multi image support
Changes on configuration and flash area organization for supporting
multi image and implementation for booting on different processors
on esp32

Signed-off-by: Almir Okato <almir.okato@espressif.com>
2022-03-16 03:58:01 -03:00
Almir Okato 20e020984b index.md: fix readme-espressif.md link
Signed-off-by: Almir Okato <almir.okato@espressif.com>
2022-03-16 03:57:32 -03:00
Almir Okato b365e234a3 espressif: add missing information for secure features
Add instructions on the readme-espressif.md on how to encrypt
data on the host.
Also add configuration and instructions for disabling/switch
UART ROM Download Mode.

Signed-off-by: Almir Okato <almir.okato@espressif.com>
2022-03-14 11:19:31 -03:00
Almir Okato 611ea503ff index.md: update the Espressif references to reflect readme.md
Signed-off-by: Almir Okato <almir.okato@espressif.com>
2022-03-14 11:19:31 -03:00
David Brown c657cbea75 Update to version 1.9.0
Bump version information for 1.9.0 release

Signed-off-by: David Brown <david.brown@linaro.org>
2022-03-02 14:29:33 -07:00
Sylvio Alves d8eff810ad doc: espressif: add ESP32-S3 development status
This updates information related to ESP32-S3 SoC.

Signed-off-by: Sylvio Alves <sylvio.alves@espressif.com>
2022-02-17 16:18:42 -03:00
Sylvio Alves d523094aa4 doc: espressif: add parameter details for esptool and imgtool
esptool and imgtool require additional information that is not clear
to end user.

It also update ESP32 status for Zephyr porting.

Signed-off-by: Sylvio Alves <sylvio.alves@espressif.com>
2022-02-17 16:18:42 -03:00
David Brown b32ff6d653 doc: Update release notes for 1.9.0-rc2
Add notes on changes since rc1.

Signed-off-by: David Brown <david.brown@linaro.org>
2022-02-10 12:21:07 -07:00
Wouter Cappelle bb7a39d114 Add config option for caching of validation state of an image in primary slot for single loader
Signed-off-by: Wouter Cappelle <wouter.cappelle@crodeon.com>
2022-02-09 13:31:56 -07:00
David Brown eaa8b31917 docs: Update release notes for 1.9.0 release
Signed-off-by: David Brown <david.brown@linaro.org>
2022-01-21 14:01:05 -07:00
Francesco Domenico Servidio 4fb288af9e doc: updated release.md
Fixed spacing after periods.
Rephrased slighly unclear sentences.
Added other very minor fixes.

Signed-off-by: Francesco Domenico Servidio <francesco.servidio@nordicsemi.no>
2022-01-18 13:21:17 -07:00