1 /* flasher for HomeMatic-devices supporting OTA updates
3 * Copyright (c) 2014 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
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
);
183 fprintf(stderr
, "Unknown response from CUL: %s", buf
);
191 int send_hm_message(struct ota_dev
*dev
, struct recv_data
*rdata
, uint8_t *msg
)
193 static uint32_t id
= 1;
199 case DEVICE_TYPE_HMCFGUSB
:
200 if (gettimeofday(&tv
, NULL
) == -1) {
201 perror("gettimeofay");
205 memset(out
, 0, sizeof(out
));
208 out
[1] = (id
>> 24) & 0xff;
209 out
[2] = (id
>> 16) & 0xff;
210 out
[3] = (id
>> 8) & 0xff;
213 out
[11] = (tv
.tv_usec
>> 24) & 0xff;
214 out
[12] = (tv
.tv_usec
>> 16) & 0xff;
215 out
[13] = (tv
.tv_usec
>> 8) & 0xff;
216 out
[14] = tv
.tv_usec
& 0xff;
218 memcpy(&out
[0x0f], msg
, msg
[0] + 1);
220 memset(rdata
, 0, sizeof(struct recv_data
));
221 hmcfgusb_send(dev
->hmcfgusb
, out
, sizeof(out
), 1);
224 if (rdata
->message_type
== MESSAGE_TYPE_R
) {
225 if (((rdata
->status
& 0xdf) == 0x01) ||
226 ((rdata
->status
& 0xdf) == 0x02)) {
229 if ((rdata
->status
& 0xff00) == 0x0400) {
230 fprintf(stderr
, "\nOut of credits!\n");
231 } else if ((rdata
->status
& 0xff) == 0x08) {
232 fprintf(stderr
, "\nMissing ACK!\n");
233 } else if ((rdata
->status
& 0xff) == 0x30) {
234 fprintf(stderr
, "\nUnknown AES-key requested!\n");
236 fprintf(stderr
, "\nInvalid status: %04x\n", rdata
->status
);
242 pfd
= hmcfgusb_poll(dev
->hmcfgusb
, 1000);
243 if ((pfd
< 0) && errno
) {
244 if (errno
!= ETIMEDOUT
) {
245 perror("\n\nhmcfgusb_poll");
251 case DEVICE_TYPE_CULFW
:
256 memset(buf
, 0, sizeof(buf
));
259 for (i
= 0; i
< msg
[0] + 1; i
++) {
260 buf
[2 + (i
* 2)] = nibble_to_ascii((msg
[i
] >> 4) & 0xf);
261 buf
[2 + (i
* 2) + 1] = nibble_to_ascii(msg
[i
] & 0xf);
263 buf
[2 + (i
* 2) ] = '\r';
264 buf
[2 + (i
* 2) + 1] = '\n';
266 memset(rdata
, 0, sizeof(struct recv_data
));
267 if (culfw_send(dev
->culfw
, buf
, 2 + (i
* 2) + 1) == 0) {
268 fprintf(stderr
, "culfw_send failed!\n");
272 if (msg
[CTL
] & 0x20) {
277 pfd
= culfw_poll(dev
->culfw
, 200);
278 if ((pfd
< 0) && errno
) {
279 if (errno
!= ETIMEDOUT
) {
280 perror("\n\nculfw_poll");
284 if (rdata
->message_type
== MESSAGE_TYPE_E
) {
285 if (rdata
->message
[TYPE
] == 0x02) {
286 if (rdata
->message
[PAYLOAD
] == 0x04) {
287 printf("AES request received but not implemented for culfw!\n");
288 } else if (rdata
->message
[PAYLOAD
] >= 0x80 && rdata
->message
[PAYLOAD
] <= 0x8f) {
290 } else { /* ACK or ACKinfo */
294 printf("Unexpected message received: ");
295 for (i
= 0; i
< rdata
->message
[LEN
]; i
++) {
296 printf("%02x", rdata
->message
[i
+1]);
304 fprintf(stderr
, "\nMissing ACK!\n");
316 static int switch_speed(struct ota_dev
*dev
, struct recv_data
*rdata
, uint8_t speed
)
321 printf("Entering %uk-mode\n", speed
);
324 case DEVICE_TYPE_HMCFGUSB
:
325 memset(out
, 0, sizeof(out
));
329 hmcfgusb_send(dev
->hmcfgusb
, out
, sizeof(out
), 1);
333 pfd
= hmcfgusb_poll(dev
->hmcfgusb
, 1000);
334 if ((pfd
< 0) && errno
) {
335 if (errno
!= ETIMEDOUT
) {
336 perror("\n\nhmcfgusb_poll");
340 if (rdata
->speed
== speed
)
344 case DEVICE_TYPE_CULFW
:
346 return culfw_send(dev
->culfw
, "AR\r\n", 4);
348 return culfw_send(dev
->culfw
, "Ar\r\n", 4);
356 void flash_ota_syntax(char *prog
)
358 fprintf(stderr
, "Syntax: %s parameters options\n\n", prog
);
359 fprintf(stderr
, "Mandatory parameters:\n");
360 fprintf(stderr
, "\t-f firmware.eq3\tfirmware file to flash\n");
361 fprintf(stderr
, "\t-s SERIAL\tserial of device to flash (optional when using -D)\n");
362 fprintf(stderr
, "\nOptional parameters:\n");
363 fprintf(stderr
, "\t-c device\tenable CUL-mode with CUL at path \"device\"\n");
364 fprintf(stderr
, "\t-b bps\t\tuse CUL with speed \"bps\" (default: %u)\n", DEFAULT_CUL_BPS
);
365 fprintf(stderr
, "\t-l\t\tlower payloadlen (required for devices with little RAM, e.g. CUL v2 and CUL v4)\n");
366 fprintf(stderr
, "\t-h\t\tthis help\n");
367 fprintf(stderr
, "\nOptional parameters for automatically sending device to bootloader\n");
368 fprintf(stderr
, "\t-C\t\tHMID of central (3 hex-bytes, no prefix, e.g. ABCDEF)\n");
369 fprintf(stderr
, "\t-D\t\tHMID of device (3 hex-bytes, no prefix, e.g. 123456)\n");
370 fprintf(stderr
, "\t-K\t\tKNO:KEY AES key-number and key (hex) separated by colon (Fhem hmKey attribute)\n");
371 fprintf(stderr
, "\t\t\tAES is currently not supported when using a culfw-device!\n");
374 int main(int argc
, char **argv
)
376 const char twiddlie
[] = { '-', '\\', '|', '/' };
377 const uint8_t cc1101_regs
[] = { 0x10, 0x5B, 0x11, 0xF8, 0x15, 0x47 };
378 char *fw_file
= NULL
;
380 char *culfw_dev
= NULL
;
382 unsigned int bps
= DEFAULT_CUL_BPS
;
384 struct recv_data rdata
;
399 printf("HomeMatic OTA flasher version " VERSION
"\n\n");
401 while((opt
= getopt(argc
, argv
, "b:c:f:hls:C:D:K:")) != -1) {
413 printf("Reducing payload-len from %d to %d\n", max_payloadlen
, LOWER_MAX_PAYLOAD
);
414 max_payloadlen
= LOWER_MAX_PAYLOAD
;
420 my_hmid
= strtoul(optarg
, &endptr
, 16);
421 if (*endptr
!= '\0') {
422 fprintf(stderr
, "Invalid central HMID!\n\n");
423 flash_ota_syntax(argv
[0]);
428 hmid
= strtoul(optarg
, &endptr
, 16);
429 if (*endptr
!= '\0') {
430 fprintf(stderr
, "Invalid device HMID!\n\n");
431 flash_ota_syntax(argv
[0]);
436 kNo
= strtoul(optarg
, &endptr
, 10);
437 if (*endptr
!= ':') {
438 fprintf(stderr
, "Invalid key number!\n\n");
439 flash_ota_syntax(argv
[0]);
443 for (cnt
= 0; cnt
< 16; cnt
++) {
444 if (*endptr
== '\0' || *(endptr
+1) == '\0' ||
445 !validate_nibble(*endptr
) ||
446 !validate_nibble(*(endptr
+1))) {
447 fprintf(stderr
, "Invalid key!\n\n");
448 flash_ota_syntax(argv
[0]);
451 key
[cnt
] = ascii_to_nibble(*endptr
) << 4 | ascii_to_nibble(*(endptr
+1));
459 flash_ota_syntax(argv
[0]);
466 if (!fw_file
|| (!serial
&& !hmid
)) {
467 flash_ota_syntax(argv
[0]);
471 fw
= firmware_read_firmware(fw_file
, debug
);
475 memset(&rdata
, 0, sizeof(rdata
));
476 memset(&dev
, 0, sizeof(struct ota_dev
));
480 fprintf(stderr
, "\nAES currently not supported with culfw-device!\n");
481 flash_ota_syntax(argv
[0]);
485 printf("Opening culfw-device at path %s with speed %u\n", culfw_dev
, bps
);
486 dev
.culfw
= culfw_init(culfw_dev
, bps
, parse_culfw
, &rdata
);
488 fprintf(stderr
, "Can't initialize CUL at %s with rate %u\n", culfw_dev
, bps
);
491 dev
.type
= DEVICE_TYPE_CULFW
;
493 printf("Requesting firmware version\n");
494 culfw_send(dev
.culfw
, "\r\n", 2);
495 culfw_flush(dev
.culfw
);
498 culfw_send(dev
.culfw
, "V\r\n", 3);
501 pfd
= culfw_poll(dev
.culfw
, 1000);
502 if ((pfd
< 0) && errno
) {
503 if (errno
!= ETIMEDOUT
) {
504 perror("\n\nhmcfgusb_poll");
512 printf("culfw-device firmware version: %u.%02u\n",
513 (rdata
.version
>> 8) & 0xff,
514 rdata
.version
& 0xff);
516 if (rdata
.version
< 0x013a) {
517 fprintf(stderr
, "\nThis version does _not_ support firmware upgrade mode, you need at least 1.58!\n");
521 uint32_t new_hmid
= my_hmid
;
523 hmcfgusb_set_debug(debug
);
525 dev
.hmcfgusb
= hmcfgusb_init(parse_hmcfgusb
, &rdata
);
527 fprintf(stderr
, "Can't initialize HM-CFG-USB\n");
530 dev
.type
= DEVICE_TYPE_HMCFGUSB
;
532 memset(out
, 0, sizeof(out
));
534 hmcfgusb_send(dev
.hmcfgusb
, out
, sizeof(out
), 1);
538 pfd
= hmcfgusb_poll(dev
.hmcfgusb
, 1000);
539 if ((pfd
< 0) && errno
) {
540 if (errno
!= ETIMEDOUT
) {
541 perror("\n\nhmcfgusb_poll");
549 if (rdata
.version
< 0x3c7) {
550 fprintf(stderr
, "HM-CFG-USB firmware too low: %u < 967\n", rdata
.version
);
554 printf("HM-CFG-USB firmware version: %u, used credits: %u%%\n", rdata
.version
, rdata
.credits
);
556 if (rdata
.credits
>= 40) {
557 printf("\nRebooting HM-CFG-USB to avoid running out of credits\n\n");
559 if (!dev
.hmcfgusb
->bootloader
) {
560 printf("HM-CFG-USB not in bootloader mode, entering bootloader.\n");
561 printf("Waiting for device to reappear...\n");
565 if (!dev
.hmcfgusb
->bootloader
)
566 hmcfgusb_enter_bootloader(dev
.hmcfgusb
);
567 hmcfgusb_close(dev
.hmcfgusb
);
570 } while (((dev
.hmcfgusb
= hmcfgusb_init(parse_hmcfgusb
, &rdata
)) == NULL
) || (!dev
.hmcfgusb
->bootloader
));
573 if (dev
.hmcfgusb
->bootloader
) {
574 printf("HM-CFG-USB in bootloader mode, rebooting\n");
578 if (dev
.hmcfgusb
->bootloader
)
579 hmcfgusb_leave_bootloader(dev
.hmcfgusb
);
580 hmcfgusb_close(dev
.hmcfgusb
);
583 } while (((dev
.hmcfgusb
= hmcfgusb_init(parse_hmcfgusb
, &rdata
)) == NULL
) || (dev
.hmcfgusb
->bootloader
));
587 printf("\n\nHM-CFG-USB opened\n\n");
589 if (new_hmid
&& (my_hmid
!= new_hmid
)) {
590 printf("Changing hmid from %06x to %06x\n", my_hmid
, new_hmid
);
592 memset(out
, 0, sizeof(out
));
594 out
[1] = (new_hmid
>> 16) & 0xff;
595 out
[2] = (new_hmid
>> 8) & 0xff;
596 out
[3] = new_hmid
& 0xff;
598 hmcfgusb_send(dev
.hmcfgusb
, out
, sizeof(out
), 1);
604 printf("Setting AES-key\n");
606 memset(out
, 0, sizeof(out
));
610 out
[3] = sizeof(key
);
611 memcpy(&(out
[4]), key
, sizeof(key
));
612 hmcfgusb_send(dev
.hmcfgusb
, out
, sizeof(out
), 1);
614 memset(out
, 0, sizeof(out
));
619 hmcfgusb_send(dev
.hmcfgusb
, out
, sizeof(out
), 1);
621 memset(out
, 0, sizeof(out
));
626 hmcfgusb_send(dev
.hmcfgusb
, out
, sizeof(out
), 1);
630 if (!switch_speed(&dev
, &rdata
, 10)) {
631 fprintf(stderr
, "Can't switch speed!\n");
635 if (hmid
&& my_hmid
) {
636 printf("Sending device with hmid %06x to bootloader\n", hmid
);
637 out
[MSGID
] = msgid
++;
640 SET_SRC(out
, my_hmid
);
643 SET_LEN_FROM_PAYLOADLEN(out
, 1);
647 if (send_hm_message(&dev
, &rdata
, out
)) {
652 printf("Failed to send device to bootloader, please enter bootloader manually.\n");
657 printf("Waiting for device with serial %s\n", serial
);
659 printf("Waiting for device with HMID %06x\n", hmid
);
665 case DEVICE_TYPE_CULFW
:
666 pfd
= culfw_poll(dev
.culfw
, 1000);
668 case DEVICE_TYPE_HMCFGUSB
:
670 pfd
= hmcfgusb_poll(dev
.hmcfgusb
, 1000);
674 if ((pfd
< 0) && errno
) {
675 if (errno
!= ETIMEDOUT
) {
681 if ((rdata
.message
[LEN
] == 0x14) && /* Length */
682 (rdata
.message
[MSGID
] == 0x00) && /* Message ID */
683 (rdata
.message
[CTL
] == 0x00) && /* Control Byte */
684 (rdata
.message
[TYPE
] == 0x10) && /* Messagte type: Information */
685 (DST(rdata
.message
) == 0x000000) && /* Broadcast */
686 (rdata
.message
[PAYLOAD
] == 0x00)) { /* FUP? */
687 if (serial
&& !strncmp((char*)&(rdata
.message
[0x0b]), serial
, 10)) {
688 hmid
= SRC(rdata
.message
);
690 } else if (!serial
&& SRC(rdata
.message
) == hmid
) {
691 serial
= (char*)&(rdata
.message
[0x0b]);
697 printf("Device with serial %s (HMID: %06x) entered firmware-update-mode\n", serial
, hmid
);
699 if (dev
.type
== DEVICE_TYPE_HMCFGUSB
) {
700 printf("Adding HMID\n");
702 memset(out
, 0, sizeof(out
));
704 out
[1] = (hmid
>> 16) & 0xff;
705 out
[2] = (hmid
>> 8) & 0xff;
706 out
[3] = hmid
& 0xff;
708 hmcfgusb_send(dev
.hmcfgusb
, out
, sizeof(out
), 1);
713 printf("Initiating remote switch to 100k\n");
715 memset(out
, 0, sizeof(out
));
717 out
[MSGID
] = msgid
++;
720 SET_SRC(out
, my_hmid
);
723 memcpy(&out
[PAYLOAD
], cc1101_regs
, sizeof(cc1101_regs
));
724 SET_LEN_FROM_PAYLOADLEN(out
, sizeof(cc1101_regs
));
726 if (!send_hm_message(&dev
, &rdata
, out
)) {
730 if (!switch_speed(&dev
, &rdata
, 100)) {
731 fprintf(stderr
, "Can't switch speed!\n");
735 printf("Has the device switched?\n");
737 memset(out
, 0, sizeof(out
));
739 out
[MSGID
] = msgid
++;
742 SET_SRC(out
, my_hmid
);
745 memcpy(&out
[PAYLOAD
], cc1101_regs
, sizeof(cc1101_regs
));
746 SET_LEN_FROM_PAYLOADLEN(out
, sizeof(cc1101_regs
));
750 if (send_hm_message(&dev
, &rdata
, out
)) {
751 /* A0A02000221B9AD00000000 */
760 if (!switch_speed(&dev
, &rdata
, 10)) {
761 fprintf(stderr
, "Can't switch speed!\n");
765 } while ((!switched
) && (switchcnt
--));
768 fprintf(stderr
, "Too many errors, giving up!\n");
774 printf("Flashing %d blocks", fw
->fw_blocks
);
778 printf(": %04u/%04u %c", 0, fw
->fw_blocks
, twiddlie
[0]);
782 for (block
= 0; block
< fw
->fw_blocks
; block
++) {
785 len
= fw
->fw
[block
][2] << 8;
786 len
|= fw
->fw
[block
][3];
788 pos
= &(fw
->fw
[block
][2]);
790 len
+= 2; /* length */
793 hexdump(pos
, len
, "F> ");
798 int payloadlen
= max_payloadlen
- 2;
802 payloadlen
= max_payloadlen
;
806 if ((len
- (pos
- &(fw
->fw
[block
][2]))) < payloadlen
)
807 payloadlen
= (len
- (pos
- &(fw
->fw
[block
][2])));
809 if (((pos
+ payloadlen
) - &(fw
->fw
[block
][2])) == len
)
812 memset(&rdata
, 0, sizeof(rdata
));
814 memset(out
, 0, sizeof(out
));
820 SET_SRC(out
, my_hmid
);
823 memcpy(&out
[PAYLOAD
], pos
, payloadlen
);
824 SET_LEN_FROM_PAYLOADLEN(out
, payloadlen
);
826 if (send_hm_message(&dev
, &rdata
, out
)) {
829 pos
= &(fw
->fw
[block
][2]);
831 if (cnt
== MAX_RETRIES
) {
832 fprintf(stderr
, "\nToo many errors, giving up!\n");
835 printf("Flashing %d blocks: %04u/%04u %c", fw
->fw_blocks
, block
+ 1, fw
->fw_blocks
, twiddlie
[msgnum
% sizeof(twiddlie
)]);
842 printf("\b\b\b\b\b\b\b\b\b\b\b%04u/%04u %c",
843 block
+ 1, fw
->fw_blocks
, twiddlie
[msgnum
% sizeof(twiddlie
)]);
846 } while((pos
- &(fw
->fw
[block
][2])) < len
);
854 if (!switch_speed(&dev
, &rdata
, 10)) {
855 fprintf(stderr
, "Can't switch speed!\n");
859 printf("Waiting for device to reboot\n");
865 case DEVICE_TYPE_CULFW
:
866 pfd
= culfw_poll(dev
.culfw
, 1000);
868 case DEVICE_TYPE_HMCFGUSB
:
870 pfd
= hmcfgusb_poll(dev
.hmcfgusb
, 1000);
873 if ((pfd
< 0) && errno
) {
874 if (errno
!= ETIMEDOUT
) {
879 if (rdata
.message_type
== MESSAGE_TYPE_E
) {
884 if (rdata
.message_type
== MESSAGE_TYPE_E
) {
885 printf("Device rebooted\n");
889 case DEVICE_TYPE_HMCFGUSB
:
890 hmcfgusb_close(dev
.hmcfgusb
);
893 case DEVICE_TYPE_CULFW
:
894 culfw_close(dev
.culfw
);