Skip to content

Commit 70814d6

Browse files
authored
Merge pull request #7417 from pan-/improve-cordio-hci-doc
Cordio Documentation: Explain how to tests and what tools are available.
2 parents deb905d + 4a9570b commit 70814d6

File tree

2 files changed

+159
-203
lines changed

2 files changed

+159
-203
lines changed
Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,44 @@
11
# HCI abstraction architecture
22

33
The HCI driver is split into two interfaces:
4-
* `CordioHCIDriver`: It is the driver for a BLE controller. It contains
5-
the primitive necessary to start and initialize the controller.
6-
* `CordioHCITransport`: It is the transport interface which is used by the HCI
4+
* `CordioHCIDriver`: It is the driver for a BLE controller. It contains
5+
the primitive necessary to start and initialize the controller.
6+
* `CordioHCITransport`: It is the transport interface which is used by the HCI
77
driver to communicate with the controller.
88

9-
A `CordioHCITransport` is injected into a `CordioHCIDriver` at construction
9+
A `CordioHCITransport` is injected into a `CordioHCIDriver` at construction
1010
time. A `CordioHCIDriver` is also injected at construction time of a `BLECordio`
11-
instance.
11+
instance.
1212

13-
This can be summarized in the following diagram:
13+
This can be summarized in the following diagram:
1414

1515
![](resources/architecture.png)
1616

1717
## CordioHCITransportDriver
1818

19-
The single responsabilities of this a driver is to handle the communication with
20-
the Bluetooth module. Basically, sending and reading bytes.
19+
The single responsibility of this driver is to handle the communication with
20+
the Bluetooth module. Basically, sending and reading bytes.
2121

22-
Given that the Bluetooth specification define standard transport interface, an
23-
implementation of the H4 interface is bundled in this port. It might be extended
24-
in the future with an implementation of the H5 interface. However there is no
22+
Given that the Bluetooth specification defines standard transport interface, an
23+
implementation of the H4 interface is bundled in this port. It might be extended
24+
in the future with an implementation of the H5 interface. However, there is no
2525
plan to provide the SDIO implementation at the moment.
2626

27-
This interface is defined in the header file
27+
This interface is defined in the header file
2828
[CordioHCITransportDriver.h](../driver/CordioHCITransportDriver.h)
2929

3030
## CordioHCIDriver
3131

32-
The responsibilities of this driver are:
33-
* Provide the memory which will used by the Bluetooth stack.
34-
* Initialize the bluetooth controller.
35-
* Handle the reset/startup sequence of the bluetooth controller.
32+
The responsibilities of this driver are:
33+
* Provide the memory which will used by the Bluetooth stack.
34+
* Initialize the Bluetooth controller.
35+
* Handle the reset/startup sequence of the Bluetooth controller.
3636

37-
This interface is defined in the header file
37+
This interface is defined in the header file
3838
[CordioHCIDriver.h](../driver/CordioHCIDriver.h)
3939

40-
A partial implementation is present in the file
41-
[CordioHCIDriver.cpp](../driver/CordioHCIDriver.cpp). It defines the function
42-
delivering memory to the stack and a complete reset sequence. However it does
43-
not define any initialization for the Bluetooth controller, this part being
44-
specific to the controller used.
40+
A partial implementation is present in the file
41+
[CordioHCIDriver.cpp](../driver/CordioHCIDriver.cpp). It defines the function
42+
delivering memory to the stack and a complete reset sequence. However, it does
43+
not define any initialization for the Bluetooth controller, this part being
44+
specific to the controller used.

0 commit comments

Comments
 (0)