Skip to content

Commit ad8bb6c

Browse files
authored
Merge pull request #3109 from madeline-underwood/cmsi
Update documentation for CMSIS RTX learning path with improved phrasi…
2 parents 10658f3 + 320175e commit ad8bb6c

5 files changed

Lines changed: 9 additions & 8 deletions

File tree

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Build an RTX5 RTOS application with Keil Studio (VS Code)
33

4+
description: Learn how to create, configure, and debug an RTX5 RTOS application using Keil Studio for VS Code with CMSIS-RTOS2 API for embedded Cortex-M development.
45

56
minutes_to_complete: 30
67

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Choose the debug connection you configured earlier to launch the FVP (Fixed Virt
2121

2222
Use the debugging controls to step through your code.
2323

24-
Once the OS is initialized, you will see the output from the threads displayed in the `Debug Console`.
24+
Once the OS is initialized, you'll see the output from the threads displayed in the `Debug Console`.
2525

2626
```
2727
[model] hello from thread 1

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This learning path will introduce the steps to create a basic RTX-based RTOS app
1111

1212
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.
1313

14-
You will use **[Keil Studio for VS Code](/install-guides/keilstudio_vs)** in this Learning Path.
14+
You'll use **[Keil Studio for VS Code](/install-guides/keilstudio_vs)** in this Learning Path.
1515

1616
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/).
1717

@@ -23,12 +23,12 @@ If using `Arm Keil μVision IDE` or Arm Development Studio, refer to the [Build
2323

2424
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.
2525

26-
1. Open the VS Code IDE, and select `File` > `New File` from the `File` menu. You will be prompted for the type of file. Select `New Solution` (`Arm CMSIS Solution`).
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`).
2727
2. The `Create New Solution` window will open. Click the `Target Device` pulldown, and search for `ARMCM4`.
2828
3. From the `Templates, Reference Applications, and Examples` pulldown, select `Blank Solution`.
2929
4. Ensure `Arm Compiler 6` is the selected compiler.
3030
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 will be prompted to open the solution in the current window, or open a new window.
31+
6. Click `Create`. You'll be prompted to open the solution in the current window, or open a new window.
3232

3333
## Configure the Solution Environment
3434

@@ -54,7 +54,7 @@ All necessary components will be downloaded and installed as necessary (if not a
5454

5555
## Configure CMSIS Options
5656

57-
1. Select **CMSIS** from the Extensions icon list in VS Code. You will see the project structure.
57+
1. Select **CMSIS** from the Extensions icon list in VS Code. You'll see the project structure.
5858
2. Hover over the top-level project and click **Manage Software Components** to add CMSIS Software Packs to your project.
5959

6060
Enable the following components:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,6 @@ void thread(void *);
5454
```
5555
The argument for this function is provided as the second parameter of the [osThreadNew()](https://arm-software.github.io/CMSIS_6/latest/RTOS2/group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f) function. Use `NULL` if no argument to pass.
5656

57-
In the example above, `app_main` is used as the main application thread, but this naming is arbitrary. From here, you will spawn all other threads in the RTOS.
57+
In the example above, `app_main` is used as the main application thread, but this naming is arbitrary. From here, you'll spawn all other threads in the RTOS.
5858

5959
{{% notice %}} Tip: Naming the main application thread is flexible. Choose a name that clearly reflects its function. {{% /notice %}}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ weight: 4 # 1 is first, 2 is second, etc.
77
# Do not modify these elements
88
layout: "learningpathall"
99
---
10-
In this step, you will implement the main RTOS thread (`app_main`), which is primarily responsible for starting and managing the other threads in the system.
10+
In this step, you'll implement the main RTOS thread (`app_main`), which is primarily responsible for starting and managing the other threads in the system.
1111

12-
You will create three threads. The number and naming of the threads are flexible, so feel free to adjust as needed.
12+
You'll create three threads. The number and naming of the threads are flexible, so feel free to adjust as needed.
1313

1414
## Create the app_main() function
1515

0 commit comments

Comments
 (0)