WizziLab / Mbed OS D7A_WM_Updater

Program to update the D7A modem's firmware.

Dependencies:   modem_ref_helper DebouncedInterrupt

main.cpp@18:a8a640941018, 2017-04-24 (annotated)

Committer:
Jeej
Date:
Mon Apr 24 16:40:03 2017 +0000
Revision:
18:a8a640941018
Parent:
17:05c9ec970a6d
Child:
20:100143cecc41
Fixed slack calculation

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 18:a8a640941018 41 #define DEBUG_BUTTON (D9)
Jeej 12:beabd59e0c35 42 #else
Jeej 12:beabd59e0c35 43 #error "Please choose or add the right platform."
Jeej 12:beabd59e0c35 44 #endif
Jeej 0:82a60d86ab2e 45
Jeej 0:82a60d86ab2e 46 // callbacks structure
Jeej 0:82a60d86ab2e 47 const d7a_callbacks_t callbacks = {
Jeej 0:82a60d86ab2e 48 .write_file = NULL,
Jeej 0:82a60d86ab2e 49 .read_file = NULL,
Jeej 0:82a60d86ab2e 50 .notif_done = NULL,
Jeej 0:82a60d86ab2e 51 .unsolicited_msg = NULL,
Jeej 0:82a60d86ab2e 52 };
Jeej 0:82a60d86ab2e 53
Jeej 0:82a60d86ab2e 54 // Com configuration for the DASH7 shield
Jeej 0:82a60d86ab2e 55 const d7a_com_config_t shield_config = {
Jeej 12:beabd59e0c35 56 .tx = D7A_PIN_TX,
Jeej 12:beabd59e0c35 57 .rx = D7A_PIN_RX,
Jeej 12:beabd59e0c35 58 .rts = D7A_PIN_RTS,
Jeej 12:beabd59e0c35 59 .cts = D7A_PIN_CTS,
Jeej 0:82a60d86ab2e 60 };
Jeej 0:82a60d86ab2e 61
Jeej 0:82a60d86ab2e 62 // Semaphore for notifiying button presses
Jeej 0:82a60d86ab2e 63 Semaphore button_user(0);
Jeej 0:82a60d86ab2e 64
Jeej 0:82a60d86ab2e 65 // Interrupt Service Routine on button press.
Jeej 0:82a60d86ab2e 66 void button_push_isr( void )
Jeej 0:82a60d86ab2e 67 {
Jeej 0:82a60d86ab2e 68 button_user.release();
Jeej 0:82a60d86ab2e 69 }
Jeej 0:82a60d86ab2e 70
Jeej 7:5b8648784381 71 uint8_t check_parameter(const char* str, uint32_t param1, uint32_t param2)
Jeej 7:5b8648784381 72 {
Jeej 7:5b8648784381 73 PRINT("Checking %s ", str);
Jeej 7:5b8648784381 74 if (param1 != param2)
Jeej 7:5b8648784381 75 {
Jeej 7:5b8648784381 76 PRINT("Failed. (0x%08X != 0x%08X)\r\n", param1, param2);
Jeej 7:5b8648784381 77 return 1;
Jeej 7:5b8648784381 78 }
Jeej 7:5b8648784381 79 else
Jeej 7:5b8648784381 80 {
Jeej 7:5b8648784381 81 PRINT("OK. (0x%08X)\r\n", param1);
Jeej 7:5b8648784381 82 return 0;
Jeej 7:5b8648784381 83 }
Jeej 7:5b8648784381 84 }
Jeej 7:5b8648784381 85
Jeej 15:24434827c575 86 void print_check_rev(void)
Jeej 15:24434827c575 87 {
Jeej 17:05c9ec970a6d 88 PRINT("\r\n"
Jeej 17:05c9ec970a6d 89 "/!\\ Please, check that you are at the right commit in the mbed revision tree /!\\\r\n"
Jeej 17:05c9ec970a6d 90 );
Jeej 15:24434827c575 91 }
Jeej 15:24434827c575 92
Jeej 15:24434827c575 93 void print_check_hardware(void)
Jeej 15:24434827c575 94 {
Jeej 15:24434827c575 95 PRINT("Please, check that you chose the right Hardware in bin.h\r\n");
Jeej 15:24434827c575 96 }
Jeej 15:24434827c575 97
Jeej 15:24434827c575 98 int32_t check_slack(cup_param_t* cup, cup_cfg_t* cup_cfg)
Jeej 15:24434827c575 99 {
Jeej 16:5a6168dbe7bb 100 //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 101 PRINT("Checking CUP Slack... ");
Jeej 16:5a6168dbe7bb 102
Jeej 18:a8a640941018 103 //int32_t data_size = (((cup->data_size/256)+1)*256);
Jeej 18:a8a640941018 104 int32_t cup_slack = cup_cfg->key - cup->data_size;
Jeej 18:a8a640941018 105
Jeej 18:a8a640941018 106 cup_slack = ((cup_slack/256)*256);
Jeej 15:24434827c575 107
Jeej 15:24434827c575 108 if (cup_slack < 0)
Jeej 15:24434827c575 109 {
Jeej 15:24434827c575 110 PRINT("Failed. (%d bytes short)\r\n", -cup_slack);
Jeej 15:24434827c575 111 }
Jeej 15:24434827c575 112 else
Jeej 15:24434827c575 113 {
Jeej 15:24434827c575 114 PRINT("OK. (%d bytes)\r\n", cup_slack);
Jeej 15:24434827c575 115 }
Jeej 15:24434827c575 116
Jeej 15:24434827c575 117 return cup_slack;
Jeej 15:24434827c575 118 }
Jeej 15:24434827c575 119
Jeej 0:82a60d86ab2e 120 int main()
Jeej 0:82a60d86ab2e 121 {
Jeej 15:24434827c575 122 bool bootloader;
Jeej 0:82a60d86ab2e 123 d7a_revision_t rev;
Jeej 7:5b8648784381 124 cup_cfg_t cup_cfg;
Jeej 15:24434827c575 125 cup_param_t* cup = (cup_param_t*)&cup_modem;
Jeej 15:24434827c575 126 int32_t cup_slack;
Jeej 0:82a60d86ab2e 127
Jeej 0:82a60d86ab2e 128 // Start & initialize
Jeej 12:beabd59e0c35 129 DBG_OPEN(DEBUG_LED);
Jeej 13:c3324b26d473 130 PRINT("\r\n"
Jeej 13:c3324b26d473 131 "-----------------------------------\r\n"
Jeej 13:c3324b26d473 132 "---------- D7A WM Updater ---------\r\n"
Jeej 13:c3324b26d473 133 "-----------------------------------\r\n");
Jeej 0:82a60d86ab2e 134
Jeej 12:beabd59e0c35 135 #ifdef DEBUG_BUTTON
Jeej 12:beabd59e0c35 136 DebouncedInterrupt user_interrupt(DEBUG_BUTTON);
Jeej 0:82a60d86ab2e 137 user_interrupt.attach(button_push_isr, IRQ_FALL, 200, true);
Jeej 12:beabd59e0c35 138 #endif
Jeej 0:82a60d86ab2e 139
Jeej 12:beabd59e0c35 140 d7a_open(&shield_config, D7A_PIN_RESET, &callbacks);
Jeej 0:82a60d86ab2e 141
Jeej 13:c3324b26d473 142 do
Jeej 0:82a60d86ab2e 143 {
Jeej 13:c3324b26d473 144 // Check modem revision
Jeej 13:c3324b26d473 145 D7A_READ(&rev, D7A_FID_FIRMWARE_VERSION, 0, sizeof(d7a_revision_t), NULL);
Jeej 13:c3324b26d473 146
Jeej 15:24434827c575 147 if (check_parameter("Manufacturer ID... ", rev.manufacturer_id, cup->mfg_id))
Jeej 13:c3324b26d473 148 {
Jeej 15:24434827c575 149 print_check_rev();
Jeej 13:c3324b26d473 150 break;
Jeej 13:c3324b26d473 151 }
Jeej 13:c3324b26d473 152
Jeej 15:24434827c575 153 if (check_parameter("Hardware version... ", rev.hw_version, cup->hw_id))
Jeej 13:c3324b26d473 154 {
Jeej 15:24434827c575 155 print_check_hardware();
Jeej 13:c3324b26d473 156 break;
Jeej 13:c3324b26d473 157 }
Jeej 13:c3324b26d473 158
Jeej 15:24434827c575 159 if (rev.device_id == BOOTLOADER_DEV_ID)
Jeej 13:c3324b26d473 160 {
Jeej 15:24434827c575 161 // Update bootloader
Jeej 16:5a6168dbe7bb 162 PRINT("\r\n"
Jeej 16:5a6168dbe7bb 163 "/!\\ This modem has a 4.7.x bootloader firmware. /!\\\r\n"
Jeej 16:5a6168dbe7bb 164 "/!\\ Step 2/2: Upgrading to full modem firmware. /!\\\r\n"
Jeej 16:5a6168dbe7bb 165 );
Jeej 15:24434827c575 166
Jeej 15:24434827c575 167 // Read CUP config with root permissions
Jeej 15:24434827c575 168 D7A_READ(&cup_cfg, cup->cfg_fid, 0, sizeof(cup_cfg_t), root_key);
Jeej 15:24434827c575 169
Jeej 15:24434827c575 170 cup_slack = check_slack(cup, &cup_cfg);
Jeej 15:24434827c575 171
Jeej 15:24434827c575 172 if (cup_slack < 0)
Jeej 15:24434827c575 173 {
Jeej 15:24434827c575 174 PRINT("/!\\ Not enough space for bootloader /!\\\r\n");
Jeej 15:24434827c575 175 break;
Jeej 15:24434827c575 176 }
Jeej 16:5a6168dbe7bb 177
Jeej 16:5a6168dbe7bb 178 cup_start_update(cup_slack);
Jeej 13:c3324b26d473 179 }
Jeej 15:24434827c575 180 else
Jeej 0:82a60d86ab2e 181 {
Jeej 15:24434827c575 182 uint32_t version_old = (rev.fw_version.major << 24) | (rev.fw_version.minor << 16) | rev.fw_version.patch;
Jeej 15:24434827c575 183 uint32_t version_new = (cup->fw_major << 24) | (cup->fw_minor << 16) | cup->fw_patch;
Jeej 15:24434827c575 184
Jeej 15:24434827c575 185 // Update modem
Jeej 15:24434827c575 186 if (check_parameter("Device ID... ", rev.device_id, cup->dev_id))
Jeej 15:24434827c575 187 {
Jeej 15:24434827c575 188 print_check_rev();
Jeej 15:24434827c575 189 break;
Jeej 15:24434827c575 190 }
Jeej 15:24434827c575 191
Jeej 15:24434827c575 192 if (check_parameter("Firmware id... ", rev.fw_version.id, cup->fw_id))
Jeej 15:24434827c575 193 {
Jeej 15:24434827c575 194 print_check_rev();
Jeej 15:24434827c575 195 break;
Jeej 15:24434827c575 196 }
Jeej 15:24434827c575 197
Jeej 15:24434827c575 198 if (version_old != version_new)
Jeej 15:24434827c575 199 {
Jeej 15:24434827c575 200 if (check_parameter("Firmware version major...", rev.fw_version.major, cup->target_fw_major))
Jeej 15:24434827c575 201 {
Jeej 15:24434827c575 202 print_check_rev();
Jeej 15:24434827c575 203 break;
Jeej 15:24434827c575 204 }
Jeej 17:05c9ec970a6d 205
Jeej 15:24434827c575 206 if (check_parameter("Firmware version minor...", rev.fw_version.minor, cup->target_fw_minor))
Jeej 15:24434827c575 207 {
Jeej 15:24434827c575 208 print_check_rev();
Jeej 15:24434827c575 209 break;
Jeej 17:05c9ec970a6d 210 }
Jeej 15:24434827c575 211 }
Jeej 15:24434827c575 212 else
Jeej 15:24434827c575 213 {
Jeej 15:24434827c575 214 PRINT("\r\nYour modem is up to date! (v%d.%d.%d)\r\n",
Jeej 15:24434827c575 215 rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch);
Jeej 15:24434827c575 216 break;
Jeej 15:24434827c575 217 }
Jeej 15:24434827c575 218
Jeej 15:24434827c575 219 // Read CUP config with root permissions
Jeej 15:24434827c575 220 D7A_READ(&cup_cfg, cup->cfg_fid, 0, sizeof(cup_cfg_t), root_key);
Jeej 15:24434827c575 221
Jeej 15:24434827c575 222 cup_slack = check_slack(cup, &cup_cfg);
Jeej 15:24434827c575 223
Jeej 15:24434827c575 224 if (cup_slack < 0)
Jeej 15:24434827c575 225 {
Jeej 16:5a6168dbe7bb 226 PRINT("\r\n"
Jeej 16:5a6168dbe7bb 227 "/!\\ Not enough space for full modem firmware binary /!\\\r\n"
Jeej 16:5a6168dbe7bb 228 "/!\\ Checking for bootloader firmware /!\\\r\n"
Jeej 16:5a6168dbe7bb 229 "\r\n"
Jeej 16:5a6168dbe7bb 230 );
Jeej 15:24434827c575 231
Jeej 15:24434827c575 232 cup_slack = check_slack((cup_param_t*)&cup_bootloader, &cup_cfg);
Jeej 15:24434827c575 233
Jeej 15:24434827c575 234 if (cup_slack < 0)
Jeej 15:24434827c575 235 {
Jeej 15:24434827c575 236 PRINT("/!\\ Not enough space for bootloader /!\\\r\n");
Jeej 15:24434827c575 237 break;
Jeej 15:24434827c575 238 }
Jeej 15:24434827c575 239
Jeej 15:24434827c575 240 bootloader = true;
Jeej 16:5a6168dbe7bb 241
Jeej 16:5a6168dbe7bb 242 PRINT("\r\n"
Jeej 16:5a6168dbe7bb 243 "/!\\ This update will be done in 2 steps. /!\\\r\n"
Jeej 16:5a6168dbe7bb 244 "/!\\ Step 1/2: Upgrading modem to bootloader. /!\\\r\n"
Jeej 16:5a6168dbe7bb 245 "/!\\ Do no push the reset button or turn off the board during upgrade. /!\\\r\n"
Jeej 16:5a6168dbe7bb 246 );
Jeej 15:24434827c575 247 }
Jeej 15:24434827c575 248 else
Jeej 15:24434827c575 249 {
Jeej 15:24434827c575 250 bootloader = false;
Jeej 15:24434827c575 251 }
Jeej 15:24434827c575 252
Jeej 15:24434827c575 253 if (version_old > version_new)
Jeej 15:24434827c575 254 {
Jeej 15:24434827c575 255 PRINT("/!\\ Your modem is at a more recent version (v%d.%d.%d)/!\\\r\n"
Jeej 15:24434827c575 256 "/!\\ Are you sure you want to downgrade to v%d.%d.%d ? /!\\\r\n",
Jeej 15:24434827c575 257 rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch,
Jeej 15:24434827c575 258 cup->fw_major, cup->fw_minor, cup->fw_patch);
Jeej 18:a8a640941018 259 #ifdef DEBUG_BUTTON
Jeej 15:24434827c575 260 PRINT("PRESS USER BUTTON TO CONFIRM...\r\n");
Jeej 15:24434827c575 261 button_user.wait();
Jeej 18:a8a640941018 262 #endif
Jeej 15:24434827c575 263 PRINT("\r\nDowngrading firmware: v%d.%d.%d --> v%d.%d.%d\r\n",
Jeej 15:24434827c575 264 rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch,
Jeej 15:24434827c575 265 cup->fw_major, cup->fw_minor, cup->fw_patch);
Jeej 18:a8a640941018 266 #ifdef DEBUG_BUTTON
Jeej 15:24434827c575 267 PRINT("PRESS USER BUTTON TO START DOWNGRADE...\r\n");
Jeej 15:24434827c575 268 button_user.wait();
Jeej 18:a8a640941018 269 #endif
Jeej 15:24434827c575 270 }
Jeej 15:24434827c575 271 else if (version_old != version_new)
Jeej 15:24434827c575 272 {
Jeej 15:24434827c575 273 PRINT("\r\nUpgrading firmware: v%d.%d.%d --> v%d.%d.%d\r\n",
Jeej 15:24434827c575 274 rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch,
Jeej 15:24434827c575 275 cup->fw_major, cup->fw_minor, cup->fw_patch);
Jeej 18:a8a640941018 276 #ifdef DEBUG_BUTTON
Jeej 15:24434827c575 277 PRINT("PRESS USER BUTTON TO START UPGRADE...\r\n");
Jeej 15:24434827c575 278 button_user.wait();
Jeej 18:a8a640941018 279 #endif
Jeej 15:24434827c575 280 }
Jeej 15:24434827c575 281
Jeej 16:5a6168dbe7bb 282 cup_start_update(cup_slack, bootloader);
Jeej 12:beabd59e0c35 283 }
Jeej 13:c3324b26d473 284
Jeej 13:c3324b26d473 285 } while (0);
Jeej 0:82a60d86ab2e 286
Jeej 0:82a60d86ab2e 287 // Set main task to lowest priority
Jeej 0:82a60d86ab2e 288 osThreadSetPriority(osThreadGetId(), osPriorityIdle);
Jeej 0:82a60d86ab2e 289 while(true)
Jeej 0:82a60d86ab2e 290 {
Jeej 0:82a60d86ab2e 291 // Wait to avoid beeing stuck in loop
Jeej 0:82a60d86ab2e 292 Thread::wait(200);
Jeej 0:82a60d86ab2e 293 }
Jeej 0:82a60d86ab2e 294 }