aboutsummaryrefslogtreecommitdiffstats
path: root/docs/components
Commit message (Collapse)AuthorAgeFilesLines
* Fix typos and misspellingsDavid Horstmann2020-11-121-2/+2
| | | | | | | | Fix a number of typos and misspellings in TF-A documentation and comments. Signed-off-by: David Horstmann <david.horstmann@arm.com> Change-Id: I34c5a28c3af15f28d1ccada4d9866aee6af136ee
* doc: add description of "owner" field in SP layout file.Manish Pandey2020-09-151-3/+11
| | | | | Change-Id: Iedaa83ed546eb2476849a8d53f6e05b847a48b23 Signed-off-by: Manish Pandey <manish.pandey2@arm.com>
* doc: Update the cot-binding for nv-counter nodeManish V Badarkhe2020-08-281-10/+14
| | | | | | | | Updated the cot-binding documentation to add 'id' property for the trusted and non-trusted nv-counters. Signed-off-by: Manish V Badarkhe <Manish.Badarkhe@arm.com> Change-Id: If1c628c5b90fe403dd96c7cd0cd04f37288c965c
* Fix broken links in docsMadhukar Pappireddy2020-08-062-7/+6
| | | | | Change-Id: If82aaba9f2a5a74cfb5e4381f968166037a70037 Signed-off-by: Madhukar Pappireddy <madhukar.pappireddy@arm.com>
* Fix broken links to various sections across docsMadhukar Pappireddy2020-08-036-42/+32
| | | | | | | | | | | These broken links were found with the help of this command: $> sphinx-build -M linkcheck . build A sample broken link is reported as follows: (line 80) -local- firmware-design.rst#secure-el1-payloads-and-dispatchers Change-Id: I5dcefdd4b8040908658115647e957f6c2c5da7c2 Signed-off-by: Madhukar Pappireddy <madhukar.pappireddy@arm.com>
* Merge "doc: secure partition manager design" into integrationjoanna.farley2020-07-293-3/+888
|\
| * doc: secure partition manager designOlivier Deprez2020-07-213-3/+888
| | | | | | | | | | | | | | | | | | | | Former EL3 Secure Partition Manager using MM protocol is renamed Secure Partition Manager (MM). A new Secure Partition Manager document covers TF-A support for the PSA FF-A compliant implementation. Signed-off-by: Olivier Deprez <olivier.deprez@arm.com> Change-Id: I9763359c2e96181e1726c8ad72738de293b80eb4
* | plat/arm/board/fvp: Add support for Measured BootAlexei Fedorov2020-07-223-0/+48
|/ | | | | | | | | | | | | | | | | This patch adds support for Measured Boot functionality to FVP platform code. It also defines new properties in 'tpm_event_log' node to store Event Log address and it size 'tpm_event_log_sm_addr' 'tpm_event_log_addr' 'tpm_event_log_size' in 'event_log.dtsi' included in 'fvp_tsp_fw_config.dts' and 'fvp_nt_fw_config.dts'. The node and its properties are described in binding document 'docs\components\measured_boot\event_log.rst'. Change-Id: I087e1423afcb269d6cfe79c1af9c348931991292 Signed-off-by: Alexei Fedorov <Alexei.Fedorov@arm.com>
* doc: Update CoT binding to make it more genericManish V Badarkhe2020-07-091-108/+149
| | | | | | | | | | Updated the CoT binding document to show chain of trust relationship with the help of 'authentication method' and 'authentication data' instead of showing content of certificate and fixed rendering issue while creating html page using this document. Signed-off-by: Manish V Badarkhe <Manish.Badarkhe@arm.com> Change-Id: Ib48279cfe786d149ab69ddc711caa381a50f9e2b
* doc: RAS: fixing broken linksManish Pandey2020-06-302-25/+20
| | | | | | | | There were some links in the file "ras.rst" which were broken, this patch fixes all the broken links in this file. Signed-off-by: Manish Pandey <manish.pandey2@arm.com> Change-Id: I00cf080e9338af5786239a4843cb4c2e0cc9d99d
* doc: Update BL1 and BL2 boot flowManish V Badarkhe2020-06-261-4/+7
| | | | | | | | | | | Updated the document for BL1 and BL2 boot flow to capture below changes made in FCONF 1. Loading of fw_config and tb_fw_config images by BL1. 2. Population of fw_config and tb_fw_config by BL2. Signed-off-by: Manish V Badarkhe <Manish.Badarkhe@arm.com> Change-Id: Ifea5c61d520ff1de834c279ce1759b53448303ba
* doc: Add a binding document for COT descriptorsManish V Badarkhe2020-06-232-0/+288
| | | | | | | | Added a binding document for COT descriptors which is going to be used in order to create COT desciptors at run-time. Signed-off-by: Manish V Badarkhe <Manish.Badarkhe@arm.com> Change-Id: Ic54519b0e16d145cd1609274a00b137a9194e8dd
* Prevent RAS register access from lower ELsVarun Wadekar2020-06-121-1/+2
| | | | | | | | | | | This patch adds a build config 'RAS_TRAP_LOWER_EL_ERR_ACCESS' to set SCR_EL3.TERR during CPU boot. This bit enables trapping RAS register accesses from EL1 or EL2 to EL3. RAS_TRAP_LOWER_EL_ERR_ACCESS is disabled by default. Signed-off-by: Varun Wadekar <vwadekar@nvidia.com> Change-Id: Ifb0fb0afedea7dd2a29a0b0491a1161ecd241438
* doc: Fixes in PSA FF-A binding documentLouis Mayencourt2020-05-251-23/+17
| | | | | | | | | | | | | - Fix possible run-time ELs value and xlat-granule size. - Remove mandatory field for stream-ids. - Define interrupts attributes to <u32>. - Remove mem-manage field. - Add description for memory/device region attributes. Co-authored-by: Manish Pandey <manish.pandey2@arm.com> Signed-off-by: Louis Mayencourt <louis.mayencourt@arm.com> Signed-off-by: Manish Pandey <manish.pandey2@arm.com> Change-Id: I71cf4406c78eaf894fa6532f83467a6f4110b344
* SPCI is now called PSA FF-AJ-Alves2020-05-252-17/+17
| | | | | | | | | | SPCI is renamed as PSA FF-A which stands for Platform Security Architecture Firmware Framework for A class processors. This patch replaces the occurrence of SPCI with PSA FF-A(in documents) or simply FFA(in code). Change-Id: I4ab10adb9ffeef1ff784641dfafd99f515133760 Signed-off-by: J-Alves <joao.alves@arm.com>
* doc: Add binding document for fconf.Louis Mayencourt2020-04-303-3/+48
| | | | | | | | | Complete the documentation with information on how to write a DTS for fconf. This patch adds the bindings information for dynamic configuration properties. Signed-off-by: Louis Mayencourt <louis.mayencourt@arm.com> Change-Id: Ic6d9f927df53bb87315c23ec5a8943d0c3258d45
* doc: Fixup some SMCCC linksSandrine Bailleux2020-04-171-1/+1
| | | | | | | | | This is a fixup for patch 3ba55a3c5fa260c9218be1adff8f39fc2a568d68 ("docs: Update SMCCC doc, other changes for release"), where some links names got changed but their references didn't. Change-Id: I980d04dde338f3539a2ec1ae2e807440587b1cf5 Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
* docs: Update SMCCC doc, other changes for releaselaurenw-arm2020-04-164-6/+6
| | | | | Signed-off-by: Lauren Wehrmeister <lauren.wehrmeister@arm.com> Change-Id: Ie842d6a9919776de151a4e9304f870aede07c47a
* doc: Fix "unexpected indentation" warning.Louis Mayencourt2020-04-013-0/+18
| | | | | Signed-off-by: Louis Mayencourt <louis.mayencourt@arm.com> Change-Id: I521eed6466fdfef18a92f5237912cb402441044a
* spm: Add spci manifest binding documentLouis Mayencourt2020-03-231-0/+239
| | | | | | | | The manifest binding document defines the expected properties and their formats to represent a partition manifest in device tree. Change-Id: I5eb250c7b89e0d828e1fcfce32b121e4081879ec Signed-off-by: Louis Mayencourt <louis.mayencourt@arm.com>
* Merge "fconf: Add namespace guidance inside documentation" into integrationMark Dykes2020-03-161-0/+27
|\
| * fconf: Add namespace guidance inside documentationLouis Mayencourt2020-03-111-0/+27
| | | | | | | | | | Change-Id: I50707d1836c7f5e4ef162c00256624a1f278baef Signed-off-by: Louis Mayencourt <louis.mayencourt@arm.com>
* | fconf: necessary modifications to support fconf in BL31 & SP_MINMadhukar Pappireddy2020-03-111-12/+28
|/ | | | | | | | | | | | | | | | | | | | Necessary infrastructure added to integrate fconf framework in BL31 & SP_MIN. Created few populator() functions which parse HW_CONFIG device tree and registered them with fconf framework. Many of the changes are only applicable for fvp platform. This patch: 1. Adds necessary symbols and sections in BL31, SP_MIN linker script 2. Adds necessary memory map entry for translation in BL31, SP_MIN 3. Creates an abstraction layer for hardware configuration based on fconf framework 4. Adds necessary changes to build flow (makefiles) 5. Minimal callback to read hw_config dtb for capturing properties related to GIC(interrupt-controller node) 6. updates the fconf documentation Change-Id: Ib6292071f674ef093962b9e8ba0d322b7bf919af Signed-off-by: Madhukar Pappireddy <madhukar.pappireddy@arm.com>
* Merge "doc: debugfs remove references section and add topic to components ↵Mark Dykes2020-02-122-15/+9
|\ | | | | | | index" into integration
| * doc: debugfs remove references section and add topic to components indexOlivier Deprez2020-02-122-15/+9
| | | | | | | | | | Signed-off-by: Olivier Deprez <olivier.deprez@arm.com> Change-Id: I8c2e6dc98f2f30a81f4f80cc0ca1232fed7a53c9
* | fconf: Add documentationLouis Mayencourt2020-02-072-0/+86
|/ | | | | Change-Id: I606f9491fb6deebc6845c5b9d7db88fc5c895bd9 Signed-off-by: Louis Mayencourt <louis.mayencourt@arm.com>
* doc: Remove backquotes from external hyperlinksImre Kis2020-02-031-2/+2
| | | | | | | | | | Since Sphinx 2.3.0 backquotes are replaced to \textasciigrave{} during building latexpdf. Using this element in a \sphinxhref{} breaks the build. In order to avoid this error backquotes must not be used in external hyperlinks. Signed-off-by: Imre Kis <imre.kis@arm.com> Change-Id: Ie3cf454427e3d5a7b7f9829b42be45aebda7f0dd
* spm-mm: correcting instructions to build SPM for FVPManish Pandey2020-01-231-2/+2
| | | | | | | | | | | | | | | Out of two possible implementation of Secure Partition Manager(SPM) currently only Management mode (MM) design is supported and the support for SPM based on SPCI Alpha 1 prototype has been removed. Earlier both implementation used common build flag "ENABLE_SPM" but it has since been decoupled and MM uses a separate build FLAG "SPM_MM". Instructions to build it for FVP was still using "ENABLE_SPM", which has beend corrected in this patch. Signed-off-by: Manish Pandey <manish.pandey2@arm.com> Change-Id: I505b98173d6051816436aa602ced6dbec4efc776
* Merge "debugfs: add SMC channel" into integrationMark Dykes2019-12-202-0/+473
|\
| * debugfs: add SMC channelAmbroise Vincent2019-12-182-0/+473
| | | | | | | | | | | | | | | | | | | | Provide an SMC interface to the 9p filesystem. This permits accessing firmware drivers through a common interface, using standardized read/write/control operations. Signed-off-by: Ambroise Vincent <ambroise.vincent@arm.com> Signed-off-by: Olivier Deprez <olivier.deprez@arm.com> Change-Id: I9314662314bb060f6bc02714476574da158b2a7d
* | spm-mm: Refactor spm_svc.h and its contentsPaul Beesley2019-12-201-20/+21
| | | | | | | | | | Change-Id: I91c192924433226b54d33e57d56d146c1c6df81b Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* | spm-mm: Refactor secure_partition.h and its contentsPaul Beesley2019-12-201-1/+1
|/ | | | | | | | | | | | | | | | | | | Before adding any new SPM-related components we should first do some cleanup around the existing SPM-MM implementation. The aim is to make sure that any SPM-MM components have names that clearly indicate that they are MM-related. Otherwise, when adding new SPM code, it could quickly become confusing as it would be unclear to which component the code belongs. The secure_partition.h header is a clear example of this, as the name is generic so it could easily apply to any SPM-related code, when it is in fact SPM-MM specific. This patch renames the file and the two structures defined within it, and then modifies any references in files that use the header. Change-Id: I44bd95fab774c358178b3e81262a16da500fda26 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* doc: Split the User Guide into multiple filesPaul Beesley2019-11-271-8/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The User Guide document has grown organically over time and now covers a wide range of topics, making it difficult to skim read and extract information from. Currently, it covers these topics and maybe a couple more: - Requirements (hardware, tools, libs) - Checking out the repo - Basic build instructions - A comprehensive list of build flags - FIP packaging - Building specifically for Juno - Firmware update images - EL3 payloads - Preloaded BL33 boot flow - Running on FVPs - Running on Juno I have separated these out into a few groups that become new documents. Broadly speaking, build instructions for the tools, for TF-A generally, and for specific scenarios are separated. Content relating to specific platforms (Juno and the FVPs are Arm-specific platforms, essentially) has been moved into the documentation that is specific to those platforms, under docs/plat/arm. Change-Id: Ica87c52d8cd4f577332be0b0738998ea3ba3bbec Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* DOC: Update ROMLIB page with memory impact infoLouis Mayencourt2019-11-181-0/+15
| | | | | | | | Complete the Library at ROM documentation with information regarding the memory impact of the feature. Change-Id: I5a10620a8e94f123021bb19523a36d558b330deb Signed-off-by: Louis Mayencourt <louis.mayencourt@arm.com>
* doc: Misc syntax and spelling fixesPaul Beesley2019-10-111-1/+1
| | | | | | | | | | Tidying up a few Sphinx warnings that had built-up over time. None of these are critical but it cleans up the Sphinx output. At the same time, fixing some spelling errors that were detected. Change-Id: I38209e235481eed287f8008c6de9dedd6b12ab2e Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* doc: Convert internal links to RST formatPaul Beesley2019-10-087-85/+65
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Currently links between documents are using the format: <path/to/><filename>.rst This was required for services like GitHub because they render each document in isolation - linking to another document is like linking to any other file, just provide the full path. However, with the new approach, the .rst files are only the raw source for the documents. Once the documents have been rendered the output is now in another format (HTML in our case) and so, when linking to another document, the link must point to the rendered version and not the .rst file. The RST spec provides a few methods for linking between content. The parent of this patch enabled the automatic creation of anchors for document titles - we will use these anchors as the targets for our links. Additional anchors can be added by hand if needed, on section and sub-section titles, for example. An example of this new format, for a document with the title "Firmware Design" is :ref:`Firmware Design`. One big advantage of this is that anchors are not dependent on paths. We can then move documents around, even between directories, without breaking any links between documents. Links will need to be updated only if the title of a document changes. Change-Id: I9e2340a61dd424cbd8fd1ecc2dc166f460d81703 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* Romlib makefile refactoring and script rewritingImre Kis2019-07-221-22/+28
| | | | | | | | | | | | | | | | The features of the previously existing gentbl, genvar and genwrappers scripts were reimplemented in the romlib_generator.py Python script. This resulted in more readable and maintainable code and the script introduces additional features that help dependency handling in makefiles. The assembly templates were separated from the script logic and were collected in the 'templates' directory. The targets and their dependencies were reorganized in the makefile and the dependency handling of included index files is possible now. Incremental build is available in case of modifying the index files. Signed-off-by: Imre Kis <imre.kis@arm.com> Change-Id: I79f65fab9dc5c70d1f6fc8f57b2a3009bf842dc5
* doc: Generate PlantUML diagrams automaticallyPaul Beesley2019-07-121-2/+2
| | | | | | | | | | | | | | | | | | | Currently we have some pre-rendered versions of certain diagrams in SVG format. These diagrams have corresponding PlantUML source that can be rendered automatically as part of the documentation build, removing the need for any intermediate files. This patch adds the Sphinx "plantuml" extension, replaces references to the pre-rendered SVG files within the documents, and finally removes the SVG files and helper script. New requirements for building the docs are the "sphinxcontrib-plantuml" Python module (added to the pip requirements.txt file) and the Graphviz package (provides the "dot" binary) which is in the Ubuntu package repositories. Change-Id: I24b52ee40ff79676212ed7cff350294945f1b50d Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* Remove references to old project name from common filesJohn Tsichritzis2019-07-101-2/+2
| | | | | | | | | | | | | The project has been renamed from "Arm Trusted Firmware (ATF)" to "Trusted Firmware-A (TF-A)" long ago. A few references to the old project name that still remained in various places have now been removed. This change doesn't affect any platform files. Any "ATF" references inside platform files, still remain. Change-Id: Id97895faa5b1845e851d4d50f5750de7a55bf99e Signed-off-by: John Tsichritzis <john.tsichritzis@arm.com>
* docs: removing references to GitHubJohn Tsichritzis2019-07-081-2/+2
| | | | | Change-Id: Ibdee91ad337ee362872924d93e82f5b5e47e63d9 Signed-off-by: John Tsichritzis <john.tsichritzis@arm.com>
* Further fixes to documentation linksJohn Tsichritzis2019-05-303-5/+5
| | | | | Change-Id: Ib021c721652d96f6c06ea18741f19a72bba1d00f Signed-off-by: John Tsichritzis <john.tsichritzis@arm.com>
* Fix documentation linksJohn Tsichritzis2019-05-281-1/+2
| | | | | Change-Id: Ic09e74f22b43fba51ee17cd02b5e1dc5d8e0bb63 Signed-off-by: John Tsichritzis <john.tsichritzis@arm.com>
* doc: Use proper note and warning annotationsPaul Beesley2019-05-221-2/+2
| | | | | | | | | The documentation contains plenty of notes and warnings. Enable special rendering of these blocks by converting the note prefix into a .. note:: annotation. Change-Id: I34e26ca6bf313d335672ab6c2645741900338822 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* doc: Reorganise images and update linksPaul Beesley2019-05-227-11/+11
| | | | | Change-Id: I679d1499376a524bef1cfc33df995b0a719b5ac8 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* doc: Set correct syntax highlighting stylePaul Beesley2019-05-223-3/+3
| | | | | | | | | | | | Several code blocks do not specify a language for syntax highlighting. This results in Sphinx using a default highlighter which is Python. This patch adds the correct language to each code block that doesn't already specify it. Change-Id: Icce1949aabfdc11a334a42d49edf55fa673cddc3 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* doc: Add minimal glossaryPaul Beesley2019-05-221-12/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | One of the current issues with the documentation is that terms and abbreviations are frequently redefined. For example, we might have a sentence like "... the SCP (System Control Processor) will ...". These definitions might be repeated several times across pages, or even within the same document. Equally, some of these abbreviations are missed and are never expanded. Sphinx provides a :term: keyword that takes some text and, if that text is defined in a glossary document, links to its glossary entry. Using this functionality will prevent repeated definitions and will make the docs more maintainable by using a single definition source. The glossary added in this patch was created from a quick scrub of the source code - there may be missing entries. The SDEI abbreviation was used as an example. Note that a global_substitutions file was created. This file contains the RST 'replace' statements that convert plain text terms into linked terms (by adding the ':term:' keyword to them). An example is: .. |TF-A| replace:: :term:`TF-A` The 'rst_prolog' variable in conf.py is used to inject this list of replacements into each page. Terms must be surrounded with the pipe character to be turned into links - this means that we can still prevent certain terms from being linked if we don't want them to be. Change-Id: I87010ed9cfa4a60011a9b4a431b98cb4bb7baa28 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* doc: Remove per-page contents listsPaul Beesley2019-05-228-22/+0
| | | | | | | | | | | | | These are no longer needed as there will always be a table of contents rendered to the left of every page. Some of these lists can be quite long and, when opening a page, the reader sees nothing but a huge list of contents! After this patch, the document contents are front-and-centre and the contents are nicely rendered in the sidebar without duplication. Change-Id: I444754d548ec91d00f2b04e861de8dde8856aa62 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* doc: Normalise section numbering and headingsPaul Beesley2019-05-224-11/+7
| | | | | | | | | Required work to make all documents sit at the correct levels within the document tree and any derived content like the table of contents and the categories in the sidebar. Change-Id: I4885fbe30864a87c8822ee67482b71fb46a8fbc6 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* doc: Reword document titlesPaul Beesley2019-05-227-29/+13
| | | | | | | | | | | This patch attempts to standardise the document titles as well as adding titles to documents that were missing one. The aim is to remove needless references to "TF-A" or "Trusted Firmware" in the title of every document and to make sure that the title matches with the document content. Change-Id: I9b93ccf43b5d57e8dc793a5311b8ed7c4dd245cc Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* doc: Move documents into subdirectoriesPaul Beesley2019-05-2114-0/+3620
This change creates the following directories under docs/ in order to provide a grouping for the content: - components - design - getting_started - perf - process In each of these directories an index.rst file is created and this serves as an index / landing page for each of the groups when the pages are compiled. Proper layout of the top-level table of contents relies on this directory/index structure. Without this patch it is possible to build the documents correctly with Sphinx but the output looks messy because there is no overall hierarchy. Change-Id: I3c9f4443ec98571a56a6edf775f2c8d74d7f429f Signed-off-by: Paul Beesley <paul.beesley@arm.com>
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-16 00:50:59 +0000