File: remote_mh.cpp

package info (click to toggle)
concordance 1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 7,700 kB
  • sloc: cpp: 7,203; sh: 4,621; ansic: 882; python: 707; perl: 171; makefile: 132; xml: 34
file content (1017 lines) | stat: -rw-r--r-- 32,020 bytes parent folder | download | duplicates (2)
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
/*
 * vim:tw=80:ai:tabstop=4:softtabstop=4:shiftwidth=4:expandtab
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * (C) Copyright Kevin Timmerman 2007
 * (C) Copyright Phil Dibowitz 2007
 * (C) Copyright Scott Talbert 2012
 */

#include "remote.h"

#include <string.h>
#include <stdlib.h>

#include "libconcord.h"
#include "lc_internal.h"
#include "hid.h"
#include "protocol.h"
#include "remote_info.h"
#include "web.h"

/* Timeout to wait for a response, in ms. */
#define MH_TIMEOUT 5000
/*
 * This value is used in places where the timeout needs to be extended in
 * order to support the Harmony Link.  It takes a long time to respond to some
 * commands.
*/
#define LINK_TIMEOUT 20000
#define MH_MAX_PACKET_SIZE 64
/* In data mode, two bytes are used for the header. */
#define MH_MAX_DATA_SIZE 62

void debug_print_packet(uint8_t* p)
{
    debug("%02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x" \
        " %02x %02x %02x",
        p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9], p[10],
        p[11], p[12], p[13], p[14], p[15]);
}

int CRemoteMH::Reset(uint8_t kind)
{
    int err;
    uint8_t rsp[MH_MAX_PACKET_SIZE];

    /* write reset msg */
    const uint8_t msg_reset[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0xFF, 0x02, 0x01, 0x01 };
    if ((err = HID_WriteReport(msg_reset))) {
        debug("Failed to write to remote");
        return 1;
    }
    if ((err = HID_ReadReport(rsp, MH_TIMEOUT))) {
        debug("Failed to read from remote");
        return 1;
    }
    debug("msg_reset");
    debug_print_packet(rsp);

    return 0;
}

string find_value(string str, string key)
{
    string value = "";
    size_t pos = str.find(key);
    if (pos != string::npos) {
        size_t value_start = str.find(" ", pos) + 1;
        size_t value_end = str.find(0x0A, pos);
        size_t len = value_end - value_start;
        if ((value_start != string::npos) && (value_end != string::npos))
            value = str.substr(value_start, len);
    }
    return value;
}

struct mh_config_attributes {
    uint8_t type[3];
    uint8_t seed[2];
    uint8_t length[4];
    uint8_t expectedvalue[2];
};

// Parse the XML file for the checksum-related attributes that are needed to
// complete an update configuration operation.
int get_mh_config_attributes(uint8_t *xml, uint32_t xml_size,
                             mh_config_attributes *attr)
{
    int err;
    string checksum;
    uint8_t *ptr;

    err = GetTag("CHECKSUM", xml, xml_size, ptr, &checksum, true);
    if (err)
        return err;

    string type;
    err = GetAttribute("TYPE", checksum, &type);
    if (err)
        return err;
    const char *type_cstr = type.c_str();
    if (strlen(type_cstr) == 3) {
        attr->type[0] = type_cstr[0];
        attr->type[1] = type_cstr[1];
        attr->type[2] = type_cstr[2];
    }

    string seed;
    err = GetAttribute("SEED", checksum, &seed);
    if (err)
        return err;
    uint16_t seed_int = strtol(seed.c_str(), NULL, 16);
    attr->seed[0] = (seed_int & 0xFF00) >> 8;
    attr->seed[1] = (seed_int & 0x00FF);

    string length;
    err = GetAttribute("LENGTH", checksum, &length);
    if (err)
        return err;
    uint32_t length_int = strtol(length.c_str(), NULL, 16);
    attr->length[0] = (length_int & 0xFF000000) >> 24;
    attr->length[1] = (length_int & 0x00FF0000) >> 16;
    attr->length[2] = (length_int & 0x0000FF00) >> 8;
    attr->length[3] = (length_int & 0x000000FF);

    string expectedvalue;
    err = GetAttribute("EXPECTEDVALUE", checksum, &expectedvalue);
    if (err)
        return err;
    uint16_t expectedvalue_int = strtol(expectedvalue.c_str(), NULL, 16);
    attr->expectedvalue[0] = (expectedvalue_int & 0xFF00) >> 8;
    attr->expectedvalue[1] = (expectedvalue_int & 0x00FF);

    return 0;
}

// Returns the current sequence number and increments it appropriately.
uint8_t get_seq(uint8_t &seq)
{
    uint8_t tmp = seq;
    seq++;
    if (seq > 0x3F) { // seq rolls over after 0x3F
        seq = 0x00;
    }
    return tmp;
}

// Sends the reset sequence message
int reset_sequence(uint8_t seq, uint8_t param)
{
    const uint8_t msg_reset_seq[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0x07, seq, 0x01, 0x01, param };
    uint8_t rsp[MH_MAX_PACKET_SIZE];

    if (HID_WriteReport(msg_reset_seq)) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }
    if (HID_ReadReport(rsp, MH_TIMEOUT)) {
        debug("Failed to read from remote");
        return LC_ERROR_READ;
    }
    debug("msg_reset_seq");
    debug_print_packet(rsp);

    return 0;
}

int CRemoteMH::ReadFile(const char *filename, uint8_t *rd, const uint32_t rdlen,
                        uint32_t *data_read, uint8_t start_seq, lc_callback cb,
                        void *cb_arg, uint32_t cb_stage)
{
    int err = 0;
    uint32_t cb_count = 0;
    uint8_t seq = start_seq;

    if (strlen(filename) > (MH_MAX_PACKET_SIZE - 9)) {
        debug("Filename too long");
        return LC_ERROR;
    }
    uint8_t msg_idx = 0;
    uint8_t msg_read_file[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0x01, get_seq(seq), 0x02, 0x80 };
    msg_idx += 5;
    memcpy(&msg_read_file[msg_idx], filename, strlen(filename));
    msg_idx += strlen(filename);
    msg_read_file[msg_idx++] = 0x00;
    msg_read_file[msg_idx++] = 0x80;
    msg_read_file[msg_idx++] = 'R';
    msg_read_file[msg_idx++] = 0x00;

    uint8_t msg_ack[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0x04, get_seq(seq), 0x02, 0x01, 0x00, 0x01, 0x00 };
    uint8_t rsp[MH_MAX_PACKET_SIZE];

    if ((err = HID_WriteReport(msg_read_file))) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }

    if ((err = HID_ReadReport(rsp, MH_TIMEOUT))) {
        debug("Failed to read from remote");
        return LC_ERROR_READ;
    }
    debug("msg_read_file");
    debug_print_packet(rsp);

    /*
     * First parameter in the read file "ack" message is reused in subsequent
     * messages to the remote.  Save it.
     */
    const uint8_t param = rsp[5];
    msg_ack[5] = param;

    /*
     * Second parameter in the read file "ack" message is the data length.  Use
     * this to determine the number of packets we should expect.
     */
    uint32_t data_len = (rsp[7] << 24) + (rsp[8] << 16) + (rsp[9] << 8) +
        rsp[10];
    int pkts_to_read = data_len / MH_MAX_DATA_SIZE;
    if ((data_len % MH_MAX_DATA_SIZE) != 0)
        pkts_to_read++;
    pkts_to_read++; // count is always one more than the actual count
    if (pkts_to_read > 50)
        msg_ack[7] = 0x33;
    else
        msg_ack[7] = pkts_to_read;

    if ((err = HID_WriteReport(msg_ack))) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }

    if ((err = HID_ReadReport(rsp))) {
        debug("Failed to read from remote");
        return LC_ERROR_READ;
    }
    debug("msg_ack");
    debug_print_packet(rsp);

    uint8_t exp_seq = rsp[2] & 0x3F;
    int pkt_count = 0;
    *data_read = 0;
    uint8_t *rd_ptr = rd;
    while(!(err = HID_ReadReport(rsp, MH_TIMEOUT))) {
        debug_print_packet(rsp);
        get_seq(exp_seq);
        uint8_t rcv_seq = rsp[0] & 0x3F;
        if (exp_seq != rcv_seq) {
            debug("ERROR: unexpected sequence # - packet lost! %02x %02x",
                  exp_seq, rcv_seq);
            return LC_ERROR_READ;
        }
        // Ignore 1st two bits on 2nd byte for length.
        uint8_t len = rsp[1] & 0x3F;
        // Skip 1st two bytes, read up to packet length.  "len"
        // represents the payload length (not including the two size
        // bytes), so we read a full "len" bytes from 2 to len+2.
        if (rd) {
            if ((*data_read + len) > rdlen) {
                debug("ERROR: buffer length exceeded!");
                return LC_ERROR;
            }
            memcpy(rd_ptr, &rsp[2], len);
            rd_ptr += len;
        }
        *data_read += len;
        pkt_count++;
        pkts_to_read--;
        if (cb) {
            cb(cb_stage, cb_count++, *data_read, data_len,
	       LC_CB_COUNTER_TYPE_BYTES, cb_arg, NULL);
        }
        if (pkts_to_read == 1) {
            break;
        }
        if (pkt_count == 50) {
            msg_ack[2] = get_seq(seq);
            if (pkts_to_read > 50)
                msg_ack[7] = 0x33;
            else
                msg_ack[7] = pkts_to_read;
            debug_print_packet(msg_ack);
            if ((err = HID_WriteReport(msg_ack))) {
                debug("Failed to write to remote");
                return LC_ERROR_WRITE;
            }

            if ((err = HID_ReadReport(rsp))) {
                debug("Failed to read from remote");
                return LC_ERROR_READ;
            }
            exp_seq = rsp[2] & 0x3F;
            debug("ack");
            debug_print_packet(rsp);
            pkt_count = 0;
        }
    }
    debug("data_read=%d", *data_read);
    if (err)
        return err;

    if ((err = reset_sequence(get_seq(seq), param)))
        return err;

    return 0;
}

int CRemoteMH::WriteFile(const char *filename, uint8_t *wr,
                         const uint32_t wrlen)
{
    int err = 0;
    uint8_t seq = 0;
    uint8_t rsp[MH_MAX_PACKET_SIZE];

    if (strlen(filename) > (MH_MAX_PACKET_SIZE - 14)) {
        debug("Filename too long");
        return LC_ERROR;
    }

    uint8_t msg_idx = 0;
    uint8_t msg_write_file[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0x01, get_seq(seq), 0x03, 0x80 };
    msg_idx += 5;
    memcpy(&msg_write_file[msg_idx], filename, strlen(filename));
    msg_idx += strlen(filename);
    msg_write_file[msg_idx++] = 0x00;
    msg_write_file[msg_idx++] = 0x80;
    msg_write_file[msg_idx++] = 'W';
    msg_write_file[msg_idx++] = 0x00;
    msg_write_file[msg_idx++] = 0x04;
    msg_write_file[msg_idx++] = (wrlen & 0xFF000000) >> 24;
    msg_write_file[msg_idx++] = (wrlen & 0x00FF0000) >> 16;
    msg_write_file[msg_idx++] = (wrlen & 0x0000FF00) >> 8;
    msg_write_file[msg_idx++] = wrlen & 0x000000FF;

    if ((err = HID_WriteReport(msg_write_file))) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }

    if ((err = HID_ReadReport(rsp, MH_TIMEOUT))) {
        debug("Failed to read from remote");
        return LC_ERROR_READ;
    }
    debug("msg_write_file");
    debug_print_packet(rsp);

    /*
     * First parameter in the read file "ack" message is reused in subsequent
     * messages to the remote.  Save it.
     */
    const uint8_t param = rsp[5];

    uint32_t pkts_to_send = wrlen / MH_MAX_DATA_SIZE;
    if ((wrlen % MH_MAX_DATA_SIZE) != 0)
        pkts_to_send++;
    pkts_to_send++; // count is always one more than the actual count

    uint8_t msg_ack[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0x03, get_seq(seq), 0x02, 0x01, param, 0x01, 0x33 };
    if (pkts_to_send < 0x33)
        msg_ack[7] = pkts_to_send;

    if ((err = HID_WriteReport(msg_ack))) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }
    debug("msg_ack");
    /* No response expected - proceed to send data. */

    uint8_t *wr_ptr = const_cast<uint8_t*>(wr);
    uint32_t tlen = wrlen;
    uint8_t pkt_len;
    uint8_t tmp_pkt[MH_MAX_PACKET_SIZE];
    int pkt_count = 0;
    while (tlen) {
        pkt_len = MH_MAX_DATA_SIZE;
        if (tlen < pkt_len) {
            pkt_len = tlen;
            for (int i = pkt_len; i < MH_MAX_PACKET_SIZE; i++)
                tmp_pkt[i] = 0x00;
        }
        tlen -= pkt_len;

        tmp_pkt[0] = get_seq(seq);
        tmp_pkt[1] = pkt_len;
        memcpy(&tmp_pkt[2], wr_ptr, pkt_len);

        debug("DATA sending %d bytes, %d bytes left", pkt_len, tlen);

        if ((err = HID_WriteReport(tmp_pkt))) {
            return err;
        }
        wr_ptr += pkt_len;
        pkt_count++;
        pkts_to_send--;

        /* Every 50 data packets, the remote seems to send us an "ack"
           of some sort.  Read it and send a response back. */
        if (pkt_count == 50) {
            if ((err = HID_ReadReport(rsp, MH_TIMEOUT))) {
                debug("Failed to read from remote");
                return LC_ERROR_READ;
            }
            debug_print_packet(rsp);
            /* 3rd byte is the sequence number */
            msg_ack[2] = get_seq(seq);
            /* 2nd parameter is the number of packets remaining,
               plus one */
            if (pkts_to_send < 0x33)
                msg_ack[7] = pkts_to_send;
            if ((err = HID_WriteReport(msg_ack))) {
                debug("Failed to write to remote");
                return LC_ERROR_WRITE;
            }
            pkt_count = 0;
        }
    }

    /*
     * Wait for remote to send us a response.  We extend the timeout here
     * because the Harmony Link can take 7+ seconds to respond to this
     * particular message.
     */
    if ((err = HID_ReadReport(rsp, LINK_TIMEOUT))) {
        debug("Failed to read from remote");
        return LC_ERROR_READ;
    }
    debug("after writing file");
    debug_print_packet(rsp);

    if ((err = reset_sequence(get_seq(seq), param)))
        return err;

    return 0;
}

/*
 * Send the GET_VERSION command to the remote, and read the response.
 *
 * Then populate our struct with all the relevant info.
 */
int CRemoteMH::GetIdentity(TRemoteInfo &ri, THIDINFO &hid, lc_callback cb,
                           void *cb_arg, uint32_t cb_stage)
{
    int err = 0;
    uint32_t cb_count = 0;

    const uint8_t msg_one[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0x00, 0x00, 0x01, 0x01 };
    const uint8_t msg_two[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0xFF, 0x01, 0x01, 0x01, 0x66 };
    const uint8_t msg_three[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0x00, 0x02 };
    uint8_t rsp[MH_MAX_PACKET_SIZE];

    /* 
     * Send msg_one five times.  Yes, this is weird, but this is what the
     * official software does and seems to be required to establish comms.
     */
    for (int i = 0; i < 5; i++) {
        if ((err = HID_WriteReport(msg_one))) {
            debug("Failed to write to remote");
            return LC_ERROR_WRITE;
        }
    }

    if ((err = HID_WriteReport(msg_two))) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }

    if ((err = HID_ReadReport(rsp))) {
        debug("Failed to read from remote");
        return LC_ERROR_READ;
    }
    debug("msg_two");
    debug_print_packet(rsp);

    if ((err = HID_WriteReport(msg_three))) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }

    if ((err = HID_ReadReport(rsp))) {
        debug("Failed to read from remote");
        return LC_ERROR_READ;
    }
    debug("msg_three");
    debug_print_packet(rsp);

    int buflen = 1000;
    char buffer[buflen];
    uint32_t data_read;
    if ((err = ReadFile("/sys/sysinfo", (uint8_t*)buffer, buflen, &data_read,
                        0x03, NULL, NULL, 0)))
        return err;
    string identity(buffer);
    debug("%s", identity.c_str());

    ri.fw_ver_major = strtol(find_value(identity, "fw_ver").c_str(), NULL, 10);
    ri.fw_ver_minor = strtol(find_value(identity, "fw_ver").c_str()+2, NULL,
                             10);
    ri.hw_ver_major = strtol(find_value(identity, "hw_ver").c_str(), NULL, 16);
    ri.hw_ver_minor = 0;
    ri.hw_ver_micro = 0; /* usbnet remotes have a non-zero micro version */
    ri.flash_id = 0x12; // TODO: FIXME
    ri.flash_mfg = 0xFF; // TODO: FIXME
    ri.architecture = strtol(find_value(identity, "arch").c_str(), NULL, 16);
    ri.fw_type = strtol(find_value(identity, "fw_type").c_str(), NULL, 16);
    ri.skin = strtol(find_value(identity, "skin").c_str(), NULL, 16);
    ri.protocol = 9; // TODO: FIXME

    setup_ri_pointers(ri);

    string guid_str = find_value(identity, "guid");
    if (guid_str.length() >= 98) {
        uint8_t guid[48];
        char guid_char[3];
        guid_char[2] = '\0';
        char *guid_cstr = (char*)guid_str.c_str() + 2;
        for (int i = 0; i < 48; i++) {
            guid_char[0] = guid_cstr[0];
            guid_char[1] = guid_cstr[1];
            guid[i] = strtol(guid_char, NULL, 16);
            guid_cstr = guid_cstr + 2;
        }
        make_serial(guid, ri);
    }
    ri.mh_serial = find_value(identity, "serial_number");

    if (cb) {
        cb(cb_stage, cb_count++, 1, 2, LC_CB_COUNTER_TYPE_STEPS, cb_arg, NULL);
    }

    /* Arch 17 (Link/Touch) don't have the '/cfg/usercfg' so don't read it */
    if (ri.architecture != 17) {
        // Send the read config message to find the config bytes used.
        const uint8_t msg_read_config[MH_MAX_PACKET_SIZE] =
            { 0xFF, 0x01, 0x00, 0x03, 0x80, '/', 'c', 'f', 'g', '/',
              'u', 's', 'e', 'r', 'c', 'f', 'g', 0x00, 0x80, 'R', 0x00 };
        if ((err = HID_WriteReport(msg_read_config))) {
            debug("Failed to write to remote");
            return LC_ERROR_WRITE;
        }

        if ((err = HID_ReadReport(rsp))) {
            debug("Failed to read from remote");
            return LC_ERROR_READ;
        }
        debug("msg_read_config");
        debug_print_packet(rsp);

        if ((err = reset_sequence(0x01, 0x06)))
            return err;

        // In ReadFlash() we add an extra four bytes to the end of the config
        // file buffer, so we include space for those bytes here.
        ri.config_bytes_used = (rsp[7] << 24) + (rsp[8] << 16) + (rsp[9] << 8)
            + rsp[10] + 4;
        debug("ri.config_bytes_used = %d", ri.config_bytes_used);
    }
    ri.max_config_size = (ri.flash->size << 10);
    ri.valid_config = 1;

    if (cb) {
        cb(cb_stage, cb_count++, 2, 2, LC_CB_COUNTER_TYPE_STEPS, cb_arg, NULL);
    }

    return 0;
}

// Calculates the XOR checksum for a config read from the remote.
uint16_t mh_get_checksum(uint8_t* rd, const uint32_t len)
{
    // This is the "SEED" that all the configs from the website use.
    uint16_t cksum = 0x4321;
    // The part of the config that gets checksummed is consistently 6 bytes
    // less than the length of the config.  Since we are checksumming two
    // bytes at a time, we stop when i == len - 7, which is the same as
    // i + 1 == len - 6.  In the case of odd lengths, we skip the last byte.
    for (uint32_t i = 0; i < (len - 7); i += 2) {
        uint16_t j = (rd[i+1] << 8) + rd[i];
        cksum ^= j;
    }
    debug("CHECKSUM=0x%04x", cksum);
    return cksum;
}

int CRemoteMH::ReadFlash(uint32_t addr, const uint32_t len, uint8_t *rd,
                         unsigned int protocol, bool verify, lc_callback cb,
                         void *cb_arg, uint32_t cb_stage)
{
    int err = 0;
    uint32_t data_read;

    if ((err = ReadFile("/cfg/usercfg", rd, len, &data_read, 0x00, cb, cb_arg,
                        cb_stage)))
        return err;

    /*
     * When returning configs, some remotes (200) return the config + EOF bytes
     * + extra padding, while other remotes (300) return just the config (with
     * no EOF bytes or padding).  Here, to handle the latter case, we add the
     * EOF bytes to the end of the buffer.  That way, when we check the length
     * of the config in _mh_get_config_len() by searching for the first instance
     * of the EOF bytes, we will find the correct length of the config in both
     * cases.
     */
    if (rd)
        memcpy(rd + len - 4, MH_EOF_BYTES, 4);

    return 0;
}

int CRemoteMH::InvalidateFlash(lc_callback cb, void *cb_arg, uint32_t lc_stage)
{
    return LC_ERROR_UNSUPP;
}

int CRemoteMH::EraseFlash(uint32_t addr, uint32_t len, const TRemoteInfo &ri,
                          lc_callback cb, void *arg, uint32_t cb_stage)
{
    return LC_ERROR_UNSUPP;
}

int CRemoteMH::PrepFirmware(const TRemoteInfo &ri, lc_callback cb, void *cb_arg,
                            uint32_t cb_stage)
{
    return LC_ERROR_UNSUPP;
}

int CRemoteMH::FinishFirmware(const TRemoteInfo &ri, lc_callback cb, void *cb_arg,
                              uint32_t cb_stage)
{
    return LC_ERROR_UNSUPP;
}

int CRemoteMH::PrepConfig(const TRemoteInfo &ri, lc_callback cb, void *cb_arg,
                          uint32_t cb_stage)
{
    return LC_ERROR_UNSUPP;
}

int CRemoteMH::FinishConfig(const TRemoteInfo &ri, lc_callback cb, void *cb_arg,
                            uint32_t cb_stage)
{
    return LC_ERROR_UNSUPP;
}

int CRemoteMH::WriteRam(uint32_t addr, const uint32_t len, uint8_t *wr)
{
    return LC_ERROR_UNSUPP;
}

int CRemoteMH::ReadRam(uint32_t addr, const uint32_t len, uint8_t *rd)
{
    return LC_ERROR_UNSUPP;
}

int CRemoteMH::WriteFlash(uint32_t addr, const uint32_t len, const uint8_t *wr,
                          unsigned int protocol, lc_callback cb, void *arg,
                          uint32_t cb_stage)
{
    return LC_ERROR_UNSUPP;
}

int CRemoteMH::ReadMiscByte(uint8_t addr, uint32_t len, uint8_t kind,
                            uint8_t *rd)
{
    return LC_ERROR_UNSUPP;
}

int CRemoteMH::ReadMiscWord(uint16_t addr, uint32_t len, uint8_t kind,
                            uint16_t *rd)
{
    return LC_ERROR_UNSUPP;
}

int CRemoteMH::WriteMiscByte(uint8_t addr, uint32_t len,
        uint8_t kind, uint8_t *wr)
{
    return LC_ERROR_UNSUPP;
}

int CRemoteMH::WriteMiscWord(uint16_t addr, uint32_t len,
        uint8_t kind, uint16_t *wr)
{
    return LC_ERROR_UNSUPP;
}

int CRemoteMH::GetTime(const TRemoteInfo &ri, THarmonyTime &ht)
{
    return LC_ERROR_UNSUPP;
}

int CRemoteMH::SetTime(const TRemoteInfo &ri, const THarmonyTime &ht,
                       lc_callback cb, void *cb_arg, uint32_t cb_stage)
{
    /* 
     * Some MH remotes do not support SetTime() operations, but we return
     * success because some higher level operations (for example, update
     * configuration) call SetTime() and thus the whole operation would be
     * declared a failure, which we do not want.
     */
    if (ri.architecture != 17) {
        return 0;
    } else {
        /* Yes, the official sw seems to hard code the US-East TZ */
        const char *tz_str = "EST5EDT,M3.2.0,M11.1.0";
        size_t tz_str_len = strlen(tz_str);
        const uint32_t tsv_len = 16 + tz_str_len;
        uint8_t tsv[tsv_len];
        tsv[0] = ht.year >> 8;
        tsv[1] = ht.year;
        tsv[2] = ht.month;
        tsv[3] = ht.day;
        tsv[4] = ht.hour;
        tsv[5] = ht.minute;
        tsv[6] = ht.second;
        tsv[7] = ht.dow;
        for (int i = 8; i < 16; i++)
            tsv[i] = 0;
        memcpy(&tsv[16], tz_str, tz_str_len);
        return WriteFile("/sys/time", tsv, tsv_len);
    }
}

int CRemoteMH::LearnIR(uint32_t *freq, uint32_t **ir_signal,
                       uint32_t *ir_signal_length, lc_callback cb, void *cb_arg,
                       uint32_t cb_stage)
{
    int err = 0;

    const uint8_t msg_one[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0x01, 0x00, 0x02, 0x80, '/', 'i', 'r', '/', 'i', 'r',
          '_', 'c', 'a', 'p', 0x00, 0x80, 'R', 0x00 };
    uint8_t rsp[MH_MAX_PACKET_SIZE];

    uint8_t start_seq = 0x90;
    /* Arch 17 uses a different starting sequence number for IR learning */
    if (get_arch() == 17) {
        start_seq = 0x00;
    }

    if (cb) {
        cb(cb_stage, 0, 0, 1, LC_CB_COUNTER_TYPE_STEPS, cb_arg, NULL);
    }

    if ((err = HID_WriteReport(msg_one))) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }
    if ((err = HID_ReadReport(rsp))) {
        debug("Failed to read from remote");
        return LC_ERROR_READ;
    }
    debug("msg_one");
    debug_print_packet(rsp);

    /*
     * First parameter in the read file "ack" message is reused in subsequent
     * messages to the remote.  Save it.
     */
    const uint8_t param = rsp[5];
    const uint8_t msg_two[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0x04, 0x01, 0x02, 0x01, param, 0x01, 0x00 };

    if ((err = HID_WriteReport(msg_two))) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }
    if ((err = HID_ReadReport(rsp))) {
        debug("Failed to read from remote");
        return LC_ERROR_READ;
    }
    debug("msg_two");
    debug_print_packet(rsp);

    err = LearnIRInnerLoop(freq, ir_signal, ir_signal_length, start_seq);

    /* send stop message */
    const uint8_t msg_stop[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0x06, 0x02, 0x02, 0x01, param, 0x01, 0x06 };
    if (HID_WriteReport(msg_stop) != 0) {
        debug("Failed to write to remote");
        err = LC_ERROR_WRITE;
    }
    if (HID_ReadReport(rsp) != 0) {
        debug("Failed to read from remote");
        err = LC_ERROR_READ;
    }
    debug("msg_stop");
    debug_print_packet(rsp);

    if ((err = reset_sequence(0x03, param)))
        return err;

    if (cb && !err) {
        cb(cb_stage, 1, 1, 1, LC_CB_COUNTER_TYPE_STEPS, cb_arg, NULL);
    }

    return err;
}

int CRemoteMH::UpdateConfig(const uint32_t len, const uint8_t *wr,
                            lc_callback cb, void *cb_arg, uint32_t cb_stage,
                            uint32_t xml_size, uint8_t *xml)
{
    int err = 0;
    uint32_t cb_count = 0;

    const uint8_t msg_one[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0xFF, 0x00, 0x01, 0x01, 0x66 };
    const uint8_t msg_two[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0x01, 0x01, 0x03, 0x80, '/', 'c', 'f', 'g', '/',
          'u', 's', 'e', 'r', 'c', 'f', 'g', 0x00, 0x80, 'W', 0x00,
          0x04, static_cast<uint8_t>(len >> 24),
          static_cast<uint8_t>(len >> 16), static_cast<uint8_t>(len >> 8),
          static_cast<uint8_t>(len) };
    const uint8_t msg_three[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0x03, 0x03, 0x02, 0x01, 0x05, 0x01, 0x33 };
    uint8_t rsp[MH_MAX_PACKET_SIZE];

    cb(LC_CB_STAGE_INITIALIZE_UPDATE, cb_count++, 0, 3,
        LC_CB_COUNTER_TYPE_STEPS, cb_arg, NULL);

    if ((err = HID_WriteReport(msg_one))) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }
    if ((err = HID_ReadReport(rsp, MH_TIMEOUT))) {
        debug("Failed to read from remote");
        return LC_ERROR_READ;
    }
    debug("msg_one");
    debug_print_packet(rsp);

    cb(LC_CB_STAGE_INITIALIZE_UPDATE, cb_count++, 1, 3,
        LC_CB_COUNTER_TYPE_STEPS, cb_arg, NULL);

    if ((err = HID_WriteReport(msg_two))) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }
    if ((err = HID_ReadReport(rsp, MH_TIMEOUT))) {
        debug("Failed to read from remote");
        return LC_ERROR_READ;
    }
    debug("msg_two");
    debug_print_packet(rsp);

    cb(LC_CB_STAGE_INITIALIZE_UPDATE, cb_count++, 2, 3,
        LC_CB_COUNTER_TYPE_STEPS, cb_arg, NULL);

    if ((err = HID_WriteReport(msg_three))) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }
    // No response is expected to this packet.
    debug("msg_three");

    cb(LC_CB_STAGE_INITIALIZE_UPDATE, cb_count++, 3, 3,
        LC_CB_COUNTER_TYPE_STEPS, cb_arg, NULL);
    cb_count = 0;

    // Start writing data:
    // First byte is the sequence number, which starts at 0x04 and rolls
    // over to 0x00 after 0x3F.
    // Second byte is the data length, up to 0x3E (62 bytes).
    uint8_t *wr_ptr = const_cast<uint8_t*>(wr);
    uint8_t seq = 0x04;
    uint32_t tlen = len;
    uint8_t pkt_len;
    uint8_t tmp_pkt[MH_MAX_PACKET_SIZE];
    int pkt_count = 0;
    int pkts_to_send = len / MH_MAX_DATA_SIZE;
    if ((len % MH_MAX_DATA_SIZE) != 0)
        pkts_to_send++;
    pkts_to_send++; // include file completion packet, 0x7E, in count.
    uint8_t ack_rsp[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0x03, 0x00, 0x02, 0x01, 0x05, 0x01, 0x33 };
    while (tlen) {
        pkt_len = MH_MAX_DATA_SIZE;
        if (tlen < pkt_len) {
            pkt_len = tlen;
        }
        tlen -= pkt_len;

        tmp_pkt[0] = get_seq(seq);
        tmp_pkt[1] = pkt_len;
        memcpy(&tmp_pkt[2], wr_ptr, pkt_len);

        debug("DATA %d, sending %d bytes, %d bytes left", cb_count,
            pkt_len, tlen);

        if ((err = HID_WriteReport(tmp_pkt))) {
            return err;
        }
        wr_ptr += pkt_len;
        pkt_count++;
        pkts_to_send--;

        /* Every 50 data packets, the remote seems to send us an "ack"
           of some sort.  Read it and send a response back. */
        if (pkt_count == 50) {
            if ((err = HID_ReadReport(rsp, MH_TIMEOUT))) {
                debug("Failed to read from remote");
                return LC_ERROR_READ;
            }
            debug_print_packet(rsp);
            /* 3rd byte is the sequence number */
            ack_rsp[2] = get_seq(seq);
            /* 2nd parameter is the number of packets remaining, 
               plus one */
            if (pkts_to_send < 50)
                ack_rsp[7] = pkts_to_send + 1;
            if ((err = HID_WriteReport(ack_rsp))) {
                debug("Failed to write to remote");
                return LC_ERROR_WRITE;
            }
            pkt_count = 0;
        }

        if (cb) {
            cb(LC_CB_STAGE_WRITE_CONFIG, cb_count++, (int)(wr_ptr - wr), len,
               LC_CB_COUNTER_TYPE_BYTES, cb_arg, NULL);
        }
    }

    cb_count = 0;
    cb(LC_CB_STAGE_FINALIZE_UPDATE, cb_count++, 0, 4, LC_CB_COUNTER_TYPE_STEPS,
       cb_arg, NULL);

    /* write end of data stream message */
    const uint8_t end_msg[MH_MAX_PACKET_SIZE] = { 0x7E };
    if ((err = HID_WriteReport(end_msg))) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }
    if ((err = HID_ReadReport(rsp, MH_TIMEOUT))) {
        debug("Failed to read from remote");
        return LC_ERROR_WRITE;
    }
    debug("end_msg");
    debug_print_packet(rsp);

    cb(LC_CB_STAGE_FINALIZE_UPDATE, cb_count++, 1, 4, LC_CB_COUNTER_TYPE_STEPS,
       cb_arg, NULL);

    /* write finish config message */
    mh_config_attributes mca;
    if ((err = get_mh_config_attributes(xml, xml_size, &mca))) {
        debug("Failed to parse config attributes");
        return LC_ERROR;
    }
    const uint8_t finish_msg[MH_MAX_PACKET_SIZE] = {
        0xFF, 0x06, get_seq(seq), 0x07, 0x01, 0x05, 0x01, 0x01, 0x80,
        mca.type[0], mca.type[1], mca.type[2], 0x00, 0x02, mca.seed[0],
        mca.seed[1], 0x04, 0x00, 0x00, 0x00, 0x00, 0x04, mca.length[0],
        mca.length[1], mca.length[2], mca.length[3], 0x02,
        mca.expectedvalue[0], mca.expectedvalue[1] };
    if ((err = HID_WriteReport(finish_msg))) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }
    if ((err = HID_ReadReport(rsp, MH_TIMEOUT))) {
        debug("Failed to read from remote");
        return LC_ERROR_READ;
    }
    debug("finish_msg");
    debug_print_packet(rsp);

    cb(LC_CB_STAGE_FINALIZE_UPDATE, cb_count++, 2, 4,
       LC_CB_COUNTER_TYPE_STEPS, cb_arg, NULL);

    /* write msg 5 */
    const uint8_t msg_5[MH_MAX_PACKET_SIZE] =
        { 0xFF, 0x05, get_seq(seq), 0x02, 0x01, 0x05, 0x01, 0x00 };
    if ((err = HID_WriteReport(msg_5))) {
        debug("Failed to write to remote");
        return LC_ERROR_WRITE;
    }
    if ((err = HID_ReadReport(rsp, MH_TIMEOUT))) {
        debug("Failed to read from remote");
        return LC_ERROR_READ;
    }
    debug("msg_5");
    debug_print_packet(rsp);

    cb(LC_CB_STAGE_FINALIZE_UPDATE, cb_count++, 3, 4,
       LC_CB_COUNTER_TYPE_STEPS, cb_arg, NULL);

    if ((err = reset_sequence(get_seq(seq), 0x05)))
        return err;

    cb(LC_CB_STAGE_FINALIZE_UPDATE, cb_count++, 4, 4,
       LC_CB_COUNTER_TYPE_STEPS, cb_arg, NULL);

    return 0;
}