aboutsummaryrefslogtreecommitdiff
path: root/docs/getting_started
AgeCommit message (Collapse)Author
2024-01-11Docs: Fixes building instructionsMatthew Dalzell
Fixes the building instructions for AN521 regression sample tests. Signed-off-by: Matthew Dalzell <matthew.dalzell@arm.com> Change-Id: I185760ea83c48912de0f4e7b39b290ea20e6cc89
2023-11-21Docs: Improve the documents for split buildKevin Peng
Change-Id: I28831840a460a7d77e99690a9041911bcb2fc3be Signed-off-by: Kevin Peng <kevin.peng@arm.com>
2023-11-14Docs: Emphasize Windows Path syntax for CMAKEKen Liu
Use "/" instead of "\" when assigning CMAKE path variables. Signed-off-by: Ken Liu <Ken.Liu@arm.com> Change-Id: I2c186865c2404bcc45bd59ba90a21a6f993586fc
2023-08-29Build: Add stub functions of system callschesun01
GNU Arm compiler version greater equal than *11.3.Rel1* has a linker issue that required system calls are missing, such as _read and _write. Add stub functions of required system calls to solve this issue. Signed-off-by: Chendi Sun <chendi.sun@arm.com> Change-Id: I1384a405174097639e4c7bb71f19d01a66318a2d
2023-08-01Docs: Add optional configurations for running fast modelJason Guo
Change-Id: Ie0c38abadeb1fd887f8d96cead00bf2fd31983a1 Signed-off-by: Jason Guo <jason.guo@arm.com>
2023-04-07Build: Add GNU Arm compiler version checkSummer Qin
GNU Arm compiler version greater equal than *11.3.Rel1* has a linker issue in syscall. Select other GNU Arm compiler versions instead. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I55e7aab2b0f1da043145b9a4d8914c9b685f287e
2022-12-12Bump minimum clang version to 6.13Chris Brand
Clang 6.12 in Debug mode can cause a stack overflow on PSoC platform. Rather than increasing the stack size, bump the minimum clang version. Change-Id: I0689a759495c1a8428d7a140277588836c7fdeae Signed-off-by: Chris Brand <chris.brand@cypress.com>
2022-11-30Build: Refine Kconfig system and docJianliang Shen
Kconfig choice supports 'optional' key word to allow the whole choice to be toggled off to select none of the symbols. It is necessary to abort the kconfig tool when platform path doesn't exist. Add usages of Kconfig tool in the documents. Signed-off-by: Jianliang Shen <jianliang.shen@arm.com> Change-Id: I6c38b0bde6a5a6d099d8ea606be5e9b359216efa
2022-07-04Docs: Rearrange TF-M building instructionsAnton Komlev
- move the building instructios to a dedicated folder, reflecting main TOC - adjust links in the documentation Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I335de95061938d619a47cd813020121809e1459b
2022-06-21Docs: Fix an error in Windows commandAnton Komlev
Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: Id2089de7e819c7dcc49e8c596f352e3bdd7e5490
2022-05-18Docs: Update Armclang version warningDavid Hu
Update the warning of Armclang version 6.15~6.17. Change-Id: I595939d770cb64560da4dd3341a89ce709bc4293 Signed-off-by: David Hu <david.hu@arm.com>
2022-04-23docs: Documentation restructureTF-Mv1.6.0-RC4Anton Komlev
- Change main index structure - Sort out integration and porting guidelines - Resort table with releases - Add Tools section. To be adjusted further for tf-m-tools Intention to minimise files movement to simplify review process. Affected files shall be moved later after the new structure agreement. Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I0352bebabe09d4f7b5e8848ee620c0cea6881c94
2022-04-23docs: Decouple refrences from /docs folderAnton Komlev
Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I1955201382074eb9e6dd80aadbc456eb09aecb22
2022-02-17docs: Guidance to minimise long build pathsAnton Komlev
- and small text alignment with the occasion Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I2c4e744f56ced5289f90468b6bd23f55abc18b88
2022-01-17Docs: Fix Armclang toolchain descriptionsDavid Hu
- Fix Armclang PATH setting - Specify valid Armclang versions. It is found Armclang v6.15 and v6.16 may also cause MemManage Fault as v6.17 does. Change-Id: Id5a591a8d165c78adf5fd9346c962662f151d496 Signed-off-by: David Hu <david.hu@arm.com>
2021-12-06Docs: Remove unncecessary section numberingAnton Komlev
Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I77282dbbf719bc86751cc7538dee55b12e5ac4d5
2021-12-01build: Disable ArmClang > v6.17.0Anton Komlev
Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I2528b39fa4bf2acdc0246cb71b56e95549aeab78
2021-11-11Tools: port iat-verifier to cbor2Ross Burton
The cbor module is unmaintained, with the last release in 2016[1]. The cbor2 module however is under active development and was last released just last month[2]. [1] https://pypi.org/project/cbor/#history [2] https://pypi.org/project/cbor2/#history Signed-off-by: Ross Burton <ross.burton@arm.com> Change-Id: Ib24a88f19dea05fb9143afaa4bdf7ebdd5a2dda6
2021-10-25docs: Clarify documentation for binaries and docs buildsAnton Komlev
Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I0a412426c40717e086c9bc4330cbb27a4cc810ad
2021-07-13Docs: Add requirement of librsvg2-bin for doc generationDavid Hu
Require tool librsvg2-bin in docs for user guide generation. librsvg2-bin shall be installed to support sphinxcontrib-svg2pdfconverter. Otherwise, user guide build will throw out warnings that RSVG converter command 'rsvg-convert' cannot be run. Change-Id: Ic988b2771c0c5317b130bb37696c1c2833c162f7 Signed-off-by: David Hu <david.hu@arm.com>
2021-07-13Docs: Fix Sphinx version in getting startedDavid Hu
Update Sphinx version to 2.0.1 to align with that in requirements.txt. Change-Id: I3420e823426d4c7cbb83271ddf0a1a974f7ae9f1 Signed-off-by: David Hu <david.hu@arm.com>
2021-06-23Docs: Refine tfm_sw_requirement.rstSummer Qin
Simplify the tfm software requirement document and change the document to 'tfm_getting_started.rst', let it more suitable for new starter. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I10379aa92ac2c6cd784f0fd1b1b5431243716d74
2021-06-22Docs: Fix the broken links in the documentationDavid Wang
Sphinx uses "autosectionlable" extension for generating the section labels automatically. The max depth is set to 2 for level 2 headers only. That section which is under level 2 will not have the reference label. This caused the broken links in the documentation. This patch creates lables for the section which is under level 2 and referenced by other places in the documentation. Signed-off-by: David Wang <david.wang@arm.com> Change-Id: I636922c624108e850635e683719f5ac035e0880b
2021-06-17Docs: Enable Sphinx tabs extensionSummer Qin
Enable the Sphinx tabs extension and fix the 'sphinx-trd-theme' typo. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I18568465804f93e6cd2b71e344a673580cec993b
2021-06-17Docs: Move build instruction and user guide into technical referenceSummer Qin
Move build instruction document and user guide document from getting started into technical references folder. Rename 'tfm_user_guide.rst' to 'tfm_run_instruction.rst'. This will make the document structure more clear for readers. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I69d46151f2cb97c828c1b82775ffd1af9032ed45
2021-06-11Docs: Move tools documents to technical references folderSummer Qin
Move tools documents from getting started to technical references folder. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I8ed8e2fe5c3a9de4afa5ceeb04fbea38562b2f6c
2021-06-04Platform: Add arm folder for arm platformsSummer Qin
Put arm platforms into arm folder and remove some unused cryptocell-312-runtime. It will be convenient for users and developers. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I1187a8f2b18903e531ce28b2d23be251ec1e2b45
2021-04-30docs: update build and sw requirement docsSubhasish Ghosh
Updated build and software requirements documentation 1. Simplified Linux and Windows build environment setup 2. Updated tools version dependencies 3. Removed some docs compilation warnings Signed-off-by: Subhasish Ghosh <subhasish.ghosh@arm.com> Change-Id: Ia0655e509d4a6424068b6113cc8a80f4b93fe8bd
2021-04-29docs: avoid indicating default toolchain (GNU ARM) in sample commandsLeonardo Sandoval
By default the project picks 'toolchain_GNUARM.cmake' as toolchain value through the 'TFM_TOOLCHAIN_FILE' build variable so there is no need to explicitly indicate it in every command, resulting in shorter and clearer build commands. Signed-off-by: Leonardo Sandoval <leonardo.sandoval@linaro.org> Change-Id: Idc7dffdefc441ba6b5a94086dda39d8f8414134a
2021-04-29docs: simplify 'cd'ing into TF-M folderLeonardo Sandoval
Currently docs use two 'cd' commands to move to the TF-M folder (1. move to base folder 2. move to TF-M folder). This patch simplifies to a single 'cd' command, moving directly to TF-M base folder. Signed-off-by: Leonardo Sandoval <leonardo.sandoval@linaro.org> Change-Id: I8d67b73d749962672aca4b351ae5b18efb38283e
2021-04-28Docs: Update description for Sphinx SVG pluginSummer Qin
Correct the description which is copied from plantuml, and update the missing information. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: Iaeecc0f481db1ef94e3a35920865e3dca467feda
2021-04-21Docs: Restructure the documentsSummer Qin
Restructure the file category to let it more friendly to users. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I7ced0e2d700ce03423e472e0098608f3445ba169
2021-04-19Platform: Remove Musca_A platform code (Deprecation)Minos Galanakis
This patch removes Musca A board from platform code-base and documentation. Signed-off-by: Minos Galanakis <minos.galanakis@arm.com> Change-Id: I8479a18faa769e112792830c9e64127e72843aaa
2021-04-12Docs: Deprecate 'build_docs' folderShawn Shan
With the prefix 'build', user may delete 'build_docs' accidentally. Deprecate 'build_docs' folder and move the only files 'conf.py' to 'docs' folder. Change-Id: I701e279861afdc9b0f6cfd10b343643acd77e51d Signed-off-by: Shawn Shan <Shawn.Shan@arm.com>
2021-03-22Docs: Add a note to avoid using GNU Arm 10-2020-q4-majorDavid Hu
Add a note to avoid using GNU Arm compiler version 10-2020-q4-major. It has a bug in CMSE support, which will break CMSE functinalities. Change-Id: If1cbc6582f2b36ed990dc737eaa67b2ef2f888e8 Signed-off-by: David Hu <david.hu@arm.com>
2021-03-19Docs: Add firmware update partition design documentSherry Zhang
Change-Id: Ia7e46eadb4c1e2a50d6641af6ed520b0c5123eca Signed-off-by: Sherry Zhang <sherry.zhang2@arm.com>
2021-03-17Platform: Add mps3/an547 platformGabor Toth
Add support for AN547, an MPS3 FPGA platform based on Corstone SSE-300 with Ethos-U55, and unify it with the already existing support of Corstone-300 Ethos-U55 Ecosystem FVP. Change-Id: I9cbb0167e61244214a8eeb5a55165c296af03ef7 Signed-off-by: Gabor Toth <gabor.toth@arm.com>
2021-03-11Platform: Remove sse200-aws platform code (Deprecation)Minos Galanakis
This patch removes the platform's code-base and documentation. Signed-off-by: Minos Galanakis <minos.galanakis@arm.com> Change-Id: Ib0f668800dd3571f0f7c10dc3954d1d62a420fb3
2021-03-11Revert "Platform: Remove Musca_A platform code (Deprecation)"Anton Komlev
This reverts commit a29d6695749aedb4015320af18e782b85744600a. Reason for revert: Musca-A is still a reference platform for 1 user. Change-Id: I3a96d5157677390360aaa82eac96b9810db58c43
2021-03-11Platform: Remove Musca_A platform code (Deprecation)Minos Galanakis
This patch removes Musca A board from platform code-base and documentation. Signed-off-by: Minos Galanakis <minos.galanakis@arm.com> Change-Id: I613eac2b478655b6b6f8195339b2502f1c5a79b9
2021-03-11AN539 : Remove AN539 from code-baseHugo L'Hostis
This patch removes mps2/an539 from the code-base and the documentation. Signed-off-by: Hugo L'Hostis <hugo.lhostis@arm.com> Change-Id: I191e04bf51c729056efd2adee0c3db72ae6eb23c
2021-03-08Docs: Update supported Arm Complier versionsMark Horvath
Instead of explicitly set all supported versions the minimum version is defined from now. Change-Id: I27371df627c0ae69d08510276e2447cd60169d2d Signed-off-by: Mark Horvath <mark.horvath@arm.com>
2021-01-30Build: Support passing absolute paths to TFM_PLATFORMØyvind Rønningstad
For convenience when using out-of-tree platforms. Change-Id: I6783eabe9e13c0bdc2412cebd1ff25277cd5dda0 Signed-off-by: Øyvind Rønningstad <oyvind.ronningstad@nordicsemi.no>
2021-01-14Build: Fetch tf-m-tests repo with fixed versionKevin Peng
The build system currently fetches the latest tf-m-tests repo always. The build would be broken if there was a dependency change between TF-M repo and test repo and developer was working on a older TF-M commit. This patch changes the version of tf-m-tests to be fetched to specific commits. With this patch, the build system will download a fixed workable version of tf-m-tests. Documentation on how the version will be updated is also added. Change-Id: Ia6fbf824f1cc3e3509aebe3ad71b04291a81c8a2 Signed-off-by: Kevin Peng <kevin.peng@arm.com>
2021-01-08Build: Rename install export dir to interfaceRaef Coles
To make it more clear that it contains the ns interface sources, headers and static libraries, and to allow more clear installation of other components. Change-Id: Id02bd472270b55245ea804437bd21d1dca24b7d8 Signed-off-by: Raef Coles <raef.coles@arm.com>
2021-01-08Build: Allow alteration of cmake install pathRaef Coles
Change-Id: I4e519d59448b74679a7d1bfa2171ffa024263944 Signed-off-by: Raef Coles <raef.coles@arm.com>
2020-12-15Docs: Correct to PSA_ARCH_TESTS_PATHRaef Coles
Previously read PSA_ARCH_TEST_PATH in the build instructions Change-Id: I429ca178d1aae7c1432910fb00075909d1a11042 Signed-off-by: Raef Coles <raef.coles@arm.com>
2020-12-10Build: Restructure Musca-B1 foldersGabor Abonyi
Original musca_b1 platform is renamed to musca_b1/sse_200, and musca_b1_secure_enclave is renamed to musca_b1/secure_enclave. Change-Id: If05f1878cff3808ec95e207abe4a0a433998523c Signed-off-by: Gabor Abonyi <gabor.abonyi@arm.com> Signed-off-by: Mark Horvath <mark.horvath@arm.com>
2020-12-10Platform: Add MUSCA_B1_SECURE_ENCLAVE platformMark Horvath
Change-Id: Iffbfe782222332fa0b94fc26c2eb9832d487f63e Signed-off-by: Gabor Abonyi <gabor.abonyi@arm.com> Signed-off-by: Mark Horvath <mark.horvath@arm.com>
2020-11-26Docs: Fix the description of MCUboot logging configTamas Ban
Signed-off-by: Tamas Ban <tamas.ban@arm.com> Change-Id: I8f318d9b6dd175238df9699c4bf383487324cf6b