Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 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
2 changes: 1 addition & 1 deletion Drv/ByteStreamDriverModel/docs/sdd.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The following components implement the byte stream model using the synchronous i
- [`Drv::TcpClient`](../../TcpClient/docs/sdd.md): a F´ component wrapper of the tcp client
- [`Drv::TcpServer`](../../TcpServer/docs/sdd.md): a F´ component wrapper of the tcp server
- [`Drv::Udp`](../../Udp/docs/sdd.md): a F´ component wrapper of the udp
- `Drv::LinuxUartDriver`
- [`Drv::LinuxUartDriver`](../../LinuxUartDriver/docs/sdd.md): a F´ component wrapper of the Linux UART driver


## Requirements
Expand Down
165 changes: 165 additions & 0 deletions Drv/LinuxUartDriver/docs/sdd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
# Drv::LinuxUartDriver Linux UART Driver Component

The LinuxUartDriver component provides a Linux-specific implementation of a UART (Universal Asynchronous Receiver-Transmitter) serial communication driver. It implements the byte stream driver model interface to enable serial communication with external devices through UART ports on Linux systems.

The component wraps Linux termios API functionality to provide configurable serial communication with support for various baud rates, flow control options, and parity settings. It implements bidirectional communication using a dedicated receive thread and synchronous send operations.

For more information on the ByteStreamDriverModel see: [`Drv::ByteStreamDriverModel`](../../ByteStreamDriverModel/docs/sdd.md).

## Requirements

| Name | Description | Validation |
|---|---|---|
| UART-COMP-001 | The LinuxUartDriver component shall implement the ByteStreamDriverModel | inspection |
| UART-COMP-002 | The LinuxUartDriver component shall provide configurable baud rates from 9600 to 4MHz | inspection |
| UART-COMP-003 | The LinuxUartDriver component shall provide configurable flow control (none/hardware) | inspection |
| UART-COMP-004 | The LinuxUartDriver component shall provide configurable parity (none/odd/even) | inspection |
| UART-COMP-005 | The LinuxUartDriver component shall provide a dedicated read thread for receiving data | inspection |
| UART-COMP-006 | The LinuxUartDriver component shall report telemetry for bytes sent and received | inspection |
| UART-COMP-007 | The LinuxUartDriver component shall handle UART errors and report them via events | inspection |
| UART-COMP-008 | The LinuxUartDriver component shall support buffer allocation for receive operations | inspection |

## Design

The LinuxUartDriver component implements the design specified by the [`Drv::ByteStreamDriverModel`](../../ByteStreamDriverModel/docs/sdd.md).

### Architecture

The component consists of the following key elements:

- **UART Configuration**: Handles device opening, baud rate, flow control, and parity settings using Linux termios API
- **Send Handler**: Synchronous transmission of data via the `send` port
- **Receive Thread**: Asynchronous reception of data via a dedicated thread that calls the `recv` output port
- **Buffer Management**: Integration with F´ buffer allocation system for memory management
- **Telemetry Reporting**: Tracks and reports bytes sent and received statistics
- **Error Handling**: Comprehensive error detection and event reporting

### Send Operation

When data is sent via the `send` input port:
1. The component validates the file descriptor and buffer
2. Data is written to the UART device using the Linux `write()` system call
3. Bytes sent counter is updated for telemetry
4. Status is returned indicating success or failure

### Receive Operation

The receive operation runs in a separate thread:
1. A buffer is allocated from the buffer manager
2. The thread blocks on `read()` waiting for incoming data
3. Received data is packaged in the buffer and sent via `recv` output port
4. Bytes received counter is updated for telemetry
5. Errors are logged and reported via events

### Threading Model

The component uses a single dedicated thread for receive operations (`serialReadTaskEntry`). This thread:
- Runs continuously until `quitReadThread()` is called
- Allocates buffers for each receive operation
- Handles timeouts and errors gracefully
- Can be started with configurable priority and stack size

## Usage

The LinuxUartDriver must be configured with device parameters before use. The typical usage pattern is:

1. **Open Device**: Configure the UART device with desired parameters
2. **Start Receive Thread**: Begin the receive thread for incoming data
3. **Send/Receive Data**: Use the ByteStreamDriverModel ports for communication
4. **Shutdown**: Stop the receive thread and close the device

### Basic Configuration Example

```cpp
Drv::LinuxUartDriver uart = Drv::LinuxUartDriver("UART Driver");

bool configureUart() {
// Open UART device with configuration
bool success = uart.open("/dev/ttyUSB0", // Device path
Drv::LinuxUartDriver::BAUD_115K, // 115200 baud
Drv::LinuxUartDriver::NO_FLOW, // No flow control
Drv::LinuxUartDriver::PARITY_NONE, // No parity
1024); // Buffer size

if (success) {
// Start receive thread
uart.start();
}

return success;
}

void shutdownUart() {
uart.quitReadThread();
uart.join();
}
```

### Integration with Rate Groups

The component includes a `run` input port for telemetry reporting that should be connected to a rate group:

```cpp
// Connect to rate group for periodic telemetry
rateGroup.connect_PingOut(0, uart.get_run_InputPort(0));
```

## Configuration

### Device Parameters

| Parameter | Type | Description | Valid Values |
|-----------|------|-------------|--------------|
| device | const char* | Path to UART device | Linux device path (e.g., "/dev/ttyUSB0") |
| baud | UartBaudRate | Communication baud rate | See baud rate enumeration |
| fc | UartFlowControl | Flow control setting | NO_FLOW, HW_FLOW |
| parity | UartParity | Parity setting | PARITY_NONE, PARITY_ODD, PARITY_EVEN |
| allocationSize | FwSizeType | Receive buffer size | Positive integer (bytes) |

### Baud Rate Options

The component supports the following baud rates:

| Enumeration | Numeric Value | Availability |
|-------------|---------------|--------------|
| BAUD_9600 | 9600 | All platforms |
| BAUD_19200 | 19200 | All platforms |
| BAUD_38400 | 38400 | All platforms |
| BAUD_57600 | 57600 | All platforms |
| BAUD_115K | 115200 | All platforms |
| BAUD_230K | 230400 | All platforms |
| BAUD_460K | 460800 | Linux only |
| BAUD_921K | 921600 | Linux only |
| BAUD_1000K | 1000000 | Linux only |
| BAUD_1152K | 1152000 | Linux only |
| BAUD_1500K | 1500000 | Linux only |
| BAUD_2000K | 2000000 | Linux only |
| BAUD_2500K | 2500000 | Linux only (if supported) |
| BAUD_3000K | 3000000 | Linux only (if supported) |
| BAUD_3500K | 3500000 | Linux only (if supported) |
| BAUD_4000K | 4000000 | Linux only (if supported) |

### Thread Configuration

The receive thread can be configured with:

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| priority | FwTaskPriorityType | TASK_PRIORITY_DEFAULT | Thread priority |
| stackSize | Os::Task::ParamType | TASK_DEFAULT | Thread stack size |
| cpuAffinity | Os::Task::ParamType | TASK_DEFAULT | CPU affinity mask |

### Events and Telemetry

The component generates the following events:
- **OpenError**: UART device open failures
- **ConfigError**: UART configuration failures
- **WriteError**: Data transmission errors
- **ReadError**: Data reception errors
- **PortOpened**: Successful device configuration
- **NoBuffers**: Buffer allocation failures
- **BufferTooSmall**: Insufficient buffer size

The component reports the following telemetry:
- **BytesSent**: Total bytes transmitted
- **BytesRecv**: Total bytes received
Loading