Program to update the D7A modem's firmware.
Dependencies: modem_ref_helper DebouncedInterrupt
main.cpp@2:e0cdfa7d2a8b, 2016-10-26 (annotated)
- Committer:
- Jeej
- Date:
- Wed Oct 26 11:41:24 2016 +0000
- Revision:
- 2:e0cdfa7d2a8b
- Parent:
- 1:765933092750
- Child:
- 3:a59c8d77006b
Added instructions.
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 | // When the upgrade is done, wait for the modem to auto-reboot. |
Jeej | 2:e0cdfa7d2a8b | 18 | // After the reboot or if the modem did not reboot in the 30 following seconds, |
Jeej | 2:e0cdfa7d2a8b | 19 | // reset the NUCLEO and check if your firmware is up to date. |
Jeej | 2:e0cdfa7d2a8b | 20 | |
Jeej | 2:e0cdfa7d2a8b | 21 | |
Jeej | 2:e0cdfa7d2a8b | 22 | // This is the default root key |
Jeej | 2:e0cdfa7d2a8b | 23 | // if you have changed this key, please specify it here |
Jeej | 2:e0cdfa7d2a8b | 24 | uint8_t root_key[D7A_ROOT_KEY_SIZE] = DEFAULT_ROOT_KEY; |
Jeej | 0:82a60d86ab2e | 25 | |
Jeej | 0:82a60d86ab2e | 26 | // callbacks structure |
Jeej | 0:82a60d86ab2e | 27 | const d7a_callbacks_t callbacks = { |
Jeej | 0:82a60d86ab2e | 28 | .write_file = NULL, |
Jeej | 0:82a60d86ab2e | 29 | .read_file = NULL, |
Jeej | 0:82a60d86ab2e | 30 | .notif_done = NULL, |
Jeej | 0:82a60d86ab2e | 31 | .unsolicited_msg = NULL, |
Jeej | 0:82a60d86ab2e | 32 | }; |
Jeej | 0:82a60d86ab2e | 33 | |
Jeej | 0:82a60d86ab2e | 34 | // Com configuration for the DASH7 shield |
Jeej | 0:82a60d86ab2e | 35 | const d7a_com_config_t shield_config = { |
Jeej | 0:82a60d86ab2e | 36 | .tx = D10, |
Jeej | 0:82a60d86ab2e | 37 | .rx = D2, |
Jeej | 0:82a60d86ab2e | 38 | .rts = D13, |
Jeej | 0:82a60d86ab2e | 39 | .cts = D9, |
Jeej | 0:82a60d86ab2e | 40 | .rx_buffer_size = 1024, |
Jeej | 0:82a60d86ab2e | 41 | }; |
Jeej | 0:82a60d86ab2e | 42 | |
Jeej | 0:82a60d86ab2e | 43 | // Semaphore for notifiying button presses |
Jeej | 0:82a60d86ab2e | 44 | Semaphore button_user(0); |
Jeej | 0:82a60d86ab2e | 45 | |
Jeej | 0:82a60d86ab2e | 46 | // Interrupt Service Routine on button press. |
Jeej | 0:82a60d86ab2e | 47 | void button_push_isr( void ) |
Jeej | 0:82a60d86ab2e | 48 | { |
Jeej | 0:82a60d86ab2e | 49 | button_user.release(); |
Jeej | 0:82a60d86ab2e | 50 | } |
Jeej | 0:82a60d86ab2e | 51 | |
Jeej | 0:82a60d86ab2e | 52 | int main() |
Jeej | 0:82a60d86ab2e | 53 | { |
Jeej | 0:82a60d86ab2e | 54 | d7a_revision_t rev; |
Jeej | 0:82a60d86ab2e | 55 | |
Jeej | 0:82a60d86ab2e | 56 | // Start & initialize |
Jeej | 0:82a60d86ab2e | 57 | DBG_OPEN(); |
Jeej | 1:765933092750 | 58 | PRINT("\r\n-----------------------------------\r\n"); |
Jeej | 1:765933092750 | 59 | PRINT("---------- D7A WM Updater ---------\r\n"); |
Jeej | 1:765933092750 | 60 | PRINT("-----------------------------------\r\n"); |
Jeej | 0:82a60d86ab2e | 61 | |
Jeej | 0:82a60d86ab2e | 62 | DebouncedInterrupt user_interrupt(USER_BUTTON); |
Jeej | 0:82a60d86ab2e | 63 | user_interrupt.attach(button_push_isr, IRQ_FALL, 200, true); |
Jeej | 0:82a60d86ab2e | 64 | |
Jeej | 0:82a60d86ab2e | 65 | d7a_open(&shield_config, A3, &callbacks); |
Jeej | 0:82a60d86ab2e | 66 | |
Jeej | 0:82a60d86ab2e | 67 | // Check modem revision |
Jeej | 0:82a60d86ab2e | 68 | D7A_READ(&rev, D7A_FID_FIRMWARE_VERSION, 0, sizeof(d7a_revision_t), NULL); |
Jeej | 0:82a60d86ab2e | 69 | |
Jeej | 0:82a60d86ab2e | 70 | PRINT("-----------------------------------\r\n"); |
Jeej | 0:82a60d86ab2e | 71 | PRINT("--------- D7A Modem infos ---------\r\n"); |
Jeej | 1:765933092750 | 72 | PRINT("Manufacturer ID: 0x%08X\r\n", rev.manufacturer_id); |
Jeej | 1:765933092750 | 73 | PRINT("Device ID: 0x%08X\r\n", rev.device_id); |
Jeej | 1:765933092750 | 74 | PRINT("Hardware version: 0x%08X\r\n", rev.hw_version); |
Jeej | 1:765933092750 | 75 | PRINT("Firmware version: v%d.%d.%d\r\n", rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch); |
Jeej | 1:765933092750 | 76 | PRINT("Firmware hash: 0x%08x\r\n", rev.fw_version.hash); |
Jeej | 1:765933092750 | 77 | PRINT("File system CRC: 0x%08x\r\n", rev.fs_crc); |
Jeej | 0:82a60d86ab2e | 78 | PRINT("-----------------------------------\r\n"); |
Jeej | 0:82a60d86ab2e | 79 | |
Jeej | 0:82a60d86ab2e | 80 | // Check package infos |
Jeej | 0:82a60d86ab2e | 81 | CUP_Archive cup_pkg; |
Jeej | 0:82a60d86ab2e | 82 | |
Jeej | 0:82a60d86ab2e | 83 | PRINT("-------- CUP Archive infos --------\r\n"); |
Jeej | 1:765933092750 | 84 | PRINT("Firmware version: v%d.%d.%d\r\n", cup_pkg.fw_major, cup_pkg.fw_minor, cup_pkg.fw_patch); |
Jeej | 1:765933092750 | 85 | PRINT("Size: %d\r\n", cup_pkg.data_size); |
Jeej | 1:765933092750 | 86 | PRINT("Nb archives: %d\r\n", cup_pkg.nb_archives); |
Jeej | 1:765933092750 | 87 | PRINT("Signature: 0x%08X\r\n", cup_pkg.signature); |
Jeej | 0:82a60d86ab2e | 88 | PRINT("-----------------------------------\r\n"); |
Jeej | 0:82a60d86ab2e | 89 | |
Jeej | 0:82a60d86ab2e | 90 | // Read CUP config with root permissions |
Jeej | 0:82a60d86ab2e | 91 | cup_cfg_t cup_cfg; |
Jeej | 0:82a60d86ab2e | 92 | D7A_READ(&cup_cfg, CUP_CFG_FID, 0, sizeof(cup_cfg_t), root_key); |
Jeej | 0:82a60d86ab2e | 93 | |
Jeej | 0:82a60d86ab2e | 94 | PRINT("----- CUP Configuration infos -----\r\n"); |
Jeej | 1:765933092750 | 95 | PRINT("Src offset: 0x%08X\r\n", cup_cfg.src_offset); |
Jeej | 1:765933092750 | 96 | PRINT("Signature: 0x%08X\r\n", cup_cfg.signature); |
Jeej | 1:765933092750 | 97 | PRINT("File max size: %d\r\n", cup_cfg.key); |
Jeej | 1:765933092750 | 98 | PRINT("Dbg config: 0x%08X\r\n", cup_cfg.dbg_cfg); |
Jeej | 0:82a60d86ab2e | 99 | PRINT("-----------------------------------\r\n"); |
Jeej | 0:82a60d86ab2e | 100 | |
Jeej | 0:82a60d86ab2e | 101 | uint32_t version_old = (rev.fw_version.major << 24) | (rev.fw_version.minor << 16) | rev.fw_version.patch; |
Jeej | 0:82a60d86ab2e | 102 | uint32_t version_new = (cup_pkg.fw_major << 24) | (cup_pkg.fw_minor << 16) | cup_pkg.fw_patch; |
Jeej | 0:82a60d86ab2e | 103 | |
Jeej | 0:82a60d86ab2e | 104 | if (rev.hw_version != cup_pkg.hw_version) |
Jeej | 0:82a60d86ab2e | 105 | { |
Jeej | 0:82a60d86ab2e | 106 | PRINT("Please select the right Hardware in bin.h\r\n"); |
Jeej | 0:82a60d86ab2e | 107 | } |
Jeej | 0:82a60d86ab2e | 108 | else if((cup_pkg.data_size % cup_pkg.word_size) != 0) |
Jeej | 0:82a60d86ab2e | 109 | { |
Jeej | 0:82a60d86ab2e | 110 | PRINT("Size %d should be multiple of %d.\r\n", cup_pkg.data_size, cup_pkg.word_size); |
Jeej | 0:82a60d86ab2e | 111 | } |
Jeej | 0:82a60d86ab2e | 112 | else if (cup_pkg.data_size > cup_cfg.key) |
Jeej | 0:82a60d86ab2e | 113 | { |
Jeej | 0:82a60d86ab2e | 114 | PRINT("CUP File too big for upgrade. Available %d needs %d.\r\n", cup_cfg.key, cup_pkg.data_size); |
Jeej | 0:82a60d86ab2e | 115 | } |
Jeej | 0:82a60d86ab2e | 116 | else if (version_old == version_new) |
Jeej | 0:82a60d86ab2e | 117 | { |
Jeej | 0:82a60d86ab2e | 118 | PRINT("Your modem is already up to date!\r\n"); |
Jeej | 0:82a60d86ab2e | 119 | } |
Jeej | 0:82a60d86ab2e | 120 | else |
Jeej | 0:82a60d86ab2e | 121 | { |
Jeej | 0:82a60d86ab2e | 122 | if (version_old > version_new) |
Jeej | 0:82a60d86ab2e | 123 | { |
Jeej | 0:82a60d86ab2e | 124 | PRINT("/!\\ Your modem is at a more recent version /!\\\r\n/!\\ Are you sure you want to downgrade? /!\\\r\n"); |
Jeej | 0:82a60d86ab2e | 125 | PRINT("PRESS USER BUTTON TO CONFIRM...\r\n"); |
Jeej | 0:82a60d86ab2e | 126 | button_user.wait(); |
Jeej | 0:82a60d86ab2e | 127 | PRINT("Downgrading firmware: v%d.%d.%d --> v%d.%d.%d\r\n", |
Jeej | 0:82a60d86ab2e | 128 | rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch, |
Jeej | 0:82a60d86ab2e | 129 | cup_pkg.fw_major, cup_pkg.fw_minor, cup_pkg.fw_patch); |
Jeej | 0:82a60d86ab2e | 130 | PRINT("PRESS USER BUTTON TO START DOWNGRADE...\r\n"); |
Jeej | 0:82a60d86ab2e | 131 | } |
Jeej | 0:82a60d86ab2e | 132 | else |
Jeej | 0:82a60d86ab2e | 133 | { |
Jeej | 0:82a60d86ab2e | 134 | PRINT("Upgrading firmware: v%d.%d.%d --> v%d.%d.%d\r\n", |
Jeej | 0:82a60d86ab2e | 135 | rev.fw_version.major, rev.fw_version.minor, rev.fw_version.patch, |
Jeej | 0:82a60d86ab2e | 136 | cup_pkg.fw_major, cup_pkg.fw_minor, cup_pkg.fw_patch); |
Jeej | 0:82a60d86ab2e | 137 | PRINT("PRESS USER BUTTON TO START UPGRADE...\r\n"); |
Jeej | 0:82a60d86ab2e | 138 | } |
Jeej | 0:82a60d86ab2e | 139 | |
Jeej | 0:82a60d86ab2e | 140 | button_user.wait(); |
Jeej | 0:82a60d86ab2e | 141 | cup_pkg.start_update(cup_cfg.src_offset); |
Jeej | 0:82a60d86ab2e | 142 | } |
Jeej | 0:82a60d86ab2e | 143 | |
Jeej | 0:82a60d86ab2e | 144 | // Set main task to lowest priority |
Jeej | 0:82a60d86ab2e | 145 | osThreadSetPriority(osThreadGetId(), osPriorityIdle); |
Jeej | 0:82a60d86ab2e | 146 | while(true) |
Jeej | 0:82a60d86ab2e | 147 | { |
Jeej | 0:82a60d86ab2e | 148 | // Wait to avoid beeing stuck in loop |
Jeej | 0:82a60d86ab2e | 149 | Thread::wait(200); |
Jeej | 0:82a60d86ab2e | 150 | } |
Jeej | 0:82a60d86ab2e | 151 | } |