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/bootloader.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_bootloader Bootloader API.
rgrover1 345:dfde56236c36 16 * @{
rgrover1 345:dfde56236c36 17 *
rgrover1 345:dfde56236c36 18 * @brief Bootloader module interface.
rgrover1 345:dfde56236c36 19 */
rgrover1 345:dfde56236c36 20
rgrover1 345:dfde56236c36 21 #ifndef BOOTLOADER_H__
rgrover1 345:dfde56236c36 22 #define BOOTLOADER_H__
rgrover1 345:dfde56236c36 23
rgrover1 345:dfde56236c36 24 #include <stdbool.h>
rgrover1 345:dfde56236c36 25 #include <stdint.h>
rgrover1 345:dfde56236c36 26 #include "bootloader_types.h"
rgrover1 345:dfde56236c36 27 #include "dfu_types.h"
rgrover1 345:dfde56236c36 28
rgrover1 345:dfde56236c36 29 /**@brief Function for initializing the Bootloader.
rgrover1 345:dfde56236c36 30 *
rgrover1 345:dfde56236c36 31 * @retval NRF_SUCCESS If bootloader was succesfully initialized.
rgrover1 345:dfde56236c36 32 */
rgrover1 345:dfde56236c36 33 uint32_t bootloader_init(void);
rgrover1 345:dfde56236c36 34
rgrover1 345:dfde56236c36 35 /**@brief Function for validating application region in flash.
rgrover1 345:dfde56236c36 36 *
rgrover1 345:dfde56236c36 37 * @param[in] app_addr Address to the region in flash where the application is stored.
rgrover1 345:dfde56236c36 38 *
rgrover1 345:dfde56236c36 39 * @retval true If Application region is valid.
rgrover1 345:dfde56236c36 40 * @retval false If Application region is not valid.
rgrover1 345:dfde56236c36 41 */
rgrover1 345:dfde56236c36 42 bool bootloader_app_is_valid(uint32_t app_addr);
rgrover1 345:dfde56236c36 43
rgrover1 345:dfde56236c36 44 /**@brief Function for starting the Device Firmware Update.
rgrover1 345:dfde56236c36 45 *
rgrover1 345:dfde56236c36 46 * @retval NRF_SUCCESS If new application image was successfully transferred.
rgrover1 345:dfde56236c36 47 */
rgrover1 345:dfde56236c36 48 uint32_t bootloader_dfu_start(void);
rgrover1 345:dfde56236c36 49
rgrover1 345:dfde56236c36 50 /**@brief Function for exiting bootloader and booting into application.
rgrover1 345:dfde56236c36 51 *
rgrover1 345:dfde56236c36 52 * @details This function will disable SoftDevice and all interrupts before jumping to application.
rgrover1 345:dfde56236c36 53 * The SoftDevice vector table base for interrupt forwarding will be set the application
rgrover1 345:dfde56236c36 54 * address.
rgrover1 345:dfde56236c36 55 *
rgrover1 345:dfde56236c36 56 * @param[in] app_addr Address to the region where the application is stored.
rgrover1 345:dfde56236c36 57 */
rgrover1 345:dfde56236c36 58 void bootloader_app_start(uint32_t app_addr);
rgrover1 345:dfde56236c36 59
rgrover1 345:dfde56236c36 60 /**@brief Function for retrieving the bootloader settings.
rgrover1 345:dfde56236c36 61 *
rgrover1 345:dfde56236c36 62 * @param[out] p_settings A copy of the current bootloader settings is returned in the structure
rgrover1 345:dfde56236c36 63 * provided.
rgrover1 345:dfde56236c36 64 */
rgrover1 345:dfde56236c36 65 void bootloader_settings_get(bootloader_settings_t * const p_settings);
rgrover1 345:dfde56236c36 66
rgrover1 345:dfde56236c36 67 /**@brief Function for processing DFU status update.
rgrover1 345:dfde56236c36 68 *
rgrover1 345:dfde56236c36 69 * @param[in] update_status DFU update status.
rgrover1 345:dfde56236c36 70 */
rgrover1 345:dfde56236c36 71 void bootloader_dfu_update_process(dfu_update_status_t update_status);
rgrover1 345:dfde56236c36 72
rgrover1 345:dfde56236c36 73 /**@brief Function getting state of SoftDevice update in progress.
rgrover1 345:dfde56236c36 74 * After a successfull SoftDevice transfer the system restarts in orderto disable SoftDevice
rgrover1 345:dfde56236c36 75 * and complete the update.
rgrover1 345:dfde56236c36 76 *
rgrover1 345:dfde56236c36 77 * @retval true A SoftDevice update is in progress. This indicates that second stage
rgrover1 345:dfde56236c36 78 * of a SoftDevice update procedure can be initiated.
rgrover1 345:dfde56236c36 79 * @retval false No SoftDevice update is in progress.
rgrover1 345:dfde56236c36 80 */
rgrover1 345:dfde56236c36 81 bool bootloader_dfu_sd_in_progress(void);
rgrover1 345:dfde56236c36 82
rgrover1 345:dfde56236c36 83 /**@brief Function for continuing the Device Firmware Update of a SoftDevice.
rgrover1 345:dfde56236c36 84 *
rgrover1 345:dfde56236c36 85 * @retval NRF_SUCCESS If the final stage of SoftDevice update was successful.
rgrover1 345:dfde56236c36 86 */
rgrover1 345:dfde56236c36 87 uint32_t bootloader_dfu_sd_update_continue(void);
rgrover1 345:dfde56236c36 88
rgrover1 345:dfde56236c36 89 /**@brief Function for finalizing the Device Firmware Update of a SoftDevice.
rgrover1 345:dfde56236c36 90 *
rgrover1 345:dfde56236c36 91 * @retval NRF_SUCCESS If the final stage of SoftDevice update was successful.
rgrover1 345:dfde56236c36 92 */
rgrover1 345:dfde56236c36 93 uint32_t bootloader_dfu_sd_update_finalize(void);
rgrover1 345:dfde56236c36 94
rgrover1 345:dfde56236c36 95 #endif // BOOTLOADER_H__
rgrover1 345:dfde56236c36 96
rgrover1 345:dfde56236c36 97 /**@} */