2 * Copyright 1994, 1995, 2000 Neil Russell.
4 * Copyright 2000, 2001 DENX Software Engineering, Wolfgang Denk, wd@denx.de
5 * Copyright 2011 Comelit Group SpA,
6 * Luca Ceresoli <luca.ceresoli@comelit.it>
15 /* Well known TFTP port # */
16 #define WELL_KNOWN_PORT 69
17 /* Millisecs to timeout for lost pkt */
18 #define TIMEOUT 5000UL
19 #ifndef CONFIG_NET_RETRY_COUNT
20 /* # of timeouts before giving up */
21 # define TIMEOUT_COUNT 10
23 # define TIMEOUT_COUNT (CONFIG_NET_RETRY_COUNT * 2)
25 /* Number of "loading" hashes per line (for checking the image size) */
26 #define HASHES_PER_LINE 65
38 static ulong TftpTimeoutMSecs = TIMEOUT;
39 static int TftpTimeoutCountMax = TIMEOUT_COUNT;
42 * These globals govern the timeout behavior when attempting a connection to a
43 * TFTP server. TftpRRQTimeoutMSecs specifies the number of milliseconds to
44 * wait for the server to respond to initial connection. Second global,
45 * TftpRRQTimeoutCountMax, gives the number of such connection retries.
46 * TftpRRQTimeoutCountMax must be non-negative and TftpRRQTimeoutMSecs must be
47 * positive. The globals are meant to be set (and restored) by code needing
48 * non-standard timeout behavior when initiating a TFTP transfer.
50 ulong TftpRRQTimeoutMSecs = TIMEOUT;
51 int TftpRRQTimeoutCountMax = TIMEOUT_COUNT;
54 TFTP_ERR_UNDEFINED = 0,
55 TFTP_ERR_FILE_NOT_FOUND = 1,
56 TFTP_ERR_ACCESS_DENIED = 2,
57 TFTP_ERR_DISK_FULL = 3,
58 TFTP_ERR_UNEXPECTED_OPCODE = 4,
59 TFTP_ERR_UNKNOWN_TRANSFER_ID = 5,
60 TFTP_ERR_FILE_ALREADY_EXISTS = 6,
63 static IPaddr_t TftpRemoteIP;
64 /* The UDP port at their end */
65 static int TftpRemotePort;
66 /* The UDP port at our end */
67 static int TftpOurPort;
68 static int TftpTimeoutCount;
69 /* packet sequence number */
70 static ulong TftpBlock;
71 /* last packet sequence number received */
72 static ulong TftpLastBlock;
73 /* count of sequence number wraparounds */
74 static ulong TftpBlockWrap;
75 /* memory offset due to wrapping */
76 static ulong TftpBlockWrapOffset;
78 #ifdef CONFIG_TFTP_TSIZE
79 /* The file size reported by the server */
81 /* The number of hashes we printed */
82 static short TftpNumchars;
85 #define STATE_SEND_RRQ 1
87 #define STATE_TOO_LARGE 3
88 #define STATE_BAD_MAGIC 4
90 #define STATE_RECV_WRQ 6
92 /* default TFTP block size */
93 #define TFTP_BLOCK_SIZE 512
94 /* sequence number is 16 bit */
95 #define TFTP_SEQUENCE_SIZE ((ulong)(1<<16))
97 #define DEFAULT_NAME_LEN (8 + 4 + 1)
98 static char default_filename[DEFAULT_NAME_LEN];
100 #ifndef CONFIG_TFTP_FILE_NAME_MAX_LEN
103 #define MAX_LEN CONFIG_TFTP_FILE_NAME_MAX_LEN
106 static char tftp_filename[MAX_LEN];
108 #ifdef CONFIG_SYS_DIRECT_FLASH_TFTP
109 extern flash_info_t flash_info[];
112 /* 512 is poor choice for ethernet, MTU is typically 1500.
113 * Minus eth.hdrs thats 1468. Can get 2x better throughput with
114 * almost-MTU block sizes. At least try... fall back to 512 if need be.
115 * (but those using CONFIG_IP_DEFRAG may want to set a larger block in cfg file)
117 #ifdef CONFIG_TFTP_BLOCKSIZE
118 #define TFTP_MTU_BLOCKSIZE CONFIG_TFTP_BLOCKSIZE
120 #define TFTP_MTU_BLOCKSIZE 1468
123 static unsigned short TftpBlkSize = TFTP_BLOCK_SIZE;
124 static unsigned short TftpBlkSizeOption = TFTP_MTU_BLOCKSIZE;
126 #ifdef CONFIG_MCAST_TFTP
128 #define MTFTP_BITMAPSIZE 0x1000
129 static unsigned *Bitmap;
130 static int PrevBitmapHole, Mapsize = MTFTP_BITMAPSIZE;
131 static uchar ProhibitMcast, MasterClient;
132 static uchar Multicast;
133 extern IPaddr_t Mcast_addr;
134 static int Mcast_port;
135 static ulong TftpEndingBlock; /* can get 'last' block before done..*/
137 static void parse_multicast_oack(char *pkt, int len);
143 eth_mcast_join(Mcast_addr, 0);
147 Mcast_addr = Multicast = Mcast_port = 0;
148 TftpEndingBlock = -1;
151 #endif /* CONFIG_MCAST_TFTP */
153 static __inline__ void
154 store_block(unsigned block, uchar *src, unsigned len)
156 ulong offset = block * TftpBlkSize + TftpBlockWrapOffset;
157 ulong newsize = offset + len;
158 #ifdef CONFIG_SYS_DIRECT_FLASH_TFTP
161 for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; i++) {
162 /* start address in flash? */
163 if (flash_info[i].flash_id == FLASH_UNKNOWN)
165 if (load_addr + offset >= flash_info[i].start[0]) {
171 if (rc) { /* Flash is destination for this packet */
172 rc = flash_write((char *)src, (ulong)(load_addr+offset), len);
175 NetState = NETLOOP_FAIL;
180 #endif /* CONFIG_SYS_DIRECT_FLASH_TFTP */
182 (void)memcpy((void *)(load_addr + offset), src, len);
184 #ifdef CONFIG_MCAST_TFTP
186 ext2_set_bit(block, Bitmap);
189 if (NetBootFileXferSize < newsize)
190 NetBootFileXferSize = newsize;
193 static void TftpSend(void);
194 static void TftpTimeout(void);
196 /**********************************************************************/
198 static void show_block_marker(void)
200 #ifdef CONFIG_TFTP_TSIZE
202 ulong pos = TftpBlock * TftpBlkSize + TftpBlockWrapOffset;
204 while (TftpNumchars < pos * 50 / TftpTsize) {
211 if (((TftpBlock - 1) % 10) == 0)
213 else if ((TftpBlock % (10 * HASHES_PER_LINE)) == 0)
218 /* The TFTP get or put is complete */
219 static void tftp_complete(void)
221 #ifdef CONFIG_TFTP_TSIZE
222 /* Print hash marks for the last packet received */
223 while (TftpTsize && TftpNumchars < 49) {
229 NetState = NETLOOP_SUCCESS;
240 #ifdef CONFIG_MCAST_TFTP
241 /* Multicast TFTP.. non-MasterClients do not ACK data. */
243 && (TftpState == STATE_DATA)
244 && (MasterClient == 0))
248 * We will always be sending some sort of packet, so
249 * cobble together the packet headers now.
251 pkt = NetTxPacket + NetEthHdrSize() + IP_HDR_SIZE;
258 *s++ = htons(TFTP_RRQ);
260 strcpy((char *)pkt, tftp_filename);
261 pkt += strlen(tftp_filename) + 1;
262 strcpy((char *)pkt, "octet");
263 pkt += 5 /*strlen("octet")*/ + 1;
264 strcpy((char *)pkt, "timeout");
265 pkt += 7 /*strlen("timeout")*/ + 1;
266 sprintf((char *)pkt, "%lu", TftpTimeoutMSecs / 1000);
267 debug("send option \"timeout %s\"\n", (char *)pkt);
268 pkt += strlen((char *)pkt) + 1;
269 #ifdef CONFIG_TFTP_TSIZE
270 memcpy((char *)pkt, "tsize\0000\0", 8);
273 /* try for more effic. blk size */
274 pkt += sprintf((char *)pkt, "blksize%c%d%c",
275 0, TftpBlkSizeOption, 0);
276 #ifdef CONFIG_MCAST_TFTP
277 /* Check all preconditions before even trying the option */
279 && (Bitmap = malloc(Mapsize))
280 && eth_get_dev()->mcast) {
283 pkt += sprintf((char *)pkt, "multicast%c%c", 0, 0);
285 #endif /* CONFIG_MCAST_TFTP */
290 #ifdef CONFIG_MCAST_TFTP
291 /* My turn! Start at where I need blocks I missed.*/
293 TftpBlock = ext2_find_next_zero_bit(Bitmap,
302 *s++ = htons(TFTP_ACK);
303 *s++ = htons(TftpBlock);
308 case STATE_TOO_LARGE:
311 *s++ = htons(TFTP_ERROR);
314 strcpy((char *)pkt, "File too large");
315 pkt += 14 /*strlen("File too large")*/ + 1;
319 case STATE_BAD_MAGIC:
322 *s++ = htons(TFTP_ERROR);
325 strcpy((char *)pkt, "File has bad magic");
326 pkt += 18 /*strlen("File has bad magic")*/ + 1;
331 NetSendUDPPacket(NetServerEther, TftpRemoteIP, TftpRemotePort,
337 TftpHandler(uchar *pkt, unsigned dest, IPaddr_t sip, unsigned src,
344 if (dest != TftpOurPort) {
345 #ifdef CONFIG_MCAST_TFTP
347 && (!Mcast_port || (dest != Mcast_port)))
351 if (TftpState != STATE_SEND_RRQ && src != TftpRemotePort &&
352 TftpState != STATE_RECV_WRQ)
358 /* warning: don't use increment (++) in ntohs() macros!! */
362 switch (ntohs(proto)) {
370 #ifdef CONFIG_CMD_TFTPSRV
374 TftpRemotePort = src;
375 TftpOurPort = 1024 + (get_timer(0) % 3072);
378 TftpBlockWrapOffset = 0;
379 TftpSend(); /* Send ACK(0) */
384 debug("Got OACK: %s %s\n",
386 pkt + strlen((char *)pkt) + 1);
387 TftpState = STATE_OACK;
388 TftpRemotePort = src;
390 * Check for 'blksize' option.
391 * Careful: "i" is signed, "len" is unsigned, thus
392 * something like "len-8" may give a *huge* number
394 for (i = 0; i+8 < len; i++) {
395 if (strcmp((char *)pkt+i, "blksize") == 0) {
396 TftpBlkSize = (unsigned short)
397 simple_strtoul((char *)pkt+i+8, NULL,
399 debug("Blocksize ack: %s, %d\n",
400 (char *)pkt+i+8, TftpBlkSize);
402 #ifdef CONFIG_TFTP_TSIZE
403 if (strcmp((char *)pkt+i, "tsize") == 0) {
404 TftpTsize = simple_strtoul((char *)pkt+i+6,
406 debug("size = %s, %d\n",
407 (char *)pkt+i+6, TftpTsize);
411 #ifdef CONFIG_MCAST_TFTP
412 parse_multicast_oack((char *)pkt, len-1);
413 if ((Multicast) && (!MasterClient))
414 TftpState = STATE_DATA; /* passive.. */
417 TftpSend(); /* Send ACK */
423 TftpBlock = ntohs(*(ushort *)pkt);
426 * RFC1350 specifies that the first data packet will
427 * have sequence number 1. If we receive a sequence
428 * number of 0 this means that there was a wrap
429 * around of the (16 bit) counter.
431 if (TftpBlock == 0) {
433 TftpBlockWrapOffset +=
434 TftpBlkSize * TFTP_SEQUENCE_SIZE;
435 printf("\n\t %lu MB received\n\t ",
436 TftpBlockWrapOffset>>20);
441 if (TftpState == STATE_SEND_RRQ)
442 debug("Server did not acknowledge timeout option!\n");
444 if (TftpState == STATE_SEND_RRQ || TftpState == STATE_OACK ||
445 TftpState == STATE_RECV_WRQ) {
446 /* first block received */
447 TftpState = STATE_DATA;
448 TftpRemotePort = src;
451 TftpBlockWrapOffset = 0;
453 #ifdef CONFIG_MCAST_TFTP
454 if (Multicast) { /* start!=1 common if mcast */
455 TftpLastBlock = TftpBlock - 1;
458 if (TftpBlock != 1) { /* Assertion */
459 printf("\nTFTP error: "
460 "First block is not block 1 (%ld)\n"
461 "Starting again\n\n",
468 if (TftpBlock == TftpLastBlock) {
470 * Same block again; ignore it.
475 TftpLastBlock = TftpBlock;
476 TftpTimeoutCountMax = TIMEOUT_COUNT;
477 NetSetTimeout(TftpTimeoutMSecs, TftpTimeout);
479 store_block(TftpBlock - 1, pkt + 2, len);
482 * Acknowledge the block just received, which will prompt
483 * the remote for the next one.
485 #ifdef CONFIG_MCAST_TFTP
486 /* if I am the MasterClient, actively calculate what my next
487 * needed block is; else I'm passive; not ACKING
490 if (len < TftpBlkSize) {
491 TftpEndingBlock = TftpBlock;
492 } else if (MasterClient) {
493 TftpBlock = PrevBitmapHole =
494 ext2_find_next_zero_bit(
498 if (TftpBlock > ((Mapsize*8) - 1)) {
499 printf("tftpfile too big\n");
500 /* try to double it and retry */
506 TftpLastBlock = TftpBlock;
512 #ifdef CONFIG_MCAST_TFTP
514 if (MasterClient && (TftpBlock >= TftpEndingBlock)) {
515 puts("\nMulticast tftp done\n");
517 NetState = NETLOOP_SUCCESS;
522 if (len < TftpBlkSize)
527 printf("\nTFTP error: '%s' (%d)\n",
528 pkt + 2, ntohs(*(ushort *)pkt));
530 switch (ntohs(*(ushort *)pkt)) {
531 case TFTP_ERR_FILE_NOT_FOUND:
532 case TFTP_ERR_ACCESS_DENIED:
533 puts("Not retrying...\n");
535 NetState = NETLOOP_FAIL;
537 case TFTP_ERR_UNDEFINED:
538 case TFTP_ERR_DISK_FULL:
539 case TFTP_ERR_UNEXPECTED_OPCODE:
540 case TFTP_ERR_UNKNOWN_TRANSFER_ID:
541 case TFTP_ERR_FILE_ALREADY_EXISTS:
543 puts("Starting again\n\n");
544 #ifdef CONFIG_MCAST_TFTP
558 if (++TftpTimeoutCount > TftpTimeoutCountMax) {
559 puts("\nRetry count exceeded; starting again\n");
560 #ifdef CONFIG_MCAST_TFTP
566 NetSetTimeout(TftpTimeoutMSecs, TftpTimeout);
567 if (TftpState != STATE_RECV_WRQ)
576 char *ep; /* Environment pointer */
579 * Allow the user to choose TFTP blocksize and timeout.
580 * TFTP protocol has a minimal timeout of 1 second.
582 ep = getenv("tftpblocksize");
584 TftpBlkSizeOption = simple_strtol(ep, NULL, 10);
586 ep = getenv("tftptimeout");
588 TftpTimeoutMSecs = simple_strtol(ep, NULL, 10);
590 if (TftpTimeoutMSecs < 1000) {
591 printf("TFTP timeout (%ld ms) too low, "
592 "set minimum = 1000 ms\n",
594 TftpTimeoutMSecs = 1000;
597 debug("TFTP blocksize = %i, timeout = %ld ms\n",
598 TftpBlkSizeOption, TftpTimeoutMSecs);
600 TftpRemoteIP = NetServerIP;
601 if (BootFile[0] == '\0') {
602 sprintf(default_filename, "%02lX%02lX%02lX%02lX.img",
604 (NetOurIP >> 8) & 0xFF,
605 (NetOurIP >> 16) & 0xFF,
606 (NetOurIP >> 24) & 0xFF);
608 strncpy(tftp_filename, default_filename, MAX_LEN);
609 tftp_filename[MAX_LEN-1] = 0;
611 printf("*** Warning: no boot file name; using '%s'\n",
614 char *p = strchr(BootFile, ':');
617 strncpy(tftp_filename, BootFile, MAX_LEN);
618 tftp_filename[MAX_LEN-1] = 0;
620 TftpRemoteIP = string_to_ip(BootFile);
621 strncpy(tftp_filename, p + 1, MAX_LEN);
622 tftp_filename[MAX_LEN-1] = 0;
626 printf("Using %s device\n", eth_get_name());
627 printf("TFTP from server %pI4"
628 "; our IP address is %pI4", &TftpRemoteIP, &NetOurIP);
630 /* Check if we need to send across this subnet */
631 if (NetOurGatewayIP && NetOurSubnetMask) {
632 IPaddr_t OurNet = NetOurIP & NetOurSubnetMask;
633 IPaddr_t RemoteNet = TftpRemoteIP & NetOurSubnetMask;
635 if (OurNet != RemoteNet)
636 printf("; sending through gateway %pI4",
641 printf("Filename '%s'.", tftp_filename);
643 if (NetBootFileSize) {
644 printf(" Size is 0x%x Bytes = ", NetBootFileSize<<9);
645 print_size(NetBootFileSize<<9, "");
650 printf("Load address: 0x%lx\n", load_addr);
652 puts("Loading: *\b");
654 TftpTimeoutCountMax = TftpRRQTimeoutCountMax;
656 NetSetTimeout(TftpTimeoutMSecs, TftpTimeout);
657 NetSetHandler(TftpHandler);
659 TftpRemotePort = WELL_KNOWN_PORT;
660 TftpTimeoutCount = 0;
661 TftpState = STATE_SEND_RRQ;
662 /* Use a pseudo-random port unless a specific port is set */
663 TftpOurPort = 1024 + (get_timer(0) % 3072);
665 #ifdef CONFIG_TFTP_PORT
666 ep = getenv("tftpdstp");
668 TftpRemotePort = simple_strtol(ep, NULL, 10);
669 ep = getenv("tftpsrcp");
671 TftpOurPort = simple_strtol(ep, NULL, 10);
675 /* zero out server ether in case the server ip has changed */
676 memset(NetServerEther, 0, 6);
677 /* Revert TftpBlkSize to dflt */
678 TftpBlkSize = TFTP_BLOCK_SIZE;
679 #ifdef CONFIG_MCAST_TFTP
682 #ifdef CONFIG_TFTP_TSIZE
690 #ifdef CONFIG_CMD_TFTPSRV
692 TftpStartServer(void)
694 tftp_filename[0] = 0;
696 printf("Using %s device\n", eth_get_name());
697 printf("Listening for TFTP transfer on %pI4\n", &NetOurIP);
698 printf("Load address: 0x%lx\n", load_addr);
700 puts("Loading: *\b");
702 TftpTimeoutCountMax = TIMEOUT_COUNT;
703 TftpTimeoutCount = 0;
704 TftpTimeoutMSecs = TIMEOUT;
705 NetSetTimeout(TftpTimeoutMSecs, TftpTimeout);
707 /* Revert TftpBlkSize to dflt */
708 TftpBlkSize = TFTP_BLOCK_SIZE;
710 TftpOurPort = WELL_KNOWN_PORT;
712 #ifdef CONFIG_TFTP_TSIZE
717 TftpState = STATE_RECV_WRQ;
718 NetSetHandler(TftpHandler);
720 #endif /* CONFIG_CMD_TFTPSRV */
722 #ifdef CONFIG_MCAST_TFTP
723 /* Credits: atftp project.
726 /* pick up BcastAddr, Port, and whether I am [now] the master-client. *
728 * +-------+-----------+---+-------~~-------+---+
729 * | opc | multicast | 0 | addr, port, mc | 0 |
730 * +-------+-----------+---+-------~~-------+---+
731 * The multicast addr/port becomes what I listen to, and if 'mc' is '1' then
732 * I am the new master-client so must send ACKs to DataBlocks. If I am not
733 * master-client, I'm a passive client, gathering what DataBlocks I may and
734 * making note of which ones I got in my bitmask.
735 * In theory, I never go from master->passive..
736 * .. this comes in with pkt already pointing just past opc
738 static void parse_multicast_oack(char *pkt, int len)
742 char *mc_adr, *port, *mc;
744 mc_adr = port = mc = NULL;
745 /* march along looking for 'multicast\0', which has to start at least
746 * 14 bytes back from the end.
748 for (i = 0; i < len-14; i++)
749 if (strcmp(pkt+i, "multicast") == 0)
751 if (i >= (len-14)) /* non-Multicast OACK, ign. */
754 i += 10; /* strlen multicast */
756 for (; i < len; i++) {
757 if (*(pkt+i) == ',') {
767 if (!port || !mc_adr || !mc)
769 if (Multicast && MasterClient) {
770 printf("I got a OACK as master Client, WRONG!\n");
773 /* ..I now accept packets destined for this MCAST addr, port */
776 printf("Internal failure! no mcast.\n");
782 /* I malloc instead of pre-declare; so that if the file ends
783 * up being too big for this bitmap I can retry
785 Bitmap = malloc(Mapsize);
787 printf("No Bitmap, no multicast. Sorry.\n");
791 memset(Bitmap, 0, Mapsize);
795 addr = string_to_ip(mc_adr);
796 if (Mcast_addr != addr) {
798 eth_mcast_join(Mcast_addr, 0);
800 if (eth_mcast_join(Mcast_addr, 1)) {
801 printf("Fail to set mcast, revert to TFTP\n");
807 MasterClient = (unsigned char)simple_strtoul((char *)mc, NULL, 10);
808 Mcast_port = (unsigned short)simple_strtoul(port, NULL, 10);
809 printf("Multicast: %s:%d [%d]\n", mc_adr, Mcast_port, MasterClient);
813 #endif /* Multicast TFTP */