Cefn Hoile / nRF51822

Dependencies:   nrf51-sdk

Dependents:   microbit-dal

Fork of nRF51822 by Lancaster University

Committer:
rgrover1
Date:
Thu Jul 02 09:08:44 2015 +0100
Revision:
362:6fa0d4d555f6
Parent:
361:d2405f5a4853
Child:
370:295f76db798e
Synchronized with git rev 2716309c
Author: Rohit Grover
Release 0.4.0
=============

This is a major release which introduces the GATT Client functionality. It
aligns with release 0.4.0 of BLE_API.

Enhancements
~~~~~~~~~~~~

* Introduce GattClient. This includes functionality for service-discovery,
connections, and attribute-reads and writes. You'll find a demo program for
LEDBlinker on the mbed.org Bluetooth team page to use the new APIs. Some of
the GATT client functionality hasn't been implemented yet, but the APIs have
been added.

* We've added an implementation for the abstract base class for
SecurityManager. All security related APIs have been moved into that.

* There has been a major cleanup of APIs under BLE. APIs have now been
categorized as belonging to Gap, GattServer, GattClient, or SecurityManager.
There are accessors to get references for Gap, GattServer, GattClient, and
SecurityManager. A former call to ble.setAddress(...) is now expected to be
achieved with ble.gap().setAddress(...).

* We've cleaned up our APIs, and this has resulted in dropping some APIs like
BLE::reset().

* We've also dropped GattServer::initializeGattDatabase(). THis was added at
some point to support controllers where a commit point was needed to
indicate when the application had finished constructing the GATT database.
This API would get called internally before Gap::startAdvertising(). We now
expect the underlying port to do the equivalent of initializeGattDatabase()
implicitly upon Gap::startAdvertising().

* We've added a version of Gap::disconnect() which takes a connection handle.
The previous API (which did not take a connection handle) has been
deprecated; it will still work for situations where there's only a single
active connection. We hold on to that API to allow existing code to migrate
to the new API.

Bugfixes
~~~~~~~~

* None.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 362:6fa0d4d555f6 1 /*
rgrover1 362:6fa0d4d555f6 2 * Copyright (c) Nordic Semiconductor ASA
rgrover1 362:6fa0d4d555f6 3 * All rights reserved.
rgrover1 362:6fa0d4d555f6 4 *
rgrover1 362:6fa0d4d555f6 5 * Redistribution and use in source and binary forms, with or without modification,
rgrover1 362:6fa0d4d555f6 6 * are permitted provided that the following conditions are met:
rgrover1 362:6fa0d4d555f6 7 *
rgrover1 362:6fa0d4d555f6 8 * 1. Redistributions of source code must retain the above copyright notice, this
rgrover1 362:6fa0d4d555f6 9 * list of conditions and the following disclaimer.
rgrover1 362:6fa0d4d555f6 10 *
rgrover1 362:6fa0d4d555f6 11 * 2. Redistributions in binary form must reproduce the above copyright notice, this
rgrover1 362:6fa0d4d555f6 12 * list of conditions and the following disclaimer in the documentation and/or
rgrover1 362:6fa0d4d555f6 13 * other materials provided with the distribution.
rgrover1 362:6fa0d4d555f6 14 *
rgrover1 362:6fa0d4d555f6 15 * 3. Neither the name of Nordic Semiconductor ASA nor the names of other
rgrover1 362:6fa0d4d555f6 16 * contributors to this software may be used to endorse or promote products
rgrover1 362:6fa0d4d555f6 17 * derived from this software without specific prior written permission.
rgrover1 362:6fa0d4d555f6 18 *
rgrover1 362:6fa0d4d555f6 19 *
rgrover1 362:6fa0d4d555f6 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
rgrover1 362:6fa0d4d555f6 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
rgrover1 362:6fa0d4d555f6 22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
rgrover1 362:6fa0d4d555f6 23 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
rgrover1 362:6fa0d4d555f6 24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
rgrover1 362:6fa0d4d555f6 25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
rgrover1 362:6fa0d4d555f6 26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
rgrover1 362:6fa0d4d555f6 27 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
rgrover1 362:6fa0d4d555f6 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
rgrover1 362:6fa0d4d555f6 29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
rgrover1 362:6fa0d4d555f6 30 *
rgrover1 362:6fa0d4d555f6 31 */
rgrover1 362:6fa0d4d555f6 32
rgrover1 362:6fa0d4d555f6 33 /**@file
rgrover1 362:6fa0d4d555f6 34 *
rgrover1 362:6fa0d4d555f6 35 * @defgroup nrf_bootloader Bootloader API.
rgrover1 362:6fa0d4d555f6 36 * @{
rgrover1 362:6fa0d4d555f6 37 *
rgrover1 362:6fa0d4d555f6 38 * @brief Bootloader module interface.
rgrover1 362:6fa0d4d555f6 39 */
rgrover1 362:6fa0d4d555f6 40
rgrover1 362:6fa0d4d555f6 41 #ifndef BOOTLOADER_H__
rgrover1 362:6fa0d4d555f6 42 #define BOOTLOADER_H__
rgrover1 362:6fa0d4d555f6 43
rgrover1 362:6fa0d4d555f6 44 #include <stdbool.h>
rgrover1 362:6fa0d4d555f6 45 #include <stdint.h>
rgrover1 362:6fa0d4d555f6 46 #include "bootloader_types.h"
rgrover1 362:6fa0d4d555f6 47 #include "dfu_types.h"
rgrover1 362:6fa0d4d555f6 48
rgrover1 362:6fa0d4d555f6 49 /**@brief Function for initializing the Bootloader.
rgrover1 362:6fa0d4d555f6 50 *
rgrover1 362:6fa0d4d555f6 51 * @retval NRF_SUCCESS If bootloader was succesfully initialized.
rgrover1 362:6fa0d4d555f6 52 */
rgrover1 362:6fa0d4d555f6 53 uint32_t bootloader_init(void);
rgrover1 362:6fa0d4d555f6 54
rgrover1 362:6fa0d4d555f6 55 /**@brief Function for validating application region in flash.
rgrover1 362:6fa0d4d555f6 56 *
rgrover1 362:6fa0d4d555f6 57 * @param[in] app_addr Address to the region in flash where the application is stored.
rgrover1 362:6fa0d4d555f6 58 *
rgrover1 362:6fa0d4d555f6 59 * @retval true If Application region is valid.
rgrover1 362:6fa0d4d555f6 60 * @retval false If Application region is not valid.
rgrover1 362:6fa0d4d555f6 61 */
rgrover1 362:6fa0d4d555f6 62 bool bootloader_app_is_valid(uint32_t app_addr);
rgrover1 362:6fa0d4d555f6 63
rgrover1 362:6fa0d4d555f6 64 /**@brief Function for starting the Device Firmware Update.
rgrover1 362:6fa0d4d555f6 65 *
rgrover1 362:6fa0d4d555f6 66 * @retval NRF_SUCCESS If new application image was successfully transferred.
rgrover1 362:6fa0d4d555f6 67 */
rgrover1 362:6fa0d4d555f6 68 uint32_t bootloader_dfu_start(void);
rgrover1 362:6fa0d4d555f6 69
rgrover1 362:6fa0d4d555f6 70 /**@brief Function for exiting bootloader and booting into application.
rgrover1 362:6fa0d4d555f6 71 *
rgrover1 362:6fa0d4d555f6 72 * @details This function will disable SoftDevice and all interrupts before jumping to application.
rgrover1 362:6fa0d4d555f6 73 * The SoftDevice vector table base for interrupt forwarding will be set the application
rgrover1 362:6fa0d4d555f6 74 * address.
rgrover1 362:6fa0d4d555f6 75 *
rgrover1 362:6fa0d4d555f6 76 * @param[in] app_addr Address to the region where the application is stored.
rgrover1 362:6fa0d4d555f6 77 */
rgrover1 362:6fa0d4d555f6 78 void bootloader_app_start(uint32_t app_addr);
rgrover1 362:6fa0d4d555f6 79
rgrover1 362:6fa0d4d555f6 80 /**@brief Function for retrieving the bootloader settings.
rgrover1 362:6fa0d4d555f6 81 *
rgrover1 362:6fa0d4d555f6 82 * @param[out] p_settings A copy of the current bootloader settings is returned in the structure
rgrover1 362:6fa0d4d555f6 83 * provided.
rgrover1 362:6fa0d4d555f6 84 */
rgrover1 362:6fa0d4d555f6 85 void bootloader_settings_get(bootloader_settings_t * const p_settings);
rgrover1 362:6fa0d4d555f6 86
rgrover1 362:6fa0d4d555f6 87 /**@brief Function for processing DFU status update.
rgrover1 362:6fa0d4d555f6 88 *
rgrover1 362:6fa0d4d555f6 89 * @param[in] update_status DFU update status.
rgrover1 362:6fa0d4d555f6 90 */
rgrover1 362:6fa0d4d555f6 91 void bootloader_dfu_update_process(dfu_update_status_t update_status);
rgrover1 362:6fa0d4d555f6 92
rgrover1 362:6fa0d4d555f6 93 /**@brief Function getting state of SoftDevice update in progress.
rgrover1 362:6fa0d4d555f6 94 * After a successfull SoftDevice transfer the system restarts in orderto disable SoftDevice
rgrover1 362:6fa0d4d555f6 95 * and complete the update.
rgrover1 362:6fa0d4d555f6 96 *
rgrover1 362:6fa0d4d555f6 97 * @retval true A SoftDevice update is in progress. This indicates that second stage
rgrover1 362:6fa0d4d555f6 98 * of a SoftDevice update procedure can be initiated.
rgrover1 362:6fa0d4d555f6 99 * @retval false No SoftDevice update is in progress.
rgrover1 362:6fa0d4d555f6 100 */
rgrover1 362:6fa0d4d555f6 101 bool bootloader_dfu_sd_in_progress(void);
rgrover1 362:6fa0d4d555f6 102
rgrover1 362:6fa0d4d555f6 103 /**@brief Function for continuing the Device Firmware Update of a SoftDevice.
rgrover1 362:6fa0d4d555f6 104 *
rgrover1 362:6fa0d4d555f6 105 * @retval NRF_SUCCESS If the final stage of SoftDevice update was successful.
rgrover1 362:6fa0d4d555f6 106 */
rgrover1 362:6fa0d4d555f6 107 uint32_t bootloader_dfu_sd_update_continue(void);
rgrover1 362:6fa0d4d555f6 108
rgrover1 362:6fa0d4d555f6 109 /**@brief Function for finalizing the Device Firmware Update of a SoftDevice.
rgrover1 362:6fa0d4d555f6 110 *
rgrover1 362:6fa0d4d555f6 111 * @retval NRF_SUCCESS If the final stage of SoftDevice update was successful.
rgrover1 362:6fa0d4d555f6 112 */
rgrover1 362:6fa0d4d555f6 113 uint32_t bootloader_dfu_sd_update_finalize(void);
rgrover1 362:6fa0d4d555f6 114
rgrover1 362:6fa0d4d555f6 115 #endif // BOOTLOADER_H__
rgrover1 362:6fa0d4d555f6 116
rgrover1 362:6fa0d4d555f6 117 /**@} */