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>
17 #ifdef CONFIG_SYS_DIRECT_FLASH_TFTP
21 DECLARE_GLOBAL_DATA_PTR;
23 /* Well known TFTP port # */
24 #define WELL_KNOWN_PORT 69
25 /* Millisecs to timeout for lost pkt */
26 #define TIMEOUT 5000UL
27 #ifndef CONFIG_NET_RETRY_COUNT
28 /* # of timeouts before giving up */
29 # define TIMEOUT_COUNT 10
31 # define TIMEOUT_COUNT (CONFIG_NET_RETRY_COUNT * 2)
33 /* Number of "loading" hashes per line (for checking the image size) */
34 #define HASHES_PER_LINE 65
46 static ulong timeout_ms = TIMEOUT;
47 static int timeout_count_max = TIMEOUT_COUNT;
48 static ulong time_start; /* Record time we started tftp */
51 * These globals govern the timeout behavior when attempting a connection to a
52 * TFTP server. tftp_timeout_ms specifies the number of milliseconds to
53 * wait for the server to respond to initial connection. Second global,
54 * tftp_timeout_count_max, gives the number of such connection retries.
55 * tftp_timeout_count_max must be non-negative and tftp_timeout_ms must be
56 * positive. The globals are meant to be set (and restored) by code needing
57 * non-standard timeout behavior when initiating a TFTP transfer.
59 ulong tftp_timeout_ms = TIMEOUT;
60 int tftp_timeout_count_max = TIMEOUT_COUNT;
63 TFTP_ERR_UNDEFINED = 0,
64 TFTP_ERR_FILE_NOT_FOUND = 1,
65 TFTP_ERR_ACCESS_DENIED = 2,
66 TFTP_ERR_DISK_FULL = 3,
67 TFTP_ERR_UNEXPECTED_OPCODE = 4,
68 TFTP_ERR_UNKNOWN_TRANSFER_ID = 5,
69 TFTP_ERR_FILE_ALREADY_EXISTS = 6,
72 static struct in_addr tftp_remote_ip;
73 /* The UDP port at their end */
74 static int tftp_remote_port;
75 /* The UDP port at our end */
76 static int tftp_our_port;
77 static int timeout_count;
78 /* packet sequence number */
79 static ulong tftp_cur_block;
80 /* last packet sequence number received */
81 static ulong tftp_prev_block;
82 /* count of sequence number wraparounds */
83 static ulong tftp_block_wrap;
84 /* memory offset due to wrapping */
85 static ulong tftp_block_wrap_offset;
86 static int tftp_state;
87 static ulong tftp_load_addr;
89 static ulong tftp_load_size;
91 #ifdef CONFIG_TFTP_TSIZE
92 /* The file size reported by the server */
93 static int tftp_tsize;
94 /* The number of hashes we printed */
95 static short tftp_tsize_num_hash;
97 #ifdef CONFIG_CMD_TFTPPUT
98 /* 1 if writing, else 0 */
99 static int tftp_put_active;
100 /* 1 if we have sent the last block */
101 static int tftp_put_final_block_sent;
103 #define tftp_put_active 0
106 #define STATE_SEND_RRQ 1
108 #define STATE_TOO_LARGE 3
109 #define STATE_BAD_MAGIC 4
111 #define STATE_RECV_WRQ 6
112 #define STATE_SEND_WRQ 7
114 /* default TFTP block size */
115 #define TFTP_BLOCK_SIZE 512
116 /* sequence number is 16 bit */
117 #define TFTP_SEQUENCE_SIZE ((ulong)(1<<16))
119 #define DEFAULT_NAME_LEN (8 + 4 + 1)
120 static char default_filename[DEFAULT_NAME_LEN];
122 #ifndef CONFIG_TFTP_FILE_NAME_MAX_LEN
125 #define MAX_LEN CONFIG_TFTP_FILE_NAME_MAX_LEN
128 static char tftp_filename[MAX_LEN];
130 /* 512 is poor choice for ethernet, MTU is typically 1500.
131 * Minus eth.hdrs thats 1468. Can get 2x better throughput with
132 * almost-MTU block sizes. At least try... fall back to 512 if need be.
133 * (but those using CONFIG_IP_DEFRAG may want to set a larger block in cfg file)
135 #ifdef CONFIG_TFTP_BLOCKSIZE
136 #define TFTP_MTU_BLOCKSIZE CONFIG_TFTP_BLOCKSIZE
138 #define TFTP_MTU_BLOCKSIZE 1468
141 static unsigned short tftp_block_size = TFTP_BLOCK_SIZE;
142 static unsigned short tftp_block_size_option = TFTP_MTU_BLOCKSIZE;
144 static inline int store_block(int block, uchar *src, unsigned int len)
146 ulong offset = block * tftp_block_size + tftp_block_wrap_offset;
147 ulong newsize = offset + len;
148 ulong store_addr = tftp_load_addr + offset;
149 #ifdef CONFIG_SYS_DIRECT_FLASH_TFTP
152 for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; i++) {
153 /* start address in flash? */
154 if (flash_info[i].flash_id == FLASH_UNKNOWN)
156 if (store_addr >= flash_info[i].start[0]) {
162 if (rc) { /* Flash is destination for this packet */
163 rc = flash_write((char *)src, store_addr, len);
169 #endif /* CONFIG_SYS_DIRECT_FLASH_TFTP */
174 ulong end_addr = tftp_load_addr + tftp_load_size;
177 end_addr = ULONG_MAX;
179 if (store_addr < tftp_load_addr ||
180 store_addr + len > end_addr) {
181 puts("\nTFTP error: ");
182 puts("trying to overwrite reserved memory...\n");
186 ptr = map_sysmem(store_addr, len);
187 memcpy(ptr, src, len);
191 if (net_boot_file_size < newsize)
192 net_boot_file_size = newsize;
197 /* Clear our state ready for a new transfer */
198 static void new_transfer(void)
202 tftp_block_wrap_offset = 0;
203 #ifdef CONFIG_CMD_TFTPPUT
204 tftp_put_final_block_sent = 0;
208 #ifdef CONFIG_CMD_TFTPPUT
210 * Load the next block from memory to be sent over tftp.
212 * @param block Block number to send
213 * @param dst Destination buffer for data
214 * @param len Number of bytes in block (this one and every other)
215 * @return number of bytes loaded
217 static int load_block(unsigned block, uchar *dst, unsigned len)
219 /* We may want to get the final block from the previous set */
220 ulong offset = ((int)block - 1) * len + tftp_block_wrap_offset;
223 tosend = min(net_boot_file_size - offset, tosend);
224 (void)memcpy(dst, (void *)(save_addr + offset), tosend);
225 debug("%s: block=%d, offset=%ld, len=%d, tosend=%ld\n", __func__,
226 block, offset, len, tosend);
231 static void tftp_send(void);
232 static void tftp_timeout_handler(void);
234 /**********************************************************************/
236 static void show_block_marker(void)
238 #ifdef CONFIG_TFTP_TSIZE
240 ulong 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 if (((tftp_cur_block - 1) % 10) == 0)
254 else if ((tftp_cur_block % (10 * HASHES_PER_LINE)) == 0)
260 * restart the current transfer due to an error
262 * @param msg Message to print for user
264 static void restart(const char *msg)
266 printf("\n%s; starting again\n", msg);
271 * Check if the block number has wrapped, and update progress
273 * TODO: The egregious use of global variables in this file should be tidied.
275 static void update_block_number(void)
278 * RFC1350 specifies that the first data packet will
279 * have sequence number 1. If we receive a sequence
280 * number of 0 this means that there was a wrap
281 * around of the (16 bit) counter.
283 if (tftp_cur_block == 0 && tftp_prev_block != 0) {
285 tftp_block_wrap_offset += tftp_block_size * TFTP_SEQUENCE_SIZE;
286 timeout_count = 0; /* we've done well, reset the timeout */
292 /* The TFTP get or put is complete */
293 static void tftp_complete(void)
295 #ifdef CONFIG_TFTP_TSIZE
296 /* Print hash marks for the last packet received */
297 while (tftp_tsize && tftp_tsize_num_hash < 49) {
299 tftp_tsize_num_hash++;
302 print_size(tftp_tsize, "");
304 time_start = get_timer(time_start);
305 if (time_start > 0) {
306 puts("\n\t "); /* Line up with "Loading: " */
307 print_size(net_boot_file_size /
308 time_start * 1000, "/s");
311 net_set_state(NETLOOP_SUCCESS);
314 static void tftp_send(void)
322 * We will always be sending some sort of packet, so
323 * cobble together the packet headers now.
325 pkt = net_tx_packet + net_eth_hdr_size() + IP_UDP_HDR_SIZE;
327 switch (tftp_state) {
332 #ifdef CONFIG_CMD_TFTPPUT
333 *s++ = htons(tftp_state == STATE_SEND_RRQ ? TFTP_RRQ :
336 *s++ = htons(TFTP_RRQ);
339 strcpy((char *)pkt, tftp_filename);
340 pkt += strlen(tftp_filename) + 1;
341 strcpy((char *)pkt, "octet");
342 pkt += 5 /*strlen("octet")*/ + 1;
343 strcpy((char *)pkt, "timeout");
344 pkt += 7 /*strlen("timeout")*/ + 1;
345 sprintf((char *)pkt, "%lu", timeout_ms / 1000);
346 debug("send option \"timeout %s\"\n", (char *)pkt);
347 pkt += strlen((char *)pkt) + 1;
348 #ifdef CONFIG_TFTP_TSIZE
349 pkt += sprintf((char *)pkt, "tsize%c%u%c",
350 0, net_boot_file_size, 0);
352 /* try for more effic. blk size */
353 pkt += sprintf((char *)pkt, "blksize%c%d%c",
354 0, tftp_block_size_option, 0);
364 s[0] = htons(TFTP_ACK);
365 s[1] = htons(tftp_cur_block);
366 pkt = (uchar *)(s + 2);
367 #ifdef CONFIG_CMD_TFTPPUT
368 if (tftp_put_active) {
369 int toload = tftp_block_size;
370 int loaded = load_block(tftp_cur_block, pkt, toload);
372 s[0] = htons(TFTP_DATA);
374 tftp_put_final_block_sent = (loaded < toload);
380 case STATE_TOO_LARGE:
383 *s++ = htons(TFTP_ERROR);
387 strcpy((char *)pkt, "File too large");
388 pkt += 14 /*strlen("File too large")*/ + 1;
392 case STATE_BAD_MAGIC:
395 *s++ = htons(TFTP_ERROR);
398 strcpy((char *)pkt, "File has bad magic");
399 pkt += 18 /*strlen("File has bad magic")*/ + 1;
404 net_send_udp_packet(net_server_ethaddr, tftp_remote_ip,
405 tftp_remote_port, tftp_our_port, len);
408 #ifdef CONFIG_CMD_TFTPPUT
409 static void icmp_handler(unsigned type, unsigned code, unsigned dest,
410 struct in_addr sip, unsigned src, uchar *pkt,
413 if (type == ICMP_NOT_REACH && code == ICMP_NOT_REACH_PORT) {
414 /* Oh dear the other end has gone away */
415 restart("TFTP server died");
420 static void tftp_handler(uchar *pkt, unsigned dest, struct in_addr sip,
421 unsigned src, unsigned len)
427 if (dest != tftp_our_port) {
430 if (tftp_state != STATE_SEND_RRQ && src != tftp_remote_port &&
431 tftp_state != STATE_RECV_WRQ && tftp_state != STATE_SEND_WRQ)
437 /* warning: don't use increment (++) in ntohs() macros!! */
441 switch (ntohs(proto)) {
446 #ifdef CONFIG_CMD_TFTPPUT
447 if (tftp_put_active) {
448 if (tftp_put_final_block_sent) {
452 * Move to the next block. We want our block
453 * count to wrap just like the other end!
455 int block = ntohs(*s);
456 int ack_ok = (tftp_cur_block == block);
458 tftp_cur_block = (unsigned short)(block + 1);
459 update_block_number();
461 tftp_send(); /* Send next data block */
470 #ifdef CONFIG_CMD_TFTPSRV
473 tftp_remote_ip = sip;
474 tftp_remote_port = src;
475 tftp_our_port = 1024 + (get_timer(0) % 3072);
477 tftp_send(); /* Send ACK(0) */
482 debug("Got OACK: %s %s\n",
483 pkt, pkt + strlen((char *)pkt) + 1);
484 tftp_state = STATE_OACK;
485 tftp_remote_port = src;
487 * Check for 'blksize' option.
488 * Careful: "i" is signed, "len" is unsigned, thus
489 * something like "len-8" may give a *huge* number
491 for (i = 0; i+8 < len; i++) {
492 if (strcmp((char *)pkt + i, "blksize") == 0) {
493 tftp_block_size = (unsigned short)
494 simple_strtoul((char *)pkt + i + 8,
496 debug("Blocksize ack: %s, %d\n",
497 (char *)pkt + i + 8, tftp_block_size);
499 #ifdef CONFIG_TFTP_TSIZE
500 if (strcmp((char *)pkt+i, "tsize") == 0) {
501 tftp_tsize = simple_strtoul((char *)pkt + i + 6,
503 debug("size = %s, %d\n",
504 (char *)pkt + i + 6, tftp_tsize);
508 #ifdef CONFIG_CMD_TFTPPUT
509 if (tftp_put_active) {
510 /* Get ready to send the first block */
511 tftp_state = STATE_DATA;
515 tftp_send(); /* Send ACK or first data block */
521 tftp_cur_block = ntohs(*(__be16 *)pkt);
523 update_block_number();
525 if (tftp_state == STATE_SEND_RRQ)
526 debug("Server did not acknowledge timeout option!\n");
528 if (tftp_state == STATE_SEND_RRQ || tftp_state == STATE_OACK ||
529 tftp_state == STATE_RECV_WRQ) {
530 /* first block received */
531 tftp_state = STATE_DATA;
532 tftp_remote_port = src;
535 if (tftp_cur_block != 1) { /* Assertion */
536 puts("\nTFTP error: ");
537 printf("First block is not block 1 (%ld)\n",
539 puts("Starting again\n\n");
545 if (tftp_cur_block == tftp_prev_block) {
546 /* Same block again; ignore it. */
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 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, load_addr);
621 tftp_load_size = max_size;
623 tftp_load_addr = 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", save_addr);
714 printf("Save size: 0x%lx\n", save_size);
715 net_boot_file_size = 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 */