From abeb3259783f90ff007ff155d312cd7807c62198 Mon Sep 17 00:00:00 2001 From: Senthil Ramakrishnan Date: Thu, 7 Feb 2019 18:45:18 -0600 Subject: [PATCH 1/9] Toolchain documentation updates --- docs/tools/tools_intro.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/tools/tools_intro.md b/docs/tools/tools_intro.md index a8491f0078..0414588dd3 100644 --- a/docs/tools/tools_intro.md +++ b/docs/tools/tools_intro.md @@ -21,23 +21,26 @@ We created the Mbed command-line tool (Mbed CLI), a Python-based tool, specifica Mbed OS 5 can be built with various toolchains. The currently supported versions are: -- [Arm compiler 5.06 update 6](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler-5/downloads). +- [Arm compiler 6.11](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler/downloads/version-6). - [GNU Arm Embedded version 6 (6-2017-q1-update)](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads). -- [IAR Embedded Workbench 8.32](https://www.iar.com/iar-embedded-workbench/tools-for-arm/arm-cortex-m-edition/). +- [IAR Embedded Workbench 8.32.1](https://www.iar.com/iar-embedded-workbench/tools-for-arm/arm-cortex-m-edition/). ##### Arm Mbed Online Compiler -The Mbed Online Compiler is our in-house IDE, and should be familiar to anyone who's been working with Mbed for a while. It switches the backing toolchain based on the architecture version: +The Mbed Online Compiler is our in-house IDE and should be familiar to anyone who's been working with Mbed for a while. It switches the backing toolchain based on the architecture version as in the table below. | Architecture version | Compiler | |---- |---- | -| Arm v6M | Arm Compiler 5.06 update 6 | -| Arm v7M | Arm Compiler 5.06 update 6 | -| Arm v7A | Arm Compiler 5.06 update 6 | -| Arm v8M | Arm Compiler 6.10.1 | +| Arm v6M | `Arm Compiler 6.11` or `Arm Compiler 5.06 update 6` based on the Arm toolchain supported by the target (see `supported_toolchains` in [Adding and configuring targets](../reference/configuration/mbed_targets.html)) | +| Arm v7M | `Arm Compiler 6.11` or `Arm Compiler 5.06 update 6` based on the Arm toolchain supported by the target (see `supported_toolchains` in [Adding and configuring targets](../reference/configuration/mbed_targets.html)) | +| Arm v7A | `Arm Compiler 6.11` | +| Arm v8M | `Arm Compiler 6.11` | For more information, please see the [Online Compiler page](developing-mbed-online-compiler.html). + **Note:** With Mbed-OS 5.12 release, ARM Compiler 6 will be the default ARM toolchain for all Mbed OS targets. Majority of Mbed OS targets/platforms are already compatible with ARM Compiler 6. Few targets currently using/supporting ARM Compiler 5 will also be migrated to ARM Compiler in future. Please be aware that all new/existing Mbed OS targets/developers must use ARM Compiler 6 for future development as all source code contributions to Mbed OS will be validated with ARM Compiler 6. + ##### Third party development tools You can export your project from any of our tools to third party tools. For instructions, as well as tool-specific information, see [the Exporting to third party toolchains page](exporting.html). + From ea365aa9eecb26e684da3c8147ceb119ae192cfc Mon Sep 17 00:00:00 2001 From: Senthil Ramakrishnan Date: Mon, 25 Feb 2019 14:15:24 -0600 Subject: [PATCH 2/9] Update target configuration information for ARMC6/ARMC5 --- docs/reference/configuration/mbed_targets.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/reference/configuration/mbed_targets.md b/docs/reference/configuration/mbed_targets.md index 1c2b7183eb..2453ae36de 100644 --- a/docs/reference/configuration/mbed_targets.md +++ b/docs/reference/configuration/mbed_targets.md @@ -192,7 +192,10 @@ Enabling `is_disk_virtual` adds delay after flashing firmware binary to make sur #### supported_toolchains -The `supported_toolchains` property is the list of toolchains that support a target. The allowed values for `supported_toolchains` are `ARM`, `uARM`, `ARMC6`, `GCC_ARM` and `IAR`. +The `supported_toolchains` property is the list of toolchains that support a target. The allowed values for `supported_toolchains` are `ARM`, `uARM`, `ARMC5`, `ARMC6`, `GCC_ARM` and `IAR`. +If you specify `ARMC5` in `supported_toolchains` it means the corresponding target supports `Arm Compiler 5.06 update 6`. +If a target lists both ARMC5 and ARM(or ARMC6) in `supported_toolchains`, the ARM Compiler 6.11 will be used when compiling with `ARM` option for `--toolchain`. +Note that although you can specify `ARMC5` in `supported_toolchains` in `targets.json`, it's not a valid option for `--toolchain` when compiling using [Mbed CLI](../tools/developing-mbed-cli.html). #### default_toolchain @@ -427,3 +430,7 @@ The `orphans` command shows all targets that you cannot reach from a public targ - EFR32MG1P132F256GM48 - EFR32MG1_BRD4150 ``` + +### Related content + +- [Developing: Mbed CLI](../tools/developing-mbed-cli.html) \ No newline at end of file From 8db10b3013255c320af09caba72fce2195dfd880 Mon Sep 17 00:00:00 2001 From: Senthil Ramakrishnan Date: Mon, 25 Feb 2019 14:26:32 -0600 Subject: [PATCH 3/9] Update tools intro section to capture new requirements for ARMC6 tranisition --- docs/tools/tools_intro.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/tools/tools_intro.md b/docs/tools/tools_intro.md index 0414588dd3..43e023f040 100644 --- a/docs/tools/tools_intro.md +++ b/docs/tools/tools_intro.md @@ -27,18 +27,19 @@ Mbed OS 5 can be built with various toolchains. The currently supported versions ##### Arm Mbed Online Compiler -The Mbed Online Compiler is our in-house IDE and should be familiar to anyone who's been working with Mbed for a while. It switches the backing toolchain based on the architecture version as in the table below. +The Mbed Online Compiler is our in-house IDE, and should be familiar to anyone who's been working with Mbed for a while. It switches the backing toolchain based on the architecture version as in the table below. + | Architecture version | Compiler | |---- |---- | -| Arm v6M | `Arm Compiler 6.11` or `Arm Compiler 5.06 update 6` based on the Arm toolchain supported by the target (see `supported_toolchains` in [Adding and configuring targets](../reference/configuration/mbed_targets.html)) | -| Arm v7M | `Arm Compiler 6.11` or `Arm Compiler 5.06 update 6` based on the Arm toolchain supported by the target (see `supported_toolchains` in [Adding and configuring targets](../reference/configuration/mbed_targets.html)) | +| Arm v6M | `Arm Compiler 6.11` or `Arm Compiler 5.06 update 6` based on the ARM toolchain supported by the target (see `supported_toolchains` in [Adding and configuring targets](../reference/configuration/mbed_targets.html#)) | +| Arm v7M | `Arm Compiler 6.11` or `Arm Compiler 5.06 update 6` based on the ARM toolchain supported by the target (see `supported_toolchains` in [Adding and configuring targets](../reference/configuration/mbed_targets.html#)) | | Arm v7A | `Arm Compiler 6.11` | | Arm v8M | `Arm Compiler 6.11` | For more information, please see the [Online Compiler page](developing-mbed-online-compiler.html). - **Note:** With Mbed-OS 5.12 release, ARM Compiler 6 will be the default ARM toolchain for all Mbed OS targets. Majority of Mbed OS targets/platforms are already compatible with ARM Compiler 6. Few targets currently using/supporting ARM Compiler 5 will also be migrated to ARM Compiler in future. Please be aware that all new/existing Mbed OS targets/developers must use ARM Compiler 6 for future development as all source code contributions to Mbed OS will be validated with ARM Compiler 6. + **Note:** With Mbed-OS 5.12 release, ARM Compiler 6 will be the default ARM toolchain for all Mbed OS targets. Majority of Mbed OS targets/platforms are already compatible with ARM Compiler 6. Few targets currently using/supporting ARM Compiler 5 will also be migrated to ARM Compiler in future. Please be aware that all new/existing Mbed OS targets/developers must use ARM Compiler 6 for future development and all code contributions to Mbed OS will be validated with ARM Compiler 6. ##### Third party development tools From 1a712b21bd1158ad67e2c8763f2701cd7b0b74df Mon Sep 17 00:00:00 2001 From: Amanda Butler Date: Mon, 25 Feb 2019 17:28:35 -0600 Subject: [PATCH 4/9] Edit tools_intro.md Make minor edits to include articles for consistency. --- docs/tools/tools_intro.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/tools/tools_intro.md b/docs/tools/tools_intro.md index 43e023f040..596f029f6a 100644 --- a/docs/tools/tools_intro.md +++ b/docs/tools/tools_intro.md @@ -27,8 +27,7 @@ Mbed OS 5 can be built with various toolchains. The currently supported versions ##### Arm Mbed Online Compiler -The Mbed Online Compiler is our in-house IDE, and should be familiar to anyone who's been working with Mbed for a while. It switches the backing toolchain based on the architecture version as in the table below. - +The Mbed Online Compiler is our in-house IDE and should be familiar to anyone who's been working with Mbed for a while. It switches the backing toolchain based on the architecture version as in the table below. | Architecture version | Compiler | |---- |---- | From b228691b0774333e730e0b10930c41f6fa66cbeb Mon Sep 17 00:00:00 2001 From: Amanda Butler Date: Mon, 25 Feb 2019 17:31:40 -0600 Subject: [PATCH 5/9] Update mbed_targets.md Edit file for minor formatting. --- docs/reference/configuration/mbed_targets.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/reference/configuration/mbed_targets.md b/docs/reference/configuration/mbed_targets.md index 2453ae36de..4d3909ba25 100644 --- a/docs/reference/configuration/mbed_targets.md +++ b/docs/reference/configuration/mbed_targets.md @@ -193,9 +193,12 @@ Enabling `is_disk_virtual` adds delay after flashing firmware binary to make sur #### supported_toolchains The `supported_toolchains` property is the list of toolchains that support a target. The allowed values for `supported_toolchains` are `ARM`, `uARM`, `ARMC5`, `ARMC6`, `GCC_ARM` and `IAR`. -If you specify `ARMC5` in `supported_toolchains` it means the corresponding target supports `Arm Compiler 5.06 update 6`. -If a target lists both ARMC5 and ARM(or ARMC6) in `supported_toolchains`, the ARM Compiler 6.11 will be used when compiling with `ARM` option for `--toolchain`. -Note that although you can specify `ARMC5` in `supported_toolchains` in `targets.json`, it's not a valid option for `--toolchain` when compiling using [Mbed CLI](../tools/developing-mbed-cli.html). + +If you specify `ARMC5` in `supported_toolchains`, it means the corresponding target supports `Arm Compiler 5.06 update 6`. + +If a target lists both ARMC5 and ARM (or ARMC6) in `supported_toolchains`, the ARM Compiler 6.11 will be used when compiling with `ARM` option for `--toolchain`. + +**Note:** Although you can specify `ARMC5` in `supported_toolchains` in `targets.json`, it's not a valid option for `--toolchain` when compiling using [Mbed CLI](../tools/developing-mbed-cli.html). #### default_toolchain @@ -433,4 +436,4 @@ The `orphans` command shows all targets that you cannot reach from a public targ ### Related content -- [Developing: Mbed CLI](../tools/developing-mbed-cli.html) \ No newline at end of file +- [Developing: Mbed CLI](../tools/developing-mbed-cli.html). From ff3f92f5458687aa9c8ea3f51e9493808b7447e3 Mon Sep 17 00:00:00 2001 From: Amanda Butler Date: Mon, 25 Feb 2019 17:35:43 -0600 Subject: [PATCH 6/9] Edit mbed_targets.md Edit file for consistent capitalization and formatting. --- docs/reference/configuration/mbed_targets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/configuration/mbed_targets.md b/docs/reference/configuration/mbed_targets.md index 4d3909ba25..4f53ba6afc 100644 --- a/docs/reference/configuration/mbed_targets.md +++ b/docs/reference/configuration/mbed_targets.md @@ -196,7 +196,7 @@ The `supported_toolchains` property is the list of toolchains that support a tar If you specify `ARMC5` in `supported_toolchains`, it means the corresponding target supports `Arm Compiler 5.06 update 6`. -If a target lists both ARMC5 and ARM (or ARMC6) in `supported_toolchains`, the ARM Compiler 6.11 will be used when compiling with `ARM` option for `--toolchain`. +If a target lists both `ARMC5` and `ARM` (or `ARMC6`) in `supported_toolchains`, the Arm Compiler 6.11 will be used when compiling with `ARM` option for `--toolchain`. **Note:** Although you can specify `ARMC5` in `supported_toolchains` in `targets.json`, it's not a valid option for `--toolchain` when compiling using [Mbed CLI](../tools/developing-mbed-cli.html). From b0b086bc7de2c4fce74596c0e01284246062679d Mon Sep 17 00:00:00 2001 From: Senthil Ramakrishnan Date: Thu, 28 Feb 2019 15:12:08 -0600 Subject: [PATCH 7/9] Added section mentioning ARMC6 as the default ARM toolchains --- docs/reference/configuration/mbed_targets.md | 4 +++- docs/tools/tools_intro.md | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/reference/configuration/mbed_targets.md b/docs/reference/configuration/mbed_targets.md index 4f53ba6afc..1e1a42de59 100644 --- a/docs/reference/configuration/mbed_targets.md +++ b/docs/reference/configuration/mbed_targets.md @@ -198,7 +198,9 @@ If you specify `ARMC5` in `supported_toolchains`, it means the corresponding tar If a target lists both `ARMC5` and `ARM` (or `ARMC6`) in `supported_toolchains`, the Arm Compiler 6.11 will be used when compiling with `ARM` option for `--toolchain`. -**Note:** Although you can specify `ARMC5` in `supported_toolchains` in `targets.json`, it's not a valid option for `--toolchain` when compiling using [Mbed CLI](../tools/developing-mbed-cli.html). +**Note:** Although you can specify `ARMC5` in `supported_toolchains` in `targets.json`, it's not a valid option for `--toolchain` when compiling using [Mbed CLI](../tools/developing-mbed-cli.html). +With Mbed-OS 5.12 release, ARM Compiler 6 will be the default ARM toolchain for Mbed-OS developmet. Majority of Mbed OS targets/platforms are already compatible with ARM Compiler 6. Some existing targets still using/supporting ARM Compiler 5 will also be migrated to ARM Compiler 6 in future. Please be aware that all new/existing Mbed OS targets/developers must use ARM Compiler 6 for future development and all code contributions to Mbed OS will be validated with ARM Compiler 6. + #### default_toolchain diff --git a/docs/tools/tools_intro.md b/docs/tools/tools_intro.md index 596f029f6a..addcd63e99 100644 --- a/docs/tools/tools_intro.md +++ b/docs/tools/tools_intro.md @@ -38,7 +38,7 @@ The Mbed Online Compiler is our in-house IDE and should be familiar to anyone wh For more information, please see the [Online Compiler page](developing-mbed-online-compiler.html). - **Note:** With Mbed-OS 5.12 release, ARM Compiler 6 will be the default ARM toolchain for all Mbed OS targets. Majority of Mbed OS targets/platforms are already compatible with ARM Compiler 6. Few targets currently using/supporting ARM Compiler 5 will also be migrated to ARM Compiler in future. Please be aware that all new/existing Mbed OS targets/developers must use ARM Compiler 6 for future development and all code contributions to Mbed OS will be validated with ARM Compiler 6. + **Note:** With Mbed-OS 5.12 release, ARM Compiler 6 will be the default ARM toolchain for Mbed-OS developmet. Majority of Mbed OS targets/platforms are already compatible with ARM Compiler 6. Some existing targets still using/supporting ARM Compiler 5 will also be migrated to ARM Compiler 6 in future. Please be aware that all new/existing Mbed OS targets/developers must use ARM Compiler 6 for future development and all code contributions to Mbed OS will be validated with ARM Compiler 6. ##### Third party development tools From 4fcbf4b4fd7f6d7a6a8e7e7f4fb669258ed760b4 Mon Sep 17 00:00:00 2001 From: Amanda Butler Date: Thu, 28 Feb 2019 16:29:19 -0600 Subject: [PATCH 8/9] Edit addition to tools_intro.md Edit note, mostly for branding and brevity. --- docs/tools/tools_intro.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tools/tools_intro.md b/docs/tools/tools_intro.md index addcd63e99..cd31c66e2b 100644 --- a/docs/tools/tools_intro.md +++ b/docs/tools/tools_intro.md @@ -27,7 +27,7 @@ Mbed OS 5 can be built with various toolchains. The currently supported versions ##### Arm Mbed Online Compiler -The Mbed Online Compiler is our in-house IDE and should be familiar to anyone who's been working with Mbed for a while. It switches the backing toolchain based on the architecture version as in the table below. +The Mbed Online Compiler is our in-house IDE and should be familiar to anyone who's been working with Mbed for a while. It switches the backing toolchain based on the architecture version: | Architecture version | Compiler | |---- |---- | @@ -38,7 +38,7 @@ The Mbed Online Compiler is our in-house IDE and should be familiar to anyone wh For more information, please see the [Online Compiler page](developing-mbed-online-compiler.html). - **Note:** With Mbed-OS 5.12 release, ARM Compiler 6 will be the default ARM toolchain for Mbed-OS developmet. Majority of Mbed OS targets/platforms are already compatible with ARM Compiler 6. Some existing targets still using/supporting ARM Compiler 5 will also be migrated to ARM Compiler 6 in future. Please be aware that all new/existing Mbed OS targets/developers must use ARM Compiler 6 for future development and all code contributions to Mbed OS will be validated with ARM Compiler 6. + **Note:** Arm Compiler 6 is the default ARM toolchain for Mbed OS developmet. Most Mbed OS platforms are already compatible with Arm Compiler 6. Some existing targets still supporting Arm Compiler 5 will also be migrated to ARM Compiler 6 in the future. Please be aware that you must use Arm Compiler 6 for future development, and we will validate all code contributions to Mbed OS with Arm Compiler 6. ##### Third party development tools From 311b78125a5ba096135c74f727e16094c2b7ef38 Mon Sep 17 00:00:00 2001 From: Amanda Butler Date: Thu, 28 Feb 2019 16:32:01 -0600 Subject: [PATCH 9/9] Edit addition to mbed_targets.md Edit note, mostly for branding and active voice. --- docs/reference/configuration/mbed_targets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/configuration/mbed_targets.md b/docs/reference/configuration/mbed_targets.md index 1e1a42de59..b7b0d146e9 100644 --- a/docs/reference/configuration/mbed_targets.md +++ b/docs/reference/configuration/mbed_targets.md @@ -199,7 +199,7 @@ If you specify `ARMC5` in `supported_toolchains`, it means the corresponding tar If a target lists both `ARMC5` and `ARM` (or `ARMC6`) in `supported_toolchains`, the Arm Compiler 6.11 will be used when compiling with `ARM` option for `--toolchain`. **Note:** Although you can specify `ARMC5` in `supported_toolchains` in `targets.json`, it's not a valid option for `--toolchain` when compiling using [Mbed CLI](../tools/developing-mbed-cli.html). -With Mbed-OS 5.12 release, ARM Compiler 6 will be the default ARM toolchain for Mbed-OS developmet. Majority of Mbed OS targets/platforms are already compatible with ARM Compiler 6. Some existing targets still using/supporting ARM Compiler 5 will also be migrated to ARM Compiler 6 in future. Please be aware that all new/existing Mbed OS targets/developers must use ARM Compiler 6 for future development and all code contributions to Mbed OS will be validated with ARM Compiler 6. +Arm Compiler 6 is the default ARM toolchain for Mbed OS developmet. Most Mbed OS platforms are already compatible with Arm Compiler 6. Some existing targets still supporting Arm Compiler 5 will be migrated to Arm Compiler 6 in the future. Please be aware that you must use Arm Compiler 6 for future development, and we will validate all code contributions to Mbed OS Arm Compiler 6. #### default_toolchain