Documentation: Minor update and cleanup

Author: MiloradCvjetkovic

documentation/overview.md

@@ -62,4 +62,4 @@ The following section lists the communication speeds that can be achieved on dif
 - ULINKplus (SWD clock: 10 MHz): 250 kB/s
 - J-Link Pro (SWD clock: auto): 800 kB/s
 
-[Using the FileSystem](layer-sdsio_fs) on the STM32H7B3_DK board with SYSCLK 280 MHz, SDMMC with 4-bit bus: 5 MB/s
+[Using the FileSystem](layer-sdsio_fs) on the STM32H7B3_DK board with CPU running at 280 MHz, SDMMC with 4-bit bus: 5 MB/s

documentation/sdsio.md

@@ -1,6 +1,6 @@
 # SDSIO Interface
 
-The SDSIO components offer flexible SDS communication interfaces. You may choose between these interface components that are stored in the folders: `./sds/sdsio/client`, `./sds/sdsio/fs` or `./sds/sdsio/vsi`. You may use one of the following CMSIS software components for integration of the SDSIO interface into the target system:
+The SDSIO components offer flexible SDS communication interfaces. You may choose between these interface components that are stored in the folders: `sds/sdsio/client`, `sds/sdsio/fs` or `sds/sdsio/vsi`. You may use one of the following CMSIS software components for integration of the SDSIO interface into the target system:
 
 ```yml
   - component: SDS:IO:Socket                     # IoT Socket Interface (Ethernet or WiFi)
@@ -32,10 +32,12 @@ To access [SDS data files](theory.md#sds-data-files), configure the `*.sdsio.yml
 
 ```bash
 >python sdsio-server.py -c myproject.sdsio.yml
+SDSIO-Server v3.0.0
 Press 'Ctrl+C' or 'X' to exit.
-Working directory: ...\SDS_data.
-SDSIO configuration YAML: ...\myproject.sdsio.yml.
+Working directory: ...\SDS_data
+SDSIO configuration YAML: ...\myproject.sdsio.yml
 SDSIO command input: R=Record, P=playback, S/s=stop, T/t=reset, X/x=exit, A-H=set flags 0-7, a-h=clear flags 0-7.
+SDSIO-Server waiting for USB SDSIO-Client...
 SDSIO-Client USB device connected.
 ```
 
@@ -58,15 +60,16 @@ To access [SDS data files](theory.md#sds-data-files), configure the `*.sdsio.yml
 
 ```bash
 >python sdsio-server.py -c myproject.sdsio.yml
+SDSIO-Server v3.0.0
 Press 'Ctrl+C' or 'X' to exit.
-Working directory: ...\SDS_data.
-SDSIO configuration YAML: ...\myproject.sdsio.yml.
+Working directory: ...\SDS_data
+SDSIO configuration YAML: ...\myproject.sdsio.yml
 SDSIO command input: R=Record, P=playback, S/s=stop, T/t=reset, X/x=exit, A-H=set flags 0-7, a-h=clear flags 0-7.
-Socket server listening on 172.20.10.2:5050
+SDSIO-Server listening on 172.20.10.2:5050
 ```
 
 !!! Note
-    The SDSIO Server prints the IP address on which it is listening. The target hardware must connect to this IP address. Configure the target by updating the `SDSIO_SOCKET_SERVER_IP` macro in `./layer/sdsio/network/RTE/SDS/sdsio_client_socket_config.h`.
+    The SDSIO-Server prints the IP address on which it is listening. The target hardware must connect to this IP address. Configure the target by updating the `SDSIO_SOCKET_SERVER_IP` macro in `layer/sdsio/network/RTE/SDS/sdsio_client_socket_config.h`.
 
 ## Layer: sdsio_rtt
 
@@ -79,7 +82,7 @@ The [`layer/sdsio/rtt/sdsio_rtt.clayer.yml`](https://github.com/ARM-software/SDS
 The SDSIO layer communicates with the host computer via an RTT socket exposed by the
 debug probe software. The [SDSIO-Server](https://arm-software.github.io/SDS-Framework/main/utilities.html#sdsio-server)
 runs on the host and connects to the debug probe socket using
-[socket connect mode](https://arm-software.github.io/SDS-Framework/main/utilities.html#socket-mode).
+[socket connect mode](https://arm-software.github.io/SDS-Framework/main/utilities.html#socket-mode-command-line).
 
 #### Connect with SEGGER J-Link
 
@@ -216,7 +219,7 @@ Playback: Test_In (Test_In.0.sds).
 Record:   Test_Out (Test_Out.0.p.sds).
 Closed:   Test_In (Test_In.0.sds).
 Closed:   Test_Out (Test_Out.0.p.sds).
-sdsControl: auto playback terminate.
+Playback complete - no more steps remaining.
 sdsFlags = 0x30000000.
 sdsFlags = 0x70000000.
 sdsFlags = 0x30000000.

documentation/template.md

@@ -23,7 +23,7 @@ With a custom SDSIO interface, alternative I/O configurations are possible.
 
 ## SDS Template Structure
 
-The structure of the SDS template application is shown below. Two projects let you choose between a data communication test and a user algorithm test. Two target types let you deploy the test application either on hardware (evaluation board) or on an AVH FVP (simulation model).
+The structure of the SDS template application is shown below. Two projects let you choose between a data communication test and a user algorithm test. Three target types are available, allowing the test application to be deployed either on hardware (an evaluation board) or on one of two AVH FVP simulation models.
 
 A standard board layer, provided by several BSPs, implements the hardware interface. For communication, the SDSIO layer uses the MDK-Middleware or (for the AVH FVP target) a virtual simulation interface (VSI).
 
@@ -33,7 +33,9 @@ The `Debug` and `Release` build types differ only in the optimization level and
 Both build types support recording and playback, controlled via `sdsFlags`. The `sdsFlags` value can be modified by the SDS application (using the function `sdsFlagsModify`) or by the SDSIO-Server, making it easy to switch between Record Mode and Playback Mode.
 
 !!! Note
-    Implementations using a file system support only recording mode.
+    The template-based file system implementation natively supports recording mode only.
+    Playback mode can be enabled by adapting the provided template code.
+    For example, an additional button on the board can be used to toggle between recording and playback modes.
 
 ### Record Mode
 
@@ -95,7 +97,7 @@ In the [**Create a new solution**](https://mdk-packs.github.io/vscode-cmsis-solu
 After the *csolution project* loads, VS Code displays a dialog where you can select a compatible software layer and an installed compiler toolchain.
 
 !!! Note
-    - If no compatible software layer is available for SDS, use the `V2M-MPS3-SSE-300-FVP` board. Then adapt `sds.csolution.yml` and create a software layer for your target hardware as outlined in [Compile for Custom Hardware](#compile-for-custom-hardware). The [layer: sdsio_rtt](sdsio.md#layer-sdsio_rtt) has minimal requirements because it uses the debug adapter as the communication interface to the SDSIO-Server.
+    - If no compatible software layer is available for SDS, use the `V2M-MPS3-SSE-300-FVP` board. Then adapt `SDS.csolution.yml` and create a software layer for your target hardware as outlined in [Compile for Custom Hardware](#compile-for-custom-hardware). The [layer: sdsio_rtt](sdsio.md#layer-sdsio_rtt) has minimal requirements because it uses the debug adapter as the communication interface to the SDSIO-Server.
 
 ![Configure Solution](images/ConfigureSolution.png)
 
@@ -157,7 +159,7 @@ The **DataTest** project validates the communication channel.
 Activate recording from the SDSIO-Server by pressing the `R` key. To stop recording, press the `S` key.
 Alternatively, recording can be started or stopped by pressing the user button on the board.
 
-This run should generate the files `Test_In.1.sds` and `Test_Out.1.sds` in the folder `datatest\SDS Recordings`. The `DataTest` project is configured to record 1000 data records at an interval of 10 ms.
+This run should generate the files `Test_In.1.sds` and `Test_Out.1.sds` in the folder `datatest/SDS Recordings`. The `DataTest` project is configured to record 1000 data records at an interval of 10 ms.
 
 To verify correctness of the recording using the SDS-Check utility, use the following commands:
 
@@ -175,7 +177,7 @@ When recording is started again, new files with different names are created: `Te
 
 Activate the playback from the SDSIO-Server by pressing the `P` key.
 
-This run should read the `Test_In.0.sds` file and generate the `Test_Out.0.p.sds` file in the folder `datatest\SDS Recordings`. The `Test_Out.0.sds` file generated during recording is identical to `Test_Out.0.p.sds`, which is generated in playback mode.
+This run should read the `Test_In.0.sds` file and generate the `Test_Out.0.p.sds` file in the folder `datatest/SDS Recordings`. The `Test_Out.0.sds` file generated during recording is identical to `Test_Out.0.p.sds`, which is generated in playback mode.
 
 To verify correctness of the recording using the SDS-Check utility, use the following command:
 

documentation/theory.md

@@ -74,16 +74,18 @@ The actual files used when opening a stream depend on the presence of the [`*.sd
 
 **Recording:**
 
-`<label>` is a sequential number starting at 0 and incremented by 1. The first value for which no corresponding file exists is used to create a new file.
-After recording completes, the process continues from the last `<label>` value.
+`<label>` is a sequential integer starting at 0. The value is incremented until no file exists with the corresponding name, at which point a new file is created.
+
+Each subsequent recording session uses the next `<label>` value in the sequence. If a file with the selected name already exists, it is preserved by renaming it with
+a .bak extension before a new file is created with the original name.
 
 **Playback:**
 
 When a [`*.sdsio.yml` control file](utilities.md#sdsio-control-file-sdsioyml) is used and contains a [`play:`](utilities.md#play) node, the filename follows the pattern `<stream-name>.<label>.sds`, where `<label>` is specified in the corresponding
 [`step:`](utilities.md#play).
 
-When no `*.sdsio.yml` control file is used, the `<label>` is a sequential number starting at 0. If the corresponding file does not exist, the open operation fails.
-After playback completes, the process repeats with the `<label>` incremented by one.
+When `*.sdsio.yml` control file is not used, the `<label>` is a sequential number starting at 0. If the corresponding file does not exist, the open operation fails.
+After playback session completes, the process repeats with the `<label>` incremented by one.
 
 !!! Note
     - Files recorded during playback include an additional `.p` before the `.sds` extension to
@@ -256,7 +258,7 @@ The size of the data stream buffer depends on several factors such as:
 - the frequency of the algorithm execution. Fast execution speeds may require a larger buffer.
 
 As a guideline, the buffer size should be at least **(2 × block size) + 2 KB**.  
-The minimum recommended buffer size is **0x1000 (4 KB)**.
+The minimum recommended buffer size is **4 KB**.
 
 ## SDSIO-Server Protocols