2 * Copyright 1994, 1995, 2000 Neil Russell.
4 * Copyright 2000, 2001 DENX Software Engineering, Wolfgang Denk, wd@denx.de
13 /* Well known TFTP port # */
14 #define WELL_KNOWN_PORT 69
15 /* Millisecs to timeout for lost pkt */
16 #define TIMEOUT 5000UL
17 #ifndef CONFIG_NET_RETRY_COUNT
18 /* # of timeouts before giving up */
19 # define TIMEOUT_COUNT 10
21 # define TIMEOUT_COUNT (CONFIG_NET_RETRY_COUNT * 2)
23 /* Number of "loading" hashes per line (for checking the image size) */
24 #define HASHES_PER_LINE 65
36 static ulong TftpTimeoutMSecs = TIMEOUT;
37 static int TftpTimeoutCountMax = TIMEOUT_COUNT;
40 * These globals govern the timeout behavior when attempting a connection to a
41 * TFTP server. TftpRRQTimeoutMSecs specifies the number of milliseconds to
42 * wait for the server to respond to initial connection. Second global,
43 * TftpRRQTimeoutCountMax, gives the number of such connection retries.
44 * TftpRRQTimeoutCountMax must be non-negative and TftpRRQTimeoutMSecs must be
45 * positive. The globals are meant to be set (and restored) by code needing
46 * non-standard timeout behavior when initiating a TFTP transfer.
48 ulong TftpRRQTimeoutMSecs = TIMEOUT;
49 int TftpRRQTimeoutCountMax = TIMEOUT_COUNT;
52 TFTP_ERR_UNDEFINED = 0,
53 TFTP_ERR_FILE_NOT_FOUND = 1,
54 TFTP_ERR_ACCESS_DENIED = 2,
55 TFTP_ERR_DISK_FULL = 3,
56 TFTP_ERR_UNEXPECTED_OPCODE = 4,
57 TFTP_ERR_UNKNOWN_TRANSFER_ID = 5,
58 TFTP_ERR_FILE_ALREADY_EXISTS = 6,
61 static IPaddr_t TftpServerIP;
62 /* The UDP port at their end */
63 static int TftpServerPort;
64 /* The UDP port at our end */
65 static int TftpOurPort;
66 static int TftpTimeoutCount;
67 /* packet sequence number */
68 static ulong TftpBlock;
69 /* last packet sequence number received */
70 static ulong TftpLastBlock;
71 /* count of sequence number wraparounds */
72 static ulong TftpBlockWrap;
73 /* memory offset due to wrapping */
74 static ulong TftpBlockWrapOffset;
76 #ifdef CONFIG_TFTP_TSIZE
77 /* The file size reported by the server */
79 /* The number of hashes we printed */
80 static short TftpNumchars;
85 #define STATE_TOO_LARGE 3
86 #define STATE_BAD_MAGIC 4
89 /* default TFTP block size */
90 #define TFTP_BLOCK_SIZE 512
91 /* sequence number is 16 bit */
92 #define TFTP_SEQUENCE_SIZE ((ulong)(1<<16))
94 #define DEFAULT_NAME_LEN (8 + 4 + 1)
95 static char default_filename[DEFAULT_NAME_LEN];
97 #ifndef CONFIG_TFTP_FILE_NAME_MAX_LEN
100 #define MAX_LEN CONFIG_TFTP_FILE_NAME_MAX_LEN
103 static char tftp_filename[MAX_LEN];
105 #ifdef CONFIG_SYS_DIRECT_FLASH_TFTP
106 extern flash_info_t flash_info[];
109 /* 512 is poor choice for ethernet, MTU is typically 1500.
110 * Minus eth.hdrs thats 1468. Can get 2x better throughput with
111 * almost-MTU block sizes. At least try... fall back to 512 if need be.
112 * (but those using CONFIG_IP_DEFRAG may want to set a larger block in cfg file)
114 #ifdef CONFIG_TFTP_BLOCKSIZE
115 #define TFTP_MTU_BLOCKSIZE CONFIG_TFTP_BLOCKSIZE
117 #define TFTP_MTU_BLOCKSIZE 1468
120 static unsigned short TftpBlkSize=TFTP_BLOCK_SIZE;
121 static unsigned short TftpBlkSizeOption=TFTP_MTU_BLOCKSIZE;
123 #ifdef CONFIG_MCAST_TFTP
125 #define MTFTP_BITMAPSIZE 0x1000
126 static unsigned *Bitmap;
127 static int PrevBitmapHole,Mapsize=MTFTP_BITMAPSIZE;
128 static uchar ProhibitMcast=0, MasterClient=0;
129 static uchar Multicast=0;
130 extern IPaddr_t Mcast_addr;
131 static int Mcast_port;
132 static ulong TftpEndingBlock; /* can get 'last' block before done..*/
134 static void parse_multicast_oack(char *pkt,int len);
139 if (Mcast_addr) eth_mcast_join(Mcast_addr, 0);
140 if (Bitmap) free(Bitmap);
142 Mcast_addr = Multicast = Mcast_port = 0;
143 TftpEndingBlock = -1;
146 #endif /* CONFIG_MCAST_TFTP */
148 static __inline__ void
149 store_block (unsigned block, uchar * src, unsigned len)
151 ulong offset = block * TftpBlkSize + TftpBlockWrapOffset;
152 ulong newsize = offset + len;
153 #ifdef CONFIG_SYS_DIRECT_FLASH_TFTP
156 for (i=0; i<CONFIG_SYS_MAX_FLASH_BANKS; i++) {
157 /* start address in flash? */
158 if (flash_info[i].flash_id == FLASH_UNKNOWN)
160 if (load_addr + offset >= flash_info[i].start[0]) {
166 if (rc) { /* Flash is destination for this packet */
167 rc = flash_write ((char *)src, (ulong)(load_addr+offset), len);
170 NetState = NETLOOP_FAIL;
175 #endif /* CONFIG_SYS_DIRECT_FLASH_TFTP */
177 (void)memcpy((void *)(load_addr + offset), src, len);
179 #ifdef CONFIG_MCAST_TFTP
181 ext2_set_bit(block, Bitmap);
184 if (NetBootFileXferSize < newsize)
185 NetBootFileXferSize = newsize;
188 static void TftpSend (void);
189 static void TftpTimeout (void);
191 /**********************************************************************/
196 volatile uchar * pkt;
201 #ifdef CONFIG_MCAST_TFTP
202 /* Multicast TFTP.. non-MasterClients do not ACK data. */
204 && (TftpState == STATE_DATA)
205 && (MasterClient == 0))
209 * We will always be sending some sort of packet, so
210 * cobble together the packet headers now.
212 pkt = NetTxPacket + NetEthHdrSize() + IP_HDR_SIZE;
219 *s++ = htons(TFTP_RRQ);
221 strcpy ((char *)pkt, tftp_filename);
222 pkt += strlen(tftp_filename) + 1;
223 strcpy ((char *)pkt, "octet");
224 pkt += 5 /*strlen("octet")*/ + 1;
225 strcpy ((char *)pkt, "timeout");
226 pkt += 7 /*strlen("timeout")*/ + 1;
227 sprintf((char *)pkt, "%lu", TftpTimeoutMSecs / 1000);
228 debug("send option \"timeout %s\"\n", (char *)pkt);
229 pkt += strlen((char *)pkt) + 1;
230 #ifdef CONFIG_TFTP_TSIZE
231 memcpy((char *)pkt, "tsize\0000\0", 8);
234 /* try for more effic. blk size */
235 pkt += sprintf((char *)pkt,"blksize%c%d%c",
236 0,TftpBlkSizeOption,0);
237 #ifdef CONFIG_MCAST_TFTP
238 /* Check all preconditions before even trying the option */
240 && (Bitmap=malloc(Mapsize))
241 && eth_get_dev()->mcast) {
244 pkt += sprintf((char *)pkt,"multicast%c%c",0,0);
246 #endif /* CONFIG_MCAST_TFTP */
251 #ifdef CONFIG_MCAST_TFTP
252 /* My turn! Start at where I need blocks I missed.*/
254 TftpBlock=ext2_find_next_zero_bit(Bitmap,(Mapsize*8),0);
260 *s++ = htons(TFTP_ACK);
261 *s++ = htons(TftpBlock);
266 case STATE_TOO_LARGE:
269 *s++ = htons(TFTP_ERROR);
272 strcpy ((char *)pkt, "File too large");
273 pkt += 14 /*strlen("File too large")*/ + 1;
277 case STATE_BAD_MAGIC:
280 *s++ = htons(TFTP_ERROR);
283 strcpy ((char *)pkt, "File has bad magic");
284 pkt += 18 /*strlen("File has bad magic")*/ + 1;
289 NetSendUDPPacket(NetServerEther, TftpServerIP, TftpServerPort,
295 TftpHandler(uchar *pkt, unsigned dest, IPaddr_t sip, unsigned src,
302 if (dest != TftpOurPort) {
303 #ifdef CONFIG_MCAST_TFTP
305 && (!Mcast_port || (dest != Mcast_port)))
309 if (TftpState != STATE_RRQ && src != TftpServerPort) {
317 /* warning: don't use increment (++) in ntohs() macros!! */
321 switch (ntohs(proto)) {
331 debug("Got OACK: %s %s\n",
333 pkt + strlen((char *)pkt) + 1);
334 TftpState = STATE_OACK;
335 TftpServerPort = src;
337 * Check for 'blksize' option.
338 * Careful: "i" is signed, "len" is unsigned, thus
339 * something like "len-8" may give a *huge* number
341 for (i=0; i+8<len; i++) {
342 if (strcmp ((char*)pkt+i,"blksize") == 0) {
343 TftpBlkSize = (unsigned short)
344 simple_strtoul((char*)pkt+i+8,NULL,10);
345 debug("Blocksize ack: %s, %d\n",
346 (char*)pkt+i+8,TftpBlkSize);
348 #ifdef CONFIG_TFTP_TSIZE
349 if (strcmp ((char*)pkt+i,"tsize") == 0) {
350 TftpTsize = simple_strtoul((char*)pkt+i+6,
352 debug("size = %s, %d\n",
353 (char*)pkt+i+6, TftpTsize);
357 #ifdef CONFIG_MCAST_TFTP
358 parse_multicast_oack((char *)pkt,len-1);
359 if ((Multicast) && (!MasterClient))
360 TftpState = STATE_DATA; /* passive.. */
363 TftpSend (); /* Send ACK */
369 TftpBlock = ntohs(*(ushort *)pkt);
372 * RFC1350 specifies that the first data packet will
373 * have sequence number 1. If we receive a sequence
374 * number of 0 this means that there was a wrap
375 * around of the (16 bit) counter.
377 if (TftpBlock == 0) {
379 TftpBlockWrapOffset +=
380 TftpBlkSize * TFTP_SEQUENCE_SIZE;
381 printf ("\n\t %lu MB received\n\t ",
382 TftpBlockWrapOffset>>20);
384 #ifdef CONFIG_TFTP_TSIZE
385 else if (TftpTsize) {
386 while (TftpNumchars <
387 NetBootFileXferSize * 50 / TftpTsize) {
394 if (((TftpBlock - 1) % 10) == 0) {
396 } else if ((TftpBlock % (10 * HASHES_PER_LINE)) == 0) {
401 if (TftpState == STATE_RRQ)
402 debug("Server did not acknowledge timeout option!\n");
404 if (TftpState == STATE_RRQ || TftpState == STATE_OACK) {
405 /* first block received */
406 TftpState = STATE_DATA;
407 TftpServerPort = src;
410 TftpBlockWrapOffset = 0;
412 #ifdef CONFIG_MCAST_TFTP
413 if (Multicast) { /* start!=1 common if mcast */
414 TftpLastBlock = TftpBlock - 1;
417 if (TftpBlock != 1) { /* Assertion */
418 printf ("\nTFTP error: "
419 "First block is not block 1 (%ld)\n"
420 "Starting again\n\n",
427 if (TftpBlock == TftpLastBlock) {
429 * Same block again; ignore it.
434 TftpLastBlock = TftpBlock;
435 TftpTimeoutCountMax = TIMEOUT_COUNT;
436 NetSetTimeout (TftpTimeoutMSecs, TftpTimeout);
438 store_block (TftpBlock - 1, pkt + 2, len);
441 * Acknoledge the block just received, which will prompt
442 * the server for the next one.
444 #ifdef CONFIG_MCAST_TFTP
445 /* if I am the MasterClient, actively calculate what my next
446 * needed block is; else I'm passive; not ACKING
449 if (len < TftpBlkSize) {
450 TftpEndingBlock = TftpBlock;
451 } else if (MasterClient) {
452 TftpBlock = PrevBitmapHole =
453 ext2_find_next_zero_bit(
457 if (TftpBlock > ((Mapsize*8) - 1)) {
458 printf ("tftpfile too big\n");
459 /* try to double it and retry */
465 TftpLastBlock = TftpBlock;
471 #ifdef CONFIG_MCAST_TFTP
473 if (MasterClient && (TftpBlock >= TftpEndingBlock)) {
474 puts ("\nMulticast tftp done\n");
476 NetState = NETLOOP_SUCCESS;
481 if (len < TftpBlkSize) {
483 * We received the whole thing. Try to
486 #ifdef CONFIG_TFTP_TSIZE
487 /* Print hash marks for the last packet received */
488 while (TftpTsize && TftpNumchars < 49) {
494 NetState = NETLOOP_SUCCESS;
499 printf ("\nTFTP error: '%s' (%d)\n",
500 pkt + 2, ntohs(*(ushort *)pkt));
502 switch (ntohs(*(ushort *)pkt)) {
503 case TFTP_ERR_FILE_NOT_FOUND:
504 case TFTP_ERR_ACCESS_DENIED:
505 puts("Not retrying...\n");
507 NetState = NETLOOP_FAIL;
509 case TFTP_ERR_UNDEFINED:
510 case TFTP_ERR_DISK_FULL:
511 case TFTP_ERR_UNEXPECTED_OPCODE:
512 case TFTP_ERR_UNKNOWN_TRANSFER_ID:
513 case TFTP_ERR_FILE_ALREADY_EXISTS:
515 puts("Starting again\n\n");
516 #ifdef CONFIG_MCAST_TFTP
530 if (++TftpTimeoutCount > TftpTimeoutCountMax) {
531 puts ("\nRetry count exceeded; starting again\n");
532 #ifdef CONFIG_MCAST_TFTP
538 NetSetTimeout (TftpTimeoutMSecs, TftpTimeout);
547 char *ep; /* Environment pointer */
550 * Allow the user to choose TFTP blocksize and timeout.
551 * TFTP protocol has a minimal timeout of 1 second.
553 if ((ep = getenv("tftpblocksize")) != NULL)
554 TftpBlkSizeOption = simple_strtol(ep, NULL, 10);
556 if ((ep = getenv("tftptimeout")) != NULL)
557 TftpTimeoutMSecs = simple_strtol(ep, NULL, 10);
559 if (TftpTimeoutMSecs < 1000) {
560 printf("TFTP timeout (%ld ms) too low, "
561 "set minimum = 1000 ms\n",
563 TftpTimeoutMSecs = 1000;
566 debug("TFTP blocksize = %i, timeout = %ld ms\n",
567 TftpBlkSizeOption, TftpTimeoutMSecs);
569 TftpServerIP = NetServerIP;
570 if (BootFile[0] == '\0') {
571 sprintf(default_filename, "%02lX%02lX%02lX%02lX.img",
573 (NetOurIP >> 8) & 0xFF,
574 (NetOurIP >> 16) & 0xFF,
575 (NetOurIP >> 24) & 0xFF );
577 strncpy(tftp_filename, default_filename, MAX_LEN);
578 tftp_filename[MAX_LEN-1] = 0;
580 printf ("*** Warning: no boot file name; using '%s'\n",
583 char *p = strchr (BootFile, ':');
586 strncpy(tftp_filename, BootFile, MAX_LEN);
587 tftp_filename[MAX_LEN-1] = 0;
589 TftpServerIP = string_to_ip (BootFile);
590 strncpy(tftp_filename, p + 1, MAX_LEN);
591 tftp_filename[MAX_LEN-1] = 0;
595 #if defined(CONFIG_NET_MULTI)
596 printf ("Using %s device\n", eth_get_name());
598 printf("TFTP from server %pI4"
599 "; our IP address is %pI4", &TftpServerIP, &NetOurIP);
601 /* Check if we need to send across this subnet */
602 if (NetOurGatewayIP && NetOurSubnetMask) {
603 IPaddr_t OurNet = NetOurIP & NetOurSubnetMask;
604 IPaddr_t ServerNet = TftpServerIP & NetOurSubnetMask;
606 if (OurNet != ServerNet)
607 printf("; sending through gateway %pI4", &NetOurGatewayIP);
611 printf ("Filename '%s'.", tftp_filename);
613 if (NetBootFileSize) {
614 printf (" Size is 0x%x Bytes = ", NetBootFileSize<<9);
615 print_size (NetBootFileSize<<9, "");
620 printf ("Load address: 0x%lx\n", load_addr);
622 puts ("Loading: *\b");
624 TftpTimeoutCountMax = TftpRRQTimeoutCountMax;
626 NetSetTimeout (TftpTimeoutMSecs, TftpTimeout);
627 NetSetHandler (TftpHandler);
629 TftpServerPort = WELL_KNOWN_PORT;
630 TftpTimeoutCount = 0;
631 TftpState = STATE_RRQ;
632 /* Use a pseudo-random port unless a specific port is set */
633 TftpOurPort = 1024 + (get_timer(0) % 3072);
635 #ifdef CONFIG_TFTP_PORT
636 if ((ep = getenv("tftpdstp")) != NULL) {
637 TftpServerPort = simple_strtol(ep, NULL, 10);
639 if ((ep = getenv("tftpsrcp")) != NULL) {
640 TftpOurPort= simple_strtol(ep, NULL, 10);
645 /* zero out server ether in case the server ip has changed */
646 memset(NetServerEther, 0, 6);
647 /* Revert TftpBlkSize to dflt */
648 TftpBlkSize = TFTP_BLOCK_SIZE;
649 #ifdef CONFIG_MCAST_TFTP
652 #ifdef CONFIG_TFTP_TSIZE
660 #ifdef CONFIG_MCAST_TFTP
661 /* Credits: atftp project.
664 /* pick up BcastAddr, Port, and whether I am [now] the master-client. *
666 * +-------+-----------+---+-------~~-------+---+
667 * | opc | multicast | 0 | addr, port, mc | 0 |
668 * +-------+-----------+---+-------~~-------+---+
669 * The multicast addr/port becomes what I listen to, and if 'mc' is '1' then
670 * I am the new master-client so must send ACKs to DataBlocks. If I am not
671 * master-client, I'm a passive client, gathering what DataBlocks I may and
672 * making note of which ones I got in my bitmask.
673 * In theory, I never go from master->passive..
674 * .. this comes in with pkt already pointing just past opc
676 static void parse_multicast_oack(char *pkt, int len)
680 char *mc_adr, *port, *mc;
683 /* march along looking for 'multicast\0', which has to start at least
684 * 14 bytes back from the end.
686 for (i=0;i<len-14;i++)
687 if (strcmp (pkt+i,"multicast") == 0)
689 if (i >= (len-14)) /* non-Multicast OACK, ign. */
692 i+=10; /* strlen multicast */
695 if (*(pkt+i) == ',') {
705 if (!port || !mc_adr || !mc ) return;
706 if (Multicast && MasterClient) {
707 printf ("I got a OACK as master Client, WRONG!\n");
710 /* ..I now accept packets destined for this MCAST addr, port */
713 printf ("Internal failure! no mcast.\n");
719 /* I malloc instead of pre-declare; so that if the file ends
720 * up being too big for this bitmap I can retry
722 if (!(Bitmap = malloc (Mapsize))) {
723 printf ("No Bitmap, no multicast. Sorry.\n");
727 memset (Bitmap,0,Mapsize);
731 addr = string_to_ip(mc_adr);
732 if (Mcast_addr != addr) {
734 eth_mcast_join(Mcast_addr, 0);
735 if (eth_mcast_join(Mcast_addr=addr, 1)) {
736 printf ("Fail to set mcast, revert to TFTP\n");
742 MasterClient = (unsigned char)simple_strtoul((char *)mc,NULL,10);
743 Mcast_port = (unsigned short)simple_strtoul(port,NULL,10);
744 printf ("Multicast: %s:%d [%d]\n", mc_adr, Mcast_port, MasterClient);
748 #endif /* Multicast TFTP */