1/*
2  Copyright (c) 2017 Arduino LLC.  All right reserved.
3
4  This library is free software; you can redistribute it and/or
5  modify it under the terms of the GNU Lesser General Public
6  License as published by the Free Software Foundation; either
7  version 2.1 of the License, or (at your option) any later version.
8
9  This library is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12  See the GNU Lesser General Public License for more details.
13
14  You should have received a copy of the GNU Lesser General Public
15  License along with this library; if not, write to the Free Software
16  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17*/
18
19/**************************************************************************************
20   INCLUDE
21 **************************************************************************************/
22
23#include <WiFiNINA.h>
24#include <FlashStorage.h>
25
26#include "lzss.h"
27
28#ifdef ARDUINO_SAMD_MKRVIDOR4000
29#include <VidorPeripherals.h>
30#endif /* ARDUINO_SAMD_MKRVIDOR4000 */
31
32#ifdef ARDUINO_SAMD_MKRVIDOR4000
33#define NINA_GPIO0  FPGA_NINA_GPIO0
34#define NINA_RESETN FPGA_SPIWIFI_RESET
35#endif /* ARDUINO_SAMD_MKRVIDOR4000 */
36
37/**************************************************************************************
38   DEFINE
39 **************************************************************************************/
40
41#define SDU_START    0x2000
42#define SDU_SIZE     0x4000
43
44#define SKETCH_START (uint32_t*)(SDU_START + SDU_SIZE)
45
46/**************************************************************************************
47   CONST
48 **************************************************************************************/
49
50const char * UPDATE_FILE_NAME      = "/fs/UPDATE.BIN";
51const char * UPDATE_FILE_NAME_LZSS = "/fs/UPDATE.BIN.LZSS";
52
53static const uint32_t crc_table[256] = {
54    0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f, 0xe963a535, 0x9e6495a3,
55    0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91,
56    0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
57    0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9, 0xfa0f3d63, 0x8d080df5,
58    0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
59    0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
60    0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599, 0xb8bda50f,
61    0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924, 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d,
62    0x76dc4190, 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
63    0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
64    0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457,
65    0x65b0d9c6, 0x12b7e950, 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
66    0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb,
67    0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9,
68    0x5005713c, 0x270241aa, 0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
69    0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad,
70    0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683,
71    0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
72    0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb, 0x196c3671, 0x6e6b06e7,
73    0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
74    0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
75    0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef, 0x4669be79,
76    0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236, 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f,
77    0xc5ba3bbe, 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
78    0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
79    0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21,
80    0x86d3d2d4, 0xf1d4e242, 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
81    0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45,
82    0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db,
83    0xaed16a4a, 0xd9d65adc, 0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
84    0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693, 0x54de5729, 0x23d967bf,
85    0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
86};
87
88/**************************************************************************************
89   FUNCTIONS
90 **************************************************************************************/
91
92uint32_t crc_update(uint32_t crc, const void * data, size_t data_len)
93{
94  const unsigned char *d = (const unsigned char *)data;
95  unsigned int tbl_idx;
96
97  while (data_len--) {
98    tbl_idx = (crc ^ *d) & 0xff;
99    crc = (crc_table[tbl_idx] ^ (crc >> 8)) & 0xffffffff;
100    d++;
101  }
102
103  return crc & 0xffffffff;
104}
105
106/**************************************************************************************
107   GLOBAL VARIABLES
108 **************************************************************************************/
109
110FlashClass flash;
111
112// Initialize C library
113extern "C" void __libc_init_array(void);
114
115/**************************************************************************************
116   MAIN
117 **************************************************************************************/
118
119int main() {
120  init();
121
122  __libc_init_array();
123
124  delay(1);
125
126#if defined(ARDUINO_SAMD_MKRVIDOR4000)
127  FPGA.begin();
128  /* NINA select SPI mode and enable (by setting RESETN = '1') */
129  FPGA.pinMode     (NINA_GPIO0,  OUTPUT);
130  FPGA.digitalWrite(NINA_GPIO0,  HIGH);
131  FPGA.pinMode     (NINA_RESETN, OUTPUT);
132  FPGA.digitalWrite(NINA_RESETN, HIGH);
133#elif defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_SAMD_NANO_33_IOT)
134  /* NINA select SPI mode and enable (by setting RESETN = '1') */
135  pinMode     (NINA_GPIO0,  OUTPUT);
136  digitalWrite(NINA_GPIO0,  HIGH);
137  pinMode     (NINA_RESETN, OUTPUT);
138  digitalWrite(NINA_RESETN, HIGH);
139#endif
140
141  String nina_fw_version;
142
143  if (WiFi.status() == WL_NO_SHIELD) {
144    goto boot;
145  }
146
147  nina_fw_version = WiFi.firmwareVersion();
148  if (nina_fw_version < "1.4.1") {
149    goto boot;
150  }
151
152  /* For UPDATE.BIN.LZSS - LZSS compressed binary files. */
153  if (WiFiStorage.exists(UPDATE_FILE_NAME_LZSS))
154  {
155    WiFiStorageFile update_file = WiFiStorage.open(UPDATE_FILE_NAME_LZSS);
156
157    union
158    {
159      struct __attribute__((packed))
160      {
161        uint32_t len;
162        uint32_t crc32;
163      } header;
164      uint8_t buf[sizeof(header)];
165    } ota_header;
166    uint32_t crc32, bytes_read;
167    uint8_t crc_buf[128];
168
169    /* Read the OTA header ... */
170    update_file.read(ota_header.buf, sizeof(ota_header.buf));
171
172    /* ... and check first length ... */
173    if (ota_header.header.len != (update_file.size() - sizeof(ota_header.buf))) {
174      update_file.close();
175      update_file.erase();
176      goto boot;
177    }
178    /* ... and the CRC second ... initialize CRC ... */
179    crc32 = 0xFFFFFFFF;
180    /* ... and calculate over file ... */
181    for(bytes_read = 0;
182        bytes_read < (ota_header.header.len - sizeof(crc_buf));
183        bytes_read += sizeof(crc_buf))
184    {
185      update_file.read(crc_buf, sizeof(crc_buf));
186      crc32 = crc_update(crc32, crc_buf, sizeof(crc_buf));
187    }
188    update_file.read(crc_buf, ota_header.header.len - bytes_read);
189    crc32 = crc_update(crc32, crc_buf, ota_header.header.len - bytes_read);
190    /* ... then finalise ... */
191    crc32 ^= 0xFFFFFFFF;
192    /* ... and compare. */
193    if (ota_header.header.crc32 != crc32) {
194      update_file.close();
195      update_file.erase();
196      goto boot;
197    }
198
199    /* Rewind to start of LZSS compressed binary. */
200    update_file.seek(sizeof(ota_header.buf));
201
202    /* Erase the complete flash starting from the SSU forward
203     * because we've got no possibility of knowing how large
204     * the decompressed binary will finally be.
205     */
206    flash.erase((void*)SKETCH_START, 0x40000 - (uint32_t)SKETCH_START);
207    /* Initialize the lzss module with the data which
208     * it requires.
209     */
210    lzss_init(&update_file, (uint32_t)SKETCH_START);
211    /* During the process of decoding UPDATE.BIN.LZSS
212     * is decompressed and stored as UPDATE.BIN.
213     */
214    lzss_decode();
215    /* Write the data remaining in the write buffer to
216     * the file.
217     */
218    lzss_flush();
219    /* Delete UPDATE.BIN.LZSS because this update is complete. */
220    update_file.close();
221    update_file.erase();
222  }
223  /* For UPDATE.BIN - uncompressed binary files. */
224  else if (WiFiStorage.exists(UPDATE_FILE_NAME)) {
225
226    WiFiStorageFile updateFile = WiFiStorage.open(UPDATE_FILE_NAME);
227    uint32_t updateSize = updateFile.size();
228    bool updateFlashed = false;
229
230    if (updateSize > SDU_SIZE) {
231      // skip the SDU section
232      updateFile.seek(SDU_SIZE);
233      updateSize -= SDU_SIZE;
234
235      uint32_t flashAddress = (uint32_t)SKETCH_START;
236
237      // erase the pages
238      flash.erase((void*)flashAddress, updateSize);
239
240      uint8_t buffer[128];
241
242      // write the pages
243      for (uint32_t i = 0; i < updateSize; i += sizeof(buffer)) {
244        updateFile.read(buffer, sizeof(buffer));
245
246        flash.write((void*)flashAddress, buffer, sizeof(buffer));
247
248        flashAddress += sizeof(buffer);
249      }
250
251      updateFlashed = true;
252    }
253
254    updateFile.close();
255
256    if (updateFlashed) {
257      updateFile.erase();
258    }
259  }
260
261boot:
262  // jump to the sketch
263  __set_MSP(*SKETCH_START);
264
265  //Reset vector table address
266  SCB->VTOR = ((uint32_t)(SKETCH_START) & SCB_VTOR_TBLOFF_Msk);
267
268  // address of Reset_Handler is written by the linker at the beginning of the .text section (see linker script)
269  uint32_t resetHandlerAddress = (uint32_t) * (SKETCH_START + 1);
270  // jump to reset handler
271  asm("bx %0"::"r"(resetHandlerAddress));
272}
273