1 /* flasher for HomeMatic-devices supporting OTA updates
3 * Copyright (c) 2014-15 Michael Gernoth <michael@gernoth.net>
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to
7 * deal in the Software without restriction, including without limitation the
8 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9 * sell copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
32 #include <sys/types.h>
36 #include <libusb-1.0/libusb.h>
47 #define NORMAL_MAX_PAYLOAD 37
48 #define LOWER_MAX_PAYLOAD 17
54 uint8_t key
[16] = {0};
57 /* Maximum payloadlen supported by IO */
58 uint32_t max_payloadlen
= NORMAL_MAX_PAYLOAD
;
67 struct hmcfgusb_dev
*hmcfgusb
;
68 struct culfw_dev
*culfw
;
78 enum message_type message_type
;
85 static int parse_hmcfgusb(uint8_t *buf
, int buf_len
, void *data
)
87 struct recv_data
*rdata
= data
;
95 ((buf
[0x11] == ((hmid
>> 16) & 0xff)) &&
96 (buf
[0x12] == ((hmid
>> 8) & 0xff)) &&
97 (buf
[0x13] == (hmid
& 0xff)))) {
98 memset(rdata
->message
, 0, sizeof(rdata
->message
));
99 memcpy(rdata
->message
, buf
+ 0x0d, buf
[0x0d] + 1);
100 rdata
->message_type
= MESSAGE_TYPE_E
;
104 memset(rdata
->message
, 0, sizeof(rdata
->message
));
105 memcpy(rdata
->message
, buf
+ 0x0e, buf
[0x0e] + 1);
106 rdata
->status
= (buf
[5] << 8) | buf
[6];
107 rdata
->message_type
= MESSAGE_TYPE_R
;
110 rdata
->speed
= buf
[1];
113 rdata
->version
= (buf
[11] << 8) | buf
[12];
114 rdata
->credits
= buf
[36];
115 my_hmid
= (buf
[0x1b] << 16) | (buf
[0x1c] << 8) | buf
[0x1d];
127 static int parse_culfw(uint8_t *buf
, int buf_len
, void *data
)
129 struct recv_data
*rdata
= data
;
132 memset(rdata
, 0, sizeof(struct recv_data
));
142 while(validate_nibble(buf
[(pos
* 2) + 1]) &&
143 validate_nibble(buf
[(pos
* 2) + 2]) &&
144 (pos
+ 1 < buf_len
)) {
145 rdata
->message
[pos
] = ascii_to_nibble(buf
[(pos
* 2) + 1]) << 4;
146 rdata
->message
[pos
] |= ascii_to_nibble(buf
[(pos
* 2) + 2]);
150 if (hmid
&& (SRC(rdata
->message
) != hmid
))
153 rdata
->message_type
= MESSAGE_TYPE_E
;
161 s
= ((char*)buf
) + 2;
164 fprintf(stderr
, "Unknown response from CUL: %s", buf
);
169 rdata
->version
= v
<< 8;
174 fprintf(stderr
, "Unknown response from CUL: %s", buf
);
184 if (!strncmp((char*)buf
, "ERR:CCA", 7)) {
185 fprintf(stderr
, "CCA didn't complete, too much traffic\n");
190 fprintf(stderr
, "Unknown response from CUL: %s", buf
);
198 int send_hm_message(struct ota_dev
*dev
, struct recv_data
*rdata
, uint8_t *msg
)
200 static uint32_t id
= 1;
206 case DEVICE_TYPE_HMCFGUSB
:
207 if (gettimeofday(&tv
, NULL
) == -1) {
208 perror("gettimeofay");
212 memset(out
, 0, sizeof(out
));
215 out
[1] = (id
>> 24) & 0xff;
216 out
[2] = (id
>> 16) & 0xff;
217 out
[3] = (id
>> 8) & 0xff;
220 out
[11] = (tv
.tv_usec
>> 24) & 0xff;
221 out
[12] = (tv
.tv_usec
>> 16) & 0xff;
222 out
[13] = (tv
.tv_usec
>> 8) & 0xff;
223 out
[14] = tv
.tv_usec
& 0xff;
225 memcpy(&out
[0x0f], msg
, msg
[0] + 1);
227 memset(rdata
, 0, sizeof(struct recv_data
));
228 hmcfgusb_send(dev
->hmcfgusb
, out
, sizeof(out
), 1);
231 if (rdata
->message_type
== MESSAGE_TYPE_R
) {
232 if (((rdata
->status
& 0xdf) == 0x01) ||
233 ((rdata
->status
& 0xdf) == 0x02)) {
236 if ((rdata
->status
& 0xff00) == 0x0400) {
237 fprintf(stderr
, "\nOut of credits!\n");
238 } else if ((rdata
->status
& 0xff) == 0x08) {
239 fprintf(stderr
, "\nMissing ACK!\n");
240 } else if ((rdata
->status
& 0xff) == 0x30) {
241 fprintf(stderr
, "\nUnknown AES-key requested!\n");
243 fprintf(stderr
, "\nInvalid status: %04x\n", rdata
->status
);
249 pfd
= hmcfgusb_poll(dev
->hmcfgusb
, 1000);
250 if ((pfd
< 0) && errno
) {
251 if (errno
!= ETIMEDOUT
) {
252 perror("\n\nhmcfgusb_poll");
258 case DEVICE_TYPE_CULFW
:
263 memset(buf
, 0, sizeof(buf
));
266 for (i
= 0; i
< msg
[0] + 1; i
++) {
267 buf
[2 + (i
* 2)] = nibble_to_ascii((msg
[i
] >> 4) & 0xf);
268 buf
[2 + (i
* 2) + 1] = nibble_to_ascii(msg
[i
] & 0xf);
270 buf
[2 + (i
* 2) ] = '\r';
271 buf
[2 + (i
* 2) + 1] = '\n';
273 memset(rdata
, 0, sizeof(struct recv_data
));
274 if (culfw_send(dev
->culfw
, buf
, 2 + (i
* 2) + 1) == 0) {
275 fprintf(stderr
, "culfw_send failed!\n");
279 if (msg
[CTL
] & 0x20) {
284 pfd
= culfw_poll(dev
->culfw
, 200);
285 if ((pfd
< 0) && errno
) {
286 if (errno
!= ETIMEDOUT
) {
287 perror("\n\nculfw_poll");
291 if (rdata
->message_type
== MESSAGE_TYPE_E
) {
292 if (rdata
->message
[TYPE
] == 0x02) {
293 if (rdata
->message
[PAYLOAD
] == 0x04) {
295 uint8_t challenge
[6];
299 req_kNo
= rdata
->message
[rdata
->message
[LEN
]] / 2;
300 memcpy(challenge
, &(rdata
->message
[PAYLOAD
+1]), 6);
302 if (req_kNo
!= kNo
) {
303 fprintf(stderr
, "AES request for unknown key %d!\n", req_kNo
);
305 resp
= hm_sign(key
, challenge
, msg
, NULL
, respbuf
);
309 memset(rbuf
, 0, sizeof(rbuf
));
310 rbuf
[MSGID
] = rdata
->message
[MSGID
];
311 rbuf
[CTL
] = rdata
->message
[CTL
];
313 SET_SRC(rbuf
, DST(rdata
->message
));
314 SET_DST(rbuf
, SRC(rdata
->message
));
315 memcpy(&(rbuf
[PAYLOAD
]), resp
, 16);
316 SET_LEN_FROM_PAYLOADLEN(rbuf
, 16);
318 return send_hm_message(dev
, rdata
, rbuf
);
321 } else if (rdata
->message
[PAYLOAD
] >= 0x80 && rdata
->message
[PAYLOAD
] <= 0x8f) {
322 fprintf(stderr
, "NACK\n");
323 } else { /* ACK or ACKinfo */
327 fprintf(stderr
, "Unexpected message received: ");
328 for (i
= 0; i
< rdata
->message
[LEN
]; i
++) {
329 fprintf(stderr
, "%02x", rdata
->message
[i
+1]);
331 fprintf(stderr
, "\n");
337 fprintf(stderr
, "\nMissing ACK!\n");
349 static int switch_speed(struct ota_dev
*dev
, struct recv_data
*rdata
, uint8_t speed
)
354 printf("Entering %uk-mode\n", speed
);
357 case DEVICE_TYPE_HMCFGUSB
:
358 memset(out
, 0, sizeof(out
));
362 hmcfgusb_send(dev
->hmcfgusb
, out
, sizeof(out
), 1);
366 pfd
= hmcfgusb_poll(dev
->hmcfgusb
, 1000);
367 if ((pfd
< 0) && errno
) {
368 if (errno
!= ETIMEDOUT
) {
369 perror("\n\nhmcfgusb_poll");
373 if (rdata
->speed
== speed
)
377 case DEVICE_TYPE_CULFW
:
379 return culfw_send(dev
->culfw
, "AR\r\n", 4);
381 return culfw_send(dev
->culfw
, "Ar\r\n", 4);
389 void flash_ota_syntax(char *prog
)
391 fprintf(stderr
, "Syntax: %s parameters options\n\n", prog
);
392 fprintf(stderr
, "Mandatory parameters:\n");
393 fprintf(stderr
, "\t-f firmware.eq3\tfirmware file to flash\n");
394 fprintf(stderr
, "\t-s SERIAL\tserial of device to flash (optional when using -D)\n");
395 fprintf(stderr
, "\nOptional parameters:\n");
396 fprintf(stderr
, "\t-c device\tenable CUL-mode with CUL at path \"device\"\n");
397 fprintf(stderr
, "\t-b bps\t\tuse CUL with speed \"bps\" (default: %u)\n", DEFAULT_CUL_BPS
);
398 fprintf(stderr
, "\t-l\t\tlower payloadlen (required for devices with little RAM, e.g. CUL v2 and CUL v4)\n");
399 fprintf(stderr
, "\t-h\t\tthis help\n");
400 fprintf(stderr
, "\nOptional parameters for automatically sending device to bootloader\n");
401 fprintf(stderr
, "\t-C\t\tHMID of central (3 hex-bytes, no prefix, e.g. ABCDEF)\n");
402 fprintf(stderr
, "\t-D\t\tHMID of device (3 hex-bytes, no prefix, e.g. 123456)\n");
403 fprintf(stderr
, "\t-K\t\tKNO:KEY AES key-number and key (hex) separated by colon (Fhem hmKey attribute)\n");
406 int main(int argc
, char **argv
)
408 const char twiddlie
[] = { '-', '\\', '|', '/' };
409 const uint8_t cc1101_regs
[] = { 0x10, 0x5B, 0x11, 0xF8, 0x15, 0x47 };
410 char *fw_file
= NULL
;
412 char *culfw_dev
= NULL
;
414 unsigned int bps
= DEFAULT_CUL_BPS
;
416 struct recv_data rdata
;
431 printf("HomeMatic OTA flasher version " VERSION
"\n\n");
433 while((opt
= getopt(argc
, argv
, "b:c:f:hls:C:D:K:")) != -1) {
445 printf("Reducing payload-len from %d to %d\n", max_payloadlen
, LOWER_MAX_PAYLOAD
);
446 max_payloadlen
= LOWER_MAX_PAYLOAD
;
452 my_hmid
= strtoul(optarg
, &endptr
, 16);
453 if (*endptr
!= '\0') {
454 fprintf(stderr
, "Invalid central HMID!\n\n");
455 flash_ota_syntax(argv
[0]);
460 hmid
= strtoul(optarg
, &endptr
, 16);
461 if (*endptr
!= '\0') {
462 fprintf(stderr
, "Invalid device HMID!\n\n");
463 flash_ota_syntax(argv
[0]);
468 kNo
= strtoul(optarg
, &endptr
, 10);
469 if (*endptr
!= ':') {
470 fprintf(stderr
, "Invalid key number!\n\n");
471 flash_ota_syntax(argv
[0]);
475 for (cnt
= 0; cnt
< 16; cnt
++) {
476 if (*endptr
== '\0' || *(endptr
+1) == '\0' ||
477 !validate_nibble(*endptr
) ||
478 !validate_nibble(*(endptr
+1))) {
479 fprintf(stderr
, "Invalid key!\n\n");
480 flash_ota_syntax(argv
[0]);
483 key
[cnt
] = ascii_to_nibble(*endptr
) << 4 | ascii_to_nibble(*(endptr
+1));
491 flash_ota_syntax(argv
[0]);
498 if (!fw_file
|| (!serial
&& !hmid
)) {
499 flash_ota_syntax(argv
[0]);
503 fw
= firmware_read_firmware(fw_file
, debug
);
507 memset(&rdata
, 0, sizeof(rdata
));
508 memset(&dev
, 0, sizeof(struct ota_dev
));
511 printf("Opening culfw-device at path %s with speed %u\n", culfw_dev
, bps
);
512 dev
.culfw
= culfw_init(culfw_dev
, bps
, parse_culfw
, &rdata
);
514 fprintf(stderr
, "Can't initialize CUL at %s with rate %u\n", culfw_dev
, bps
);
517 dev
.type
= DEVICE_TYPE_CULFW
;
519 printf("Requesting firmware version\n");
520 culfw_send(dev
.culfw
, "\r\n", 2);
521 culfw_flush(dev
.culfw
);
524 culfw_send(dev
.culfw
, "V\r\n", 3);
527 pfd
= culfw_poll(dev
.culfw
, 1000);
528 if ((pfd
< 0) && errno
) {
529 if (errno
!= ETIMEDOUT
) {
530 perror("\n\nhmcfgusb_poll");
538 printf("culfw-device firmware version: %u.%02u\n",
539 (rdata
.version
>> 8) & 0xff,
540 rdata
.version
& 0xff);
542 if (rdata
.version
< 0x013a) {
543 fprintf(stderr
, "\nThis version does _not_ support firmware upgrade mode, you need at least 1.58!\n");
547 uint32_t new_hmid
= my_hmid
;
549 hmcfgusb_set_debug(debug
);
551 dev
.hmcfgusb
= hmcfgusb_init(parse_hmcfgusb
, &rdata
);
553 fprintf(stderr
, "Can't initialize HM-CFG-USB\n");
556 dev
.type
= DEVICE_TYPE_HMCFGUSB
;
558 memset(out
, 0, sizeof(out
));
560 hmcfgusb_send(dev
.hmcfgusb
, out
, sizeof(out
), 1);
564 pfd
= hmcfgusb_poll(dev
.hmcfgusb
, 1000);
565 if ((pfd
< 0) && errno
) {
566 if (errno
!= ETIMEDOUT
) {
567 perror("\n\nhmcfgusb_poll");
575 if (rdata
.version
< 0x3c7) {
576 fprintf(stderr
, "HM-CFG-USB firmware too low: %u < 967\n", rdata
.version
);
580 printf("HM-CFG-USB firmware version: %u, used credits: %u%%\n", rdata
.version
, rdata
.credits
);
582 if (rdata
.credits
>= 40) {
583 printf("\nRebooting HM-CFG-USB to avoid running out of credits\n\n");
585 if (!dev
.hmcfgusb
->bootloader
) {
586 printf("HM-CFG-USB not in bootloader mode, entering bootloader.\n");
587 printf("Waiting for device to reappear...\n");
591 if (!dev
.hmcfgusb
->bootloader
)
592 hmcfgusb_enter_bootloader(dev
.hmcfgusb
);
593 hmcfgusb_close(dev
.hmcfgusb
);
596 } while (((dev
.hmcfgusb
= hmcfgusb_init(parse_hmcfgusb
, &rdata
)) == NULL
) || (!dev
.hmcfgusb
->bootloader
));
599 if (dev
.hmcfgusb
->bootloader
) {
600 printf("HM-CFG-USB in bootloader mode, rebooting\n");
604 if (dev
.hmcfgusb
->bootloader
)
605 hmcfgusb_leave_bootloader(dev
.hmcfgusb
);
606 hmcfgusb_close(dev
.hmcfgusb
);
609 } while (((dev
.hmcfgusb
= hmcfgusb_init(parse_hmcfgusb
, &rdata
)) == NULL
) || (dev
.hmcfgusb
->bootloader
));
613 printf("\n\nHM-CFG-USB opened\n\n");
615 if (new_hmid
&& (my_hmid
!= new_hmid
)) {
616 printf("Changing hmid from %06x to %06x\n", my_hmid
, new_hmid
);
618 memset(out
, 0, sizeof(out
));
620 out
[1] = (new_hmid
>> 16) & 0xff;
621 out
[2] = (new_hmid
>> 8) & 0xff;
622 out
[3] = new_hmid
& 0xff;
624 hmcfgusb_send(dev
.hmcfgusb
, out
, sizeof(out
), 1);
630 printf("Setting AES-key\n");
632 memset(out
, 0, sizeof(out
));
636 out
[3] = sizeof(key
);
637 memcpy(&(out
[4]), key
, sizeof(key
));
638 hmcfgusb_send(dev
.hmcfgusb
, out
, sizeof(out
), 1);
640 memset(out
, 0, sizeof(out
));
645 hmcfgusb_send(dev
.hmcfgusb
, out
, sizeof(out
), 1);
647 memset(out
, 0, sizeof(out
));
652 hmcfgusb_send(dev
.hmcfgusb
, out
, sizeof(out
), 1);
656 if (!switch_speed(&dev
, &rdata
, 10)) {
657 fprintf(stderr
, "Can't switch speed!\n");
661 if (hmid
&& my_hmid
) {
662 printf("Sending device with hmid %06x to bootloader\n", hmid
);
665 SET_SRC(out
, my_hmid
);
668 SET_LEN_FROM_PAYLOADLEN(out
, 1);
672 out
[MSGID
] = msgid
++;
673 if (send_hm_message(&dev
, &rdata
, out
)) {
678 printf("Failed to send device to bootloader, please enter bootloader manually.\n");
683 printf("Waiting for device with serial %s\n", serial
);
685 printf("Waiting for device with HMID %06x\n", hmid
);
691 case DEVICE_TYPE_CULFW
:
692 pfd
= culfw_poll(dev
.culfw
, 1000);
694 case DEVICE_TYPE_HMCFGUSB
:
696 pfd
= hmcfgusb_poll(dev
.hmcfgusb
, 1000);
700 if ((pfd
< 0) && errno
) {
701 if (errno
!= ETIMEDOUT
) {
707 if ((rdata
.message
[LEN
] == 0x14) && /* Length */
708 (rdata
.message
[MSGID
] == 0x00) && /* Message ID */
709 (rdata
.message
[CTL
] == 0x00) && /* Control Byte */
710 (rdata
.message
[TYPE
] == 0x10) && /* Messagte type: Information */
711 (DST(rdata
.message
) == 0x000000) && /* Broadcast */
712 (rdata
.message
[PAYLOAD
] == 0x00)) { /* FUP? */
713 if (serial
&& !strncmp((char*)&(rdata
.message
[0x0b]), serial
, 10)) {
714 hmid
= SRC(rdata
.message
);
716 } else if (!serial
&& SRC(rdata
.message
) == hmid
) {
717 serial
= (char*)&(rdata
.message
[0x0b]);
723 printf("Device with serial %s (HMID: %06x) entered firmware-update-mode\n", serial
, hmid
);
725 if (dev
.type
== DEVICE_TYPE_HMCFGUSB
) {
726 printf("Adding HMID\n");
728 memset(out
, 0, sizeof(out
));
730 out
[1] = (hmid
>> 16) & 0xff;
731 out
[2] = (hmid
>> 8) & 0xff;
732 out
[3] = hmid
& 0xff;
734 hmcfgusb_send(dev
.hmcfgusb
, out
, sizeof(out
), 1);
739 printf("Initiating remote switch to 100k\n");
741 memset(out
, 0, sizeof(out
));
743 out
[MSGID
] = msgid
++;
746 SET_SRC(out
, my_hmid
);
749 memcpy(&out
[PAYLOAD
], cc1101_regs
, sizeof(cc1101_regs
));
750 SET_LEN_FROM_PAYLOADLEN(out
, sizeof(cc1101_regs
));
752 if (!send_hm_message(&dev
, &rdata
, out
)) {
756 if (!switch_speed(&dev
, &rdata
, 100)) {
757 fprintf(stderr
, "Can't switch speed!\n");
761 printf("Has the device switched?\n");
763 memset(out
, 0, sizeof(out
));
765 out
[MSGID
] = msgid
++;
768 SET_SRC(out
, my_hmid
);
771 memcpy(&out
[PAYLOAD
], cc1101_regs
, sizeof(cc1101_regs
));
772 SET_LEN_FROM_PAYLOADLEN(out
, sizeof(cc1101_regs
));
776 if (send_hm_message(&dev
, &rdata
, out
)) {
777 /* A0A02000221B9AD00000000 */
786 if (!switch_speed(&dev
, &rdata
, 10)) {
787 fprintf(stderr
, "Can't switch speed!\n");
791 } while ((!switched
) && (switchcnt
--));
794 fprintf(stderr
, "Too many errors, giving up!\n");
800 printf("Flashing %d blocks", fw
->fw_blocks
);
804 printf(": %04u/%04u %c", 0, fw
->fw_blocks
, twiddlie
[0]);
808 for (block
= 0; block
< fw
->fw_blocks
; block
++) {
811 len
= fw
->fw
[block
][2] << 8;
812 len
|= fw
->fw
[block
][3];
814 pos
= &(fw
->fw
[block
][2]);
816 len
+= 2; /* length */
819 hexdump(pos
, len
, "F> ");
824 int payloadlen
= max_payloadlen
- 2;
828 payloadlen
= max_payloadlen
;
832 if ((len
- (pos
- &(fw
->fw
[block
][2]))) < payloadlen
)
833 payloadlen
= (len
- (pos
- &(fw
->fw
[block
][2])));
835 if (((pos
+ payloadlen
) - &(fw
->fw
[block
][2])) == len
)
838 memset(&rdata
, 0, sizeof(rdata
));
840 memset(out
, 0, sizeof(out
));
846 SET_SRC(out
, my_hmid
);
849 memcpy(&out
[PAYLOAD
], pos
, payloadlen
);
850 SET_LEN_FROM_PAYLOADLEN(out
, payloadlen
);
852 if (send_hm_message(&dev
, &rdata
, out
)) {
855 pos
= &(fw
->fw
[block
][2]);
857 if (cnt
== MAX_RETRIES
) {
858 fprintf(stderr
, "\nToo many errors, giving up!\n");
861 printf("Flashing %d blocks: %04u/%04u %c", fw
->fw_blocks
, block
+ 1, fw
->fw_blocks
, twiddlie
[msgnum
% sizeof(twiddlie
)]);
868 printf("\b\b\b\b\b\b\b\b\b\b\b%04u/%04u %c",
869 block
+ 1, fw
->fw_blocks
, twiddlie
[msgnum
% sizeof(twiddlie
)]);
872 } while((pos
- &(fw
->fw
[block
][2])) < len
);
880 if (!switch_speed(&dev
, &rdata
, 10)) {
881 fprintf(stderr
, "Can't switch speed!\n");
885 printf("Waiting for device to reboot\n");
891 case DEVICE_TYPE_CULFW
:
892 pfd
= culfw_poll(dev
.culfw
, 1000);
894 case DEVICE_TYPE_HMCFGUSB
:
896 pfd
= hmcfgusb_poll(dev
.hmcfgusb
, 1000);
899 if ((pfd
< 0) && errno
) {
900 if (errno
!= ETIMEDOUT
) {
905 if (rdata
.message_type
== MESSAGE_TYPE_E
) {
910 if (rdata
.message_type
== MESSAGE_TYPE_E
) {
911 printf("Device rebooted\n");
915 case DEVICE_TYPE_HMCFGUSB
:
916 hmcfgusb_close(dev
.hmcfgusb
);
919 case DEVICE_TYPE_CULFW
:
920 culfw_close(dev
.culfw
);