[people/ms/u-boot.git] / common / xyzModem.c

/*
 *==========================================================================
 *
 *      xyzModem.c
 *
 *      RedBoot stream handler for xyzModem protocol
 *
 *==========================================================================
 * SPDX-License-Identifier:	eCos-2.0
 *==========================================================================
 *#####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 <crc.h>

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

/* Values magic to the protocol */
#define SOH 0x01
#define STX 0x02
#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;
  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);
  while (!tstc ())
    {
      if (get_timer(now) > xyzModem_CHAR_TIMEOUT)
        break;
    }
  if (tstc ())
    {
      *c = getc ();
      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;
}


#ifdef DEBUG
/*
 * 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);
  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:
	      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;
}

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;

  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.next_blk = 1;
      return 0;
    }

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