2 * (C) Copyright 2000-2003
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 #if (CONFIG_COMMANDS & CFG_CMD_LOADS)
35 static ulong load_serial (ulong offset);
36 static int read_record (char *buf, ulong len);
37 # if (CONFIG_COMMANDS & CFG_CMD_SAVES)
38 static int save_serial (ulong offset, ulong size);
39 static int write_record (char *buf);
40 # endif /* CFG_CMD_SAVES */
42 static int do_echo = 1;
43 #endif /* CFG_CMD_LOADS */
45 /* -------------------------------------------------------------------- */
47 #if (CONFIG_COMMANDS & CFG_CMD_LOADS)
48 int do_load_serial (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
55 #ifdef CFG_LOADS_BAUD_CHANGE
56 DECLARE_GLOBAL_DATA_PTR;
57 int load_baudrate, current_baudrate;
59 load_baudrate = current_baudrate = gd->baudrate;
62 if (((env_echo = getenv("loads_echo")) != NULL) && (*env_echo == '1')) {
68 #ifdef CFG_LOADS_BAUD_CHANGE
70 offset = simple_strtoul(argv[1], NULL, 16);
73 load_baudrate = (int)simple_strtoul(argv[2], NULL, 10);
75 /* default to current baudrate */
76 if (load_baudrate == 0)
77 load_baudrate = current_baudrate;
79 if (load_baudrate != current_baudrate) {
80 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
83 gd->baudrate = load_baudrate;
91 #else /* ! CFG_LOADS_BAUD_CHANGE */
93 offset = simple_strtoul(argv[1], NULL, 16);
95 #endif /* CFG_LOADS_BAUD_CHANGE */
97 printf ("## Ready for S-Record download ...\n");
99 addr = load_serial (offset);
102 * Gather any trailing characters (for instance, the ^D which
103 * is sent by 'cu' after sending a file), and give the
104 * box some time (100 * 1 ms)
106 for (i=0; i<100; ++i) {
108 (void) serial_getc();
114 printf ("## S-Record download aborted\n");
117 printf ("## Start Addr = 0x%08lX\n", addr);
121 #ifdef CFG_LOADS_BAUD_CHANGE
122 if (load_baudrate != current_baudrate) {
123 printf ("## Switch baudrate to %d bps and press ESC ...\n",
126 gd->baudrate = current_baudrate;
130 if (getc() == 0x1B) /* ESC */
139 load_serial (ulong offset)
141 char record[SREC_MAXRECLEN + 1]; /* buffer for one S-Record */
142 char binbuf[SREC_MAXBINLEN]; /* buffer for binary data */
143 int binlen; /* no. of data bytes in S-Rec. */
144 int type; /* return code for record type */
145 ulong addr; /* load address from S-Record */
146 ulong size; /* number of bytes transferred */
149 ulong start_addr = ~0;
153 while (read_record(record, SREC_MAXRECLEN + 1) >= 0) {
154 type = srec_decode (record, &binlen, &addr, binbuf);
157 return (~0); /* Invalid S-Record */
164 store_addr = addr + offset;
166 if (addr2info(store_addr)) {
169 rc = flash_write((uchar *)binbuf,store_addr,binlen);
177 memcpy ((char *)(store_addr), binbuf, binlen);
179 if ((store_addr) < start_addr)
180 start_addr = store_addr;
181 if ((store_addr + binlen - 1) > end_addr)
182 end_addr = store_addr + binlen - 1;
188 size = end_addr - start_addr + 1;
190 "## First Load Addr = 0x%08lX\n"
191 "## Last Load Addr = 0x%08lX\n"
192 "## Total Size = 0x%08lX = %ld Bytes\n",
193 start_addr, end_addr, size, size
195 flush_cache (addr, size);
196 sprintf(buf, "%lX", size);
197 setenv("filesize", buf);
204 if (!do_echo) { /* print a '.' every 100 lines */
205 if ((++line_count % 100) == 0)
210 return (~0); /* Download aborted */
214 read_record (char *buf, ulong len)
219 --len; /* always leave room for terminating '\0' byte */
221 for (p=buf; p < buf+len; ++p) {
222 c = serial_getc(); /* read character */
224 serial_putc (c); /* ... and echo it */
232 case 0x03: /* ^C - Control C */
238 /* Check for the console hangup (if any different from serial) */
239 #ifdef CONFIG_PPC /* we don't have syscall_tbl anywhere else */
240 if (syscall_tbl[SYSCALL_GETC] != serial_getc) {
248 /* line too long - truncate */
253 #if (CONFIG_COMMANDS & CFG_CMD_SAVES)
255 int do_save_serial (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
259 #ifdef CFG_LOADS_BAUD_CHANGE
260 DECLARE_GLOBAL_DATA_PTR;
261 int save_baudrate, current_baudrate;
263 save_baudrate = current_baudrate = gd->baudrate;
267 offset = simple_strtoul(argv[1], NULL, 16);
269 #ifdef CFG_LOADS_BAUD_CHANGE
271 size = simple_strtoul(argv[2], NULL, 16);
274 save_baudrate = (int)simple_strtoul(argv[3], NULL, 10);
276 /* default to current baudrate */
277 if (save_baudrate == 0)
278 save_baudrate = current_baudrate;
280 if (save_baudrate != current_baudrate) {
281 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
284 gd->baudrate = save_baudrate;
292 #else /* ! CFG_LOADS_BAUD_CHANGE */
294 size = simple_strtoul(argv[2], NULL, 16);
296 #endif /* CFG_LOADS_BAUD_CHANGE */
298 printf ("## Ready for S-Record upload, press ENTER to proceed ...\n");
303 if(save_serial (offset, size)) {
304 printf ("## S-Record upload aborted\n");
306 printf ("## S-Record upload complete\n");
308 #ifdef CFG_LOADS_BAUD_CHANGE
309 if (save_baudrate != current_baudrate) {
310 printf ("## Switch baudrate to %d bps and press ESC ...\n",
311 (int)current_baudrate);
313 gd->baudrate = current_baudrate;
317 if (getc() == 0x1B) /* ESC */
325 #define SREC3_START "S0030000FC\n"
326 #define SREC3_FORMAT "S3%02X%08lX%s%02X\n"
327 #define SREC3_END "S70500000000FA\n"
328 #define SREC_BYTES_PER_RECORD 16
330 static int save_serial (ulong address, ulong count)
332 int i, c, reclen, checksum, length;
333 char *hex = "0123456789ABCDEF";
334 char record[2*SREC_BYTES_PER_RECORD+16]; /* buffer for one S-Record */
335 char data[2*SREC_BYTES_PER_RECORD+1]; /* buffer for hex data */
340 if(write_record(SREC3_START)) /* write the header */
343 if(count) { /* collect hex data in the buffer */
344 c = *(volatile uchar*)(address + reclen); /* get one byte */
345 checksum += c; /* accumulate checksum */
346 data[2*reclen] = hex[(c>>4)&0x0f];
347 data[2*reclen+1] = hex[c & 0x0f];
348 data[2*reclen+2] = '\0';
352 if(reclen == SREC_BYTES_PER_RECORD || count == 0) {
353 /* enough data collected for one record: dump it */
354 if(reclen) { /* build & write a data record: */
355 /* address + data + checksum */
356 length = 4 + reclen + 1;
358 /* accumulate length bytes into checksum */
359 for(i = 0; i < 2; i++)
360 checksum += (length >> (8*i)) & 0xff;
362 /* accumulate address bytes into checksum: */
363 for(i = 0; i < 4; i++)
364 checksum += (address >> (8*i)) & 0xff;
366 /* make proper checksum byte: */
367 checksum = ~checksum & 0xff;
369 /* output one record: */
370 sprintf(record, SREC3_FORMAT, length, address, data, checksum);
371 if(write_record(record))
374 address += reclen; /* increment address */
380 if(write_record(SREC3_END)) /* write the final record */
386 write_record (char *buf)
393 /* Check for the console hangup (if any different from serial) */
400 # endif /* CFG_CMD_SAVES */
402 #endif /* CFG_CMD_LOADS */
405 #if (CONFIG_COMMANDS & CFG_CMD_LOADB) /* loadb command (load binary) included */
409 #define START_CHAR 0x01
410 #define ETX_CHAR 0x03
411 #define END_CHAR 0x0D
413 #define K_ESCAPE 0x23
414 #define SEND_TYPE 'S'
415 #define DATA_TYPE 'D'
417 #define NACK_TYPE 'N'
418 #define BREAK_TYPE 'B'
419 #define tochar(x) ((char) (((x) + SPACE) & 0xff))
420 #define untochar(x) ((int) (((x) - SPACE) & 0xff))
422 extern int os_data_count;
423 extern int os_data_header[8];
425 static void set_kerm_bin_mode(unsigned long *);
426 static int k_recv(void);
427 static ulong load_serial_bin (ulong offset);
430 char his_eol; /* character he needs at end of packet */
431 int his_pad_count; /* number of pad chars he needs */
432 char his_pad_char; /* pad chars he needs */
433 char his_quote; /* quote chars he'll use */
435 int do_load_serial_bin (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
437 DECLARE_GLOBAL_DATA_PTR;
441 int load_baudrate, current_baudrate;
445 /* pre-set offset from CFG_LOAD_ADDR */
446 offset = CFG_LOAD_ADDR;
448 /* pre-set offset from $loadaddr */
449 if ((s = getenv("loadaddr")) != NULL) {
450 offset = simple_strtoul(s, NULL, 16);
453 load_baudrate = current_baudrate = gd->baudrate;
456 offset = simple_strtoul(argv[1], NULL, 16);
459 load_baudrate = (int)simple_strtoul(argv[2], NULL, 10);
461 /* default to current baudrate */
462 if (load_baudrate == 0)
463 load_baudrate = current_baudrate;
466 if (load_baudrate != current_baudrate) {
467 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
470 gd->baudrate = load_baudrate;
479 printf ("## Ready for binary (kermit) download "
480 "to 0x%08lX at %d bps...\n",
483 addr = load_serial_bin (offset);
487 printf ("## Binary (kermit) download aborted\n");
490 printf ("## Start Addr = 0x%08lX\n", addr);
494 if (load_baudrate != current_baudrate) {
495 printf ("## Switch baudrate to %d bps and press ESC ...\n",
498 gd->baudrate = current_baudrate;
502 if (getc() == 0x1B) /* ESC */
507 #ifdef CONFIG_AUTOSCRIPT
511 if (((s = getenv("autoscript")) != NULL) && (strcmp(s,"yes") == 0)) {
512 printf("Running autoscript at addr 0x%08lX ...\n", load_addr);
513 rcode = autoscript (load_addr);
521 static ulong load_serial_bin (ulong offset)
526 set_kerm_bin_mode ((ulong *) offset);
530 * Gather any trailing characters (for instance, the ^D which
531 * is sent by 'cu' after sending a file), and give the
532 * box some time (100 * 1 ms)
534 for (i=0; i<100; ++i) {
536 (void) serial_getc();
541 flush_cache (offset, size);
543 printf("## Total Size = 0x%08x = %d Bytes\n", size, size);
544 sprintf(buf, "%X", size);
545 setenv("filesize", buf);
552 int count = his_pad_count;
555 serial_putc (his_pad_char);
558 /* converts escaped kermit char to binary char */
559 char ktrans (char in)
561 if ((in & 0x60) == 0x40) {
562 return (char) (in & ~0x40);
563 } else if ((in & 0x7f) == 0x3f) {
564 return (char) (in | 0x40);
569 int chk1 (char *buffer)
576 return (int) ((total + ((total >> 6) & 0x03)) & 0x3f);
579 void s1_sendpacket (char *packet)
583 serial_putc (*packet++);
588 void send_ack (int n)
595 a_b[4] = tochar (chk1 (&a_b[1]));
601 void send_nack (int n)
608 a_b[4] = tochar (chk1 (&a_b[1]));
615 /* os_data_* takes an OS Open image and puts it into memory, and
616 puts the boot header in an array named os_data_header
618 if image is binary, no header is stored in os_data_header.
620 void (*os_data_init) (void);
621 void (*os_data_char) (char new_char);
622 static int os_data_state, os_data_state_saved;
624 static int os_data_count_saved;
625 static char *os_data_addr, *os_data_addr_saved;
626 static char *bin_start_address;
627 int os_data_header[8];
628 static void bin_data_init (void)
632 os_data_addr = bin_start_address;
634 static void os_data_save (void)
636 os_data_state_saved = os_data_state;
637 os_data_count_saved = os_data_count;
638 os_data_addr_saved = os_data_addr;
640 static void os_data_restore (void)
642 os_data_state = os_data_state_saved;
643 os_data_count = os_data_count_saved;
644 os_data_addr = os_data_addr_saved;
646 static void bin_data_char (char new_char)
648 switch (os_data_state) {
650 *os_data_addr++ = new_char;
655 static void set_kerm_bin_mode (unsigned long *addr)
657 bin_start_address = (char *) addr;
658 os_data_init = bin_data_init;
659 os_data_char = bin_data_char;
663 /* k_data_* simply handles the kermit escape translations */
664 static int k_data_escape, k_data_escape_saved;
665 void k_data_init (void)
670 void k_data_save (void)
672 k_data_escape_saved = k_data_escape;
675 void k_data_restore (void)
677 k_data_escape = k_data_escape_saved;
680 void k_data_char (char new_char)
683 /* last char was escape - translate this character */
684 os_data_char (ktrans (new_char));
687 if (new_char == his_quote) {
688 /* this char is escape - remember */
691 /* otherwise send this char as-is */
692 os_data_char (new_char);
697 #define SEND_DATA_SIZE 20
698 char send_parms[SEND_DATA_SIZE];
701 /* handle_send_packet interprits the protocol info and builds and
702 sends an appropriate ack for what we can do */
703 void handle_send_packet (int n)
708 /* initialize some protocol parameters */
709 his_eol = END_CHAR; /* default end of line character */
712 his_quote = K_ESCAPE;
714 /* ignore last character if it filled the buffer */
715 if (send_ptr == &send_parms[SEND_DATA_SIZE - 1])
717 bytes = send_ptr - send_parms; /* how many bytes we'll process */
721 /* handle MAXL - max length */
722 /* ignore what he says - most I'll take (here) is 94 */
723 a_b[++length] = tochar (94);
726 /* handle TIME - time you should wait for my packets */
727 /* ignore what he says - don't wait for my ack longer than 1 second */
728 a_b[++length] = tochar (1);
731 /* handle NPAD - number of pad chars I need */
732 /* remember what he says - I need none */
733 his_pad_count = untochar (send_parms[2]);
734 a_b[++length] = tochar (0);
737 /* handle PADC - pad chars I need */
738 /* remember what he says - I need none */
739 his_pad_char = ktrans (send_parms[3]);
740 a_b[++length] = 0x40; /* He should ignore this */
743 /* handle EOL - end of line he needs */
744 /* remember what he says - I need CR */
745 his_eol = untochar (send_parms[4]);
746 a_b[++length] = tochar (END_CHAR);
749 /* handle QCTL - quote control char he'll use */
750 /* remember what he says - I'll use '#' */
751 his_quote = send_parms[5];
755 /* handle QBIN - 8-th bit prefixing */
756 /* ignore what he says - I refuse */
760 /* handle CHKT - the clock check type */
761 /* ignore what he says - I do type 1 (for now) */
765 /* handle REPT - the repeat prefix */
766 /* ignore what he says - I refuse (for now) */
770 /* handle CAPAS - the capabilities mask */
771 /* ignore what he says - I only do long packets - I don't do windows */
772 a_b[++length] = tochar (2); /* only long packets */
773 a_b[++length] = tochar (0); /* no windows */
774 a_b[++length] = tochar (94); /* large packet msb */
775 a_b[++length] = tochar (94); /* large packet lsb */
779 a_b[1] = tochar (length);
782 a_b[++length] = '\0';
783 a_b[length] = tochar (chk1 (&a_b[1]));
784 a_b[++length] = his_eol;
785 a_b[++length] = '\0';
789 /* k_recv receives a OS Open image file over kermit line */
790 static int k_recv (void)
793 char k_state, k_state_saved;
801 /* initialize some protocol parameters */
802 his_eol = END_CHAR; /* default end of line character */
805 his_quote = K_ESCAPE;
807 /* initialize the k_recv and k_data state machine */
811 k_state_saved = k_state;
813 n = 0; /* just to get rid of a warning */
816 /* expect this "type" sequence (but don't check):
821 B: break transmission
824 /* enter main loop */
826 /* set the send packet pointer to begining of send packet parms */
827 send_ptr = send_parms;
829 /* With each packet, start summing the bytes starting with the length.
830 Save the current sequence number.
831 Note the type of the packet.
832 If a character less than SPACE (0x20) is received - error.
836 /* OLD CODE, Prior to checking sequence numbers */
837 /* first have all state machines save current states */
838 k_state_saved = k_state;
843 /* wait for the starting character or ^C */
845 switch (serial_getc ()) {
846 case START_CHAR: /* start packet */
848 case ETX_CHAR: /* ^C waiting for packet */
855 /* get length of packet */
857 new_char = serial_getc ();
858 if ((new_char & 0xE0) == 0)
860 sum += new_char & 0xff;
861 length = untochar (new_char);
862 /* get sequence number */
863 new_char = serial_getc ();
864 if ((new_char & 0xE0) == 0)
866 sum += new_char & 0xff;
867 n = untochar (new_char);
870 /* NEW CODE - check sequence numbers for retried packets */
871 /* Note - this new code assumes that the sequence number is correctly
872 * received. Handling an invalid sequence number adds another layer
873 * of complexity that may not be needed - yet! At this time, I'm hoping
874 * that I don't need to buffer the incoming data packets and can write
875 * the data into memory in real time.
878 /* same sequence number, restore the previous state */
879 k_state = k_state_saved;
882 /* new sequence number, checkpoint the download */
884 k_state_saved = k_state;
889 /* get packet type */
890 new_char = serial_getc ();
891 if ((new_char & 0xE0) == 0)
893 sum += new_char & 0xff;
896 /* check for extended length */
898 /* (length byte was 0, decremented twice) */
899 /* get the two length bytes */
900 new_char = serial_getc ();
901 if ((new_char & 0xE0) == 0)
903 sum += new_char & 0xff;
904 len_hi = untochar (new_char);
905 new_char = serial_getc ();
906 if ((new_char & 0xE0) == 0)
908 sum += new_char & 0xff;
909 len_lo = untochar (new_char);
910 length = len_hi * 95 + len_lo;
911 /* check header checksum */
912 new_char = serial_getc ();
913 if ((new_char & 0xE0) == 0)
915 if (new_char != tochar ((sum + ((sum >> 6) & 0x03)) & 0x3f))
917 sum += new_char & 0xff;
918 /* --length; */ /* new length includes only data and block check to come */
920 /* bring in rest of packet */
922 new_char = serial_getc ();
923 if ((new_char & 0xE0) == 0)
925 sum += new_char & 0xff;
927 if (k_state == DATA_TYPE) {
928 /* pass on the data if this is a data packet */
929 k_data_char (new_char);
930 } else if (k_state == SEND_TYPE) {
931 /* save send pack in buffer as is */
932 *send_ptr++ = new_char;
933 /* if too much data, back off the pointer */
934 if (send_ptr >= &send_parms[SEND_DATA_SIZE])
938 /* get and validate checksum character */
939 new_char = serial_getc ();
940 if ((new_char & 0xE0) == 0)
942 if (new_char != tochar ((sum + ((sum >> 6) & 0x03)) & 0x3f))
945 new_char = serial_getc ();
946 if (new_char != END_CHAR) {
948 /* restore state machines */
949 k_state = k_state_saved;
951 /* send a negative acknowledge packet in */
953 } else if (k_state == SEND_TYPE) {
954 /* crack the protocol parms, build an appropriate ack packet */
955 handle_send_packet (n);
957 /* send simple acknowledge packet in */
959 /* quit if end of transmission */
960 if (k_state == BREAK_TYPE)
965 return ((ulong) os_data_addr - (ulong) bin_start_address);
967 #endif /* CFG_CMD_LOADB */
969 /* -------------------------------------------------------------------- */
971 #if (CONFIG_COMMANDS & CFG_CMD_LOADS)
973 #ifdef CFG_LOADS_BAUD_CHANGE
975 loads, 3, 0, do_load_serial,
976 "loads - load S-Record file over serial line\n",
978 " - load S-Record file over serial line"
979 " with offset 'off' and baudrate 'baud'\n"
982 #else /* ! CFG_LOADS_BAUD_CHANGE */
984 loads, 2, 0, do_load_serial,
985 "loads - load S-Record file over serial line\n",
987 " - load S-Record file over serial line with offset 'off'\n"
989 #endif /* CFG_LOADS_BAUD_CHANGE */
992 * SAVES always requires LOADS support, but not vice versa
996 #if (CONFIG_COMMANDS & CFG_CMD_SAVES)
997 #ifdef CFG_LOADS_BAUD_CHANGE
999 saves, 4, 0, do_save_serial,
1000 "saves - save S-Record file over serial line\n",
1001 "[ off ] [size] [ baud ]\n"
1002 " - save S-Record file over serial line"
1003 " with offset 'off', size 'size' and baudrate 'baud'\n"
1005 #else /* ! CFG_LOADS_BAUD_CHANGE */
1007 saves, 3, 0, do_save_serial,
1008 "saves - save S-Record file over serial line\n",
1010 " - save S-Record file over serial line with offset 'off' and size 'size'\n"
1012 #endif /* CFG_LOADS_BAUD_CHANGE */
1013 #endif /* CFG_CMD_SAVES */
1014 #endif /* CFG_CMD_LOADS */
1017 #if (CONFIG_COMMANDS & CFG_CMD_LOADB)
1019 loadb, 3, 0, do_load_serial_bin,
1020 "loadb - load binary file over serial line (kermit mode)\n",
1021 "[ off ] [ baud ]\n"
1022 " - load binary file over serial line"
1023 " with offset 'off' and baudrate 'baud'\n"
1026 #endif /* CFG_CMD_LOADB */
1028 /* -------------------------------------------------------------------- */
1030 #if (CONFIG_COMMANDS & CFG_CMD_HWFLOW)
1031 int do_hwflow (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
1033 extern int hwflow_onoff(int);
1036 if (strcmp(argv[1], "off") == 0)
1039 if (strcmp(argv[1], "on") == 0)
1042 printf("Usage: %s\n", cmdtp->usage);
1044 printf("RTS/CTS hardware flow control: %s\n", hwflow_onoff(0) ? "on" : "off");
1048 /* -------------------------------------------------------------------- */
1051 hwflow [on|off], 2, 0, do_hwflow,
1052 "hwflow - turn the harwdare flow control on/off\n",
1053 "\n - change RTS/CTS hardware flow control over serial line\n"
1056 #endif /* CFG_CMD_HWFLOW */