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 (ulong 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 CFG_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 CFG_LOADS_BAUD_CHANGE
75 offset = simple_strtoul(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 /* ! CFG_LOADS_BAUD_CHANGE */
98 offset = simple_strtoul(argv[1], NULL, 16);
100 #endif /* CFG_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 CFG_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 (ulong 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;
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 CFG_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 CFG_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 /* ! CFG_LOADS_BAUD_CHANGE */
296 size = simple_strtoul(argv[2], NULL, 16);
298 #endif /* CFG_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 CFG_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 extern int os_data_count;
428 static void set_kerm_bin_mode(unsigned long *);
429 static int k_recv(void);
430 static ulong load_serial_bin (ulong offset);
433 char his_eol; /* character he needs at end of packet */
434 int his_pad_count; /* number of pad chars he needs */
435 char his_pad_char; /* pad chars he needs */
436 char his_quote; /* quote chars he'll use */
438 int do_load_serial_bin (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
442 int load_baudrate, current_baudrate;
446 /* pre-set offset from CFG_LOAD_ADDR */
447 offset = CFG_LOAD_ADDR;
449 /* pre-set offset from $loadaddr */
450 if ((s = getenv("loadaddr")) != NULL) {
451 offset = simple_strtoul(s, NULL, 16);
454 load_baudrate = current_baudrate = gd->baudrate;
457 offset = simple_strtoul(argv[1], NULL, 16);
460 load_baudrate = (int)simple_strtoul(argv[2], NULL, 10);
462 /* default to current baudrate */
463 if (load_baudrate == 0)
464 load_baudrate = current_baudrate;
467 if (load_baudrate != current_baudrate) {
468 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
471 gd->baudrate = load_baudrate;
480 if (strcmp(argv[0],"loady")==0) {
481 printf ("## Ready for binary (ymodem) download "
482 "to 0x%08lX at %d bps...\n",
486 addr = load_serial_ymodem (offset);
490 printf ("## Ready for binary (kermit) download "
491 "to 0x%08lX at %d bps...\n",
494 addr = load_serial_bin (offset);
498 printf ("## Binary (kermit) download aborted\n");
501 printf ("## Start Addr = 0x%08lX\n", addr);
505 if (load_baudrate != current_baudrate) {
506 printf ("## Switch baudrate to %d bps and press ESC ...\n",
509 gd->baudrate = current_baudrate;
513 if (getc() == 0x1B) /* ESC */
518 #ifdef CONFIG_AUTOSCRIPT
522 if (((s = getenv("autoscript")) != NULL) && (strcmp(s,"yes") == 0)) {
523 printf ("Running autoscript at addr 0x%08lX", load_addr);
525 s = getenv ("autoscript_uname");
527 printf (":%s ...\n", s);
531 rcode = autoscript (load_addr, s);
539 static ulong load_serial_bin (ulong offset)
544 set_kerm_bin_mode ((ulong *) offset);
548 * Gather any trailing characters (for instance, the ^D which
549 * is sent by 'cu' after sending a file), and give the
550 * box some time (100 * 1 ms)
552 for (i=0; i<100; ++i) {
559 flush_cache (offset, size);
561 printf("## Total Size = 0x%08x = %d Bytes\n", size, size);
562 sprintf(buf, "%X", size);
563 setenv("filesize", buf);
570 int count = his_pad_count;
576 /* converts escaped kermit char to binary char */
577 char ktrans (char in)
579 if ((in & 0x60) == 0x40) {
580 return (char) (in & ~0x40);
581 } else if ((in & 0x7f) == 0x3f) {
582 return (char) (in | 0x40);
587 int chk1 (char *buffer)
594 return (int) ((total + ((total >> 6) & 0x03)) & 0x3f);
597 void s1_sendpacket (char *packet)
606 void send_ack (int n)
613 a_b[4] = tochar (chk1 (&a_b[1]));
619 void send_nack (int n)
626 a_b[4] = tochar (chk1 (&a_b[1]));
633 void (*os_data_init) (void);
634 void (*os_data_char) (char new_char);
635 static int os_data_state, os_data_state_saved;
637 static int os_data_count_saved;
638 static char *os_data_addr, *os_data_addr_saved;
639 static char *bin_start_address;
641 static void bin_data_init (void)
645 os_data_addr = bin_start_address;
648 static void os_data_save (void)
650 os_data_state_saved = os_data_state;
651 os_data_count_saved = os_data_count;
652 os_data_addr_saved = os_data_addr;
655 static void os_data_restore (void)
657 os_data_state = os_data_state_saved;
658 os_data_count = os_data_count_saved;
659 os_data_addr = os_data_addr_saved;
662 static void bin_data_char (char new_char)
664 switch (os_data_state) {
666 *os_data_addr++ = new_char;
672 static void set_kerm_bin_mode (unsigned long *addr)
674 bin_start_address = (char *) addr;
675 os_data_init = bin_data_init;
676 os_data_char = bin_data_char;
680 /* k_data_* simply handles the kermit escape translations */
681 static int k_data_escape, k_data_escape_saved;
682 void k_data_init (void)
688 void k_data_save (void)
690 k_data_escape_saved = k_data_escape;
694 void k_data_restore (void)
696 k_data_escape = k_data_escape_saved;
700 void k_data_char (char new_char)
703 /* last char was escape - translate this character */
704 os_data_char (ktrans (new_char));
707 if (new_char == his_quote) {
708 /* this char is escape - remember */
711 /* otherwise send this char as-is */
712 os_data_char (new_char);
717 #define SEND_DATA_SIZE 20
718 char send_parms[SEND_DATA_SIZE];
721 /* handle_send_packet interprits the protocol info and builds and
722 sends an appropriate ack for what we can do */
723 void handle_send_packet (int n)
728 /* initialize some protocol parameters */
729 his_eol = END_CHAR; /* default end of line character */
732 his_quote = K_ESCAPE;
734 /* ignore last character if it filled the buffer */
735 if (send_ptr == &send_parms[SEND_DATA_SIZE - 1])
737 bytes = send_ptr - send_parms; /* how many bytes we'll process */
741 /* handle MAXL - max length */
742 /* ignore what he says - most I'll take (here) is 94 */
743 a_b[++length] = tochar (94);
746 /* handle TIME - time you should wait for my packets */
747 /* ignore what he says - don't wait for my ack longer than 1 second */
748 a_b[++length] = tochar (1);
751 /* handle NPAD - number of pad chars I need */
752 /* remember what he says - I need none */
753 his_pad_count = untochar (send_parms[2]);
754 a_b[++length] = tochar (0);
757 /* handle PADC - pad chars I need */
758 /* remember what he says - I need none */
759 his_pad_char = ktrans (send_parms[3]);
760 a_b[++length] = 0x40; /* He should ignore this */
763 /* handle EOL - end of line he needs */
764 /* remember what he says - I need CR */
765 his_eol = untochar (send_parms[4]);
766 a_b[++length] = tochar (END_CHAR);
769 /* handle QCTL - quote control char he'll use */
770 /* remember what he says - I'll use '#' */
771 his_quote = send_parms[5];
775 /* handle QBIN - 8-th bit prefixing */
776 /* ignore what he says - I refuse */
780 /* handle CHKT - the clock check type */
781 /* ignore what he says - I do type 1 (for now) */
785 /* handle REPT - the repeat prefix */
786 /* ignore what he says - I refuse (for now) */
790 /* handle CAPAS - the capabilities mask */
791 /* ignore what he says - I only do long packets - I don't do windows */
792 a_b[++length] = tochar (2); /* only long packets */
793 a_b[++length] = tochar (0); /* no windows */
794 a_b[++length] = tochar (94); /* large packet msb */
795 a_b[++length] = tochar (94); /* large packet lsb */
799 a_b[1] = tochar (length);
802 a_b[++length] = '\0';
803 a_b[length] = tochar (chk1 (&a_b[1]));
804 a_b[++length] = his_eol;
805 a_b[++length] = '\0';
809 /* k_recv receives a OS Open image file over kermit line */
810 static int k_recv (void)
813 char k_state, k_state_saved;
821 /* initialize some protocol parameters */
822 his_eol = END_CHAR; /* default end of line character */
825 his_quote = K_ESCAPE;
827 /* initialize the k_recv and k_data state machine */
831 k_state_saved = k_state;
833 n = 0; /* just to get rid of a warning */
836 /* expect this "type" sequence (but don't check):
841 B: break transmission
844 /* enter main loop */
846 /* set the send packet pointer to begining of send packet parms */
847 send_ptr = send_parms;
849 /* With each packet, start summing the bytes starting with the length.
850 Save the current sequence number.
851 Note the type of the packet.
852 If a character less than SPACE (0x20) is received - error.
856 /* OLD CODE, Prior to checking sequence numbers */
857 /* first have all state machines save current states */
858 k_state_saved = k_state;
863 /* wait for the starting character or ^C */
866 case START_CHAR: /* start packet */
868 case ETX_CHAR: /* ^C waiting for packet */
875 /* get length of packet */
878 if ((new_char & 0xE0) == 0)
880 sum += new_char & 0xff;
881 length = untochar (new_char);
882 /* get sequence number */
884 if ((new_char & 0xE0) == 0)
886 sum += new_char & 0xff;
887 n = untochar (new_char);
890 /* NEW CODE - check sequence numbers for retried packets */
891 /* Note - this new code assumes that the sequence number is correctly
892 * received. Handling an invalid sequence number adds another layer
893 * of complexity that may not be needed - yet! At this time, I'm hoping
894 * that I don't need to buffer the incoming data packets and can write
895 * the data into memory in real time.
898 /* same sequence number, restore the previous state */
899 k_state = k_state_saved;
902 /* new sequence number, checkpoint the download */
904 k_state_saved = k_state;
909 /* get packet type */
911 if ((new_char & 0xE0) == 0)
913 sum += new_char & 0xff;
916 /* check for extended length */
918 /* (length byte was 0, decremented twice) */
919 /* get the two length bytes */
921 if ((new_char & 0xE0) == 0)
923 sum += new_char & 0xff;
924 len_hi = untochar (new_char);
926 if ((new_char & 0xE0) == 0)
928 sum += new_char & 0xff;
929 len_lo = untochar (new_char);
930 length = len_hi * 95 + len_lo;
931 /* check header checksum */
933 if ((new_char & 0xE0) == 0)
935 if (new_char != tochar ((sum + ((sum >> 6) & 0x03)) & 0x3f))
937 sum += new_char & 0xff;
938 /* --length; */ /* new length includes only data and block check to come */
940 /* bring in rest of packet */
943 if ((new_char & 0xE0) == 0)
945 sum += new_char & 0xff;
947 if (k_state == DATA_TYPE) {
948 /* pass on the data if this is a data packet */
949 k_data_char (new_char);
950 } else if (k_state == SEND_TYPE) {
951 /* save send pack in buffer as is */
952 *send_ptr++ = new_char;
953 /* if too much data, back off the pointer */
954 if (send_ptr >= &send_parms[SEND_DATA_SIZE])
958 /* get and validate checksum character */
960 if ((new_char & 0xE0) == 0)
962 if (new_char != tochar ((sum + ((sum >> 6) & 0x03)) & 0x3f))
966 if (new_char != END_CHAR) {
968 /* restore state machines */
969 k_state = k_state_saved;
971 /* send a negative acknowledge packet in */
973 } else if (k_state == SEND_TYPE) {
974 /* crack the protocol parms, build an appropriate ack packet */
975 handle_send_packet (n);
977 /* send simple acknowledge packet in */
979 /* quit if end of transmission */
980 if (k_state == BREAK_TYPE)
985 return ((ulong) os_data_addr - (ulong) bin_start_address);
988 static int getcxmodem(void) {
993 static ulong load_serial_ymodem (ulong offset)
999 connection_info_t info;
1000 char ymodemBuf[1024];
1001 ulong store_addr = ~0;
1005 info.mode = xyzModem_ymodem;
1006 res = xyzModem_stream_open (&info, &err);
1010 xyzModem_stream_read (ymodemBuf, 1024, &err)) > 0) {
1011 store_addr = addr + offset;
1014 #ifndef CFG_NO_FLASH
1015 if (addr2info (store_addr)) {
1018 rc = flash_write ((char *) ymodemBuf,
1027 memcpy ((char *) (store_addr), ymodemBuf,
1033 printf ("%s\n", xyzModem_error (err));
1036 xyzModem_stream_close (&err);
1037 xyzModem_stream_terminate (false, &getcxmodem);
1040 flush_cache (offset, size);
1042 printf ("## Total Size = 0x%08x = %d Bytes\n", size, size);
1043 sprintf (buf, "%X", size);
1044 setenv ("filesize", buf);
1051 /* -------------------------------------------------------------------- */
1053 #if defined(CONFIG_CMD_LOADS)
1055 #ifdef CFG_LOADS_BAUD_CHANGE
1057 loads, 3, 0, do_load_serial,
1058 "loads - load S-Record file over serial line\n",
1059 "[ off ] [ baud ]\n"
1060 " - load S-Record file over serial line"
1061 " with offset 'off' and baudrate 'baud'\n"
1064 #else /* ! CFG_LOADS_BAUD_CHANGE */
1066 loads, 2, 0, do_load_serial,
1067 "loads - load S-Record file over serial line\n",
1069 " - load S-Record file over serial line with offset 'off'\n"
1071 #endif /* CFG_LOADS_BAUD_CHANGE */
1074 * SAVES always requires LOADS support, but not vice versa
1078 #if defined(CONFIG_CMD_SAVES)
1079 #ifdef CFG_LOADS_BAUD_CHANGE
1081 saves, 4, 0, do_save_serial,
1082 "saves - save S-Record file over serial line\n",
1083 "[ off ] [size] [ baud ]\n"
1084 " - save S-Record file over serial line"
1085 " with offset 'off', size 'size' and baudrate 'baud'\n"
1087 #else /* ! CFG_LOADS_BAUD_CHANGE */
1089 saves, 3, 0, do_save_serial,
1090 "saves - save S-Record file over serial line\n",
1092 " - save S-Record file over serial line with offset 'off' and size 'size'\n"
1094 #endif /* CFG_LOADS_BAUD_CHANGE */
1099 #if defined(CONFIG_CMD_LOADB)
1101 loadb, 3, 0, do_load_serial_bin,
1102 "loadb - load binary file over serial line (kermit mode)\n",
1103 "[ off ] [ baud ]\n"
1104 " - load binary file over serial line"
1105 " with offset 'off' and baudrate 'baud'\n"
1109 loady, 3, 0, do_load_serial_bin,
1110 "loady - load binary file over serial line (ymodem mode)\n",
1111 "[ off ] [ baud ]\n"
1112 " - load binary file over serial line"
1113 " with offset 'off' and baudrate 'baud'\n"
1118 /* -------------------------------------------------------------------- */
1120 #if defined(CONFIG_CMD_HWFLOW)
1121 int do_hwflow (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
1123 extern int hwflow_onoff(int);
1126 if (strcmp(argv[1], "off") == 0)
1129 if (strcmp(argv[1], "on") == 0)
1132 printf("Usage: %s\n", cmdtp->usage);
1134 printf("RTS/CTS hardware flow control: %s\n", hwflow_onoff(0) ? "on" : "off");
1138 /* -------------------------------------------------------------------- */
1141 hwflow, 2, 0, do_hwflow,
1142 "hwflow - turn the harwdare flow control on/off\n",
1143 "[on|off]\n - change RTS/CTS hardware flow control over serial line\n"