Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions Documentation/Doxygen/src/DV_SPI.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,20 @@ Example: to test `Driver_SPI2`, set this value to `2`.
- Fixed parameters:
- **Clock/Frame:** CPOL=0, CPHA=0
- **Data Bits:** 8
- **Bit Order:** MSB LSB
- **Bit Order:** MSB to LSB
- Configurable parameters:
- **Slave Select** **Software Controlled** (driver toggles SS using `ARM_SPI_CONTROL_SS`) or **Hardware Controlled**.
- **Bus Speed** nominal bus speed for reliable command exchange with the Server.
- **Slave Select** - **Software Controlled** (driver toggles SS using `ARM_SPI_CONTROL_SS`) or **Hardware Controlled**.
- **Bus Speed** - nominal bus speed for reliable command exchange with the Server.

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

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

*/

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

\subsection spi_server_config_detail Configuration settings

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

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

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

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

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

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

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

\section spi_server_troubleshooting Troubleshooting
Expand All @@ -160,10 +160,10 @@ create a new solution from **template**:
- Verify the correct driver instance in `SPI_Server_Config.h`.
- Reduce bus speed used for communication with the Server (in `DV_SPI_Config.h`).

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

3. **Tests report data mismatch**
- Ensure Slave Select line has a pull-up to Vcc (3.3 V).
Expand Down
56 changes: 28 additions & 28 deletions Documentation/Doxygen/src/DV_USART.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,21 +32,21 @@ Example: to test `Driver_USART2`, set this value to `2`.
- **Stop Bits:** 1
- **Flow Control:** None
- Configurable parameter:
- **Mode** communication mode with the USART Server. Different modes require different physical connections and the
- **Mode** - communication mode with the USART Server. Different modes require different physical connections and the
USART Server must be configured accordingly. For details, see \ref usart_server_con "USART Server connection".

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

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

*/

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

\subsection usart_server_config_detail Configuration settings

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

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

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

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

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

\section usart_server_troubleshooting Troubleshooting
Expand All @@ -175,10 +175,10 @@ create a new solution from **template**:
- Verify the correct driver instance in `USART_Server_Config.h`.
- Ensure communication settings (mode) match between Server and Driver Validation; if changed, rebuild and reflash.

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

*/
Expand Down
Loading