1 /* 2 * Copyright 1994, 1995, 2000 Neil Russell. 3 * (See License) 4 * Copyright 2000, 2001 DENX Software Engineering, Wolfgang Denk, wd@denx.de 5 */ 6 7 #include <common.h> 8 #include <command.h> 9 #include <net.h> 10 #include "tftp.h" 11 #include "bootp.h" 12 13 #if defined(CONFIG_CMD_NET) 14 15 #define WELL_KNOWN_PORT 69 /* Well known TFTP port # */ 16 #define TIMEOUT 5000UL /* Millisecs to timeout for lost pkt */ 17 #ifndef CONFIG_NET_RETRY_COUNT 18 # define TIMEOUT_COUNT 10 /* # of timeouts before giving up */ 19 #else 20 # define TIMEOUT_COUNT (CONFIG_NET_RETRY_COUNT * 2) 21 #endif 22 /* (for checking the image size) */ 23 #define HASHES_PER_LINE 65 /* Number of "loading" hashes per line */ 24 25 /* 26 * TFTP operations. 27 */ 28 #define TFTP_RRQ 1 29 #define TFTP_WRQ 2 30 #define TFTP_DATA 3 31 #define TFTP_ACK 4 32 #define TFTP_ERROR 5 33 #define TFTP_OACK 6 34 35 static ulong TftpTimeoutMSecs = TIMEOUT; 36 static int TftpTimeoutCountMax = TIMEOUT_COUNT; 37 38 /* 39 * These globals govern the timeout behavior when attempting a connection to a 40 * TFTP server. TftpRRQTimeoutMSecs specifies the number of milliseconds to 41 * wait for the server to respond to initial connection. Second global, 42 * TftpRRQTimeoutCountMax, gives the number of such connection retries. 43 * TftpRRQTimeoutCountMax must be non-negative and TftpRRQTimeoutMSecs must be 44 * positive. The globals are meant to be set (and restored) by code needing 45 * non-standard timeout behavior when initiating a TFTP transfer. 46 */ 47 ulong TftpRRQTimeoutMSecs = TIMEOUT; 48 int TftpRRQTimeoutCountMax = TIMEOUT_COUNT; 49 50 static IPaddr_t TftpServerIP; 51 static int TftpServerPort; /* The UDP port at their end */ 52 static int TftpOurPort; /* The UDP port at our end */ 53 static int TftpTimeoutCount; 54 static ulong TftpBlock; /* packet sequence number */ 55 static ulong TftpLastBlock; /* last packet sequence number received */ 56 static ulong TftpBlockWrap; /* count of sequence number wraparounds */ 57 static ulong TftpBlockWrapOffset; /* memory offset due to wrapping */ 58 static int TftpState; 59 60 #define STATE_RRQ 1 61 #define STATE_DATA 2 62 #define STATE_TOO_LARGE 3 63 #define STATE_BAD_MAGIC 4 64 #define STATE_OACK 5 65 66 #define TFTP_BLOCK_SIZE 512 /* default TFTP block size */ 67 #define TFTP_SEQUENCE_SIZE ((ulong)(1<<16)) /* sequence number is 16 bit */ 68 69 #define DEFAULT_NAME_LEN (8 + 4 + 1) 70 static char default_filename[DEFAULT_NAME_LEN]; 71 72 #ifndef CONFIG_TFTP_FILE_NAME_MAX_LEN 73 #define MAX_LEN 128 74 #else 75 #define MAX_LEN CONFIG_TFTP_FILE_NAME_MAX_LEN 76 #endif 77 78 static char tftp_filename[MAX_LEN]; 79 80 #ifdef CONFIG_SYS_DIRECT_FLASH_TFTP 81 extern flash_info_t flash_info[]; 82 #endif 83 84 /* 512 is poor choice for ethernet, MTU is typically 1500. 85 * Minus eth.hdrs thats 1468. Can get 2x better throughput with 86 * almost-MTU block sizes. At least try... fall back to 512 if need be. 87 * (but those using CONFIG_IP_DEFRAG may want to set a larger block in cfg file) 88 */ 89 #ifdef CONFIG_TFTP_BLOCKSIZE 90 #define TFTP_MTU_BLOCKSIZE CONFIG_TFTP_BLOCKSIZE 91 #else 92 #define TFTP_MTU_BLOCKSIZE 1468 93 #endif 94 95 static unsigned short TftpBlkSize=TFTP_BLOCK_SIZE; 96 static unsigned short TftpBlkSizeOption=TFTP_MTU_BLOCKSIZE; 97 98 #ifdef CONFIG_MCAST_TFTP 99 #include <malloc.h> 100 #define MTFTP_BITMAPSIZE 0x1000 101 static unsigned *Bitmap; 102 static int PrevBitmapHole,Mapsize=MTFTP_BITMAPSIZE; 103 static uchar ProhibitMcast=0, MasterClient=0; 104 static uchar Multicast=0; 105 extern IPaddr_t Mcast_addr; 106 static int Mcast_port; 107 static ulong TftpEndingBlock; /* can get 'last' block before done..*/ 108 109 static void parse_multicast_oack(char *pkt,int len); 110 111 static void 112 mcast_cleanup(void) 113 { 114 if (Mcast_addr) eth_mcast_join(Mcast_addr, 0); 115 if (Bitmap) free(Bitmap); 116 Bitmap=NULL; 117 Mcast_addr = Multicast = Mcast_port = 0; 118 TftpEndingBlock = -1; 119 } 120 121 #endif /* CONFIG_MCAST_TFTP */ 122 123 static __inline__ void 124 store_block (unsigned block, uchar * src, unsigned len) 125 { 126 ulong offset = block * TftpBlkSize + TftpBlockWrapOffset; 127 ulong newsize = offset + len; 128 #ifdef CONFIG_SYS_DIRECT_FLASH_TFTP 129 int i, rc = 0; 130 131 for (i=0; i<CONFIG_SYS_MAX_FLASH_BANKS; i++) { 132 /* start address in flash? */ 133 if (flash_info[i].flash_id == FLASH_UNKNOWN) 134 continue; 135 if (load_addr + offset >= flash_info[i].start[0]) { 136 rc = 1; 137 break; 138 } 139 } 140 141 if (rc) { /* Flash is destination for this packet */ 142 rc = flash_write ((char *)src, (ulong)(load_addr+offset), len); 143 if (rc) { 144 flash_perror (rc); 145 NetState = NETLOOP_FAIL; 146 return; 147 } 148 } 149 else 150 #endif /* CONFIG_SYS_DIRECT_FLASH_TFTP */ 151 { 152 (void)memcpy((void *)(load_addr + offset), src, len); 153 } 154 #ifdef CONFIG_MCAST_TFTP 155 if (Multicast) 156 ext2_set_bit(block, Bitmap); 157 #endif 158 159 if (NetBootFileXferSize < newsize) 160 NetBootFileXferSize = newsize; 161 } 162 163 static void TftpSend (void); 164 static void TftpTimeout (void); 165 166 /**********************************************************************/ 167 168 static void 169 TftpSend (void) 170 { 171 volatile uchar * pkt; 172 volatile uchar * xp; 173 int len = 0; 174 volatile ushort *s; 175 176 #ifdef CONFIG_MCAST_TFTP 177 /* Multicast TFTP.. non-MasterClients do not ACK data. */ 178 if (Multicast 179 && (TftpState == STATE_DATA) 180 && (MasterClient == 0)) 181 return; 182 #endif 183 /* 184 * We will always be sending some sort of packet, so 185 * cobble together the packet headers now. 186 */ 187 pkt = NetTxPacket + NetEthHdrSize() + IP_HDR_SIZE; 188 189 switch (TftpState) { 190 191 case STATE_RRQ: 192 xp = pkt; 193 s = (ushort *)pkt; 194 *s++ = htons(TFTP_RRQ); 195 pkt = (uchar *)s; 196 strcpy ((char *)pkt, tftp_filename); 197 pkt += strlen(tftp_filename) + 1; 198 strcpy ((char *)pkt, "octet"); 199 pkt += 5 /*strlen("octet")*/ + 1; 200 strcpy ((char *)pkt, "timeout"); 201 pkt += 7 /*strlen("timeout")*/ + 1; 202 sprintf((char *)pkt, "%lu", TIMEOUT / 1000); 203 debug("send option \"timeout %s\"\n", (char *)pkt); 204 pkt += strlen((char *)pkt) + 1; 205 /* try for more effic. blk size */ 206 pkt += sprintf((char *)pkt,"blksize%c%d%c", 207 0,TftpBlkSizeOption,0); 208 #ifdef CONFIG_MCAST_TFTP 209 /* Check all preconditions before even trying the option */ 210 if (!ProhibitMcast 211 && (Bitmap=malloc(Mapsize)) 212 && eth_get_dev()->mcast) { 213 free(Bitmap); 214 Bitmap=NULL; 215 pkt += sprintf((char *)pkt,"multicast%c%c",0,0); 216 } 217 #endif /* CONFIG_MCAST_TFTP */ 218 len = pkt - xp; 219 break; 220 221 case STATE_OACK: 222 #ifdef CONFIG_MCAST_TFTP 223 /* My turn! Start at where I need blocks I missed.*/ 224 if (Multicast) 225 TftpBlock=ext2_find_next_zero_bit(Bitmap,(Mapsize*8),0); 226 /*..falling..*/ 227 #endif 228 case STATE_DATA: 229 xp = pkt; 230 s = (ushort *)pkt; 231 *s++ = htons(TFTP_ACK); 232 *s++ = htons(TftpBlock); 233 pkt = (uchar *)s; 234 len = pkt - xp; 235 break; 236 237 case STATE_TOO_LARGE: 238 xp = pkt; 239 s = (ushort *)pkt; 240 *s++ = htons(TFTP_ERROR); 241 *s++ = htons(3); 242 pkt = (uchar *)s; 243 strcpy ((char *)pkt, "File too large"); 244 pkt += 14 /*strlen("File too large")*/ + 1; 245 len = pkt - xp; 246 break; 247 248 case STATE_BAD_MAGIC: 249 xp = pkt; 250 s = (ushort *)pkt; 251 *s++ = htons(TFTP_ERROR); 252 *s++ = htons(2); 253 pkt = (uchar *)s; 254 strcpy ((char *)pkt, "File has bad magic"); 255 pkt += 18 /*strlen("File has bad magic")*/ + 1; 256 len = pkt - xp; 257 break; 258 } 259 260 NetSendUDPPacket(NetServerEther, TftpServerIP, TftpServerPort, TftpOurPort, len); 261 } 262 263 264 static void 265 TftpHandler (uchar * pkt, unsigned dest, unsigned src, unsigned len) 266 { 267 ushort proto; 268 ushort *s; 269 int i; 270 271 if (dest != TftpOurPort) { 272 #ifdef CONFIG_MCAST_TFTP 273 if (Multicast 274 && (!Mcast_port || (dest != Mcast_port))) 275 #endif 276 return; 277 } 278 if (TftpState != STATE_RRQ && src != TftpServerPort) { 279 return; 280 } 281 282 if (len < 2) { 283 return; 284 } 285 len -= 2; 286 /* warning: don't use increment (++) in ntohs() macros!! */ 287 s = (ushort *)pkt; 288 proto = *s++; 289 pkt = (uchar *)s; 290 switch (ntohs(proto)) { 291 292 case TFTP_RRQ: 293 case TFTP_WRQ: 294 case TFTP_ACK: 295 break; 296 default: 297 break; 298 299 case TFTP_OACK: 300 debug("Got OACK: %s %s\n", 301 pkt, 302 pkt + strlen((char *)pkt) + 1); 303 TftpState = STATE_OACK; 304 TftpServerPort = src; 305 /* 306 * Check for 'blksize' option. 307 * Careful: "i" is signed, "len" is unsigned, thus 308 * something like "len-8" may give a *huge* number 309 */ 310 for (i=0; i+8<len; i++) { 311 if (strcmp ((char*)pkt+i,"blksize") == 0) { 312 TftpBlkSize = (unsigned short) 313 simple_strtoul((char*)pkt+i+8,NULL,10); 314 debug("Blocksize ack: %s, %d\n", 315 (char*)pkt+i+8,TftpBlkSize); 316 break; 317 } 318 } 319 #ifdef CONFIG_MCAST_TFTP 320 parse_multicast_oack((char *)pkt,len-1); 321 if ((Multicast) && (!MasterClient)) 322 TftpState = STATE_DATA; /* passive.. */ 323 else 324 #endif 325 TftpSend (); /* Send ACK */ 326 break; 327 case TFTP_DATA: 328 if (len < 2) 329 return; 330 len -= 2; 331 TftpBlock = ntohs(*(ushort *)pkt); 332 333 /* 334 * RFC1350 specifies that the first data packet will 335 * have sequence number 1. If we receive a sequence 336 * number of 0 this means that there was a wrap 337 * around of the (16 bit) counter. 338 */ 339 if (TftpBlock == 0) { 340 TftpBlockWrap++; 341 TftpBlockWrapOffset += TftpBlkSize * TFTP_SEQUENCE_SIZE; 342 printf ("\n\t %lu MB received\n\t ", TftpBlockWrapOffset>>20); 343 } else { 344 if (((TftpBlock - 1) % 10) == 0) { 345 putc ('#'); 346 } else if ((TftpBlock % (10 * HASHES_PER_LINE)) == 0) { 347 puts ("\n\t "); 348 } 349 } 350 351 if (TftpState == STATE_RRQ) 352 debug("Server did not acknowledge timeout option!\n"); 353 354 if (TftpState == STATE_RRQ || TftpState == STATE_OACK) { 355 /* first block received */ 356 TftpState = STATE_DATA; 357 TftpServerPort = src; 358 TftpLastBlock = 0; 359 TftpBlockWrap = 0; 360 TftpBlockWrapOffset = 0; 361 362 #ifdef CONFIG_MCAST_TFTP 363 if (Multicast) { /* start!=1 common if mcast */ 364 TftpLastBlock = TftpBlock - 1; 365 } else 366 #endif 367 if (TftpBlock != 1) { /* Assertion */ 368 printf ("\nTFTP error: " 369 "First block is not block 1 (%ld)\n" 370 "Starting again\n\n", 371 TftpBlock); 372 NetStartAgain (); 373 break; 374 } 375 } 376 377 if (TftpBlock == TftpLastBlock) { 378 /* 379 * Same block again; ignore it. 380 */ 381 break; 382 } 383 384 TftpLastBlock = TftpBlock; 385 TftpTimeoutMSecs = TIMEOUT; 386 TftpTimeoutCountMax = TIMEOUT_COUNT; 387 NetSetTimeout (TftpTimeoutMSecs, TftpTimeout); 388 389 store_block (TftpBlock - 1, pkt + 2, len); 390 391 /* 392 * Acknoledge the block just received, which will prompt 393 * the server for the next one. 394 */ 395 #ifdef CONFIG_MCAST_TFTP 396 /* if I am the MasterClient, actively calculate what my next 397 * needed block is; else I'm passive; not ACKING 398 */ 399 if (Multicast) { 400 if (len < TftpBlkSize) { 401 TftpEndingBlock = TftpBlock; 402 } else if (MasterClient) { 403 TftpBlock = PrevBitmapHole = 404 ext2_find_next_zero_bit( 405 Bitmap, 406 (Mapsize*8), 407 PrevBitmapHole); 408 if (TftpBlock > ((Mapsize*8) - 1)) { 409 printf ("tftpfile too big\n"); 410 /* try to double it and retry */ 411 Mapsize<<=1; 412 mcast_cleanup(); 413 NetStartAgain (); 414 return; 415 } 416 TftpLastBlock = TftpBlock; 417 } 418 } 419 #endif 420 TftpSend (); 421 422 #ifdef CONFIG_MCAST_TFTP 423 if (Multicast) { 424 if (MasterClient && (TftpBlock >= TftpEndingBlock)) { 425 puts ("\nMulticast tftp done\n"); 426 mcast_cleanup(); 427 NetState = NETLOOP_SUCCESS; 428 } 429 } 430 else 431 #endif 432 if (len < TftpBlkSize) { 433 /* 434 * We received the whole thing. Try to 435 * run it. 436 */ 437 puts ("\ndone\n"); 438 NetState = NETLOOP_SUCCESS; 439 } 440 break; 441 442 case TFTP_ERROR: 443 printf ("\nTFTP error: '%s' (%d)\n", 444 pkt + 2, ntohs(*(ushort *)pkt)); 445 puts ("Starting again\n\n"); 446 #ifdef CONFIG_MCAST_TFTP 447 mcast_cleanup(); 448 #endif 449 NetStartAgain (); 450 break; 451 } 452 } 453 454 455 static void 456 TftpTimeout (void) 457 { 458 if (++TftpTimeoutCount > TftpTimeoutCountMax) { 459 puts ("\nRetry count exceeded; starting again\n"); 460 #ifdef CONFIG_MCAST_TFTP 461 mcast_cleanup(); 462 #endif 463 NetStartAgain (); 464 } else { 465 puts ("T "); 466 NetSetTimeout (TftpTimeoutMSecs, TftpTimeout); 467 TftpSend (); 468 } 469 } 470 471 472 void 473 TftpStart (void) 474 { 475 char *ep; /* Environment pointer */ 476 477 /* Allow the user to choose tftpblocksize */ 478 if ((ep = getenv("tftpblocksize")) != NULL) 479 TftpBlkSizeOption = simple_strtol(ep, NULL, 10); 480 debug("tftp block size is %i\n", TftpBlkSizeOption); 481 482 TftpServerIP = NetServerIP; 483 if (BootFile[0] == '\0') { 484 sprintf(default_filename, "%02lX%02lX%02lX%02lX.img", 485 NetOurIP & 0xFF, 486 (NetOurIP >> 8) & 0xFF, 487 (NetOurIP >> 16) & 0xFF, 488 (NetOurIP >> 24) & 0xFF ); 489 490 strncpy(tftp_filename, default_filename, MAX_LEN); 491 tftp_filename[MAX_LEN-1] = 0; 492 493 printf ("*** Warning: no boot file name; using '%s'\n", 494 tftp_filename); 495 } else { 496 char *p = strchr (BootFile, ':'); 497 498 if (p == NULL) { 499 strncpy(tftp_filename, BootFile, MAX_LEN); 500 tftp_filename[MAX_LEN-1] = 0; 501 } else { 502 TftpServerIP = string_to_ip (BootFile); 503 strncpy(tftp_filename, p + 1, MAX_LEN); 504 tftp_filename[MAX_LEN-1] = 0; 505 } 506 } 507 508 #if defined(CONFIG_NET_MULTI) 509 printf ("Using %s device\n", eth_get_name()); 510 #endif 511 printf("TFTP from server %pI4" 512 "; our IP address is %pI4", &TftpServerIP, &NetOurIP); 513 514 /* Check if we need to send across this subnet */ 515 if (NetOurGatewayIP && NetOurSubnetMask) { 516 IPaddr_t OurNet = NetOurIP & NetOurSubnetMask; 517 IPaddr_t ServerNet = TftpServerIP & NetOurSubnetMask; 518 519 if (OurNet != ServerNet) 520 printf("; sending through gateway %pI4", &NetOurGatewayIP); 521 } 522 putc ('\n'); 523 524 printf ("Filename '%s'.", tftp_filename); 525 526 if (NetBootFileSize) { 527 printf (" Size is 0x%x Bytes = ", NetBootFileSize<<9); 528 print_size (NetBootFileSize<<9, ""); 529 } 530 531 putc ('\n'); 532 533 printf ("Load address: 0x%lx\n", load_addr); 534 535 puts ("Loading: *\b"); 536 537 TftpTimeoutMSecs = TftpRRQTimeoutMSecs; 538 TftpTimeoutCountMax = TftpRRQTimeoutCountMax; 539 540 NetSetTimeout (TftpTimeoutMSecs, TftpTimeout); 541 NetSetHandler (TftpHandler); 542 543 TftpServerPort = WELL_KNOWN_PORT; 544 TftpTimeoutCount = 0; 545 TftpState = STATE_RRQ; 546 /* Use a pseudo-random port unless a specific port is set */ 547 TftpOurPort = 1024 + (get_timer(0) % 3072); 548 549 #ifdef CONFIG_TFTP_PORT 550 if ((ep = getenv("tftpdstp")) != NULL) { 551 TftpServerPort = simple_strtol(ep, NULL, 10); 552 } 553 if ((ep = getenv("tftpsrcp")) != NULL) { 554 TftpOurPort= simple_strtol(ep, NULL, 10); 555 } 556 #endif 557 TftpBlock = 0; 558 559 /* zero out server ether in case the server ip has changed */ 560 memset(NetServerEther, 0, 6); 561 /* Revert TftpBlkSize to dflt */ 562 TftpBlkSize = TFTP_BLOCK_SIZE; 563 #ifdef CONFIG_MCAST_TFTP 564 mcast_cleanup(); 565 #endif 566 567 TftpSend (); 568 } 569 570 #ifdef CONFIG_MCAST_TFTP 571 /* Credits: atftp project. 572 */ 573 574 /* pick up BcastAddr, Port, and whether I am [now] the master-client. * 575 * Frame: 576 * +-------+-----------+---+-------~~-------+---+ 577 * | opc | multicast | 0 | addr, port, mc | 0 | 578 * +-------+-----------+---+-------~~-------+---+ 579 * The multicast addr/port becomes what I listen to, and if 'mc' is '1' then 580 * I am the new master-client so must send ACKs to DataBlocks. If I am not 581 * master-client, I'm a passive client, gathering what DataBlocks I may and 582 * making note of which ones I got in my bitmask. 583 * In theory, I never go from master->passive.. 584 * .. this comes in with pkt already pointing just past opc 585 */ 586 static void parse_multicast_oack(char *pkt, int len) 587 { 588 int i; 589 IPaddr_t addr; 590 char *mc_adr, *port, *mc; 591 592 mc_adr=port=mc=NULL; 593 /* march along looking for 'multicast\0', which has to start at least 594 * 14 bytes back from the end. 595 */ 596 for (i=0;i<len-14;i++) 597 if (strcmp (pkt+i,"multicast") == 0) 598 break; 599 if (i >= (len-14)) /* non-Multicast OACK, ign. */ 600 return; 601 602 i+=10; /* strlen multicast */ 603 mc_adr = pkt+i; 604 for (;i<len;i++) { 605 if (*(pkt+i) == ',') { 606 *(pkt+i) = '\0'; 607 if (port) { 608 mc = pkt+i+1; 609 break; 610 } else { 611 port = pkt+i+1; 612 } 613 } 614 } 615 if (!port || !mc_adr || !mc ) return; 616 if (Multicast && MasterClient) { 617 printf ("I got a OACK as master Client, WRONG!\n"); 618 return; 619 } 620 /* ..I now accept packets destined for this MCAST addr, port */ 621 if (!Multicast) { 622 if (Bitmap) { 623 printf ("Internal failure! no mcast.\n"); 624 free(Bitmap); 625 Bitmap=NULL; 626 ProhibitMcast=1; 627 return ; 628 } 629 /* I malloc instead of pre-declare; so that if the file ends 630 * up being too big for this bitmap I can retry 631 */ 632 if (!(Bitmap = malloc (Mapsize))) { 633 printf ("No Bitmap, no multicast. Sorry.\n"); 634 ProhibitMcast=1; 635 return; 636 } 637 memset (Bitmap,0,Mapsize); 638 PrevBitmapHole = 0; 639 Multicast = 1; 640 } 641 addr = string_to_ip(mc_adr); 642 if (Mcast_addr != addr) { 643 if (Mcast_addr) 644 eth_mcast_join(Mcast_addr, 0); 645 if (eth_mcast_join(Mcast_addr=addr, 1)) { 646 printf ("Fail to set mcast, revert to TFTP\n"); 647 ProhibitMcast=1; 648 mcast_cleanup(); 649 NetStartAgain(); 650 } 651 } 652 MasterClient = (unsigned char)simple_strtoul((char *)mc,NULL,10); 653 Mcast_port = (unsigned short)simple_strtoul(port,NULL,10); 654 printf ("Multicast: %s:%d [%d]\n", mc_adr, Mcast_port, MasterClient); 655 return; 656 } 657 658 #endif /* Multicast TFTP */ 659 660 #endif 661