Import Mbed OS hard-float snapshot
This commit is contained in:
33
connectivity/FEATURE_BLE/libraries/TARGET_CORDIO/README.md
Normal file
33
connectivity/FEATURE_BLE/libraries/TARGET_CORDIO/README.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# BLE API Cordio Implementation
|
||||
|
||||
The BLE API Cordio implementation allows Cordio licensee to easily deliver a
|
||||
complete and up to date implementation of mbed BLE to their customers using
|
||||
mbed OS.
|
||||
|
||||
To deliver a BLE port, vendors simply have to provide an HCI driver tailored
|
||||
for the BLE module present on the board they want to support.
|
||||
|
||||
## Source Organization
|
||||
|
||||
The root contains the public header of the classes implementing BLE API public
|
||||
interface.
|
||||
|
||||
* `doc`: Documentation such as the HCI extension guide and the
|
||||
porting guide.
|
||||
* `driver`: HCI driver and transport interfaces. Also contains standard driver
|
||||
implementation.
|
||||
* `sources`: BLE API Implementation files
|
||||
* `stack`: Cordio stack
|
||||
* `cordio_stack`: Headers and sources of the cordio stack
|
||||
* `mbed_os_adaptation`: Headers of the interface responsible for the bridge
|
||||
between BLE API and the Cordio stack.
|
||||
|
||||
## Build time configuration
|
||||
|
||||
Build time configuration may be controlled through options set in:
|
||||
`features\FEATURE_BLE\targets\TARGET_CORDIO\mbed_lib.json`
|
||||
|
||||
## Documentation
|
||||
|
||||
* [HCI architecture](doc/HCIAbstraction.md)
|
||||
* [Porting guide](doc/PortingGuide.md)
|
||||
Reference in New Issue
Block a user