Jonathan Austin / 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.

Dependents:   microbit_rubber_ducky microbit_mouse_BLE microbit_mouse_BLE_daybreak_version microbit_presenter

Fork of nRF51822 by Nordic Semiconductor

nordic-sdk/components/libraries/bootloader_dfu/dfu.h@345:dfde56236c36, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:55:35 2015 +0100
Revision:
345:dfde56236c36
Parent:
343:6675661fa600
Child:
346:14b090482fd2
Synchronized with git rev fbfc6d16

Author: Andrew Fernandes

Fix various GCC compilation issues.

Who changed what in which revision?

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