[J-u-boot.git] / common / xyzModem.c

// SPDX-License-Identifier: eCos-2.0
/*
 *==========================================================================
 *
 *      xyzModem.c
 *
 *      RedBoot stream handler for xyzModem protocol
 *
 *==========================================================================
 *#####DESCRIPTIONBEGIN####
 *
 * Author(s):    gthomas
 * Contributors: gthomas, tsmith, Yoshinori Sato
 * Date:         2000-07-14
 * Purpose:
 * Description:
 *
 * This code is part of RedBoot (tm).
 *
 *####DESCRIPTIONEND####
 *
 *==========================================================================
 */
#include <common.h>
#include <xyzModem.h>
#include <stdarg.h>
#include <u-boot/crc.h>
#include <watchdog.h>
#include <env.h>

/* Assumption - run xyzModem protocol over the console port */

/* Values magic to the protocol */
#define SOH 0x01
#define STX 0x02
#define ETX 0x03		/* ^C for interrupt */
#define EOT 0x04
#define ACK 0x06
#define BSP 0x08
#define NAK 0x15
#define CAN 0x18
#define EOF 0x1A		/* ^Z for DOS officionados */

/* Data & state local to the protocol */
static struct
{
  int *__chan;
  unsigned char pkt[1024], *bufp;
  unsigned char blk, cblk, crc1, crc2;
  unsigned char next_blk;	/* Expected block */
  int len, mode, total_retries;
  int total_SOH, total_STX, total_CAN;
  bool crc_mode, at_eof, tx_ack;
  bool first_xmodem_packet;
  ulong initial_time, timeout;
  unsigned long file_length, read_length;
} xyz;

#define xyzModem_CHAR_TIMEOUT            2000	/* 2 seconds */
#define xyzModem_MAX_RETRIES             20
#define xyzModem_MAX_RETRIES_WITH_CRC    10
#define xyzModem_CAN_COUNT                3	/* Wait for 3 CAN before quitting */


typedef int cyg_int32;
static int
CYGACC_COMM_IF_GETC_TIMEOUT (char chan, char *c)
{

  ulong now = get_timer(0);
  schedule();
  while (!tstc ())
    {
      if (get_timer(now) > xyzModem_CHAR_TIMEOUT)
        break;
    }
  if (tstc ())
    {
      *c = getchar();
      return 1;
    }
  return 0;
}

static void
CYGACC_COMM_IF_PUTC (char x, char y)
{
  putc (y);
}

/* Validate a hex character */
__inline__ static bool
_is_hex (char c)
{
  return (((c >= '0') && (c <= '9')) ||
	  ((c >= 'A') && (c <= 'F')) || ((c >= 'a') && (c <= 'f')));
}

/* Convert a single hex nibble */
__inline__ static int
_from_hex (char c)
{
  int ret = 0;

  if ((c >= '0') && (c <= '9'))
    {
      ret = (c - '0');
    }
  else if ((c >= 'a') && (c <= 'f'))
    {
      ret = (c - 'a' + 0x0a);
    }
  else if ((c >= 'A') && (c <= 'F'))
    {
      ret = (c - 'A' + 0x0A);
    }
  return ret;
}

/* Convert a character to lower case */
__inline__ static char
_tolower (char c)
{
  if ((c >= 'A') && (c <= 'Z'))
    {
      c = (c - 'A') + 'a';
    }
  return c;
}

/* Parse (scan) a number */
static bool
parse_num (char *s, unsigned long *val, char **es, char *delim)
{
  bool first = true;
  int radix = 10;
  char c;
  unsigned long result = 0;
  int digit;

  while (*s == ' ')
    s++;
  while (*s)
    {
      if (first && (s[0] == '0') && (_tolower (s[1]) == 'x'))
	{
	  radix = 16;
	  s += 2;
	}
      first = false;
      c = *s++;
      if (_is_hex (c) && ((digit = _from_hex (c)) < radix))
	{
	  /* Valid digit */
	  result = (result * radix) + digit;
	}
      else
	{
	  if (delim != (char *) 0)
	    {
	      /* See if this character is one of the delimiters */
	      char *dp = delim;
	      while (*dp && (c != *dp))
		dp++;
	      if (*dp)
		break;		/* Found a good delimiter */
	    }
	  return false;		/* Malformatted number */
	}
    }
  *val = result;
  if (es != (char **) 0)
    {
      *es = s;
    }
  return true;
}


#if defined(DEBUG) && !CONFIG_IS_ENABLED(USE_TINY_PRINTF)
/*
 * Note: this debug setup works by storing the strings in a fixed buffer
 */
static char zm_debug_buf[8192];
static char *zm_out = zm_debug_buf;
static char *zm_out_start = zm_debug_buf;

static int
zm_dprintf(char *fmt, ...)
{
	int len;
	va_list args;

	va_start(args, fmt);
	len = diag_vsprintf(zm_out, fmt, args);
	va_end(args);
	zm_out += len;
	return len;
}

static void
zm_flush (void)
{
  zm_out = zm_out_start;
}

static void
zm_dump_buf (void *buf, int len)
{

}

static unsigned char zm_buf[2048];
static unsigned char *zm_bp;

static void
zm_new (void)
{
  zm_bp = zm_buf;
}

static void
zm_save (unsigned char c)
{
  *zm_bp++ = c;
}

static void
zm_dump (int line)
{
  zm_dprintf ("Packet at line: %d\n", line);
  zm_dump_buf (zm_buf, zm_bp - zm_buf);
}

#define ZM_DEBUG(x) x
#else
#define ZM_DEBUG(x)
#endif

/* Wait for the line to go idle */
static void
xyzModem_flush (void)
{
  int res;
  char c;
  while (true)
    {
      res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, &c);
      if (!res)
	return;
    }
}

static int
xyzModem_get_hdr (void)
{
  char c;
  int res;
  bool hdr_found = false;
  int i, can_total, hdr_chars;
  unsigned short cksum;

  ZM_DEBUG (zm_new ());
  /* Find the start of a header */
  can_total = 0;
  hdr_chars = 0;

  if (xyz.tx_ack)
    {
      CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
      xyz.tx_ack = false;
    }
  while (!hdr_found)
    {
      res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, &c);
      ZM_DEBUG (zm_save (c));
      if (res)
	{
	  hdr_chars++;
	  switch (c)
	    {
	    case SOH:
	      xyz.total_SOH++;
	    case STX:
	      if (c == STX)
		xyz.total_STX++;
	      hdr_found = true;
	      break;
	    case CAN:
	    case ETX:
	      xyz.total_CAN++;
	      ZM_DEBUG (zm_dump (__LINE__));
	      if (++can_total == xyzModem_CAN_COUNT)
		{
		  return xyzModem_cancel;
		}
	      else
		{
		  /* Wait for multiple CAN to avoid early quits */
		  break;
		}
	    case EOT:
	      /* EOT only supported if no noise */
	      if (hdr_chars == 1)
		{
		  CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
		  ZM_DEBUG (zm_dprintf ("ACK on EOT #%d\n", __LINE__));
		  ZM_DEBUG (zm_dump (__LINE__));
		  return xyzModem_eof;
		}
	    default:
	      /* Ignore, waiting for start of header */
	      ;
	    }
	}
      else
	{
	  /* Data stream timed out */
	  xyzModem_flush ();	/* Toss any current input */
	  ZM_DEBUG (zm_dump (__LINE__));
	  CYGACC_CALL_IF_DELAY_US ((cyg_int32) 250000);
	  return xyzModem_timeout;
	}
    }

  /* Header found, now read the data */
  res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, (char *) &xyz.blk);
  ZM_DEBUG (zm_save (xyz.blk));
  if (!res)
    {
      ZM_DEBUG (zm_dump (__LINE__));
      return xyzModem_timeout;
    }
  res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, (char *) &xyz.cblk);
  ZM_DEBUG (zm_save (xyz.cblk));
  if (!res)
    {
      ZM_DEBUG (zm_dump (__LINE__));
      return xyzModem_timeout;
    }
  xyz.len = (c == SOH) ? 128 : 1024;
  xyz.bufp = xyz.pkt;
  for (i = 0; i < xyz.len; i++)
    {
      res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, &c);
      ZM_DEBUG (zm_save (c));
      if (res)
	{
	  xyz.pkt[i] = c;
	}
      else
	{
	  ZM_DEBUG (zm_dump (__LINE__));
	  return xyzModem_timeout;
	}
    }
  res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, (char *) &xyz.crc1);
  ZM_DEBUG (zm_save (xyz.crc1));
  if (!res)
    {
      ZM_DEBUG (zm_dump (__LINE__));
      return xyzModem_timeout;
    }
  if (xyz.crc_mode)
    {
      res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, (char *) &xyz.crc2);
      ZM_DEBUG (zm_save (xyz.crc2));
      if (!res)
	{
	  ZM_DEBUG (zm_dump (__LINE__));
	  return xyzModem_timeout;
	}
    }
  ZM_DEBUG (zm_dump (__LINE__));
  /* Validate the message */
  if ((xyz.blk ^ xyz.cblk) != (unsigned char) 0xFF)
    {
      ZM_DEBUG (zm_dprintf
		("Framing error - blk: %x/%x/%x\n", xyz.blk, xyz.cblk,
		 (xyz.blk ^ xyz.cblk)));
      ZM_DEBUG (zm_dump_buf (xyz.pkt, xyz.len));
      xyzModem_flush ();
      return xyzModem_frame;
    }
  /* Verify checksum/CRC */
  if (xyz.crc_mode)
    {
      cksum = crc16_ccitt(0, xyz.pkt, xyz.len);
      if (cksum != ((xyz.crc1 << 8) | xyz.crc2))
	{
	  ZM_DEBUG (zm_dprintf ("CRC error - recvd: %02x%02x, computed: %x\n",
				xyz.crc1, xyz.crc2, cksum & 0xFFFF));
	  return xyzModem_cksum;
	}
    }
  else
    {
      cksum = 0;
      for (i = 0; i < xyz.len; i++)
	{
	  cksum += xyz.pkt[i];
	}
      if (xyz.crc1 != (cksum & 0xFF))
	{
	  ZM_DEBUG (zm_dprintf
		    ("Checksum error - recvd: %x, computed: %x\n", xyz.crc1,
		     cksum & 0xFF));
	  return xyzModem_cksum;
	}
    }
  /* If we get here, the message passes [structural] muster */
  return 0;
}

static
ulong
xyzModem_get_initial_timeout (void)
{
  /* timeout is in seconds, non-positive timeout value is infinity */
#if CONFIG_IS_ENABLED(ENV_SUPPORT)
  const char *timeout_str = env_get("loadxy_timeout");
  if (timeout_str)
    return 1000 * simple_strtol(timeout_str, NULL, 10);
#endif
  return 1000 * CONFIG_CMD_LOADXY_TIMEOUT;
}

int
xyzModem_stream_open (connection_info_t * info, int *err)
{
  int stat = 0;
  int retries = xyzModem_MAX_RETRIES;
  int crc_retries = xyzModem_MAX_RETRIES_WITH_CRC;

/*    ZM_DEBUG(zm_out = zm_out_start); */
#ifdef xyzModem_zmodem
  if (info->mode == xyzModem_zmodem)
    {
      *err = xyzModem_noZmodem;
      return -1;
    }
#endif

/* TODO: CHECK ! */
  int dummy = 0;
  xyz.__chan = &dummy;
  xyz.len = 0;
  xyz.crc_mode = true;
  xyz.at_eof = false;
  xyz.tx_ack = false;
  xyz.mode = info->mode;
  xyz.total_retries = 0;
  xyz.total_SOH = 0;
  xyz.total_STX = 0;
  xyz.total_CAN = 0;
  xyz.read_length = 0;
  xyz.file_length = 0;
  xyz.first_xmodem_packet = false;
  xyz.initial_time = get_timer(0);
  xyz.timeout = xyzModem_get_initial_timeout();

  CYGACC_COMM_IF_PUTC (*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));

  if (xyz.mode == xyzModem_xmodem)
    {
      /* X-modem doesn't have an information header - exit here */
      xyz.first_xmodem_packet = true;
      xyz.next_blk = 1;
      return 0;
    }

  while (!(xyz.timeout && get_timer(xyz.initial_time) > xyz.timeout))
    {
      if (--retries <= 0)
        {
          retries = xyzModem_MAX_RETRIES;
          crc_retries = xyzModem_MAX_RETRIES_WITH_CRC;
          xyz.crc_mode = true;
        }
      stat = xyzModem_get_hdr ();
      if (stat == 0)
	{
	  /* Y-modem file information header */
	  if (xyz.blk == 0)
	    {
	      /* skip filename */
	      while (*xyz.bufp++);
	      /* get the length */
	      parse_num ((char *) xyz.bufp, &xyz.file_length, NULL, " ");
	      /* The rest of the file name data block quietly discarded */
	      xyz.tx_ack = true;
	    }
	  xyz.next_blk = 1;
	  xyz.len = 0;
	  return 0;
	}
      else if (stat == xyzModem_timeout)
	{
	  if (--crc_retries <= 0)
	    xyz.crc_mode = false;
	  CYGACC_CALL_IF_DELAY_US (5 * 100000);	/* Extra delay for startup */
	  CYGACC_COMM_IF_PUTC (*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));
	  xyz.total_retries++;
	  ZM_DEBUG (zm_dprintf ("NAK (%d)\n", __LINE__));
	}
      if (stat == xyzModem_cancel)
	{
	  break;
	}
    }
  *err = stat;
  ZM_DEBUG (zm_flush ());
  return -1;
}

int
xyzModem_stream_read (char *buf, int size, int *err)
{
  int stat, total, len;
  int retries;

  total = 0;
  stat = xyzModem_cancel;
  /* Try and get 'size' bytes into the buffer */
  while (!xyz.at_eof && xyz.len >= 0 && (size > 0))
    {
      if (xyz.len == 0)
	{
	  retries = xyzModem_MAX_RETRIES;
	  while (retries-- > 0)
	    {
	      if (xyz.first_xmodem_packet && xyz.timeout &&
		  get_timer(xyz.initial_time) > xyz.timeout)
		{
		  *err = xyzModem_timeout;
		  xyz.len = -1;
		  return total;
		}

	      stat = xyzModem_get_hdr ();
	      if (stat == 0)
		{
		  if (xyz.mode == xyzModem_xmodem && xyz.first_xmodem_packet)
		    xyz.first_xmodem_packet = false;
		  if (xyz.blk == xyz.next_blk)
		    {
		      xyz.tx_ack = true;
		      ZM_DEBUG (zm_dprintf
				("ACK block %d (%d)\n", xyz.blk, __LINE__));
		      xyz.next_blk = (xyz.next_blk + 1) & 0xFF;

		      if (xyz.mode == xyzModem_xmodem || xyz.file_length == 0)
			{
			  /* Data blocks can be padded with ^Z (EOF) characters */
			  /* This code tries to detect and remove them */
			  if ((xyz.bufp[xyz.len - 1] == EOF) &&
			      (xyz.bufp[xyz.len - 2] == EOF) &&
			      (xyz.bufp[xyz.len - 3] == EOF))
			    {
			      while (xyz.len
				     && (xyz.bufp[xyz.len - 1] == EOF))
				{
				  xyz.len--;
				}
			    }
			}

		      /*
		       * See if accumulated length exceeds that of the file.
		       * If so, reduce size (i.e., cut out pad bytes)
		       * Only do this for Y-modem (and Z-modem should it ever
		       * be supported since it can fall back to Y-modem mode).
		       */
		      if (xyz.mode != xyzModem_xmodem && 0 != xyz.file_length)
			{
			  xyz.read_length += xyz.len;
			  if (xyz.read_length > xyz.file_length)
			    {
			      xyz.len -= (xyz.read_length - xyz.file_length);
			    }
			}
		      break;
		    }
		  else if (xyz.blk == ((xyz.next_blk - 1) & 0xFF))
		    {
		      /* Just re-ACK this so sender will get on with it */
		      CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
		      continue;	/* Need new header */
		    }
		  else
		    {
		      stat = xyzModem_sequence;
		    }
		}
	      if (stat == xyzModem_cancel)
		{
		  break;
		}
	      if (stat == xyzModem_eof)
		{
		  CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
		  ZM_DEBUG (zm_dprintf ("ACK (%d)\n", __LINE__));
		  if (xyz.mode == xyzModem_ymodem)
		    {
		      CYGACC_COMM_IF_PUTC (*xyz.__chan,
					   (xyz.crc_mode ? 'C' : NAK));
		      xyz.total_retries++;
		      ZM_DEBUG (zm_dprintf ("Reading Final Header\n"));
		      stat = xyzModem_get_hdr ();
		      CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
		      ZM_DEBUG (zm_dprintf ("FINAL ACK (%d)\n", __LINE__));
		    }
		  else
		    stat = 0;
		  xyz.at_eof = true;
		  break;
		}
	      CYGACC_COMM_IF_PUTC (*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));
	      xyz.total_retries++;
	      ZM_DEBUG (zm_dprintf ("NAK (%d)\n", __LINE__));
	    }
	  if (stat < 0 && (!xyz.first_xmodem_packet || stat != xyzModem_timeout))
	    {
	      *err = stat;
	      xyz.len = -1;
	      return total;
	    }
	}
      /* Don't "read" data from the EOF protocol package */
      if (!xyz.at_eof && xyz.len > 0)
	{
	  len = xyz.len;
	  if (size < len)
	    len = size;
	  memcpy (buf, xyz.bufp, len);
	  size -= len;
	  buf += len;
	  total += len;
	  xyz.len -= len;
	  xyz.bufp += len;
	}
    }
  return total;
}

void
xyzModem_stream_close (int *err)
{
  ZM_DEBUG (zm_dprintf
    ("xyzModem - %s mode, %d(SOH)/%d(STX)/%d(CAN) packets, %d retries\n",
     xyz.crc_mode ? "CRC" : "Cksum", xyz.total_SOH, xyz.total_STX,
     xyz.total_CAN, xyz.total_retries));
  ZM_DEBUG (zm_flush ());
}

/* Need to be able to clean out the input buffer, so have to take the */
/* getc */
void
xyzModem_stream_terminate (bool abort, int (*getc) (void))
{
  int c;

  if (abort)
    {
      ZM_DEBUG (zm_dprintf ("!!!! TRANSFER ABORT !!!!\n"));
      switch (xyz.mode)
	{
	case xyzModem_xmodem:
	case xyzModem_ymodem:
	  /* The X/YMODEM Spec seems to suggest that multiple CAN followed by an equal */
	  /* number of Backspaces is a friendly way to get the other end to abort. */
	  CYGACC_COMM_IF_PUTC (*xyz.__chan, CAN);
	  CYGACC_COMM_IF_PUTC (*xyz.__chan, CAN);
	  CYGACC_COMM_IF_PUTC (*xyz.__chan, CAN);
	  CYGACC_COMM_IF_PUTC (*xyz.__chan, CAN);
	  CYGACC_COMM_IF_PUTC (*xyz.__chan, BSP);
	  CYGACC_COMM_IF_PUTC (*xyz.__chan, BSP);
	  CYGACC_COMM_IF_PUTC (*xyz.__chan, BSP);
	  CYGACC_COMM_IF_PUTC (*xyz.__chan, BSP);
	  /* Now consume the rest of what's waiting on the line. */
	  ZM_DEBUG (zm_dprintf ("Flushing serial line.\n"));
	  xyzModem_flush ();
	  xyz.at_eof = true;
	  break;
#ifdef xyzModem_zmodem
	case xyzModem_zmodem:
	  /* Might support it some day I suppose. */
#endif
	  break;
	}
    }
  else
    {
      ZM_DEBUG (zm_dprintf ("Engaging cleanup mode...\n"));
      /*
       * Consume any trailing crap left in the inbuffer from
       * previous received blocks. Since very few files are an exact multiple
       * of the transfer block size, there will almost always be some gunk here.
       * If we don't eat it now, RedBoot will think the user typed it.
       */
      ZM_DEBUG (zm_dprintf ("Trailing gunk:\n"));
      while ((c = (*getc) ()) > -1)
        ;
      ZM_DEBUG (zm_dprintf ("\n"));
      /*
       * Make a small delay to give terminal programs like minicom
       * time to get control again after their file transfer program
       * exits.
       */
      CYGACC_CALL_IF_DELAY_US ((cyg_int32) 250000);
    }
}

char *
xyzModem_error (int err)
{
  switch (err)
    {
    case xyzModem_access:
      return "Can't access file";
      break;
    case xyzModem_noZmodem:
      return "Sorry, zModem not available yet";
      break;
    case xyzModem_timeout:
      return "Timed out";
      break;
    case xyzModem_eof:
      return "End of file";
      break;
    case xyzModem_cancel:
      return "Cancelled";
      break;
    case xyzModem_frame:
      return "Invalid framing";
      break;
    case xyzModem_cksum:
      return "CRC/checksum error";
      break;
    case xyzModem_sequence:
      return "Block sequence error";
      break;
    default:
      return "Unknown error";
      break;
    }
}

/*
 * RedBoot interface
 */
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: eCos-2.0
cf48eb9a WD	2	/*
	3	*==========================================================================
	4	*
	5	* xyzModem.c
	6	*
	7	* RedBoot stream handler for xyzModem protocol
	8	*
	9	*==========================================================================
cf48eb9a WD	10	*#####DESCRIPTIONBEGIN####
	11	*
	12	* Author(s): gthomas
	13	* Contributors: gthomas, tsmith, Yoshinori Sato
	14	* Date: 2000-07-14
	15	* Purpose:
	16	* Description:
	17	*
	18	* This code is part of RedBoot (tm).
	19	*
	20	*####DESCRIPTIONEND####
	21	*
	22	*==========================================================================
	23	*/
f2841d37 MK	24	#include <common.h>
	25	#include <xyzModem.h>
	26	#include <stdarg.h>
a740ee91	27	#include <u-boot/crc.h>
a4773c55	28	#include <watchdog.h>
1b3e6820	29	#include <env.h>
f2841d37	30
cf48eb9a	31	/* Assumption - run xyzModem protocol over the console port */
f2841d37	32
cf48eb9a	33	/* Values magic to the protocol */
f2841d37 MK	34	#define SOH 0x01
f2841d37 MK	35	#define STX 0x02
dffeb400	36	#define ETX 0x03 /* ^C for interrupt */
f2841d37 MK	37	#define EOT 0x04
	38	#define ACK 0x06
	39	#define BSP 0x08
	40	#define NAK 0x15
	41	#define CAN 0x18
7d0432c9	42	#define EOF 0x1A /* ^Z for DOS officionados */
f2841d37	43
cf48eb9a	44	/* Data & state local to the protocol */
7d0432c9 WD	45	static struct
7d0432c9 WD	46	{
7d0432c9	47	int *__chan;
7d0432c9 WD	48	unsigned char pkt[1024], *bufp;
	49	unsigned char blk, cblk, crc1, crc2;
	50	unsigned char next_blk; /* Expected block */
	51	int len, mode, total_retries;
	52	int total_SOH, total_STX, total_CAN;
	53	bool crc_mode, at_eof, tx_ack;
1b3e6820 T	54	bool first_xmodem_packet;
1b3e6820 T	55	ulong initial_time, timeout;
7d0432c9	56	unsigned long file_length, read_length;
f2841d37 MK	57	} xyz;
f2841d37 MK	58
7d0432c9	59	#define xyzModem_CHAR_TIMEOUT 2000 /* 2 seconds */
f2841d37 MK	60	#define xyzModem_MAX_RETRIES 20
f2841d37 MK	61	#define xyzModem_MAX_RETRIES_WITH_CRC 10
7d0432c9	62	#define xyzModem_CAN_COUNT 3 /* Wait for 3 CAN before quitting */
f2841d37 MK	63
f2841d37 MK	64
f2841d37	65	typedef int cyg_int32;
199adb60	66	static int
7d0432c9 WD	67	CYGACC_COMM_IF_GETC_TIMEOUT (char chan, char *c)
7d0432c9 WD	68	{
2c77c0d6	69
2c77c0d6	70	ulong now = get_timer(0);
29caf930	71	schedule();
2c77c0d6	72	while (!tstc ())
7d0432c9	73	{
2c77c0d6	74	if (get_timer(now) > xyzModem_CHAR_TIMEOUT)
2c77c0d6	75	break;
7d0432c9 WD	76	}
	77	if (tstc ())
	78	{
c670aeee	79	*c = getchar();
7d0432c9 WD	80	return 1;
	81	}
	82	return 0;
f2841d37 MK	83	}
f2841d37 MK	84
199adb60	85	static void
7d0432c9 WD	86	CYGACC_COMM_IF_PUTC (char x, char y)
	87	{
	88	putc (y);
f2841d37 MK	89	}
f2841d37 MK	90
cf48eb9a	91	/* Validate a hex character */
f2841d37	92	__inline__ static bool
7d0432c9	93	_is_hex (char c)
f2841d37	94	{
7d0432c9 WD	95	return (((c >= '0') && (c <= '9')) \|\|
7d0432c9 WD	96	((c >= 'A') && (c <= 'F')) \|\| ((c >= 'a') && (c <= 'f')));
f2841d37 MK	97	}
f2841d37 MK	98
cf48eb9a	99	/* Convert a single hex nibble */
f2841d37	100	__inline__ static int
7d0432c9	101	_from_hex (char c)
f2841d37	102	{
7d0432c9 WD	103	int ret = 0;
	104
	105	if ((c >= '0') && (c <= '9'))
	106	{
	107	ret = (c - '0');
	108	}
	109	else if ((c >= 'a') && (c <= 'f'))
	110	{
	111	ret = (c - 'a' + 0x0a);
f2841d37	112	}
7d0432c9 WD	113	else if ((c >= 'A') && (c <= 'F'))
	114	{
	115	ret = (c - 'A' + 0x0A);
	116	}
	117	return ret;
f2841d37 MK	118	}
f2841d37 MK	119
cf48eb9a	120	/* Convert a character to lower case */
f2841d37	121	__inline__ static char
7d0432c9	122	_tolower (char c)
f2841d37	123	{
7d0432c9 WD	124	if ((c >= 'A') && (c <= 'Z'))
	125	{
	126	c = (c - 'A') + 'a';
f2841d37	127	}
7d0432c9	128	return c;
f2841d37 MK	129	}
f2841d37 MK	130
cf48eb9a	131	/* Parse (scan) a number */
199adb60	132	static bool
7d0432c9	133	parse_num (char s, unsigned long val, char *es, char delim)
f2841d37	134	{
7d0432c9 WD	135	bool first = true;
	136	int radix = 10;
	137	char c;
	138	unsigned long result = 0;
	139	int digit;
	140
	141	while (*s == ' ')
	142	s++;
	143	while (*s)
	144	{
	145	if (first && (s[0] == '0') && (_tolower (s[1]) == 'x'))
	146	{
	147	radix = 16;
	148	s += 2;
	149	}
	150	first = false;
	151	c = *s++;
	152	if (_is_hex (c) && ((digit = _from_hex (c)) < radix))
	153	{
	154	/* Valid digit */
7d0432c9	155	result = (result * radix) + digit;
7d0432c9 WD	156	}
	157	else
	158	{
	159	if (delim != (char *) 0)
	160	{
	161	/* See if this character is one of the delimiters */
	162	char *dp = delim;
	163	while (dp && (c != dp))
	164	dp++;
	165	if (*dp)
	166	break; /* Found a good delimiter */
	167	}
	168	return false; /* Malformatted number */
	169	}
f2841d37	170	}
7d0432c9 WD	171	*val = result;
	172	if (es != (char **) 0)
	173	{
	174	*es = s;
f2841d37	175	}
7d0432c9	176	return true;
f2841d37 MK	177	}
f2841d37 MK	178
f2841d37	179
27084c03	180	#if defined(DEBUG) && !CONFIG_IS_ENABLED(USE_TINY_PRINTF)
cf48eb9a WD	181	/*
	182	* Note: this debug setup works by storing the strings in a fixed buffer
	183	*/
b09ece08 AG	184	static char zm_debug_buf[8192];
	185	static char *zm_out = zm_debug_buf;
	186	static char *zm_out_start = zm_debug_buf;
f2841d37	187
f2841d37	188	static int
23c64898	189	zm_dprintf(char *fmt, ...)
f2841d37	190	{
23c64898 HS	191	int len;
	192	va_list args;
	193
	194	va_start(args, fmt);
	195	len = diag_vsprintf(zm_out, fmt, args);
	196	va_end(args);
	197	zm_out += len;
	198	return len;
f2841d37 MK	199	}
	200
	201	static void
7d0432c9	202	zm_flush (void)
f2841d37	203	{
7d0432c9	204	zm_out = zm_out_start;
f2841d37	205	}
f2841d37 MK	206
f2841d37 MK	207	static void
7d0432c9	208	zm_dump_buf (void *buf, int len)
f2841d37	209	{
f2841d37	210
f2841d37 MK	211	}
	212
	213	static unsigned char zm_buf[2048];
	214	static unsigned char *zm_bp;
	215
	216	static void
7d0432c9	217	zm_new (void)
f2841d37	218	{
7d0432c9	219	zm_bp = zm_buf;
f2841d37 MK	220	}
	221
	222	static void
7d0432c9	223	zm_save (unsigned char c)
f2841d37	224	{
7d0432c9	225	*zm_bp++ = c;
f2841d37 MK	226	}
	227
	228	static void
7d0432c9	229	zm_dump (int line)
f2841d37	230	{
7d0432c9 WD	231	zm_dprintf ("Packet at line: %d\n", line);
7d0432c9 WD	232	zm_dump_buf (zm_buf, zm_bp - zm_buf);
f2841d37 MK	233	}
	234
	235	#define ZM_DEBUG(x) x
	236	#else
	237	#define ZM_DEBUG(x)
	238	#endif
	239
cf48eb9a	240	/* Wait for the line to go idle */
f2841d37	241	static void
7d0432c9	242	xyzModem_flush (void)
f2841d37	243	{
7d0432c9 WD	244	int res;
	245	char c;
	246	while (true)
	247	{
	248	res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, &c);
	249	if (!res)
	250	return;
f2841d37 MK	251	}
	252	}
	253
	254	static int
7d0432c9	255	xyzModem_get_hdr (void)
f2841d37	256	{
7d0432c9 WD	257	char c;
	258	int res;
	259	bool hdr_found = false;
	260	int i, can_total, hdr_chars;
	261	unsigned short cksum;
	262
	263	ZM_DEBUG (zm_new ());
	264	/* Find the start of a header */
	265	can_total = 0;
	266	hdr_chars = 0;
	267
	268	if (xyz.tx_ack)
	269	{
	270	CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
	271	xyz.tx_ack = false;
f2841d37	272	}
7d0432c9 WD	273	while (!hdr_found)
	274	{
	275	res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, &c);
	276	ZM_DEBUG (zm_save (c));
	277	if (res)
	278	{
	279	hdr_chars++;
	280	switch (c)
	281	{
	282	case SOH:
	283	xyz.total_SOH++;
	284	case STX:
	285	if (c == STX)
	286	xyz.total_STX++;
	287	hdr_found = true;
	288	break;
	289	case CAN:
dffeb400	290	case ETX:
7d0432c9 WD	291	xyz.total_CAN++;
	292	ZM_DEBUG (zm_dump (__LINE__));
	293	if (++can_total == xyzModem_CAN_COUNT)
	294	{
	295	return xyzModem_cancel;
	296	}
	297	else
	298	{
	299	/* Wait for multiple CAN to avoid early quits */
	300	break;
	301	}
	302	case EOT:
	303	/* EOT only supported if no noise */
	304	if (hdr_chars == 1)
	305	{
	306	CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
	307	ZM_DEBUG (zm_dprintf ("ACK on EOT #%d\n", __LINE__));
	308	ZM_DEBUG (zm_dump (__LINE__));
	309	return xyzModem_eof;
	310	}
	311	default:
	312	/* Ignore, waiting for start of header */
	313	;
	314	}
	315	}
	316	else
	317	{
	318	/* Data stream timed out */
	319	xyzModem_flush (); /* Toss any current input */
	320	ZM_DEBUG (zm_dump (__LINE__));
	321	CYGACC_CALL_IF_DELAY_US ((cyg_int32) 250000);
	322	return xyzModem_timeout;
	323	}
f2841d37 MK	324	}
f2841d37 MK	325
7d0432c9 WD	326	/* Header found, now read the data */
	327	res = CYGACC_COMM_IF_GETC_TIMEOUT (xyz.__chan, (char ) &xyz.blk);
	328	ZM_DEBUG (zm_save (xyz.blk));
	329	if (!res)
	330	{
	331	ZM_DEBUG (zm_dump (__LINE__));
	332	return xyzModem_timeout;
f2841d37	333	}
7d0432c9 WD	334	res = CYGACC_COMM_IF_GETC_TIMEOUT (xyz.__chan, (char ) &xyz.cblk);
	335	ZM_DEBUG (zm_save (xyz.cblk));
	336	if (!res)
	337	{
	338	ZM_DEBUG (zm_dump (__LINE__));
	339	return xyzModem_timeout;
f2841d37	340	}
7d0432c9 WD	341	xyz.len = (c == SOH) ? 128 : 1024;
	342	xyz.bufp = xyz.pkt;
	343	for (i = 0; i < xyz.len; i++)
	344	{
	345	res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, &c);
	346	ZM_DEBUG (zm_save (c));
	347	if (res)
	348	{
	349	xyz.pkt[i] = c;
	350	}
	351	else
	352	{
	353	ZM_DEBUG (zm_dump (__LINE__));
	354	return xyzModem_timeout;
	355	}
f2841d37	356	}
7d0432c9 WD	357	res = CYGACC_COMM_IF_GETC_TIMEOUT (xyz.__chan, (char ) &xyz.crc1);
	358	ZM_DEBUG (zm_save (xyz.crc1));
	359	if (!res)
	360	{
	361	ZM_DEBUG (zm_dump (__LINE__));
	362	return xyzModem_timeout;
f2841d37	363	}
7d0432c9 WD	364	if (xyz.crc_mode)
	365	{
	366	res = CYGACC_COMM_IF_GETC_TIMEOUT (xyz.__chan, (char ) &xyz.crc2);
	367	ZM_DEBUG (zm_save (xyz.crc2));
	368	if (!res)
	369	{
	370	ZM_DEBUG (zm_dump (__LINE__));
	371	return xyzModem_timeout;
	372	}
f2841d37	373	}
7d0432c9 WD	374	ZM_DEBUG (zm_dump (__LINE__));
	375	/* Validate the message */
	376	if ((xyz.blk ^ xyz.cblk) != (unsigned char) 0xFF)
	377	{
	378	ZM_DEBUG (zm_dprintf
	379	("Framing error - blk: %x/%x/%x\n", xyz.blk, xyz.cblk,
	380	(xyz.blk ^ xyz.cblk)));
	381	ZM_DEBUG (zm_dump_buf (xyz.pkt, xyz.len));
	382	xyzModem_flush ();
	383	return xyzModem_frame;
f2841d37	384	}
7d0432c9 WD	385	/* Verify checksum/CRC */
	386	if (xyz.crc_mode)
	387	{
ecb57f69	388	cksum = crc16_ccitt(0, xyz.pkt, xyz.len);
7d0432c9 WD	389	if (cksum != ((xyz.crc1 << 8) \| xyz.crc2))
	390	{
	391	ZM_DEBUG (zm_dprintf ("CRC error - recvd: %02x%02x, computed: %x\n",
	392	xyz.crc1, xyz.crc2, cksum & 0xFFFF));
	393	return xyzModem_cksum;
	394	}
f2841d37	395	}
7d0432c9 WD	396	else
	397	{
	398	cksum = 0;
	399	for (i = 0; i < xyz.len; i++)
	400	{
	401	cksum += xyz.pkt[i];
	402	}
	403	if (xyz.crc1 != (cksum & 0xFF))
	404	{
	405	ZM_DEBUG (zm_dprintf
	406	("Checksum error - recvd: %x, computed: %x\n", xyz.crc1,
	407	cksum & 0xFF));
	408	return xyzModem_cksum;
	409	}
	410	}
	411	/* If we get here, the message passes [structural] muster */
	412	return 0;
f2841d37 MK	413	}
f2841d37 MK	414
1b3e6820 T	415	static
	416	ulong
	417	xyzModem_get_initial_timeout (void)
	418	{
	419	/* timeout is in seconds, non-positive timeout value is infinity */
	420	#if CONFIG_IS_ENABLED(ENV_SUPPORT)
	421	const char *timeout_str = env_get("loadxy_timeout");
	422	if (timeout_str)
	423	return 1000 * simple_strtol(timeout_str, NULL, 10);
	424	#endif
	425	return 1000 * CONFIG_CMD_LOADXY_TIMEOUT;
	426	}
	427
cf48eb9a	428	int
7d0432c9	429	xyzModem_stream_open (connection_info_t * info, int *err)
f2841d37	430	{
7d0432c9 WD	431	int stat = 0;
	432	int retries = xyzModem_MAX_RETRIES;
	433	int crc_retries = xyzModem_MAX_RETRIES_WITH_CRC;
f2841d37	434
cf48eb9a	435	/* ZM_DEBUG(zm_out = zm_out_start); */
f2841d37	436	#ifdef xyzModem_zmodem
7d0432c9 WD	437	if (info->mode == xyzModem_zmodem)
	438	{
	439	*err = xyzModem_noZmodem;
	440	return -1;
f2841d37 MK	441	}
	442	#endif
	443
cf48eb9a	444	/* TODO: CHECK ! */
2a2ed845	445	int dummy = 0;
7d0432c9	446	xyz.__chan = &dummy;
7d0432c9 WD	447	xyz.len = 0;
	448	xyz.crc_mode = true;
	449	xyz.at_eof = false;
	450	xyz.tx_ack = false;
	451	xyz.mode = info->mode;
	452	xyz.total_retries = 0;
	453	xyz.total_SOH = 0;
	454	xyz.total_STX = 0;
	455	xyz.total_CAN = 0;
7d0432c9 WD	456	xyz.read_length = 0;
7d0432c9 WD	457	xyz.file_length = 0;
1b3e6820 T	458	xyz.first_xmodem_packet = false;
	459	xyz.initial_time = get_timer(0);
	460	xyz.timeout = xyzModem_get_initial_timeout();
cf48eb9a	461
7d0432c9	462	CYGACC_COMM_IF_PUTC (*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));
f2841d37	463
7d0432c9 WD	464	if (xyz.mode == xyzModem_xmodem)
	465	{
	466	/* X-modem doesn't have an information header - exit here */
1b3e6820	467	xyz.first_xmodem_packet = true;
7d0432c9 WD	468	xyz.next_blk = 1;
7d0432c9 WD	469	return 0;
f2841d37 MK	470	}
f2841d37 MK	471
1b3e6820	472	while (!(xyz.timeout && get_timer(xyz.initial_time) > xyz.timeout))
7d0432c9	473	{
1b3e6820 T	474	if (--retries <= 0)
	475	{
	476	retries = xyzModem_MAX_RETRIES;
	477	crc_retries = xyzModem_MAX_RETRIES_WITH_CRC;
	478	xyz.crc_mode = true;
	479	}
7d0432c9 WD	480	stat = xyzModem_get_hdr ();
	481	if (stat == 0)
	482	{
	483	/* Y-modem file information header */
	484	if (xyz.blk == 0)
	485	{
7d0432c9 WD	486	/* skip filename */
	487	while (*xyz.bufp++);
	488	/* get the length */
	489	parse_num ((char *) xyz.bufp, &xyz.file_length, NULL, " ");
7d0432c9 WD	490	/* The rest of the file name data block quietly discarded */
	491	xyz.tx_ack = true;
	492	}
	493	xyz.next_blk = 1;
	494	xyz.len = 0;
	495	return 0;
	496	}
	497	else if (stat == xyzModem_timeout)
	498	{
	499	if (--crc_retries <= 0)
	500	xyz.crc_mode = false;
	501	CYGACC_CALL_IF_DELAY_US (5 * 100000); /* Extra delay for startup */
	502	CYGACC_COMM_IF_PUTC (*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));
	503	xyz.total_retries++;
	504	ZM_DEBUG (zm_dprintf ("NAK (%d)\n", __LINE__));
	505	}
	506	if (stat == xyzModem_cancel)
	507	{
	508	break;
	509	}
f2841d37	510	}
7d0432c9 WD	511	*err = stat;
	512	ZM_DEBUG (zm_flush ());
	513	return -1;
f2841d37 MK	514	}
f2841d37 MK	515
cf48eb9a	516	int
7d0432c9	517	xyzModem_stream_read (char buf, int size, int err)
f2841d37	518	{
7d0432c9 WD	519	int stat, total, len;
	520	int retries;
	521
	522	total = 0;
	523	stat = xyzModem_cancel;
	524	/* Try and get 'size' bytes into the buffer */
1e747846	525	while (!xyz.at_eof && xyz.len >= 0 && (size > 0))
7d0432c9 WD	526	{
	527	if (xyz.len == 0)
	528	{
	529	retries = xyzModem_MAX_RETRIES;
	530	while (retries-- > 0)
	531	{
1b3e6820 T	532	if (xyz.first_xmodem_packet && xyz.timeout &&
	533	get_timer(xyz.initial_time) > xyz.timeout)
	534	{
	535	*err = xyzModem_timeout;
	536	xyz.len = -1;
	537	return total;
	538	}
	539
7d0432c9 WD	540	stat = xyzModem_get_hdr ();
	541	if (stat == 0)
	542	{
1b3e6820 T	543	if (xyz.mode == xyzModem_xmodem && xyz.first_xmodem_packet)
1b3e6820 T	544	xyz.first_xmodem_packet = false;
7d0432c9 WD	545	if (xyz.blk == xyz.next_blk)
	546	{
	547	xyz.tx_ack = true;
	548	ZM_DEBUG (zm_dprintf
	549	("ACK block %d (%d)\n", xyz.blk, __LINE__));
	550	xyz.next_blk = (xyz.next_blk + 1) & 0xFF;
f2841d37	551
7d0432c9 WD	552	if (xyz.mode == xyzModem_xmodem \|\| xyz.file_length == 0)
7d0432c9 WD	553	{
7d0432c9 WD	554	/* Data blocks can be padded with ^Z (EOF) characters */
	555	/* This code tries to detect and remove them */
	556	if ((xyz.bufp[xyz.len - 1] == EOF) &&
	557	(xyz.bufp[xyz.len - 2] == EOF) &&
	558	(xyz.bufp[xyz.len - 3] == EOF))
	559	{
	560	while (xyz.len
	561	&& (xyz.bufp[xyz.len - 1] == EOF))
	562	{
	563	xyz.len--;
	564	}
	565	}
	566	}
f2841d37	567
7d0432c9 WD	568	/*
	569	* See if accumulated length exceeds that of the file.
	570	* If so, reduce size (i.e., cut out pad bytes)
	571	* Only do this for Y-modem (and Z-modem should it ever
	572	* be supported since it can fall back to Y-modem mode).
	573	*/
	574	if (xyz.mode != xyzModem_xmodem && 0 != xyz.file_length)
	575	{
	576	xyz.read_length += xyz.len;
	577	if (xyz.read_length > xyz.file_length)
	578	{
	579	xyz.len -= (xyz.read_length - xyz.file_length);
	580	}
	581	}
7d0432c9 WD	582	break;
	583	}
	584	else if (xyz.blk == ((xyz.next_blk - 1) & 0xFF))
	585	{
	586	/* Just re-ACK this so sender will get on with it */
	587	CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
	588	continue; /* Need new header */
	589	}
	590	else
	591	{
	592	stat = xyzModem_sequence;
	593	}
	594	}
	595	if (stat == xyzModem_cancel)
	596	{
	597	break;
	598	}
	599	if (stat == xyzModem_eof)
	600	{
	601	CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
	602	ZM_DEBUG (zm_dprintf ("ACK (%d)\n", __LINE__));
	603	if (xyz.mode == xyzModem_ymodem)
	604	{
	605	CYGACC_COMM_IF_PUTC (*xyz.__chan,
	606	(xyz.crc_mode ? 'C' : NAK));
	607	xyz.total_retries++;
	608	ZM_DEBUG (zm_dprintf ("Reading Final Header\n"));
	609	stat = xyzModem_get_hdr ();
	610	CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
	611	ZM_DEBUG (zm_dprintf ("FINAL ACK (%d)\n", __LINE__));
	612	}
15c27a5a T	613	else
15c27a5a T	614	stat = 0;
7d0432c9 WD	615	xyz.at_eof = true;
	616	break;
	617	}
	618	CYGACC_COMM_IF_PUTC (*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));
	619	xyz.total_retries++;
	620	ZM_DEBUG (zm_dprintf ("NAK (%d)\n", __LINE__));
	621	}
1b3e6820	622	if (stat < 0 && (!xyz.first_xmodem_packet \|\| stat != xyzModem_timeout))
7d0432c9 WD	623	{
	624	*err = stat;
	625	xyz.len = -1;
	626	return total;
	627	}
	628	}
	629	/* Don't "read" data from the EOF protocol package */
1e747846	630	if (!xyz.at_eof && xyz.len > 0)
7d0432c9 WD	631	{
	632	len = xyz.len;
	633	if (size < len)
	634	len = size;
	635	memcpy (buf, xyz.bufp, len);
	636	size -= len;
	637	buf += len;
	638	total += len;
	639	xyz.len -= len;
	640	xyz.bufp += len;
	641	}
f2841d37	642	}
7d0432c9	643	return total;
f2841d37 MK	644	}
	645
	646	void
7d0432c9	647	xyzModem_stream_close (int *err)
f2841d37	648	{
f05d69bd	649	ZM_DEBUG (zm_dprintf
7d0432c9 WD	650	("xyzModem - %s mode, %d(SOH)/%d(STX)/%d(CAN) packets, %d retries\n",
7d0432c9 WD	651	xyz.crc_mode ? "CRC" : "Cksum", xyz.total_SOH, xyz.total_STX,
f05d69bd	652	xyz.total_CAN, xyz.total_retries));
7d0432c9	653	ZM_DEBUG (zm_flush ());
f2841d37 MK	654	}
f2841d37 MK	655
cf48eb9a WD	656	/* Need to be able to clean out the input buffer, so have to take the */
cf48eb9a WD	657	/* getc */
7d0432c9 WD	658	void
7d0432c9 WD	659	xyzModem_stream_terminate (bool abort, int (*getc) (void))
f2841d37 MK	660	{
	661	int c;
	662
7d0432c9 WD	663	if (abort)
	664	{
	665	ZM_DEBUG (zm_dprintf ("!!!! TRANSFER ABORT !!!!\n"));
	666	switch (xyz.mode)
	667	{
f2841d37 MK	668	case xyzModem_xmodem:
f2841d37 MK	669	case xyzModem_ymodem:
cf48eb9a WD	670	/* The X/YMODEM Spec seems to suggest that multiple CAN followed by an equal */
cf48eb9a WD	671	/* number of Backspaces is a friendly way to get the other end to abort. */
7d0432c9 WD	672	CYGACC_COMM_IF_PUTC (*xyz.__chan, CAN);
	673	CYGACC_COMM_IF_PUTC (*xyz.__chan, CAN);
	674	CYGACC_COMM_IF_PUTC (*xyz.__chan, CAN);
	675	CYGACC_COMM_IF_PUTC (*xyz.__chan, CAN);
	676	CYGACC_COMM_IF_PUTC (*xyz.__chan, BSP);
	677	CYGACC_COMM_IF_PUTC (*xyz.__chan, BSP);
	678	CYGACC_COMM_IF_PUTC (*xyz.__chan, BSP);
	679	CYGACC_COMM_IF_PUTC (*xyz.__chan, BSP);
cf48eb9a	680	/* Now consume the rest of what's waiting on the line. */
7d0432c9 WD	681	ZM_DEBUG (zm_dprintf ("Flushing serial line.\n"));
	682	xyzModem_flush ();
	683	xyz.at_eof = true;
	684	break;
f2841d37 MK	685	#ifdef xyzModem_zmodem
f2841d37 MK	686	case xyzModem_zmodem:
cf48eb9a	687	/* Might support it some day I suppose. */
f2841d37	688	#endif
7d0432c9 WD	689	break;
	690	}
	691	}
	692	else
	693	{
	694	ZM_DEBUG (zm_dprintf ("Engaging cleanup mode...\n"));
cf48eb9a WD	695	/*
cf48eb9a WD	696	* Consume any trailing crap left in the inbuffer from
16263087	697	* previous received blocks. Since very few files are an exact multiple
cf48eb9a WD	698	* of the transfer block size, there will almost always be some gunk here.
	699	* If we don't eat it now, RedBoot will think the user typed it.
	700	*/
7d0432c9	701	ZM_DEBUG (zm_dprintf ("Trailing gunk:\n"));
e153b13c JH	702	while ((c = (*getc) ()) > -1)
e153b13c JH	703	;
7d0432c9	704	ZM_DEBUG (zm_dprintf ("\n"));
cf48eb9a WD	705	/*
	706	* Make a small delay to give terminal programs like minicom
	707	* time to get control again after their file transfer program
	708	* exits.
	709	*/
7d0432c9 WD	710	CYGACC_CALL_IF_DELAY_US ((cyg_int32) 250000);
7d0432c9 WD	711	}
f2841d37 MK	712	}
	713
	714	char *
7d0432c9	715	xyzModem_error (int err)
f2841d37	716	{
7d0432c9 WD	717	switch (err)
7d0432c9 WD	718	{
f2841d37	719	case xyzModem_access:
7d0432c9 WD	720	return "Can't access file";
7d0432c9 WD	721	break;
f2841d37	722	case xyzModem_noZmodem:
7d0432c9 WD	723	return "Sorry, zModem not available yet";
7d0432c9 WD	724	break;
f2841d37	725	case xyzModem_timeout:
7d0432c9 WD	726	return "Timed out";
7d0432c9 WD	727	break;
f2841d37	728	case xyzModem_eof:
7d0432c9 WD	729	return "End of file";
7d0432c9 WD	730	break;
f2841d37	731	case xyzModem_cancel:
7d0432c9 WD	732	return "Cancelled";
7d0432c9 WD	733	break;
f2841d37	734	case xyzModem_frame:
7d0432c9 WD	735	return "Invalid framing";
7d0432c9 WD	736	break;
f2841d37	737	case xyzModem_cksum:
7d0432c9 WD	738	return "CRC/checksum error";
7d0432c9 WD	739	break;
f2841d37	740	case xyzModem_sequence:
7d0432c9 WD	741	return "Block sequence error";
7d0432c9 WD	742	break;
f2841d37	743	default:
7d0432c9 WD	744	return "Unknown error";
7d0432c9 WD	745	break;
f2841d37 MK	746	}
	747	}
	748
cf48eb9a WD	749	/*
	750	* RedBoot interface
	751	*/