summaryrefslogtreecommitdiff
path: root/docs/sections/building.md
AgeCommit message (Collapse)Author
14 daysMinor documentation fixesKshitij Sisodia
Minor fixes to broken links in markdown files. Added a note about timing adapters being disabled in Arm Corstone-315 by default. Change-Id: I7f0b33adc8c38e8be7a5bfcebbf5d87f4e22430c Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2024-05-03MLECO-4825: Adding Arm Corstone-315 supportKshitij Sisodia
This patch adds initial support for MPS4 based Arm Corstone-315 FVPs. The applications will execute on the FVP but with INITSVTOR set to `0x12000000` explicitly. The default value is the 64kiB code region at `0x11000000`. The linker scripts will be changed for the initial boot logic and vector table to be moved to the code region. This patch adds `source/hal/source/platform/mps4` directory. There is considerable overlap with MPS3 platform and this is expected to be the case until the support for MPS4 matures. Refactoring to pull in common bits from these targets will follow. Same goes for the CMake build support added under `scripts/cmake/platforms/mps4`. Change-Id: I981be9e1ec57cfedcf7d340b4f19e5eb40b5cbd3 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com> Tested-by: mlecosys <mlecosys@arm.com> Reviewed-by: Conor Kennedy <conor.kennedy@arm.com> Reviewed-by: Alex Tawse <alex.tawse@arm.com> Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2023-11-30MLECO-4371 Update dependencies to 23.11 release components23.11-rc1Richard Burton
* Updated NPU components and dependencies (core-driver, core-platform, Vela, CMSIS, TensorFlow Lite Micro) to 23.11 release SHAs. * Changed Python version to 3.10 * Updated release notes and other documentation * Added workarounds to scripts in order to address build issues Signed-off-by: Aron Virginas-Tar <aron.virginas-tar@arm.com> Change-Id: I0a639b80881b53eebb216085b7e6764e3be8ca67
2023-11-03MLECO-3640 MLECO-3678: Adding support for M85 in GCCRichard Burton
Signed-off-by: Richard Burton <richard.burton@arm.com> Change-Id: I087e23f43b41fa0ef97ec7dcaeba807f6cba17e7
2023-09-05MLECO-4074: bump up version of armclang to 6.1923.08-rc223.08Nina Drozd
* issues identified with armclang 6.17 and 6.18 * updates in cmake for minimum version * updates in release notes and documentation Change-Id: Iffa711d9d95a509f5c07cd55f59a49bdcf3e9d6a
2023-06-22Small fixes based on feedbackRichard Burton
* Typo fix in documentation * Fix bug with build_default.py and passing in --make-verbose * Added additional requirement for third-party dependencies Signed-off-by: Richard Burton <richard.burton@arm.com> Change-Id: Icdac7d4583c4fe3000fe9bc784979b2d1cf70909
2023-06-09MLECO-4065: Revising scripts to use Python3.923.05Kshitij Sisodia
Revising documentation and scripts to use Python3.9 explicitly to remove the need for installing it system-wide that might break a distro's desktop and pacakge manager utilities. Change-Id: I683b55dd0243d0a726dc94eba2431005d4897c8c Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2023-05-30MLECO-4065 MLECO-4066: Updating to 23.05 dependenciesRichard Burton
* Update dependencies to 23.05 versions * Fix for a break caused by changes in TensorFlow Lite Micro * Update release notes Signed-off-by: Richard Burton <richard.burton@arm.com> Change-Id: Id2f60ea574aab982911125bdcb513adb8edc723d
2023-03-21MLECO-3802: [Maintenance] Remove Pillow warning23.02Isabella Gottardi
- Image.Resampling.BILINEAR replace deprecated Image.BILINEAR - Trivial documentation fixes Change-Id: Ia75af2d2bf171085d4a0a2c472f0e3f94dbdc5b9 Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
2022-12-23MLECO-3748: Documentation updatesKshitij Sisodia
Added documentation around known issue with Arm GNU toolchain version 12.2.1. Minor change for MLECO-3731 also included. Link-time warnings for Arm GNU toolchain 11.3.1 also fixed. Change-Id: Ia8215e9f71327eeb59868aea91729d7b19dd6d34 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-12-19MLECO-3611: Formatting fixes for generated files.Kshitij Sisodia
Template files updated for generated files to adhere to coding guidelines and clang format configuration. There will still be unavoidable violations, but most of the others have been fixed. Change-Id: Ia03db40f8c62a369f2b07fe02eea65e41993a523 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-12-01MLECO-3620 MLECO-3619: Update to 22.11 dependencies22.11-rc122.11Richard Burton
* CMSIS-NN is now a seperate dependency * Added inclusive language commitment * TensorFlow Lite Micro dependency is moved ahead of 22.11 to fix compilation issue Change-Id: I60e3311ff7da2ce064cbcdca054a86bdd1f620d8
2022-11-17MLECO-3583: Update copyright notice according to new guidelinesRichard Burton
Change-Id: I0f057b33993e5196a60e52f4fb0c60e09693dcfe
2022-10-14MLECO-3562: Trivial documentation link updateKshitij Sisodia
Link update in docs/sections/building.md file. Change-Id: I6b4b95bc4c3e911123ee745e64fe6075af563011 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-10-12MLECO-3562: Add documentation on CMake PresetsMaksims Svecovs
Adds documentation on how to configure and use CMake Presets in VS Code. Signed-off-by: Maksims Svecovs <maksims.svecovs@arm.com> Change-Id: I0aa5d598415895268cabc9cbe36e7582a6fea789
2022-10-03MLECO-3149: Add CTest driven FVP runs for non-native targets.Sarah Blades
Additional CMake configuration parameters required: * `BUILD_FVP_TESTS`: Selects whether these tests are built, OFF by default. * `FVP_PATH`: Path to the FVP that MUST be provided for the configuration to succeed. Change-Id: I741379cd0a6078a3e2c3163e6b253b2f5dc25c58 Signed-off-by: Sarah Blades <sarah.blades@arm.com>
2022-09-28MLECO-3518: Move to CMake 3.23.3Maksims Svecovs
For the purpose of using decoupled presets move required CMake version to 3.23.3 that supports "includes" option for presets. Updates the documentation. Signed-off-by: Maksims Svecovs <maksims.svecovs@arm.com> Change-Id: I259e8e3a4641294d8ccdee429c7284d8160b9e24
2022-09-26MLECO-3254 Default to using only one file per UCEanna O Cathain
Signed-off-by: Eanna O Cathain <eanna.ocathain@arm.com> Change-Id: I4a1cd2b5746cb479ae0d81ed973961cec2f3046e
2022-09-07MLECO-3535: update to 22.08 versions of modelsNina Drozd
* update to 22.08 release of ethos-u-vela * update download_dependencies script to new tf revision Signed-off-by: Nina Drozd <nina.drozd@arm.com> Change-Id: Ib4cb47ac0881d45fc6766b6b87154584d9db7374
2022-09-05MLECO-3538: Minor documentation updatesNina Drozd
* updated table of contents for building page * point to timing adapter page * updates to timing adapter page links and tables Change-Id: I54bde77db1a082afddae0abe109fa1369506057c
2022-08-31MLECO-3449: Update dependancies to 22.08 tagsMaksims Svecovs
Update dependencies to be aligned with 22.08 release of mlplatform according to: https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u/+/refs/heads/master/22.08.json CMSIS-DSP is moved to a separate repository, this patch adds a new repository along with user build parameter. Signed-off-by: Maksims Svecovs <maksims.svecovs@arm.com> Change-Id: I356fb19b5dac87a21adfc34c67f9699131666074
2022-08-25MLECO-3252: Minor documentation additionsKshitij Sisodia
Documentation md files added under source tree with links to the main docs. Minor updates to FAQs for MLECO-3251 as well. Change-Id: Ifdcc587f2fcf77228fd46e211d3f9c3963bc9b97 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-08-16MLECO-3319: Documentation updates for Arm® Corstone™-310.Kshitij Sisodia
Documentation updates around use of Arm® Corstone™-310 AVH, especially in terms of use of timing adapters (TA). Also, use of TA's is forced off for SSE-310 subsystem's CMake configuration. Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com> Signed-off-by: Maksims Svecovs <maksims.svecovs@arm.com> Change-Id: I66a87060d8d47ce2580aa15f3908be20162eab54
2022-08-16MLECO-3244: Documentation on timing adaptersMaksims Svecovs
Documents current differences between timing adapters implementations on Corstone-300 and Corstone-310 platforms. Signed-off-by: Maksims Svecovs <maksims.svecovs@arm.com> Change-Id: I3161dc929bd01217a4992be869f13377a58e5471
2022-08-05MLECO-3232: Add basic cmake presetsMaksims Svecovs
Assuming cmake 3.21 adds basic configuration and build presets: * Target mps3 board with gcc * Target mps3 board with armclang * Target simple platform with gcc * Target simple platform with armclang * Target native build system Adds test preset for native build to run default ctests. Adds respective doc section to building instructions. Note: hidden configurationPresets are to be moved to respective project directories once cmake 3.24 is supported in the codebase and preset include is supported. Note: it is encouraged to create a personal CMakeUserPresets.json with personal preferences like specific `LOG_LEVEL` and `jobs` for faster compilation time. Usage example: cmake --preset=mps3-gcc Signed-off-by: Maksims Svecovs <maksims.svecovs@arm.com> Change-Id: I07a8861ed91160cc3f5167e16be45a921b60a285
2022-08-03MLECO-3375: Update documentation for missing AVH python3.8 venv packageRichard Burton
Change-Id: Idfee5b33b31cabdf7e825c2161df1e71191d115a
2022-06-01MLECO-2968 Create a docker image with all requirementsKshitij Sisodia
Added a Dockerfile to setup and install requirements for the ml-embedded-evaluation-kit repository. Also included minor change (MLCE-859) for NPU components' source file. Signed-off-by: Matthew Sloyan <matthew.sloyan@arm.com> Change-Id: I621fb2991218a451a0e8c33e14032b9c9e36709e
2022-05-31MLECO-3213: Downgrade requirment from Python3.8 to Python3.7Richard Burton
Update Vela to 3.4.0 Signed-off-by: Richard Burton <richard.burton@arm.com> Change-Id: If203d29d6884219cd4947a5753a1fb8d8284f174
2022-05-25MLECO-3185: Documentation updatesKshitij Sisodia
Documentation updated to reflect refactoring changes in the last few weeks. Change-Id: Ic7abf5cc3af9898123049e890c189ed74e505309
2022-05-23MLECO-3225: Using official support for Arm Cortex-M85 CPU.Kshitij Sisodia
* CMake version requirement bumped up to 3.21.0 * CMake 3.22.4 installed in the local Python virtualenv * CPU flags updated in toolchain files. * Using __ARM_FEATURE_DSP instead of potentially defining ARM_MATH_DSP wrongly. * CMake project version bumped up to 22.05.0 Changes also made for MLECO-3107 (pack generation): * TensorFlow Lite Micro CMSIS-pack version updated to 1.22.02. * Change to using __ARM_FEATURE_DSP will also help the generated pack. Partial changes for MLECO-3095: * CMSIS updated to version post 5.9.0 * TensorFlow Lite Micro updated to latest available * Ethos-U driver and core-platform repositories updated to 20.05_rc2 tags. Change-Id: I012c9e65897aed8ce589cff9bfe3a19efc3edeb9 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-05-17MLECO-2985 Adding Corstone-310 supportKshitij Sisodia
Change-Id: Ifa4b11154478355c10cb3e747b9938a74afd242b Signed-off-by: Eanna O Cathain <eanna.ocathain@arm.com>
2022-04-05MLECO-3096: Removing "timer" from HAL profile.Kshitij Sisodia
Attempting to have timer functionality contained within the platform drivers "package" as it should (in line with the refactoring work done so far under HAL). This will ensure that we don't need two timer implementations under HAL "profiles" and therefore, this whole directory can be removed. This change also addressed issue with the applicatio level Profiler code knowing about how the PMU has been set up by the platform code. This link has been removed completely. This will make it much easier to add/amend the Ethos-U PMU event counters types and give each platform the capability of populating their relvant counters. The application level Profiler doesn't know which metrics it is displaying but just calculates and maintains statistics for whatever PMU counters it receives from the HAL level. A fix for timing adapter issue introduced in the last CR is also included. Change-Id: Ia46e03a06e7b8e42b9ed2ba8f2af2dcd2229c110 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-03-28MLECO-2917 Replacing platform CMake definitions with headersKshitij Sisodia
Moving away from CMake description of targets and generation of platform header files (for memory addresses and IRQ numbers). Instead these headers are part of the repository under their respective platform-driver packages under HAL sources. Change-Id: I9bd3e68eb17385f8b93eb3d8d76b212ce0e1a6d5 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-03-15MLECO-3035: [Documentation] Add instructions for updating to python3.8 for ↵Isabella Gottardi
Ubuntu 18.04 (or older) users Change-Id: If7bb02f44f8bb7b84b7b7a620e69429a7b5fbb60 Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
2022-03-15MLECO-3041: Update model optimization documentationRichard Burton
Change-Id: I771089443a6cdb4135570fcdd6e321a8f68fcf4a
2022-03-11MLECO-3006: Fixing some minor errors in documentationIsabella Gottardi
Change-Id: I24cd544780f46fcec8f154b440f7bb959c20a459 Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
2022-03-04MLECO-2984: Refactor componentsKshitij Sisodia
* Use UART component from Ethos-U core-platform * Components as cmake project Change-Id: I053f3a59800abc20216e6a4df8555db357e3f21d Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
2022-03-04MLECO-2978: Update to 22.02 dependenciesRichard Burton
* Core-platform now a depdenency for timing adapter Signed-off-by: Richard Burton <richard.burton@arm.com> Change-Id: I54f3773bdf91083fa1513be15372fcf2231bea2c
2022-02-28MLECO-2976: Configurable Ethos-U cache size for Dedicated_SramIsabella Gottardi
MLECO-2949: Platform drivers should own NPU and TA init Change-Id: I13606a0197f137816bae803eb9d7d46c358b5fb8 Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
2022-02-25Documentation fixesIsabella Gottardi
Change-Id: I2036332cffee94f1a3b69b391586d0a2f6c9db55
2022-02-21MLECO-2927: Build Arm Ethos-U NPU driver outside TFLuNina Drozd
* TensorFlow CMake uses Arm Ethos-U NPU driver lib path * armclang DWARF level config flag removed * uses and mentions of DWARF level removed * TensorFlow uses Arm Cortex-M generic target * removed Arm Cortex-M custom target makefile and dir Change-Id: Ie0d3edb5473462ef8552f8b9f832190de5e99a7c
2022-02-15MLECO-2614: Minor documentation updatesIsabella Gottardi
* Adding troubleshooting for cloning errors Change-Id: Ib57353900064c68c30ecb2141602081180c50c99 Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
2021-12-09 MLECO-2082 Fixes and improvements from OOB21.11Ayaan Masood
-Fixed noise_reduction CMake bug cause inference to fail when non-default mac_units passed to build script -Inference complete message added to noise_reduction LCD -Doc update clarfiy vela.ini config file for compiling to non-default memory modes -QOL improvement by adding a note on how to make path variables permenant when configuring Arm compilers Change-Id: Id798b25638260721d8e48468b7a5942bd802d63b
2021-11-30MLECO-2745: Fix for arena-cache-sizeIsabella Gottardi
Arena-cache-size is different from default when using Dedicated_Sram memory mode. Change-Id: Ie112146218e1ec456e17babd4ed3e7c7bc2009a8
2021-11-26MLECO 2597: Minimal system requirementCisco Cervellera
* Documentation added with missing prerequisite * build_default.py can now be tuned for constraint build systems Change-Id: I74c061359ff663335e664528c4f0616f55cff0f7
2021-11-23MLECO-1935: All common CMake user options consolidated.Kshitij Sisodia
For easier look up and maintenance, all common CMake user options have been consolidated in one CMake file. NOTE: the individual use case specific options are still within the correspoinding use case CMake files. Change-Id: Id887f7b2c763f4d3eb997d997cf466684d0089b6
2021-11-16MLECO-2520: Change md files to have correct file linksCisco Cervellera
Change-Id: I3ec18583c321eb2815a670d56f4958e610331d6d
2021-10-29MLECO-2512: Minor improvement for helper scripts.Kshitij Sisodia
Python scripts 'build_default.py' and 'set_up_default_resources.py' now allow building for non-default Ethos-U configurations: H32, H64, H256 and Y512. Change-Id: Iefdbf135410396c4dc0be73462644725d4b47910
2021-10-05MLECO-2395: Allow users to select Ethos-U memory modeIsabella Gottardi
Change-Id: Icf09410f12072e8d7850dd1e540c3243af24ed09
2021-09-15MLECO-2137: TA documentation improvementIsabella Gottardi
Change-Id: Ie2f358ef52aaa8734ff09ead97aea72e5bda7f8b