aboutsummaryrefslogtreecommitdiff
path: root/docs/contributing
AgeCommit message (Collapse)Author
2021-09-07readme: Add Sebastian as a Nordic maintainerSebastian Bøe
Add Sebastian Bøe as a new Nordic maintainer. Change-Id: I7306caa38476ff1a67c918ddb9e5780e25cebd38 Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
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-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-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-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-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-03-30Update maintainers fileChris Brand
Add Infineon company name (Cypress is now owned by Infineon). Add Chris Brand, Ken Liu, David Hu as new miantainers. Remove Abhishek Pandit, Ashutosh Singh, Miklos Balint from mainteiners. Change-Id: Iddac1b24d455f55aec01bdde6857cf4b18233fca Signed-off-by: Chris Brand <chris.brand@cypress.com> Signed-off-by: Anton Komlev <anton.komlev@arm.com>
2021-03-17platform: Add deprecation warnings for nRF5340 PDKAndrzej Głąbek
Indicate that the nRF5340 PDK (nordic_nrf/nrf5340pdk_nrf5340_cpuapp) platform is deprecated by issuing a corresponding cmake warning at build time and a run-time log message when the platform is initialized. Add also the platform to the List of Deprecated Platforms in the Platform deprecation and removal section of the TF-M documentation. Signed-off-by: Andrzej Głąbek <andrzej.glabek@nordicsemi.no> Change-Id: Ibe657cf03d8973703418ac260a8d20d7fa1a85d7
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-01-29platform : Added deprecation warnings for musca_aHugo L'Hostis
This patch modifies the cmake configuration for musca_a to display the deprecation warning at build-time. It also adds a LOG_MESSAGE entry on the spm_hal which displays a run-time notification. The Deprecated Platforms section of the documentation is updated to reflect this status change. Signed-off-by: Hugo L'Hostis <hugo.lhostis@arm.com> Change-Id: Iac9adb5d25fd46d843f0655cfa553889f45fbbbe
2021-01-27platform: Added deprecation warnings for sse-200_awsMinos Galanakis
This patch modifies the cmake configuration for sse-200_aws to display the deprecation warning at build-time. It also adds a LOG_MESSAGE entry on the spm_hal which displays a run-time notification. The Deprecated Platforms section of the documentation is updated to reflect this status change. Signed-off-by: Minos Galanakis <minos.galanakis@arm.com> Change-Id: I3b29fd02a29ecb89d0eec241211a281356f51198
2021-01-25SPM: Rename 'spm/common' into 'spm/ffm'Ken Liu
The name 'common' confused a bit, as its real purpose is for general FF-M API implementation. Rename this folder as the first step for re-structure patches. There are some 'common' folder legacies still in the renamed 'ffm' folder. They will be updated in the following patches. Change-Id: Ic72fcf9ecf47f2185a82761edfdcbcd3c4569421 Signed-off-by: Ken Liu <Ken.Liu@arm.com>
2020-11-25Version: Update for TF-M v1.2.0 releaseMinos Galanakis
This patch updates the TF-M version for runtime code, build system and documentation to v1.2.0 Signed-off-by: Minos Galanakis <minos.galanakis@arm.com> Change-Id: I53b1e916a9928bac7347381d1a37c7d62bd2302a
2020-11-23Build: Semantic versioning supportMinos Galanakis
This patch modifies the project's versioning schema to support semantic versioning. The new schema going forward is: <Major>.<Minor>.Hotfix> The patch updates: • The TF-M version macros * Previous releases' documentation * The version detection logic for documentation to support old and new schema Signed-off-by: Minos Galanakis <minos.galanakis@arm.com> Change-Id: I6baa0cab849d656c8d756d4a70c10c258ef3001c
2020-11-09Docs: Added Documentation Contribution GuidelinesMinos Galanakis
Signed-off-by: Minos Galanakis <minos.galanakis@arm.com> Change-Id: Icefd12e9b26c14cc87a1b29e51d281008db508e4
2020-11-03Docs: Updating references to DS-5, and other contentMinos Galanakis
This patch is updating the references to DS-5 to Arm Development Studio. The version numbers, and user instructions have also been updated to reflect the new name. It is also adding proper documentation to the appropriate arm developer pages for each toolchain, as well as fixing other minor formatting issues across documentation Signed-off-by: Minos Galanakis <minos.galanakis@arm.com> Change-Id: I99fd4ff3f127e6fe9f1f5384245770637fe41c11
2020-10-29Platform: Adding Nuvoton M2351 Supportwschang0
The NuMicro® M2351 microcontroller series is powered by Arm® Cortex®-M23 core with TrustZone® for Armv8-M architecture, which elevates the traditional firmware security to the new level of robust software security. The porting will apply trusted-firmware-M to M2351 to make it easy to create the security firmware on Nuvoton M2351 platform. Signed-off-by: WSChang <wschang0@nuvoton.com> Change-Id: I059618223fae8ab9ca085e9c998d51e3d12e8d86
2020-10-26platform: Added deprecation warnings for AN539Minos Galanakis
This patch modifies the cmake configuration for AN539 to display the deprecation warning at build-time. It also adds a LOG_MESSAGE entry on the spm_hal which displays a run-time notification. The Deprecated Platforms section of the documentation is updated to reflect this status change. Signed-off-by: Minos Galanakis <minos.galanakis@arm.com> Change-Id: I1cddb70427ec314562197bca65aeb15172418c39
2020-10-08Platform: Add support for new SOCs: nRF5340 and nRF9160Øyvind Rønningstad
Supporting most configurations. This patch targets the nRF9160 and the nRF5340 application core. The nRF5340 is a dual-core SOC (application core and network core). The nRF5340 application core is a Cortex-M33F with TrustZone-M. The nRF9160 is an SOC with LTE-M/NB-IOT/GPS connectivity. The nRF9160 has a Cortex-M33F with TrustZone-M. Common code between the two platforms has been placed into a common directory. The platforms do not use the tfm_common_s.ld linker script since the nRF IDAU needs some alterations to the placement of the veneers. The common directory contains parts of the nrfx driver framework, copied from https://github.com/NordicSemiconductor/nrfx version 2.3.0 at commit 6c31cb7d0e4038afa1efc9bfed40206adfd7b83e. Signed-off-by: Andrzej Głąbek <andrzej.glabek@nordicsemi.no> Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no> Signed-off-by: Øyvind Rønningstad <oyvind.ronningstad@nordicsemi.no> Change-Id: I15b932f444aa9adf2ef2489e9ecf036c64c851a7
2020-09-29Docs: Code Review GuidelinesKen Liu
A document to clarify the uncertain items while reviewing. The audience is mainly the reviewers but also helpful for contributors. Change-Id: I4ca04ea602aaf18eef6b52237279a8e602388083 Signed-off-by: Ken Liu <ken.liu@arm.com>
2020-08-10Docs: Add process for platform removalSoby Mathew
Signed-off-by: Soby Mathew <soby.mathew@arm.com> Change-Id: I3aefb16be610cb60270e8837bd8ce598c25a7f9a
2020-07-03Docs: Added link to security centerMinos Galanakis
This patch adds an external link for the TF-M Security Center to the `Contributing` and `Quick Links` sections of the documentation Change-Id: I5cfed23fcdfaeead35f4050004499e5f6756300c Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>
2020-06-24Define code owners and update list of maintainersAnton Komlev
This is a follow up of "Project Maintenance Process" created here: ttps://developer.trustedfirmware.org/w/collaboration/project-maintenance-process/ The document defines roles of maintainers, code owners and contributors. This update lists Code owners and maintainers for TF-M project. Added code owners of NXP, STM and Cypress platforms. Change the owner of Audit log to Jamie Fox Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: Ia47b0587d91f00d64692e838f7dd0b90683d7bfa Signed-off-by: Anton Komlev <anton.komlev@arm.com>
2020-06-24docs: Add release cadence informationSoby Mathew
This patch adds premiliminary information about release cadence to be followed by the project. Signed-off-by: Soby Mathew <soby.mathew@arm.com> Change-Id: If695862e5e428538595e3c9f96f815089b7447bf
2020-06-22docs: contributing.rst: Add details about submitting patches to GerritØyvind Rønningstad
Add HTTPS push link, and add link to where to add credentials. Also add more details about Change-Id, and remove line about "other fields" since it doesn't have any examples and is not required to submit the patch. Also, remove line about adding the task ID since I can't see that it is being done in the commits on master. Change-Id: Ib0db5087f80f726877af00cb8bc4e86e26ff0822 Signed-off-by: Øyvind Rønningstad <oyvind.ronningstad@nordicsemi.no>
2020-06-19Docs: Restructuring and new layoutMinos Galanakis
This patch implements a set of user-experiences aimed changes.It modifies the documentation structure and switches to a more reactive design for the rtd theme. * The documentation layout has been redesigned to be more intuitive,easier to maintain and and scale. * The landing page introduces a new dashboard. * Introduced dedicated space for release documents, and changelog has been modified to directly source content from referenced documents. * Added quick-link navigation for items that need emphasis. * Relevant design documents can now be grouped in suf-folders. * There is dedicated space for custom platform, and third party tools documents. * Wildcard and regex matching has been introduced to indexes. Change-Id: Ib02d17d5d26187d397ba17317788cf2a01401b07 Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>