Skip to content

Commit 81b55f7

Browse files
committed
Fixed a bunch of doc references to Drv/BlockDriver
1 parent d301b76 commit 81b55f7

File tree

5 files changed

+19
-19
lines changed

5 files changed

+19
-19
lines changed

Drv/Interfaces/docs/sdd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ The `Drv/SpiInterface` is an interface for writing and reading to an SPI device.
2020

2121
## Drv/TickInterface
2222

23-
The `Drv/TickInterface` is an interface for outputting a system tick along with a RawTime timestamp. The [`Drv::BlockDriver`](../../BlockDriver/BlockDriver.fpp) driver implements this interface.
23+
The `Drv/TickInterface` is an interface for outputting a system tick along with a RawTime timestamp. The [`Ref::BlockDriver`](../../../Ref/BlockDriver/BlockDriver.fpp) driver is an example of a notinal driver that implements this interface.

Ref/BlockDriver/docs/sdd.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
# Drv::BlockDriver Component
1+
# Ref::BlockDriver Component
22

33
## 1. Introduction
44

5-
The `Drv::BlockDriver` is a demonstration component that loops back data buffers. It also emulates a timing interrupt driven by the public method `void callIsr(void)`.
5+
The `Ref::BlockDriver` is a demonstration component that loops back data buffers. It also emulates a timing interrupt driven by the public method `void callIsr(void)`.
66

77
## 2. Requirements
88

9-
The requirements for `Drv::BlockDriver` are as follows:
9+
The requirements for `Ref::BlockDriver` are as follows:
1010

1111
Requirement | Description | Verification Method
1212
----------- | ----------- | -------------------
13-
ISF-BDV-001 | The `Drv::BlockDriver` component shall loop back packets from its input port to its output port | System test, unit test
14-
ISF-BDV-002 | The `Drv::BlockDriver` component shall loop back the key value from `PingIn` port to `PingOut` port | System test, unit test
15-
ISF-BDV-003 | The `Drv::BlockDriver` component shall send a timing interrupt whenever `callIsr()` is invoked | System test, unit test
13+
ISF-BDV-001 | The `Ref::BlockDriver` component shall loop back packets from its input port to its output port | System test, unit test
14+
ISF-BDV-002 | The `Ref::BlockDriver` component shall loop back the key value from `PingIn` port to `PingOut` port | System test, unit test
15+
ISF-BDV-003 | The `Ref::BlockDriver` component shall send a timing interrupt whenever `callIsr()` is invoked | System test, unit test
1616

1717
## 3. Design
1818

1919
### 3.1 Context
2020

2121
#### 3.1.1 Component Diagram
2222

23-
The `Drv::BlockDriver` component has the following component diagram:
23+
The `Ref::BlockDriver` component has the following component diagram:
2424

25-
![`Drv::BlockDriver` Diagram](img/BlockDriverBDD.jpg "Drv::BlockDriver")
25+
![`Ref::BlockDriver` Diagram](img/BlockDriverBDD.jpg "Ref::BlockDriver")
2626

2727
## 4. Dictionaries
2828

Ref/docs/sdd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The application illustrates some example application components:
1515
|---|---|---|
1616
|SendBuffApp | A component that sends a buffer | [SDD](../SendBuffApp/docs/sdd.md) |
1717
|RecvBuffApp | A component that receives a buffer | [SDD](../RecvBuffApp/docs/sdd.md) |
18-
|BlockDriver | A notional driver that relays buffers from SendBuffApp to RecvBuffApp | [SDD](../../Drv/BlockDriver/docs/sdd.md)|
18+
|BlockDriver | A notional driver that relays buffers from SendBuffApp to RecvBuffApp | [SDD](../BlockDriver/docs/sdd.md)|
1919
|SignalGen | A component that generates telemetry following a waveform| [SDD](../SignalGen/docs/sdd.md)|
2020
|PingReceiver|A test component that gets health pings that can be turned off| [SDD](../SignalGen/docs/sdd.md)|
2121

cmake/test/src/settings.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
"Svc_StaticMemory",
6565
"Svc_Time",
6666
"Svc_TlmChan",
67-
"Drv_BlockDriver",
67+
"Ref_BlockDriver",
6868
"Ref_PingReceiver",
6969
"Ref_RecvBuffApp",
7070
"Ref_SendBuffApp",

docs/user-manual/overview/source-tree.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -478,14 +478,6 @@ depend on the source code in this directory. There is no particular
478478
significance to the name; rather, it was selected to represent how a
479479
developer might organize their code. The subdirectories are as follows.
480480

481-
### BlockDriver
482-
483-
This represents a hardware driver that accepts buffers of data to send
484-
to a device, and sends buffers that it receives from the device. Since
485-
there is no real hardware behind the driver, the driver takes any
486-
incoming data buffers from the input port and sends them out the output
487-
port.
488-
489481
### DataTypes
490482

491483
This directory contains the port and data buffer types used by the
@@ -499,6 +491,14 @@ logic. An adapter would use the framework layers, drivers, and services
499491
that are meant to be reusable, along with application components for a
500492
particular task.
501493

494+
### BlockDriver
495+
496+
This represents a hardware driver that accepts buffers of data to send
497+
to a device, and sends buffers that it receives from the device. Since
498+
there is no real hardware behind the driver, the driver takes any
499+
incoming data buffers from the input port and sends them out the output
500+
port.
501+
502502
### SendBuffApp
503503

504504
This passive component represents a part of the application that sends

0 commit comments

Comments
 (0)