Program to update the D7A modem's firmware.
Dependencies: modem_ref_helper DebouncedInterrupt
main.cpp@8:914b7aff5554, 2016-11-10 (annotated)
- Committer:
- Jeej
- Date:
- Thu Nov 10 17:18:42 2016 +0000
- Revision:
- 8:914b7aff5554
- Parent:
- 7:5b8648784381
- Child:
- 9:bd53ca2aece5
Release 4.6.0 - revised
Who changed what in which revision?
User | Revision | Line number | New 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 | 7:5b8648784381 | 20 | // For now root key size is always D7A_ROOT_KEY_SIZE |
Jeej | 7:5b8648784381 | 21 | uint8_t root_key[D7A_ROOT_KEY_SIZE] = CUP_DEFAULT_KEY; |
Jeej | 7:5b8648784381 | 22 | uint8_t root_key_size = D7A_ROOT_KEY_SIZE; // XXX: Do not change this |
Jeej | 0:82a60d86ab2e | 23 | |
Jeej | 0:82a60d86ab2e | 24 | // callbacks structure |
Jeej | 0:82a60d86ab2e | 25 | const d7a_callbacks_t callbacks = { |
Jeej | 0:82a60d86ab2e | 26 | .write_file = NULL, |
Jeej | 0:82a60d86ab2e | 27 | .read_file = NULL, |
Jeej | 0:82a60d86ab2e | 28 | .notif_done = NULL, |
Jeej | 0:82a60d86ab2e | 29 | .unsolicited_msg = NULL, |
Jeej | 0:82a60d86ab2e | 30 | }; |
Jeej | 0:82a60d86ab2e | 31 | |
Jeej | 0:82a60d86ab2e | 32 | // Com configuration for the DASH7 shield |
Jeej | 0:82a60d86ab2e | 33 | const d7a_com_config_t shield_config = { |
Jeej | 0:82a60d86ab2e | 34 | .tx = D10, |
Jeej | 0:82a60d86ab2e | 35 | .rx = D2, |
Jeej | 0:82a60d86ab2e | 36 | .rts = D13, |
Jeej | 0:82a60d86ab2e | 37 | .cts = D9, |
Jeej | 0:82a60d86ab2e | 38 | .rx_buffer_size = 1024, |
Jeej | 0:82a60d86ab2e | 39 | }; |
Jeej | 0:82a60d86ab2e | 40 | |
Jeej | 0:82a60d86ab2e | 41 | // Semaphore for notifiying button presses |
Jeej | 0:82a60d86ab2e | 42 | Semaphore button_user(0); |
Jeej | 0:82a60d86ab2e | 43 | |
Jeej | 0:82a60d86ab2e | 44 | // Interrupt Service Routine on button press. |
Jeej | 0:82a60d86ab2e | 45 | void button_push_isr( void ) |
Jeej | 0:82a60d86ab2e | 46 | { |
Jeej | 0:82a60d86ab2e | 47 | button_user.release(); |
Jeej | 0:82a60d86ab2e | 48 | } |
Jeej | 0:82a60d86ab2e | 49 | |
Jeej | 7:5b8648784381 | 50 | uint8_t check_parameter(const char* str, uint32_t param1, uint32_t param2) |
Jeej | 7:5b8648784381 | 51 | { |
Jeej | 7:5b8648784381 | 52 | PRINT("Checking %s ", str); |
Jeej | 7:5b8648784381 | 53 | if (param1 != param2) |
Jeej | 7:5b8648784381 | 54 | { |
Jeej | 7:5b8648784381 | 55 | PRINT("Failed. (0x%08X != 0x%08X)\r\n", param1, param2); |
Jeej | 7:5b8648784381 | 56 | return 1; |
Jeej | 7:5b8648784381 | 57 | } |
Jeej | 7:5b8648784381 | 58 | else |
Jeej | 7:5b8648784381 | 59 | { |
Jeej | 7:5b8648784381 | 60 | PRINT("OK. (0x%08X)\r\n", param1); |
Jeej | 7:5b8648784381 | 61 | return 0; |
Jeej | 7:5b8648784381 | 62 | } |
Jeej | 7:5b8648784381 | 63 | } |
Jeej | 7:5b8648784381 | 64 | |
Jeej | 0:82a60d86ab2e | 65 | int main() |
Jeej | 0:82a60d86ab2e | 66 | { |
Jeej | 0:82a60d86ab2e | 67 | d7a_revision_t rev; |
Jeej | 7:5b8648784381 | 68 | cup_cfg_t cup_cfg; |
Jeej | 0:82a60d86ab2e | 69 | |
Jeej | 0:82a60d86ab2e | 70 | // Start & initialize |
Jeej | 0:82a60d86ab2e | 71 | DBG_OPEN(); |
Jeej | 1:765933092750 | 72 | PRINT("\r\n-----------------------------------\r\n"); |
Jeej | 1:765933092750 | 73 | PRINT("---------- D7A WM Updater ---------\r\n"); |
Jeej | 1:765933092750 | 74 | PRINT("-----------------------------------\r\n"); |
Jeej | 0:82a60d86ab2e | 75 | |
Jeej | 0:82a60d86ab2e | 76 | DebouncedInterrupt user_interrupt(USER_BUTTON); |
Jeej | 0:82a60d86ab2e | 77 | user_interrupt.attach(button_push_isr, IRQ_FALL, 200, true); |
Jeej | 0:82a60d86ab2e | 78 | |
Jeej | 0:82a60d86ab2e | 79 | d7a_open(&shield_config, A3, &callbacks); |
Jeej | 0:82a60d86ab2e | 80 | |
Jeej | 0:82a60d86ab2e | 81 | // Check modem revision |
Jeej | 0:82a60d86ab2e | 82 | D7A_READ(&rev, D7A_FID_FIRMWARE_VERSION, 0, sizeof(d7a_revision_t), NULL); |
Jeej | 0:82a60d86ab2e | 83 | |
Jeej | 0:82a60d86ab2e | 84 | // Read CUP config with root permissions |
Jeej | 0:82a60d86ab2e | 85 | D7A_READ(&cup_cfg, CUP_CFG_FID, 0, sizeof(cup_cfg_t), root_key); |
Jeej | 0:82a60d86ab2e | 86 | |
Jeej | 7:5b8648784381 | 87 | uint8_t hw_errors = 0; |
Jeej | 7:5b8648784381 | 88 | uint8_t fw_errors = 0; |
Jeej | 7:5b8648784381 | 89 | uint8_t errors = 0; |
Jeej | 0:82a60d86ab2e | 90 | |
Jeej | 0:82a60d86ab2e | 91 | uint32_t version_old = (rev.fw_version.major << 24) | (rev.fw_version.minor << 16) | rev.fw_version.patch; |
Jeej | 7:5b8648784381 | 92 | uint32_t version_new = (CUP_FW_MAJOR << 24) | (CUP_FW_MINOR << 16) | CUP_FW_PATCH; |
Jeej | 7:5b8648784381 | 93 | |
Jeej | 7:5b8648784381 | 94 | hw_errors += check_parameter("Manufacturer ID... ", rev.manufacturer_id, CUP_MFG_ID); |
Jeej | 7:5b8648784381 | 95 | hw_errors += check_parameter("Device ID... ", rev.device_id, CUP_DEV_ID); |
Jeej | 7:5b8648784381 | 96 | hw_errors += check_parameter("Hardware version... ", rev.hw_version, CUP_HW_ID); |
Jeej | 8:914b7aff5554 | 97 | fw_errors += check_parameter("Firmware id... ", rev.fw_version.id, CUP_FW_ID); |
Jeej | 8:914b7aff5554 | 98 | |
Jeej | 7:5b8648784381 | 99 | if (version_old != version_new) |
Jeej | 0:82a60d86ab2e | 100 | { |
Jeej | 7:5b8648784381 | 101 | fw_errors += check_parameter("Firmware version major...", rev.fw_version.major, CUP_TARGET_FW_MAJOR); |
Jeej | 7:5b8648784381 | 102 | fw_errors += check_parameter("Firmware version minor...", rev.fw_version.minor, CUP_TARGET_FW_MINOR); |
Jeej | 7:5b8648784381 | 103 | |
Jeej | 7:5b8648784381 | 104 | PRINT("Checking Available CUP space... "); |
Jeej | 7:5b8648784381 | 105 | if (CUP_DATA_SIZE > cup_cfg.key) |
Jeej | 7:5b8648784381 | 106 | { |
Jeej | 7:5b8648784381 | 107 | PRINT("Failed. (0x%08X < 0x%08X)\r\n", cup_cfg.key, CUP_DATA_SIZE); |
Jeej | 7:5b8648784381 | 108 | fw_errors++; |
Jeej | 7:5b8648784381 | 109 | } |
Jeej | 7:5b8648784381 | 110 | else |
Jeej | 7:5b8648784381 | 111 | { |
Jeej | 7:5b8648784381 | 112 | PRINT("OK. (0x%08X)\r\n", cup_cfg.key); |
Jeej | 7:5b8648784381 | 113 | } |
Jeej | 0:82a60d86ab2e | 114 | } |
Jeej | 7:5b8648784381 | 115 | |
Jeej | 7:5b8648784381 | 116 | PRINT("\r\n"); |
Jeej | 7:5b8648784381 | 117 | |
Jeej | 7:5b8648784381 | 118 | if (hw_errors) |
Jeej | 0:82a60d86ab2e | 119 | { |
Jeej | 7:5b8648784381 | 120 | PRINT("Please, check that you chose the right Hardware in bin.h\r\n"); |
Jeej | 0:82a60d86ab2e | 121 | } |
Jeej | 7:5b8648784381 | 122 | |
Jeej | 7:5b8648784381 | 123 | if (fw_errors) |
Jeej | 0:82a60d86ab2e | 124 | { |
Jeej | 7:5b8648784381 | 125 | PRINT("Please, check that you chose the right Revision in mbed revision tree.\r\n"); |
Jeej | 7:5b8648784381 | 126 | PRINT("You can only upgrade to another patch 4.5.x --> 4.5.y\r\nor to the next minor 4.5.x --> 4.6.0\r\n"); |
Jeej | 7:5b8648784381 | 127 | } |
Jeej | 7:5b8648784381 | 128 | |
Jeej | 7:5b8648784381 | 129 | errors = hw_errors + fw_errors; |
Jeej | 7:5b8648784381 | 130 | |
Jeej | 7:5b8648784381 | 131 | if (errors) |
Jeej | 7:5b8648784381 | 132 | { |
Jeej | 7:5b8648784381 | 133 | PRINT("\r\nSelect the right parameters and recompile.\r\n"); |
Jeej | 0:82a60d86ab2e | 134 | } |
Jeej | 0:82a60d86ab2e | 135 | else if (version_old == version_new) |
Jeej | 0:82a60d86ab2e | 136 | { |
Jeej | 8:914b7aff5554 | 137 | PRINT("Your modem is up to date! (v%d.%d.%d)\r\n", rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch); |
Jeej | 0:82a60d86ab2e | 138 | } |
Jeej | 0:82a60d86ab2e | 139 | else |
Jeej | 0:82a60d86ab2e | 140 | { |
Jeej | 0:82a60d86ab2e | 141 | if (version_old > version_new) |
Jeej | 0:82a60d86ab2e | 142 | { |
Jeej | 0:82a60d86ab2e | 143 | PRINT("/!\\ Your modem is at a more recent version /!\\\r\n/!\\ Are you sure you want to downgrade? /!\\\r\n"); |
Jeej | 0:82a60d86ab2e | 144 | PRINT("PRESS USER BUTTON TO CONFIRM...\r\n"); |
Jeej | 0:82a60d86ab2e | 145 | button_user.wait(); |
Jeej | 7:5b8648784381 | 146 | PRINT("\r\nDowngrading firmware: v%d.%d.%d --> v%d.%d.%d\r\n", |
Jeej | 0:82a60d86ab2e | 147 | rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch, |
Jeej | 7:5b8648784381 | 148 | CUP_FW_MAJOR, CUP_FW_MINOR, CUP_FW_PATCH); |
Jeej | 0:82a60d86ab2e | 149 | PRINT("PRESS USER BUTTON TO START DOWNGRADE...\r\n"); |
Jeej | 0:82a60d86ab2e | 150 | } |
Jeej | 0:82a60d86ab2e | 151 | else |
Jeej | 0:82a60d86ab2e | 152 | { |
Jeej | 0:82a60d86ab2e | 153 | PRINT("Upgrading firmware: v%d.%d.%d --> v%d.%d.%d\r\n", |
Jeej | 0:82a60d86ab2e | 154 | rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch, |
Jeej | 7:5b8648784381 | 155 | CUP_FW_MAJOR, CUP_FW_MINOR, CUP_FW_PATCH); |
Jeej | 0:82a60d86ab2e | 156 | PRINT("PRESS USER BUTTON TO START UPGRADE...\r\n"); |
Jeej | 0:82a60d86ab2e | 157 | } |
Jeej | 0:82a60d86ab2e | 158 | |
Jeej | 0:82a60d86ab2e | 159 | button_user.wait(); |
Jeej | 7:5b8648784381 | 160 | cup_start_update(cup_cfg.src_offset, cup_cfg.key); |
Jeej | 0:82a60d86ab2e | 161 | } |
Jeej | 0:82a60d86ab2e | 162 | |
Jeej | 0:82a60d86ab2e | 163 | // Set main task to lowest priority |
Jeej | 0:82a60d86ab2e | 164 | osThreadSetPriority(osThreadGetId(), osPriorityIdle); |
Jeej | 0:82a60d86ab2e | 165 | while(true) |
Jeej | 0:82a60d86ab2e | 166 | { |
Jeej | 0:82a60d86ab2e | 167 | // Wait to avoid beeing stuck in loop |
Jeej | 0:82a60d86ab2e | 168 | Thread::wait(200); |
Jeej | 0:82a60d86ab2e | 169 | } |
Jeej | 0:82a60d86ab2e | 170 | } |