Skip to content

Commit f4e86ae

Browse files
Documentation update (#42)
- update links - some clean-up
1 parent 5461556 commit f4e86ae

4 files changed

Lines changed: 30 additions & 31 deletions

File tree

Documentation/Doxygen/src/DV_SPI.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ create a new solution from **template**:
151151
7. Build and run the **SPI Server application** on your hardware.
152152

153153
\note **IMPORTANT:** The target board's SPI CMSIS-Driver must be **fully CMSIS compliant**!
154-
\note The SPI Server for **build-type: Debug** displays command execution on an STDOUT channel (typically Virtual COM port via Debug adapter).
154+
\note The SPI Server for **build-type: Debug** displays command execution on an STDOUT channel (typically Virtual COM Port via Debug adapter).
155155

156156
\section spi_server_troubleshooting Troubleshooting
157157

Documentation/Doxygen/src/DV_USART.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ create a new solution from **template**:
166166
7. Build and run the **USART Server application** on your hardware.
167167

168168
\note **IMPORTANT:** The target board's USART CMSIS-Driver must be **fully CMSIS compliant**!
169-
\note The USART Server for **build-type: Debug** displays command execution on an STDOUT channel (typically Virtual COM port via Debug adapter).
169+
\note The USART Server for **build-type: Debug** displays command execution on an STDOUT channel (typically Virtual COM Port via Debug adapter).
170170

171171
\section usart_server_troubleshooting Troubleshooting
172172

Documentation/Doxygen/src/DV_USBD.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ tests of all available examples:
7575
- USB MSC: Send a long file to the mass storage device and read it back and compare the output.
7676
- USB HID: Use the HID Client (available in the MDK installation directory below \\ARM\\Utilities\\HID_Client\\Release) to
7777
see how the device works under stress.
78-
- USB CDC (Virtual COM): Send a large file on the Virtual COM port and capture it on the UART and vice versa. Compare sent
78+
- USB CDC (Virtual COM): Send a large file on the Virtual COM Port and capture it on the UART and vice versa. Compare sent
7979
and received files for both directions.
8080
- USB ADC: Play a sound file form the board for some time and listen for any sound distortion. Record sounds coming from
8181
a microphone and verify the recorded file on the USB Host.

Documentation/Doxygen/src/DriverValidation.txt

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
/**
33
\mainpage Overview
44

5-
This manual explains the scope and the usage of the <b>CMSIS-Driver Validation</b> framework. This is a test suite that helps developers to verify that an implementation of a peripheral driver is compliant with the corresponding **[CMSIS-Driver Specification](https://arm-software.github.io/CMSIS_5/Driver/html/index.html)**. Verified drivers can then be reliably used with middleware components and user applications that rely on CMSIS-Driver APIs.
5+
This manual explains the scope and the usage of the <b>CMSIS-Driver Validation</b> framework. This is a test suite that helps developers to verify that an implementation of a peripheral driver is compliant with the corresponding [**CMSIS-Driver Specification**](https://arm-software.github.io/CMSIS_6/latest/Driver/index.html). Verified drivers can then be reliably used with middleware components and user applications that rely on CMSIS-Driver APIs.
66

7-
The CMSIS-Driver Validation is maintained in a public **[GitHub repository](https://github.com/ARM-software/CMSIS-Driver_Validation)**. Its releases in **[CMSIS Pack format](https://www.open-cmsis-pack.org/)** are also available on **[CMSIS Packs page](https://developer.arm.com/tools-and-software/embedded/cmsis/cmsis-packs)** under *Arm* - *CMSIS Driver Validation* category and can be used in environments supporting the CMSIS-Pack concept.
7+
The CMSIS-Driver Validation is maintained in a public [**GitHub repository**](https://github.com/ARM-software/CMSIS-Driver_Validation). Its releases in [**CMSIS Pack format**](https://www.open-cmsis-pack.org/) are also available on [**CMSIS Packs page**](https://developer.arm.com/tools-and-software/embedded/cmsis/cmsis-packs) under *Arm* - *CMSIS Driver Validation* category and can be used in environments supporting the CMSIS-Pack concept.
88

99
The CMSIS-Driver Validation framework provides:
1010
- Configurable validation tests for various CMSIS-Driver interfaces
@@ -19,8 +19,8 @@ The CMSIS-Driver Validation tests and verifies:
1919
- <b>Transfer speed</b> of the data communication with time measurement of data transfer duration
2020
- <b>Event</b> signaling
2121

22-
The CMSIS-Driver Validation requires
23-
<a href="https://arm-software.github.io/CMSIS_5/RTOS2/html/index.html" target="_blank">CMSIS-RTOS2</a> functionality and can be used to verify the setup and configuration of the CMSIS-Driver interfaces in a user system.
22+
The CMSIS-Driver Validation requires [**CMSIS-RTOS2**](https://arm-software.github.io/CMSIS_6/latest/RTOS2/index.html) functionality
23+
and can be used to verify the setup and configuration of the CMSIS-Driver interfaces in a user system.
2424

2525
The diagram below shows an overview of the CMSIS-Driver Validation configuration.
2626

@@ -38,19 +38,20 @@ The CMSIS-Driver Validation provides validation for the following interfaces:
3838
- \ref dv_usbh "USB Host" - Universal Serial Bus (USB) Host interface driver.
3939
- \ref dv_wifi "WiFi" - WiFi (Wireless Fidelity Interface) module/shield driver.
4040

41-
\note Extensive testing using dedicated Server is available for SPI and USART drivers.
41+
\note Extensive testing using dedicated Server is available for **SPI**, **USART** and **WiFi** drivers.
4242

43-
This manual assumes that you are familiar with MDK. Refer to
44-
<a href="https://developer.arm.com/documentation/KGS1" target="_blank">MDK Version 5 - Getting Started</a> for additional information.
43+
This manual assumes that you are familiar with MDK.
44+
Refer to [**MDK Version 5 - Getting Started**](https://developer.arm.com/documentation/KGS1) for additional information.
4545

4646
\section doc_structure Document structure
4747

4848
This manual contains the following chapters:
49+
- \ref rev_hist - Contains revision history information.
4950
- \ref setup - Describes the general setup of the CMSIS-Driver Validation test and how to generate test report.
5051
- \ref report - Describes the reports produced by the CMSIS-Driver Validation.
5152
- \ref debugging - Describes procedure for debugging of the interface drivers using the CMSIS-Driver Validation.
5253
- \ref resource_requirements - Lists memory and CMSIS-RTOS2 requirements.
53-
- \ref examples - Contains information about several example projects including the required hardware setup.
54+
- \ref examples - Contains information about several example projects.
5455
- <a class="el" href="./topics.html">Reference</a> - Explains the configuration and tests for the various CMSIS-Driver interfaces.
5556

5657
\section License License
@@ -70,7 +71,7 @@ The table below provides information about the changes delivered with specific v
7071
/**
7172
\page setup Setup
7273

73-
Using the [Arm CMSIS Solution](https://marketplace.visualstudio.com/items?itemName=Arm.cmsis-csolution) VS Code extension,
74+
Using the [**Arm CMSIS Solution**](https://marketplace.visualstudio.com/items?itemName=Arm.cmsis-csolution) VS Code extension,
7475
create a new solution from **template**:
7576

7677
## Step 1: In the **CMSIS** extension, click **Create a New Solution**.
@@ -111,20 +112,20 @@ For validation configuration of specific driver check respective driver document
111112
For the interfaces that support loopback testing: \ref dv_eth "Ethernet", \ref dv_usart "USART" and \ref dv_spi "SPI",
112113
connect the following pins on your target hardware together (refer to the hardware schematics):
113114

114-
- Ethernet: RX+ and TX+, RX- and TX-
115-
- USART: RX and TX
116-
- SPI: MOSI and MISO
115+
- **Ethernet**: **RX+** and **TX+**, **RX-** and **TX-**
116+
- **USART**: **RX** and **TX**
117+
- **SPI**: **MOSI** and **MISO**
117118

118119
For the interfaces that support testing with dedicated server: \ref dv_wifi "WiFi", \ref dv_spi "SPI" and \ref dv_usart "USART"
119120
connect the related hardware as required by the related server:
120121

121-
- WiFi: WiFi module has to be in close proximity to the Access Point which is in the same network as the required \ref wifi_sock_setup
122-
- SPI: MOSI, MISO, SCLK, SS, GND to the same lines on the \ref spi_server
123-
- USART: Tx, Rx, GND and optionally CLK, CTS, RTS, DCD and RI lines as described in \ref usart_server
122+
- **USART**: **Tx**, **Rx**, **GND** and optionally CLK, CTS, RTS, DCD and RI lines as described in \ref usart_server
123+
- **SPI**: **MOSI**, **MISO**, **SCLK**, **SS**, **GND** to the same lines on the \ref spi_server
124+
- **WiFi**: WiFi module has to be in close proximity to the Access Point which is in the same network as the required \ref wifi_sock_setup
124125

125126
## Step 9: Build and Run the application
126127

127-
Example below shows output results (in STDOUT channel) of an Ethernet driver testing:
128+
Example below shows output results (in STDOUT channel) of an **Ethernet driver testing** :
128129
\verbatim
129130
CMSIS-Driver_Validation v3.1.0 CMSIS-Driver ETH Test Report Oct 9 2025 07:30:34
130131

@@ -179,9 +180,9 @@ Test Result: PASSED
179180

180181
The CMSIS-Driver Validation outputs the test report in a <b>Plain Text</b> format.
181182

182-
This report can be viewed using the <b>Debug (printf) Viewer</b> window or any terminal application.
183+
This report can be viewed on <b>STDOUT channel</b> (usually Virtual COM Port via Debug adapter).
183184

184-
An example of a report captured in a terminal application is shown below:
185+
A GPIO driver validation example report captured in a terminal application is shown below:
185186
\verbatim
186187
CMSIS-Driver_Validation v3.1.0 CMSIS-Driver GPIO Test Report Oct 9 2025 09:15:16
187188

@@ -319,21 +320,19 @@ Interface test modules that are not listed in the previous table do not use heap
319320
The system heap memory size must support the largest heap requirement of any used interface test module.<br>
320321
For example, if SPI driver testing is selected heap memory size should be set to at least 12 kB.
321322

322-
Suggested value for heap memory size is <b>16384</b> bytes.
323+
Suggested value for heap memory size is **16 kB**.
323324

324325
\note Each module contains additional settings in related configuration file which are not exposed through
325326
Configuration Wizard and impact the heap memory requirement.<br>
326327
If these values are changed please adjust heap memory size accordingly.
327328

328329
\section rtos2_req CMSIS-RTOS2
329330

330-
The thread requirements need to be reflected in the CMSIS-RTOS2 configuration. Refer to the
331-
<a class="el" href="https://arm-software.github.io/CMSIS_5/RTOS2/html/index.html" target="_blank">CMSIS-RTOS2 Reference</a> for further details.
331+
The thread requirements need to be reflected in the CMSIS-RTOS2 configuration.
332+
Refer to the [**CMSIS-RTOS2 documentation**](https://arm-software.github.io/CMSIS-RTX/latest/index.html) for further details.
332333

333-
For <a class="el" href="https://arm-software.github.io/CMSIS_5/RTOS2/html/rtx5_impl.html" target="_blank">CMSIS-RTOS2 RTX5</a>, thread
334-
requirements are configured in the
335-
<a class=el href="https://arm-software.github.io/CMSIS_5/RTOS2/html/config_rtx5.html" target="_blank">RTX_Config.h</a> file located
336-
under the \b CMSIS component class:
334+
For **CMSIS-RTOS2 RTX5**, thread requirements are configured in the
335+
[**RTX_Config.h**](https://arm-software.github.io/CMSIS-RTX/latest/config_rtx5.html) file :
337336

338337
| Option | Value |
339338
| :---------------------------------------------------------------- | :--------------------------------: |
@@ -347,14 +346,14 @@ under the \b CMSIS component class:
347346
/**
348347
\page examples Examples
349348

350-
The CMSIS-Driver Validation Software Pack contains a set of examples that show how to use the CMSIS-Driver Validation on
351-
a real hardware.<br>
349+
The CMSIS-Driver Validation Software Pack includes example projects that demonstrate how to use the CMSIS-Driver Validation on real hardware,
350+
providing a reference and comparison point for user validation projects.
352351

353352
Follow these steps to use the validation examples:
354353

355354
1. In the **CMSIS** extension, click **Create a New Solution**.
356355
2. Select the **Target Board** (**NUCLEO-H563ZI** for **Ethernet** example, **B-U585I-IOT02A** for **all other examples**).
357-
3. Under **Templates, Reference Applications, and Examples**, select **Driver Validation**.
356+
3. Under **Templates, Reference Applications, and Examples**, select desired **Driver Validation Example**.
358357
4. Choose **Solution Base Folder**, click **Create**.
359358
5. Setup the required hardware as described in the example's **README.md** file
360359
6. Build and Run the application

0 commit comments

Comments
 (0)