Skip to content

Commit 450f986

Browse files
Minor documentation update (#39)
- convert non-ASCII characters to ASCII
1 parent c7649ea commit 450f986

2 files changed

Lines changed: 52 additions & 52 deletions

File tree

Documentation/Doxygen/src/DV_SPI.txt

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,20 @@ Example: to test `Driver_SPI2`, set this value to `2`.
2727
- Fixed parameters:
2828
- **Clock/Frame:** CPOL=0, CPHA=0
2929
- **Data Bits:** 8
30-
- **Bit Order:** MSB LSB
30+
- **Bit Order:** MSB to LSB
3131
- Configurable parameters:
32-
- **Slave Select** **Software Controlled** (driver toggles SS using `ARM_SPI_CONTROL_SS`) or **Hardware Controlled**.
33-
- **Bus Speed** nominal bus speed for reliable command exchange with the Server.
32+
- **Slave Select** - **Software Controlled** (driver toggles SS using `ARM_SPI_CONTROL_SS`) or **Hardware Controlled**.
33+
- **Bus Speed** - nominal bus speed for reliable command exchange with the Server.
3434

3535
- **Tests**: configuration for test execution.
36-
- **Default settings** defaults for data exchange tests (see \ref spi_tests_data_xchg).
37-
- **Bus Speed** minimum/maximum speeds used by \ref SPI_Bus_Speed_Min and \ref SPI_Bus_Speed_Max.
38-
- **Number of Items** item counts (including odd/unusual) used by \ref SPI_Number_Of_Items to verify conformance.
36+
- **Default settings** - defaults for data exchange tests (see \ref spi_tests_data_xchg).
37+
- **Bus Speed** - minimum/maximum speeds used by \ref SPI_Bus_Speed_Min and \ref SPI_Bus_Speed_Max.
38+
- **Number of Items** - item counts (including odd/unusual) used by \ref SPI_Number_Of_Items to verify conformance.
3939

40-
**Tests** section enable/disable test groups (and individual tests):
41-
- **Driver Management** see \ref spi_tests_drv_mgmt.
42-
- **Data Exchange** see \ref spi_tests_data_xchg.
43-
- **Event** see \ref spi_tests_evt.
40+
**Tests** section - enable/disable test groups (and individual tests):
41+
- **Driver Management** - see \ref spi_tests_drv_mgmt.
42+
- **Data Exchange** - see \ref spi_tests_data_xchg.
43+
- **Event** - see \ref spi_tests_evt.
4444

4545
*/
4646

@@ -77,26 +77,26 @@ Communication settings are defined in **SPI_Server_Config.h** file.
7777

7878
\subsection spi_server_config_detail Configuration settings
7979

80-
- **Driver_SPI#** selects the driver instance used by the Server.
80+
- **Driver_SPI#** - selects the driver instance used by the Server.
8181
- **Communication settings** (fixed for command exchange):
8282
- **Mode:** Slave with **hardware-monitored Slave Select**
8383
- **Clock/Frame:** Clock Polarity 0/ Clock Phase 0
8484
- **Data Bits:** 8
8585
- **Bit Order:** MSB to LSB
8686

87-
\note The SPI Server receives commands as an SPI **Slave** using the **Slave Select** line. The Servers SPI driver **must
87+
\note The SPI Server receives commands as an SPI **Slave** using the **Slave Select** line. The Server's SPI driver **must
8888
support hardware-monitored Slave Select** functionality.
8989

9090
\section spi_server_commands Commands
9191
Commands are human-readable (ASCII) for simpler analysis with an SPI bus analyzer.
9292

93-
- **GET VER** get Server version
94-
- **GET CAP** get capabilities (auto-detected)
95-
- **SET BUF** initialize Rx/Tx buffer content
96-
- **GET BUF** retrieve Rx/Tx buffer content
97-
- **SET COM** specify transfer configuration for the next **XFER**
98-
- **XFER** trigger a transfer
99-
- **GET CNT** retrieve number of transferred items in the last transfer
93+
- **GET VER** - get Server version
94+
- **GET CAP** - get capabilities (auto-detected)
95+
- **SET BUF** - initialize Rx/Tx buffer content
96+
- **GET BUF** - retrieve Rx/Tx buffer content
97+
- **SET COM** - specify transfer configuration for the next **XFER**
98+
- **XFER** - trigger a transfer
99+
- **GET CNT** - retrieve number of transferred items in the last transfer
100100

101101
\note For detailed command descriptions, see **README.md** in project root.
102102

@@ -143,14 +143,14 @@ create a new solution from **template**:
143143
\image html spi_server_new_sol_template.png
144144
4. Choose **Solution Base Folder**, click **Create**.
145145
\image html spi_server_new_sol_create.png
146-
5. Select the board layer that provides an SPI Driver.
146+
5. Select the board layer that provides an SPI Driver, click **OK**.
147147
\image html server_new_sol_layer.png
148148
6. If SPI is not routed to ARDUINO (or a different SPI peripheral is required),
149149
open **SPI_Server_Config.h**, **Open Preview** and edit **Driver_SPI#** to
150150
the required instance.
151151
7. Build and run the **SPI Server application** on your hardware.
152152

153-
\note **IMPORTANT:** The target boards SPI CMSIS-Driver must be **fully CMSIS compliant**!
153+
\note **IMPORTANT:** The target board's SPI CMSIS-Driver must be **fully CMSIS compliant**!
154154
\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
@@ -160,10 +160,10 @@ create a new solution from **template**:
160160
- Verify the correct driver instance in `SPI_Server_Config.h`.
161161
- Reduce bus speed used for communication with the Server (in `DV_SPI_Config.h`).
162162

163-
2. Debug message **Server Start failed!** (build-type: Debug)
163+
2. Debug message **"Server Start failed!"** (build-type: Debug)
164164
- Check heap (must be > `2 * SPI_SERVER_BUF_SIZE`).
165-
- Verify RTOS allows **512 bytes** allocation for the Server main thread (e.g., *Global Dynamic Memory size* in `RTX_Config.h` if RTX5).
166-
- Ensure the Servers SPI driver supports all fixed settings (Slave with hardware-monitored Slave Select, CPOL=0/CPHA=0, 8 bits, MSB to LSB).
165+
- Verify RTOS allows >= **512 bytes** allocation for the Server main thread (e.g., *Global Dynamic Memory size* in `RTX_Config.h` if RTX5).
166+
- Ensure the Server's SPI driver supports all fixed settings (Slave with hardware-monitored Slave Select, CPOL=0/CPHA=0, 8 bits, MSB to LSB).
167167

168168
3. **Tests report data mismatch**
169169
- Ensure Slave Select line has a pull-up to Vcc (3.3 V).

Documentation/Doxygen/src/DV_USART.txt

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -32,21 +32,21 @@ Example: to test `Driver_USART2`, set this value to `2`.
3232
- **Stop Bits:** 1
3333
- **Flow Control:** None
3434
- Configurable parameter:
35-
- **Mode** communication mode with the USART Server. Different modes require different physical connections and the
35+
- **Mode** - communication mode with the USART Server. Different modes require different physical connections and the
3636
USART Server must be configured accordingly. For details, see \ref usart_server_con "USART Server connection".
3737

3838
- **Tests**: configuration for test execution.
39-
- **Default settings** default parameters for data exchange tests. Typically, a single feature is varied while all
39+
- **Default settings** - default parameters for data exchange tests. Typically, a single feature is varied while all
4040
other parameters use defaults. For defaults used by each function, see \ref usart_tests_data_xchg.
41-
- **Baudrate** minimum and maximum bus speeds used by \ref USART_Baudrate_Min and \ref USART_Baudrate_Max.
42-
- **Number of Items** a selection of item counts (including unusual/odd counts) used by \ref USART_Number_Of_Items
41+
- **Baudrate** - minimum and maximum bus speeds used by \ref USART_Baudrate_Min and \ref USART_Baudrate_Max.
42+
- **Number of Items** - a selection of item counts (including unusual/odd counts) used by \ref USART_Number_Of_Items
4343
to verify transfers comply with the CMSIS-Driver specification.
4444

45-
**Tests** section enable/disable test groups (and individual tests):
46-
- **Driver Management** see \ref usart_tests_drv_mgmt.
47-
- **Data Exchange** see \ref usart_tests_data_xchg.
48-
- **Modem** see \ref usart_tests_modem.
49-
- **Event** see \ref usart_tests_evt.
45+
**Tests** section - enable/disable test groups (and individual tests):
46+
- **Driver Management** - see \ref usart_tests_drv_mgmt.
47+
- **Data Exchange** - see \ref usart_tests_data_xchg.
48+
- **Modem** - see \ref usart_tests_modem.
49+
- **Event** - see \ref usart_tests_evt.
5050

5151
*/
5252

@@ -84,9 +84,9 @@ Communication settings are defined in **USART_Server_Config.h** file.
8484

8585
\subsection usart_server_config_detail Configuration settings
8686

87-
- **Driver_USART#** selects the USART driver instance used by the Server.
87+
- **Driver_USART#** - selects the USART driver instance used by the Server.
8888
- **Communication settings**:
89-
- **Mode** defines the mode used for command exchange (must match DUT setup).
89+
- **Mode** - defines the mode used for command exchange (must match DUT setup).
9090
- Fixed parameters used for command exchange:
9191
- **Baudrate:** 115200
9292
- **Data Bits:** 8
@@ -97,17 +97,17 @@ Communication settings are defined in **USART_Server_Config.h** file.
9797
\section usart_server_commands Commands
9898
Commands are human-readable (ASCII) for easier analysis with a USART bus analyzer.
9999

100-
- **GET VER** get Server version
101-
- **GET CAP** get Server capabilities (auto-detected upon reception)
102-
- **SET BUF** initialize Rx/Tx buffer content
103-
- **GET BUF** retrieve Rx/Tx buffer content
104-
- **SET COM** specify transfer configuration for the next **XFER**
105-
- **XFER** trigger a transfer
106-
- **GET CNT** retrieve number of items transferred in the last transfer
107-
- **SET BRK** generate break signal
108-
- **GET BRK** read break signal status
109-
- **SET MDM** activate modem lines
110-
- **GET MDM** read modem line status
100+
- **GET VER** - get Server version
101+
- **GET CAP** - get Server capabilities (auto-detected upon reception)
102+
- **SET BUF** - initialize Rx/Tx buffer content
103+
- **GET BUF** - retrieve Rx/Tx buffer content
104+
- **SET COM** - specify transfer configuration for the next **XFER**
105+
- **XFER** - trigger a transfer
106+
- **GET CNT** - retrieve number of items transferred in the last transfer
107+
- **SET BRK** - generate break signal
108+
- **GET BRK** - read break signal status
109+
- **SET MDM** - activate modem lines
110+
- **GET MDM** - read modem line status
111111

112112
\note For detailed command descriptions, see **README.md** in project root.
113113

@@ -159,13 +159,13 @@ create a new solution from **template**:
159159
\image html usart_server_new_sol_template.png
160160
4. Choose **Solution Base Folder**, click **Create**.
161161
\image html usart_server_new_sol_create.png
162-
5. Select the board layer that provides an USART Driver.
163-
6. If the boards USART is not routed to ARDUINO (or a different peripheral is required)
162+
5. Select the board layer that provides an USART Driver, click **OK**.
163+
6. If the board's USART is not routed to ARDUINO (or a different peripheral is required)
164164
, open **USART_Server_Config.h**, **Open Preview** and edit **Driver_USART#** to
165165
the required instance.
166166
7. Build and run the **USART Server application** on your hardware.
167167

168-
\note **IMPORTANT:** The target boards USART CMSIS-Driver must be **fully CMSIS compliant**!
168+
\note **IMPORTANT:** The target board's USART CMSIS-Driver must be **fully CMSIS compliant**!
169169
\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
@@ -175,10 +175,10 @@ create a new solution from **template**:
175175
- Verify the correct driver instance in `USART_Server_Config.h`.
176176
- Ensure communication settings (mode) match between Server and Driver Validation; if changed, rebuild and reflash.
177177

178-
2. Debug message **Server Start failed!** (build-type: Debug)
178+
2. Debug message **"Server Start failed!"** (build-type: Debug)
179179
- Check heap (must be > `2 * USART_SERVER_BUF_SIZE`).
180-
- Verify RTOS allows **512 bytes** allocation for the Server main thread (e.g., *Global Dynamic Memory size* in `RTX_Config.h` if RTX5).
181-
- Ensure the Servers USART driver supports all fixed settings:
180+
- Verify RTOS allows >= **512 bytes** allocation for the Server main thread (e.g., *Global Dynamic Memory size* in `RTX_Config.h` if RTX5).
181+
- Ensure the Server's USART driver supports all fixed settings:
182182
- Baudrate 115200, 8-N-1, Flow Control None.
183183

184184
*/

0 commit comments

Comments
 (0)