WizziLab / Mbed OS D7A_WM_Updater

Program to update the D7A modem's firmware.

Dependencies:   modem_ref_helper DebouncedInterrupt

main.cpp@12:beabd59e0c35, 2017-01-06 (annotated)

Committer:
Jeej
Date:
Fri Jan 06 14:16:49 2017 +0000
Revision:
12:beabd59e0c35
Parent:
11:3c6ef9b1be8a
Child:
13:c3324b26d473
Added L432KC platform.

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 0:82a60d86ab2e 85 int main()
Jeej 0:82a60d86ab2e 86 {
Jeej 0:82a60d86ab2e 87 d7a_revision_t rev;
Jeej 7:5b8648784381 88 cup_cfg_t cup_cfg;
Jeej 9:bd53ca2aece5 89 uint32_t cup_offset;
Jeej 0:82a60d86ab2e 90
Jeej 0:82a60d86ab2e 91 // Start & initialize
Jeej 12:beabd59e0c35 92 DBG_OPEN(DEBUG_LED);
Jeej 1:765933092750 93 PRINT("\r\n-----------------------------------\r\n");
Jeej 1:765933092750 94 PRINT("---------- D7A WM Updater ---------\r\n");
Jeej 1:765933092750 95 PRINT("-----------------------------------\r\n");
Jeej 0:82a60d86ab2e 96
Jeej 12:beabd59e0c35 97 #ifdef DEBUG_BUTTON
Jeej 12:beabd59e0c35 98 DebouncedInterrupt user_interrupt(DEBUG_BUTTON);
Jeej 0:82a60d86ab2e 99 user_interrupt.attach(button_push_isr, IRQ_FALL, 200, true);
Jeej 12:beabd59e0c35 100 #endif
Jeej 0:82a60d86ab2e 101
Jeej 12:beabd59e0c35 102 d7a_open(&shield_config, D7A_PIN_RESET, &callbacks);
Jeej 0:82a60d86ab2e 103
Jeej 0:82a60d86ab2e 104 // Check modem revision
Jeej 0:82a60d86ab2e 105 D7A_READ(&rev, D7A_FID_FIRMWARE_VERSION, 0, sizeof(d7a_revision_t), NULL);
Jeej 0:82a60d86ab2e 106
Jeej 0:82a60d86ab2e 107 // Read CUP config with root permissions
Jeej 0:82a60d86ab2e 108 D7A_READ(&cup_cfg, CUP_CFG_FID, 0, sizeof(cup_cfg_t), root_key);
Jeej 0:82a60d86ab2e 109
Jeej 7:5b8648784381 110 uint8_t hw_errors = 0;
Jeej 7:5b8648784381 111 uint8_t fw_errors = 0;
Jeej 7:5b8648784381 112 uint8_t errors = 0;
Jeej 0:82a60d86ab2e 113
Jeej 0:82a60d86ab2e 114 uint32_t version_old = (rev.fw_version.major << 24) | (rev.fw_version.minor << 16) | rev.fw_version.patch;
Jeej 7:5b8648784381 115 uint32_t version_new = (CUP_FW_MAJOR << 24) | (CUP_FW_MINOR << 16) | CUP_FW_PATCH;
Jeej 7:5b8648784381 116
Jeej 7:5b8648784381 117 hw_errors += check_parameter("Manufacturer ID... ", rev.manufacturer_id, CUP_MFG_ID);
Jeej 7:5b8648784381 118 hw_errors += check_parameter("Device ID... ", rev.device_id, CUP_DEV_ID);
Jeej 7:5b8648784381 119 hw_errors += check_parameter("Hardware version... ", rev.hw_version, CUP_HW_ID);
Jeej 8:914b7aff5554 120 fw_errors += check_parameter("Firmware id... ", rev.fw_version.id, CUP_FW_ID);
Jeej 9:bd53ca2aece5 121
Jeej 12:beabd59e0c35 122 PRINT("Checking CUP Slack... ");
Jeej 12:beabd59e0c35 123 cup_offset = (CUP_CODE_SIZE > cup_cfg.src_offset)? CUP_CODE_SIZE - cup_cfg.src_offset : 0;
Jeej 12:beabd59e0c35 124 int32_t cup_slack = cup_cfg.key - cup_offset - CUP_DATA_SIZE;
Jeej 12:beabd59e0c35 125 if (cup_slack < 0)
Jeej 12:beabd59e0c35 126 {
Jeej 12:beabd59e0c35 127 PRINT("Failed. (%d bytes short)\r\n", -cup_slack);
Jeej 12:beabd59e0c35 128 fw_errors++;
Jeej 12:beabd59e0c35 129 }
Jeej 12:beabd59e0c35 130 else
Jeej 12:beabd59e0c35 131 {
Jeej 12:beabd59e0c35 132 PRINT("OK. (%d bytes)\r\n", cup_slack);
Jeej 12:beabd59e0c35 133 }
Jeej 12:beabd59e0c35 134
Jeej 7:5b8648784381 135 if (version_old != version_new)
Jeej 0:82a60d86ab2e 136 {
Jeej 7:5b8648784381 137 fw_errors += check_parameter("Firmware version major...", rev.fw_version.major, CUP_TARGET_FW_MAJOR);
Jeej 7:5b8648784381 138 fw_errors += check_parameter("Firmware version minor...", rev.fw_version.minor, CUP_TARGET_FW_MINOR);
Jeej 0:82a60d86ab2e 139 }
Jeej 7:5b8648784381 140
Jeej 7:5b8648784381 141 PRINT("\r\n");
Jeej 7:5b8648784381 142
Jeej 7:5b8648784381 143 if (hw_errors)
Jeej 0:82a60d86ab2e 144 {
Jeej 7:5b8648784381 145 PRINT("Please, check that you chose the right Hardware in bin.h\r\n");
Jeej 0:82a60d86ab2e 146 }
Jeej 7:5b8648784381 147
Jeej 7:5b8648784381 148 if (fw_errors)
Jeej 0:82a60d86ab2e 149 {
Jeej 12:beabd59e0c35 150 PRINT("Please, check that you chose the right Revision in mbed revision tree.\r\n"
Jeej 12:beabd59e0c35 151 "You are trying to upgrade from v%d.%d.%d to v%d.%d.%d.\r\n",
Jeej 9:bd53ca2aece5 152 rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch,
Jeej 9:bd53ca2aece5 153 CUP_FW_MAJOR, CUP_FW_MINOR, CUP_FW_PATCH);
Jeej 12:beabd59e0c35 154 PRINT("You can only upgrade to another patch %d.%d.x --> %d.%d.y\r\n"
Jeej 12:beabd59e0c35 155 "or to the next minor %d.%d.x --> %d.%d.0\r\n",
Jeej 9:bd53ca2aece5 156 rev.fw_version.major, rev.fw_version.minor,
Jeej 9:bd53ca2aece5 157 rev.fw_version.major, rev.fw_version.minor,
Jeej 9:bd53ca2aece5 158 rev.fw_version.major, rev.fw_version.minor,
Jeej 9:bd53ca2aece5 159 rev.fw_version.major, rev.fw_version.minor+1);
Jeej 7:5b8648784381 160 }
Jeej 7:5b8648784381 161
Jeej 7:5b8648784381 162 errors = hw_errors + fw_errors;
Jeej 7:5b8648784381 163
Jeej 7:5b8648784381 164 if (errors)
Jeej 7:5b8648784381 165 {
Jeej 7:5b8648784381 166 PRINT("\r\nSelect the right parameters and recompile.\r\n");
Jeej 0:82a60d86ab2e 167 }
Jeej 12:beabd59e0c35 168
Jeej 0:82a60d86ab2e 169 else
Jeej 0:82a60d86ab2e 170 {
Jeej 0:82a60d86ab2e 171 if (version_old > version_new)
Jeej 0:82a60d86ab2e 172 {
Jeej 12:beabd59e0c35 173 PRINT("/!\\ Your modem is at a more recent version (v%d.%d.%d)/!\\\r\n"
Jeej 12:beabd59e0c35 174 "/!\\ Are you sure you want to downgrade to v%d.%d.%d ? /!\\\r\n",
Jeej 9:bd53ca2aece5 175 rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch,
Jeej 9:bd53ca2aece5 176 CUP_FW_MAJOR, CUP_FW_MINOR, CUP_FW_PATCH);
Jeej 0:82a60d86ab2e 177 PRINT("PRESS USER BUTTON TO CONFIRM...\r\n");
Jeej 0:82a60d86ab2e 178 button_user.wait();
Jeej 7:5b8648784381 179 PRINT("\r\nDowngrading firmware: v%d.%d.%d --> v%d.%d.%d\r\n",
Jeej 0:82a60d86ab2e 180 rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch,
Jeej 7:5b8648784381 181 CUP_FW_MAJOR, CUP_FW_MINOR, CUP_FW_PATCH);
Jeej 12:beabd59e0c35 182 #ifdef DEBUG_BUTTON
Jeej 0:82a60d86ab2e 183 PRINT("PRESS USER BUTTON TO START DOWNGRADE...\r\n");
Jeej 12:beabd59e0c35 184 button_user.wait();
Jeej 12:beabd59e0c35 185 #endif
Jeej 12:beabd59e0c35 186 cup_start_update(cup_offset);
Jeej 12:beabd59e0c35 187 }
Jeej 12:beabd59e0c35 188 else if (version_old == version_new)
Jeej 12:beabd59e0c35 189 {
Jeej 12:beabd59e0c35 190 PRINT("Your modem is up to date! (v%d.%d.%d)\r\n",
Jeej 12:beabd59e0c35 191 rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch);
Jeej 12:beabd59e0c35 192 #ifdef DEBUG_BUTTON
Jeej 12:beabd59e0c35 193 PRINT("PRESS USER BUTTON TO RETRY UPGRADE...\r\n");
Jeej 12:beabd59e0c35 194 button_user.wait();
Jeej 12:beabd59e0c35 195 cup_start_update(cup_offset);
Jeej 12:beabd59e0c35 196 #endif
Jeej 0:82a60d86ab2e 197 }
Jeej 0:82a60d86ab2e 198 else
Jeej 0:82a60d86ab2e 199 {
Jeej 0:82a60d86ab2e 200 PRINT("Upgrading firmware: v%d.%d.%d --> v%d.%d.%d\r\n",
Jeej 0:82a60d86ab2e 201 rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch,
Jeej 7:5b8648784381 202 CUP_FW_MAJOR, CUP_FW_MINOR, CUP_FW_PATCH);
Jeej 12:beabd59e0c35 203 #ifdef DEBUG_BUTTON
Jeej 0:82a60d86ab2e 204 PRINT("PRESS USER BUTTON TO START UPGRADE...\r\n");
Jeej 12:beabd59e0c35 205 button_user.wait();
Jeej 12:beabd59e0c35 206 #endif
Jeej 12:beabd59e0c35 207 cup_start_update(cup_offset);
Jeej 0:82a60d86ab2e 208 }
Jeej 0:82a60d86ab2e 209 }
Jeej 0:82a60d86ab2e 210
Jeej 0:82a60d86ab2e 211 // Set main task to lowest priority
Jeej 0:82a60d86ab2e 212 osThreadSetPriority(osThreadGetId(), osPriorityIdle);
Jeej 0:82a60d86ab2e 213 while(true)
Jeej 0:82a60d86ab2e 214 {
Jeej 0:82a60d86ab2e 215 // Wait to avoid beeing stuck in loop
Jeej 0:82a60d86ab2e 216 Thread::wait(200);
Jeej 0:82a60d86ab2e 217 }
Jeej 0:82a60d86ab2e 218 }