path: root/docs
AgeCommit message (Collapse)Author
13 hoursBuild: Disable ECDH crypto test for profile smallHEADmasterAntonio de Angelis
This patch disables the ECDH test in the Crypto regression for profile small which does not support the feature. The documentation is updated accordingly in relevant places. Signed-off-by: Antonio de Angelis <antonio.deangelis@arm.com> Change-Id: I3781c473864d90ac26584b357c2903f750ed5190
7 daysDocs: Add link for TFMV-3 in security handlingSummer Qin
Add reference link for TFMV-3 in security handling document. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: Iebd281d6dcfe3b07caeb92326058f1637a033f20
13 daysCrypto: Use NV SEED as default entropy sourceSummer Qin
MBEDTLS_TEST_NULL_ENTROPY is removed from mbedtls 3.0.0. Change to use 'MBEDTLS_ENTROPY_NV_SEED' as the default entropy source if a platform doesn't generate entropy from hardware. Change-Id: If03c9dec3c6fb0d7bb98721963ac2142d43ed00d Signed-off-by: Summer Qin <summer.qin@arm.com>
14 daysDocs: Turn warnings into errors in html generationSummer Qin
Turn warnings into errors in html generation, it helps to maintain documentation. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I669f6f79d0917ff9e4ab70ab4420ad8763cc167b
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: Move design documents into a dedicated folderDavid Hu
Collect all the design documents under a dedicated design_docs folder. Update the links in other documents. Change-Id: I2da761a11317144185e960c539f2245d3d46fd2a 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-07-13Docs: Fix doc links in porting_TFM_to_a_new_hardware.rstDavid Hu
Change-Id: Iec42e7f37b07ac9b9089351d3f6108ab05011049 Signed-off-by: David Hu <david.hu@arm.com>
2021-07-07Tools: Deprecate the attribute 'tfm_partition_ipc'Shawn Shan
'tfm_partition_ipc' was introduced to distinguish if partitions support library model only. The FF-M v1.1 introduces a new SFN Model which is an alternative of IPC Model. This attribute becomes confusing to indicate the models. Made some changes to remove the attribute 'tfm_partition_ipc'. Change-Id: Ifba5778caf87bb716993db3dc19986bbde3653c3 Signed-off-by: Shawn Shan <Shawn.Shan@arm.com>
2021-06-30Test: Add the FLIH test PartitionKevin Peng
Currently the FLIH test is only supported on AN519 and AN521 Change-Id: Ic34aee26d4db732bdf9fb72c9163dd164b1e688e Signed-off-by: Kevin Peng <kevin.peng@arm.com>
2021-06-30DOCS: adding the new platform porting guideRobert Wakim
This guide should help new platform owner to add they platform in the TF-M repo. Signed-off-by: Robert Wakim <robert.wakim@arm.com> Change-Id: I041064bb6879e131b6586123560e90962b07281d
2021-06-30SPM: Remove the IRQ priority in manifestKevin Peng
TF-M added a tfm_irq_priority attribute in the Partition manifest for SPM to set IRQ priorities so that IRQ can work correctly - TF-M requires external interrupt priorities must be higher than that of PendSV. However, a universal IRQ priority might not work on all platforms because different platforms have different number of configurable interrupt priorities. So the same value represents different priorities on different platforms. Besides, the attribute is not defined by FF-M. This patch removes the IRQ priority in manifest and in the HAL API as well so that platforms have the most flexibility to set priorities for IRQs based on their own cases. Note: the external interrupt priorities must be higher than PendSV. Change-Id: Id9e544a9afffcc7d019177cf29e51f32d1600504 Signed-off-by: Kevin Peng <kevin.peng@arm.com>
2021-06-28Docs: Specify tools versionSummer Qin
To have the better generated documentation format, sphinx should be 2.0.1 and docutils should be 0.16. Package librsvg2-bin is needed by sphinxcontrib-svg2pdfconverter. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: Id001bf742378d6675ae3f5a73a6035824c8e4b2d
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-23Docs: Refine tfm_run_instruction.rst nameSummer Qin
Rename 'tfm_run_instruction.rst' to 'run_tfm_examples_on_arm_platforms.rst' to reflect the content better. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I0ae23907ab05fe08ba191bb123507d53a7af48e1
2021-06-23Docs: Abstract documentation generation into a new fileSummer Qin
Abstract the introduction of documentation generation into a new file. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I0a47e21b426dbb53e8165d08c81e9174958cf6d0
2021-06-23Docs: 'Stateless RoT Service' application referenceMingyang Sun
- The implementation details, necessary support in manifest tooling, and programming API change for stateless service. - Application recommendation of developing stateless RoT services. Change-Id: Ibc8e9e68353212d3704b960dda7a2752464cad1e Signed-off-by: Mingyang Sun <mingyang.sun@arm.com>
2021-06-22Test: Refactor IRQ TestingKevin Peng
This patch: - Replaces the tfm_irq_test_service_1 with the tfm_slih_test_service - Docs update: - Remove the out-of-date tfm_non-secure_interrupt_handling.rst - Remove IRQ test part in core_test_services_integration_guide.rst as core test does not participate in IRQ testing anymore. Note: The new SLIH testing does not support Library Model. Change-Id: I578d43ca7a363cdcb298226cc9ebad5f7b66fb48 Signed-off-by: Kevin Peng <kevin.peng@arm.com>
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-08HAL: Replace the 'idx' input param with 'privileged'Mingyang Sun
In tfm_spm_hal_configure_default_isolation(), a partition index is passed in to query the partition privilege. Change to pass in privilege directly instead of the partition index. Change-Id: Id046431cc8e224a94e83a71564ba2843fabf8ed7 Signed-off-by: Mingyang Sun <mingyang.sun@arm.com>
2021-06-08Crypto: Change to stateless serviceSummer Qin
Crypto service does not require a client to call to psa_connect() or psa_close(). Instead the service can use a stateless mechanism. Related documents are also updated. Note: Framework version of Crypto partition has been updated to 1.1, but not all features of FF-M 1.1 are implemented now. Change-Id: Iad628667e4b63e809c933fb263734403c6274bf9 Signed-off-by: Summer Qin <summer.qin@arm.com>
2021-06-07Attest: Support to retrieve Initial Attestation public key in runtimeDavid Hu
Enable ATTEST_TEST_GET_PUBLIC_KEY flag in Musca-B1 and Musca-S1 with OTP enabled. Add Initial Attestation test service in manifest list. Change-Id: I8e982ee1a7c31548b4e7c74b937e17660cb0e89e Signed-off-by: David Hu <david.hu@arm.com>
2021-06-04Docs : adding Documentation for SQUAD dashboardHugo L'Hostis
This patch adds a documentation page for the SQUAD dashboard in tf.org. Signed-off-by: Hugo L'Hostis <hugo.lhostis@arm.com> Change-Id: Ic47926d1a5b04615303955913b8fc7f4a3b5332f
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-06-02Attest: Remove initial attestation get public key API functionDavid Hu
It is overkill to implement a dedicated secure function for NS to fetch initial attestation public key just for test purpose. Besides, this function to get public key can be confusing as it is not defined in PSA Initial Attestation API spec. Remove get public key secure function from NS and S sides to simplify TF-M initial attestation implementation and interface. Change-Id: I8d0967698e3d2f2c684194caa9a6234585026a71 Signed-off-by: David Hu <david.hu@arm.com>
2021-05-31SPM: Refine 'load' interfacesKen Liu
- Partitions need load info assemling MACROs, move them out of 'partition_static_load.h'. - Rename 'partition_static_load.h' into 'spm_load_api.h', and create a static load implementation 'static_load.c'. - Refine the load logic, call API provided in 'spm_load_api.h'. - Service lookup now list based. - Rename 'load info' variable in partition and service runtime defs. Change-Id: I73901094458ff1f11674100f8660eaa44a457d09 Signed-off-by: Ken Liu <Ken.Liu@arm.com>
2021-05-26Document: Spelling check.shejia01
Correct the spelling problem in document. Change-Id: I461a496c2f9faee3c9e282f457104119963330d5 Signed-off-by: Jianliang Shen <jianliang.shen@arm.com>
2021-05-26FWU: Add checking the state of the running imageSherry Zhang
The Firmware Update partition reads the image_ok flag to check whether the running image has been confirmed. The running image state is set according to this flag in psa_fwu_query(). Change-Id: I9cf58b7d6f3b87a50e0ac6f926e30170bb01b8f1 Signed-off-by: Sherry Zhang <sherry.zhang2@arm.com>
It should be TFM_DEFAULT_SECURE_IRQ_PRIO*R*ITY. In the cases when the priority in interrupt controller is not set, the default value TFM_DEFAULT_SECURE_IRQ_PRIORITY cannot be found and build fails in IPC model. Change-Id: I6412de4163c793bfe9da361cacc8e8c19855c76c Signed-off-by: Kevin Peng <kevin.peng@arm.com>
2021-05-21Profiles: Update Profile Medium document and default configsDavid Hu
Update Profile Medium design document. Refine Profile Medium configs. Disable asymmetric encryption by default. Change-Id: I7e42751073192a74532396fb4251c775b7b2fb3b Signed-off-by: David Hu <david.hu@arm.com>
2021-05-21Crypto: Refine asymmetric cryptographic control flagsDavid Hu
Add CRYPTO_ASYM_SIGN_MODULE_DISABLED flag to control Crypto asymmetric signature operations. Add CRYPTO_ASYM_ENCRYPT_MODULE_DISABLED flag to control Crypto asymmetric encryption operations. The two new flags replace the existing CRYPTO_ASYMMETRIC_MODULE_DISABLED flag. Those flags help control Crypto asymmetirc key based operations independently and align with the PSA Crypto API spec. Change-Id: I4ff1561187abc9b463ed72b97dea0a8231b8da0e Signed-off-by: David Hu <david.hu@arm.com>
2021-05-20Docs: Manually set security advisory documents in orderDavid Hu
Manually sort the security advisory documents in order. Otherwise, rendered documents are sorted according to file names in alphabetical order. Change-Id: Ib49c788ae1e37c24ff84d44429ed3963d85c5267 Signed-off-by: David Hu <david.hu@arm.com>
2021-05-20TFMV-3: Crypto multi-part operations abort() may not take effect.David Hu
Change-Id: I9e699ffc0a2e9528636192b86d3ec6e1117cc070 Signed-off-by: David Hu <david.hu@arm.com>
2021-05-19Docs: Update the tfm_fwu_service.rstSherry Zhang
Update the document after the support of image update with dependencies. Change-Id: Ia733f0a410e3801123d3f9d321838899aa9c97a6 Signed-off-by: Sherry Zhang <sherry.zhang2@arm.com>
2021-05-19Docs: Announce future release datesAnton Komlev
Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I320e1433716640373997ee83a22bb4299b607250
2021-05-18Docs: Clean up draft status claimsDavid Hu
The design document status is optional. The status field in some design documents are not changed during merge and are still "Draft". It will confuse readers and developers as obviously those design documents have been accepted. Remove the "Draft" status from those design documents. Change-Id: I94a2c049dc62fbf794d646d934a10e746400d224 Signed-off-by: David Hu <david.hu@arm.com>
2021-05-18Docs: Fix some document build warningsDavid Hu
Fix some duplicated labels warnings and code block language warnings. Change-Id: Ic25be83273fb8eac3a3ff4c2b98182ff268cb3dd Signed-off-by: David Hu <david.hu@arm.com>
2021-05-06Add icons to the User guide home pageAnton Komlev
Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I2dea09830e5fa8b68cc362172ebf44a97a4167b1
2021-05-06Docs: Refine introductionSummer Qin
Refine the content of introduction. Move 'releases' and 'platform supported' into their separate directory. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: Ia791ae8114401966a9512fb0d12f98068b1b775e
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-30Docs: Update TF-M diagramSummer Qin
Update TF-M diagram since includes Firmware Updates services and isolation level 3. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I0c9642dc780b77411ee7cbca6df16279f54a2687
2021-04-29Platform: Add support for BL5340 DVKJamie McCrae
This adds supports for the Laird Connectivity BL5340 DVK (development kit) application core, which is based on the nRF5340 SoC. Signed-off-by: Jamie McCrae <jamie.mccrae@lairdconnect.com> Change-Id: I062412918d4cbe692748c1a31fef444190f50661
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-29Interface: Remove NS specific implementation of test interfaceDavid Hu
Remove some test interface files to decouple TF-M from NS speific implementation. Those files will be moved to tf-m-tests. Those files include NS client identification management and NS mailbox test utilities. Change-Id: I963ccae2b50d6124e3ac84547d91b09b28fddfd5 Signed-off-by: David Hu <david.hu@arm.com>
2021-04-29Docs: Update integration guides to align with NS interface changeDavid Hu
Update tfm_integration_guide document Change-Id: I1a78e1b39b0b764f087af348e4347e1062c5b756 Signed-off-by: David Hu <david.hu@arm.com>
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