Nordic stack and drivers for the mbed BLE API

Dependents:   idd_hw5_bleFanProto

Fork of nRF51822 by Nordic Semiconductor

Committer:
Rohit Grover
Date:
Tue Sep 02 15:50:05 2014 +0100
Revision:
56:a1071b629aa3
Parent:
42:120a96d10f90
Release 0.1.0
=============

We've achieved significant gains in power consumption: the BLE_Beacon demo now
runs at around 35uA of average current broadcasting once a second at 0dB; when
not using the radio, this demo consumes around 7uA.

Features
~~~~~~~~

- Replace initialization of high-frequency external crystal clock-source with
the use of low-frequency clock. This brings in significant gains in power
consumption.

- Re-implement the micro-second timer on nRF51 using the app_timer module
(which internally uses RTC). This limits the precision of the us_Timer to
30uS; but brings in significant gains in power consumption.

- Reduce the number of available app_timers and the event depths for app-timer
events; this will reduce memory consumption for zero-initialized data by
around 1K.

- Remove the call to conn_params_init() at startup. This is not mandatory; and
was causing an unnecessary re-negotiation of connection parameters a few
seconds into every connection.

- Reduce default transmission power level to 0dbB (was 4dbB before).

- Reduce min connection interval to 50ms and max to 500ms (previous values
were much larger).

- Replace a few instances of use of wait() with nrf_delay_us().

- onConnection() callback now receives connection-parameters applicable to the
new connection.

- onDataSent() callback now receives a count parameter containing the number of
times notifications were sent out since the last callback.

- A 'reason' parameter has been added to Gap::disconnect() to indicate the
reason for disconnection; and also to the onDisconnection callback to
receive a reason from the remote host.

- disable the app_gpiote module by default.

Bugfixes
~~~~~~~~

- onDataWritten() callback now passes an additional parameter
(GattServer::WriteEventCallback_t) encapsulating the update. This avoids
having to re-fetch the updated characteristic's value attribute. It also
fixes a bug where multiple updates to the characteristic's value-attribute
could get clobbered if they occurred in quick succession before the
callbacks could be processed.


Compatibility
~~~~~~~~~~~~~

Compatible with revision 0.1.0 of the BLE_API.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Rohit Grover 22:c6ee8136847e 1 /* mbed Microcontroller Library
Rohit Grover 22:c6ee8136847e 2 * Copyright (c) 2006-2013 ARM Limited
Rohit Grover 22:c6ee8136847e 3 *
Rohit Grover 22:c6ee8136847e 4 * Licensed under the Apache License, Version 2.0 (the "License");
Rohit Grover 22:c6ee8136847e 5 * you may not use this file except in compliance with the License.
Rohit Grover 22:c6ee8136847e 6 * You may obtain a copy of the License at
Rohit Grover 22:c6ee8136847e 7 *
Rohit Grover 22:c6ee8136847e 8 * http://www.apache.org/licenses/LICENSE-2.0
Rohit Grover 22:c6ee8136847e 9 *
Rohit Grover 22:c6ee8136847e 10 * Unless required by applicable law or agreed to in writing, software
Rohit Grover 22:c6ee8136847e 11 * distributed under the License is distributed on an "AS IS" BASIS,
Rohit Grover 22:c6ee8136847e 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Rohit Grover 22:c6ee8136847e 13 * See the License for the specific language governing permissions and
Rohit Grover 22:c6ee8136847e 14 * limitations under the License.
Rohit Grover 22:c6ee8136847e 15 */
Rohit Grover 22:c6ee8136847e 16 #include "common/common.h"
Rohit Grover 22:c6ee8136847e 17
Rohit Grover 22:c6ee8136847e 18 #include "app_timer.h"
Rohit Grover 22:c6ee8136847e 19 #include "ble_gap.h"
Rohit Grover 22:c6ee8136847e 20 #include "ble_conn_params.h"
Rohit Grover 22:c6ee8136847e 21
Rohit Grover 22:c6ee8136847e 22 static inline uint32_t msec_to_1_25msec(uint32_t interval_ms) ATTR_ALWAYS_INLINE ATTR_CONST;
Rohit Grover 56:a1071b629aa3 23 #if SDK_CONN_PARAMS_MODULE_ENABLE
Rohit Grover 22:c6ee8136847e 24 static void error_callback(uint32_t nrf_error);
Rohit Grover 56:a1071b629aa3 25 #endif // SDK_CONN_PARAMS_MODULE_ENABLE
Rohit Grover 22:c6ee8136847e 26
Rohit Grover 22:c6ee8136847e 27 /**************************************************************************/
Rohit Grover 22:c6ee8136847e 28 /*!
Rohit Grover 22:c6ee8136847e 29 @brief Initialise GAP in the underlying SoftDevice
Rohit Grover 22:c6ee8136847e 30
Rohit Grover 22:c6ee8136847e 31 @returns
Rohit Grover 22:c6ee8136847e 32 */
Rohit Grover 22:c6ee8136847e 33 /**************************************************************************/
Rohit Grover 22:c6ee8136847e 34 error_t btle_gap_init(void)
Rohit Grover 22:c6ee8136847e 35 {
Rohit Grover 22:c6ee8136847e 36 ble_gap_conn_params_t gap_conn_params = {0};
Rohit Grover 22:c6ee8136847e 37
Rohit Grover 42:120a96d10f90 38 gap_conn_params.min_conn_interval = msec_to_1_25msec(CFG_GAP_CONNECTION_MIN_INTERVAL_MS); // in 1.25ms units
Rohit Grover 42:120a96d10f90 39 gap_conn_params.max_conn_interval = msec_to_1_25msec(CFG_GAP_CONNECTION_MAX_INTERVAL_MS); // in 1.25ms unit
Rohit Grover 22:c6ee8136847e 40 gap_conn_params.slave_latency = CFG_GAP_CONNECTION_SLAVE_LATENCY;
Rohit Grover 42:120a96d10f90 41 gap_conn_params.conn_sup_timeout = CFG_GAP_CONNECTION_SUPERVISION_TIMEOUT_MS / 10; // in 10ms unit
Rohit Grover 22:c6ee8136847e 42
Rohit Grover 22:c6ee8136847e 43 ble_gap_conn_sec_mode_t sec_mode;
Rohit Grover 22:c6ee8136847e 44 BLE_GAP_CONN_SEC_MODE_SET_OPEN(&sec_mode); // no security is needed
Rohit Grover 22:c6ee8136847e 45
Rohit Grover 42:120a96d10f90 46 ASSERT_STATUS( sd_ble_gap_device_name_set(&sec_mode, (const uint8_t *) CFG_GAP_LOCAL_NAME, strlen(CFG_GAP_LOCAL_NAME)));
Rohit Grover 22:c6ee8136847e 47 ASSERT_STATUS( sd_ble_gap_appearance_set(CFG_GAP_APPEARANCE));
Rohit Grover 22:c6ee8136847e 48 ASSERT_STATUS( sd_ble_gap_ppcp_set(&gap_conn_params));
Rohit Grover 22:c6ee8136847e 49 ASSERT_STATUS( sd_ble_gap_tx_power_set(CFG_BLE_TX_POWER_LEVEL));
Rohit Grover 22:c6ee8136847e 50
Rohit Grover 56:a1071b629aa3 51 /**
Rohit Grover 56:a1071b629aa3 52 * Call to conn_params_init() is not necessary; and so is disabled by default.
Rohit Grover 56:a1071b629aa3 53 * This API should be exposed to the user to be invoked when necessary.
Rohit Grover 56:a1071b629aa3 54 */
Rohit Grover 56:a1071b629aa3 55 #if SDK_CONN_PARAMS_MODULE_ENABLE
Rohit Grover 22:c6ee8136847e 56 /* Connection Parameters */
Rohit Grover 22:c6ee8136847e 57 enum {
Rohit Grover 22:c6ee8136847e 58 FIRST_UPDATE_DELAY = APP_TIMER_TICKS(5000, CFG_TIMER_PRESCALER),
Rohit Grover 22:c6ee8136847e 59 NEXT_UPDATE_DELAY = APP_TIMER_TICKS(5000, CFG_TIMER_PRESCALER),
Rohit Grover 22:c6ee8136847e 60 MAX_UPDATE_COUNT = 3
Rohit Grover 22:c6ee8136847e 61 };
Rohit Grover 22:c6ee8136847e 62
Rohit Grover 22:c6ee8136847e 63 ble_conn_params_init_t cp_init = {0};
Rohit Grover 22:c6ee8136847e 64
Rohit Grover 22:c6ee8136847e 65 cp_init.p_conn_params = NULL;
Rohit Grover 22:c6ee8136847e 66 cp_init.first_conn_params_update_delay = FIRST_UPDATE_DELAY;
Rohit Grover 22:c6ee8136847e 67 cp_init.next_conn_params_update_delay = NEXT_UPDATE_DELAY;
Rohit Grover 22:c6ee8136847e 68 cp_init.max_conn_params_update_count = MAX_UPDATE_COUNT;
Rohit Grover 22:c6ee8136847e 69 cp_init.start_on_notify_cccd_handle = BLE_GATT_HANDLE_INVALID;
Rohit Grover 22:c6ee8136847e 70 cp_init.disconnect_on_fail = true;
Rohit Grover 22:c6ee8136847e 71 cp_init.evt_handler = NULL;
Rohit Grover 22:c6ee8136847e 72 cp_init.error_handler = error_callback;
Rohit Grover 22:c6ee8136847e 73
Rohit Grover 22:c6ee8136847e 74 ASSERT_STATUS ( ble_conn_params_init(&cp_init));
Rohit Grover 56:a1071b629aa3 75 #endif // SDK_CONN_PARAMS_MODULE_ENABLE
Rohit Grover 22:c6ee8136847e 76
Rohit Grover 22:c6ee8136847e 77 return ERROR_NONE;
Rohit Grover 22:c6ee8136847e 78 }
Rohit Grover 22:c6ee8136847e 79
Rohit Grover 22:c6ee8136847e 80 /**************************************************************************/
Rohit Grover 22:c6ee8136847e 81 /*!
Rohit Grover 22:c6ee8136847e 82 @brief Converts msecs to an integer representing 1.25ms units
Rohit Grover 22:c6ee8136847e 83
Rohit Grover 22:c6ee8136847e 84 @param[in] ms
Rohit Grover 22:c6ee8136847e 85 The number of milliseconds to conver to 1.25ms units
Rohit Grover 22:c6ee8136847e 86
Rohit Grover 22:c6ee8136847e 87 @returns The number of 1.25ms units in the supplied number of ms
Rohit Grover 22:c6ee8136847e 88 */
Rohit Grover 22:c6ee8136847e 89 /**************************************************************************/
Rohit Grover 22:c6ee8136847e 90 static inline uint32_t msec_to_1_25msec(uint32_t interval_ms)
Rohit Grover 22:c6ee8136847e 91 {
Rohit Grover 22:c6ee8136847e 92 return (interval_ms * 4) / 5;
Rohit Grover 22:c6ee8136847e 93 }
Rohit Grover 22:c6ee8136847e 94
Rohit Grover 56:a1071b629aa3 95 #if SDK_CONN_PARAMS_MODULE_ENABLE
Rohit Grover 22:c6ee8136847e 96 static void error_callback(uint32_t nrf_error)
Rohit Grover 22:c6ee8136847e 97 {
Rohit Grover 22:c6ee8136847e 98 ASSERT_STATUS_RET_VOID( nrf_error );
Rohit Grover 22:c6ee8136847e 99 }
Rohit Grover 56:a1071b629aa3 100 #endif // SDK_CONN_PARAMS_MODULE_ENABLE