WizziLab / Mbed OS D7A_WM_Updater

Program to update the D7A modem's firmware.

Dependencies:   modem_ref_helper DebouncedInterrupt

main.cpp@15:24434827c575, 2017-03-10 (annotated)

Committer:
Jeej
Date:
Fri Mar 10 16:01:27 2017 +0000
Revision:
15:24434827c575
Parent:
13:c3324b26d473
Child:
16:5a6168dbe7bb
Sanity commit 4.7.232

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jeej 0:82a60d86ab2e 1 #include "mbed.h"
Jeej 0:82a60d86ab2e 2 #include "rtos.h"
Jeej 0:82a60d86ab2e 3 #include "d7a.h"
Jeej 0:82a60d86ab2e 4 #include "dbg.h"
Jeej 0:82a60d86ab2e 5 #include "cup.h"
Jeej 0:82a60d86ab2e 6 #include "DebouncedInterrupt.h"
Jeej 0:82a60d86ab2e 7
Jeej 0:82a60d86ab2e 8 // File IDs
Jeej 0:82a60d86ab2e 9 #define D7A_FID_FIRMWARE_VERSION (2)
Jeej 0:82a60d86ab2e 10
Jeej 2:e0cdfa7d2a8b 11 // To udate your firmware:
Jeej 2:e0cdfa7d2a8b 12 // - Specify your root key
Jeej 2:e0cdfa7d2a8b 13 // - Choose your Hardware in bin.h
Jeej 2:e0cdfa7d2a8b 14 // - Program your NUCLEO with your modem stacked
Jeej 2:e0cdfa7d2a8b 15 // - Follow the instructions printed on the debug port
Jeej 2:e0cdfa7d2a8b 16
Jeej 2:e0cdfa7d2a8b 17
Jeej 2:e0cdfa7d2a8b 18 // This is the default root key
Jeej 2:e0cdfa7d2a8b 19 // if you have changed this key, please specify it here
Jeej 12:beabd59e0c35 20 uint8_t root_key[CUP_DEFAULT_KEY_SIZE] = CUP_DEFAULT_KEY;
Jeej 12:beabd59e0c35 21 uint8_t root_key_size = CUP_DEFAULT_KEY_SIZE;
Jeej 12:beabd59e0c35 22
Jeej 12:beabd59e0c35 23 // -----------------------------------------------
Jeej 12:beabd59e0c35 24 // Hardware configuration
Jeej 12:beabd59e0c35 25 // -----------------------------------------------
Jeej 12:beabd59e0c35 26 #if defined(TARGET_STM32L152RE)
Jeej 12:beabd59e0c35 27 #define D7A_PIN_TX (D10)
Jeej 12:beabd59e0c35 28 #define D7A_PIN_RX (D2)
Jeej 12:beabd59e0c35 29 #define D7A_PIN_RTS (D13)
Jeej 12:beabd59e0c35 30 #define D7A_PIN_CTS (D9)
Jeej 12:beabd59e0c35 31 #define D7A_PIN_RESET (A3)
Jeej 12:beabd59e0c35 32 #define DEBUG_LED (NC)
Jeej 12:beabd59e0c35 33 #define DEBUG_BUTTON (USER_BUTTON)
Jeej 12:beabd59e0c35 34 #elif defined(TARGET_STM32L432KC)
Jeej 12:beabd59e0c35 35 #define D7A_PIN_TX (D5)
Jeej 12:beabd59e0c35 36 #define D7A_PIN_RX (D4)
Jeej 12:beabd59e0c35 37 #define D7A_PIN_RTS (D11)
Jeej 12:beabd59e0c35 38 #define D7A_PIN_CTS (D10)
Jeej 12:beabd59e0c35 39 #define D7A_PIN_RESET (D12)
Jeej 12:beabd59e0c35 40 #define DEBUG_LED (D13) // LED1
Jeej 12:beabd59e0c35 41 #else
Jeej 12:beabd59e0c35 42 #error "Please choose or add the right platform."
Jeej 12:beabd59e0c35 43 #endif
Jeej 0:82a60d86ab2e 44
Jeej 0:82a60d86ab2e 45 // callbacks structure
Jeej 0:82a60d86ab2e 46 const d7a_callbacks_t callbacks = {
Jeej 0:82a60d86ab2e 47 .write_file = NULL,
Jeej 0:82a60d86ab2e 48 .read_file = NULL,
Jeej 0:82a60d86ab2e 49 .notif_done = NULL,
Jeej 0:82a60d86ab2e 50 .unsolicited_msg = NULL,
Jeej 0:82a60d86ab2e 51 };
Jeej 0:82a60d86ab2e 52
Jeej 0:82a60d86ab2e 53 // Com configuration for the DASH7 shield
Jeej 0:82a60d86ab2e 54 const d7a_com_config_t shield_config = {
Jeej 12:beabd59e0c35 55 .tx = D7A_PIN_TX,
Jeej 12:beabd59e0c35 56 .rx = D7A_PIN_RX,
Jeej 12:beabd59e0c35 57 .rts = D7A_PIN_RTS,
Jeej 12:beabd59e0c35 58 .cts = D7A_PIN_CTS,
Jeej 0:82a60d86ab2e 59 };
Jeej 0:82a60d86ab2e 60
Jeej 0:82a60d86ab2e 61 // Semaphore for notifiying button presses
Jeej 0:82a60d86ab2e 62 Semaphore button_user(0);
Jeej 0:82a60d86ab2e 63
Jeej 0:82a60d86ab2e 64 // Interrupt Service Routine on button press.
Jeej 0:82a60d86ab2e 65 void button_push_isr( void )
Jeej 0:82a60d86ab2e 66 {
Jeej 0:82a60d86ab2e 67 button_user.release();
Jeej 0:82a60d86ab2e 68 }
Jeej 0:82a60d86ab2e 69
Jeej 7:5b8648784381 70 uint8_t check_parameter(const char* str, uint32_t param1, uint32_t param2)
Jeej 7:5b8648784381 71 {
Jeej 7:5b8648784381 72 PRINT("Checking %s ", str);
Jeej 7:5b8648784381 73 if (param1 != param2)
Jeej 7:5b8648784381 74 {
Jeej 7:5b8648784381 75 PRINT("Failed. (0x%08X != 0x%08X)\r\n", param1, param2);
Jeej 7:5b8648784381 76 return 1;
Jeej 7:5b8648784381 77 }
Jeej 7:5b8648784381 78 else
Jeej 7:5b8648784381 79 {
Jeej 7:5b8648784381 80 PRINT("OK. (0x%08X)\r\n", param1);
Jeej 7:5b8648784381 81 return 0;
Jeej 7:5b8648784381 82 }
Jeej 7:5b8648784381 83 }
Jeej 7:5b8648784381 84
Jeej 15:24434827c575 85 void print_check_rev(void)
Jeej 15:24434827c575 86 {
Jeej 15:24434827c575 87 PRINT("Please, check that you are at the right version is rhe revision tree\r\n");
Jeej 15:24434827c575 88 }
Jeej 15:24434827c575 89
Jeej 15:24434827c575 90 void print_check_hardware(void)
Jeej 15:24434827c575 91 {
Jeej 15:24434827c575 92 PRINT("Please, check that you chose the right Hardware in bin.h\r\n");
Jeej 15:24434827c575 93 }
Jeej 15:24434827c575 94
Jeej 15:24434827c575 95 int32_t check_slack(cup_param_t* cup, cup_cfg_t* cup_cfg)
Jeej 15:24434827c575 96 {
Jeej 15:24434827c575 97 PRINT("key: %d data: %d code: %d src: %d\r\n", cup_cfg->key, cup->data_size, cup->code_size, cup_cfg->src_offset);
Jeej 15:24434827c575 98 PRINT("Checking CUP Slack... ");
Jeej 15:24434827c575 99
Jeej 15:24434827c575 100 int32_t cup_slack = cup_cfg->key - cup->data_size - (cup->code_size > cup_cfg->src_offset)? cup->code_size - cup_cfg->src_offset : 0;
Jeej 15:24434827c575 101
Jeej 15:24434827c575 102 if (cup_slack < 0)
Jeej 15:24434827c575 103 {
Jeej 15:24434827c575 104 PRINT("Failed. (%d bytes short)\r\n", -cup_slack);
Jeej 15:24434827c575 105 }
Jeej 15:24434827c575 106 else
Jeej 15:24434827c575 107 {
Jeej 15:24434827c575 108 PRINT("OK. (%d bytes)\r\n", cup_slack);
Jeej 15:24434827c575 109 }
Jeej 15:24434827c575 110
Jeej 15:24434827c575 111 return cup_slack;
Jeej 15:24434827c575 112 }
Jeej 15:24434827c575 113
Jeej 0:82a60d86ab2e 114 int main()
Jeej 0:82a60d86ab2e 115 {
Jeej 15:24434827c575 116 bool bootloader;
Jeej 0:82a60d86ab2e 117 d7a_revision_t rev;
Jeej 7:5b8648784381 118 cup_cfg_t cup_cfg;
Jeej 15:24434827c575 119 cup_param_t* cup = (cup_param_t*)&cup_modem;
Jeej 9:bd53ca2aece5 120 uint32_t cup_offset;
Jeej 15:24434827c575 121 int32_t cup_slack;
Jeej 0:82a60d86ab2e 122
Jeej 0:82a60d86ab2e 123 // Start & initialize
Jeej 12:beabd59e0c35 124 DBG_OPEN(DEBUG_LED);
Jeej 13:c3324b26d473 125 PRINT("\r\n"
Jeej 13:c3324b26d473 126 "-----------------------------------\r\n"
Jeej 13:c3324b26d473 127 "---------- D7A WM Updater ---------\r\n"
Jeej 13:c3324b26d473 128 "-----------------------------------\r\n");
Jeej 0:82a60d86ab2e 129
Jeej 12:beabd59e0c35 130 #ifdef DEBUG_BUTTON
Jeej 12:beabd59e0c35 131 DebouncedInterrupt user_interrupt(DEBUG_BUTTON);
Jeej 0:82a60d86ab2e 132 user_interrupt.attach(button_push_isr, IRQ_FALL, 200, true);
Jeej 12:beabd59e0c35 133 #endif
Jeej 0:82a60d86ab2e 134
Jeej 12:beabd59e0c35 135 d7a_open(&shield_config, D7A_PIN_RESET, &callbacks);
Jeej 0:82a60d86ab2e 136
Jeej 13:c3324b26d473 137 do
Jeej 0:82a60d86ab2e 138 {
Jeej 13:c3324b26d473 139 // Check modem revision
Jeej 13:c3324b26d473 140 D7A_READ(&rev, D7A_FID_FIRMWARE_VERSION, 0, sizeof(d7a_revision_t), NULL);
Jeej 13:c3324b26d473 141
Jeej 15:24434827c575 142 if (check_parameter("Manufacturer ID... ", rev.manufacturer_id, cup->mfg_id))
Jeej 13:c3324b26d473 143 {
Jeej 15:24434827c575 144 print_check_rev();
Jeej 13:c3324b26d473 145 break;
Jeej 13:c3324b26d473 146 }
Jeej 13:c3324b26d473 147
Jeej 15:24434827c575 148 if (check_parameter("Hardware version... ", rev.hw_version, cup->hw_id))
Jeej 13:c3324b26d473 149 {
Jeej 15:24434827c575 150 print_check_hardware();
Jeej 13:c3324b26d473 151 break;
Jeej 13:c3324b26d473 152 }
Jeej 13:c3324b26d473 153
Jeej 15:24434827c575 154 if (rev.device_id == BOOTLOADER_DEV_ID)
Jeej 13:c3324b26d473 155 {
Jeej 15:24434827c575 156 // Update bootloader
Jeej 15:24434827c575 157
Jeej 15:24434827c575 158 // Read CUP config with root permissions
Jeej 15:24434827c575 159 D7A_READ(&cup_cfg, cup->cfg_fid, 0, sizeof(cup_cfg_t), root_key);
Jeej 15:24434827c575 160
Jeej 15:24434827c575 161 cup_slack = check_slack(cup, &cup_cfg);
Jeej 15:24434827c575 162
Jeej 15:24434827c575 163 if (cup_slack < 0)
Jeej 15:24434827c575 164 {
Jeej 15:24434827c575 165 PRINT("/!\\ Not enough space for bootloader /!\\\r\n");
Jeej 15:24434827c575 166 break;
Jeej 15:24434827c575 167 }
Jeej 15:24434827c575 168
Jeej 15:24434827c575 169 cup_offset = cup_cfg.key + cup_cfg.src_offset - cup->data_size;
Jeej 15:24434827c575 170
Jeej 15:24434827c575 171 cup_start_update(cup_offset);
Jeej 13:c3324b26d473 172 }
Jeej 15:24434827c575 173 else
Jeej 0:82a60d86ab2e 174 {
Jeej 15:24434827c575 175 uint32_t version_old = (rev.fw_version.major << 24) | (rev.fw_version.minor << 16) | rev.fw_version.patch;
Jeej 15:24434827c575 176 uint32_t version_new = (cup->fw_major << 24) | (cup->fw_minor << 16) | cup->fw_patch;
Jeej 15:24434827c575 177
Jeej 15:24434827c575 178 // Update modem
Jeej 15:24434827c575 179 if (check_parameter("Device ID... ", rev.device_id, cup->dev_id))
Jeej 15:24434827c575 180 {
Jeej 15:24434827c575 181 print_check_rev();
Jeej 15:24434827c575 182 break;
Jeej 15:24434827c575 183 }
Jeej 15:24434827c575 184
Jeej 15:24434827c575 185 if (check_parameter("Firmware id... ", rev.fw_version.id, cup->fw_id))
Jeej 15:24434827c575 186 {
Jeej 15:24434827c575 187 print_check_rev();
Jeej 15:24434827c575 188 break;
Jeej 15:24434827c575 189 }
Jeej 15:24434827c575 190
Jeej 15:24434827c575 191 if (version_old != version_new)
Jeej 15:24434827c575 192 {
Jeej 15:24434827c575 193 if (check_parameter("Firmware version major...", rev.fw_version.major, cup->target_fw_major))
Jeej 15:24434827c575 194 {
Jeej 15:24434827c575 195 print_check_rev();
Jeej 15:24434827c575 196 break;
Jeej 15:24434827c575 197 }
Jeej 15:24434827c575 198
Jeej 15:24434827c575 199 if (check_parameter("Firmware version minor...", rev.fw_version.minor, cup->target_fw_minor))
Jeej 15:24434827c575 200 {
Jeej 15:24434827c575 201 print_check_rev();
Jeej 15:24434827c575 202 break;
Jeej 15:24434827c575 203 }
Jeej 15:24434827c575 204 }
Jeej 15:24434827c575 205 else
Jeej 15:24434827c575 206 {
Jeej 15:24434827c575 207 PRINT("\r\nYour modem is up to date! (v%d.%d.%d)\r\n",
Jeej 15:24434827c575 208 rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch);
Jeej 15:24434827c575 209 break;
Jeej 15:24434827c575 210 }
Jeej 15:24434827c575 211
Jeej 15:24434827c575 212 // Read CUP config with root permissions
Jeej 15:24434827c575 213 D7A_READ(&cup_cfg, cup->cfg_fid, 0, sizeof(cup_cfg_t), root_key);
Jeej 15:24434827c575 214
Jeej 15:24434827c575 215 cup_slack = check_slack(cup, &cup_cfg);
Jeej 15:24434827c575 216
Jeej 15:24434827c575 217 if (cup_slack < 0)
Jeej 15:24434827c575 218 {
Jeej 15:24434827c575 219 PRINT("/!\\ Not enough space for binary, checking for bootloader /!\\\r\n");
Jeej 15:24434827c575 220
Jeej 15:24434827c575 221 cup_slack = check_slack((cup_param_t*)&cup_bootloader, &cup_cfg);
Jeej 15:24434827c575 222
Jeej 15:24434827c575 223 if (cup_slack < 0)
Jeej 15:24434827c575 224 {
Jeej 15:24434827c575 225 PRINT("/!\\ Not enough space for bootloader /!\\\r\n");
Jeej 15:24434827c575 226 break;
Jeej 15:24434827c575 227 }
Jeej 15:24434827c575 228
Jeej 15:24434827c575 229 bootloader = true;
Jeej 15:24434827c575 230 }
Jeej 15:24434827c575 231 else
Jeej 15:24434827c575 232 {
Jeej 15:24434827c575 233 bootloader = false;
Jeej 15:24434827c575 234 }
Jeej 15:24434827c575 235
Jeej 15:24434827c575 236 if (version_old > version_new)
Jeej 15:24434827c575 237 {
Jeej 15:24434827c575 238 PRINT("/!\\ Your modem is at a more recent version (v%d.%d.%d)/!\\\r\n"
Jeej 15:24434827c575 239 "/!\\ Are you sure you want to downgrade to v%d.%d.%d ? /!\\\r\n",
Jeej 15:24434827c575 240 rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch,
Jeej 15:24434827c575 241 cup->fw_major, cup->fw_minor, cup->fw_patch);
Jeej 15:24434827c575 242 PRINT("PRESS USER BUTTON TO CONFIRM...\r\n");
Jeej 15:24434827c575 243 button_user.wait();
Jeej 15:24434827c575 244 PRINT("\r\nDowngrading firmware: v%d.%d.%d --> v%d.%d.%d\r\n",
Jeej 15:24434827c575 245 rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch,
Jeej 15:24434827c575 246 cup->fw_major, cup->fw_minor, cup->fw_patch);
Jeej 15:24434827c575 247 #ifdef DEBUG_BUTTON
Jeej 15:24434827c575 248 PRINT("PRESS USER BUTTON TO START DOWNGRADE...\r\n");
Jeej 15:24434827c575 249 button_user.wait();
Jeej 15:24434827c575 250 #endif
Jeej 15:24434827c575 251 }
Jeej 15:24434827c575 252 else if (version_old != version_new)
Jeej 15:24434827c575 253 {
Jeej 15:24434827c575 254 PRINT("\r\nUpgrading firmware: v%d.%d.%d --> v%d.%d.%d\r\n",
Jeej 15:24434827c575 255 rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch,
Jeej 15:24434827c575 256 cup->fw_major, cup->fw_minor, cup->fw_patch);
Jeej 15:24434827c575 257 #ifdef DEBUG_BUTTON
Jeej 15:24434827c575 258 PRINT("PRESS USER BUTTON TO START UPGRADE...\r\n");
Jeej 15:24434827c575 259 button_user.wait();
Jeej 15:24434827c575 260 #endif
Jeej 15:24434827c575 261 }
Jeej 15:24434827c575 262
Jeej 15:24434827c575 263 cup_offset = cup_cfg.key - cup->data_size;
Jeej 15:24434827c575 264 cup_start_update(cup_offset, bootloader);
Jeej 12:beabd59e0c35 265 }
Jeej 13:c3324b26d473 266
Jeej 13:c3324b26d473 267 } while (0);
Jeej 0:82a60d86ab2e 268
Jeej 0:82a60d86ab2e 269 // Set main task to lowest priority
Jeej 0:82a60d86ab2e 270 osThreadSetPriority(osThreadGetId(), osPriorityIdle);
Jeej 0:82a60d86ab2e 271 while(true)
Jeej 0:82a60d86ab2e 272 {
Jeej 0:82a60d86ab2e 273 // Wait to avoid beeing stuck in loop
Jeej 0:82a60d86ab2e 274 Thread::wait(200);
Jeej 0:82a60d86ab2e 275 }
Jeej 0:82a60d86ab2e 276 }