2 * (C) Copyright 2000-2004
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * See file CREDITS for list of people who contributed to this
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
25 * Serial up- and download support
34 DECLARE_GLOBAL_DATA_PTR;
36 #if defined(CONFIG_CMD_LOADB)
37 static ulong load_serial_ymodem (ulong offset);
40 #if defined(CONFIG_CMD_LOADS)
41 static ulong load_serial (long offset);
42 static int read_record (char *buf, ulong len);
43 # if defined(CONFIG_CMD_SAVES)
44 static int save_serial (ulong offset, ulong size);
45 static int write_record (char *buf);
48 static int do_echo = 1;
51 /* -------------------------------------------------------------------- */
53 #if defined(CONFIG_CMD_LOADS)
54 int do_load_serial (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
61 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
62 int load_baudrate, current_baudrate;
64 load_baudrate = current_baudrate = gd->baudrate;
67 if (((env_echo = getenv("loads_echo")) != NULL) && (*env_echo == '1')) {
73 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
75 offset = simple_strtol(argv[1], NULL, 16);
78 load_baudrate = (int)simple_strtoul(argv[2], NULL, 10);
80 /* default to current baudrate */
81 if (load_baudrate == 0)
82 load_baudrate = current_baudrate;
84 if (load_baudrate != current_baudrate) {
85 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
88 gd->baudrate = load_baudrate;
96 #else /* ! CONFIG_SYS_LOADS_BAUD_CHANGE */
98 offset = simple_strtol(argv[1], NULL, 16);
100 #endif /* CONFIG_SYS_LOADS_BAUD_CHANGE */
102 printf ("## Ready for S-Record download ...\n");
104 addr = load_serial (offset);
107 * Gather any trailing characters (for instance, the ^D which
108 * is sent by 'cu' after sending a file), and give the
109 * box some time (100 * 1 ms)
111 for (i=0; i<100; ++i) {
119 printf ("## S-Record download aborted\n");
122 printf ("## Start Addr = 0x%08lX\n", addr);
126 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
127 if (load_baudrate != current_baudrate) {
128 printf ("## Switch baudrate to %d bps and press ESC ...\n",
131 gd->baudrate = current_baudrate;
135 if (getc() == 0x1B) /* ESC */
144 load_serial (long offset)
146 char record[SREC_MAXRECLEN + 1]; /* buffer for one S-Record */
147 char binbuf[SREC_MAXBINLEN]; /* buffer for binary data */
148 int binlen; /* no. of data bytes in S-Rec. */
149 int type; /* return code for record type */
150 ulong addr; /* load address from S-Record */
151 ulong size; /* number of bytes transferred */
154 ulong start_addr = ~0;
158 while (read_record(record, SREC_MAXRECLEN + 1) >= 0) {
159 type = srec_decode (record, &binlen, &addr, binbuf);
162 return (~0); /* Invalid S-Record */
169 store_addr = addr + offset;
170 #ifndef CONFIG_SYS_NO_FLASH
171 if (addr2info(store_addr)) {
174 rc = flash_write((char *)binbuf,store_addr,binlen);
182 memcpy ((char *)(store_addr), binbuf, binlen);
184 if ((store_addr) < start_addr)
185 start_addr = store_addr;
186 if ((store_addr + binlen - 1) > end_addr)
187 end_addr = store_addr + binlen - 1;
193 size = end_addr - start_addr + 1;
195 "## First Load Addr = 0x%08lX\n"
196 "## Last Load Addr = 0x%08lX\n"
197 "## Total Size = 0x%08lX = %ld Bytes\n",
198 start_addr, end_addr, size, size
200 flush_cache (start_addr, size);
201 sprintf(buf, "%lX", size);
202 setenv("filesize", buf);
209 if (!do_echo) { /* print a '.' every 100 lines */
210 if ((++line_count % 100) == 0)
215 return (~0); /* Download aborted */
219 read_record (char *buf, ulong len)
224 --len; /* always leave room for terminating '\0' byte */
226 for (p=buf; p < buf+len; ++p) {
227 c = getc(); /* read character */
229 putc (c); /* ... and echo it */
237 case 0x03: /* ^C - Control C */
243 /* Check for the console hangup (if any different from serial) */
244 if (gd->jt[XF_getc] != getc) {
251 /* line too long - truncate */
256 #if defined(CONFIG_CMD_SAVES)
258 int do_save_serial (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
262 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
263 int save_baudrate, current_baudrate;
265 save_baudrate = current_baudrate = gd->baudrate;
269 offset = simple_strtoul(argv[1], NULL, 16);
271 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
273 size = simple_strtoul(argv[2], NULL, 16);
276 save_baudrate = (int)simple_strtoul(argv[3], NULL, 10);
278 /* default to current baudrate */
279 if (save_baudrate == 0)
280 save_baudrate = current_baudrate;
282 if (save_baudrate != current_baudrate) {
283 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
286 gd->baudrate = save_baudrate;
294 #else /* ! CONFIG_SYS_LOADS_BAUD_CHANGE */
296 size = simple_strtoul(argv[2], NULL, 16);
298 #endif /* CONFIG_SYS_LOADS_BAUD_CHANGE */
300 printf ("## Ready for S-Record upload, press ENTER to proceed ...\n");
305 if(save_serial (offset, size)) {
306 printf ("## S-Record upload aborted\n");
308 printf ("## S-Record upload complete\n");
310 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
311 if (save_baudrate != current_baudrate) {
312 printf ("## Switch baudrate to %d bps and press ESC ...\n",
313 (int)current_baudrate);
315 gd->baudrate = current_baudrate;
319 if (getc() == 0x1B) /* ESC */
327 #define SREC3_START "S0030000FC\n"
328 #define SREC3_FORMAT "S3%02X%08lX%s%02X\n"
329 #define SREC3_END "S70500000000FA\n"
330 #define SREC_BYTES_PER_RECORD 16
332 static int save_serial (ulong address, ulong count)
334 int i, c, reclen, checksum, length;
335 char *hex = "0123456789ABCDEF";
336 char record[2*SREC_BYTES_PER_RECORD+16]; /* buffer for one S-Record */
337 char data[2*SREC_BYTES_PER_RECORD+1]; /* buffer for hex data */
342 if(write_record(SREC3_START)) /* write the header */
345 if(count) { /* collect hex data in the buffer */
346 c = *(volatile uchar*)(address + reclen); /* get one byte */
347 checksum += c; /* accumulate checksum */
348 data[2*reclen] = hex[(c>>4)&0x0f];
349 data[2*reclen+1] = hex[c & 0x0f];
350 data[2*reclen+2] = '\0';
354 if(reclen == SREC_BYTES_PER_RECORD || count == 0) {
355 /* enough data collected for one record: dump it */
356 if(reclen) { /* build & write a data record: */
357 /* address + data + checksum */
358 length = 4 + reclen + 1;
360 /* accumulate length bytes into checksum */
361 for(i = 0; i < 2; i++)
362 checksum += (length >> (8*i)) & 0xff;
364 /* accumulate address bytes into checksum: */
365 for(i = 0; i < 4; i++)
366 checksum += (address >> (8*i)) & 0xff;
368 /* make proper checksum byte: */
369 checksum = ~checksum & 0xff;
371 /* output one record: */
372 sprintf(record, SREC3_FORMAT, length, address, data, checksum);
373 if(write_record(record))
376 address += reclen; /* increment address */
382 if(write_record(SREC3_END)) /* write the final record */
388 write_record (char *buf)
395 /* Check for the console hangup (if any different from serial) */
407 #if defined(CONFIG_CMD_LOADB)
409 * loadb command (load binary) included
413 #define START_CHAR 0x01
414 #define ETX_CHAR 0x03
415 #define END_CHAR 0x0D
417 #define K_ESCAPE 0x23
418 #define SEND_TYPE 'S'
419 #define DATA_TYPE 'D'
421 #define NACK_TYPE 'N'
422 #define BREAK_TYPE 'B'
423 #define tochar(x) ((char) (((x) + SPACE) & 0xff))
424 #define untochar(x) ((int) (((x) - SPACE) & 0xff))
426 static void set_kerm_bin_mode(unsigned long *);
427 static int k_recv(void);
428 static ulong load_serial_bin (ulong offset);
431 char his_eol; /* character he needs at end of packet */
432 int his_pad_count; /* number of pad chars he needs */
433 char his_pad_char; /* pad chars he needs */
434 char his_quote; /* quote chars he'll use */
436 int do_load_serial_bin (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
440 int load_baudrate, current_baudrate;
444 /* pre-set offset from CONFIG_SYS_LOAD_ADDR */
445 offset = CONFIG_SYS_LOAD_ADDR;
447 /* pre-set offset from $loadaddr */
448 if ((s = getenv("loadaddr")) != NULL) {
449 offset = simple_strtoul(s, NULL, 16);
452 load_baudrate = current_baudrate = gd->baudrate;
455 offset = simple_strtoul(argv[1], NULL, 16);
458 load_baudrate = (int)simple_strtoul(argv[2], NULL, 10);
460 /* default to current baudrate */
461 if (load_baudrate == 0)
462 load_baudrate = current_baudrate;
465 if (load_baudrate != current_baudrate) {
466 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
469 gd->baudrate = load_baudrate;
478 if (strcmp(argv[0],"loady")==0) {
479 printf ("## Ready for binary (ymodem) download "
480 "to 0x%08lX at %d bps...\n",
484 addr = load_serial_ymodem (offset);
488 printf ("## Ready for binary (kermit) download "
489 "to 0x%08lX at %d bps...\n",
492 addr = load_serial_bin (offset);
496 printf ("## Binary (kermit) download aborted\n");
499 printf ("## Start Addr = 0x%08lX\n", addr);
503 if (load_baudrate != current_baudrate) {
504 printf ("## Switch baudrate to %d bps and press ESC ...\n",
507 gd->baudrate = current_baudrate;
511 if (getc() == 0x1B) /* ESC */
516 #ifdef CONFIG_AUTOSCRIPT
520 if (((s = getenv("autoscript")) != NULL) && (strcmp(s,"yes") == 0)) {
521 printf ("Running autoscript at addr 0x%08lX", load_addr);
523 s = getenv ("autoscript_uname");
525 printf (":%s ...\n", s);
529 rcode = autoscript (load_addr, s);
537 static ulong load_serial_bin (ulong offset)
542 set_kerm_bin_mode ((ulong *) offset);
546 * Gather any trailing characters (for instance, the ^D which
547 * is sent by 'cu' after sending a file), and give the
548 * box some time (100 * 1 ms)
550 for (i=0; i<100; ++i) {
557 flush_cache (offset, size);
559 printf("## Total Size = 0x%08x = %d Bytes\n", size, size);
560 sprintf(buf, "%X", size);
561 setenv("filesize", buf);
568 int count = his_pad_count;
574 /* converts escaped kermit char to binary char */
575 char ktrans (char in)
577 if ((in & 0x60) == 0x40) {
578 return (char) (in & ~0x40);
579 } else if ((in & 0x7f) == 0x3f) {
580 return (char) (in | 0x40);
585 int chk1 (char *buffer)
592 return (int) ((total + ((total >> 6) & 0x03)) & 0x3f);
595 void s1_sendpacket (char *packet)
604 void send_ack (int n)
611 a_b[4] = tochar (chk1 (&a_b[1]));
617 void send_nack (int n)
624 a_b[4] = tochar (chk1 (&a_b[1]));
631 void (*os_data_init) (void);
632 void (*os_data_char) (char new_char);
633 static int os_data_state, os_data_state_saved;
634 static char *os_data_addr, *os_data_addr_saved;
635 static char *bin_start_address;
637 static void bin_data_init (void)
640 os_data_addr = bin_start_address;
643 static void os_data_save (void)
645 os_data_state_saved = os_data_state;
646 os_data_addr_saved = os_data_addr;
649 static void os_data_restore (void)
651 os_data_state = os_data_state_saved;
652 os_data_addr = os_data_addr_saved;
655 static void bin_data_char (char new_char)
657 switch (os_data_state) {
659 *os_data_addr++ = new_char;
664 static void set_kerm_bin_mode (unsigned long *addr)
666 bin_start_address = (char *) addr;
667 os_data_init = bin_data_init;
668 os_data_char = bin_data_char;
672 /* k_data_* simply handles the kermit escape translations */
673 static int k_data_escape, k_data_escape_saved;
674 void k_data_init (void)
680 void k_data_save (void)
682 k_data_escape_saved = k_data_escape;
686 void k_data_restore (void)
688 k_data_escape = k_data_escape_saved;
692 void k_data_char (char new_char)
695 /* last char was escape - translate this character */
696 os_data_char (ktrans (new_char));
699 if (new_char == his_quote) {
700 /* this char is escape - remember */
703 /* otherwise send this char as-is */
704 os_data_char (new_char);
709 #define SEND_DATA_SIZE 20
710 char send_parms[SEND_DATA_SIZE];
713 /* handle_send_packet interprits the protocol info and builds and
714 sends an appropriate ack for what we can do */
715 void handle_send_packet (int n)
720 /* initialize some protocol parameters */
721 his_eol = END_CHAR; /* default end of line character */
724 his_quote = K_ESCAPE;
726 /* ignore last character if it filled the buffer */
727 if (send_ptr == &send_parms[SEND_DATA_SIZE - 1])
729 bytes = send_ptr - send_parms; /* how many bytes we'll process */
733 /* handle MAXL - max length */
734 /* ignore what he says - most I'll take (here) is 94 */
735 a_b[++length] = tochar (94);
738 /* handle TIME - time you should wait for my packets */
739 /* ignore what he says - don't wait for my ack longer than 1 second */
740 a_b[++length] = tochar (1);
743 /* handle NPAD - number of pad chars I need */
744 /* remember what he says - I need none */
745 his_pad_count = untochar (send_parms[2]);
746 a_b[++length] = tochar (0);
749 /* handle PADC - pad chars I need */
750 /* remember what he says - I need none */
751 his_pad_char = ktrans (send_parms[3]);
752 a_b[++length] = 0x40; /* He should ignore this */
755 /* handle EOL - end of line he needs */
756 /* remember what he says - I need CR */
757 his_eol = untochar (send_parms[4]);
758 a_b[++length] = tochar (END_CHAR);
761 /* handle QCTL - quote control char he'll use */
762 /* remember what he says - I'll use '#' */
763 his_quote = send_parms[5];
767 /* handle QBIN - 8-th bit prefixing */
768 /* ignore what he says - I refuse */
772 /* handle CHKT - the clock check type */
773 /* ignore what he says - I do type 1 (for now) */
777 /* handle REPT - the repeat prefix */
778 /* ignore what he says - I refuse (for now) */
782 /* handle CAPAS - the capabilities mask */
783 /* ignore what he says - I only do long packets - I don't do windows */
784 a_b[++length] = tochar (2); /* only long packets */
785 a_b[++length] = tochar (0); /* no windows */
786 a_b[++length] = tochar (94); /* large packet msb */
787 a_b[++length] = tochar (94); /* large packet lsb */
791 a_b[1] = tochar (length);
794 a_b[++length] = '\0';
795 a_b[length] = tochar (chk1 (&a_b[1]));
796 a_b[++length] = his_eol;
797 a_b[++length] = '\0';
801 /* k_recv receives a OS Open image file over kermit line */
802 static int k_recv (void)
805 char k_state, k_state_saved;
812 /* initialize some protocol parameters */
813 his_eol = END_CHAR; /* default end of line character */
816 his_quote = K_ESCAPE;
818 /* initialize the k_recv and k_data state machine */
822 k_state_saved = k_state;
824 n = 0; /* just to get rid of a warning */
827 /* expect this "type" sequence (but don't check):
832 B: break transmission
835 /* enter main loop */
837 /* set the send packet pointer to begining of send packet parms */
838 send_ptr = send_parms;
840 /* With each packet, start summing the bytes starting with the length.
841 Save the current sequence number.
842 Note the type of the packet.
843 If a character less than SPACE (0x20) is received - error.
847 /* OLD CODE, Prior to checking sequence numbers */
848 /* first have all state machines save current states */
849 k_state_saved = k_state;
854 /* wait for the starting character or ^C */
857 case START_CHAR: /* start packet */
859 case ETX_CHAR: /* ^C waiting for packet */
866 /* get length of packet */
869 if ((new_char & 0xE0) == 0)
871 sum += new_char & 0xff;
872 length = untochar (new_char);
873 /* get sequence number */
875 if ((new_char & 0xE0) == 0)
877 sum += new_char & 0xff;
878 n = untochar (new_char);
881 /* NEW CODE - check sequence numbers for retried packets */
882 /* Note - this new code assumes that the sequence number is correctly
883 * received. Handling an invalid sequence number adds another layer
884 * of complexity that may not be needed - yet! At this time, I'm hoping
885 * that I don't need to buffer the incoming data packets and can write
886 * the data into memory in real time.
889 /* same sequence number, restore the previous state */
890 k_state = k_state_saved;
893 /* new sequence number, checkpoint the download */
895 k_state_saved = k_state;
900 /* get packet type */
902 if ((new_char & 0xE0) == 0)
904 sum += new_char & 0xff;
907 /* check for extended length */
909 /* (length byte was 0, decremented twice) */
910 /* get the two length bytes */
912 if ((new_char & 0xE0) == 0)
914 sum += new_char & 0xff;
915 len_hi = untochar (new_char);
917 if ((new_char & 0xE0) == 0)
919 sum += new_char & 0xff;
920 len_lo = untochar (new_char);
921 length = len_hi * 95 + len_lo;
922 /* check header checksum */
924 if ((new_char & 0xE0) == 0)
926 if (new_char != tochar ((sum + ((sum >> 6) & 0x03)) & 0x3f))
928 sum += new_char & 0xff;
929 /* --length; */ /* new length includes only data and block check to come */
931 /* bring in rest of packet */
934 if ((new_char & 0xE0) == 0)
936 sum += new_char & 0xff;
938 if (k_state == DATA_TYPE) {
939 /* pass on the data if this is a data packet */
940 k_data_char (new_char);
941 } else if (k_state == SEND_TYPE) {
942 /* save send pack in buffer as is */
943 *send_ptr++ = new_char;
944 /* if too much data, back off the pointer */
945 if (send_ptr >= &send_parms[SEND_DATA_SIZE])
949 /* get and validate checksum character */
951 if ((new_char & 0xE0) == 0)
953 if (new_char != tochar ((sum + ((sum >> 6) & 0x03)) & 0x3f))
957 if (new_char != END_CHAR) {
959 /* restore state machines */
960 k_state = k_state_saved;
962 /* send a negative acknowledge packet in */
964 } else if (k_state == SEND_TYPE) {
965 /* crack the protocol parms, build an appropriate ack packet */
966 handle_send_packet (n);
968 /* send simple acknowledge packet in */
970 /* quit if end of transmission */
971 if (k_state == BREAK_TYPE)
975 return ((ulong) os_data_addr - (ulong) bin_start_address);
978 static int getcxmodem(void) {
983 static ulong load_serial_ymodem (ulong offset)
989 connection_info_t info;
990 char ymodemBuf[1024];
991 ulong store_addr = ~0;
995 info.mode = xyzModem_ymodem;
996 res = xyzModem_stream_open (&info, &err);
1000 xyzModem_stream_read (ymodemBuf, 1024, &err)) > 0) {
1001 store_addr = addr + offset;
1004 #ifndef CONFIG_SYS_NO_FLASH
1005 if (addr2info (store_addr)) {
1008 rc = flash_write ((char *) ymodemBuf,
1017 memcpy ((char *) (store_addr), ymodemBuf,
1023 printf ("%s\n", xyzModem_error (err));
1026 xyzModem_stream_close (&err);
1027 xyzModem_stream_terminate (false, &getcxmodem);
1030 flush_cache (offset, size);
1032 printf ("## Total Size = 0x%08x = %d Bytes\n", size, size);
1033 sprintf (buf, "%X", size);
1034 setenv ("filesize", buf);
1041 /* -------------------------------------------------------------------- */
1043 #if defined(CONFIG_CMD_LOADS)
1045 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
1047 loads, 3, 0, do_load_serial,
1048 "load S-Record file over serial line",
1049 "[ off ] [ baud ]\n"
1050 " - load S-Record file over serial line"
1051 " with offset 'off' and baudrate 'baud'\n"
1054 #else /* ! CONFIG_SYS_LOADS_BAUD_CHANGE */
1056 loads, 2, 0, do_load_serial,
1057 "load S-Record file over serial line",
1059 " - load S-Record file over serial line with offset 'off'\n"
1061 #endif /* CONFIG_SYS_LOADS_BAUD_CHANGE */
1064 * SAVES always requires LOADS support, but not vice versa
1068 #if defined(CONFIG_CMD_SAVES)
1069 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
1071 saves, 4, 0, do_save_serial,
1072 "save S-Record file over serial line",
1073 "[ off ] [size] [ baud ]\n"
1074 " - save S-Record file over serial line"
1075 " with offset 'off', size 'size' and baudrate 'baud'\n"
1077 #else /* ! CONFIG_SYS_LOADS_BAUD_CHANGE */
1079 saves, 3, 0, do_save_serial,
1080 "save S-Record file over serial line",
1082 " - save S-Record file over serial line with offset 'off' and size 'size'\n"
1084 #endif /* CONFIG_SYS_LOADS_BAUD_CHANGE */
1089 #if defined(CONFIG_CMD_LOADB)
1091 loadb, 3, 0, do_load_serial_bin,
1092 "load binary file over serial line (kermit mode)",
1093 "[ off ] [ baud ]\n"
1094 " - load binary file over serial line"
1095 " with offset 'off' and baudrate 'baud'\n"
1099 loady, 3, 0, do_load_serial_bin,
1100 "load binary file over serial line (ymodem mode)",
1101 "[ off ] [ baud ]\n"
1102 " - load binary file over serial line"
1103 " with offset 'off' and baudrate 'baud'\n"
1108 /* -------------------------------------------------------------------- */
1110 #if defined(CONFIG_CMD_HWFLOW)
1111 int do_hwflow (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
1113 extern int hwflow_onoff(int);
1116 if (strcmp(argv[1], "off") == 0)
1119 if (strcmp(argv[1], "on") == 0)
1124 printf("RTS/CTS hardware flow control: %s\n", hwflow_onoff(0) ? "on" : "off");
1128 /* -------------------------------------------------------------------- */
1131 hwflow, 2, 0, do_hwflow,
1132 "turn the harwdare flow control on/off",
1133 "[on|off]\n - change RTS/CTS hardware flow control over serial line\n"