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
33 DECLARE_GLOBAL_DATA_PTR;
35 #if (CONFIG_COMMANDS & CFG_CMD_LOADS)
36 static ulong load_serial (ulong offset);
37 static int read_record (char *buf, ulong len);
38 # if (CONFIG_COMMANDS & CFG_CMD_SAVES)
39 static int save_serial (ulong offset, ulong size);
40 static int write_record (char *buf);
41 # endif /* CFG_CMD_SAVES */
43 static int do_echo = 1;
44 #endif /* CFG_CMD_LOADS */
46 /* -------------------------------------------------------------------- */
48 #if (CONFIG_COMMANDS & CFG_CMD_LOADS)
49 int do_load_serial (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
56 #ifdef CFG_LOADS_BAUD_CHANGE
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) {
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((char *)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 (start_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 = getc(); /* read character */
224 putc (c); /* ... and echo it */
232 case 0x03: /* ^C - Control C */
238 /* Check for the console hangup (if any different from serial) */
239 if (gd->jt[XF_getc] != getc) {
246 /* line too long - truncate */
251 #if (CONFIG_COMMANDS & CFG_CMD_SAVES)
253 int do_save_serial (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
257 #ifdef CFG_LOADS_BAUD_CHANGE
258 int save_baudrate, current_baudrate;
260 save_baudrate = current_baudrate = gd->baudrate;
264 offset = simple_strtoul(argv[1], NULL, 16);
266 #ifdef CFG_LOADS_BAUD_CHANGE
268 size = simple_strtoul(argv[2], NULL, 16);
271 save_baudrate = (int)simple_strtoul(argv[3], NULL, 10);
273 /* default to current baudrate */
274 if (save_baudrate == 0)
275 save_baudrate = current_baudrate;
277 if (save_baudrate != current_baudrate) {
278 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
281 gd->baudrate = save_baudrate;
289 #else /* ! CFG_LOADS_BAUD_CHANGE */
291 size = simple_strtoul(argv[2], NULL, 16);
293 #endif /* CFG_LOADS_BAUD_CHANGE */
295 printf ("## Ready for S-Record upload, press ENTER to proceed ...\n");
300 if(save_serial (offset, size)) {
301 printf ("## S-Record upload aborted\n");
303 printf ("## S-Record upload complete\n");
305 #ifdef CFG_LOADS_BAUD_CHANGE
306 if (save_baudrate != current_baudrate) {
307 printf ("## Switch baudrate to %d bps and press ESC ...\n",
308 (int)current_baudrate);
310 gd->baudrate = current_baudrate;
314 if (getc() == 0x1B) /* ESC */
322 #define SREC3_START "S0030000FC\n"
323 #define SREC3_FORMAT "S3%02X%08lX%s%02X\n"
324 #define SREC3_END "S70500000000FA\n"
325 #define SREC_BYTES_PER_RECORD 16
327 static int save_serial (ulong address, ulong count)
329 int i, c, reclen, checksum, length;
330 char *hex = "0123456789ABCDEF";
331 char record[2*SREC_BYTES_PER_RECORD+16]; /* buffer for one S-Record */
332 char data[2*SREC_BYTES_PER_RECORD+1]; /* buffer for hex data */
337 if(write_record(SREC3_START)) /* write the header */
340 if(count) { /* collect hex data in the buffer */
341 c = *(volatile uchar*)(address + reclen); /* get one byte */
342 checksum += c; /* accumulate checksum */
343 data[2*reclen] = hex[(c>>4)&0x0f];
344 data[2*reclen+1] = hex[c & 0x0f];
345 data[2*reclen+2] = '\0';
349 if(reclen == SREC_BYTES_PER_RECORD || count == 0) {
350 /* enough data collected for one record: dump it */
351 if(reclen) { /* build & write a data record: */
352 /* address + data + checksum */
353 length = 4 + reclen + 1;
355 /* accumulate length bytes into checksum */
356 for(i = 0; i < 2; i++)
357 checksum += (length >> (8*i)) & 0xff;
359 /* accumulate address bytes into checksum: */
360 for(i = 0; i < 4; i++)
361 checksum += (address >> (8*i)) & 0xff;
363 /* make proper checksum byte: */
364 checksum = ~checksum & 0xff;
366 /* output one record: */
367 sprintf(record, SREC3_FORMAT, length, address, data, checksum);
368 if(write_record(record))
371 address += reclen; /* increment address */
377 if(write_record(SREC3_END)) /* write the final record */
383 write_record (char *buf)
390 /* Check for the console hangup (if any different from serial) */
397 # endif /* CFG_CMD_SAVES */
399 #endif /* CFG_CMD_LOADS */
402 #if (CONFIG_COMMANDS & CFG_CMD_LOADB) /* loadb command (load binary) included */
406 #define START_CHAR 0x01
407 #define ETX_CHAR 0x03
408 #define END_CHAR 0x0D
410 #define K_ESCAPE 0x23
411 #define SEND_TYPE 'S'
412 #define DATA_TYPE 'D'
414 #define NACK_TYPE 'N'
415 #define BREAK_TYPE 'B'
416 #define tochar(x) ((char) (((x) + SPACE) & 0xff))
417 #define untochar(x) ((int) (((x) - SPACE) & 0xff))
419 extern int os_data_count;
420 extern int os_data_header[8];
422 static void set_kerm_bin_mode(unsigned long *);
423 static int k_recv(void);
424 static ulong load_serial_bin (ulong offset);
427 char his_eol; /* character he needs at end of packet */
428 int his_pad_count; /* number of pad chars he needs */
429 char his_pad_char; /* pad chars he needs */
430 char his_quote; /* quote chars he'll use */
432 int do_load_serial_bin (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
436 int load_baudrate, current_baudrate;
440 /* pre-set offset from CFG_LOAD_ADDR */
441 offset = CFG_LOAD_ADDR;
443 /* pre-set offset from $loadaddr */
444 if ((s = getenv("loadaddr")) != NULL) {
445 offset = simple_strtoul(s, NULL, 16);
448 load_baudrate = current_baudrate = gd->baudrate;
451 offset = simple_strtoul(argv[1], NULL, 16);
454 load_baudrate = (int)simple_strtoul(argv[2], NULL, 10);
456 /* default to current baudrate */
457 if (load_baudrate == 0)
458 load_baudrate = current_baudrate;
461 if (load_baudrate != current_baudrate) {
462 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
465 gd->baudrate = load_baudrate;
474 printf ("## Ready for binary (kermit) download "
475 "to 0x%08lX at %d bps...\n",
478 addr = load_serial_bin (offset);
482 printf ("## Binary (kermit) download aborted\n");
485 printf ("## Start Addr = 0x%08lX\n", addr);
489 if (load_baudrate != current_baudrate) {
490 printf ("## Switch baudrate to %d bps and press ESC ...\n",
493 gd->baudrate = current_baudrate;
497 if (getc() == 0x1B) /* ESC */
502 #ifdef CONFIG_AUTOSCRIPT
506 if (((s = getenv("autoscript")) != NULL) && (strcmp(s,"yes") == 0)) {
507 printf("Running autoscript at addr 0x%08lX ...\n", load_addr);
508 rcode = autoscript (load_addr);
516 static ulong load_serial_bin (ulong offset)
521 set_kerm_bin_mode ((ulong *) offset);
525 * Gather any trailing characters (for instance, the ^D which
526 * is sent by 'cu' after sending a file), and give the
527 * box some time (100 * 1 ms)
529 for (i=0; i<100; ++i) {
536 flush_cache (offset, size);
538 printf("## Total Size = 0x%08x = %d Bytes\n", size, size);
539 sprintf(buf, "%X", size);
540 setenv("filesize", buf);
547 int count = his_pad_count;
553 /* converts escaped kermit char to binary char */
554 char ktrans (char in)
556 if ((in & 0x60) == 0x40) {
557 return (char) (in & ~0x40);
558 } else if ((in & 0x7f) == 0x3f) {
559 return (char) (in | 0x40);
564 int chk1 (char *buffer)
571 return (int) ((total + ((total >> 6) & 0x03)) & 0x3f);
574 void s1_sendpacket (char *packet)
583 void send_ack (int n)
590 a_b[4] = tochar (chk1 (&a_b[1]));
596 void send_nack (int n)
603 a_b[4] = tochar (chk1 (&a_b[1]));
610 /* os_data_* takes an OS Open image and puts it into memory, and
611 puts the boot header in an array named os_data_header
613 if image is binary, no header is stored in os_data_header.
615 void (*os_data_init) (void);
616 void (*os_data_char) (char new_char);
617 static int os_data_state, os_data_state_saved;
619 static int os_data_count_saved;
620 static char *os_data_addr, *os_data_addr_saved;
621 static char *bin_start_address;
622 int os_data_header[8];
623 static void bin_data_init (void)
627 os_data_addr = bin_start_address;
629 static void os_data_save (void)
631 os_data_state_saved = os_data_state;
632 os_data_count_saved = os_data_count;
633 os_data_addr_saved = os_data_addr;
635 static void os_data_restore (void)
637 os_data_state = os_data_state_saved;
638 os_data_count = os_data_count_saved;
639 os_data_addr = os_data_addr_saved;
641 static void bin_data_char (char new_char)
643 switch (os_data_state) {
645 *os_data_addr++ = new_char;
650 static void set_kerm_bin_mode (unsigned long *addr)
652 bin_start_address = (char *) addr;
653 os_data_init = bin_data_init;
654 os_data_char = bin_data_char;
658 /* k_data_* simply handles the kermit escape translations */
659 static int k_data_escape, k_data_escape_saved;
660 void k_data_init (void)
665 void k_data_save (void)
667 k_data_escape_saved = k_data_escape;
670 void k_data_restore (void)
672 k_data_escape = k_data_escape_saved;
675 void k_data_char (char new_char)
678 /* last char was escape - translate this character */
679 os_data_char (ktrans (new_char));
682 if (new_char == his_quote) {
683 /* this char is escape - remember */
686 /* otherwise send this char as-is */
687 os_data_char (new_char);
692 #define SEND_DATA_SIZE 20
693 char send_parms[SEND_DATA_SIZE];
696 /* handle_send_packet interprits the protocol info and builds and
697 sends an appropriate ack for what we can do */
698 void handle_send_packet (int n)
703 /* initialize some protocol parameters */
704 his_eol = END_CHAR; /* default end of line character */
707 his_quote = K_ESCAPE;
709 /* ignore last character if it filled the buffer */
710 if (send_ptr == &send_parms[SEND_DATA_SIZE - 1])
712 bytes = send_ptr - send_parms; /* how many bytes we'll process */
716 /* handle MAXL - max length */
717 /* ignore what he says - most I'll take (here) is 94 */
718 a_b[++length] = tochar (94);
721 /* handle TIME - time you should wait for my packets */
722 /* ignore what he says - don't wait for my ack longer than 1 second */
723 a_b[++length] = tochar (1);
726 /* handle NPAD - number of pad chars I need */
727 /* remember what he says - I need none */
728 his_pad_count = untochar (send_parms[2]);
729 a_b[++length] = tochar (0);
732 /* handle PADC - pad chars I need */
733 /* remember what he says - I need none */
734 his_pad_char = ktrans (send_parms[3]);
735 a_b[++length] = 0x40; /* He should ignore this */
738 /* handle EOL - end of line he needs */
739 /* remember what he says - I need CR */
740 his_eol = untochar (send_parms[4]);
741 a_b[++length] = tochar (END_CHAR);
744 /* handle QCTL - quote control char he'll use */
745 /* remember what he says - I'll use '#' */
746 his_quote = send_parms[5];
750 /* handle QBIN - 8-th bit prefixing */
751 /* ignore what he says - I refuse */
755 /* handle CHKT - the clock check type */
756 /* ignore what he says - I do type 1 (for now) */
760 /* handle REPT - the repeat prefix */
761 /* ignore what he says - I refuse (for now) */
765 /* handle CAPAS - the capabilities mask */
766 /* ignore what he says - I only do long packets - I don't do windows */
767 a_b[++length] = tochar (2); /* only long packets */
768 a_b[++length] = tochar (0); /* no windows */
769 a_b[++length] = tochar (94); /* large packet msb */
770 a_b[++length] = tochar (94); /* large packet lsb */
774 a_b[1] = tochar (length);
777 a_b[++length] = '\0';
778 a_b[length] = tochar (chk1 (&a_b[1]));
779 a_b[++length] = his_eol;
780 a_b[++length] = '\0';
784 /* k_recv receives a OS Open image file over kermit line */
785 static int k_recv (void)
788 char k_state, k_state_saved;
796 /* initialize some protocol parameters */
797 his_eol = END_CHAR; /* default end of line character */
800 his_quote = K_ESCAPE;
802 /* initialize the k_recv and k_data state machine */
806 k_state_saved = k_state;
808 n = 0; /* just to get rid of a warning */
811 /* expect this "type" sequence (but don't check):
816 B: break transmission
819 /* enter main loop */
821 /* set the send packet pointer to begining of send packet parms */
822 send_ptr = send_parms;
824 /* With each packet, start summing the bytes starting with the length.
825 Save the current sequence number.
826 Note the type of the packet.
827 If a character less than SPACE (0x20) is received - error.
831 /* OLD CODE, Prior to checking sequence numbers */
832 /* first have all state machines save current states */
833 k_state_saved = k_state;
838 /* wait for the starting character or ^C */
841 case START_CHAR: /* start packet */
843 case ETX_CHAR: /* ^C waiting for packet */
850 /* get length of packet */
853 if ((new_char & 0xE0) == 0)
855 sum += new_char & 0xff;
856 length = untochar (new_char);
857 /* get sequence number */
859 if ((new_char & 0xE0) == 0)
861 sum += new_char & 0xff;
862 n = untochar (new_char);
865 /* NEW CODE - check sequence numbers for retried packets */
866 /* Note - this new code assumes that the sequence number is correctly
867 * received. Handling an invalid sequence number adds another layer
868 * of complexity that may not be needed - yet! At this time, I'm hoping
869 * that I don't need to buffer the incoming data packets and can write
870 * the data into memory in real time.
873 /* same sequence number, restore the previous state */
874 k_state = k_state_saved;
877 /* new sequence number, checkpoint the download */
879 k_state_saved = k_state;
884 /* get packet type */
886 if ((new_char & 0xE0) == 0)
888 sum += new_char & 0xff;
891 /* check for extended length */
893 /* (length byte was 0, decremented twice) */
894 /* get the two length bytes */
896 if ((new_char & 0xE0) == 0)
898 sum += new_char & 0xff;
899 len_hi = untochar (new_char);
901 if ((new_char & 0xE0) == 0)
903 sum += new_char & 0xff;
904 len_lo = untochar (new_char);
905 length = len_hi * 95 + len_lo;
906 /* check header checksum */
908 if ((new_char & 0xE0) == 0)
910 if (new_char != tochar ((sum + ((sum >> 6) & 0x03)) & 0x3f))
912 sum += new_char & 0xff;
913 /* --length; */ /* new length includes only data and block check to come */
915 /* bring in rest of packet */
918 if ((new_char & 0xE0) == 0)
920 sum += new_char & 0xff;
922 if (k_state == DATA_TYPE) {
923 /* pass on the data if this is a data packet */
924 k_data_char (new_char);
925 } else if (k_state == SEND_TYPE) {
926 /* save send pack in buffer as is */
927 *send_ptr++ = new_char;
928 /* if too much data, back off the pointer */
929 if (send_ptr >= &send_parms[SEND_DATA_SIZE])
933 /* get and validate checksum character */
935 if ((new_char & 0xE0) == 0)
937 if (new_char != tochar ((sum + ((sum >> 6) & 0x03)) & 0x3f))
941 if (new_char != END_CHAR) {
943 /* restore state machines */
944 k_state = k_state_saved;
946 /* send a negative acknowledge packet in */
948 } else if (k_state == SEND_TYPE) {
949 /* crack the protocol parms, build an appropriate ack packet */
950 handle_send_packet (n);
952 /* send simple acknowledge packet in */
954 /* quit if end of transmission */
955 if (k_state == BREAK_TYPE)
960 return ((ulong) os_data_addr - (ulong) bin_start_address);
962 #endif /* CFG_CMD_LOADB */
964 /* -------------------------------------------------------------------- */
966 #if (CONFIG_COMMANDS & CFG_CMD_LOADS)
968 #ifdef CFG_LOADS_BAUD_CHANGE
970 loads, 3, 0, do_load_serial,
971 "loads - load S-Record file over serial line\n",
973 " - load S-Record file over serial line"
974 " with offset 'off' and baudrate 'baud'\n"
977 #else /* ! CFG_LOADS_BAUD_CHANGE */
979 loads, 2, 0, do_load_serial,
980 "loads - load S-Record file over serial line\n",
982 " - load S-Record file over serial line with offset 'off'\n"
984 #endif /* CFG_LOADS_BAUD_CHANGE */
987 * SAVES always requires LOADS support, but not vice versa
991 #if (CONFIG_COMMANDS & CFG_CMD_SAVES)
992 #ifdef CFG_LOADS_BAUD_CHANGE
994 saves, 4, 0, do_save_serial,
995 "saves - save S-Record file over serial line\n",
996 "[ off ] [size] [ baud ]\n"
997 " - save S-Record file over serial line"
998 " with offset 'off', size 'size' and baudrate 'baud'\n"
1000 #else /* ! CFG_LOADS_BAUD_CHANGE */
1002 saves, 3, 0, do_save_serial,
1003 "saves - save S-Record file over serial line\n",
1005 " - save S-Record file over serial line with offset 'off' and size 'size'\n"
1007 #endif /* CFG_LOADS_BAUD_CHANGE */
1008 #endif /* CFG_CMD_SAVES */
1009 #endif /* CFG_CMD_LOADS */
1012 #if (CONFIG_COMMANDS & CFG_CMD_LOADB)
1014 loadb, 3, 0, do_load_serial_bin,
1015 "loadb - load binary file over serial line (kermit mode)\n",
1016 "[ off ] [ baud ]\n"
1017 " - load binary file over serial line"
1018 " with offset 'off' and baudrate 'baud'\n"
1021 #endif /* CFG_CMD_LOADB */
1023 /* -------------------------------------------------------------------- */
1025 #if (CONFIG_COMMANDS & CFG_CMD_HWFLOW)
1026 int do_hwflow (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
1028 extern int hwflow_onoff(int);
1031 if (strcmp(argv[1], "off") == 0)
1034 if (strcmp(argv[1], "on") == 0)
1037 printf("Usage: %s\n", cmdtp->usage);
1039 printf("RTS/CTS hardware flow control: %s\n", hwflow_onoff(0) ? "on" : "off");
1043 /* -------------------------------------------------------------------- */
1046 hwflow, 2, 0, do_hwflow,
1047 "hwflow - turn the harwdare flow control on/off\n",
1048 "[on|off]\n - change RTS/CTS hardware flow control over serial line\n"
1051 #endif /* CFG_CMD_HWFLOW */