Skip to content

Commit 657fc45

Browse files
paul-szczepanek-armDonatien Garnier
authored andcommitted
updated porting guide
1 parent f36e58b commit 657fc45

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

features/FEATURE_BLE/targets/TARGET_CORDIO/doc/PortingGuide.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ There are two main steps to enable the Mbed BLE Cordio port:
44

55
1. Configure your target to include Cordio BLE port and Cordio libraries during the build process.
66

7-
1. Implement the `CordioHCIDriver` class targeting the Bluetooth controller.
7+
2. Implement the `CordioHCIDriver` class targeting the Bluetooth controller.
88

99
### Configure the target
1010

@@ -42,7 +42,8 @@ Include an HCI driver for the BLE module used by the target, and a factory funct
4242
1. Navigate to the folder of the BLE API that hosts the target port `features/FEATURE_BLE/targets`.
4343

4444
1. Create a folder containing the port code to isolate it from other code.
45-
* Begin this folder's name with `TARGET_` and the rest of the name in capital letters.
45+
46+
1. Begin this folder's name with `TARGET_` and the rest of the name in capital letters.
4647

4748
#### Create the HCI driver
4849

@@ -54,7 +55,9 @@ More information about the architecture can be found in [HCI abstraction archite
5455

5556
<span class="notes">**Note:** If the Bluetooth controller uses an H4 communication interface and the host exposes serial flow control in Mbed, you can skip this step. Use the class `ble::vendor::cordio::H4TransportDriver` as the transport driver.</span>
5657

57-
To code an empty transport driver:
58+
The transport driver shall inherit publicly from the base class `CordioHCITransportDriver`.
59+
60+
To code a basic transport driver:
5861

5962
```
6063
#include "CordioHCITransportDriver.h"
@@ -84,8 +87,6 @@ private:
8487
} // namespace ble
8588
```
8689

87-
It inherits publicly from the base class `CordioHCITransportDriver`.
88-
8990
##### Functions
9091

9192
* **Initialization/termination**: The functions `initialize` and `terminate` are responsible for initializing and terminating the transport driver. It is not necessary to initialize the transport in the constructor.
@@ -102,7 +103,9 @@ void on_data_received(uint8_t* data_received, uint16_t length_of_data_received);
102103

103104
#### HCIDriver
104105

105-
The HCIDriver template is:
106+
The HCI Driver shall inherit publicly from the base class `CordioHCIDriver`.
107+
108+
The driver template is:
106109

107110
```
108111
#include "CordioHCIDriver.h"

0 commit comments

Comments
 (0)