blob: 56f4bcaf99453d04bac277b39a63688ed6836263 [file] [log] [blame]
Wolfgang Denkcf48eb92006-04-16 10:51:58 +02001/*
2 *==========================================================================
3 *
4 * xyzModem.c
5 *
6 * RedBoot stream handler for xyzModem protocol
7 *
8 *==========================================================================
Wolfgang Denke85427f2013-07-08 12:11:35 +02009 * SPDX-License-Identifier: eCos-2.0
Wolfgang Denkcf48eb92006-04-16 10:51:58 +020010 *==========================================================================
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 */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020025#include <common.h>
26#include <xyzModem.h>
27#include <stdarg.h>
28#include <crc.h>
29
Wolfgang Denkcf48eb92006-04-16 10:51:58 +020030/* Assumption - run xyzModem protocol over the console port */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020031
Wolfgang Denkcf48eb92006-04-16 10:51:58 +020032/* Values magic to the protocol */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020033#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
Wolfgang Denk7d0432c2006-08-31 16:46:53 +020040#define EOF 0x1A /* ^Z for DOS officionados */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020041
42#define USE_YMODEM_LENGTH
43
Wolfgang Denkcf48eb92006-04-16 10:51:58 +020044/* Data & state local to the protocol */
Wolfgang Denk7d0432c2006-08-31 16:46:53 +020045static struct
46{
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020047#ifdef REDBOOT
Wolfgang Denk7d0432c2006-08-31 16:46:53 +020048 hal_virtual_comm_table_t *__chan;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020049#else
Wolfgang Denk7d0432c2006-08-31 16:46:53 +020050 int *__chan;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020051#endif
Wolfgang Denk7d0432c2006-08-31 16:46:53 +020052 unsigned char pkt[1024], *bufp;
53 unsigned char blk, cblk, crc1, crc2;
54 unsigned char next_blk; /* Expected block */
55 int len, mode, total_retries;
56 int total_SOH, total_STX, total_CAN;
57 bool crc_mode, at_eof, tx_ack;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020058#ifdef USE_YMODEM_LENGTH
Wolfgang Denk7d0432c2006-08-31 16:46:53 +020059 unsigned long file_length, read_length;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020060#endif
61} xyz;
62
Wolfgang Denk7d0432c2006-08-31 16:46:53 +020063#define xyzModem_CHAR_TIMEOUT 2000 /* 2 seconds */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020064#define xyzModem_MAX_RETRIES 20
65#define xyzModem_MAX_RETRIES_WITH_CRC 10
Wolfgang Denk7d0432c2006-08-31 16:46:53 +020066#define xyzModem_CAN_COUNT 3 /* Wait for 3 CAN before quitting */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020067
68
Wolfgang Denk7d0432c2006-08-31 16:46:53 +020069#ifndef REDBOOT /*SB */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020070typedef int cyg_int32;
Kim Phillips199adb62012-10-29 13:34:32 +000071static int
Wolfgang Denk7d0432c2006-08-31 16:46:53 +020072CYGACC_COMM_IF_GETC_TIMEOUT (char chan, char *c)
73{
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020074#define DELAY 20
Wolfgang Denk7d0432c2006-08-31 16:46:53 +020075 unsigned long counter = 0;
76 while (!tstc () && (counter < xyzModem_CHAR_TIMEOUT * 1000 / DELAY))
77 {
78 udelay (DELAY);
79 counter++;
80 }
81 if (tstc ())
82 {
83 *c = getc ();
84 return 1;
85 }
86 return 0;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020087}
88
Kim Phillips199adb62012-10-29 13:34:32 +000089static void
Wolfgang Denk7d0432c2006-08-31 16:46:53 +020090CYGACC_COMM_IF_PUTC (char x, char y)
91{
92 putc (y);
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020093}
94
Wolfgang Denkcf48eb92006-04-16 10:51:58 +020095/* Validate a hex character */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020096__inline__ static bool
Wolfgang Denk7d0432c2006-08-31 16:46:53 +020097_is_hex (char c)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +020098{
Wolfgang Denk7d0432c2006-08-31 16:46:53 +020099 return (((c >= '0') && (c <= '9')) ||
100 ((c >= 'A') && (c <= 'F')) || ((c >= 'a') && (c <= 'f')));
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200101}
102
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200103/* Convert a single hex nibble */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200104__inline__ static int
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200105_from_hex (char c)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200106{
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200107 int ret = 0;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200108
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200109 if ((c >= '0') && (c <= '9'))
110 {
111 ret = (c - '0');
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200112 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200113 else if ((c >= 'a') && (c <= 'f'))
114 {
115 ret = (c - 'a' + 0x0a);
116 }
117 else if ((c >= 'A') && (c <= 'F'))
118 {
119 ret = (c - 'A' + 0x0A);
120 }
121 return ret;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200122}
123
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200124/* Convert a character to lower case */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200125__inline__ static char
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200126_tolower (char c)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200127{
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200128 if ((c >= 'A') && (c <= 'Z'))
129 {
130 c = (c - 'A') + 'a';
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200131 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200132 return c;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200133}
134
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200135/* Parse (scan) a number */
Kim Phillips199adb62012-10-29 13:34:32 +0000136static bool
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200137parse_num (char *s, unsigned long *val, char **es, char *delim)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200138{
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200139 bool first = true;
140 int radix = 10;
141 char c;
142 unsigned long result = 0;
143 int digit;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200144
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200145 while (*s == ' ')
146 s++;
147 while (*s)
148 {
149 if (first && (s[0] == '0') && (_tolower (s[1]) == 'x'))
150 {
151 radix = 16;
152 s += 2;
153 }
154 first = false;
155 c = *s++;
156 if (_is_hex (c) && ((digit = _from_hex (c)) < radix))
157 {
158 /* Valid digit */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200159#ifdef CYGPKG_HAL_MIPS
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200160 /* FIXME: tx49 compiler generates 0x2539018 for MUL which */
161 /* isn't any good. */
162 if (16 == radix)
163 result = result << 4;
164 else
165 result = 10 * result;
166 result += digit;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200167#else
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200168 result = (result * radix) + digit;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200169#endif
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200170 }
171 else
172 {
173 if (delim != (char *) 0)
174 {
175 /* See if this character is one of the delimiters */
176 char *dp = delim;
177 while (*dp && (c != *dp))
178 dp++;
179 if (*dp)
180 break; /* Found a good delimiter */
181 }
182 return false; /* Malformatted number */
183 }
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200184 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200185 *val = result;
186 if (es != (char **) 0)
187 {
188 *es = s;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200189 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200190 return true;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200191}
192
193#endif
194
195#define USE_SPRINTF
196#ifdef DEBUG
197#ifndef USE_SPRINTF
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200198/*
199 * Note: this debug setup only works if the target platform has two serial ports
200 * available so that the other one (currently only port 1) can be used for debug
201 * messages.
202 */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200203static int
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200204zm_dprintf (char *fmt, ...)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200205{
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200206 int cur_console;
207 va_list args;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200208
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200209 va_start (args, fmt);
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200210#ifdef REDBOOT
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200211 cur_console =
212 CYGACC_CALL_IF_SET_CONSOLE_COMM
213 (CYGNUM_CALL_IF_SET_COMM_ID_QUERY_CURRENT);
214 CYGACC_CALL_IF_SET_CONSOLE_COMM (1);
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200215#endif
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200216 diag_vprintf (fmt, args);
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200217#ifdef REDBOOT
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200218 CYGACC_CALL_IF_SET_CONSOLE_COMM (cur_console);
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200219#endif
220}
221
222static void
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200223zm_flush (void)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200224{
225}
226
227#else
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200228/*
229 * Note: this debug setup works by storing the strings in a fixed buffer
230 */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200231#define FINAL
232#ifdef FINAL
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200233static char *zm_out = (char *) 0x00380000;
234static char *zm_out_start = (char *) 0x00380000;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200235#else
236static char zm_buf[8192];
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200237static char *zm_out = zm_buf;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200238static char *zm_out_start = zm_buf;
239
240#endif
241static int
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200242zm_dprintf (char *fmt, ...)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200243{
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200244 int len;
245 va_list args;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200246
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200247 va_start (args, fmt);
248 len = diag_vsprintf (zm_out, fmt, args);
249 zm_out += len;
250 return len;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200251}
252
253static void
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200254zm_flush (void)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200255{
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200256#ifdef REDBOOT
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200257 char *p = zm_out_start;
258 while (*p)
259 mon_write_char (*p++);
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200260#endif
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200261 zm_out = zm_out_start;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200262}
263#endif
264
265static void
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200266zm_dump_buf (void *buf, int len)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200267{
268#ifdef REDBOOT
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200269 diag_vdump_buf_with_offset (zm_dprintf, buf, len, 0);
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200270#else
271
272#endif
273}
274
275static unsigned char zm_buf[2048];
276static unsigned char *zm_bp;
277
278static void
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200279zm_new (void)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200280{
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200281 zm_bp = zm_buf;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200282}
283
284static void
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200285zm_save (unsigned char c)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200286{
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200287 *zm_bp++ = c;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200288}
289
290static void
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200291zm_dump (int line)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200292{
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200293 zm_dprintf ("Packet at line: %d\n", line);
294 zm_dump_buf (zm_buf, zm_bp - zm_buf);
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200295}
296
297#define ZM_DEBUG(x) x
298#else
299#define ZM_DEBUG(x)
300#endif
301
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200302/* Wait for the line to go idle */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200303static void
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200304xyzModem_flush (void)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200305{
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200306 int res;
307 char c;
308 while (true)
309 {
310 res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, &c);
311 if (!res)
312 return;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200313 }
314}
315
316static int
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200317xyzModem_get_hdr (void)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200318{
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200319 char c;
320 int res;
321 bool hdr_found = false;
322 int i, can_total, hdr_chars;
323 unsigned short cksum;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200324
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200325 ZM_DEBUG (zm_new ());
326 /* Find the start of a header */
327 can_total = 0;
328 hdr_chars = 0;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200329
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200330 if (xyz.tx_ack)
331 {
332 CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
333 xyz.tx_ack = false;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200334 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200335 while (!hdr_found)
336 {
337 res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, &c);
338 ZM_DEBUG (zm_save (c));
339 if (res)
340 {
341 hdr_chars++;
342 switch (c)
343 {
344 case SOH:
345 xyz.total_SOH++;
346 case STX:
347 if (c == STX)
348 xyz.total_STX++;
349 hdr_found = true;
350 break;
351 case CAN:
352 xyz.total_CAN++;
353 ZM_DEBUG (zm_dump (__LINE__));
354 if (++can_total == xyzModem_CAN_COUNT)
355 {
356 return xyzModem_cancel;
357 }
358 else
359 {
360 /* Wait for multiple CAN to avoid early quits */
361 break;
362 }
363 case EOT:
364 /* EOT only supported if no noise */
365 if (hdr_chars == 1)
366 {
367 CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
368 ZM_DEBUG (zm_dprintf ("ACK on EOT #%d\n", __LINE__));
369 ZM_DEBUG (zm_dump (__LINE__));
370 return xyzModem_eof;
371 }
372 default:
373 /* Ignore, waiting for start of header */
374 ;
375 }
376 }
377 else
378 {
379 /* Data stream timed out */
380 xyzModem_flush (); /* Toss any current input */
381 ZM_DEBUG (zm_dump (__LINE__));
382 CYGACC_CALL_IF_DELAY_US ((cyg_int32) 250000);
383 return xyzModem_timeout;
384 }
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200385 }
386
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200387 /* Header found, now read the data */
388 res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, (char *) &xyz.blk);
389 ZM_DEBUG (zm_save (xyz.blk));
390 if (!res)
391 {
392 ZM_DEBUG (zm_dump (__LINE__));
393 return xyzModem_timeout;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200394 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200395 res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, (char *) &xyz.cblk);
396 ZM_DEBUG (zm_save (xyz.cblk));
397 if (!res)
398 {
399 ZM_DEBUG (zm_dump (__LINE__));
400 return xyzModem_timeout;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200401 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200402 xyz.len = (c == SOH) ? 128 : 1024;
403 xyz.bufp = xyz.pkt;
404 for (i = 0; i < xyz.len; i++)
405 {
406 res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, &c);
407 ZM_DEBUG (zm_save (c));
408 if (res)
409 {
410 xyz.pkt[i] = c;
411 }
412 else
413 {
414 ZM_DEBUG (zm_dump (__LINE__));
415 return xyzModem_timeout;
416 }
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200417 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200418 res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, (char *) &xyz.crc1);
419 ZM_DEBUG (zm_save (xyz.crc1));
420 if (!res)
421 {
422 ZM_DEBUG (zm_dump (__LINE__));
423 return xyzModem_timeout;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200424 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200425 if (xyz.crc_mode)
426 {
427 res = CYGACC_COMM_IF_GETC_TIMEOUT (*xyz.__chan, (char *) &xyz.crc2);
428 ZM_DEBUG (zm_save (xyz.crc2));
429 if (!res)
430 {
431 ZM_DEBUG (zm_dump (__LINE__));
432 return xyzModem_timeout;
433 }
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200434 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200435 ZM_DEBUG (zm_dump (__LINE__));
436 /* Validate the message */
437 if ((xyz.blk ^ xyz.cblk) != (unsigned char) 0xFF)
438 {
439 ZM_DEBUG (zm_dprintf
440 ("Framing error - blk: %x/%x/%x\n", xyz.blk, xyz.cblk,
441 (xyz.blk ^ xyz.cblk)));
442 ZM_DEBUG (zm_dump_buf (xyz.pkt, xyz.len));
443 xyzModem_flush ();
444 return xyzModem_frame;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200445 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200446 /* Verify checksum/CRC */
447 if (xyz.crc_mode)
448 {
449 cksum = cyg_crc16 (xyz.pkt, xyz.len);
450 if (cksum != ((xyz.crc1 << 8) | xyz.crc2))
451 {
452 ZM_DEBUG (zm_dprintf ("CRC error - recvd: %02x%02x, computed: %x\n",
453 xyz.crc1, xyz.crc2, cksum & 0xFFFF));
454 return xyzModem_cksum;
455 }
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200456 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200457 else
458 {
459 cksum = 0;
460 for (i = 0; i < xyz.len; i++)
461 {
462 cksum += xyz.pkt[i];
463 }
464 if (xyz.crc1 != (cksum & 0xFF))
465 {
466 ZM_DEBUG (zm_dprintf
467 ("Checksum error - recvd: %x, computed: %x\n", xyz.crc1,
468 cksum & 0xFF));
469 return xyzModem_cksum;
470 }
471 }
472 /* If we get here, the message passes [structural] muster */
473 return 0;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200474}
475
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200476int
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200477xyzModem_stream_open (connection_info_t * info, int *err)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200478{
Stefan Roesef90a3922006-05-10 15:01:40 +0200479#ifdef REDBOOT
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200480 int console_chan;
Stefan Roesef90a3922006-05-10 15:01:40 +0200481#endif
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200482 int stat = 0;
483 int retries = xyzModem_MAX_RETRIES;
484 int crc_retries = xyzModem_MAX_RETRIES_WITH_CRC;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200485
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200486/* ZM_DEBUG(zm_out = zm_out_start); */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200487#ifdef xyzModem_zmodem
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200488 if (info->mode == xyzModem_zmodem)
489 {
490 *err = xyzModem_noZmodem;
491 return -1;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200492 }
493#endif
494
495#ifdef REDBOOT
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200496 /* Set up the I/O channel. Note: this allows for using a different port in the future */
497 console_chan =
498 CYGACC_CALL_IF_SET_CONSOLE_COMM
499 (CYGNUM_CALL_IF_SET_COMM_ID_QUERY_CURRENT);
500 if (info->chan >= 0)
501 {
502 CYGACC_CALL_IF_SET_CONSOLE_COMM (info->chan);
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200503 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200504 else
505 {
506 CYGACC_CALL_IF_SET_CONSOLE_COMM (console_chan);
507 }
508 xyz.__chan = CYGACC_CALL_IF_CONSOLE_PROCS ();
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200509
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200510 CYGACC_CALL_IF_SET_CONSOLE_COMM (console_chan);
511 CYGACC_COMM_IF_CONTROL (*xyz.__chan, __COMMCTL_SET_TIMEOUT,
512 xyzModem_CHAR_TIMEOUT);
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200513#else
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200514/* TODO: CHECK ! */
Kim Phillips2a2ed842009-06-15 11:50:40 -0500515 int dummy = 0;
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200516 xyz.__chan = &dummy;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200517#endif
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200518 xyz.len = 0;
519 xyz.crc_mode = true;
520 xyz.at_eof = false;
521 xyz.tx_ack = false;
522 xyz.mode = info->mode;
523 xyz.total_retries = 0;
524 xyz.total_SOH = 0;
525 xyz.total_STX = 0;
526 xyz.total_CAN = 0;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200527#ifdef USE_YMODEM_LENGTH
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200528 xyz.read_length = 0;
529 xyz.file_length = 0;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200530#endif
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200531
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200532 CYGACC_COMM_IF_PUTC (*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200533
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200534 if (xyz.mode == xyzModem_xmodem)
535 {
536 /* X-modem doesn't have an information header - exit here */
537 xyz.next_blk = 1;
538 return 0;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200539 }
540
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200541 while (retries-- > 0)
542 {
543 stat = xyzModem_get_hdr ();
544 if (stat == 0)
545 {
546 /* Y-modem file information header */
547 if (xyz.blk == 0)
548 {
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200549#ifdef USE_YMODEM_LENGTH
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200550 /* skip filename */
551 while (*xyz.bufp++);
552 /* get the length */
553 parse_num ((char *) xyz.bufp, &xyz.file_length, NULL, " ");
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200554#endif
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200555 /* The rest of the file name data block quietly discarded */
556 xyz.tx_ack = true;
557 }
558 xyz.next_blk = 1;
559 xyz.len = 0;
560 return 0;
561 }
562 else if (stat == xyzModem_timeout)
563 {
564 if (--crc_retries <= 0)
565 xyz.crc_mode = false;
566 CYGACC_CALL_IF_DELAY_US (5 * 100000); /* Extra delay for startup */
567 CYGACC_COMM_IF_PUTC (*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));
568 xyz.total_retries++;
569 ZM_DEBUG (zm_dprintf ("NAK (%d)\n", __LINE__));
570 }
571 if (stat == xyzModem_cancel)
572 {
573 break;
574 }
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200575 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200576 *err = stat;
577 ZM_DEBUG (zm_flush ());
578 return -1;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200579}
580
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200581int
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200582xyzModem_stream_read (char *buf, int size, int *err)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200583{
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200584 int stat, total, len;
585 int retries;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200586
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200587 total = 0;
588 stat = xyzModem_cancel;
589 /* Try and get 'size' bytes into the buffer */
590 while (!xyz.at_eof && (size > 0))
591 {
592 if (xyz.len == 0)
593 {
594 retries = xyzModem_MAX_RETRIES;
595 while (retries-- > 0)
596 {
597 stat = xyzModem_get_hdr ();
598 if (stat == 0)
599 {
600 if (xyz.blk == xyz.next_blk)
601 {
602 xyz.tx_ack = true;
603 ZM_DEBUG (zm_dprintf
604 ("ACK block %d (%d)\n", xyz.blk, __LINE__));
605 xyz.next_blk = (xyz.next_blk + 1) & 0xFF;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200606
607#if defined(xyzModem_zmodem) || defined(USE_YMODEM_LENGTH)
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200608 if (xyz.mode == xyzModem_xmodem || xyz.file_length == 0)
609 {
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200610#else
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200611 if (1)
612 {
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200613#endif
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200614 /* Data blocks can be padded with ^Z (EOF) characters */
615 /* This code tries to detect and remove them */
616 if ((xyz.bufp[xyz.len - 1] == EOF) &&
617 (xyz.bufp[xyz.len - 2] == EOF) &&
618 (xyz.bufp[xyz.len - 3] == EOF))
619 {
620 while (xyz.len
621 && (xyz.bufp[xyz.len - 1] == EOF))
622 {
623 xyz.len--;
624 }
625 }
626 }
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200627
628#ifdef USE_YMODEM_LENGTH
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200629 /*
630 * See if accumulated length exceeds that of the file.
631 * If so, reduce size (i.e., cut out pad bytes)
632 * Only do this for Y-modem (and Z-modem should it ever
633 * be supported since it can fall back to Y-modem mode).
634 */
635 if (xyz.mode != xyzModem_xmodem && 0 != xyz.file_length)
636 {
637 xyz.read_length += xyz.len;
638 if (xyz.read_length > xyz.file_length)
639 {
640 xyz.len -= (xyz.read_length - xyz.file_length);
641 }
642 }
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200643#endif
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200644 break;
645 }
646 else if (xyz.blk == ((xyz.next_blk - 1) & 0xFF))
647 {
648 /* Just re-ACK this so sender will get on with it */
649 CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
650 continue; /* Need new header */
651 }
652 else
653 {
654 stat = xyzModem_sequence;
655 }
656 }
657 if (stat == xyzModem_cancel)
658 {
659 break;
660 }
661 if (stat == xyzModem_eof)
662 {
663 CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
664 ZM_DEBUG (zm_dprintf ("ACK (%d)\n", __LINE__));
665 if (xyz.mode == xyzModem_ymodem)
666 {
667 CYGACC_COMM_IF_PUTC (*xyz.__chan,
668 (xyz.crc_mode ? 'C' : NAK));
669 xyz.total_retries++;
670 ZM_DEBUG (zm_dprintf ("Reading Final Header\n"));
671 stat = xyzModem_get_hdr ();
672 CYGACC_COMM_IF_PUTC (*xyz.__chan, ACK);
673 ZM_DEBUG (zm_dprintf ("FINAL ACK (%d)\n", __LINE__));
674 }
675 xyz.at_eof = true;
676 break;
677 }
678 CYGACC_COMM_IF_PUTC (*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));
679 xyz.total_retries++;
680 ZM_DEBUG (zm_dprintf ("NAK (%d)\n", __LINE__));
681 }
682 if (stat < 0)
683 {
684 *err = stat;
685 xyz.len = -1;
686 return total;
687 }
688 }
689 /* Don't "read" data from the EOF protocol package */
690 if (!xyz.at_eof)
691 {
692 len = xyz.len;
693 if (size < len)
694 len = size;
695 memcpy (buf, xyz.bufp, len);
696 size -= len;
697 buf += len;
698 total += len;
699 xyz.len -= len;
700 xyz.bufp += len;
701 }
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200702 }
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200703 return total;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200704}
705
706void
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200707xyzModem_stream_close (int *err)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200708{
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200709 diag_printf
710 ("xyzModem - %s mode, %d(SOH)/%d(STX)/%d(CAN) packets, %d retries\n",
711 xyz.crc_mode ? "CRC" : "Cksum", xyz.total_SOH, xyz.total_STX,
712 xyz.total_CAN, xyz.total_retries);
713 ZM_DEBUG (zm_flush ());
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200714}
715
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200716/* Need to be able to clean out the input buffer, so have to take the */
717/* getc */
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200718void
719xyzModem_stream_terminate (bool abort, int (*getc) (void))
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200720{
721 int c;
722
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200723 if (abort)
724 {
725 ZM_DEBUG (zm_dprintf ("!!!! TRANSFER ABORT !!!!\n"));
726 switch (xyz.mode)
727 {
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200728 case xyzModem_xmodem:
729 case xyzModem_ymodem:
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200730 /* The X/YMODEM Spec seems to suggest that multiple CAN followed by an equal */
731 /* number of Backspaces is a friendly way to get the other end to abort. */
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200732 CYGACC_COMM_IF_PUTC (*xyz.__chan, CAN);
733 CYGACC_COMM_IF_PUTC (*xyz.__chan, CAN);
734 CYGACC_COMM_IF_PUTC (*xyz.__chan, CAN);
735 CYGACC_COMM_IF_PUTC (*xyz.__chan, CAN);
736 CYGACC_COMM_IF_PUTC (*xyz.__chan, BSP);
737 CYGACC_COMM_IF_PUTC (*xyz.__chan, BSP);
738 CYGACC_COMM_IF_PUTC (*xyz.__chan, BSP);
739 CYGACC_COMM_IF_PUTC (*xyz.__chan, BSP);
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200740 /* Now consume the rest of what's waiting on the line. */
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200741 ZM_DEBUG (zm_dprintf ("Flushing serial line.\n"));
742 xyzModem_flush ();
743 xyz.at_eof = true;
744 break;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200745#ifdef xyzModem_zmodem
746 case xyzModem_zmodem:
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200747 /* Might support it some day I suppose. */
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200748#endif
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200749 break;
750 }
751 }
752 else
753 {
754 ZM_DEBUG (zm_dprintf ("Engaging cleanup mode...\n"));
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200755 /*
756 * Consume any trailing crap left in the inbuffer from
Mike Williams16263082011-07-22 04:01:30 +0000757 * previous received blocks. Since very few files are an exact multiple
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200758 * of the transfer block size, there will almost always be some gunk here.
759 * If we don't eat it now, RedBoot will think the user typed it.
760 */
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200761 ZM_DEBUG (zm_dprintf ("Trailing gunk:\n"));
Jeroen Hofsteee153b132014-06-11 01:04:42 +0200762 while ((c = (*getc) ()) > -1)
763 ;
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200764 ZM_DEBUG (zm_dprintf ("\n"));
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200765 /*
766 * Make a small delay to give terminal programs like minicom
767 * time to get control again after their file transfer program
768 * exits.
769 */
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200770 CYGACC_CALL_IF_DELAY_US ((cyg_int32) 250000);
771 }
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200772}
773
774char *
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200775xyzModem_error (int err)
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200776{
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200777 switch (err)
778 {
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200779 case xyzModem_access:
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200780 return "Can't access file";
781 break;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200782 case xyzModem_noZmodem:
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200783 return "Sorry, zModem not available yet";
784 break;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200785 case xyzModem_timeout:
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200786 return "Timed out";
787 break;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200788 case xyzModem_eof:
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200789 return "End of file";
790 break;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200791 case xyzModem_cancel:
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200792 return "Cancelled";
793 break;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200794 case xyzModem_frame:
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200795 return "Invalid framing";
796 break;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200797 case xyzModem_cksum:
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200798 return "CRC/checksum error";
799 break;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200800 case xyzModem_sequence:
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200801 return "Block sequence error";
802 break;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200803 default:
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200804 return "Unknown error";
805 break;
Markus Klotzbuecherf2841d32006-03-30 13:40:55 +0200806 }
807}
808
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200809/*
810 * RedBoot interface
811 */
Wolfgang Denk7d0432c2006-08-31 16:46:53 +0200812#if 0 /* SB */
813GETC_IO_FUNCS (xyzModem_io, xyzModem_stream_open, xyzModem_stream_close,
814 xyzModem_stream_terminate, xyzModem_stream_read,
815 xyzModem_error);
816RedBoot_load (xmodem, xyzModem_io, false, false, xyzModem_xmodem);
817RedBoot_load (ymodem, xyzModem_io, false, false, xyzModem_ymodem);
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200818#endif