Cefn Hoile / nRF51822

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   nrf51-sdk

Dependents:   microbit-dal

Fork of nRF51822 by Lancaster University

nordic-sdk/components/libraries/bootloader_dfu/dfu.h@386:3253b512fb24, 2015-07-21 (annotated)

Committer:
rgrover1
Date:
Tue Jul 21 13:23:43 2015 +0100
Revision:
386:3253b512fb24
Parent:
source/nordic-sdk/components/libraries/bootloader_dfu/dfu.h@381:c997e9717fb7 
Synchronized with git rev 928a5e63

Author: Rohit Grover

Release 0.4.1

=============



This is a minor release.



Enhancements

~~~~~~~~~~~~



* Hide duplicate symbol definitions in ble_types.h. These have already been

  brought into ble/blecommon.h.



* Replace DiscoveredCharacteristic::setupOnDataRead() with

  GattClient::onDataRead().



* Implement new API GattServer::areUpdatesEnabled() to determine notification

  status for a characteristic.



Bugfixes

~~~~~~~~



* fix for #20: GattServer::addService() incorrectly initialized value

  attribute-handles. These were getting confused with characteristicIndex.

  Event handlers also return attribute handles correctly now; they were also

  previously returning characteristic indices.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 371:8f7d2137727a 1 /*
rgrover1 371:8f7d2137727a 2 * Copyright (c) Nordic Semiconductor ASA
rgrover1 371:8f7d2137727a 3 * All rights reserved.
rgrover1 371:8f7d2137727a 4 *
rgrover1 371:8f7d2137727a 5 * Redistribution and use in source and binary forms, with or without modification,
rgrover1 371:8f7d2137727a 6 * are permitted provided that the following conditions are met:
rgrover1 371:8f7d2137727a 7 *
rgrover1 371:8f7d2137727a 8 * 1. Redistributions of source code must retain the above copyright notice, this
rgrover1 371:8f7d2137727a 9 * list of conditions and the following disclaimer.
rgrover1 371:8f7d2137727a 10 *
rgrover1 371:8f7d2137727a 11 * 2. Redistributions in binary form must reproduce the above copyright notice, this
rgrover1 371:8f7d2137727a 12 * list of conditions and the following disclaimer in the documentation and/or
rgrover1 371:8f7d2137727a 13 * other materials provided with the distribution.
rgrover1 371:8f7d2137727a 14 *
rgrover1 371:8f7d2137727a 15 * 3. Neither the name of Nordic Semiconductor ASA nor the names of other
rgrover1 371:8f7d2137727a 16 * contributors to this software may be used to endorse or promote products
rgrover1 371:8f7d2137727a 17 * derived from this software without specific prior written permission.
rgrover1 371:8f7d2137727a 18 *
rgrover1 371:8f7d2137727a 19 *
rgrover1 371:8f7d2137727a 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
rgrover1 371:8f7d2137727a 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
rgrover1 371:8f7d2137727a 22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
rgrover1 371:8f7d2137727a 23 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
rgrover1 371:8f7d2137727a 24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
rgrover1 371:8f7d2137727a 25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
rgrover1 371:8f7d2137727a 26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
rgrover1 371:8f7d2137727a 27 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
rgrover1 371:8f7d2137727a 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
rgrover1 371:8f7d2137727a 29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
rgrover1 371:8f7d2137727a 30 *
rgrover1 371:8f7d2137727a 31 */
rgrover1 371:8f7d2137727a 32
rgrover1 371:8f7d2137727a 33 /**@file
rgrover1 371:8f7d2137727a 34 *
rgrover1 371:8f7d2137727a 35 * @defgroup nrf_dfu Device Firmware Update API.
rgrover1 371:8f7d2137727a 36 * @{
rgrover1 371:8f7d2137727a 37 *
rgrover1 371:8f7d2137727a 38 * @brief Device Firmware Update module interface.
rgrover1 371:8f7d2137727a 39 */
rgrover1 371:8f7d2137727a 40
rgrover1 371:8f7d2137727a 41 #ifndef DFU_H__
rgrover1 371:8f7d2137727a 42 #define DFU_H__
rgrover1 371:8f7d2137727a 43
rgrover1 371:8f7d2137727a 44 #include "dfu_types.h"
rgrover1 371:8f7d2137727a 45 #include <stdbool.h>
rgrover1 371:8f7d2137727a 46 #include <stdint.h>
rgrover1 371:8f7d2137727a 47
rgrover1 371:8f7d2137727a 48
rgrover1 371:8f7d2137727a 49 /**@brief DFU event callback for asynchronous calls.
rgrover1 371:8f7d2137727a 50 *
rgrover1 371:8f7d2137727a 51 * @param[in] packet Packet type for which this callback is related. START_PACKET, DATA_PACKET.
rgrover1 371:8f7d2137727a 52 * @param[in] result Operation result code. NRF_SUCCESS when a queued operation was successful.
rgrover1 371:8f7d2137727a 53 * @param[in] p_data Pointer to the data to which the operation is related.
rgrover1 371:8f7d2137727a 54 */
rgrover1 371:8f7d2137727a 55 typedef void (*dfu_callback_t)(uint32_t packet, uint32_t result, uint8_t * p_data);
rgrover1 371:8f7d2137727a 56
rgrover1 371:8f7d2137727a 57 /**@brief Function for initializing the Device Firmware Update module.
rgrover1 371:8f7d2137727a 58 *
rgrover1 371:8f7d2137727a 59 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 371:8f7d2137727a 60 */
rgrover1 371:8f7d2137727a 61 uint32_t dfu_init(void);
rgrover1 371:8f7d2137727a 62
rgrover1 371:8f7d2137727a 63 /**@brief Function for registering a callback listener for \ref dfu_data_pkt_handle callbacks.
rgrover1 371:8f7d2137727a 64 *
rgrover1 371:8f7d2137727a 65 * @param[in] callback_handler Callback handler for receiving DFU events on completed operations
rgrover1 371:8f7d2137727a 66 * of DFU packets.
rgrover1 371:8f7d2137727a 67 */
rgrover1 371:8f7d2137727a 68 void dfu_register_callback(dfu_callback_t callback_handler);
rgrover1 371:8f7d2137727a 69
rgrover1 371:8f7d2137727a 70 /**@brief Function for setting the DFU image size.
rgrover1 371:8f7d2137727a 71 *
rgrover1 371:8f7d2137727a 72 * @details Function sets the DFU image size. This function must be called when an update is started
rgrover1 371:8f7d2137727a 73 * in order to notify the DFU of the new image size. If multiple images are to be
rgrover1 371:8f7d2137727a 74 * transferred within the same update context then this function must be called with size
rgrover1 371:8f7d2137727a 75 * information for each image being transfered.
rgrover1 371:8f7d2137727a 76 * If an image type is not being transfered, e.g. SoftDevice but no Application , then the
rgrover1 371:8f7d2137727a 77 * image size for application must be zero.
rgrover1 371:8f7d2137727a 78 *
rgrover1 371:8f7d2137727a 79 * @param[in] p_packet Pointer to the DFU packet containing information on DFU update process to
rgrover1 371:8f7d2137727a 80 * be started.
rgrover1 371:8f7d2137727a 81 *
rgrover1 371:8f7d2137727a 82 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 371:8f7d2137727a 83 */
rgrover1 371:8f7d2137727a 84 uint32_t dfu_start_pkt_handle(dfu_update_packet_t * p_packet);
rgrover1 371:8f7d2137727a 85
rgrover1 371:8f7d2137727a 86 /**@brief Function for handling DFU data packets.
rgrover1 371:8f7d2137727a 87 *
rgrover1 371:8f7d2137727a 88 * @param[in] p_packet Pointer to the DFU packet.
rgrover1 371:8f7d2137727a 89 *
rgrover1 371:8f7d2137727a 90 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 371:8f7d2137727a 91 */
rgrover1 371:8f7d2137727a 92 uint32_t dfu_data_pkt_handle(dfu_update_packet_t * p_packet);
rgrover1 371:8f7d2137727a 93
rgrover1 371:8f7d2137727a 94 /**@brief Function for handling DFU init packets.
rgrover1 371:8f7d2137727a 95 *
rgrover1 371:8f7d2137727a 96 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 371:8f7d2137727a 97 */
rgrover1 371:8f7d2137727a 98 uint32_t dfu_init_pkt_handle(dfu_update_packet_t * p_packet);
rgrover1 371:8f7d2137727a 99
rgrover1 371:8f7d2137727a 100 /**@brief Function for validating a transferred image after the transfer has completed.
rgrover1 371:8f7d2137727a 101 *
rgrover1 371:8f7d2137727a 102 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 371:8f7d2137727a 103 */
rgrover1 371:8f7d2137727a 104 uint32_t dfu_image_validate(void);
rgrover1 371:8f7d2137727a 105
rgrover1 371:8f7d2137727a 106 /**@brief Function for activating the transfered image after validation has successfully completed.
rgrover1 371:8f7d2137727a 107 *
rgrover1 371:8f7d2137727a 108 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 371:8f7d2137727a 109 */
rgrover1 371:8f7d2137727a 110 uint32_t dfu_image_activate(void);
rgrover1 371:8f7d2137727a 111
rgrover1 371:8f7d2137727a 112 /**@brief Function for reseting the current update procedure and return to initial state.
rgrover1 371:8f7d2137727a 113 *
rgrover1 371:8f7d2137727a 114 * @details This function call will result in a system reset to ensure correct system behavior.
rgrover1 371:8f7d2137727a 115 * The reset will might be scheduled to execute at a later point in time to ensure pending
rgrover1 371:8f7d2137727a 116 * flash operations has completed.
rgrover1 371:8f7d2137727a 117 */
rgrover1 371:8f7d2137727a 118 void dfu_reset(void);
rgrover1 371:8f7d2137727a 119
rgrover1 371:8f7d2137727a 120 /**@brief Function for validating that new bootloader has been correctly installed.
rgrover1 371:8f7d2137727a 121 *
rgrover1 371:8f7d2137727a 122 * @return NRF_SUCCESS if install was successful. NRF_ERROR_NULL if the images differs.
rgrover1 371:8f7d2137727a 123 */
rgrover1 371:8f7d2137727a 124 uint32_t dfu_bl_image_validate(void);
rgrover1 371:8f7d2137727a 125
rgrover1 371:8f7d2137727a 126 /**@brief Function for validating that new SoftDevicehas been correctly installed.
rgrover1 371:8f7d2137727a 127 *
rgrover1 371:8f7d2137727a 128 * @return NRF_SUCCESS if install was successful. NRF_ERROR_NULL if the images differs.
rgrover1 371:8f7d2137727a 129 */
rgrover1 371:8f7d2137727a 130 uint32_t dfu_sd_image_validate(void);
rgrover1 371:8f7d2137727a 131
rgrover1 371:8f7d2137727a 132 /**@brief Function for swapping existing bootloader with newly received.
rgrover1 371:8f7d2137727a 133 *
rgrover1 371:8f7d2137727a 134 * @return NRF_SUCCESS on succesfull swapping. For error code please refer to
rgrover1 371:8f7d2137727a 135 * \ref sd_mbr_command_copy_bl_t.
rgrover1 371:8f7d2137727a 136 */
rgrover1 371:8f7d2137727a 137 uint32_t dfu_bl_image_swap(void);
rgrover1 371:8f7d2137727a 138
rgrover1 371:8f7d2137727a 139 /**@brief Function for swapping existing SoftDevice with newly received.
rgrover1 371:8f7d2137727a 140 *
rgrover1 371:8f7d2137727a 141 * @return NRF_SUCCESS on succesfull swapping. For error code please refer to
rgrover1 371:8f7d2137727a 142 * \ref sd_mbr_command_copy_sd_t.
rgrover1 371:8f7d2137727a 143 */
rgrover1 371:8f7d2137727a 144 uint32_t dfu_sd_image_swap(void);
rgrover1 371:8f7d2137727a 145
rgrover1 371:8f7d2137727a 146 /**@brief Function for handling DFU init packet complete.
rgrover1 371:8f7d2137727a 147 *
rgrover1 371:8f7d2137727a 148 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 371:8f7d2137727a 149 */
rgrover1 371:8f7d2137727a 150 uint32_t dfu_init_pkt_complete(void);
rgrover1 371:8f7d2137727a 151
rgrover1 371:8f7d2137727a 152 #endif // DFU_H__
rgrover1 371:8f7d2137727a 153
rgrover1 371:8f7d2137727a 154 /** @} */