Dash7Board Code Upgrade Protocol demonstration code.

Dependencies:   modem_ref_helper CRC

Committer:
Jeej
Date:
Wed Sep 19 15:58:35 2018 +0000
Revision:
2:49acddddec25
Parent:
1:dd4e18b267a1
Child:
3:cfe26c2bb78b
Updated libraries and APP for modem 5.2+

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jeej 0:5589104abba0 1 // @autor: jeremie@wizzilab.com
Jeej 0:5589104abba0 2 // @date: 2017-12-14
Jeej 0:5589104abba0 3
Jeej 0:5589104abba0 4 #include "modem_ref_helper.h"
Jeej 0:5589104abba0 5 #include "modem_callbacks.h"
Jeej 0:5589104abba0 6 #include "files.h"
Jeej 0:5589104abba0 7 #include "crc.h"
Jeej 0:5589104abba0 8
Jeej 0:5589104abba0 9 #define CHUNK_SIZE (128)
Jeej 0:5589104abba0 10
Jeej 0:5589104abba0 11 Semaphore modem_ready(0);
Jeej 0:5589104abba0 12 Queue<touch_t, 8> g_file_modified;
Jeej 0:5589104abba0 13
Jeej 0:5589104abba0 14 // CRC calculated on the incoming data stream
Jeej 0:5589104abba0 15 extern uint32_t stream_crc;
Jeej 0:5589104abba0 16
Jeej 0:5589104abba0 17 const uint8_t default_root_key[] = {206, 87, 116, 11, 4, 30, 202, 254, 206, 87, 116, 11, 4, 30, 202, 254};
Jeej 0:5589104abba0 18
Jeej 0:5589104abba0 19 void print_resp(uint8_t id, int status)
Jeej 0:5589104abba0 20 {
Jeej 0:5589104abba0 21 switch (status)
Jeej 0:5589104abba0 22 {
Jeej 0:5589104abba0 23 case ALP_ERR_NONE:
Jeej 0:5589104abba0 24 //PRINT("Resp[%d]: OK\n", id);
Jeej 0:5589104abba0 25 break;
Jeej 0:5589104abba0 26 case ALP_ERR_FILE_EXIST:
Jeej 0:5589104abba0 27 PRINT("Resp[%d]: Already registered\n", id);
Jeej 0:5589104abba0 28 break;
Jeej 0:5589104abba0 29 default:
Jeej 0:5589104abba0 30 PRINT("Resp[%d]: error %d\n", id, status);
Jeej 0:5589104abba0 31 break;
Jeej 0:5589104abba0 32 }
Jeej 0:5589104abba0 33 }
Jeej 0:5589104abba0 34
Jeej 0:5589104abba0 35 modem_callbacks_t callbacks = {
Jeej 0:5589104abba0 36 .read = my_read,
Jeej 0:5589104abba0 37 .write = my_write,
Jeej 0:5589104abba0 38 .read_fprop = my_read_fprop,
Jeej 0:5589104abba0 39 .flush = my_flush,
Jeej 0:5589104abba0 40 .remove = my_delete,
Jeej 0:5589104abba0 41 .udata = my_udata,
Jeej 0:5589104abba0 42 .lqual = my_lqual,
Jeej 0:5589104abba0 43 .ldown = my_ldown,
Jeej 0:5589104abba0 44 .reset = my_reset,
Jeej 1:dd4e18b267a1 45 .boot = my_boot,
Jeej 1:dd4e18b267a1 46 .busy = my_busy
Jeej 0:5589104abba0 47 };
Jeej 0:5589104abba0 48
Jeej 0:5589104abba0 49 // Callback
Jeej 0:5589104abba0 50 void my_main_callback(uint8_t terminal, int8_t err, uint8_t id)
Jeej 0:5589104abba0 51 {
Jeej 0:5589104abba0 52 (void)id;
Jeej 0:5589104abba0 53
Jeej 0:5589104abba0 54 print_resp(id, err);
Jeej 0:5589104abba0 55
Jeej 0:5589104abba0 56 if (terminal)
Jeej 0:5589104abba0 57 {
Jeej 0:5589104abba0 58 modem_ready.release();
Jeej 0:5589104abba0 59 }
Jeej 0:5589104abba0 60 }
Jeej 0:5589104abba0 61
Jeej 0:5589104abba0 62 void thread_file_modified()
Jeej 0:5589104abba0 63 {
Jeej 0:5589104abba0 64 touch_t* touch;
Jeej 0:5589104abba0 65 osEvent evt;
Jeej 0:5589104abba0 66 Timer tim;
Jeej 0:5589104abba0 67 uint32_t total = 0;
Jeej 0:5589104abba0 68 uint32_t next_chunk = 0;
Jeej 0:5589104abba0 69
Jeej 0:5589104abba0 70 uint8_t id = modem_get_id(my_main_callback);
Jeej 0:5589104abba0 71
Jeej 0:5589104abba0 72 PRINT("Ready\n");
Jeej 0:5589104abba0 73
Jeej 0:5589104abba0 74 while (true)
Jeej 0:5589104abba0 75 {
Jeej 0:5589104abba0 76 evt = g_file_modified.get();
Jeej 0:5589104abba0 77 touch = (evt.status == osEventMessage)? (touch_t*)evt.value.p : NULL;
Jeej 0:5589104abba0 78 ASSERT(touch != NULL, "NULL touch pointer!\n");
Jeej 0:5589104abba0 79
Jeej 0:5589104abba0 80 switch (touch->fid)
Jeej 0:5589104abba0 81 {
Jeej 0:5589104abba0 82 case FID_APP_CUP_CFG:
Jeej 0:5589104abba0 83 cup_cfg_t cup_cfg;
Jeej 0:5589104abba0 84
Jeej 0:5589104abba0 85 ram_fs_read(FID_APP_CUP_CFG, 0, sizeof(cup_cfg_t), (uint8_t*)&cup_cfg);
Jeej 0:5589104abba0 86
Jeej 0:5589104abba0 87 if (CUP_CMD_UPGRADE_FILE_START == cup_cfg.cmd)
Jeej 0:5589104abba0 88 {
Jeej 0:5589104abba0 89 PRINT("Enter upload mode. Watchdog %ds\n", cup_cfg.arch_nb);
Jeej 0:5589104abba0 90
Jeej 2:49acddddec25 91 tim.stop();
Jeej 0:5589104abba0 92 tim.reset();
Jeej 0:5589104abba0 93 total = 0;
Jeej 0:5589104abba0 94 next_chunk = 0;
Jeej 0:5589104abba0 95 stream_crc = 0;
Jeej 0:5589104abba0 96
Jeej 0:5589104abba0 97 // Write to the modem CUP config file (as root)
Jeej 0:5589104abba0 98 // to enter upload mode
Jeej 0:5589104abba0 99 cup_cfg.cmd = CUP_CMD_UPGRADE_UPLOAD;
Jeej 0:5589104abba0 100 modem_write_file_root(FID_CUP_CFG, (uint8_t*)&cup_cfg, 0, 4, (uint8_t*)default_root_key, id);
Jeej 0:5589104abba0 101 modem_ready.wait();
Jeej 0:5589104abba0 102 }
Jeej 0:5589104abba0 103 else if (CUP_CMD_UPGRADE_FILE_END == cup_cfg.cmd)
Jeej 0:5589104abba0 104 {
Jeej 0:5589104abba0 105 float time_s = tim.read();
Jeej 0:5589104abba0 106 uint32_t expected_size = cup_cfg.src_offset;
Jeej 0:5589104abba0 107 uint32_t expected_crc = cup_cfg.signature;
Jeej 0:5589104abba0 108
Jeej 0:5589104abba0 109 PRINT("Done. %d/%d bytes received in %.2f sec (%.2f kb/s)\r\n"
Jeej 0:5589104abba0 110 "Expected CRC 0x%08X. Stream CRC 0x%08X.\r\n",
Jeej 2:49acddddec25 111 total, expected_size, time_s, (double)(total/time_s)/1024.0,
Jeej 0:5589104abba0 112 expected_crc, stream_crc);
Jeej 0:5589104abba0 113
Jeej 0:5589104abba0 114 tim.stop();
Jeej 0:5589104abba0 115
Jeej 0:5589104abba0 116 // Compare expected crc with received data crc
Jeej 0:5589104abba0 117 if (stream_crc == expected_crc)
Jeej 0:5589104abba0 118 {
Jeej 0:5589104abba0 119 PRINT("Received complete binary.\n");
Jeej 0:5589104abba0 120 }
Jeej 0:5589104abba0 121 else
Jeej 0:5589104abba0 122 {
Jeej 0:5589104abba0 123 PRINT("Missed or corrupted data in this session.\n");
Jeej 0:5589104abba0 124 }
Jeej 0:5589104abba0 125
Jeej 0:5589104abba0 126
Jeej 0:5589104abba0 127 // Actual check is done here since we could have received some of the missed data in a previous session.
Jeej 0:5589104abba0 128
Jeej 0:5589104abba0 129 /******************************/
Jeej 0:5589104abba0 130 /* Compute CRC on saved data. */
Jeej 0:5589104abba0 131 /******************************/
Jeej 0:5589104abba0 132
Jeej 0:5589104abba0 133 // If you have the full binary data,
Jeej 0:5589104abba0 134 // You can use this function to compute CRC
Jeej 0:5589104abba0 135 //binary_crc = crc32((char*)binary_data, expected_size);
Jeej 0:5589104abba0 136
Jeej 0:5589104abba0 137 // Else just do a loop and a fast CRC on data chunks like in my_write
Jeej 0:5589104abba0 138 }
Jeej 0:5589104abba0 139 else
Jeej 0:5589104abba0 140 {
Jeej 0:5589104abba0 141 PRINT("CUP command 0x%04X\n", cup_cfg.cmd);
Jeej 0:5589104abba0 142 }
Jeej 0:5589104abba0 143
Jeej 0:5589104abba0 144 break;
Jeej 0:5589104abba0 145 case FID_APP_CUP_CODE:
Jeej 0:5589104abba0 146 // Chunk data should be saved in my_write callback
Jeej 0:5589104abba0 147 PRINT("Got CUP code chunk length %d offset %d\n", touch->length, touch->offset);
Jeej 0:5589104abba0 148
Jeej 2:49acddddec25 149 if (!next_chunk)
Jeej 2:49acddddec25 150 {
Jeej 2:49acddddec25 151 // First chunk, start timer
Jeej 2:49acddddec25 152 tim.start();
Jeej 2:49acddddec25 153 }
Jeej 2:49acddddec25 154
Jeej 0:5589104abba0 155 total += touch->length;
Jeej 0:5589104abba0 156
Jeej 0:5589104abba0 157 if (next_chunk != touch->offset)
Jeej 0:5589104abba0 158 {
Jeej 0:5589104abba0 159 PRINT("Missed %d chunk(s) at offset %d (got offset %d)\n", (touch->offset - next_chunk) / CHUNK_SIZE, next_chunk, touch->offset);
Jeej 0:5589104abba0 160 }
Jeej 0:5589104abba0 161 next_chunk = touch->offset + touch->length;
Jeej 0:5589104abba0 162
Jeej 0:5589104abba0 163 // Notify modem code file to reset upload watchdog
Jeej 0:5589104abba0 164 // else the device will exit upload mode after the watchdog timeout
Jeej 0:5589104abba0 165 modem_notify_file(FID_CUP_CODE, 0, 1, id);
Jeej 0:5589104abba0 166 modem_ready.wait();
Jeej 0:5589104abba0 167
Jeej 0:5589104abba0 168 break;
Jeej 0:5589104abba0 169 default:
Jeej 0:5589104abba0 170 PRINT("TOUCH FID %d OFF %d LEN %d\n", touch->fid, touch->offset, touch->length);
Jeej 0:5589104abba0 171 break;
Jeej 0:5589104abba0 172 }
Jeej 0:5589104abba0 173
Jeej 0:5589104abba0 174 FREE(touch);
Jeej 0:5589104abba0 175 }
Jeej 0:5589104abba0 176 }
Jeej 0:5589104abba0 177
Jeej 0:5589104abba0 178 /*** Main function ------------------------------------------------------------- ***/
Jeej 0:5589104abba0 179 int main() {
Jeej 0:5589104abba0 180 // Start & initialize
Jeej 0:5589104abba0 181 #ifdef DEBUG_LED
Jeej 0:5589104abba0 182 DBG_OPEN(DEBUG_LED);
Jeej 0:5589104abba0 183 #else
Jeej 0:5589104abba0 184 DBG_OPEN(NC);
Jeej 0:5589104abba0 185 #endif
Jeej 0:5589104abba0 186 PRINT("\n"
Jeej 0:5589104abba0 187 "-----------------------------------------\n"
Jeej 0:5589104abba0 188 "---------------- Demo CUP ---------------\n"
Jeej 0:5589104abba0 189 "-----------------------------------------\n");
Jeej 0:5589104abba0 190
Jeej 0:5589104abba0 191 modem_helper_open(&callbacks);
Jeej 0:5589104abba0 192
Jeej 0:5589104abba0 193 PRINT("--------------- APP infos ---------------\r\n");
Jeej 0:5589104abba0 194 PRINT(" - Manufacturer ID: %08X\r\n", f_rev.manufacturer_id);
Jeej 0:5589104abba0 195 PRINT(" - Device ID: %08X\r\n", f_rev.device_id);
Jeej 0:5589104abba0 196 PRINT(" - Hardware version: %08X\r\n", f_rev.hw_version);
Jeej 0:5589104abba0 197 PRINT(" - Firmware version: v%d.%d.%d [%02X]\r\n", f_rev.fw_version.major, f_rev.fw_version.minor, f_rev.fw_version.patch, f_rev.fw_version.id);
Jeej 0:5589104abba0 198 PRINT(" - CUP max size: %d\r\n", f_rev.cup_max_size);
Jeej 0:5589104abba0 199 PRINT("-----------------------------------------\r\n");
Jeej 0:5589104abba0 200
Jeej 0:5589104abba0 201 uint8_t id = modem_get_id(my_main_callback);
Jeej 0:5589104abba0 202
Jeej 0:5589104abba0 203 PRINT("Register Files\n");
Jeej 0:5589104abba0 204 modem_update_file(FID_HOST_REV, (alp_file_header_t*)&h_rev, (uint8_t*)&f_rev);
Jeej 0:5589104abba0 205 modem_update_file(FID_APP_CUP_CFG, (alp_file_header_t*)&h_cup_cfg, (uint8_t*)&f_cup_cfg);
Jeej 0:5589104abba0 206
Jeej 0:5589104abba0 207 // Declare the cup code file
Jeej 0:5589104abba0 208 // It needs a special handling of its data in my_write callback since we want to keep them.
Jeej 0:5589104abba0 209 // (can't be done with the current RAM file system)
Jeej 0:5589104abba0 210 modem_declare_file(FID_APP_CUP_CODE, (alp_file_header_t*)&h_cup_code, true, id);
Jeej 0:5589104abba0 211 modem_ready.wait();
Jeej 0:5589104abba0 212
Jeej 1:dd4e18b267a1 213 PRINT("Setup URCs\n");
Jeej 1:dd4e18b267a1 214 // Busy URC to know if modem enters CUP mode
Jeej 1:dd4e18b267a1 215 modem_enable_urc(ALP_URC_TYPE_BUSY, 0, 0, true, id);
Jeej 1:dd4e18b267a1 216 modem_ready.wait();
Jeej 1:dd4e18b267a1 217
Jeej 0:5589104abba0 218 PRINT("Start D7A Stack\n");
Jeej 0:5589104abba0 219 //modem_activate_itf(ALP_ITF_TYPE_D7A, 24, 0, ALP_D7A_ISTAT_RESP | ALP_D7A_ISTAT_UNS, true, id);
Jeej 0:5589104abba0 220 modem_activate_itf(ALP_ITF_TYPE_D7A, 24, 0, 0, true, id);
Jeej 0:5589104abba0 221 modem_ready.wait();
Jeej 0:5589104abba0 222
Jeej 0:5589104abba0 223 PRINT("Notify Modem Version\n");
Jeej 0:5589104abba0 224 modem_notify_file(D7A_FID_FIRMWARE_VERSION, 0, SIZE_HOST_REV, id);
Jeej 0:5589104abba0 225 modem_ready.wait();
Jeej 0:5589104abba0 226
Jeej 0:5589104abba0 227 PRINT("Notify Host Version\n");
Jeej 0:5589104abba0 228 modem_notify_file(FID_HOST_REV, 0, SIZE_HOST_REV, id);
Jeej 0:5589104abba0 229 modem_ready.wait();
Jeej 0:5589104abba0 230
Jeej 0:5589104abba0 231 // id no longer needed
Jeej 0:5589104abba0 232 modem_free_id(id);
Jeej 0:5589104abba0 233
Jeej 0:5589104abba0 234 // Start file modified thread
Jeej 0:5589104abba0 235 Thread th_file_modified(osPriorityNormal, 1024, NULL);
Jeej 0:5589104abba0 236 osStatus status = th_file_modified.start(thread_file_modified);
Jeej 0:5589104abba0 237 ASSERT(status == osOK, "Failed to start thread_file_modified (err: %d)\r\n", status);
Jeej 0:5589104abba0 238
Jeej 0:5589104abba0 239 #ifdef DEBUG_LED
Jeej 0:5589104abba0 240 DigitalOut my_led(DEBUG_LED);
Jeej 0:5589104abba0 241 #endif
Jeej 0:5589104abba0 242
Jeej 0:5589104abba0 243 // Set main task to lowest priority
Jeej 0:5589104abba0 244 osThreadSetPriority(osThreadGetId(), osPriorityIdle);
Jeej 0:5589104abba0 245 while(true)
Jeej 0:5589104abba0 246 {
Jeej 0:5589104abba0 247 Thread::wait(500);
Jeej 0:5589104abba0 248 #ifdef DEBUG_LED
Jeej 0:5589104abba0 249 my_led = !my_led;
Jeej 0:5589104abba0 250 #endif
Jeej 0:5589104abba0 251 }
Jeej 0:5589104abba0 252 }