Skip to content

Commit ddc34c5

Browse files
committed
Update Keil Studio for VS Code install guide
1 parent ae26212 commit ddc34c5

4 files changed

Lines changed: 47 additions & 58 deletions

File tree

6.93 KB
Loading
26.8 KB
Loading
Lines changed: 24 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
2-
### Title the install tools article with the name of the tool to be installed
3-
### Include vendor name where appropriate
42
title: Arm Keil Studio for VS Code
53

6-
### Optional additional search terms (one per line) to assist in finding the article
74
additional_search_terms:
85
- cortex-m
96
- microcontroller
@@ -15,61 +12,57 @@ additional_search_terms:
1512
- visual studio
1613
- cmsis
1714

18-
19-
### Estimated completion time in minutes (please use integer multiple of 5)
2015
minutes_to_complete: 15
2116

2217
author: Ronan Synnott
2318

24-
### Link to official documentation
2519
official_docs: https://developer.arm.com/documentation/108029
2620

27-
### PAGE SETUP
28-
weight: 1 # Defines page ordering. Must be 1 for first (or only) page.
29-
tool_install: true # Set to true to be listed in main selection page, else false
30-
multi_install: false # Set to true if first page of multi-page article, else false
31-
multitool_install_part: false # Set to true if a sub-page of a multi-page article, else false
32-
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
21+
weight: 1
22+
tool_install: true
23+
multi_install: false
24+
multitool_install_part: false
25+
layout: installtoolsall
3326
---
3427
[Arm Keil Studio](https://keil.arm.com/) is the next generation software development environment for Arm Cortex-M based microcontroller devices. The desktop version is available as a set of [Visual Studio Code](https://code.visualstudio.com/) extensions.
3528

3629
Alternatively, [Keil Studio Cloud](/install-guides/keilstudiocloud/) provides similar functionality, but runs in a browser and requires no installation.
3730

38-
## Where can I download Visual Studio Code?
31+
## Download and install Visual Studio Code
3932

40-
[Download](https://code.visualstudio.com/download), install, and start `Visual Studio Code` on your desktop.
33+
[Download](https://code.visualstudio.com/download), install, and start Visual Studio Code on your desktop.
4134

4235
Linux, macOS, and Windows are supported.
4336

44-
## How do I install the Keil Studio extensions?
37+
## Install the Keil Studio extensions
4538

46-
The `Keil Studio Pack` extensions is available on the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Arm.keil-studio-pack).
39+
The **Keil Studio Pack** extension is available on the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Arm.keil-studio-pack).
4740

4841
Install the Keil Studio extensions:
4942

50-
1. Open the `Extensions` view in Visual Studio Code
51-
2. Search for `Keil Studio Pack`
52-
3. Click the `Install` button to install all extensions in the `Keil Studio Pack`
43+
1. Open the **Extensions** view in Visual Studio Code
44+
2. Search for **Keil Studio Pack**
45+
3. Select the **Install** button to install all extensions in the **Keil Studio Pack**
5346

54-
Visual Studio Code installs the extensions. The extensions are now available in the `Activity Bar`.
47+
![The Keil Studio Pack extension shown in the VS Code Extensions marketplace view, with the Arm publisher name and Install button visible#center](/install-guides/_images/ks-extension.webp "Keil Studio Pack in the VS Code Extensions marketplace")
5548

56-
You will be prompted to enable an [MDK Community License](https://www.keil.arm.com/mdk-community/) for non-commercial use. Accept this option if you do not have a license and agree to non-commercial use.
49+
## Verify the installation
5750

58-
If you have a commercial license for `Keil MDK` installed, decline this option.
51+
After installation, the Keil Studio icons appear in the **Activity Bar** on the left side of VS Code.
5952

60-
## How do I get started?
53+
![VS Code Activity Bar showing the Keil Studio extension icons after successful installation of the Keil Studio Pack#center](/install-guides/_images/ks-installed.webp "Keil Studio extensions visible in the VS Code Activity Bar")
6154

62-
Follow the [Getting started with an example project](https://developer.arm.com/documentation/108029/latest/Get-started-with-an-example-project) tutorial to verify the extensions are installed correctly.
55+
To verify the extensions are working correctly, follow the [Work with CMSIS solutions](https://mdk-packs.github.io/vscode-cmsis-solution-docs/create_app.html#) tutorial.
6356

64-
## Where can I find more information about the Keil Studio extensions?
57+
## More information
6558

6659
Use the table below to find additional information about the VS Code extensions.
6760

6861
| Extension | Description |
6962
|-----------|-------------|
70-
| [Arm CMSIS csolution](https://github.com/ARM-software/vscode-cmsis-csolution/blob/main/README.md) | provides support for working with CMSIS solutions (csolution projects).|
71-
| [Arm Device Manager](https://github.com/ARM-software/vscode-device-manager/blob/main/README.md) | allows you to manage device connections for Arm Cortex-M based microcontrollers, development boards and debug probes.|
72-
| [Arm Embedded Debugger](https://github.com/ARM-software/vscode-embedded-debug/blob/main/README.md) | allows you to do flashing and debugging on Arm Cortex-M targets implementing the Microsoft Debug Adapter Protocol (DAP). |
73-
| [Arm Remote Build](https://github.com/ARM-software/vscode-remote-build/blob/main/README.md) | allows you to undertake remote builds of projects for Arm Cortex-M targets. |
74-
| [Arm Virtual Hardware](https://github.com/ARM-software/vscode-virtual-hardware/blob/main/README.md) | allows you to manage Arm Virtual Hardware and run embedded applications on them. |
75-
| [Keil Studio Pack](https://github.com/ARM-software/vscode-keil-studio-pack/blob/main/README.md) | installs recommended extensions for embedded and IoT software development on Arm-based microcontroller (MCU) devices. |
63+
| [Arm CMSIS csolution](https://github.com/ARM-software/vscode-cmsis-csolution/blob/main/README.md) | Provides support for working with CMSIS solutions (csolution projects). |
64+
| [Arm Device Manager](https://github.com/ARM-software/vscode-device-manager/blob/main/README.md) | Allows you to manage device connections for Arm Cortex-M based microcontrollers, development boards and debug probes. |
65+
| [Arm Embedded Debugger](https://github.com/ARM-software/vscode-embedded-debug/blob/main/README.md) | Allows you to do flashing and debugging on Arm Cortex-M targets implementing the Microsoft Debug Adapter Protocol (DAP). |
66+
| [Arm Remote Build](https://github.com/ARM-software/vscode-remote-build/blob/main/README.md) | Allows you to undertake remote builds of projects for Arm Cortex-M targets. |
67+
| [Arm Virtual Hardware](https://github.com/ARM-software/vscode-virtual-hardware/blob/main/README.md) | Allows you to manage Arm Virtual Hardware and run embedded applications on them. |
68+
| [Keil Studio Pack](https://github.com/ARM-software/vscode-keil-studio-pack/blob/main/README.md) | Installs recommended extensions for embedded and IoT software development on Arm-based microcontroller (MCU) devices. |

content/learning-paths/embedded-and-microcontrollers/cmsis_rtx_vs/create.md

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,31 @@ weight: 2 # 1 is first, 2 is second, etc.
77
# Do not modify these elements
88
layout: "learningpathall"
99
---
10-
This learning path will introduce the steps to create a basic RTX-based RTOS application using the latest features of [CMSIS](https://www.keil.arm.com/cmsis).
10+
You'll create a basic RTX-based RTOS application using [CMSIS](https://www.keil.arm.com/cmsis) and [Keil Studio for VS Code](/install-guides/keilstudio_vs/).
1111

12-
For more information on the latest update, see the [CMSIS v6 is here](https://community.arm.com/arm-community-blogs/b/tools-software-ides-blog/posts/cmsis-v6-is-here) blog.
13-
14-
You'll use **[Keil Studio for VS Code](/install-guides/keilstudio_vs/)** in this Learning Path.
15-
16-
This Learning Path is written for the supplied **Cortex-M4 Fixed Virtual Platform (FVP)**, but you can run it on any of the 10,000+ devices supported by [CMSIS-Pack](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html/).
12+
The steps use the **Cortex-M4 Fixed Virtual Platform (FVP)**, but you can follow along with any of the 10,000+ devices supported by [CMSIS-Pack](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html/).
1713

1814
{{% notice Note%}}
1915
If using `Arm Keil μVision IDE` or Arm Development Studio, refer to the [Build an RTX5 RTOS application with Keil μVision](/learning-paths/embedded-and-microcontrollers/cmsis_rtx/) guide.
2016
{{% /notice %}}
2117

22-
## Create a New Project
18+
## Create a new project
2319

2420
Keil Studio projects are based on the [CMSIS Solution](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/YML-Input-Format.md) standard.
2521

26-
1. Open the VS Code IDE, and select `File` > `New File` from the `File` menu. You'll be prompted for the type of file. Select `New Solution` (`Arm CMSIS Solution`).
27-
2. The `Create New Solution` window will open. Click the `Target Device` pulldown, and search for `ARMCM4`.
28-
3. From the `Templates, Reference Applications, and Examples` pulldown, select `Blank Solution`.
29-
4. Ensure `Arm Compiler 6` is the selected compiler.
30-
5. Enter an appropriate `Solution Name`. This will define the folder name that the project will be created into. You can also change the folder location if necessary.
31-
6. Click `Create`. You'll be prompted to open the solution in the current window, or open a new window.
22+
1. Open VS Code and select **File** > **New File**. When prompted for the file type, select **New Solution** (**Arm CMSIS Solution**).
23+
2. The **Create New Solution** dialog opens. Select the **Target Device** drop-down and search for `ARMCM4`.
24+
3. From the **Templates, Reference Applications, and Examples** drop-down, select **Blank Solution**.
25+
4. Ensure **Arm Compiler 6** is the selected compiler.
26+
5. Enter an appropriate **Solution Name**. This defines the folder name the project is created into. You can also change the folder location if necessary.
27+
6. Select **Create**. You'll be prompted to open the solution in the current window or a new window.
3228

33-
## Configure the Solution Environment
29+
## Configure the solution environment
3430

3531
VS Code allows complete configurability of all aspects of the project.
3632

3733
- Locate `vcpkg-configuration.json` within the project. This file defines the components used.
38-
- Right-click on this file, and select `Configure Arm Tools Environment` to open the configuration panel.
34+
- Right-click on this file and select **Configure Arm Tools Environment** to open the configuration panel.
3935

4036
From the dropdown menus, make sure to select the most up-to-date versions of the following:
4137

@@ -52,30 +48,30 @@ If you open `vcpkg-configuration.json` in the text editor, you’ll see these se
5248

5349
All necessary components will be downloaded and installed as necessary (if not already installed).
5450

55-
## Configure CMSIS Options
51+
## Configure CMSIS options
5652

5753
1. Select **CMSIS** from the Extensions icon list in VS Code. You'll see the project structure.
58-
2. Hover over the top-level project and click **Manage Software Components** to add CMSIS Software Packs to your project.
54+
2. Hover over the top-level project and select **Manage Software Components** to add CMSIS software packs to your project.
5955

6056
Enable the following components:
6157
* `CMSIS > Core`
6258
* `CMSIS > OSTick > SysTick`
6359
* `CMSIS > RTOS2 > Keil RTX`
6460
* `Device > Startup`
6561

66-
You may need to select `Software packs: All packs` from the pull down.
62+
You may need to select **Software packs: All packs** from the drop-down.
6763

68-
If prompted in the `Validation` pane, select the latest available version for each. Use the `CMSIS-RTX` pack if others are shown.
64+
If prompted in the **Validation** pane, select the latest available version for each. Use the `CMSIS-RTX` pack if others are shown.
6965

7066
Close this view to save.
7167

72-
## Define the Memory Map
68+
## Define the memory map
7369

7470
Use [scatter-loading](https://developer.arm.com/documentation/101754/latest/armlink-Reference/Scatter-loading-Features/The-scatter-loading-mechanism/Overview-of-scatter-loading) to define the memory map to the linker.
7571

7672
The memory map for the FVP is given in the [documentation](https://developer.arm.com/documentation/100964/latest/Microcontroller-Prototyping-System-2/MPS2---memory-maps/MPS2---memory-map-for-models-without-the-Armv8-M-additions).
7773

78-
The project should be configured to use `ARMCM4_ac6.sct` as the scatter file. Locate this file in the CMSIS Extension view, and click to create.
74+
The project should be configured to use `ARMCM4_ac6.sct` as the scatter file. Locate this file in the CMSIS Extension view and select it to create.
7975

8076
Populate with the following.
8177

@@ -95,15 +91,15 @@ LOAD 0x0 0x400000 {
9591
}
9692
```
9793

98-
## Configure Debug with the FVP
94+
## Configure debug with the FVP
9995

100-
1. Select `Run and Debug` from the Extensions icon list.
101-
2. Click the gear icon to open `launch.json`. This is the file that defines the debug instance.
102-
3. Right-click on `launch.json` and select `Open Run and Debug Configuration`.
96+
1. Select **Run and Debug** from the Extensions icon list.
97+
2. Select the gear icon to open `launch.json`. This file defines the debug instance.
98+
3. Right-click on `launch.json` and select **Open Run and Debug Configuration**.
10399

104-
From the `Selected Configuration` pull-down, select `New Configuration` > `Launch FVP`. Edit the `Configuration Name` if desired.
100+
From the **Selected Configuration** drop-down, select **New Configuration** > **Launch FVP**. Edit the **Configuration Name** if desired.
105101

106-
From the `Target` > `Configuration Database Entry` pull-down, select `MPS2_Cortex_M4` > `Cortex-M4`.
102+
From the **Target** > **Configuration Database Entry** drop-down, select **MPS2_Cortex_M4** > **Cortex-M4**.
107103

108104
Leave other fields as default. Observe that `launch.json` has been updated.
109105

0 commit comments

Comments
 (0)