Newer
Older
// SPDX-License-Identifier: GPL-2.0+
* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
*/
/*
* Serial up- and download support
*/
#include <common.h>
#include <command.h>
#include <exports.h>
#include <xyzModem.h>
DECLARE_GLOBAL_DATA_PTR;
#if defined(CONFIG_CMD_LOADB)
static ulong load_serial_ymodem(ulong offset, int mode);
#if defined(CONFIG_CMD_LOADS)
static ulong load_serial(long offset);
static int read_record(char *buf, ulong len);
# if defined(CONFIG_CMD_SAVES)
static int save_serial(ulong offset, ulong size);
static int write_record(char *buf);
/* -------------------------------------------------------------------- */
#if defined(CONFIG_CMD_LOADS)
static int do_load_serial(cmd_tbl_t *cmdtp, int flag, int argc,
char * const argv[])
ulong addr;
int i;
char *env_echo;
int rcode = 0;
#ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
int load_baudrate, current_baudrate;
load_baudrate = current_baudrate = gd->baudrate;
#endif
env_echo = env_get("loads_echo");
if (env_echo && *env_echo == '1')
#ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
offset = simple_strtol(argv[1], NULL, 16);
}
if (argc == 3) {
load_baudrate = (int)simple_strtoul(argv[2], NULL, 10);
/* default to current baudrate */
if (load_baudrate == 0)
load_baudrate = current_baudrate;
}
if (load_baudrate != current_baudrate) {
printf("## Switch baudrate to %d bps and press ENTER ...\n",
load_baudrate);
udelay(50000);
gd->baudrate = load_baudrate;
udelay(50000);
for (;;) {
if (getc() == '\r')
break;
}
}
#else /* ! CONFIG_SYS_LOADS_BAUD_CHANGE */
offset = simple_strtol(argv[1], NULL, 16);
#endif /* CONFIG_SYS_LOADS_BAUD_CHANGE */
printf("## Ready for S-Record download ...\n");
/*
* Gather any trailing characters (for instance, the ^D which
* is sent by 'cu' after sending a file), and give the
* box some time (100 * 1 ms)
*/
for (i=0; i<100; ++i) {
if (tstc()) {
(void) getc();
#ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
printf("## Switch baudrate to %d bps and press ESC ...\n",
for (;;) {
if (getc() == 0x1B) /* ESC */
break;
}
}
#endif
return rcode;
}
{
char record[SREC_MAXRECLEN + 1]; /* buffer for one S-Record */
char binbuf[SREC_MAXBINLEN]; /* buffer for binary data */
int binlen; /* no. of data bytes in S-Rec. */
int type; /* return code for record type */
ulong addr; /* load address from S-Record */
ulong size; /* number of bytes transferred */
ulong store_addr;
ulong start_addr = ~0;
ulong end_addr = 0;
int line_count = 0;
while (read_record(record, SREC_MAXRECLEN + 1) >= 0) {
type = srec_decode(record, &binlen, &addr, binbuf);
if (type < 0) {
return (~0); /* Invalid S-Record */
}
switch (type) {
case SREC_DATA2:
case SREC_DATA3:
case SREC_DATA4:
store_addr = addr + offset;
#ifdef CONFIG_MTD_NOR_FLASH
memcpy((char *)(store_addr), binbuf, binlen);
}
if ((store_addr) < start_addr)
start_addr = store_addr;
if ((store_addr + binlen - 1) > end_addr)
end_addr = store_addr + binlen - 1;
break;
case SREC_END2:
case SREC_END3:
case SREC_END4:
"## First Load Addr = 0x%08lX\n"
"## Last Load Addr = 0x%08lX\n"
"## Total Size = 0x%08lX = %ld Bytes\n",
start_addr, end_addr, size, size
);
env_set_hex("filesize", size);
return (addr);
case SREC_START:
break;
default:
break;
}
if (!do_echo) { /* print a '.' every 100 lines */
if ((++line_count % 100) == 0)
}
}
return (~0); /* Download aborted */
}
static int read_record(char *buf, ulong len)
{
char *p;
char c;
--len; /* always leave room for terminating '\0' byte */
for (p=buf; p < buf+len; ++p) {
c = getc(); /* read character */
switch (c) {
case '\r':
case '\n':
*p = '\0';
return (p - buf);
case '\0':
case 0x03: /* ^C - Control C */
return (-1);
default:
*p = c;
}
/* Check for the console hangup (if any different from serial) */
if (ctrlc()) {
return (-1);
}
}
}
/* line too long - truncate */
*p = '\0';
return (p - buf);
}
#if defined(CONFIG_CMD_SAVES)
int do_save_serial (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
#ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
int save_baudrate, current_baudrate;
save_baudrate = current_baudrate = gd->baudrate;
#endif
if (argc >= 2) {
offset = simple_strtoul(argv[1], NULL, 16);
}
#ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
if (argc >= 3) {
size = simple_strtoul(argv[2], NULL, 16);
}
if (argc == 4) {
save_baudrate = (int)simple_strtoul(argv[3], NULL, 10);
/* default to current baudrate */
if (save_baudrate == 0)
save_baudrate = current_baudrate;
}
if (save_baudrate != current_baudrate) {
printf("## Switch baudrate to %d bps and press ENTER ...\n",
save_baudrate);
udelay(50000);
gd->baudrate = save_baudrate;
udelay(50000);
for (;;) {
if (getc() == '\r')
break;
}
}
#else /* ! CONFIG_SYS_LOADS_BAUD_CHANGE */
if (argc == 3) {
size = simple_strtoul(argv[2], NULL, 16);
}
#endif /* CONFIG_SYS_LOADS_BAUD_CHANGE */
printf("## Ready for S-Record upload, press ENTER to proceed ...\n");
if (save_serial(offset, size)) {
printf("## S-Record upload aborted\n");
#ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
printf("## Switch baudrate to %d bps and press ESC ...\n",
for (;;) {
if (getc() == 0x1B) /* ESC */
break;
}
}
#endif
return 0;
}
#define SREC3_START "S0030000FC\n"
#define SREC3_FORMAT "S3%02X%08lX%s%02X\n"
#define SREC3_END "S70500000000FA\n"
#define SREC_BYTES_PER_RECORD 16
static int save_serial(ulong address, ulong count)
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
{
int i, c, reclen, checksum, length;
char *hex = "0123456789ABCDEF";
char record[2*SREC_BYTES_PER_RECORD+16]; /* buffer for one S-Record */
char data[2*SREC_BYTES_PER_RECORD+1]; /* buffer for hex data */
reclen = 0;
checksum = 0;
if(write_record(SREC3_START)) /* write the header */
return (-1);
do {
if(count) { /* collect hex data in the buffer */
c = *(volatile uchar*)(address + reclen); /* get one byte */
checksum += c; /* accumulate checksum */
data[2*reclen] = hex[(c>>4)&0x0f];
data[2*reclen+1] = hex[c & 0x0f];
data[2*reclen+2] = '\0';
++reclen;
--count;
}
if(reclen == SREC_BYTES_PER_RECORD || count == 0) {
/* enough data collected for one record: dump it */
if(reclen) { /* build & write a data record: */
/* address + data + checksum */
length = 4 + reclen + 1;
/* accumulate length bytes into checksum */
for(i = 0; i < 2; i++)
checksum += (length >> (8*i)) & 0xff;
/* accumulate address bytes into checksum: */
for(i = 0; i < 4; i++)
checksum += (address >> (8*i)) & 0xff;
/* make proper checksum byte: */
checksum = ~checksum & 0xff;
/* output one record: */
sprintf(record, SREC3_FORMAT, length, address, data, checksum);
if(write_record(record))
return (-1);
}
address += reclen; /* increment address */
checksum = 0;
reclen = 0;
}
}
while(count);
if(write_record(SREC3_END)) /* write the final record */
return (-1);
return(0);
}
/* Check for the console hangup (if any different from serial) */
if (ctrlc()) {
return (-1);
}
return (0);
}
#if defined(CONFIG_CMD_LOADB)
Jon Loeliger
committed
/*
* loadb command (load binary) included
*/
#define XON_CHAR 17
#define XOFF_CHAR 19
#define START_CHAR 0x01
#define ETX_CHAR 0x03
#define END_CHAR 0x0D
#define SPACE 0x20
#define K_ESCAPE 0x23
#define SEND_TYPE 'S'
#define DATA_TYPE 'D'
#define ACK_TYPE 'Y'
#define NACK_TYPE 'N'
#define BREAK_TYPE 'B'
#define tochar(x) ((char) (((x) + SPACE) & 0xff))
#define untochar(x) ((int) (((x) - SPACE) & 0xff))
static void set_kerm_bin_mode(unsigned long *);
static int k_recv(void);
static char his_eol; /* character he needs at end of packet */
static int his_pad_count; /* number of pad chars he needs */
static char his_pad_char; /* pad chars he needs */
static char his_quote; /* quote chars he'll use */
static int do_load_serial_bin(cmd_tbl_t *cmdtp, int flag, int argc,
char * const argv[])
{
ulong offset = 0;
ulong addr;
int load_baudrate, current_baudrate;
int rcode = 0;
char *s;
/* pre-set offset from CONFIG_SYS_LOAD_ADDR */
offset = CONFIG_SYS_LOAD_ADDR;
offset = simple_strtoul(s, NULL, 16);
load_baudrate = current_baudrate = gd->baudrate;
if (argc >= 2) {
offset = simple_strtoul(argv[1], NULL, 16);
}
if (argc == 3) {
load_baudrate = (int)simple_strtoul(argv[2], NULL, 10);
/* default to current baudrate */
if (load_baudrate == 0)
load_baudrate = current_baudrate;
}
if (load_baudrate != current_baudrate) {
printf("## Switch baudrate to %d bps and press ENTER ...\n",
load_baudrate);
udelay(50000);
gd->baudrate = load_baudrate;
udelay(50000);
for (;;) {
if (getc() == '\r')
break;
}
}
if (strcmp(argv[0],"loady")==0) {
printf("## Ready for binary (ymodem) download "
"to 0x%08lX at %d bps...\n",
offset,
load_baudrate);
addr = load_serial_ymodem(offset, xyzModem_ymodem);
} else if (strcmp(argv[0],"loadx")==0) {
printf("## Ready for binary (xmodem) download "
"to 0x%08lX at %d bps...\n",
offset,
load_baudrate);
addr = load_serial_ymodem(offset, xyzModem_xmodem);
printf("## Ready for binary (kermit) download "
"to 0x%08lX at %d bps...\n",
offset,
load_baudrate);
if (addr == ~0) {
load_addr = 0;
printf("## Binary (kermit) download aborted\n");
rcode = 1;
} else {
load_addr = addr;
}
}
printf("## Switch baudrate to %d bps and press ESC ...\n",
for (;;) {
if (getc() == 0x1B) /* ESC */
break;
}
}
return rcode;
}
set_kerm_bin_mode((ulong *) offset);
size = k_recv();
/*
* Gather any trailing characters (for instance, the ^D which
* is sent by 'cu' after sending a file), and give the
* box some time (100 * 1 ms)
*/
for (i=0; i<100; ++i) {
if (tstc()) {
(void) getc();
printf("## Total Size = 0x%08x = %d Bytes\n", size, size);
env_set_hex("filesize", size);
{
int count = his_pad_count;
while (count-- > 0)
}
/* converts escaped kermit char to binary char */
{
if ((in & 0x60) == 0x40) {
return (char) (in & ~0x40);
} else if ((in & 0x7f) == 0x3f) {
return (char) (in | 0x40);
} else
return in;
}
{
int total = 0;
while (*buffer) {
total += *buffer++;
}
return (int) ((total + ((total >> 6) & 0x03)) & 0x3f);
}
static void (*os_data_init)(void);
static void (*os_data_char)(char new_char);
static int os_data_state, os_data_state_saved;
static char *os_data_addr, *os_data_addr_saved;
static char *bin_start_address;
{
os_data_state = 0;
os_data_addr = bin_start_address;
}
{
os_data_state_saved = os_data_state;
os_data_addr_saved = os_data_addr;
}
{
os_data_state = os_data_state_saved;
os_data_addr = os_data_addr_saved;
}
{
switch (os_data_state) {
case 0: /* data */
*os_data_addr++ = new_char;
break;
}
}
static void set_kerm_bin_mode(unsigned long *addr)
{
bin_start_address = (char *) addr;
os_data_init = bin_data_init;
os_data_char = bin_data_char;
}
/* k_data_* simply handles the kermit escape translations */
static int k_data_escape, k_data_escape_saved;
{
if (k_data_escape) {
/* last char was escape - translate this character */
k_data_escape = 0;
} else {
if (new_char == his_quote) {
/* this char is escape - remember */
k_data_escape = 1;
} else {
/* otherwise send this char as-is */
static char send_parms[SEND_DATA_SIZE];
static char *send_ptr;
/* handle_send_packet interprits the protocol info and builds and
sends an appropriate ack for what we can do */
{
int length = 3;
int bytes;
/* initialize some protocol parameters */
his_eol = END_CHAR; /* default end of line character */
his_pad_count = 0;
his_pad_char = '\0';
his_quote = K_ESCAPE;
/* ignore last character if it filled the buffer */
if (send_ptr == &send_parms[SEND_DATA_SIZE - 1])
--send_ptr;
bytes = send_ptr - send_parms; /* how many bytes we'll process */
do {
if (bytes-- <= 0)
break;
/* handle MAXL - max length */
/* ignore what he says - most I'll take (here) is 94 */
if (bytes-- <= 0)
break;
/* handle TIME - time you should wait for my packets */
/* ignore what he says - don't wait for my ack longer than 1 second */
if (bytes-- <= 0)
break;
/* handle NPAD - number of pad chars I need */
/* remember what he says - I need none */
his_pad_count = untochar(send_parms[2]);
a_b[++length] = tochar(0);
if (bytes-- <= 0)
break;
/* handle PADC - pad chars I need */
/* remember what he says - I need none */
a_b[++length] = 0x40; /* He should ignore this */
if (bytes-- <= 0)
break;
/* handle EOL - end of line he needs */
/* remember what he says - I need CR */
his_eol = untochar(send_parms[4]);
a_b[++length] = tochar(END_CHAR);
if (bytes-- <= 0)
break;
/* handle QCTL - quote control char he'll use */
/* remember what he says - I'll use '#' */
his_quote = send_parms[5];
a_b[++length] = '#';
if (bytes-- <= 0)
break;
/* handle QBIN - 8-th bit prefixing */
/* ignore what he says - I refuse */
a_b[++length] = 'N';
if (bytes-- <= 0)
break;
/* handle CHKT - the clock check type */
/* ignore what he says - I do type 1 (for now) */
a_b[++length] = '1';
if (bytes-- <= 0)
break;
/* handle REPT - the repeat prefix */
/* ignore what he says - I refuse (for now) */
a_b[++length] = 'N';
if (bytes-- <= 0)
break;
/* handle CAPAS - the capabilities mask */
/* ignore what he says - I only do long packets - I don't do windows */
a_b[++length] = tochar(2); /* only long packets */
a_b[++length] = tochar(0); /* no windows */
a_b[++length] = tochar(94); /* large packet msb */
a_b[++length] = tochar(94); /* large packet lsb */
a_b[1] = tochar(length);
a_b[2] = tochar(n);
}
/* k_recv receives a OS Open image file over kermit line */
{
char new_char;
char k_state, k_state_saved;
int sum;
int done;
int length;
int n, last_n;
int len_lo, len_hi;
/* initialize some protocol parameters */
his_eol = END_CHAR; /* default end of line character */
his_pad_count = 0;
his_pad_char = '\0';
his_quote = K_ESCAPE;
/* initialize the k_recv and k_data state machine */
done = 0;
k_state = 0;
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
n = 0; /* just to get rid of a warning */
last_n = -1;
/* expect this "type" sequence (but don't check):
S: send initiate
F: file header
D: data (multiple)
Z: end of file
B: break transmission
*/
/* enter main loop */
while (!done) {
/* set the send packet pointer to begining of send packet parms */
send_ptr = send_parms;
/* With each packet, start summing the bytes starting with the length.
Save the current sequence number.
Note the type of the packet.
If a character less than SPACE (0x20) is received - error.
*/
#if 0
/* OLD CODE, Prior to checking sequence numbers */
/* first have all state machines save current states */
k_state_saved = k_state;
k_data_save ();
#endif
/* get a packet */
/* wait for the starting character or ^C */
for (;;) {
case START_CHAR: /* start packet */
goto START;
case ETX_CHAR: /* ^C waiting for packet */
return (0);
default:
;
}
}
START:
/* get length of packet */
sum = 0;
if ((new_char & 0xE0) == 0)
goto packet_error;
sum += new_char & 0xff;
if ((new_char & 0xE0) == 0)
goto packet_error;
sum += new_char & 0xff;
--length;
/* NEW CODE - check sequence numbers for retried packets */
/* Note - this new code assumes that the sequence number is correctly
* received. Handling an invalid sequence number adds another layer
* of complexity that may not be needed - yet! At this time, I'm hoping
* that I don't need to buffer the incoming data packets and can write
* the data into memory in real time.
*/
if (n == last_n) {
/* same sequence number, restore the previous state */
k_state = k_state_saved;
} else {
/* new sequence number, checkpoint the download */
last_n = n;
k_state_saved = k_state;
if ((new_char & 0xE0) == 0)
goto packet_error;
sum += new_char & 0xff;
k_state = new_char;
--length;
/* check for extended length */
if (length == -2) {
/* (length byte was 0, decremented twice) */
/* get the two length bytes */
if ((new_char & 0xE0) == 0)
goto packet_error;
sum += new_char & 0xff;
len_hi = untochar(new_char);
new_char = getc();
if ((new_char & 0xE0) == 0)
goto packet_error;
sum += new_char & 0xff;
length = len_hi * 95 + len_lo;
/* check header checksum */
if (new_char != tochar((sum + ((sum >> 6) & 0x03)) & 0x3f))
goto packet_error;
sum += new_char & 0xff;
/* --length; */ /* new length includes only data and block check to come */
}
/* bring in rest of packet */
while (length > 1) {
if ((new_char & 0xE0) == 0)
goto packet_error;
sum += new_char & 0xff;
--length;
if (k_state == DATA_TYPE) {
/* pass on the data if this is a data packet */
k_data_char (new_char);
} else if (k_state == SEND_TYPE) {
/* save send pack in buffer as is */
*send_ptr++ = new_char;
/* if too much data, back off the pointer */
if (send_ptr >= &send_parms[SEND_DATA_SIZE])
--send_ptr;
}
}
/* get and validate checksum character */
if (new_char != tochar((sum + ((sum >> 6) & 0x03)) & 0x3f))
if (new_char != END_CHAR) {
packet_error:
/* restore state machines */
k_state = k_state_saved;
} else if (k_state == SEND_TYPE) {
/* crack the protocol parms, build an appropriate ack packet */
/* quit if end of transmission */
if (k_state == BREAK_TYPE)
done = 1;
}
}
return ((ulong) os_data_addr - (ulong) bin_start_address);
}
static int getcxmodem(void) {
return (getc());
return -1;
}
static ulong load_serial_ymodem(ulong offset, int mode)
{
int size;
int err;
int res;
connection_info_t info;
char ymodemBuf[1024];
ulong store_addr = ~0;
ulong addr = 0;
xyzModem_stream_read(ymodemBuf, 1024, &err)) > 0) {
store_addr = addr + offset;
size += res;
addr += res;
#ifdef CONFIG_MTD_NOR_FLASH
store_addr, res);
if (rc != 0) {
flash_perror (rc);
return (~0);
}
} else
xyzModem_stream_close(&err);
xyzModem_stream_terminate(false, &getcxmodem);
flush_cache(offset, ALIGN(size, ARCH_DMA_MINALIGN));