1 // SPDX-License-Identifier: eCos-2.0
3 *==========================================================================
7 * RedBoot stream handler for xyzModem protocol
9 *==========================================================================
10 *#####DESCRIPTIONBEGIN####
13 * Contributors: gthomas, tsmith, Yoshinori Sato
18 * This code is part of RedBoot (tm).
20 *####DESCRIPTIONEND####
22 *==========================================================================
27 #include <u-boot/crc.h>
30 /* Assumption - run xyzModem protocol over the console port */
32 /* Values magic to the protocol */
40 #define EOF 0x1A /* ^Z for DOS officionados */
42 /* Data & state local to the protocol */
46 unsigned char pkt
[1024], *bufp
;
47 unsigned char blk
, cblk
, crc1
, crc2
;
48 unsigned char next_blk
; /* Expected block */
49 int len
, mode
, total_retries
;
50 int total_SOH
, total_STX
, total_CAN
;
51 bool crc_mode
, at_eof
, tx_ack
;
52 unsigned long file_length
, read_length
;
55 #define xyzModem_CHAR_TIMEOUT 2000 /* 2 seconds */
56 #define xyzModem_MAX_RETRIES 20
57 #define xyzModem_MAX_RETRIES_WITH_CRC 10
58 #define xyzModem_CAN_COUNT 3 /* Wait for 3 CAN before quitting */
61 typedef int cyg_int32
;
63 CYGACC_COMM_IF_GETC_TIMEOUT (char chan
, char *c
)
66 ulong now
= get_timer(0);
70 if (get_timer(now
) > xyzModem_CHAR_TIMEOUT
)
82 CYGACC_COMM_IF_PUTC (char x
, char y
)
87 /* Validate a hex character */
88 __inline__
static bool
91 return (((c
>= '0') && (c
<= '9')) ||
92 ((c
>= 'A') && (c
<= 'F')) || ((c
>= 'a') && (c
<= 'f')));
95 /* Convert a single hex nibble */
101 if ((c
>= '0') && (c
<= '9'))
105 else if ((c
>= 'a') && (c
<= 'f'))
107 ret
= (c
- 'a' + 0x0a);
109 else if ((c
>= 'A') && (c
<= 'F'))
111 ret
= (c
- 'A' + 0x0A);
116 /* Convert a character to lower case */
117 __inline__
static char
120 if ((c
>= 'A') && (c
<= 'Z'))
127 /* Parse (scan) a number */
129 parse_num (char *s
, unsigned long *val
, char **es
, char *delim
)
134 unsigned long result
= 0;
141 if (first
&& (s
[0] == '0') && (_tolower (s
[1]) == 'x'))
148 if (_is_hex (c
) && ((digit
= _from_hex (c
)) < radix
))
151 result
= (result
* radix
) + digit
;
155 if (delim
!= (char *) 0)
157 /* See if this character is one of the delimiters */
159 while (*dp
&& (c
!= *dp
))
162 break; /* Found a good delimiter */
164 return false; /* Malformatted number */
168 if (es
!= (char **) 0)
176 #if defined(DEBUG) && !defined(CONFIG_USE_TINY_PRINTF)
178 * Note: this debug setup works by storing the strings in a fixed buffer
180 static char zm_debug_buf
[8192];
181 static char *zm_out
= zm_debug_buf
;
182 static char *zm_out_start
= zm_debug_buf
;
185 zm_dprintf(char *fmt
, ...)
191 len
= diag_vsprintf(zm_out
, fmt
, args
);
200 zm_out
= zm_out_start
;
204 zm_dump_buf (void *buf
, int len
)
209 static unsigned char zm_buf
[2048];
210 static unsigned char *zm_bp
;
219 zm_save (unsigned char c
)
227 zm_dprintf ("Packet at line: %d\n", line
);
228 zm_dump_buf (zm_buf
, zm_bp
- zm_buf
);
231 #define ZM_DEBUG(x) x
236 /* Wait for the line to go idle */
238 xyzModem_flush (void)
244 res
= CYGACC_COMM_IF_GETC_TIMEOUT (*xyz
.__chan
, &c
);
251 xyzModem_get_hdr (void)
255 bool hdr_found
= false;
256 int i
, can_total
, hdr_chars
;
257 unsigned short cksum
;
259 ZM_DEBUG (zm_new ());
260 /* Find the start of a header */
266 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, ACK
);
271 res
= CYGACC_COMM_IF_GETC_TIMEOUT (*xyz
.__chan
, &c
);
272 ZM_DEBUG (zm_save (c
));
287 ZM_DEBUG (zm_dump (__LINE__
));
288 if (++can_total
== xyzModem_CAN_COUNT
)
290 return xyzModem_cancel
;
294 /* Wait for multiple CAN to avoid early quits */
298 /* EOT only supported if no noise */
301 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, ACK
);
302 ZM_DEBUG (zm_dprintf ("ACK on EOT #%d\n", __LINE__
));
303 ZM_DEBUG (zm_dump (__LINE__
));
307 /* Ignore, waiting for start of header */
313 /* Data stream timed out */
314 xyzModem_flush (); /* Toss any current input */
315 ZM_DEBUG (zm_dump (__LINE__
));
316 CYGACC_CALL_IF_DELAY_US ((cyg_int32
) 250000);
317 return xyzModem_timeout
;
321 /* Header found, now read the data */
322 res
= CYGACC_COMM_IF_GETC_TIMEOUT (*xyz
.__chan
, (char *) &xyz
.blk
);
323 ZM_DEBUG (zm_save (xyz
.blk
));
326 ZM_DEBUG (zm_dump (__LINE__
));
327 return xyzModem_timeout
;
329 res
= CYGACC_COMM_IF_GETC_TIMEOUT (*xyz
.__chan
, (char *) &xyz
.cblk
);
330 ZM_DEBUG (zm_save (xyz
.cblk
));
333 ZM_DEBUG (zm_dump (__LINE__
));
334 return xyzModem_timeout
;
336 xyz
.len
= (c
== SOH
) ? 128 : 1024;
338 for (i
= 0; i
< xyz
.len
; i
++)
340 res
= CYGACC_COMM_IF_GETC_TIMEOUT (*xyz
.__chan
, &c
);
341 ZM_DEBUG (zm_save (c
));
348 ZM_DEBUG (zm_dump (__LINE__
));
349 return xyzModem_timeout
;
352 res
= CYGACC_COMM_IF_GETC_TIMEOUT (*xyz
.__chan
, (char *) &xyz
.crc1
);
353 ZM_DEBUG (zm_save (xyz
.crc1
));
356 ZM_DEBUG (zm_dump (__LINE__
));
357 return xyzModem_timeout
;
361 res
= CYGACC_COMM_IF_GETC_TIMEOUT (*xyz
.__chan
, (char *) &xyz
.crc2
);
362 ZM_DEBUG (zm_save (xyz
.crc2
));
365 ZM_DEBUG (zm_dump (__LINE__
));
366 return xyzModem_timeout
;
369 ZM_DEBUG (zm_dump (__LINE__
));
370 /* Validate the message */
371 if ((xyz
.blk
^ xyz
.cblk
) != (unsigned char) 0xFF)
374 ("Framing error - blk: %x/%x/%x\n", xyz
.blk
, xyz
.cblk
,
375 (xyz
.blk
^ xyz
.cblk
)));
376 ZM_DEBUG (zm_dump_buf (xyz
.pkt
, xyz
.len
));
378 return xyzModem_frame
;
380 /* Verify checksum/CRC */
383 cksum
= crc16_ccitt(0, xyz
.pkt
, xyz
.len
);
384 if (cksum
!= ((xyz
.crc1
<< 8) | xyz
.crc2
))
386 ZM_DEBUG (zm_dprintf ("CRC error - recvd: %02x%02x, computed: %x\n",
387 xyz
.crc1
, xyz
.crc2
, cksum
& 0xFFFF));
388 return xyzModem_cksum
;
394 for (i
= 0; i
< xyz
.len
; i
++)
398 if (xyz
.crc1
!= (cksum
& 0xFF))
401 ("Checksum error - recvd: %x, computed: %x\n", xyz
.crc1
,
403 return xyzModem_cksum
;
406 /* If we get here, the message passes [structural] muster */
411 xyzModem_stream_open (connection_info_t
* info
, int *err
)
414 int retries
= xyzModem_MAX_RETRIES
;
415 int crc_retries
= xyzModem_MAX_RETRIES_WITH_CRC
;
417 /* ZM_DEBUG(zm_out = zm_out_start); */
418 #ifdef xyzModem_zmodem
419 if (info
->mode
== xyzModem_zmodem
)
421 *err
= xyzModem_noZmodem
;
433 xyz
.mode
= info
->mode
;
434 xyz
.total_retries
= 0;
441 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, (xyz
.crc_mode
? 'C' : NAK
));
443 if (xyz
.mode
== xyzModem_xmodem
)
445 /* X-modem doesn't have an information header - exit here */
450 while (retries
-- > 0)
452 stat
= xyzModem_get_hdr ();
455 /* Y-modem file information header */
461 parse_num ((char *) xyz
.bufp
, &xyz
.file_length
, NULL
, " ");
462 /* The rest of the file name data block quietly discarded */
469 else if (stat
== xyzModem_timeout
)
471 if (--crc_retries
<= 0)
472 xyz
.crc_mode
= false;
473 CYGACC_CALL_IF_DELAY_US (5 * 100000); /* Extra delay for startup */
474 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, (xyz
.crc_mode
? 'C' : NAK
));
476 ZM_DEBUG (zm_dprintf ("NAK (%d)\n", __LINE__
));
478 if (stat
== xyzModem_cancel
)
484 ZM_DEBUG (zm_flush ());
489 xyzModem_stream_read (char *buf
, int size
, int *err
)
491 int stat
, total
, len
;
495 stat
= xyzModem_cancel
;
496 /* Try and get 'size' bytes into the buffer */
497 while (!xyz
.at_eof
&& (size
> 0))
501 retries
= xyzModem_MAX_RETRIES
;
502 while (retries
-- > 0)
504 stat
= xyzModem_get_hdr ();
507 if (xyz
.blk
== xyz
.next_blk
)
511 ("ACK block %d (%d)\n", xyz
.blk
, __LINE__
));
512 xyz
.next_blk
= (xyz
.next_blk
+ 1) & 0xFF;
514 if (xyz
.mode
== xyzModem_xmodem
|| xyz
.file_length
== 0)
516 /* Data blocks can be padded with ^Z (EOF) characters */
517 /* This code tries to detect and remove them */
518 if ((xyz
.bufp
[xyz
.len
- 1] == EOF
) &&
519 (xyz
.bufp
[xyz
.len
- 2] == EOF
) &&
520 (xyz
.bufp
[xyz
.len
- 3] == EOF
))
523 && (xyz
.bufp
[xyz
.len
- 1] == EOF
))
531 * See if accumulated length exceeds that of the file.
532 * If so, reduce size (i.e., cut out pad bytes)
533 * Only do this for Y-modem (and Z-modem should it ever
534 * be supported since it can fall back to Y-modem mode).
536 if (xyz
.mode
!= xyzModem_xmodem
&& 0 != xyz
.file_length
)
538 xyz
.read_length
+= xyz
.len
;
539 if (xyz
.read_length
> xyz
.file_length
)
541 xyz
.len
-= (xyz
.read_length
- xyz
.file_length
);
546 else if (xyz
.blk
== ((xyz
.next_blk
- 1) & 0xFF))
548 /* Just re-ACK this so sender will get on with it */
549 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, ACK
);
550 continue; /* Need new header */
554 stat
= xyzModem_sequence
;
557 if (stat
== xyzModem_cancel
)
561 if (stat
== xyzModem_eof
)
563 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, ACK
);
564 ZM_DEBUG (zm_dprintf ("ACK (%d)\n", __LINE__
));
565 if (xyz
.mode
== xyzModem_ymodem
)
567 CYGACC_COMM_IF_PUTC (*xyz
.__chan
,
568 (xyz
.crc_mode
? 'C' : NAK
));
570 ZM_DEBUG (zm_dprintf ("Reading Final Header\n"));
571 stat
= xyzModem_get_hdr ();
572 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, ACK
);
573 ZM_DEBUG (zm_dprintf ("FINAL ACK (%d)\n", __LINE__
));
578 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, (xyz
.crc_mode
? 'C' : NAK
));
580 ZM_DEBUG (zm_dprintf ("NAK (%d)\n", __LINE__
));
589 /* Don't "read" data from the EOF protocol package */
595 memcpy (buf
, xyz
.bufp
, len
);
607 xyzModem_stream_close (int *err
)
610 ("xyzModem - %s mode, %d(SOH)/%d(STX)/%d(CAN) packets, %d retries\n",
611 xyz
.crc_mode
? "CRC" : "Cksum", xyz
.total_SOH
, xyz
.total_STX
,
612 xyz
.total_CAN
, xyz
.total_retries
);
613 ZM_DEBUG (zm_flush ());
616 /* Need to be able to clean out the input buffer, so have to take the */
619 xyzModem_stream_terminate (bool abort
, int (*getc
) (void))
625 ZM_DEBUG (zm_dprintf ("!!!! TRANSFER ABORT !!!!\n"));
628 case xyzModem_xmodem
:
629 case xyzModem_ymodem
:
630 /* The X/YMODEM Spec seems to suggest that multiple CAN followed by an equal */
631 /* number of Backspaces is a friendly way to get the other end to abort. */
632 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, CAN
);
633 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, CAN
);
634 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, CAN
);
635 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, CAN
);
636 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, BSP
);
637 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, BSP
);
638 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, BSP
);
639 CYGACC_COMM_IF_PUTC (*xyz
.__chan
, BSP
);
640 /* Now consume the rest of what's waiting on the line. */
641 ZM_DEBUG (zm_dprintf ("Flushing serial line.\n"));
645 #ifdef xyzModem_zmodem
646 case xyzModem_zmodem
:
647 /* Might support it some day I suppose. */
654 ZM_DEBUG (zm_dprintf ("Engaging cleanup mode...\n"));
656 * Consume any trailing crap left in the inbuffer from
657 * previous received blocks. Since very few files are an exact multiple
658 * of the transfer block size, there will almost always be some gunk here.
659 * If we don't eat it now, RedBoot will think the user typed it.
661 ZM_DEBUG (zm_dprintf ("Trailing gunk:\n"));
662 while ((c
= (*getc
) ()) > -1)
664 ZM_DEBUG (zm_dprintf ("\n"));
666 * Make a small delay to give terminal programs like minicom
667 * time to get control again after their file transfer program
670 CYGACC_CALL_IF_DELAY_US ((cyg_int32
) 250000);
675 xyzModem_error (int err
)
679 case xyzModem_access
:
680 return "Can't access file";
682 case xyzModem_noZmodem
:
683 return "Sorry, zModem not available yet";
685 case xyzModem_timeout
:
689 return "End of file";
691 case xyzModem_cancel
:
695 return "Invalid framing";
698 return "CRC/checksum error";
700 case xyzModem_sequence
:
701 return "Block sequence error";
704 return "Unknown error";