summaryrefslogtreecommitdiff
path: root/readme.rst
AgeCommit message (Collapse)Author
2019-10-09doc: Formatting fixes for readme.rstPaul Beesley
The readme.rst file in the project root is the front-page that is displayed on Github and if viewing the TF-A repository on git.trustedfirmware.org in the "about" view. It now contains a small amount of stub content, and directs readers to the ReadTheDocs documentation via trustedfirmware.org/docs/tf-a. The Github renderer is displaying the content fine but the cgit viewer displays some "backlink" errors because some content substitutions were left in place (terms surrounded by pipe symbols), e.g. |TF-A|. This patch removes those substitutions, that are not supported by cgit, and also updates one heading to clarify where to find the new docs. Change-Id: I358451df45b8c99975ba0b6db8ea61253a10560d Signed-off-by: Paul Beesley <paul.beesley@arm.com>
2019-10-08doc: De-duplicate readme and license filesPaul Beesley
The readme.rst and license.rst files in the project root overlap with the index.rst and license.rst files in the docs/ folder. We need to use the latter when building the documentation, as Sphinx requires all included files to be under a common root. However, the files in the root are currently used by the cgit and Github viewers. Using symlinks in Git presents some difficulties so the best course of action is likely to leave these files but in stub form. The license.rst file in the root will simply tell the reader to refer to docs/license.rst. The readme.rst file will contain a small amount of content that is derived from the docs/index.rst file, so that the Github main page will have something valid to show, but it will also contain a link to the full documentation on ReadTheDocs. Change-Id: I6dc46f08777e8d7ecb32ca7afc07a28486c9f77a Signed-off-by: Paul Beesley <paul.beesley@arm.com>
2019-09-13Refactor ARMv8.3 Pointer Authentication support codeAlexei Fedorov
This patch provides the following features and makes modifications listed below: - Individual APIAKey key generation for each CPU. - New key generation on every BL31 warm boot and TSP CPU On event. - Per-CPU storage of APIAKey added in percpu_data[] of cpu_data structure. - `plat_init_apiakey()` function replaced with `plat_init_apkey()` which returns 128-bit value and uses Generic timer physical counter value to increase the randomness of the generated key. The new function can be used for generation of all ARMv8.3-PAuth keys - ARMv8.3-PAuth specific code placed in `lib\extensions\pauth`. - New `pauth_init_enable_el1()` and `pauth_init_enable_el3()` functions generate, program and enable APIAKey_EL1 for EL1 and EL3 respectively; pauth_disable_el1()` and `pauth_disable_el3()` functions disable PAuth for EL1 and EL3 respectively; `pauth_load_bl31_apiakey()` loads saved per-CPU APIAKey_EL1 from cpu-data structure. - Combined `save_gp_pauth_registers()` function replaces calls to `save_gp_registers()` and `pauth_context_save()`; `restore_gp_pauth_registers()` replaces `pauth_context_restore()` and `restore_gp_registers()` calls. - `restore_gp_registers_eret()` function removed with corresponding code placed in `el3_exit()`. - Fixed the issue when `pauth_t pauth_ctx` structure allocated space for 12 uint64_t PAuth registers instead of 10 by removal of macro CTX_PACGAKEY_END from `include/lib/el3_runtime/aarch64/context.h` and assigning its value to CTX_PAUTH_REGS_END. - Use of MODE_SP_ELX and MODE_SP_EL0 macro definitions in `msr spsel` instruction instead of hard-coded values. - Changes in documentation related to ARMv8.3-PAuth and ARMv8.5-BTI. Change-Id: Id18b81cc46f52a783a7e6a09b9f149b6ce803211 Signed-off-by: Alexei Fedorov <Alexei.Fedorov@arm.com>
2019-07-10Rename Cortex-Deimos to Cortex-A77Balint Dobszay
Change-Id: I755e4c42242d9a052570fd1132ca3d937acadb13 Signed-off-by: Balint Dobszay <balint.dobszay@arm.com>
2019-06-08Update Allwinner SoC names in documentationSamuel Holland
Provide the friendly marketing names, not just the platform name. Signed-off-by: Samuel Holland <samuel@sholland.org> Change-Id: Id4427abb73d0c1be4ac1709b2a8e87beffc20dd5
2019-06-03Add information about the mailing list in the docsJohn Tsichritzis
Change-Id: I41ce5323c33a81db13c5cc40de1ac4e221a10cd8 Signed-off-by: John Tsichritzis <john.tsichritzis@arm.com>
2019-05-31Removing IRC related info from the documentationJohn Tsichritzis
Change-Id: I5cf8c70a304bf5869cbeb12fa8d39171cff48ebd Signed-off-by: John Tsichritzis <john.tsichritzis@arm.com>
2019-05-28Fix documentation linksJohn Tsichritzis
Change-Id: Ic09e74f22b43fba51ee17cd02b5e1dc5d8e0bb63 Signed-off-by: John Tsichritzis <john.tsichritzis@arm.com>
2019-05-24Docs fixesJohn Tsichritzis
1) Fix links in "about" page 2) Put back the "contents" page with adjusted links Change-Id: Id09140b91df5cf0a275149801d05d8cfeeda1c6e Signed-off-by: John Tsichritzis <john.tsichritzis@arm.com>
2019-05-20Update docs for FVP v11.6John Tsichritzis
Change-Id: I33c1bf49aa10867e1a2ca4c167112b99bf756dda Signed-off-by: John Tsichritzis <john.tsichritzis@arm.com>
2019-04-25Doc: Update link to TBBR-CLIENT specificationSandrine Bailleux
Change-Id: Iafa79b6f7891d3eebec9908a8f7725131202beb3 Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
2019-04-12Improvements in ReadmeJohn Tsichritzis
- Fix broken link to the issue tracker. - Add contents section to make navigation easier throughout the page. - Move the link to documentation contents near the top. Where it was before could be missed and documentation might seem inaccessible. Change-Id: I502e4fc0fd312459cda351d30a8781c221625724 Signed-off-by: John Tsichritzis <john.tsichritzis@arm.com>
2019-04-08Add support for Cortex-A76AE CPUAlexei Fedorov
Change-Id: I0a81f4ea94d41245cd5150de341b51fc70babffe Signed-off-by: Alexei Fedorov <Alexei.Fedorov@arm.com>
2019-04-03Merge pull request #1918 from lmayencourt/lm/contrib_guidelinesAntonio Niño Díaz
doc: Update contribution guidelines
2019-04-02doc: Update contribution guidelinesLouis Mayencourt
Update the documentation for trustedfirmware.org migration Change-Id: Ibb7052b0becbec3326164f1503806ca2c2fd4dcc Signed-off-by: Louis Mayencourt <louis.mayencourt@arm.com>
2019-04-02plat: gxl: Add documentation on building GXL imageRemi Pommarel
Also adds a maintainer for GXL. Signed-off-by: Remi Pommarel <repk@triplefau.lt>
2019-03-29doc: Clarify draft status of SPCI and SPRT specsPaul Beesley
These SPM-related specifications are mentioned in the readme and the change log. Update references to these specs to make it clear that they are in draft form and are expected to change. Change-Id: Ia2791c48c371a828246d96f102a402747cd69f96 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
2019-03-28Documentation: update tested platformsAmbroise Vincent
Update both the readme and user guide on their shared "platform" section. Change-Id: Ia1f30acda45ac8facdcb7d540800191cdf6cdacf Signed-off-by: Ambroise Vincent <ambroise.vincent@arm.com>
2019-03-27doc: Update readme.rst for v2.1 releasePaul Beesley
Change-Id: Id3ae11a401a2e5290bb1980f1f349fc3cf49c7d6 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
2019-03-12doc: Minor formatting enhancementSandrine Bailleux
The security advisories would all appear on a single line. Use bullet points instead to improve the readability. Change-Id: Id631985d7d559b3632f43d695cffa6735520b64a Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
2019-03-12doc: Fix a broken link in the readme.rst fileSandrine Bailleux
Change-Id: I53a4649b17614f711957424ddffed1dcccfc7880 Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
2019-03-07doc: Update links within imported wiki contentJoel Hutton
This patch covers two changes: - Links that refer to GitHub are updated to point to the relevant content on trustedfirmware.org - Internal links between documents have been updated, with the required .rst suffix being added or due to a change in the relative locations of the files. Change-Id: Ibf87da7d2ece726d1c94a9b33a2bbc3129de7779 Signed-off-by: Joel Hutton <Joel.Hutton@Arm.com> Signed-off-by: Paul Beesley <paul.beesley@arm.com>
2019-02-27board/rde1edge: rename sgiclarkh to rde1edgeChandni Cherukuri
Replace all usage of 'sgiclark' with 'rdn1e1edge' and 'sgiclarkh' with 'rde1edge' as per the updated product names. Change-Id: I14e9b0332851798531de21d70eb54f1e5557a7bd Signed-off-by: Chandni Cherukuri <chandni.cherukuri@arm.com>
2019-02-27board/rdn1edge: rename sgiclarka to rdn1edgeChandni Cherukuri
Replace all usage of 'sgiclark' with 'rdn1e1edge' and 'sgiclarka' with 'rdn1edge' as per the updated product names. Change-Id: Idbc157c73477ec32f507ba2d4a4e907d8813374c Signed-off-by: Chandni Cherukuri <chandni.cherukuri@arm.com>
2019-02-19Rename Cortex-Ares to Neoverse N1John Tsichritzis
Change-Id: Ideb49011da35f39ff1959be6f5015fa212ca2b6b Signed-off-by: John Tsichritzis <john.tsichritzis@arm.com>
2019-01-17readme: Update list of supported platformsAntonio Nino Diaz
Change-Id: I13b7b16a13f51bcb83098d7c55701f9ee03859a8 Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com>
2019-01-11doc: Minor readme structure improvementsPaul Beesley
Improves wording and sentence structure of the readme, including: - Using "TF-A" in place of "the TF-A" in a couple of places - "Support for X" in place of "Support X" - Explicitly naming the Secure Payload Dispatcher when introducing the SPD acronym. Change-Id: I4e7b7e7dc6748f631d07c02d97adcca10ae60ea4 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
2019-01-11doc: Fix NVIDIA name case in readme.rstPaul Beesley
Change-Id: I7e0ba692277c1c120c86d47ab966dcd11682428a Signed-off-by: Paul Beesley <paul.beesley@arm.com>
2019-01-11doc: Add SCMI abbreviation to readmePaul Beesley
Currently the examples of Arm interface standards all include abbreviationsof the full names, except for SCMI. Change-Id: I8417ada780d51ecf93426aa5d265c507c7dac08c Signed-off-by: Paul Beesley <paul.beesley@arm.com>
2018-10-26docs: gxbb: Add documentationAntonio Nino Diaz
Change-Id: Ie2465c1ccc482bd8eb5e5a71c580543095e4ba94 Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com>
2018-10-02Release docs updates for v2.0 releaseJoanna Farley
Change-Id: Iaa5c586b65f0abdd4ddbdee4c73d07811a0aff49 Signed-off-by: Joanna Farley <joanna.farley@arm.com>
2018-09-21Readme and Change-log updates for v1.6 releaseJoanna Farley
Change-Id: I7855c9d3de104975bf3249bdf291c428f001d07a Signed-off-by: Joanna Farley <joanna.farley@arm.com>
2018-08-22libc: Introduce files from SCCAntonio Nino Diaz
Taken from http://git.simple-cc.org/scc/ from the following commit: 67508ad14af314cea2229783d3c084f28c41daf0 Permission has been granted from the author to use them under the license BSD-3-Clause instead of ISC. Change-Id: I65c0ce3ab60c49d34a57533af12a74bd7bde88e5 Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com>
2018-08-13Merge pull request #1502 from dp-arm/dp/ircDimitris Papastamos
readme: Add information about the TF-A IRC channel
2018-07-31Update license information in readme.rstDan Handley
Added information on how disjunctively dual licensed code from other projects is treated in the TF-A project. Change-Id: Idca329abba4d36bd3c4fd722ac1556940b9135a2 Signed-off-by: Dan Handley <dan.handley@arm.com>
2018-07-30readme: Add information about the TF-A IRC channelDimitris Papastamos
Fixes ARM-software/tf-issues#607 Change-Id: I5637f53e7f4857c85ee8b3af06ebcf86b9e4f1bc Signed-off-by: Dimitris Papastamos <dimitris.papastamos@arm.com>
2018-06-21synquacer: Add platform makefile and documentationSumit Garg
Add Makefile and plaform definations file. My thanks to Daniel Thompson and Ard Biesheuvel for the bits and pieces I've taken from their earlier work regarding build and deploy steps for Developerbox based on Synquacer SoCs. They deserve much of the credit for this work although, since I assembled and tested things, any blame is probably mine. Signed-off-by: Sumit Garg <sumit.garg@linaro.org> Tested-by: Daniel Thompson <daniel.thompson@linaro.org> Tested-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
2018-06-19ti: k3: Setup initial files for platformNishanth Menon
Create the baseline Makefile, platform definitions file and platform specific assembly macros file. This includes first set of constants for the platform including cache sizes and linker format and a stub for BL31 and the basic memory layout K3 SoC family of processors do not use require a BL1 or BL2 binary, since such functions are provided by an system controller on the SoC. This lowers the burden of ATF to purely managing the local ARM cores themselves. Signed-off-by: Benjamin Fair <b-fair@ti.com> Signed-off-by: Nishanth Menon <nm@ti.com> Signed-off-by: Andrew F. Davis <afd@ti.com>
2018-03-20Fix SDEI link in readme.rstdanh-arm
2018-03-19Update readme.rst for v1.5 releaseDan Handley
Change-Id: Id9bd0c20a5af4f41269a51a675018dcc59e93f6c Signed-off-by: Dan Handley <dan.handley@arm.com>
2018-03-15Update Arm TF references to TF-ADan Handley
Update Arm Trusted Firmware references in the upstream documents to Trusted Firmware-A (TF-A). This is for consistency with and disambiguation from Trusted Firmware-M (TF-M). Also update other Arm trademarks, e.g. ARM->Arm, ARMv8->Armv8-A. Change-Id: I8bb0e18af29c6744eeea2dc6c08f2c10b20ede22 Signed-off-by: Dan Handley <dan.handley@arm.com> Signed-off-by: David Cunado <david.cunado@arm.com>
2017-07-17Clarify third party license info in readmeDan Handley
Clarify the license information for imported third party code in the readme.rst file. Change-Id: I96e26fda687a290a6dffb475aca20b169d85784d Signed-off-by: Dan Handley <dan.handley@arm.com>
2017-07-05Update readme for v1.4 releaseDan Handley
Update the release notes (readme.rst) for the ARM Trusted Firmware v1.4 release. Also, reorder and fix some of the links following the conversion to reStructured text format. Change-Id: I8f5e8aa86cb891f61b6b62cf9fab0ad0f0ebb36b Signed-off-by: Dan Handley <dan.handley@arm.com>
2017-06-29Convert documentation to reStructuredTextDouglas Raillard
Due to recent issues in the rendering of the documentation on GitHub and some long-standing issues like the lack of automatic table of content in Markdown, the documentation has been converted to reStructuredText. Basic constructs looks pretty similar to Markdown. Automatically convert GitHub markdown documentation to reStructuredText using pandoc. Change-Id: If20b695acedc6d1b49c8d9fb64efd6b6ba23f4a9 Signed-off-by: Douglas Raillard <douglas.raillard@arm.com>
generated by cgit v1.2.3 (git 2.0.4) at 2024-05-12 06:33:54 +0000