24 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
Atharva Lele
af467a7543 Update Container Tool documentation (#160)
Updates the document to reflect the changes made by
https://github.com/slimbootloader/slimbootloader/pull/1816

Adds details on ACPI table update and adds example commands
for creating each type of container

Signed-off-by: Atharva Lele <atharva.lele@intel.com>
2023-02-06 15:34:38 -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
Atharva Lele
ed377682a2 Container Tool doc updates (#154)
* Update Key IDs in Container Tool doc

Update KEY ID values to reflect currently used keys

Signed-off-by: Atharva Lele <atharva.lele@intel.com>

* Clean up GenContainer create examples

Also specify where the container header name comes from.

Signed-off-by: Atharva Lele <atharva.lele@intel.com>

Signed-off-by: Atharva Lele <atharva.lele@intel.com>
2022-12-12 17:01:58 -08:00
Atharva Lele
9170797fab IAS and other cleanup (#153)
* GenContainer: bold the default container type

Signed-off-by: Atharva Lele <atharva.lele@intel.com>

* Add container type to VxWorks create container command

Signed-off-by: Atharva Lele <atharva.lele@intel.com>

* Remove ACRN page from the How-Tos index

Signed-off-by: Atharva Lele <atharva.lele@intel.com>

* Remove fastboot page from the How-Tos index

Signed-off-by: Atharva Lele <atharva.lele@intel.com>

* Update image on Container tool to remove spell check lines

Signed-off-by: Atharva Lele <atharva.lele@intel.com>

* Change IAS reference to container in build system doc

Signed-off-by: Atharva Lele <atharva.lele@intel.com>

* Replace IAS references with container in Change Boot Options doc

Signed-off-by: Atharva Lele <atharva.lele@intel.com>

Signed-off-by: Atharva Lele <atharva.lele@intel.com>
2022-12-09 17:04:58 -08:00
Atharva Lele
c00170476f Container related document updates (#152)
* Add container type details to container tool doc

Signed-off-by: Atharva Lele <atharva.lele@intel.com>

* Add Boot to Container section in QEMU doc

Signed-off-by: Atharva Lele <atharva.lele@intel.com>

* Add RTCM container build command to TCC enabling guide

Signed-off-by: Atharva Lele <atharva.lele@intel.com>

Signed-off-by: Atharva Lele <atharva.lele@intel.com>
2022-12-09 12:57:11 -08:00
Ravi Rangarajan
db1ba3380c fixed unicode chars and some other minor updates (#95)
* fixed unicode chars and some other minor updates

* Format update for consistency

* Format update for consistency
2020-09-15 15:05:44 -07:00
Ravi Rangarajan
8cb4a2e184 Updated Tools section (#93) 2020-09-15 14:21:55 -07:00
Subash Lakkimsetti
378f7e3973 SVN configuration in container tools (#86)
This patch updates documentation for configuring
svn while container creation and for component update.

Signed-off-by: Subash Lakkimsetti <subash.lakkimsetti@intel.com>
2020-09-03 13:20:04 -07: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
bigchenla
86d217374a Correct command and struct for Whiskey Lake (#78) 2020-06-22 13:34:36 -07:00
Subash Lakkimsetti
e635d94155 GenContainer tool documentation updates (#66)
Updated for Authentication algorithm changes.

Signed-off-by: Subash Lakkimsetti <subash.lakkimsetti@intel.com>
2020-02-20 16:42:13 -08:00
stalamudupula
eaa251baa4 GenGpioData.py tool documentation (#61)
Add documentation for the GenGpioData.py tool

Signed-off-by: Sai Talamudupula <sai.kiran.talamudupula@intel.com>
2019-11-14 05:35:37 +08:00
stalamudupula
533f4c74bf Add documentation for GenContainer.py script (#59)
Add simple documentation for Container Generation script.

Signed-off-by: Sai Talamudupula <sai.kiran.talamudupula@intel.com>
2019-11-01 01:56:40 +08:00
Ravi Rangarajan
2c1c6adc46 Updated Getting Started and Supported Hardware sections (#45) 2019-06-24 10:40:37 -07: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
aa47f212bd Update documenation for iasimage Tool
iasimage tool now supports both Python 2.x and 3.x
(GitHub commit: b637605)

Signed-off-by: Huang Jin <huang.jin@intel.com>
2019-04-03 16:09:50 -07:00
Huang Jin
b8cd886853 Add How-To to generate IAS boot image
Signed-off-by: Huang Jin <huang.jin@intel.com>
2019-01-08 15:10:59 -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
YoYo
ce76fadac1 Add 'Source Level Debugging' page under 'Developer's Guide' (#6)
Add source level debugging guide
2018-11-12 16:37:46 -08:00
Huang Jin
8ef7f8b4d0 Update build command usage on Windows (#2)
BuildLoader.cmd is out-dated. Use BuildLoader.py
for both Windows and Linux build.

Signed-off-by: Huang Jin <huang.jin@intel.com>
2018-10-01 16:28:34 -07:00
Jin, Huang
fbf926ff96 Initial doc code check-in 2018-09-13 16:20:25 -07:00