1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2000-2004
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
8 * Serial up- and download support
14 #include <efi_loader.h>
24 #include <asm/cache.h>
25 #include <asm/global_data.h>
26 #include <linux/delay.h>
28 DECLARE_GLOBAL_DATA_PTR;
30 #if defined(CONFIG_CMD_LOADB)
31 static ulong load_serial_ymodem(ulong offset, int mode);
34 #if defined(CONFIG_CMD_LOADS)
35 static ulong load_serial(long offset);
36 static int read_record(char *buf, ulong len);
37 # if defined(CONFIG_CMD_SAVES)
38 static int save_serial(ulong offset, ulong size);
39 static int write_record(char *buf);
42 static int do_echo = 1;
45 /* -------------------------------------------------------------------- */
47 #if defined(CONFIG_CMD_LOADS)
48 static int do_load_serial(struct cmd_tbl *cmdtp, int flag, int argc,
56 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
57 int load_baudrate, current_baudrate;
59 load_baudrate = current_baudrate = gd->baudrate;
62 env_echo = env_get("loads_echo");
63 if (env_echo && *env_echo == '1')
68 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
70 offset = simple_strtol(argv[1], NULL, 16);
73 load_baudrate = (int)dectoul(argv[2], NULL);
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;
87 if (getchar() == '\r')
91 #else /* ! CONFIG_SYS_LOADS_BAUD_CHANGE */
93 offset = simple_strtol(argv[1], NULL, 16);
95 #endif /* CONFIG_SYS_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);
118 image_load_addr = addr;
121 #ifdef CONFIG_SYS_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 (getchar() == 0x1B) /* ESC */
138 static ulong load_serial(long offset)
140 char record[SREC_MAXRECLEN + 1]; /* buffer for one S-Record */
141 char binbuf[SREC_MAXBINLEN]; /* buffer for binary data */
142 int binlen; /* no. of data bytes in S-Rec. */
143 int type; /* return code for record type */
144 ulong addr; /* load address from S-Record */
145 ulong size; /* number of bytes transferred */
147 ulong start_addr = ~0;
151 while (read_record(record, SREC_MAXRECLEN + 1) >= 0) {
152 type = srec_decode(record, &binlen, &addr, binbuf);
155 return (~0); /* Invalid S-Record */
162 store_addr = addr + offset;
163 #ifdef CONFIG_MTD_NOR_FLASH
164 if (addr2info(store_addr)) {
167 rc = flash_write((char *)binbuf,store_addr,binlen);
175 memcpy((char *)(store_addr), binbuf, binlen);
177 if ((store_addr) < start_addr)
178 start_addr = store_addr;
179 if ((store_addr + binlen - 1) > end_addr)
180 end_addr = store_addr + binlen - 1;
186 size = end_addr - start_addr + 1;
188 "## First Load Addr = 0x%08lX\n"
189 "## Last Load Addr = 0x%08lX\n"
190 "## Total Size = 0x%08lX = %ld Bytes\n",
191 start_addr, end_addr, size, size
193 flush_cache(start_addr, size);
194 env_set_hex("filesize", size);
201 if (!do_echo) { /* print a '.' every 100 lines */
202 if ((++line_count % 100) == 0)
207 return (~0); /* Download aborted */
210 static int read_record(char *buf, ulong len)
215 --len; /* always leave room for terminating '\0' byte */
217 for (p=buf; p < buf+len; ++p) {
218 c = getchar(); /* read character */
220 putc(c); /* ... and echo it */
228 case 0x03: /* ^C - Control C */
234 /* Check for the console hangup (if any different from serial) */
235 if (gd->jt->getc != getchar) {
241 /* line too long - truncate */
246 #if defined(CONFIG_CMD_SAVES)
248 int do_save_serial(struct cmd_tbl *cmdtp, int flag, int argc,
253 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
254 int save_baudrate, current_baudrate;
256 save_baudrate = current_baudrate = gd->baudrate;
260 offset = hextoul(argv[1], NULL);
262 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
264 size = hextoul(argv[2], NULL);
267 save_baudrate = (int)dectoul(argv[3], NULL);
269 /* default to current baudrate */
270 if (save_baudrate == 0)
271 save_baudrate = current_baudrate;
273 if (save_baudrate != current_baudrate) {
274 printf("## Switch baudrate to %d bps and press ENTER ...\n",
277 gd->baudrate = save_baudrate;
281 if (getchar() == '\r')
285 #else /* ! CONFIG_SYS_LOADS_BAUD_CHANGE */
287 size = hextoul(argv[2], NULL);
289 #endif /* CONFIG_SYS_LOADS_BAUD_CHANGE */
291 printf("## Ready for S-Record upload, press ENTER to proceed ...\n");
293 if (getchar() == '\r')
296 if (save_serial(offset, size)) {
297 printf("## S-Record upload aborted\n");
299 printf("## S-Record upload complete\n");
301 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
302 if (save_baudrate != current_baudrate) {
303 printf("## Switch baudrate to %d bps and press ESC ...\n",
304 (int)current_baudrate);
306 gd->baudrate = current_baudrate;
310 if (getchar() == 0x1B) /* ESC */
318 #define SREC3_START "S0030000FC\n"
319 #define SREC3_FORMAT "S3%02X%08lX%s%02X\n"
320 #define SREC3_END "S70500000000FA\n"
321 #define SREC_BYTES_PER_RECORD 16
323 static int save_serial(ulong address, ulong count)
325 int i, c, reclen, checksum, length;
326 char *hex = "0123456789ABCDEF";
327 char record[2*SREC_BYTES_PER_RECORD+16]; /* buffer for one S-Record */
328 char data[2*SREC_BYTES_PER_RECORD+1]; /* buffer for hex data */
333 if(write_record(SREC3_START)) /* write the header */
336 if(count) { /* collect hex data in the buffer */
337 c = *(volatile uchar*)(address + reclen); /* get one byte */
338 checksum += c; /* accumulate checksum */
339 data[2*reclen] = hex[(c>>4)&0x0f];
340 data[2*reclen+1] = hex[c & 0x0f];
341 data[2*reclen+2] = '\0';
345 if(reclen == SREC_BYTES_PER_RECORD || count == 0) {
346 /* enough data collected for one record: dump it */
347 if(reclen) { /* build & write a data record: */
348 /* address + data + checksum */
349 length = 4 + reclen + 1;
351 /* accumulate length bytes into checksum */
352 for(i = 0; i < 2; i++)
353 checksum += (length >> (8*i)) & 0xff;
355 /* accumulate address bytes into checksum: */
356 for(i = 0; i < 4; i++)
357 checksum += (address >> (8*i)) & 0xff;
359 /* make proper checksum byte: */
360 checksum = ~checksum & 0xff;
362 /* output one record: */
363 sprintf(record, SREC3_FORMAT, length, address, data, checksum);
364 if(write_record(record))
367 address += reclen; /* increment address */
373 if(write_record(SREC3_END)) /* write the final record */
378 static int write_record(char *buf)
385 /* Check for the console hangup (if any different from serial) */
397 #if defined(CONFIG_CMD_LOADB)
399 * loadb command (load binary) included
403 #define START_CHAR 0x01
404 #define ETX_CHAR 0x03
405 #define END_CHAR 0x0D
407 #define K_ESCAPE 0x23
408 #define SEND_TYPE 'S'
409 #define DATA_TYPE 'D'
411 #define NACK_TYPE 'N'
412 #define BREAK_TYPE 'B'
413 #define tochar(x) ((char) (((x) + SPACE) & 0xff))
414 #define untochar(x) ((int) (((x) - SPACE) & 0xff))
416 static void set_kerm_bin_mode(unsigned long *);
417 static int k_recv(void);
418 static ulong load_serial_bin(ulong offset);
421 static char his_eol; /* character he needs at end of packet */
422 static int his_pad_count; /* number of pad chars he needs */
423 static char his_pad_char; /* pad chars he needs */
424 static char his_quote; /* quote chars he'll use */
426 static int do_load_serial_bin(struct cmd_tbl *cmdtp, int flag, int argc,
431 int load_baudrate, current_baudrate;
435 /* pre-set offset from CONFIG_SYS_LOAD_ADDR */
436 offset = CONFIG_SYS_LOAD_ADDR;
438 /* pre-set offset from $loadaddr */
439 s = env_get("loadaddr");
441 offset = hextoul(s, NULL);
443 load_baudrate = current_baudrate = gd->baudrate;
446 offset = hextoul(argv[1], NULL);
449 load_baudrate = (int)dectoul(argv[2], NULL);
451 /* default to current baudrate */
452 if (load_baudrate == 0)
453 load_baudrate = current_baudrate;
456 if (load_baudrate != current_baudrate) {
457 printf("## Switch baudrate to %d bps and press ENTER ...\n",
460 gd->baudrate = load_baudrate;
464 if (getchar() == '\r')
469 if (strcmp(argv[0],"loady")==0) {
470 printf("## Ready for binary (ymodem) download "
471 "to 0x%08lX at %d bps...\n",
475 addr = load_serial_ymodem(offset, xyzModem_ymodem);
477 } else if (strcmp(argv[0],"loadx")==0) {
478 printf("## Ready for binary (xmodem) download "
479 "to 0x%08lX at %d bps...\n",
483 addr = load_serial_ymodem(offset, xyzModem_xmodem);
487 printf("## Ready for binary (kermit) download "
488 "to 0x%08lX at %d bps...\n",
491 addr = load_serial_bin(offset);
495 printf("## Binary (kermit) download aborted\n");
498 printf("## Start Addr = 0x%08lX\n", addr);
499 image_load_addr = addr;
502 if (load_baudrate != current_baudrate) {
503 printf("## Switch baudrate to %d bps and press ESC ...\n",
506 gd->baudrate = current_baudrate;
510 if (getchar() == 0x1B) /* ESC */
519 static ulong load_serial_bin(ulong offset)
523 set_kerm_bin_mode((ulong *) offset);
527 * Gather any trailing characters (for instance, the ^D which
528 * is sent by 'cu' after sending a file), and give the
529 * box some time (100 * 1 ms)
531 for (i=0; i<100; ++i) {
539 return ~0; /* Download aborted */
541 flush_cache(offset, size);
543 printf("## Total Size = 0x%08x = %d Bytes\n", size, size);
544 env_set_hex("filesize", size);
549 static void send_pad(void)
551 int count = his_pad_count;
557 /* converts escaped kermit char to binary char */
558 static char ktrans(char in)
560 if ((in & 0x60) == 0x40) {
561 return (char) (in & ~0x40);
562 } else if ((in & 0x7f) == 0x3f) {
563 return (char) (in | 0x40);
568 static int chk1(char *buffer)
575 return (int) ((total + ((total >> 6) & 0x03)) & 0x3f);
578 static void s1_sendpacket(char *packet)
587 static void send_ack(int n)
594 a_b[4] = tochar(chk1(&a_b[1]));
600 static void send_nack(int n)
607 a_b[4] = tochar(chk1(&a_b[1]));
614 static void (*os_data_init)(void);
615 static void (*os_data_char)(char new_char);
616 static int os_data_state, os_data_state_saved;
617 static char *os_data_addr, *os_data_addr_saved;
618 static char *bin_start_address;
620 static void bin_data_init(void)
623 os_data_addr = bin_start_address;
626 static void os_data_save(void)
628 os_data_state_saved = os_data_state;
629 os_data_addr_saved = os_data_addr;
632 static void os_data_restore(void)
634 os_data_state = os_data_state_saved;
635 os_data_addr = os_data_addr_saved;
638 static void bin_data_char(char new_char)
640 switch (os_data_state) {
642 *os_data_addr++ = new_char;
647 static void set_kerm_bin_mode(unsigned long *addr)
649 bin_start_address = (char *) addr;
650 os_data_init = bin_data_init;
651 os_data_char = bin_data_char;
655 /* k_data_* simply handles the kermit escape translations */
656 static int k_data_escape, k_data_escape_saved;
657 static void k_data_init(void)
663 static void k_data_save(void)
665 k_data_escape_saved = k_data_escape;
669 static void k_data_restore(void)
671 k_data_escape = k_data_escape_saved;
675 static 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 static char send_parms[SEND_DATA_SIZE];
694 static char *send_ptr;
696 /* handle_send_packet interprits the protocol info and builds and
697 sends an appropriate ack for what we can do */
698 static 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;
795 /* initialize some protocol parameters */
796 his_eol = END_CHAR; /* default end of line character */
799 his_quote = K_ESCAPE;
801 /* initialize the k_recv and k_data state machine */
805 k_state_saved = k_state;
807 n = 0; /* just to get rid of a warning */
810 /* expect this "type" sequence (but don't check):
815 B: break transmission
818 /* enter main loop */
820 /* set the send packet pointer to begining of send packet parms */
821 send_ptr = send_parms;
823 /* With each packet, start summing the bytes starting with the length.
824 Save the current sequence number.
825 Note the type of the packet.
826 If a character less than SPACE (0x20) is received - error.
830 /* OLD CODE, Prior to checking sequence numbers */
831 /* first have all state machines save current states */
832 k_state_saved = k_state;
837 /* wait for the starting character or ^C */
840 case START_CHAR: /* start packet */
842 case ETX_CHAR: /* ^C waiting for packet */
849 /* get length of packet */
851 new_char = getchar();
852 if ((new_char & 0xE0) == 0)
854 sum += new_char & 0xff;
855 length = untochar(new_char);
856 /* get sequence number */
857 new_char = getchar();
858 if ((new_char & 0xE0) == 0)
860 sum += new_char & 0xff;
861 n = untochar(new_char);
864 /* NEW CODE - check sequence numbers for retried packets */
865 /* Note - this new code assumes that the sequence number is correctly
866 * received. Handling an invalid sequence number adds another layer
867 * of complexity that may not be needed - yet! At this time, I'm hoping
868 * that I don't need to buffer the incoming data packets and can write
869 * the data into memory in real time.
872 /* same sequence number, restore the previous state */
873 k_state = k_state_saved;
876 /* new sequence number, checkpoint the download */
878 k_state_saved = k_state;
883 /* get packet type */
884 new_char = getchar();
885 if ((new_char & 0xE0) == 0)
887 sum += new_char & 0xff;
890 /* check for extended length */
892 /* (length byte was 0, decremented twice) */
893 /* get the two length bytes */
894 new_char = getchar();
895 if ((new_char & 0xE0) == 0)
897 sum += new_char & 0xff;
898 len_hi = untochar(new_char);
899 new_char = getchar();
900 if ((new_char & 0xE0) == 0)
902 sum += new_char & 0xff;
903 len_lo = untochar(new_char);
904 length = len_hi * 95 + len_lo;
905 /* check header checksum */
906 new_char = getchar();
907 if ((new_char & 0xE0) == 0)
909 if (new_char != tochar((sum + ((sum >> 6) & 0x03)) & 0x3f))
911 sum += new_char & 0xff;
912 /* --length; */ /* new length includes only data and block check to come */
914 /* bring in rest of packet */
916 new_char = getchar();
917 if ((new_char & 0xE0) == 0)
919 sum += new_char & 0xff;
921 if (k_state == DATA_TYPE) {
922 /* pass on the data if this is a data packet */
923 k_data_char (new_char);
924 } else if (k_state == SEND_TYPE) {
925 /* save send pack in buffer as is */
926 *send_ptr++ = new_char;
927 /* if too much data, back off the pointer */
928 if (send_ptr >= &send_parms[SEND_DATA_SIZE])
932 /* get and validate checksum character */
933 new_char = getchar();
934 if ((new_char & 0xE0) == 0)
936 if (new_char != tochar((sum + ((sum >> 6) & 0x03)) & 0x3f))
939 new_char = getchar();
940 if (new_char != END_CHAR) {
942 /* restore state machines */
943 k_state = k_state_saved;
945 /* send a negative acknowledge packet in */
947 } else if (k_state == SEND_TYPE) {
948 /* crack the protocol parms, build an appropriate ack packet */
949 handle_send_packet(n);
951 /* send simple acknowledge packet in */
953 /* quit if end of transmission */
954 if (k_state == BREAK_TYPE)
958 return ((ulong) os_data_addr - (ulong) bin_start_address);
961 static int getcxmodem(void) {
966 static ulong load_serial_ymodem(ulong offset, int mode)
971 connection_info_t info;
972 char ymodemBuf[1024];
973 ulong store_addr = ~0;
978 res = xyzModem_stream_open(&info, &err);
982 xyzModem_stream_read(ymodemBuf, 1024, &err)) > 0) {
983 store_addr = addr + offset;
986 #ifdef CONFIG_MTD_NOR_FLASH
987 if (addr2info(store_addr)) {
990 rc = flash_write((char *) ymodemBuf,
999 memcpy((char *)(store_addr), ymodemBuf,
1004 if (IS_ENABLED(CONFIG_CMD_BOOTEFI))
1005 efi_set_bootdev("Uart", "", "",
1006 map_sysmem(offset, 0), size);
1009 printf("%s\n", xyzModem_error(err));
1012 xyzModem_stream_terminate(false, &getcxmodem);
1013 xyzModem_stream_close(&err);
1016 flush_cache(offset, ALIGN(size, ARCH_DMA_MINALIGN));
1018 printf("## Total Size = 0x%08x = %d Bytes\n", size, size);
1019 env_set_hex("filesize", size);
1026 /* -------------------------------------------------------------------- */
1028 #if defined(CONFIG_CMD_LOADS)
1030 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
1032 loads, 3, 0, do_load_serial,
1033 "load S-Record file over serial line",
1034 "[ off ] [ baud ]\n"
1035 " - load S-Record file over serial line"
1036 " with offset 'off' and baudrate 'baud'"
1039 #else /* ! CONFIG_SYS_LOADS_BAUD_CHANGE */
1041 loads, 2, 0, do_load_serial,
1042 "load S-Record file over serial line",
1044 " - load S-Record file over serial line with offset 'off'"
1046 #endif /* CONFIG_SYS_LOADS_BAUD_CHANGE */
1049 * SAVES always requires LOADS support, but not vice versa
1053 #if defined(CONFIG_CMD_SAVES)
1054 #ifdef CONFIG_SYS_LOADS_BAUD_CHANGE
1056 saves, 4, 0, do_save_serial,
1057 "save S-Record file over serial line",
1058 "[ off ] [size] [ baud ]\n"
1059 " - save S-Record file over serial line"
1060 " with offset 'off', size 'size' and baudrate 'baud'"
1062 #else /* ! CONFIG_SYS_LOADS_BAUD_CHANGE */
1064 saves, 3, 0, do_save_serial,
1065 "save S-Record file over serial line",
1067 " - save S-Record file over serial line with offset 'off' and size 'size'"
1069 #endif /* CONFIG_SYS_LOADS_BAUD_CHANGE */
1070 #endif /* CONFIG_CMD_SAVES */
1071 #endif /* CONFIG_CMD_LOADS */
1074 #if defined(CONFIG_CMD_LOADB)
1076 loadb, 3, 0, do_load_serial_bin,
1077 "load binary file over serial line (kermit mode)",
1078 "[ addr [ baud ] ]\n"
1079 " - load binary file over serial line"
1080 " at address 'addr' with baudrate 'baud'"
1084 loadx, 3, 0, do_load_serial_bin,
1085 "load binary file over serial line (xmodem mode)",
1086 "[ addr [ baud ] ]\n"
1087 " - load binary file over serial line"
1088 " at address 'addr' with baudrate 'baud'"
1092 loady, 3, 0, do_load_serial_bin,
1093 "load binary file over serial line (ymodem mode)",
1094 "[ addr [ baud ] ]\n"
1095 " - load binary file over serial line"
1096 " at address 'addr' with baudrate 'baud'"
1099 #endif /* CONFIG_CMD_LOADB */