//==========================================================================
|
//==========================================================================
|
//
|
//
|
// xyzModem.c
|
// xyzModem.c
|
//
|
//
|
// RedBoot stream handler for xyzModem protocol
|
// RedBoot stream handler for xyzModem protocol
|
//
|
//
|
//==========================================================================
|
//==========================================================================
|
//####ECOSGPLCOPYRIGHTBEGIN####
|
//####ECOSGPLCOPYRIGHTBEGIN####
|
// -------------------------------------------
|
// -------------------------------------------
|
// This file is part of eCos, the Embedded Configurable Operating System.
|
// This file is part of eCos, the Embedded Configurable Operating System.
|
// Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
|
// Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
|
// Copyright (C) 2002 Gary Thomas
|
// Copyright (C) 2002 Gary Thomas
|
//
|
//
|
// eCos is free software; you can redistribute it and/or modify it under
|
// eCos is free software; you can redistribute it and/or modify it under
|
// the terms of the GNU General Public License as published by the Free
|
// the terms of the GNU General Public License as published by the Free
|
// Software Foundation; either version 2 or (at your option) any later version.
|
// Software Foundation; either version 2 or (at your option) any later version.
|
//
|
//
|
// eCos is distributed in the hope that it will be useful, but WITHOUT ANY
|
// eCos is distributed in the hope that it will be useful, but WITHOUT ANY
|
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
// for more details.
|
// for more details.
|
//
|
//
|
// You should have received a copy of the GNU General Public License along
|
// You should have received a copy of the GNU General Public License along
|
// with eCos; if not, write to the Free Software Foundation, Inc.,
|
// with eCos; if not, write to the Free Software Foundation, Inc.,
|
// 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
|
// 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
|
//
|
//
|
// As a special exception, if other files instantiate templates or use macros
|
// As a special exception, if other files instantiate templates or use macros
|
// or inline functions from this file, or you compile this file and link it
|
// or inline functions from this file, or you compile this file and link it
|
// with other works to produce a work based on this file, this file does not
|
// with other works to produce a work based on this file, this file does not
|
// by itself cause the resulting work to be covered by the GNU General Public
|
// by itself cause the resulting work to be covered by the GNU General Public
|
// License. However the source code for this file must still be made available
|
// License. However the source code for this file must still be made available
|
// in accordance with section (3) of the GNU General Public License.
|
// in accordance with section (3) of the GNU General Public License.
|
//
|
//
|
// This exception does not invalidate any other reasons why a work based on
|
// This exception does not invalidate any other reasons why a work based on
|
// this file might be covered by the GNU General Public License.
|
// this file might be covered by the GNU General Public License.
|
//
|
//
|
// Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
|
// Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
|
// at http://sources.redhat.com/ecos/ecos-license/
|
// at http://sources.redhat.com/ecos/ecos-license/
|
// -------------------------------------------
|
// -------------------------------------------
|
//####ECOSGPLCOPYRIGHTEND####
|
//####ECOSGPLCOPYRIGHTEND####
|
//==========================================================================
|
//==========================================================================
|
//#####DESCRIPTIONBEGIN####
|
//#####DESCRIPTIONBEGIN####
|
//
|
//
|
// Author(s): gthomas
|
// Author(s): gthomas
|
// Contributors: gthomas, tsmith, Yoshinori Sato
|
// Contributors: gthomas, tsmith, Yoshinori Sato
|
// Date: 2000-07-14
|
// Date: 2000-07-14
|
// Purpose:
|
// Purpose:
|
// Description:
|
// Description:
|
//
|
//
|
// This code is part of RedBoot (tm).
|
// This code is part of RedBoot (tm).
|
//
|
//
|
//####DESCRIPTIONEND####
|
//####DESCRIPTIONEND####
|
//
|
//
|
//==========================================================================
|
//==========================================================================
|
|
|
#include <redboot.h>
|
#include <redboot.h>
|
#include <xyzModem.h>
|
#include <xyzModem.h>
|
|
|
// Assumption - run xyzModem protocol over the console port
|
// Assumption - run xyzModem protocol over the console port
|
|
|
// Values magic to the protocol
|
// Values magic to the protocol
|
#define SOH 0x01
|
#define SOH 0x01
|
#define STX 0x02
|
#define STX 0x02
|
#define EOT 0x04
|
#define EOT 0x04
|
#define ACK 0x06
|
#define ACK 0x06
|
#define BSP 0x08
|
#define BSP 0x08
|
#define NAK 0x15
|
#define NAK 0x15
|
#define CAN 0x18
|
#define CAN 0x18
|
#define EOF 0x1A // ^Z for DOS officionados
|
#define EOF 0x1A // ^Z for DOS officionados
|
|
|
#define nUSE_YMODEM_LENGTH
|
#define nUSE_YMODEM_LENGTH
|
|
|
// Data & state local to the protocol
|
// Data & state local to the protocol
|
static struct {
|
static struct {
|
hal_virtual_comm_table_t* __chan;
|
hal_virtual_comm_table_t* __chan;
|
unsigned char pkt[1024], *bufp;
|
unsigned char pkt[1024], *bufp;
|
unsigned char blk,cblk,crc1,crc2;
|
unsigned char blk,cblk,crc1,crc2;
|
unsigned char next_blk; // Expected block
|
unsigned char next_blk; // Expected block
|
int len, mode, total_retries;
|
int len, mode, total_retries;
|
int total_SOH, total_STX, total_CAN;
|
int total_SOH, total_STX, total_CAN;
|
bool crc_mode, at_eof, tx_ack;
|
bool crc_mode, at_eof, tx_ack;
|
#ifdef USE_YMODEM_LENGTH
|
#ifdef USE_YMODEM_LENGTH
|
unsigned long file_length, read_length;
|
unsigned long file_length, read_length;
|
#endif
|
#endif
|
} xyz;
|
} xyz;
|
|
|
#define xyzModem_CHAR_TIMEOUT 2000 // 2 seconds
|
#define xyzModem_CHAR_TIMEOUT 2000 // 2 seconds
|
#define xyzModem_MAX_RETRIES 20
|
#define xyzModem_MAX_RETRIES 20
|
#define xyzModem_MAX_RETRIES_WITH_CRC 10
|
#define xyzModem_MAX_RETRIES_WITH_CRC 10
|
#define xyzModem_CAN_COUNT 3 // Wait for 3 CAN before quitting
|
#define xyzModem_CAN_COUNT 3 // Wait for 3 CAN before quitting
|
|
|
#ifdef DEBUG
|
#ifdef DEBUG
|
#ifndef USE_SPRINTF
|
#ifndef USE_SPRINTF
|
//
|
//
|
// Note: this debug setup only works if the target platform has two serial ports
|
// Note: this debug setup only works if the target platform has two serial ports
|
// available so that the other one (currently only port 1) can be used for debug
|
// available so that the other one (currently only port 1) can be used for debug
|
// messages.
|
// messages.
|
//
|
//
|
static int
|
static int
|
zm_dprintf(char *fmt, ...)
|
zm_dprintf(char *fmt, ...)
|
{
|
{
|
int cur_console;
|
int cur_console;
|
va_list args;
|
va_list args;
|
|
|
va_start(args, fmt);
|
va_start(args, fmt);
|
cur_console = CYGACC_CALL_IF_SET_CONSOLE_COMM(CYGNUM_CALL_IF_SET_COMM_ID_QUERY_CURRENT);
|
cur_console = CYGACC_CALL_IF_SET_CONSOLE_COMM(CYGNUM_CALL_IF_SET_COMM_ID_QUERY_CURRENT);
|
CYGACC_CALL_IF_SET_CONSOLE_COMM(1);
|
CYGACC_CALL_IF_SET_CONSOLE_COMM(1);
|
diag_vprintf(fmt, args);
|
diag_vprintf(fmt, args);
|
CYGACC_CALL_IF_SET_CONSOLE_COMM(cur_console);
|
CYGACC_CALL_IF_SET_CONSOLE_COMM(cur_console);
|
}
|
}
|
|
|
static void
|
static void
|
zm_flush(void)
|
zm_flush(void)
|
{
|
{
|
}
|
}
|
|
|
#else
|
#else
|
//
|
//
|
// Note: this debug setup works by storing the strings in a fixed buffer
|
// Note: this debug setup works by storing the strings in a fixed buffer
|
//
|
//
|
static char *zm_out = (char *)0x00380000;
|
static char *zm_out = (char *)0x00380000;
|
static char *zm_out_start = (char *)0x00380000;
|
static char *zm_out_start = (char *)0x00380000;
|
|
|
static int
|
static int
|
zm_dprintf(char *fmt, ...)
|
zm_dprintf(char *fmt, ...)
|
{
|
{
|
int len;
|
int len;
|
va_list args;
|
va_list args;
|
|
|
va_start(args, fmt);
|
va_start(args, fmt);
|
len = diag_vsprintf(zm_out, fmt, args);
|
len = diag_vsprintf(zm_out, fmt, args);
|
zm_out += len;
|
zm_out += len;
|
return len;
|
return len;
|
}
|
}
|
|
|
static void
|
static void
|
zm_flush(void)
|
zm_flush(void)
|
{
|
{
|
char *p = zm_out_start;
|
char *p = zm_out_start;
|
while (*p) mon_write_char(*p++);
|
while (*p) mon_write_char(*p++);
|
zm_out = zm_out_start;
|
zm_out = zm_out_start;
|
}
|
}
|
#endif
|
#endif
|
|
|
static void
|
static void
|
zm_dump_buf(void *buf, int len)
|
zm_dump_buf(void *buf, int len)
|
{
|
{
|
diag_vdump_buf_with_offset(zm_dprintf, buf, len, 0);
|
diag_vdump_buf_with_offset(zm_dprintf, buf, len, 0);
|
}
|
}
|
|
|
static unsigned char zm_buf[2048];
|
static unsigned char zm_buf[2048];
|
static unsigned char *zm_bp;
|
static unsigned char *zm_bp;
|
|
|
static void
|
static void
|
zm_new(void)
|
zm_new(void)
|
{
|
{
|
zm_bp = zm_buf;
|
zm_bp = zm_buf;
|
}
|
}
|
|
|
static void
|
static void
|
zm_save(unsigned char c)
|
zm_save(unsigned char c)
|
{
|
{
|
*zm_bp++ = c;
|
*zm_bp++ = c;
|
}
|
}
|
|
|
static void
|
static void
|
zm_dump(int line)
|
zm_dump(int line)
|
{
|
{
|
zm_dprintf("Packet at line: %d\n", line);
|
zm_dprintf("Packet at line: %d\n", line);
|
zm_dump_buf(zm_buf, zm_bp-zm_buf);
|
zm_dump_buf(zm_buf, zm_bp-zm_buf);
|
}
|
}
|
|
|
#define ZM_DEBUG(x) x
|
#define ZM_DEBUG(x) x
|
#else
|
#else
|
#define ZM_DEBUG(x)
|
#define ZM_DEBUG(x)
|
#endif
|
#endif
|
|
|
// Wait for the line to go idle
|
// Wait for the line to go idle
|
static void
|
static void
|
xyzModem_flush(void)
|
xyzModem_flush(void)
|
{
|
{
|
int res;
|
int res;
|
char c;
|
char c;
|
while (true) {
|
while (true) {
|
res = CYGACC_COMM_IF_GETC_TIMEOUT(*xyz.__chan, &c);
|
res = CYGACC_COMM_IF_GETC_TIMEOUT(*xyz.__chan, &c);
|
if (!res) return;
|
if (!res) return;
|
}
|
}
|
}
|
}
|
|
|
static int
|
static int
|
xyzModem_get_hdr(void)
|
xyzModem_get_hdr(void)
|
{
|
{
|
char c;
|
char c;
|
int res;
|
int res;
|
bool hdr_found = false;
|
bool hdr_found = false;
|
int i, can_total, hdr_chars;
|
int i, can_total, hdr_chars;
|
unsigned short cksum;
|
unsigned short cksum;
|
|
|
ZM_DEBUG(zm_new());
|
ZM_DEBUG(zm_new());
|
// Find the start of a header
|
// Find the start of a header
|
can_total = 0;
|
can_total = 0;
|
hdr_chars = 0;
|
hdr_chars = 0;
|
|
|
if (xyz.tx_ack) {
|
if (xyz.tx_ack) {
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, ACK);
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, ACK);
|
xyz.tx_ack = false;
|
xyz.tx_ack = false;
|
}
|
}
|
while (!hdr_found) {
|
while (!hdr_found) {
|
res = CYGACC_COMM_IF_GETC_TIMEOUT(*xyz.__chan, &c);
|
res = CYGACC_COMM_IF_GETC_TIMEOUT(*xyz.__chan, &c);
|
ZM_DEBUG(zm_save(c));
|
ZM_DEBUG(zm_save(c));
|
if (res) {
|
if (res) {
|
hdr_chars++;
|
hdr_chars++;
|
switch (c) {
|
switch (c) {
|
case SOH:
|
case SOH:
|
xyz.total_SOH++;
|
xyz.total_SOH++;
|
case STX:
|
case STX:
|
if (c == STX) xyz.total_STX++;
|
if (c == STX) xyz.total_STX++;
|
hdr_found = true;
|
hdr_found = true;
|
break;
|
break;
|
case CAN:
|
case CAN:
|
xyz.total_CAN++;
|
xyz.total_CAN++;
|
ZM_DEBUG(zm_dump(__LINE__));
|
ZM_DEBUG(zm_dump(__LINE__));
|
if (++can_total == xyzModem_CAN_COUNT) {
|
if (++can_total == xyzModem_CAN_COUNT) {
|
return xyzModem_cancel;
|
return xyzModem_cancel;
|
} else {
|
} else {
|
// Wait for multiple CAN to avoid early quits
|
// Wait for multiple CAN to avoid early quits
|
break;
|
break;
|
}
|
}
|
case EOT:
|
case EOT:
|
// EOT only supported if no noise
|
// EOT only supported if no noise
|
if (hdr_chars == 1) {
|
if (hdr_chars == 1) {
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, ACK);
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, ACK);
|
ZM_DEBUG(zm_dprintf("ACK on EOT #%d\n", __LINE__));
|
ZM_DEBUG(zm_dprintf("ACK on EOT #%d\n", __LINE__));
|
ZM_DEBUG(zm_dump(__LINE__));
|
ZM_DEBUG(zm_dump(__LINE__));
|
return xyzModem_eof;
|
return xyzModem_eof;
|
}
|
}
|
default:
|
default:
|
// Ignore, waiting for start of header
|
// Ignore, waiting for start of header
|
;
|
;
|
}
|
}
|
} else {
|
} else {
|
// Data stream timed out
|
// Data stream timed out
|
xyzModem_flush(); // Toss any current input
|
xyzModem_flush(); // Toss any current input
|
ZM_DEBUG(zm_dump(__LINE__));
|
ZM_DEBUG(zm_dump(__LINE__));
|
CYGACC_CALL_IF_DELAY_US((cyg_int32)250000);
|
CYGACC_CALL_IF_DELAY_US((cyg_int32)250000);
|
return xyzModem_timeout;
|
return xyzModem_timeout;
|
}
|
}
|
}
|
}
|
|
|
// Header found, now read the data
|
// Header found, now read the data
|
res = CYGACC_COMM_IF_GETC_TIMEOUT(*xyz.__chan, &xyz.blk);
|
res = CYGACC_COMM_IF_GETC_TIMEOUT(*xyz.__chan, &xyz.blk);
|
ZM_DEBUG(zm_save(xyz.blk));
|
ZM_DEBUG(zm_save(xyz.blk));
|
if (!res) {
|
if (!res) {
|
ZM_DEBUG(zm_dump(__LINE__));
|
ZM_DEBUG(zm_dump(__LINE__));
|
return xyzModem_timeout;
|
return xyzModem_timeout;
|
}
|
}
|
res = CYGACC_COMM_IF_GETC_TIMEOUT(*xyz.__chan, &xyz.cblk);
|
res = CYGACC_COMM_IF_GETC_TIMEOUT(*xyz.__chan, &xyz.cblk);
|
ZM_DEBUG(zm_save(xyz.cblk));
|
ZM_DEBUG(zm_save(xyz.cblk));
|
if (!res) {
|
if (!res) {
|
ZM_DEBUG(zm_dump(__LINE__));
|
ZM_DEBUG(zm_dump(__LINE__));
|
return xyzModem_timeout;
|
return xyzModem_timeout;
|
}
|
}
|
xyz.len = (c == SOH) ? 128 : 1024;
|
xyz.len = (c == SOH) ? 128 : 1024;
|
xyz.bufp = xyz.pkt;
|
xyz.bufp = xyz.pkt;
|
for (i = 0; i < xyz.len; i++) {
|
for (i = 0; i < xyz.len; i++) {
|
res = CYGACC_COMM_IF_GETC_TIMEOUT(*xyz.__chan, &c);
|
res = CYGACC_COMM_IF_GETC_TIMEOUT(*xyz.__chan, &c);
|
ZM_DEBUG(zm_save(c));
|
ZM_DEBUG(zm_save(c));
|
if (res) {
|
if (res) {
|
xyz.pkt[i] = c;
|
xyz.pkt[i] = c;
|
} else {
|
} else {
|
ZM_DEBUG(zm_dump(__LINE__));
|
ZM_DEBUG(zm_dump(__LINE__));
|
return xyzModem_timeout;
|
return xyzModem_timeout;
|
}
|
}
|
}
|
}
|
res = CYGACC_COMM_IF_GETC_TIMEOUT(*xyz.__chan, &xyz.crc1);
|
res = CYGACC_COMM_IF_GETC_TIMEOUT(*xyz.__chan, &xyz.crc1);
|
ZM_DEBUG(zm_save(xyz.crc1));
|
ZM_DEBUG(zm_save(xyz.crc1));
|
if (!res) {
|
if (!res) {
|
ZM_DEBUG(zm_dump(__LINE__));
|
ZM_DEBUG(zm_dump(__LINE__));
|
return xyzModem_timeout;
|
return xyzModem_timeout;
|
}
|
}
|
if (xyz.crc_mode) {
|
if (xyz.crc_mode) {
|
res = CYGACC_COMM_IF_GETC_TIMEOUT(*xyz.__chan, &xyz.crc2);
|
res = CYGACC_COMM_IF_GETC_TIMEOUT(*xyz.__chan, &xyz.crc2);
|
ZM_DEBUG(zm_save(xyz.crc2));
|
ZM_DEBUG(zm_save(xyz.crc2));
|
if (!res) {
|
if (!res) {
|
ZM_DEBUG(zm_dump(__LINE__));
|
ZM_DEBUG(zm_dump(__LINE__));
|
return xyzModem_timeout;
|
return xyzModem_timeout;
|
}
|
}
|
}
|
}
|
ZM_DEBUG(zm_dump(__LINE__));
|
ZM_DEBUG(zm_dump(__LINE__));
|
// Validate the message
|
// Validate the message
|
if ((xyz.blk ^ xyz.cblk) != (unsigned char)0xFF) {
|
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_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));
|
ZM_DEBUG(zm_dump_buf(xyz.pkt, xyz.len));
|
xyzModem_flush();
|
xyzModem_flush();
|
return xyzModem_frame;
|
return xyzModem_frame;
|
}
|
}
|
// Verify checksum/CRC
|
// Verify checksum/CRC
|
if (xyz.crc_mode) {
|
if (xyz.crc_mode) {
|
cksum = cyg_crc16(xyz.pkt, xyz.len);
|
cksum = cyg_crc16(xyz.pkt, xyz.len);
|
if (cksum != ((xyz.crc1 << 8) | xyz.crc2)) {
|
if (cksum != ((xyz.crc1 << 8) | xyz.crc2)) {
|
ZM_DEBUG(zm_dprintf("CRC error - recvd: %02x%02x, computed: %x\n",
|
ZM_DEBUG(zm_dprintf("CRC error - recvd: %02x%02x, computed: %x\n",
|
xyz.crc1, xyz.crc2, cksum & 0xFFFF));
|
xyz.crc1, xyz.crc2, cksum & 0xFFFF));
|
return xyzModem_cksum;
|
return xyzModem_cksum;
|
}
|
}
|
} else {
|
} else {
|
cksum = 0;
|
cksum = 0;
|
for (i = 0; i < xyz.len; i++) {
|
for (i = 0; i < xyz.len; i++) {
|
cksum += xyz.pkt[i];
|
cksum += xyz.pkt[i];
|
}
|
}
|
if (xyz.crc1 != (cksum & 0xFF)) {
|
if (xyz.crc1 != (cksum & 0xFF)) {
|
ZM_DEBUG(zm_dprintf("Checksum error - recvd: %x, computed: %x\n", xyz.crc1, cksum & 0xFF));
|
ZM_DEBUG(zm_dprintf("Checksum error - recvd: %x, computed: %x\n", xyz.crc1, cksum & 0xFF));
|
return xyzModem_cksum;
|
return xyzModem_cksum;
|
}
|
}
|
}
|
}
|
// If we get here, the message passes [structural] muster
|
// If we get here, the message passes [structural] muster
|
return 0;
|
return 0;
|
}
|
}
|
|
|
int
|
int
|
xyzModem_stream_open(connection_info_t *info, int *err)
|
xyzModem_stream_open(connection_info_t *info, int *err)
|
{
|
{
|
int console_chan, stat;
|
int console_chan, stat;
|
int retries = xyzModem_MAX_RETRIES;
|
int retries = xyzModem_MAX_RETRIES;
|
int crc_retries = xyzModem_MAX_RETRIES_WITH_CRC;
|
int crc_retries = xyzModem_MAX_RETRIES_WITH_CRC;
|
|
|
// ZM_DEBUG(zm_out = zm_out_start);
|
// ZM_DEBUG(zm_out = zm_out_start);
|
#ifdef xyzModem_zmodem
|
#ifdef xyzModem_zmodem
|
if (info->mode == xyzModem_zmodem) {
|
if (info->mode == xyzModem_zmodem) {
|
*err = xyzModem_noZmodem;
|
*err = xyzModem_noZmodem;
|
return -1;
|
return -1;
|
}
|
}
|
#endif
|
#endif
|
|
|
// Set up the I/O channel. Note: this allows for using a different port in the future
|
// Set up the I/O channel. Note: this allows for using a different port in the future
|
console_chan = CYGACC_CALL_IF_SET_CONSOLE_COMM(CYGNUM_CALL_IF_SET_COMM_ID_QUERY_CURRENT);
|
console_chan = CYGACC_CALL_IF_SET_CONSOLE_COMM(CYGNUM_CALL_IF_SET_COMM_ID_QUERY_CURRENT);
|
if (info->chan >= 0) {
|
if (info->chan >= 0) {
|
CYGACC_CALL_IF_SET_CONSOLE_COMM(info->chan);
|
CYGACC_CALL_IF_SET_CONSOLE_COMM(info->chan);
|
} else {
|
} else {
|
CYGACC_CALL_IF_SET_CONSOLE_COMM(console_chan);
|
CYGACC_CALL_IF_SET_CONSOLE_COMM(console_chan);
|
}
|
}
|
xyz.__chan = CYGACC_CALL_IF_CONSOLE_PROCS();
|
xyz.__chan = CYGACC_CALL_IF_CONSOLE_PROCS();
|
CYGACC_CALL_IF_SET_CONSOLE_COMM(console_chan);
|
CYGACC_CALL_IF_SET_CONSOLE_COMM(console_chan);
|
CYGACC_COMM_IF_CONTROL(*xyz.__chan, __COMMCTL_SET_TIMEOUT, xyzModem_CHAR_TIMEOUT);
|
CYGACC_COMM_IF_CONTROL(*xyz.__chan, __COMMCTL_SET_TIMEOUT, xyzModem_CHAR_TIMEOUT);
|
xyz.len = 0;
|
xyz.len = 0;
|
xyz.crc_mode = true;
|
xyz.crc_mode = true;
|
xyz.at_eof = false;
|
xyz.at_eof = false;
|
xyz.tx_ack = false;
|
xyz.tx_ack = false;
|
xyz.mode = info->mode;
|
xyz.mode = info->mode;
|
xyz.total_retries = 0;
|
xyz.total_retries = 0;
|
xyz.total_SOH = 0;
|
xyz.total_SOH = 0;
|
xyz.total_STX = 0;
|
xyz.total_STX = 0;
|
xyz.total_CAN = 0;
|
xyz.total_CAN = 0;
|
#ifdef USE_YMODEM_LENGTH
|
#ifdef USE_YMODEM_LENGTH
|
xyz.read_length = 0;
|
xyz.read_length = 0;
|
xyz.file_length = 0;
|
xyz.file_length = 0;
|
#endif
|
#endif
|
|
|
while (retries-- > 0) {
|
while (retries-- > 0) {
|
stat = xyzModem_get_hdr();
|
stat = xyzModem_get_hdr();
|
if (stat == 0) {
|
if (stat == 0) {
|
// Y-modem file information header
|
// Y-modem file information header
|
if (xyz.blk == 0) {
|
if (xyz.blk == 0) {
|
#ifdef USE_YMODEM_LENGTH
|
#ifdef USE_YMODEM_LENGTH
|
// skip filename
|
// skip filename
|
while (*xyz.bufp++);
|
while (*xyz.bufp++);
|
// get the length
|
// get the length
|
parse_num(xyz.bufp, &xyz.file_length, NULL, " ");
|
parse_num(xyz.bufp, &xyz.file_length, NULL, " ");
|
#endif
|
#endif
|
// The rest of the file name data block quietly discarded
|
// The rest of the file name data block quietly discarded
|
xyz.tx_ack = true;
|
xyz.tx_ack = true;
|
}
|
}
|
xyz.next_blk = 1;
|
xyz.next_blk = 1;
|
xyz.len = 0;
|
xyz.len = 0;
|
return 0;
|
return 0;
|
} else
|
} else
|
if (stat == xyzModem_timeout) {
|
if (stat == xyzModem_timeout) {
|
if (--crc_retries <= 0) xyz.crc_mode = false;
|
if (--crc_retries <= 0) xyz.crc_mode = false;
|
CYGACC_CALL_IF_DELAY_US(5*100000); // Extra delay for startup
|
CYGACC_CALL_IF_DELAY_US(5*100000); // Extra delay for startup
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));
|
xyz.total_retries++;
|
xyz.total_retries++;
|
ZM_DEBUG(zm_dprintf("NAK (%d)\n", __LINE__));
|
ZM_DEBUG(zm_dprintf("NAK (%d)\n", __LINE__));
|
}
|
}
|
if (stat == xyzModem_cancel) {
|
if (stat == xyzModem_cancel) {
|
break;
|
break;
|
}
|
}
|
}
|
}
|
*err = stat;
|
*err = stat;
|
ZM_DEBUG(zm_flush());
|
ZM_DEBUG(zm_flush());
|
return -1;
|
return -1;
|
}
|
}
|
|
|
int
|
int
|
xyzModem_stream_read(char *buf, int size, int *err)
|
xyzModem_stream_read(char *buf, int size, int *err)
|
{
|
{
|
int stat, total, len;
|
int stat, total, len;
|
int retries;
|
int retries;
|
|
|
total = 0;
|
total = 0;
|
stat = xyzModem_cancel;
|
stat = xyzModem_cancel;
|
// Try and get 'size' bytes into the buffer
|
// Try and get 'size' bytes into the buffer
|
while (!xyz.at_eof && (size > 0)) {
|
while (!xyz.at_eof && (size > 0)) {
|
if (xyz.len == 0) {
|
if (xyz.len == 0) {
|
retries = xyzModem_MAX_RETRIES;
|
retries = xyzModem_MAX_RETRIES;
|
while (retries-- > 0) {
|
while (retries-- > 0) {
|
stat = xyzModem_get_hdr();
|
stat = xyzModem_get_hdr();
|
if (stat == 0) {
|
if (stat == 0) {
|
if (xyz.blk == xyz.next_blk) {
|
if (xyz.blk == xyz.next_blk) {
|
xyz.tx_ack = true;
|
xyz.tx_ack = true;
|
ZM_DEBUG(zm_dprintf("ACK block %d (%d)\n", xyz.blk, __LINE__));
|
ZM_DEBUG(zm_dprintf("ACK block %d (%d)\n", xyz.blk, __LINE__));
|
xyz.next_blk = (xyz.next_blk + 1) & 0xFF;
|
xyz.next_blk = (xyz.next_blk + 1) & 0xFF;
|
// Data blocks can be padded with ^Z (EOF) characters
|
// Data blocks can be padded with ^Z (EOF) characters
|
// This code tries to detect and remove them
|
// This code tries to detect and remove them
|
#ifdef xyzModem_zmodem
|
#ifdef xyzModem_zmodem
|
if (xyz.mode != xyzModem_zmodem) {
|
if (xyz.mode != xyzModem_zmodem) {
|
#else
|
#else
|
if (1) {
|
if (1) {
|
#endif
|
#endif
|
if ((xyz.bufp[xyz.len-1] == EOF) &&
|
if ((xyz.bufp[xyz.len-1] == EOF) &&
|
(xyz.bufp[xyz.len-2] == EOF) &&
|
(xyz.bufp[xyz.len-2] == EOF) &&
|
(xyz.bufp[xyz.len-3] == EOF)) {
|
(xyz.bufp[xyz.len-3] == EOF)) {
|
while (xyz.len && (xyz.bufp[xyz.len-1] == EOF)) {
|
while (xyz.len && (xyz.bufp[xyz.len-1] == EOF)) {
|
xyz.len--;
|
xyz.len--;
|
}
|
}
|
}
|
}
|
}
|
}
|
|
|
#ifdef USE_YMODEM_LENGTH
|
#ifdef USE_YMODEM_LENGTH
|
// See if accumulated length exceeds that of the file.
|
// See if accumulated length exceeds that of the file.
|
// If so, reduce size (i.e., cut out pad bytes)
|
// If so, reduce size (i.e., cut out pad bytes)
|
// Only do this for Y-modem (and Z-modem should it ever
|
// Only do this for Y-modem (and Z-modem should it ever
|
// be supported since it can fall back to Y-modem mode).
|
// be supported since it can fall back to Y-modem mode).
|
if (xyz.mode != xyzModem_xmodem && 0 != xyz.file_length) {
|
if (xyz.mode != xyzModem_xmodem && 0 != xyz.file_length) {
|
xyz.read_length += xyz.len;
|
xyz.read_length += xyz.len;
|
if (xyz.read_length > xyz.file_length) {
|
if (xyz.read_length > xyz.file_length) {
|
xyz.len -= (xyz.read_length - xyz.file_length);
|
xyz.len -= (xyz.read_length - xyz.file_length);
|
}
|
}
|
}
|
}
|
#endif
|
#endif
|
break;
|
break;
|
} else if (xyz.blk == ((xyz.next_blk - 1) & 0xFF)) {
|
} else if (xyz.blk == ((xyz.next_blk - 1) & 0xFF)) {
|
// Just re-ACK this so sender will get on with it
|
// Just re-ACK this so sender will get on with it
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, ACK);
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, ACK);
|
continue; // Need new header
|
continue; // Need new header
|
} else {
|
} else {
|
stat = xyzModem_sequence;
|
stat = xyzModem_sequence;
|
}
|
}
|
}
|
}
|
if (stat == xyzModem_cancel) {
|
if (stat == xyzModem_cancel) {
|
break;
|
break;
|
}
|
}
|
if (stat == xyzModem_eof) {
|
if (stat == xyzModem_eof) {
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, ACK);
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, ACK);
|
ZM_DEBUG(zm_dprintf("ACK (%d)\n", __LINE__));
|
ZM_DEBUG(zm_dprintf("ACK (%d)\n", __LINE__));
|
if (xyz.mode == xyzModem_ymodem) {
|
if (xyz.mode == xyzModem_ymodem) {
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));
|
xyz.total_retries++;
|
xyz.total_retries++;
|
ZM_DEBUG(zm_dprintf("Reading Final Header\n"));
|
ZM_DEBUG(zm_dprintf("Reading Final Header\n"));
|
stat = xyzModem_get_hdr();
|
stat = xyzModem_get_hdr();
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, ACK);
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, ACK);
|
ZM_DEBUG(zm_dprintf("FINAL ACK (%d)\n", __LINE__));
|
ZM_DEBUG(zm_dprintf("FINAL ACK (%d)\n", __LINE__));
|
}
|
}
|
xyz.at_eof = true;
|
xyz.at_eof = true;
|
break;
|
break;
|
}
|
}
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));
|
CYGACC_COMM_IF_PUTC(*xyz.__chan, (xyz.crc_mode ? 'C' : NAK));
|
xyz.total_retries++;
|
xyz.total_retries++;
|
ZM_DEBUG(zm_dprintf("NAK (%d)\n", __LINE__));
|
ZM_DEBUG(zm_dprintf("NAK (%d)\n", __LINE__));
|
}
|
}
|
if (stat < 0) {
|
if (stat < 0) {
|
*err = stat;
|
*err = stat;
|
xyz.len = -1;
|
xyz.len = -1;
|
return total;
|
return total;
|
}
|
}
|
}
|
}
|
// Don't "read" data from the EOF protocol package
|
// Don't "read" data from the EOF protocol package
|
if (!xyz.at_eof) {
|
if (!xyz.at_eof) {
|
len = xyz.len;
|
len = xyz.len;
|
if (size < len) len = size;
|
if (size < len) len = size;
|
memcpy(buf, xyz.bufp, len);
|
memcpy(buf, xyz.bufp, len);
|
size -= len;
|
size -= len;
|
buf += len;
|
buf += len;
|
total += len;
|
total += len;
|
xyz.len -= len;
|
xyz.len -= len;
|
xyz.bufp += len;
|
xyz.bufp += len;
|
}
|
}
|
}
|
}
|
return total;
|
return total;
|
}
|
}
|
|
|
void
|
void
|
xyzModem_stream_close(int *err)
|
xyzModem_stream_close(int *err)
|
{
|
{
|
diag_printf("xyzModem - %s mode, %d(SOH)/%d(STX)/%d(CAN) packets, %d retries\n",
|
diag_printf("xyzModem - %s mode, %d(SOH)/%d(STX)/%d(CAN) packets, %d retries\n",
|
xyz.crc_mode ? "CRC" : "Cksum",
|
xyz.crc_mode ? "CRC" : "Cksum",
|
xyz.total_SOH, xyz.total_STX, xyz.total_CAN,
|
xyz.total_SOH, xyz.total_STX, xyz.total_CAN,
|
xyz.total_retries);
|
xyz.total_retries);
|
// ZM_DEBUG(zm_flush());
|
// ZM_DEBUG(zm_flush());
|
}
|
}
|
|
|
// Need to be able to clean out the input buffer, so have to take the
|
// Need to be able to clean out the input buffer, so have to take the
|
// getc
|
// getc
|
void xyzModem_stream_terminate(bool abort, int (*getc)(void))
|
void xyzModem_stream_terminate(bool abort, int (*getc)(void))
|
{
|
{
|
int c;
|
int c;
|
|
|
if (abort) {
|
if (abort) {
|
ZM_DEBUG(zm_dprintf("!!!! TRANSFER ABORT !!!!\n"));
|
ZM_DEBUG(zm_dprintf("!!!! TRANSFER ABORT !!!!\n"));
|
switch (xyz.mode) {
|
switch (xyz.mode) {
|
case xyzModem_xmodem:
|
case xyzModem_xmodem:
|
case xyzModem_ymodem:
|
case xyzModem_ymodem:
|
// The X/YMODEM Spec seems to suggest that multiple CAN followed by an equal
|
// 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.
|
// 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,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);
|
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.
|
// Now consume the rest of what's waiting on the line.
|
ZM_DEBUG(zm_dprintf("Flushing serial line.\n"));
|
ZM_DEBUG(zm_dprintf("Flushing serial line.\n"));
|
xyzModem_flush();
|
xyzModem_flush();
|
xyz.at_eof = true;
|
xyz.at_eof = true;
|
break;
|
break;
|
#ifdef xyzModem_zmodem
|
#ifdef xyzModem_zmodem
|
case xyzModem_zmodem:
|
case xyzModem_zmodem:
|
// Might support it some day I suppose.
|
// Might support it some day I suppose.
|
#endif
|
#endif
|
break;
|
break;
|
}
|
}
|
} else {
|
} else {
|
ZM_DEBUG(zm_dprintf("Engaging cleanup mode...\n"));
|
ZM_DEBUG(zm_dprintf("Engaging cleanup mode...\n"));
|
// Consume any trailing crap left in the inbuffer from
|
// Consume any trailing crap left in the inbuffer from
|
// previous recieved blocks. Since very few files are an exact multiple
|
// previous recieved blocks. Since very few files are an exact multiple
|
// of the transfer block size, there will almost always be some gunk here.
|
// 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.
|
// If we don't eat it now, RedBoot will think the user typed it.
|
ZM_DEBUG(zm_dprintf("Trailing gunk:\n"));
|
ZM_DEBUG(zm_dprintf("Trailing gunk:\n"));
|
while ((c = (*getc)()) > -1) ;
|
while ((c = (*getc)()) > -1) ;
|
ZM_DEBUG(zm_dprintf("\n"));
|
ZM_DEBUG(zm_dprintf("\n"));
|
// Make a small delay to give terminal programs like minicom
|
// Make a small delay to give terminal programs like minicom
|
// time to get control again after their file transfer program
|
// time to get control again after their file transfer program
|
// exits.
|
// exits.
|
CYGACC_CALL_IF_DELAY_US((cyg_int32)250000);
|
CYGACC_CALL_IF_DELAY_US((cyg_int32)250000);
|
}
|
}
|
}
|
}
|
|
|
char *
|
char *
|
xyzModem_error(int err)
|
xyzModem_error(int err)
|
{
|
{
|
switch (err) {
|
switch (err) {
|
case xyzModem_access:
|
case xyzModem_access:
|
return "Can't access file";
|
return "Can't access file";
|
break;
|
break;
|
case xyzModem_noZmodem:
|
case xyzModem_noZmodem:
|
return "Sorry, zModem not available yet";
|
return "Sorry, zModem not available yet";
|
break;
|
break;
|
case xyzModem_timeout:
|
case xyzModem_timeout:
|
return "Timed out";
|
return "Timed out";
|
break;
|
break;
|
case xyzModem_eof:
|
case xyzModem_eof:
|
return "End of file";
|
return "End of file";
|
break;
|
break;
|
case xyzModem_cancel:
|
case xyzModem_cancel:
|
return "Cancelled";
|
return "Cancelled";
|
break;
|
break;
|
case xyzModem_frame:
|
case xyzModem_frame:
|
return "Invalid framing";
|
return "Invalid framing";
|
break;
|
break;
|
case xyzModem_cksum:
|
case xyzModem_cksum:
|
return "CRC/checksum error";
|
return "CRC/checksum error";
|
break;
|
break;
|
case xyzModem_sequence:
|
case xyzModem_sequence:
|
return "Block sequence error";
|
return "Block sequence error";
|
break;
|
break;
|
default:
|
default:
|
return "Unknown error";
|
return "Unknown error";
|
break;
|
break;
|
}
|
}
|
}
|
}
|
|
|
//
|
//
|
// RedBoot interface
|
// RedBoot interface
|
//
|
//
|
GETC_IO_FUNCS(xyzModem_io, xyzModem_stream_open, xyzModem_stream_close,
|
GETC_IO_FUNCS(xyzModem_io, xyzModem_stream_open, xyzModem_stream_close,
|
xyzModem_stream_terminate, xyzModem_stream_read, xyzModem_error);
|
xyzModem_stream_terminate, xyzModem_stream_read, xyzModem_error);
|
RedBoot_load(xmodem, xyzModem_io, false, false, xyzModem_xmodem);
|
RedBoot_load(xmodem, xyzModem_io, false, false, xyzModem_xmodem);
|
RedBoot_load(ymodem, xyzModem_io, false, false, xyzModem_ymodem);
|
RedBoot_load(ymodem, xyzModem_io, false, false, xyzModem_ymodem);
|
|
|
