Wang Xinglu / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Dependencies:   nRF51822

Dependents:   LinkNode_LIS3DH

Fork of BLE_API by Bluetooth Low Energy

Files at this revision

API Documentation at this revision

Revision 411:cf2cce37ad73, committed 2015-06-08

Comitter:
rgrover1
Date:
Mon Jun 08 10:41:18 2015 +0100
Parent:
410:af8f2d1b67b6
Child:
412:7a295e110b77
Commit message:
Synchronized with git rev 92fca3c1
Author: Rohit Grover
add a comment header block to explain why BLEDevice::init() may not be safe to call from global static context.

Changed in this revision

public/BLEDevice.h Show annotated file Show diff for this revision Revisions of this file 
--- a/public/BLEDevice.h	Mon Jun 08 10:41:17 2015 +0100
+++ b/public/BLEDevice.h	Mon Jun 08 10:41:18 2015 +0100
@@ -33,8 +33,16 @@
     /**
      * Initialize the BLE controller. This should be called before using
      * anything else in the BLE_API.
+     *
+     * init() hands control to the underlying BLE module to accomplish
+     * initialization. This initialization may tacitly depend on other hardware
+     * setup (such as clocks or power-modes) which happens early on during
+     * system startup. It may not be safe to call init() from global static
+     * context where ordering is compiler specific and can't be guaranteed--it
+     * is safe to call BLEDevice::init() from within main().
      */
     ble_error_t init();
+
     ble_error_t reset(void);
 
     /**