kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-26 23:11:19 +01:00
Code Releases Activity

pkg/nordic_softdevice_ble: Move README in with doxygen

Browse Source
This commit is contained in:
chrysn 2020-02-11 09:46:15 +01:00
parent b685b4d720
commit 461065471d
2 changed files with 33 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
pkg/nordic_softdevice_ble/README.md
View File

@ -1,30 +0,0 @@
# Overview
This package provides necessary Makefiles and glue code to use the Nordic S132
SoftDevice as Bluetooth BLE transport for RIOT's 6lowpan stack.
# Usage
"gnrc_netdev_default" has a dependency to "nordic_softdevice_ble", so all
examples automatically download the SDK and compile / link / flash all needed
code.
If you want to manually set up included modules, add "USEPKG +=
nordic_softdevice_ble" to your application's Makefile.
See README-BLE-6LoWPAN.md for instructions on how to set up 6lowpan over BLE on
Linux.
# Known issues
- floating point ABI mismatch
The Nordic binaries are compiled using hard float ABI, which RIOT currently
doesn't support (RIOT's context switching code doesn't preserve the floating
point registers). If the softdevice is compiled in, RIOT will be compiled with
hard float ABI in order for the linking to succeed. This works for some
application, but will lead to serious and hard-to-find bugs for code using
floating point instructions.
Hopefully, either the RIOT community adds hard-float support, or Nordic
releases a soft-float version of the used binaries.

34
pkg/nordic_softdevice_ble/doc.txt
View File

@ -3,4 +3,36 @@
* @ingroup pkg
* @ingroup net
* @brief Provides a RIOT adaption for Nordic Softdevice BLE library
*/
# Overview
This package provides necessary Makefiles and glue code to use the Nordic S132
SoftDevice as Bluetooth BLE transport for RIOT's 6lowpan stack.
# Usage
"gnrc_netdev_default" has a dependency to "nordic_softdevice_ble", so all
examples automatically download the SDK and compile / link / flash all needed
code.
If you want to manually set up included modules, add "USEPKG +=
nordic_softdevice_ble" to your application's Makefile.
See README-BLE-6LoWPAN.md for instructions on how to set up 6lowpan over BLE on
Linux.
# Known issues
- floating point ABI mismatch
The Nordic binaries are compiled using hard float ABI, which RIOT currently
doesn't support (RIOT's context switching code doesn't preserve the floating
point registers). If the softdevice is compiled in, RIOT will be compiled with
hard float ABI in order for the linking to succeed. This works for some
application, but will lead to serious and hard-to-find bugs for code using
floating point instructions.
Hopefully, either the RIOT community adds hard-float support, or Nordic
releases a soft-float version of the used binaries.
*/