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>
11 #include <efi_loader.h>
20 #ifdef CONFIG_SYS_DIRECT_FLASH_TFTP
24 DECLARE_GLOBAL_DATA_PTR;
26 /* Well known TFTP port # */
27 #define WELL_KNOWN_PORT 69
28 /* Millisecs to timeout for lost pkt */
29 #define TIMEOUT 5000UL
30 #ifndef CONFIG_NET_RETRY_COUNT
31 /* # of timeouts before giving up */
32 # define TIMEOUT_COUNT 10
34 # define TIMEOUT_COUNT (CONFIG_NET_RETRY_COUNT * 2)
36 /* Number of "loading" hashes per line (for checking the image size) */
37 #define HASHES_PER_LINE 65
49 static ulong timeout_ms = TIMEOUT;
50 static int timeout_count_max = TIMEOUT_COUNT;
51 static ulong time_start; /* Record time we started tftp */
54 * These globals govern the timeout behavior when attempting a connection to a
55 * TFTP server. tftp_timeout_ms specifies the number of milliseconds to
56 * wait for the server to respond to initial connection. Second global,
57 * tftp_timeout_count_max, gives the number of such connection retries.
58 * tftp_timeout_count_max must be non-negative and tftp_timeout_ms must be
59 * positive. The globals are meant to be set (and restored) by code needing
60 * non-standard timeout behavior when initiating a TFTP transfer.
62 ulong tftp_timeout_ms = TIMEOUT;
63 int tftp_timeout_count_max = TIMEOUT_COUNT;
66 TFTP_ERR_UNDEFINED = 0,
67 TFTP_ERR_FILE_NOT_FOUND = 1,
68 TFTP_ERR_ACCESS_DENIED = 2,
69 TFTP_ERR_DISK_FULL = 3,
70 TFTP_ERR_UNEXPECTED_OPCODE = 4,
71 TFTP_ERR_UNKNOWN_TRANSFER_ID = 5,
72 TFTP_ERR_FILE_ALREADY_EXISTS = 6,
75 static struct in_addr tftp_remote_ip;
76 /* The UDP port at their end */
77 static int tftp_remote_port;
78 /* The UDP port at our end */
79 static int tftp_our_port;
80 static int timeout_count;
81 /* packet sequence number */
82 static ulong tftp_cur_block;
83 /* last packet sequence number received */
84 static ulong tftp_prev_block;
85 /* count of sequence number wraparounds */
86 static ulong tftp_block_wrap;
87 /* memory offset due to wrapping */
88 static ulong tftp_block_wrap_offset;
89 static int tftp_state;
90 static ulong tftp_load_addr;
92 static ulong tftp_load_size;
94 #ifdef CONFIG_TFTP_TSIZE
95 /* The file size reported by the server */
96 static int tftp_tsize;
97 /* The number of hashes we printed */
98 static short tftp_tsize_num_hash;
100 #ifdef CONFIG_CMD_TFTPPUT
101 /* 1 if writing, else 0 */
102 static int tftp_put_active;
103 /* 1 if we have sent the last block */
104 static int tftp_put_final_block_sent;
106 #define tftp_put_active 0
109 #define STATE_SEND_RRQ 1
111 #define STATE_TOO_LARGE 3
112 #define STATE_BAD_MAGIC 4
114 #define STATE_RECV_WRQ 6
115 #define STATE_SEND_WRQ 7
117 /* default TFTP block size */
118 #define TFTP_BLOCK_SIZE 512
119 /* sequence number is 16 bit */
120 #define TFTP_SEQUENCE_SIZE ((ulong)(1<<16))
122 #define DEFAULT_NAME_LEN (8 + 4 + 1)
123 static char default_filename[DEFAULT_NAME_LEN];
125 #ifndef CONFIG_TFTP_FILE_NAME_MAX_LEN
128 #define MAX_LEN CONFIG_TFTP_FILE_NAME_MAX_LEN
131 static char tftp_filename[MAX_LEN];
133 /* 512 is poor choice for ethernet, MTU is typically 1500.
134 * Minus eth.hdrs thats 1468. Can get 2x better throughput with
135 * almost-MTU block sizes. At least try... fall back to 512 if need be.
136 * (but those using CONFIG_IP_DEFRAG may want to set a larger block in cfg file)
139 static unsigned short tftp_block_size = TFTP_BLOCK_SIZE;
140 static unsigned short tftp_block_size_option = CONFIG_TFTP_BLOCKSIZE;
142 static inline int store_block(int block, uchar *src, unsigned int len)
144 ulong offset = block * tftp_block_size + tftp_block_wrap_offset;
145 ulong newsize = offset + len;
146 ulong store_addr = tftp_load_addr + offset;
147 #ifdef CONFIG_SYS_DIRECT_FLASH_TFTP
150 for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; i++) {
151 /* start address in flash? */
152 if (flash_info[i].flash_id == FLASH_UNKNOWN)
154 if (store_addr >= flash_info[i].start[0]) {
160 if (rc) { /* Flash is destination for this packet */
161 rc = flash_write((char *)src, store_addr, len);
167 #endif /* CONFIG_SYS_DIRECT_FLASH_TFTP */
172 ulong end_addr = tftp_load_addr + tftp_load_size;
175 end_addr = ULONG_MAX;
177 if (store_addr < tftp_load_addr ||
178 store_addr + len > end_addr) {
179 puts("\nTFTP error: ");
180 puts("trying to overwrite reserved memory...\n");
184 ptr = map_sysmem(store_addr, len);
185 memcpy(ptr, src, len);
189 if (net_boot_file_size < newsize)
190 net_boot_file_size = newsize;
195 /* Clear our state ready for a new transfer */
196 static void new_transfer(void)
200 tftp_block_wrap_offset = 0;
201 #ifdef CONFIG_CMD_TFTPPUT
202 tftp_put_final_block_sent = 0;
206 #ifdef CONFIG_CMD_TFTPPUT
208 * Load the next block from memory to be sent over tftp.
210 * @param block Block number to send
211 * @param dst Destination buffer for data
212 * @param len Number of bytes in block (this one and every other)
213 * @return number of bytes loaded
215 static int load_block(unsigned block, uchar *dst, unsigned len)
217 /* We may want to get the final block from the previous set */
218 ulong offset = ((int)block - 1) * len + tftp_block_wrap_offset;
221 tosend = min(net_boot_file_size - offset, tosend);
222 (void)memcpy(dst, (void *)(image_save_addr + offset), tosend);
223 debug("%s: block=%u, offset=%lu, len=%u, tosend=%lu\n", __func__,
224 block, offset, len, tosend);
229 static void tftp_send(void);
230 static void tftp_timeout_handler(void);
232 /**********************************************************************/
234 static void show_block_marker(void)
238 #ifdef CONFIG_TFTP_TSIZE
240 pos = tftp_cur_block * tftp_block_size +
241 tftp_block_wrap_offset;
242 if (pos > tftp_tsize)
245 while (tftp_tsize_num_hash < pos * 50 / tftp_tsize) {
247 tftp_tsize_num_hash++;
252 pos = (tftp_cur_block - 1) +
253 (tftp_block_wrap * TFTP_SEQUENCE_SIZE);
256 else if (((pos + 1) % (10 * HASHES_PER_LINE)) == 0)
262 * restart the current transfer due to an error
264 * @param msg Message to print for user
266 static void restart(const char *msg)
268 printf("\n%s; starting again\n", msg);
273 * Check if the block number has wrapped, and update progress
275 * TODO: The egregious use of global variables in this file should be tidied.
277 static void update_block_number(void)
280 * RFC1350 specifies that the first data packet will
281 * have sequence number 1. If we receive a sequence
282 * number of 0 this means that there was a wrap
283 * around of the (16 bit) counter.
285 if (tftp_cur_block == 0 && tftp_prev_block != 0) {
287 tftp_block_wrap_offset += tftp_block_size * TFTP_SEQUENCE_SIZE;
288 timeout_count = 0; /* we've done well, reset the timeout */
293 /* The TFTP get or put is complete */
294 static void tftp_complete(void)
296 #ifdef CONFIG_TFTP_TSIZE
297 /* Print hash marks for the last packet received */
298 while (tftp_tsize && tftp_tsize_num_hash < 49) {
300 tftp_tsize_num_hash++;
303 print_size(tftp_tsize, "");
305 time_start = get_timer(time_start);
306 if (time_start > 0) {
307 puts("\n\t "); /* Line up with "Loading: " */
308 print_size(net_boot_file_size /
309 time_start * 1000, "/s");
312 net_set_state(NETLOOP_SUCCESS);
315 static void tftp_send(void)
323 * We will always be sending some sort of packet, so
324 * cobble together the packet headers now.
326 pkt = net_tx_packet + net_eth_hdr_size() + IP_UDP_HDR_SIZE;
328 switch (tftp_state) {
333 #ifdef CONFIG_CMD_TFTPPUT
334 *s++ = htons(tftp_state == STATE_SEND_RRQ ? TFTP_RRQ :
337 *s++ = htons(TFTP_RRQ);
340 strcpy((char *)pkt, tftp_filename);
341 pkt += strlen(tftp_filename) + 1;
342 strcpy((char *)pkt, "octet");
343 pkt += 5 /*strlen("octet")*/ + 1;
344 strcpy((char *)pkt, "timeout");
345 pkt += 7 /*strlen("timeout")*/ + 1;
346 sprintf((char *)pkt, "%lu", timeout_ms / 1000);
347 debug("send option \"timeout %s\"\n", (char *)pkt);
348 pkt += strlen((char *)pkt) + 1;
349 #ifdef CONFIG_TFTP_TSIZE
350 pkt += sprintf((char *)pkt, "tsize%c%u%c",
351 0, net_boot_file_size, 0);
353 /* try for more effic. blk size */
354 pkt += sprintf((char *)pkt, "blksize%c%d%c",
355 0, tftp_block_size_option, 0);
365 s[0] = htons(TFTP_ACK);
366 s[1] = htons(tftp_cur_block);
367 pkt = (uchar *)(s + 2);
368 #ifdef CONFIG_CMD_TFTPPUT
369 if (tftp_put_active) {
370 int toload = tftp_block_size;
371 int loaded = load_block(tftp_cur_block, pkt, toload);
373 s[0] = htons(TFTP_DATA);
375 tftp_put_final_block_sent = (loaded < toload);
381 case STATE_TOO_LARGE:
384 *s++ = htons(TFTP_ERROR);
388 strcpy((char *)pkt, "File too large");
389 pkt += 14 /*strlen("File too large")*/ + 1;
393 case STATE_BAD_MAGIC:
396 *s++ = htons(TFTP_ERROR);
399 strcpy((char *)pkt, "File has bad magic");
400 pkt += 18 /*strlen("File has bad magic")*/ + 1;
405 net_send_udp_packet(net_server_ethaddr, tftp_remote_ip,
406 tftp_remote_port, tftp_our_port, len);
409 #ifdef CONFIG_CMD_TFTPPUT
410 static void icmp_handler(unsigned type, unsigned code, unsigned dest,
411 struct in_addr sip, unsigned src, uchar *pkt,
414 if (type == ICMP_NOT_REACH && code == ICMP_NOT_REACH_PORT) {
415 /* Oh dear the other end has gone away */
416 restart("TFTP server died");
421 static void tftp_handler(uchar *pkt, unsigned dest, struct in_addr sip,
422 unsigned src, unsigned len)
428 if (dest != tftp_our_port) {
431 if (tftp_state != STATE_SEND_RRQ && src != tftp_remote_port &&
432 tftp_state != STATE_RECV_WRQ && tftp_state != STATE_SEND_WRQ)
438 /* warning: don't use increment (++) in ntohs() macros!! */
442 switch (ntohs(proto)) {
447 #ifdef CONFIG_CMD_TFTPPUT
448 if (tftp_put_active) {
449 if (tftp_put_final_block_sent) {
453 * Move to the next block. We want our block
454 * count to wrap just like the other end!
456 int block = ntohs(*s);
457 int ack_ok = (tftp_cur_block == block);
459 tftp_cur_block = (unsigned short)(block + 1);
460 update_block_number();
462 tftp_send(); /* Send next data block */
471 #ifdef CONFIG_CMD_TFTPSRV
474 tftp_remote_ip = sip;
475 tftp_remote_port = src;
476 tftp_our_port = 1024 + (get_timer(0) % 3072);
478 tftp_send(); /* Send ACK(0) */
483 debug("Got OACK: %s %s\n",
484 pkt, pkt + strlen((char *)pkt) + 1);
485 tftp_state = STATE_OACK;
486 tftp_remote_port = src;
488 * Check for 'blksize' option.
489 * Careful: "i" is signed, "len" is unsigned, thus
490 * something like "len-8" may give a *huge* number
492 for (i = 0; i+8 < len; i++) {
493 if (strcmp((char *)pkt + i, "blksize") == 0) {
494 tftp_block_size = (unsigned short)
495 simple_strtoul((char *)pkt + i + 8,
497 debug("Blocksize ack: %s, %d\n",
498 (char *)pkt + i + 8, tftp_block_size);
500 #ifdef CONFIG_TFTP_TSIZE
501 if (strcmp((char *)pkt+i, "tsize") == 0) {
502 tftp_tsize = simple_strtoul((char *)pkt + i + 6,
504 debug("size = %s, %d\n",
505 (char *)pkt + i + 6, tftp_tsize);
509 #ifdef CONFIG_CMD_TFTPPUT
510 if (tftp_put_active) {
511 /* Get ready to send the first block */
512 tftp_state = STATE_DATA;
516 tftp_send(); /* Send ACK or first data block */
522 tftp_cur_block = ntohs(*(__be16 *)pkt);
524 if (tftp_state == STATE_SEND_RRQ)
525 debug("Server did not acknowledge timeout option!\n");
527 if (tftp_state == STATE_SEND_RRQ || tftp_state == STATE_OACK ||
528 tftp_state == STATE_RECV_WRQ) {
529 /* first block received */
530 tftp_state = STATE_DATA;
531 tftp_remote_port = src;
534 if (tftp_cur_block != 1) { /* Assertion */
535 puts("\nTFTP error: ");
536 printf("First block is not block 1 (%ld)\n",
538 puts("Starting again\n\n");
544 if (tftp_cur_block == tftp_prev_block) {
545 /* Same block again; ignore it. */
549 update_block_number();
550 tftp_prev_block = tftp_cur_block;
551 timeout_count_max = tftp_timeout_count_max;
552 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
554 if (store_block(tftp_cur_block - 1, pkt + 2, len)) {
556 net_set_state(NETLOOP_FAIL);
561 * Acknowledge the block just received, which will prompt
562 * the remote for the next one.
566 if (len < tftp_block_size)
571 printf("\nTFTP error: '%s' (%d)\n",
572 pkt + 2, ntohs(*(__be16 *)pkt));
574 switch (ntohs(*(__be16 *)pkt)) {
575 case TFTP_ERR_FILE_NOT_FOUND:
576 case TFTP_ERR_ACCESS_DENIED:
577 puts("Not retrying...\n");
579 net_set_state(NETLOOP_FAIL);
581 case TFTP_ERR_UNDEFINED:
582 case TFTP_ERR_DISK_FULL:
583 case TFTP_ERR_UNEXPECTED_OPCODE:
584 case TFTP_ERR_UNKNOWN_TRANSFER_ID:
585 case TFTP_ERR_FILE_ALREADY_EXISTS:
587 puts("Starting again\n\n");
596 static void tftp_timeout_handler(void)
598 if (++timeout_count > timeout_count_max) {
599 restart("Retry count exceeded");
602 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
603 if (tftp_state != STATE_RECV_WRQ)
608 /* Initialize tftp_load_addr and tftp_load_size from image_load_addr and lmb */
609 static int tftp_init_load_addr(void)
613 phys_size_t max_size;
615 lmb_init_and_reserve(&lmb, gd->bd, (void *)gd->fdt_blob);
617 max_size = lmb_get_free_size(&lmb, image_load_addr);
621 tftp_load_size = max_size;
623 tftp_load_addr = image_load_addr;
627 void tftp_start(enum proto_t protocol)
629 #if CONFIG_NET_TFTP_VARS
630 char *ep; /* Environment pointer */
633 * Allow the user to choose TFTP blocksize and timeout.
634 * TFTP protocol has a minimal timeout of 1 second.
637 ep = env_get("tftpblocksize");
639 tftp_block_size_option = simple_strtol(ep, NULL, 10);
641 ep = env_get("tftptimeout");
643 timeout_ms = simple_strtol(ep, NULL, 10);
645 if (timeout_ms < 1000) {
646 printf("TFTP timeout (%ld ms) too low, set min = 1000 ms\n",
651 ep = env_get("tftptimeoutcountmax");
653 tftp_timeout_count_max = simple_strtol(ep, NULL, 10);
655 if (tftp_timeout_count_max < 0) {
656 printf("TFTP timeout count max (%d ms) negative, set to 0\n",
657 tftp_timeout_count_max);
658 tftp_timeout_count_max = 0;
662 debug("TFTP blocksize = %i, timeout = %ld ms\n",
663 tftp_block_size_option, timeout_ms);
665 tftp_remote_ip = net_server_ip;
666 if (!net_parse_bootfile(&tftp_remote_ip, tftp_filename, MAX_LEN)) {
667 sprintf(default_filename, "%02X%02X%02X%02X.img",
668 net_ip.s_addr & 0xFF,
669 (net_ip.s_addr >> 8) & 0xFF,
670 (net_ip.s_addr >> 16) & 0xFF,
671 (net_ip.s_addr >> 24) & 0xFF);
673 strncpy(tftp_filename, default_filename, DEFAULT_NAME_LEN);
674 tftp_filename[DEFAULT_NAME_LEN - 1] = 0;
676 printf("*** Warning: no boot file name; using '%s'\n",
680 printf("Using %s device\n", eth_get_name());
681 printf("TFTP %s server %pI4; our IP address is %pI4",
682 #ifdef CONFIG_CMD_TFTPPUT
683 protocol == TFTPPUT ? "to" : "from",
687 &tftp_remote_ip, &net_ip);
689 /* Check if we need to send across this subnet */
690 if (net_gateway.s_addr && net_netmask.s_addr) {
691 struct in_addr our_net;
692 struct in_addr remote_net;
694 our_net.s_addr = net_ip.s_addr & net_netmask.s_addr;
695 remote_net.s_addr = tftp_remote_ip.s_addr & net_netmask.s_addr;
696 if (our_net.s_addr != remote_net.s_addr)
697 printf("; sending through gateway %pI4", &net_gateway);
701 printf("Filename '%s'.", tftp_filename);
703 if (net_boot_file_expected_size_in_blocks) {
704 printf(" Size is 0x%x Bytes = ",
705 net_boot_file_expected_size_in_blocks << 9);
706 print_size(net_boot_file_expected_size_in_blocks << 9, "");
710 #ifdef CONFIG_CMD_TFTPPUT
711 tftp_put_active = (protocol == TFTPPUT);
712 if (tftp_put_active) {
713 printf("Save address: 0x%lx\n", image_save_addr);
714 printf("Save size: 0x%lx\n", image_save_size);
715 net_boot_file_size = image_save_size;
717 tftp_state = STATE_SEND_WRQ;
722 if (tftp_init_load_addr()) {
724 net_set_state(NETLOOP_FAIL);
725 puts("\nTFTP error: ");
726 puts("trying to overwrite reserved memory...\n");
729 printf("Load address: 0x%lx\n", tftp_load_addr);
730 puts("Loading: *\b");
731 tftp_state = STATE_SEND_RRQ;
732 #ifdef CONFIG_CMD_BOOTEFI
733 efi_set_bootdev("Net", "", tftp_filename);
737 time_start = get_timer(0);
738 timeout_count_max = tftp_timeout_count_max;
740 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
741 net_set_udp_handler(tftp_handler);
742 #ifdef CONFIG_CMD_TFTPPUT
743 net_set_icmp_handler(icmp_handler);
745 tftp_remote_port = WELL_KNOWN_PORT;
747 /* Use a pseudo-random port unless a specific port is set */
748 tftp_our_port = 1024 + (get_timer(0) % 3072);
750 #ifdef CONFIG_TFTP_PORT
751 ep = env_get("tftpdstp");
753 tftp_remote_port = simple_strtol(ep, NULL, 10);
754 ep = env_get("tftpsrcp");
756 tftp_our_port = simple_strtol(ep, NULL, 10);
760 /* zero out server ether in case the server ip has changed */
761 memset(net_server_ethaddr, 0, 6);
762 /* Revert tftp_block_size to dflt */
763 tftp_block_size = TFTP_BLOCK_SIZE;
764 #ifdef CONFIG_TFTP_TSIZE
766 tftp_tsize_num_hash = 0;
772 #ifdef CONFIG_CMD_TFTPSRV
773 void tftp_start_server(void)
775 tftp_filename[0] = 0;
777 if (tftp_init_load_addr()) {
779 net_set_state(NETLOOP_FAIL);
780 puts("\nTFTP error: trying to overwrite reserved memory...\n");
783 printf("Using %s device\n", eth_get_name());
784 printf("Listening for TFTP transfer on %pI4\n", &net_ip);
785 printf("Load address: 0x%lx\n", tftp_load_addr);
787 puts("Loading: *\b");
789 timeout_count_max = tftp_timeout_count_max;
791 timeout_ms = TIMEOUT;
792 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
794 /* Revert tftp_block_size to dflt */
795 tftp_block_size = TFTP_BLOCK_SIZE;
797 tftp_our_port = WELL_KNOWN_PORT;
799 #ifdef CONFIG_TFTP_TSIZE
801 tftp_tsize_num_hash = 0;
804 tftp_state = STATE_RECV_WRQ;
805 net_set_udp_handler(tftp_handler);
807 /* zero out server ether in case the server ip has changed */
808 memset(net_server_ethaddr, 0, 6);
810 #endif /* CONFIG_CMD_TFTPSRV */