Rob Kluin / 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.

Fork of nRF51822 by Nordic Semiconductor

nordic-sdk/components/libraries/bootloader_dfu/dfu.h@361:d2405f5a4853, 2015-07-02 (annotated)

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