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@370:295f76db798e, 2015-07-06 (annotated)

Committer:
rgrover1
Date:
Mon Jul 06 10:13:26 2015 +0100
Revision:
370:295f76db798e
Parent:
362:6fa0d4d555f6
Child:
371:8f7d2137727a
Synchronized with git rev 9f72c4ba

Author: Rohit Grover

Release 0.3.7

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



This is a minor set of enhancements mostly around reduce our global static

memory footprint.



Enhancements

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



* Reduce the maximum number of CHARACTERISTICS and DESCRIPTORS that can be

  handled. This has memory implications for static global memory. It should

  be possible to re-architect our solution for add_characteristic() to not

  require these limits; hopefully we'll get there soon.



* Move nRF51GattServer::getInstance() into a .cpp file; same for nRF51Gap::getInstance().



* Reduce max bonds to managed by device-manager to 4; this has memory implications for static global memory.



* Reduce pStorage command queue size to 2; this has memory implications for static global memory.



* Replace uses of deprecated Gap::addr_type_t with Gap::AddressType_t.



* Some UUID-related types have moved into UUID class. Minor changes were needed to work around build errors.



Bugfixes

~~~~~~~~



* None.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 370:295f76db798e 1 /* Copyright (c) 2013 Nordic Semiconductor. All Rights Reserved.
rgrover1 370:295f76db798e 2 *
rgrover1 370:295f76db798e 3 * The information contained herein is property of Nordic Semiconductor ASA.
rgrover1 370:295f76db798e 4 * Terms and conditions of usage are described in detail in NORDIC
rgrover1 370:295f76db798e 5 * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
rgrover1 370:295f76db798e 6 *
rgrover1 370:295f76db798e 7 * Licensees are granted free, non-transferable use of the information. NO
rgrover1 370:295f76db798e 8 * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
rgrover1 370:295f76db798e 9 * the file.
rgrover1 370:295f76db798e 10 *
rgrover1 370:295f76db798e 11 */
rgrover1 370:295f76db798e 12
rgrover1 370:295f76db798e 13 /**@file
rgrover1 370:295f76db798e 14 *
rgrover1 370:295f76db798e 15 * @defgroup nrf_dfu Device Firmware Update API.
rgrover1 370:295f76db798e 16 * @{
rgrover1 370:295f76db798e 17 *
rgrover1 370:295f76db798e 18 * @brief Device Firmware Update module interface.
rgrover1 370:295f76db798e 19 */
rgrover1 370:295f76db798e 20
rgrover1 370:295f76db798e 21 #ifndef DFU_H__
rgrover1 370:295f76db798e 22 #define DFU_H__
rgrover1 370:295f76db798e 23
rgrover1 370:295f76db798e 24 #include "dfu_types.h"
rgrover1 370:295f76db798e 25 #include <stdbool.h>
rgrover1 370:295f76db798e 26 #include <stdint.h>
rgrover1 370:295f76db798e 27
rgrover1 370:295f76db798e 28
rgrover1 370:295f76db798e 29 /**@brief DFU event callback for asynchronous calls.
rgrover1 370:295f76db798e 30 *
rgrover1 370:295f76db798e 31 * @param[in] packet Packet type for which this callback is related. START_PACKET, DATA_PACKET.
rgrover1 370:295f76db798e 32 * @param[in] result Operation result code. NRF_SUCCESS when a queued operation was successful.
rgrover1 370:295f76db798e 33 * @param[in] p_data Pointer to the data to which the operation is related.
rgrover1 370:295f76db798e 34 */
rgrover1 370:295f76db798e 35 typedef void (*dfu_callback_t)(uint32_t packet, uint32_t result, uint8_t * p_data);
rgrover1 370:295f76db798e 36
rgrover1 370:295f76db798e 37 /**@brief Function for initializing the Device Firmware Update module.
rgrover1 370:295f76db798e 38 *
rgrover1 370:295f76db798e 39 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 370:295f76db798e 40 */
rgrover1 370:295f76db798e 41 uint32_t dfu_init(void);
rgrover1 370:295f76db798e 42
rgrover1 370:295f76db798e 43 /**@brief Function for registering a callback listener for \ref dfu_data_pkt_handle callbacks.
rgrover1 370:295f76db798e 44 *
rgrover1 370:295f76db798e 45 * @param[in] callback_handler Callback handler for receiving DFU events on completed operations
rgrover1 370:295f76db798e 46 * of DFU packets.
rgrover1 370:295f76db798e 47 */
rgrover1 370:295f76db798e 48 void dfu_register_callback(dfu_callback_t callback_handler);
rgrover1 370:295f76db798e 49
rgrover1 370:295f76db798e 50 /**@brief Function for setting the DFU image size.
rgrover1 370:295f76db798e 51 *
rgrover1 370:295f76db798e 52 * @details Function sets the DFU image size. This function must be called when an update is started
rgrover1 370:295f76db798e 53 * in order to notify the DFU of the new image size. If multiple images are to be
rgrover1 370:295f76db798e 54 * transferred within the same update context then this function must be called with size
rgrover1 370:295f76db798e 55 * information for each image being transfered.
rgrover1 370:295f76db798e 56 * If an image type is not being transfered, e.g. SoftDevice but no Application , then the
rgrover1 370:295f76db798e 57 * image size for application must be zero.
rgrover1 370:295f76db798e 58 *
rgrover1 370:295f76db798e 59 * @param[in] p_packet Pointer to the DFU packet containing information on DFU update process to
rgrover1 370:295f76db798e 60 * be started.
rgrover1 370:295f76db798e 61 *
rgrover1 370:295f76db798e 62 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 370:295f76db798e 63 */
rgrover1 370:295f76db798e 64 uint32_t dfu_start_pkt_handle(dfu_update_packet_t * p_packet);
rgrover1 370:295f76db798e 65
rgrover1 370:295f76db798e 66 /**@brief Function for handling DFU data packets.
rgrover1 370:295f76db798e 67 *
rgrover1 370:295f76db798e 68 * @param[in] p_packet Pointer to the DFU packet.
rgrover1 370:295f76db798e 69 *
rgrover1 370:295f76db798e 70 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 370:295f76db798e 71 */
rgrover1 370:295f76db798e 72 uint32_t dfu_data_pkt_handle(dfu_update_packet_t * p_packet);
rgrover1 370:295f76db798e 73
rgrover1 370:295f76db798e 74 /**@brief Function for handling DFU init packets.
rgrover1 370:295f76db798e 75 *
rgrover1 370:295f76db798e 76 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 370:295f76db798e 77 */
rgrover1 370:295f76db798e 78 uint32_t dfu_init_pkt_handle(dfu_update_packet_t * p_packet);
rgrover1 370:295f76db798e 79
rgrover1 370:295f76db798e 80 /**@brief Function for validating a transferred image after the transfer has completed.
rgrover1 370:295f76db798e 81 *
rgrover1 370:295f76db798e 82 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 370:295f76db798e 83 */
rgrover1 370:295f76db798e 84 uint32_t dfu_image_validate(void);
rgrover1 370:295f76db798e 85
rgrover1 370:295f76db798e 86 /**@brief Function for activating the transfered image after validation has successfully completed.
rgrover1 370:295f76db798e 87 *
rgrover1 370:295f76db798e 88 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 370:295f76db798e 89 */
rgrover1 370:295f76db798e 90 uint32_t dfu_image_activate(void);
rgrover1 370:295f76db798e 91
rgrover1 370:295f76db798e 92 /**@brief Function for reseting the current update procedure and return to initial state.
rgrover1 370:295f76db798e 93 *
rgrover1 370:295f76db798e 94 * @details This function call will result in a system reset to ensure correct system behavior.
rgrover1 370:295f76db798e 95 * The reset will might be scheduled to execute at a later point in time to ensure pending
rgrover1 370:295f76db798e 96 * flash operations has completed.
rgrover1 370:295f76db798e 97 */
rgrover1 370:295f76db798e 98 void dfu_reset(void);
rgrover1 370:295f76db798e 99
rgrover1 370:295f76db798e 100 /**@brief Function for validating that new bootloader has been correctly installed.
rgrover1 370:295f76db798e 101 *
rgrover1 370:295f76db798e 102 * @return NRF_SUCCESS if install was successful. NRF_ERROR_NULL if the images differs.
rgrover1 370:295f76db798e 103 */
rgrover1 370:295f76db798e 104 uint32_t dfu_bl_image_validate(void);
rgrover1 370:295f76db798e 105
rgrover1 370:295f76db798e 106 /**@brief Function for validating that new SoftDevicehas been correctly installed.
rgrover1 370:295f76db798e 107 *
rgrover1 370:295f76db798e 108 * @return NRF_SUCCESS if install was successful. NRF_ERROR_NULL if the images differs.
rgrover1 370:295f76db798e 109 */
rgrover1 370:295f76db798e 110 uint32_t dfu_sd_image_validate(void);
rgrover1 370:295f76db798e 111
rgrover1 370:295f76db798e 112 /**@brief Function for swapping existing bootloader with newly received.
rgrover1 370:295f76db798e 113 *
rgrover1 370:295f76db798e 114 * @return NRF_SUCCESS on succesfull swapping. For error code please refer to
rgrover1 370:295f76db798e 115 * \ref sd_mbr_command_copy_bl_t.
rgrover1 370:295f76db798e 116 */
rgrover1 370:295f76db798e 117 uint32_t dfu_bl_image_swap(void);
rgrover1 370:295f76db798e 118
rgrover1 370:295f76db798e 119 /**@brief Function for swapping existing SoftDevice with newly received.
rgrover1 370:295f76db798e 120 *
rgrover1 370:295f76db798e 121 * @return NRF_SUCCESS on succesfull swapping. For error code please refer to
rgrover1 370:295f76db798e 122 * \ref sd_mbr_command_copy_sd_t.
rgrover1 370:295f76db798e 123 */
rgrover1 370:295f76db798e 124 uint32_t dfu_sd_image_swap(void);
rgrover1 370:295f76db798e 125
rgrover1 370:295f76db798e 126 /**@brief Function for handling DFU init packet complete.
rgrover1 370:295f76db798e 127 *
rgrover1 370:295f76db798e 128 * @return NRF_SUCCESS on success, an error_code otherwise.
rgrover1 370:295f76db798e 129 */
rgrover1 370:295f76db798e 130 uint32_t dfu_init_pkt_complete(void);
rgrover1 370:295f76db798e 131
rgrover1 370:295f76db798e 132 #endif // DFU_H__
rgrover1 370:295f76db798e 133
rgrover1 370:295f76db798e 134 /** @} */