aboutsummaryrefslogtreecommitdiff
path: root/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/bootloader/dfu/nrf_dfu_settings.c
diff options
context:
space:
mode:
Diffstat (limited to 'thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/bootloader/dfu/nrf_dfu_settings.c')
-rw-r--r--thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/bootloader/dfu/nrf_dfu_settings.c241
1 files changed, 241 insertions, 0 deletions
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/bootloader/dfu/nrf_dfu_settings.c b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/bootloader/dfu/nrf_dfu_settings.c
new file mode 100644
index 0000000..13e89b4
--- /dev/null
+++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/bootloader/dfu/nrf_dfu_settings.c
@@ -0,0 +1,241 @@
+/**
+ * Copyright (c) 2016 - 2018, Nordic Semiconductor ASA
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form, except as embedded into a Nordic
+ * Semiconductor ASA integrated circuit in a product or a software update for
+ * such product, must reproduce the above copyright notice, this list of
+ * conditions and the following disclaimer in the documentation and/or other
+ * materials provided with the distribution.
+ *
+ * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * 4. This software, with or without modification, must only be used with a
+ * Nordic Semiconductor ASA integrated circuit.
+ *
+ * 5. Any software provided in binary form under this license must not be reverse
+ * engineered, decompiled, modified and/or disassembled.
+ *
+ * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
+ * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+ * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+#include "nrf_dfu_settings.h"
+#include <stddef.h>
+#include <string.h>
+#include "app_error.h"
+#include "nrf_dfu_flash.h"
+#include "nrf_soc.h"
+#include "crc32.h"
+#include "nrf_nvmc.h"
+
+#define DFU_SETTINGS_INIT_COMMAND_OFFSET offsetof(nrf_dfu_settings_t, init_command) //<! Offset in the settings struct where the InitCommand is located.
+
+#define NRF_LOG_MODULE_NAME nrf_dfu_settings
+#include "nrf_log.h"
+NRF_LOG_MODULE_REGISTER();
+
+
+/**@brief This variable reserves a page in flash for bootloader settings
+ * to ensure the linker doesn't place any code or variables at this location.
+ */
+#if defined (__CC_ARM )
+
+ uint8_t m_dfu_settings_buffer[BOOTLOADER_SETTINGS_PAGE_SIZE]
+ __attribute__((at(BOOTLOADER_SETTINGS_ADDRESS)))
+ __attribute__((used));
+
+#elif defined ( __GNUC__ ) || defined ( __SES_ARM )
+
+ uint8_t m_dfu_settings_buffer[BOOTLOADER_SETTINGS_PAGE_SIZE]
+ __attribute__((section(".bootloader_settings_page")))
+ __attribute__((used));
+
+#elif defined ( __ICCARM__ )
+
+ __no_init __root uint8_t m_dfu_settings_buffer[BOOTLOADER_SETTINGS_PAGE_SIZE]
+ @ BOOTLOADER_SETTINGS_ADDRESS;
+
+#else
+
+ #error Not a valid compiler/linker for m_dfu_settings placement.
+
+#endif // Compiler specific
+
+#ifndef BL_SETTINGS_ACCESS_ONLY
+#if defined(NRF52_SERIES)
+
+/**@brief This variable reserves a page in flash for MBR parameters
+ * to ensure the linker doesn't place any code or variables at this location.
+ */
+#if defined ( __CC_ARM )
+
+ uint8_t m_mbr_params_page[NRF_MBR_PARAMS_PAGE_SIZE]
+ __attribute__((at(NRF_MBR_PARAMS_PAGE_ADDRESS)))
+ __attribute__((used));
+
+#elif defined ( __GNUC__ ) || defined ( __SES_ARM )
+
+ uint8_t m_mbr_params_page[NRF_MBR_PARAMS_PAGE_SIZE]
+ __attribute__ ((section(".mbr_params_page")));
+
+#elif defined ( __ICCARM__ )
+
+ __no_init uint8_t m_mbr_params_page[NRF_MBR_PARAMS_PAGE_SIZE]
+ @ NRF_MBR_PARAMS_PAGE_ADDRESS;
+
+#else
+
+ #error Not a valid compiler/linker for m_mbr_params_page placement.
+
+#endif // Compiler specific
+
+
+/**@brief This variable has the linker write the MBR parameters page address to the
+ * UICR register. This value will be written in the HEX file and thus to the
+ * UICR when the bootloader is flashed into the chip.
+ */
+#if defined ( __CC_ARM )
+
+ uint32_t const m_uicr_mbr_params_page_address
+ __attribute__((at(NRF_UICR_MBR_PARAMS_PAGE_ADDRESS))) = NRF_MBR_PARAMS_PAGE_ADDRESS;
+
+#elif defined ( __GNUC__ ) || defined ( __SES_ARM )
+
+ uint32_t const m_uicr_mbr_params_page_address
+ __attribute__ ((section(".uicr_mbr_params_page")))
+ __attribute__ ((used)) = NRF_MBR_PARAMS_PAGE_ADDRESS;
+
+#elif defined ( __ICCARM__ )
+
+ __root uint32_t const m_uicr_mbr_params_page_address
+ @ NRF_UICR_MBR_PARAMS_PAGE_ADDRESS = NRF_MBR_PARAMS_PAGE_ADDRESS;
+
+#else
+
+ #error Not a valid compiler/linker for m_mbr_params_page placement.
+
+#endif // Compiler specific
+#endif // #if defined( NRF52_SERIES )
+#endif // #ifndef BL_SETTINGS_ACCESS_ONLY
+
+
+nrf_dfu_settings_t s_dfu_settings;
+
+
+static uint32_t nrf_dfu_settings_crc_get(void)
+{
+ // The crc is calculated from the s_dfu_settings struct, except the crc itself and the init command
+ return crc32_compute((uint8_t*)&s_dfu_settings + 4, DFU_SETTINGS_INIT_COMMAND_OFFSET - 4, NULL);
+}
+
+
+ret_code_t nrf_dfu_settings_init(bool sd_irq_initialized)
+{
+ NRF_LOG_DEBUG("Calling nrf_dfu_settings_init()...");
+
+ ret_code_t rc = nrf_dfu_flash_init(sd_irq_initialized);
+ if (rc != NRF_SUCCESS)
+ {
+ NRF_LOG_ERROR("nrf_dfu_flash_init() failed with error: %x", rc);
+ return NRF_ERROR_INTERNAL;
+ }
+
+ // Copy the DFU settings out of flash and into a buffer in RAM.
+ memcpy((void*)&s_dfu_settings, m_dfu_settings_buffer, sizeof(nrf_dfu_settings_t));
+
+ if (s_dfu_settings.crc != 0xFFFFFFFF)
+ {
+ // CRC is set. Content must be valid
+ uint32_t crc = nrf_dfu_settings_crc_get();
+ if (crc == s_dfu_settings.crc)
+ {
+ return NRF_SUCCESS;
+ }
+ }
+
+ // Reached if the page is erased or CRC is wrong.
+ NRF_LOG_DEBUG("Resetting bootloader settings.");
+
+ memset(&s_dfu_settings, 0x00, sizeof(nrf_dfu_settings_t));
+ s_dfu_settings.settings_version = NRF_DFU_SETTINGS_VERSION;
+
+ rc = nrf_dfu_settings_write(NULL);
+ if (rc != NRF_SUCCESS)
+ {
+ NRF_LOG_ERROR("nrf_dfu_flash_write() failed with error: %x", rc);
+ return NRF_ERROR_INTERNAL;
+ }
+ return NRF_SUCCESS;
+}
+
+
+ret_code_t nrf_dfu_settings_write(nrf_dfu_flash_callback_t callback)
+{
+ ret_code_t err_code;
+
+ if (memcmp(&s_dfu_settings, m_dfu_settings_buffer, sizeof(nrf_dfu_settings_t)) == 0)
+ {
+ NRF_LOG_DEBUG("New settings are identical to old, write not needed. Skipping.");
+ if (callback != NULL)
+ {
+ callback(NULL);
+ }
+ return NRF_SUCCESS;
+ }
+
+ NRF_LOG_DEBUG("Writing settings...");
+ NRF_LOG_DEBUG("Erasing old settings at: 0x%08x", (uint32_t)m_dfu_settings_buffer);
+
+ // Not setting the callback function because ERASE is required before STORE
+ // Only report completion on successful STORE.
+ err_code = nrf_dfu_flash_erase((uint32_t)m_dfu_settings_buffer, 1, NULL);
+
+ if (err_code != NRF_SUCCESS)
+ {
+ NRF_LOG_ERROR("Could not erase the settings page!");
+ return NRF_ERROR_INTERNAL;
+ }
+
+ s_dfu_settings.crc = nrf_dfu_settings_crc_get();
+
+ static nrf_dfu_settings_t temp_dfu_settings;
+ memcpy(&temp_dfu_settings, &s_dfu_settings, sizeof(nrf_dfu_settings_t));
+
+ err_code = nrf_dfu_flash_store((uint32_t)m_dfu_settings_buffer,
+ &temp_dfu_settings,
+ sizeof(nrf_dfu_settings_t),
+ callback);
+
+ if (err_code != NRF_SUCCESS)
+ {
+ NRF_LOG_ERROR("Could not write the DFU settings page!");
+ return NRF_ERROR_INTERNAL;
+ }
+
+ return NRF_SUCCESS;
+}
+
+__WEAK ret_code_t nrf_dfu_settings_additional_erase(void)
+{
+ NRF_LOG_WARNING("No additional data erased");
+ return NRF_SUCCESS;
+}