17 Commits

Author SHA1 Message Date
Atharva Lele
dbde6f11c2 Enhance docs and clean up warnings in several docs (#169)
- Make footer copyright year update automatically
- Add clarification about EPLD region
- Add heading to build tool doc
- Clean up warnings about section links, length of underlines, etc.
- Adjust whitespace in Build System doc
- Fix reference to key management section

Signed-off-by: Atharva Lele <atharva.lele@intel.com>
2023-04-04 14:30:28 -07:00
Supreet Gulavani
d6e489bb70 Updated SBL Keys Generation Section (#164)
- Added info to set SBL_KEY_DIR environment variable
- Added an anchor in key-management.rst to reference it in SBL Keys
  Generation section

Signed-off-by: Supreet Gulavani <supreet.gulavani@intel.com>
2023-02-21 11:35:25 -08:00
sean-m-mcginn
ea0bc6a037 Further enhance documentation for firmware resiliency (#159)
* Reduce the size of SBL recovery sample logs

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Note that FSP debugging must be turned off when SBL resiliency enabled

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Group SBL resiliency diagrams by scenario

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Refactor note on FSP debugging and SBL resiliency

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>
2023-01-18 09:23:18 -08:00
sean-m-mcginn
37e88e8461 Enhance documentation for firmware resiliency (#158)
* Add expected behavior to the corruption tutorial section

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Add note detailing which platforms support resiliency

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>
2023-01-17 15:10:42 -08:00
sean-m-mcginn
39319deba6 Add documentation for firmware resiliency (#151)
* Add documentation for firmware resiliency

This change adds a section for firmware resiliency
as well as updates existing sections that are related
to firmware resiliency

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Fix grammatical errors in resiliency and recovery section

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Add in test tool tutorials for SBL resiliency

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Add in block diagrams for SBL resiliency

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Make minor improvements to resiliency and update sections

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Mention non-overlapping region requirement for FW update capsule tool

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Give example for building FW update capsule with TMAC:IPFW

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Add note that corruptcomp tool should be disabled in prod builds

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>
2023-01-13 13:40:04 -08:00
Subash Lakkimsetti
a4e18cdaee Container security methods (#112)
This patch captures documentation of container security,
keys involved and component update flow.

Signed-off-by: Subash Lakkimsetti <subash.lakkimsetti@intel.com>
2021-06-23 13:09:38 -07:00
Subash Lakkimsetti
3ab68264c4 Update openssl to latest version (#100)
User has to set OPENSSL_PATH to Openssl directort
where openssl.exe is present.
Updated documentation error in verified boot.

Signed-off-by: Subash Lakkimsetti <subash.lakkimsetti@intel.com>
2020-12-15 08:09:31 -08:00
naveenm18
84b90e20fa Updated .rst files information from dsc to yaml. (#84)
Also Images which mentioned about dsc also updated to yaml.

Signed-off-by: Mutha <naga.naveen.mutha@intel.com>

Co-authored-by: Mutha <naga.naveen.mutha@intel.com>
2020-09-03 13:19:00 -07:00
James Gutbub
74221ba5a4 Add page for VxWorks booting
The new page provides info on generating a SBL OS container
consisting of the VxWorks kernel binary given in ELF format
and is multiboot compliant as well as providing info on how
to configure the boot options to launch this container.

Also include a few additional changes to resolve some build
issues reported during 'make html' after running 'make clean'.

Signed-off-by: James Gutbub <james.gutbub@intel.com>
2020-07-08 13:31:08 -07:00
Subash Lakkimsetti
4672e9b185 Update documentation for single sign key management (#74)
- Updated SBL key management and Key ids
- Info with GenerateKeys.py
- Build changes for introducting SBL_KEY_DIR env variable
- GenContainer updates for auth types and Key id

Signed-off-by: Subash Lakkimsetti <subash.lakkimsetti@intel.com>
2020-07-07 13:16:40 -07:00
James Gutbub
42b69f095d Update firmware update triggering info (#77)
Recently support for triggering a FW update
via Linux kernel has been enabled, this patch
provides the details on how to trigger a FW
update if the Linux kernel supports it.

Also some other notes on HTTP server in Python3
and remove error message about guessing the syntax
of the Windows FW update triggering code block.

Signed-off-by: James Gutbub <james.gutbub@intel.com>
2020-06-15 21:50:30 -07:00
Sachin Agrawal
f8254dc8c6 Updated SBL security related items (#73) (#72)
1) Added a picture depicting SBL Verified Boot chain.
2) Added a table describing the usage of various keys.

Signed-off-by: Sachin Agrawal <sachin.agrawal@intel.com>
2020-06-11 18:14:11 -07:00
raghavag
9c46cb4ce5 Added updated information for Firmware Update (#70)
Following changes are made for firmware update documentation

1) Trigger from Operating system mechanism
2) 4-byte string id instead of GUID to identify components information
   capsule.
3) Container component update.

Signed-off-by: Raghava Gudla <raghava.gudla@intel.com>

Co-authored-by: Raghava Gudla <raghava.gudla@intel.com>
2020-03-31 15:58:44 -07:00
raghavag
25639f6254 Add additional information about firmware update (#60)
This patch added additional information about firmware update
namely, capsule layout, generating capsule, triggering firmware
update and generating sbl binaries for firmware update capsule.

Signed-off-by: Raghava Gudla <raghava.gudla@intel.com>
2019-11-08 09:52:47 -08:00
James Gutbub
c5a516be99 Clean up spelling (#41)
Performed some spell checking on the source/*.rst files
in most places as needed

Signed-off-by: James Gutbub <james.gutbub@intel.com>
2019-04-23 15:34:23 -07:00
Huang Jin
41ca732eea Cleanup build warnings. No content change. (#27)
Signed-off-by: Huang Jin <huang.jin@intel.com>
2019-01-04 16:53:36 -08:00
Jin, Huang
fbf926ff96 Initial doc code check-in 2018-09-13 16:20:25 -07:00