Skip to content

Commit

Permalink
Clarify buffer ownership for ByteStreamDriverModel
Browse files Browse the repository at this point in the history
  • Loading branch information
celskeggs authored Nov 22, 2024
1 parent 00c5c8e commit 7771b5e
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions Drv/ByteStreamDriverModel/docs/sdd.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ The manager component (typically the ground interface) initiates the transfer of
The caller will provide a `Fw::Buffer` containing the data to send and the port call will return a status of that send.
These responses are an enumeration whose values are described in the following table:

| Value | Description |
|---|---|
| Drv::SEND_OK | Send functioned normally. |
| Drv::SEND_RETRY | Send should be retried, but a subsequent send should return SEND_OK. |
| Drv::SEND_ERROR | Send produced an error, future sends likely to fail. |
| Value | Description | Buffer Ownership |
|---|---|---|
| Drv::SEND_OK | Send functioned normally. | Ownership of the `Fw::Buffer` passes to the byte stream driver. |
| Drv::SEND_RETRY | Send should be retried, but a subsequent send should return SEND_OK. | The caller retains ownership of the `Fw::Buffer`. |
| Drv::SEND_ERROR | Send produced an error, future sends likely to fail. | Ownership of the `Fw::Buffer` passes to the byte stream driver. |

**Note:** in either formation described below, send will operate as described here.

Expand Down

0 comments on commit 7771b5e

Please sign in to comment.