-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathcorsacOTA.c
1800 lines (1490 loc) · 52.5 KB
/
corsacOTA.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Copyright (c) 2021 windowsair <msdn_02 at sina.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#include <stdint.h>
#include <string.h>
#include <sys/param.h>
#include "corsacOTA.h"
#include "esp_log.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "mbedtls/base64.h"
#include "mbedtls/sha1.h"
#include "esp_ota_ops.h"
#include "esp_partition.h"
#include "esp_system.h"
#include "lwip/err.h"
#include "lwip/sockets.h"
#include "lwip/sys.h"
#include <lwip/netdb.h>
#include "sdkconfig.h"
#if (defined CONFIG_IDF_TARGET_ESP8266) && (CONFIG_IDF_TARGET_ESP8266 == 1)
#define CO_TARGET_ESP8266 1
#define CO_DEVICE_TYPE_NAME "esp8266"
#include "esp8266/eagle_soc.h"
#endif
#if (defined CONFIG_IDF_TARGET_ESP32) && (CONFIG_IDF_TARGET_ESP32 == 1)
#define CO_TARGET_ESP32 1
#define CO_DEVICE_TYPE_NAME "esp32"
#include "esp32/rom/uart.h"
#include "hal/wdt_hal.h"
#include "hal/wdt_types.h"
#include "soc/rtc.h"
#endif
#if (defined CONFIG_IDF_TARGET_ESP32S2) && (CONFIG_IDF_TARGET_ESP32S2 == 1)
#define CO_DEVICE_TYPE_NAME "esp32s2"
#define CO_TARGET_ESP32 1
#include "esp32s2/rom/uart.h"
#include "hal/wdt_hal.h"
#include "hal/wdt_types.h"
#include "soc/rtc.h"
#endif
#if (defined CONFIG_IDF_TARGET_ESP32C3) && (CONFIG_IDF_TARGET_ESP32C3 == 1)
#define CO_DEVICE_TYPE_NAME "esp32c3"
#define CO_TARGET_ESP32C3 1
#include "esp32c3/rom/uart.h"
#include "hal/wdt_hal.h"
#include "hal/wdt_types.h"
#include "soc/rtc.h"
#endif
#if (defined CONFIG_IDF_TARGET_ESP32S3) && (CONFIG_IDF_TARGET_ESP32S3 == 1)
#define CO_DEVICE_TYPE_NAME "esp32s3"
#define CO_TARGET_ESP32S3 1
#include "esp32s3/rom/uart.h"
#include "hal/wdt_hal.h"
#include "hal/wdt_types.h"
#include "soc/rtc.h"
#endif
#if (!defined CO_TARGET_ESP8266) && (!defined CO_TARGET_ESP32) && (!defined CONFIG_IDF_TARGET_ESP32S2) && (!defined CONFIG_IDF_TARGET_ESP32C3) && (!defined CONFIG_IDF_TARGET_ESP32S3)
#error Unknown hardware platform
#endif
#if (defined CONFIG_PARTITION_TABLE_SINGLE_APP) && (CONFIG_PARTITION_TABLE_SINGLE_APP == 1)
#warning No OTA partition configured. corsacOTA may not work!
#endif
static const char *CO_TAG = "corsacOTA";
#define CONFIG_CO_SOCKET_BUFFER_SIZE 1500
#define CONFIG_CO_WS_TEXT_BUFFER_SIZE 100
#define LOG_FMT(x) "%s: " x, __func__
#define min(a, b) ((a) < (b) ? (a) : (b))
#define CO_NO_RETURN __attribute__((noreturn))
#define CO_INLINE __attribute__((always_inline))
#define CO_TEST_MODE 0
#if (CO_TEST_MODE == 1)
#warning corsacOTA test mode is in use
#endif
/**
* @brief corsacOTA websocket control block
*
*/
typedef struct co_websocket_cb {
uint8_t FIN;
uint8_t OPCODE;
uint8_t MASK;
size_t payload_len; // it is used not only for the 7-bit payload len,
// but also for the total length of the payload after the extended payload length is included.
size_t payload_read_len; // the number of payload bytes already read
union {
uint32_t val;
uint8_t data[4];
} mask;
bool skip_frame; // skip too long text frames
} co_websocket_cb_t;
/**
* @brief corsacOTA socket control block
*
*/
typedef struct co_socket_cb {
int fd; // The file descriptor for this socket
enum co_socket_status {
CO_SOCKET_ACCEPT = 0,
CO_SOCKET_HANDSHAKE, // not handshake, or in progress
CO_SOCKET_WEBSOCKET_HEADER, // already handshake, now reading the header of websocket frame
CO_SOCKET_WEBSOCKET_EXTEND_LENGTH, // reading the extended length of websocket header
CO_SOCKET_WEBSOCKET_MASK, // reading the mask part of websocket header
CO_SOCKET_WEBSOCKET_PAYLOAD, // reading the payload of websocket frame
CO_SOCKET_CLOSING // waiting to close
} status;
char *buf; // data from raw socket
size_t remaining_len; // the number of available bytes remaining in buf
size_t read_len; // the number of bytes that have been processed
co_websocket_cb_t wcb; // websocket control block
} co_socket_cb_t;
/**
* @brief corsacOTA OTA control block
*
*/
typedef struct co_ota_cb {
enum co_ota_status {
CO_OTA_INIT = 0,
CO_OTA_LOAD,
CO_OTA_DONE,
CO_OTA_STOP,
CO_OTA_ERROR,
CO_OTA_FATAL_ERROR,
} status;
int32_t error_code; //// TODO: ?
const esp_partition_t *update_ptn;
const esp_partition_t *running_ptn;
esp_ota_handle_t update_handle;
int32_t total_size; // Total firmware size
int32_t offset; // Current processed size
int32_t chunk_size; // The response will be made every time the chunk size is reached
int32_t last_index_offset; // The offset recorded in the last response
} co_ota_cb_t;
/**
* @brief corsacOTA http control block
*
*/
typedef struct co_cb {
int listen_fd; // server listener FD
int websocket_fd; // only one websocket is allowed.
uint8_t *recv_data; // recv buffer at websocket stage (text mode)
int recv_data_offset; // (text mode)
int max_listen_num; // maxium number of connections. In fact, after the handshake is complete, there is only one connection to provide services
int wait_timeout_sec; // timeout (in seconds)
int wait_timeout_usec; // timeout (in microseconds)
co_socket_cb_t **socket_list; // socket control block list
co_socket_cb_t *websocket; // the only valid socket in the list
int accept_num; // current number of established connections
int closing_num; // current number of closing socket
co_ota_cb_t ota; // ota control block
} co_cb_t;
static co_cb_t *global_cb = NULL;
typedef void (*co_process_fn_t)(void *);
typedef struct co_process_entry {
const char *str;
co_process_fn_t fn;
} co_process_entry_t;
static void co_ota_start(void *data);
static void co_ota_stop(void *data);
#define CO_ENTRY_DICT_LEN (sizeof(co_entry_dict) / sizeof(co_entry_dict[0]))
#define CO_ENTRT_DICT_ITEM_LEN (sizeof(co_entry_dict[0]))
// must be sorted alphabetically
static const co_process_entry_t co_entry_dict[] = {
{"start", co_ota_start},
{"stop", co_ota_stop},
};
static int co_compare(const void *s1, const void *s2) {
const co_process_entry_t *e1 = s1;
const co_process_entry_t *e2 = s2;
return strcmp(e1->str, e2->str);
}
static co_process_fn_t co_get_process_entry(char *str) {
co_process_entry_t *res;
co_process_entry_t key = {str, NULL};
res = bsearch(&key, co_entry_dict, CO_ENTRY_DICT_LEN, CO_ENTRT_DICT_ITEM_LEN, co_compare);
if (res) {
return res->fn;
}
return NULL;
}
#if (CO_TARGET_ESP8266)
extern void uart_tx_wait_idle(uint8_t uart_no);
extern void esp_reset_reason_set_hint(esp_reset_reason_t hint);
/**
* @brief In some cases, reboot operation cannot be completed properly, so we take a forced reboot.
*
*/
static void CO_NO_RETURN co_hardware_restart() {
vPortEnterCritical(); // avoid entering the panicHandler
uart_tx_wait_idle(0);
uart_tx_wait_idle(1);
esp_reset_reason_set_hint(ESP_RST_SW); // software restart
// force restart
CLEAR_WDT_REG_MASK(WDT_CTL_ADDRESS, BIT0);
WDT_REG_WRITE(WDT_OP_ADDRESS, 1);
WDT_REG_WRITE(WDT_OP_ND_ADDRESS, 1);
SET_PERI_REG_BITS(PERIPHS_WDT_BASEADDR + WDT_CTL_ADDRESS,
WDT_CTL_RSTLEN_MASK,
7 << WDT_CTL_RSTLEN_LSB,
0);
SET_PERI_REG_BITS(PERIPHS_WDT_BASEADDR + WDT_CTL_ADDRESS,
WDT_CTL_RSPMOD_MASK,
0 << WDT_CTL_RSPMOD_LSB,
0);
SET_PERI_REG_BITS(PERIPHS_WDT_BASEADDR + WDT_CTL_ADDRESS,
WDT_CTL_EN_MASK,
1 << WDT_CTL_EN_LSB,
0);
while (1) {
}
}
#endif // CO_TARGET_ESP8266
#if (CO_TARGET_ESP32)
extern void uart_tx_wait_idle(uint8_t uart_no);
extern void esp_reset_reason_set_hint(esp_reset_reason_t hint);
extern void xt_ints_off(unsigned int mask);
/**
* @brief In some cases, reboot operation cannot be completed properly, so we take a forced reboot.
*
*/
void CO_NO_RETURN co_hardware_restart() {
wdt_hal_context_t rtc_wdt_ctx;
uint32_t stage_timeout_ticks;
xt_ints_off(0xFFFFFFFF); // disable all interrupts
uart_tx_wait_idle(0);
uart_tx_wait_idle(1);
uart_tx_wait_idle(2);
wdt_hal_init(&rtc_wdt_ctx, WDT_RWDT, 0, false);
stage_timeout_ticks = (uint32_t)(1000ULL * rtc_clk_slow_freq_get_hz() / 1000ULL);
wdt_hal_write_protect_disable(&rtc_wdt_ctx);
wdt_hal_config_stage(&rtc_wdt_ctx, WDT_STAGE0, stage_timeout_ticks, WDT_STAGE_ACTION_RESET_SYSTEM);
wdt_hal_config_stage(&rtc_wdt_ctx, WDT_STAGE1, stage_timeout_ticks, WDT_STAGE_ACTION_RESET_RTC);
wdt_hal_set_flashboot_en(&rtc_wdt_ctx, true);
wdt_hal_write_protect_enable(&rtc_wdt_ctx);
esp_reset_reason_set_hint(ESP_RST_SW); // software restart
while (1) {
}
}
#elif (CO_TARGET_ESP32S3)
extern void uart_tx_wait_idle(uint8_t uart_no);
extern void esp_reset_reason_set_hint(esp_reset_reason_t hint);
extern void xt_ints_off(unsigned int mask);
void CO_NO_RETURN co_hardware_restart() {
wdt_hal_context_t rtc_wdt_ctx;
uint32_t stage_timeout_ticks;
xt_ints_off(0xFFFFFFFF); // disable all interrupts
uart_tx_wait_idle(0);
uart_tx_wait_idle(1);
uart_tx_wait_idle(2);
wdt_hal_init(&rtc_wdt_ctx, WDT_RWDT, 0, false);
stage_timeout_ticks = (uint32_t)(1000ULL * rtc_clk_slow_freq_get_hz() / 1000ULL);
wdt_hal_write_protect_disable(&rtc_wdt_ctx);
wdt_hal_config_stage(&rtc_wdt_ctx, WDT_STAGE0, stage_timeout_ticks, WDT_STAGE_ACTION_RESET_SYSTEM);
wdt_hal_config_stage(&rtc_wdt_ctx, WDT_STAGE1, stage_timeout_ticks, WDT_STAGE_ACTION_RESET_RTC);
wdt_hal_set_flashboot_en(&rtc_wdt_ctx, true);
wdt_hal_write_protect_enable(&rtc_wdt_ctx);
esp_reset_reason_set_hint(ESP_RST_SW); // software restart
while (1) {
}
}
#elif (CO_TARGET_ESP32C3)
extern void uart_tx_wait_idle(uint8_t uart_no);
extern void esp_reset_reason_set_hint(esp_reset_reason_t hint);
extern void riscv_global_interrupts_disable(void);
/**
* @brief In some cases, reboot operation cannot be completed properly, so we take a forced reboot.
*
*/
void CO_NO_RETURN co_hardware_restart() {
wdt_hal_context_t rtc_wdt_ctx;
uint32_t stage_timeout_ticks;
riscv_global_interrupts_disable(); // disable all interrupts
uart_tx_wait_idle(0);
uart_tx_wait_idle(1);
wdt_hal_init(&rtc_wdt_ctx, WDT_RWDT, 0, false);
stage_timeout_ticks = (uint32_t)(1000ULL * rtc_clk_slow_freq_get_hz() / 1000ULL);
wdt_hal_write_protect_disable(&rtc_wdt_ctx);
wdt_hal_config_stage(&rtc_wdt_ctx, WDT_STAGE0, stage_timeout_ticks, WDT_STAGE_ACTION_RESET_SYSTEM);
wdt_hal_config_stage(&rtc_wdt_ctx, WDT_STAGE1, stage_timeout_ticks, WDT_STAGE_ACTION_RESET_RTC);
wdt_hal_set_flashboot_en(&rtc_wdt_ctx, true);
wdt_hal_write_protect_enable(&rtc_wdt_ctx);
esp_reset_reason_set_hint(ESP_RST_SW); // software restart
while (1) {
}
}
#endif // CO_TARGET_ESP32
/**
* @brief Parse the request text and populate the op and data.
*
* @param text Original request text
* @param[in] op operation field
* @param[in] data data field
* @return co_err_t
* - CO_OK
* - CO_FAIL
*/
static co_err_t co_parse_request_text(const char *text, char *op, char *data) {
int ret, n;
n = 0;
// "op=auth&data=password"
// "op=start&data=12345"
// "op=stop&data="
ret = sscanf(text, "op=%10[^&]&data=%n%10s", op, &n, data);
if (ret == 2) {
return CO_OK;
} else if (ret == 1 && text[n] == '\0') { // data is empty
data[0] = '\0';
return CO_OK;
} else {
return CO_FAIL;
}
}
/* RFC 6455: The WebSocket Protocol
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-------+-+-------------+-------------------------------+
|F|R|R|R| opcode|M| Payload len | Extended payload length |
|I|S|S|S| (4) |A| (7) | (16/64) |
|N|V|V|V| |S| | (if payload len==126/127) |
| |1|2|3| |K| | |
+-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
| Extended payload length continued, if payload len == 127 |
+ - - - - - - - - - - - - - - - +-------------------------------+
| |Masking-key, if MASK set to 1 |
+-------------------------------+-------------------------------+
| Masking-key (continued) | Payload Data |
+-------------------------------- - - - - - - - - - - - - - - - +
: Payload Data continued ... :
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| Payload Data continued ... |
+---------------------------------------------------------------+
*/
#define WS_FIN 0x80
#define WS_RSV1 0x40
#define WS_RSV2 0x20
#define WS_RSV3 0x10
#define WS_OPCODE_CONTINUTAION 0x00
#define WS_OPCODE_TEXT 0x01
#define WS_OPCODE_BINARY 0x02
#define WS_OPCODE_CLOSE 0x08
#define WS_OPCODE_PING 0x09
#define WS_OPCODE_PONG 0x0A
#define WS_MASK 0x80
static inline int co_websocket_get_res_payload_offset(int payload_len) {
// promise: payload_len <= 65535
return 2 + (payload_len >= 126 ? 2 : 0);
}
static co_err_t co_websocket_process_header(co_cb_t *cb, co_socket_cb_t *scb) {
uint8_t opcode, fin, mask;
uint64_t payload_len;
uint8_t *data;
data = (uint8_t *)scb->buf;
if (scb->status == CO_SOCKET_WEBSOCKET_HEADER) {
if (scb->remaining_len < 2) {
return CO_OK;
}
// check RSV
if (data[0] & 0b1110000) {
return CO_FAIL; // no extension defining RSV
}
// first byte
fin = (data[0] & WS_FIN) == WS_FIN;
opcode = data[0] & 0b1111;
// second byte
mask = (data[1] & WS_MASK) == WS_MASK;
payload_len = data[1] & 0x7F;
switch (opcode) {
case WS_OPCODE_CONTINUTAION:
// nothing to do
break;
case WS_OPCODE_TEXT:
case WS_OPCODE_BINARY:
scb->wcb.OPCODE = opcode;
break;
case WS_OPCODE_PING:
case WS_OPCODE_PONG:
scb->wcb.OPCODE = opcode;
break;
case WS_OPCODE_CLOSE:
scb->wcb.OPCODE = opcode;
break;
default:
return CO_FAIL;
break;
}
scb->wcb.FIN = fin;
scb->wcb.MASK = mask;
scb->wcb.payload_len = payload_len;
// extended payload length should be read
if (payload_len == 126 || payload_len == 127) {
scb->status = CO_SOCKET_WEBSOCKET_EXTEND_LENGTH;
} else if (mask == 1) {
scb->status = CO_SOCKET_WEBSOCKET_MASK;
}
scb->read_len = 2; // first 2 byte header
}
if (scb->status == CO_SOCKET_WEBSOCKET_EXTEND_LENGTH) {
if (scb->wcb.payload_len == 126) {
if (scb->remaining_len < scb->read_len + 2) { // 2 byte extended length
return CO_OK;
}
payload_len = data[2] << 8 | data[3]; // 0 + scb->read_len == 2
scb->read_len += 2;
} else if (scb->wcb.payload_len == 127) { // 8 byte extended length
if (scb->remaining_len < scb->read_len + 8) {
return CO_OK;
}
payload_len = ((uint64_t)(data[9]) << 0);
payload_len |= ((uint64_t)(data[8]) << 8);
payload_len |= ((uint64_t)(data[7]) << 16);
payload_len |= ((uint64_t)(data[6]) << 24);
payload_len |= ((uint64_t)(data[5]) << 32);
payload_len |= ((uint64_t)(data[4]) << 40);
payload_len |= ((uint64_t)(data[3]) << 48);
payload_len |= ((uint64_t)(data[2]) << 56);
// most significant bit MUST be 0
if (((payload_len >> 63) & 0b1) == 0x1) {
ESP_LOGE(CO_TAG, "wrong payload length");
return CO_FAIL;
}
scb->read_len += 8;
} else {
payload_len = scb->wcb.payload_len;
}
scb->wcb.payload_len = payload_len;
scb->status = scb->wcb.MASK == 1 ? CO_SOCKET_WEBSOCKET_MASK : CO_SOCKET_WEBSOCKET_PAYLOAD;
}
if (scb->status == CO_SOCKET_WEBSOCKET_MASK) {
if (scb->remaining_len < scb->read_len + 4) { // 4 byte mask
return CO_OK;
}
memcpy(&scb->wcb.mask.data[0], &data[scb->read_len], 4);
scb->read_len += 4;
scb->status = CO_SOCKET_WEBSOCKET_PAYLOAD;
} else {
scb->status = CO_SOCKET_WEBSOCKET_PAYLOAD;
}
return CO_OK;
}
// We promise that the length of the payload should not exceed 65535
static co_err_t co_websocket_send_frame(void *frame_buffer, size_t payload_len, int frame_type) {
int sz;
uint16_t payload_length;
uint8_t *p;
payload_length = payload_len;
sz = co_websocket_get_res_payload_offset(payload_len) + payload_len;
p = frame_buffer;
// 2 bytes
*p++ = WS_FIN | frame_type; // frame_type
*p++ = (payload_length >= 126 ? 126 : payload_length);
// extended length
if (payload_length >= 126) {
payload_length = htons(payload_length);
memcpy(p, &payload_length, 2);
p += 2;
}
// no mask
send(global_cb->websocket->fd, frame_buffer, sz, 0);
return CO_OK;
}
// Create a new frame buffer, construct text and send frame.
static co_err_t co_websocket_send_msg_with_code(int code, const char *msg) {
char *buffer;
int len, ret;
int offset;
len = strlen(msg);
offset = co_websocket_get_res_payload_offset(len);
buffer = malloc(offset + len + 25);
if (buffer == NULL) {
ret = CO_ERROR_NO_MEM;
goto cleanup;
}
if (code == CO_RES_SUCCESS) {
ret = snprintf(buffer + offset, len + 24, "code=%d&data=\"%s\"", code, msg);
} else {
ret = snprintf(buffer + offset, len + 24, "code=%d&data=\"msg=%s\"", code, msg);
}
if (ret < 0) {
ESP_LOGE(CO_TAG, "invalid arg");
ret = CO_ERROR_INVALID_ARG;
goto cleanup;
}
ret = co_websocket_send_frame(buffer, ret, WS_OPCODE_TEXT);
cleanup:
free(buffer);
return ret;
}
#if (CO_TEST_MODE == 1)
// use for test
static co_err_t co_websocket_send_echo(void *data, size_t len, int frame_type) {
char *buffer;
int ret;
int offset;
offset = co_websocket_get_res_payload_offset(len);
buffer = malloc(offset + len);
if (buffer == NULL) {
ret = CO_ERROR_NO_MEM;
goto cleanup;
}
memcpy(buffer + offset, data, len);
ret = co_websocket_send_frame(buffer, len, frame_type);
cleanup:
free(buffer);
return ret;
}
#endif // (CO_TEST_MODE == 1)
static const char *co_ota_error_to_msg(esp_err_t err) {
switch (err) {
case ESP_OK:
return NULL;
case ESP_ERR_NO_MEM:
return "No Mem";
case ESP_ERR_INVALID_ARG:
return "Invalid handle";
case ESP_ERR_OTA_VALIDATE_FAILED:
return "Invalid firmware";
case ESP_ERR_INVALID_SIZE:
return "Firmware size too large";
case ESP_ERR_OTA_SELECT_INFO_INVALID:
return "Invalid partition info";
case ESP_ERR_NOT_FOUND:
return "OTA partition not found";
case ESP_ERR_FLASH_OP_TIMEOUT:
case ESP_ERR_FLASH_OP_FAIL:
return "Flash write failed";
case ESP_ERR_INVALID_STATE:
return "Flash encryption is enabled";
default:
return "OTA Failed";
}
}
/**
* @brief OTA init
*
* @param size Total firmware size
* @return const char* Error message, returns NULL indicating that no error occurred
*/
static const char *co_ota_init(int32_t size) {
const esp_partition_t *boot_ptn, *running_ptn, *update_ptn;
esp_err_t ret;
boot_ptn = esp_ota_get_boot_partition();
running_ptn = esp_ota_get_running_partition();
if (boot_ptn != running_ptn) {
//// TODO: boot image become corrupted
}
update_ptn = esp_ota_get_next_update_partition(NULL);
if (update_ptn == NULL) {
global_cb->ota.status = CO_OTA_FATAL_ERROR;
global_cb->ota.error_code = CO_ERROR_INVALID_OTA_PTN;
return "Invalid OTA data partition";
}
// Start erase flash
//// TODO: full chip erase
ret = esp_ota_begin(update_ptn, size, &global_cb->ota.update_handle);
global_cb->ota.update_ptn = update_ptn;
return co_ota_error_to_msg(ret);
}
// write ota data
static const char *co_ota_write(void *data, size_t len) {
esp_err_t ret = esp_ota_write(global_cb->ota.update_handle, data, len);
return co_ota_error_to_msg(ret);
}
static const char *co_ota_end() {
esp_err_t ret = esp_ota_end(global_cb->ota.update_handle);
if (ret != ESP_OK) {
return co_ota_error_to_msg(ret);
}
ret = esp_ota_set_boot_partition(global_cb->ota.update_ptn);
return co_ota_error_to_msg(ret);
}
/**
* @brief Process OTA start request
*
* @param data Pointer to a string indicating the size of the firmware
*/
static void co_ota_start(void *data) { // TODO: return value -> status
const char *res_msg = "deviceType=" CO_DEVICE_TYPE_NAME "&state=ready&offset=0";
const char *err_msg;
int size;
// may be we should ignore status...
// if (global_cb->ota.status != CO_OTA_INIT && global_cb->ota.status != CO_OTA_STOP) {
// co_websocket_send_msg_with_code(CO_RES_INVALID_STATUS, "OTA has not started");
// return;
// }
size = atoi(data);
if (size < 1) {
co_websocket_send_msg_with_code(CO_RES_INVALID_SIZE, "Invalid size");
return;
}
err_msg = co_ota_init(size);
if (err_msg != NULL) {
co_websocket_send_msg_with_code(CO_RES_SYSTEM_ERROR, err_msg);
return;
}
global_cb->ota.status = CO_OTA_LOAD;
global_cb->ota.total_size = size;
size = min(global_cb->ota.total_size / 10, 1024 * 10); // 10KB default
if (size == 0) {
size = 1; // Firmware too small...
}
global_cb->ota.chunk_size = size;
global_cb->ota.offset = 0;
global_cb->ota.last_index_offset = 0;
co_websocket_send_msg_with_code(CO_RES_SUCCESS, res_msg);
}
static void co_ota_stop(void *data) {
if (global_cb->ota.status != CO_OTA_FATAL_ERROR) {
memset(&global_cb->ota, 0, sizeof(global_cb->ota));
global_cb->ota.status = CO_OTA_STOP;
co_websocket_send_msg_with_code(CO_RES_SUCCESS, "");
} else {
co_websocket_send_msg_with_code(CO_RES_SYSTEM_ERROR, "Fatal error");
}
}
static void co_websocket_process_binary(uint8_t *data, size_t len) {
char res[32]; // state=ready&offset=2147483647
const char *err_msg;
bool is_done;
if (global_cb->ota.status == CO_OTA_LOAD) {
global_cb->ota.offset += (int)len;
is_done = global_cb->ota.total_size == global_cb->ota.offset;
if (is_done) {
// If everything is fine, then we will restart chip afterwards, which does not require the use of the status
global_cb->ota.status = CO_OTA_INIT;
}
err_msg = co_ota_write(data, len);
if (err_msg != NULL) {
memset(&global_cb->ota, 0, sizeof(global_cb->ota));
global_cb->ota.status = CO_OTA_STOP;
co_websocket_send_msg_with_code(CO_RES_SYSTEM_ERROR, err_msg);
return;
}
// response
if (!is_done && global_cb->ota.offset - global_cb->ota.last_index_offset < global_cb->ota.chunk_size) {
return;
}
global_cb->ota.last_index_offset = global_cb->ota.offset;
snprintf(res, 32, "state=%s&offset=%d", is_done ? "done" : "ready", global_cb->ota.offset);
if (is_done) {
err_msg = co_ota_end();
if (err_msg != NULL) {
co_websocket_send_msg_with_code(CO_RES_SYSTEM_ERROR, err_msg);
return;
}
co_websocket_send_msg_with_code(CO_RES_SUCCESS, res);
ESP_LOGD(CO_TAG, "prepare to restart");
vTaskDelay(pdMS_TO_TICKS(5000));
co_hardware_restart();
}
co_websocket_send_msg_with_code(CO_RES_SUCCESS, res);
} else if (global_cb->ota.status != CO_OTA_STOP) {
// skip the rest of the frame when a stop command is received
co_websocket_send_msg_with_code(CO_RES_INVALID_STATUS, "OTA has not started");
}
}
static void co_websocket_process_text(uint8_t *data, size_t len) {
char op_field[10 + 1], data_field[10 + 1];
char *text;
co_process_fn_t fn;
// Note that the text may not have a terminator
// TODO: add terminator
text = strndup((char *)data, len);
if (text == NULL) {
// TODO: memory leak
goto clean;
}
if (co_parse_request_text(text, op_field, data_field) != CO_OK) {
co_websocket_send_msg_with_code(CO_RES_INVALID_ARG, "parse error");
goto clean;
}
if ((fn = co_get_process_entry(op_field)) == NULL) {
co_websocket_send_msg_with_code(CO_RES_INVALID_ARG, "invalid op");
goto clean;
}
// start process!
fn(data_field);
clean:
free(text);
}
// send pong response
// TODO: too long ping frame
static void co_websocket_process_ping(co_cb_t *cb, co_socket_cb_t *scb) {
int len;
// control frame max payload length: 125 -> 0 byte extended length
len = 2 + scb->wcb.payload_len + (scb->wcb.MASK ? 4 : 0);
scb->buf[0] = WS_FIN | WS_OPCODE_PONG;
send(scb->fd, scb->buf, len, 0);
}
// close handshake
// TODO: array
static void co_websocket_process_close(co_cb_t *cb, co_socket_cb_t *scb) {
uint8_t buf[4];
uint8_t *p = buf;
*p++ = WS_FIN | WS_OPCODE_CLOSE;
*p++ = 0x02; // 2 byte status code
// normal closure
*p++ = 0x03;
*p = 0xe8;
send(scb->fd, buf, 4, 0);
}
static inline CO_INLINE uint32_t co_rotr32(uint32_t n, unsigned int c) {
const unsigned int mask = (CHAR_BIT * sizeof(n) - 1);
c &= mask;
return (n >> c) | (n << ((-c) & mask));
}
/**
* @brief Quick calculation WebSocket. The process of calculating the mask is one of the performance bottlenecks
* of the entire websocket. The performance between the optimized version and the version without mask is not significant.
*
* We assume: the natural machine word length is 4byte (32bits) and the endianness is little-endian
* For xtensa: single fetch: 4 byte(32bit)
*
* @param data data buffer ptr
* @param mask websocket mask. Little-endian 32bis mask.
* @param len data length
*/
void co_websocket_fast_mask(uint8_t *data, uint32_t mask, size_t len) {
uint32_t new_mask;
int align_len;
size_t i;
const uint8_t *p_mask = (uint8_t *)&mask;
unsigned long int dst = (long int)data;
if (len >= 8) {
// copy just a few bytes to make dst aligned.
align_len = (-dst) % 4;
len -= align_len;
for (i = 0; i < align_len; i++) {
data[i] ^= p_mask[i];
}
// use the new mask on the aligned address
switch (align_len) {
case 1:
new_mask = co_rotr32(mask, 8U);
break;
case 2:
new_mask = co_rotr32(mask, 16U);
break;
case 3:
new_mask = co_rotr32(mask, 24U);
break;
default: // 0
new_mask = mask;
break;
}
p_mask = (uint8_t *)&new_mask;
dst += align_len;
for (i = 0; i < len / 4; i++) {
*((uint32_t *)dst) ^= new_mask;
dst += 4;
}
len %= 4;
}
// There are just a few bytes to process
for (i = 0; i < len; i++) {
*((uint8_t *)dst) ^= p_mask[i % 4];
dst += 1;
}
}
static inline uint32_t co_websocket_get_new_mask(uint32_t mask, size_t len) {
switch (len & 0b11) {
case 1:
return co_rotr32(mask, 8U);
case 2:
return co_rotr32(mask, 16U);
case 3:
return co_rotr32(mask, 24U);
default:
return mask;
}
}
/**
* @brief Process websocket payload
*
* @param cb corsacOTA control block
* @param scb corsacOTA socket control block
* @return co_err_t
* - CO_OK: Successful processing of all payloads
* - CO_ERROR_IO_PENDING: There are still new frames to be processed
*/
static co_err_t co_websocket_process_payload(co_cb_t *cb, co_socket_cb_t *scb) {
int len, new_len;
uint8_t *data;
uint32_t mask;
data = (uint8_t *)scb->buf + scb->read_len;
// May be possible to read the complete frame and maybe a new frame rate afterwards
len = min(scb->remaining_len - scb->read_len, scb->wcb.payload_len);
// For ping frames, we will directly change their opcode and send.
if (scb->wcb.MASK == 1 && scb->wcb.OPCODE != WS_OPCODE_PING) {
mask = scb->wcb.mask.val;
co_websocket_fast_mask(data, mask, len);
scb->wcb.mask.val = co_websocket_get_new_mask(mask, len);
}
// In the previous processing, we can ensure that each new frame can begin in a place where the Buffer offset is 0.
switch (scb->wcb.OPCODE) {
case WS_OPCODE_TEXT:
#if (CO_TEST_MODE == 1)
co_websocket_send_echo(data, len, WS_OPCODE_TEXT);
break;
#endif
// case 0: This frame should be skip