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>
19 #ifdef CONFIG_SYS_DIRECT_FLASH_TFTP
23 DECLARE_GLOBAL_DATA_PTR;
25 /* Well known TFTP port # */
26 #define WELL_KNOWN_PORT 69
27 /* Millisecs to timeout for lost pkt */
28 #define TIMEOUT 5000UL
29 #ifndef CONFIG_NET_RETRY_COUNT
30 /* # of timeouts before giving up */
31 # define TIMEOUT_COUNT 10
33 # define TIMEOUT_COUNT (CONFIG_NET_RETRY_COUNT * 2)
35 /* Number of "loading" hashes per line (for checking the image size) */
36 #define HASHES_PER_LINE 65
48 static ulong timeout_ms = TIMEOUT;
49 static int timeout_count_max = TIMEOUT_COUNT;
50 static ulong time_start; /* Record time we started tftp */
53 * These globals govern the timeout behavior when attempting a connection to a
54 * TFTP server. tftp_timeout_ms specifies the number of milliseconds to
55 * wait for the server to respond to initial connection. Second global,
56 * tftp_timeout_count_max, gives the number of such connection retries.
57 * tftp_timeout_count_max must be non-negative and tftp_timeout_ms must be
58 * positive. The globals are meant to be set (and restored) by code needing
59 * non-standard timeout behavior when initiating a TFTP transfer.
61 ulong tftp_timeout_ms = TIMEOUT;
62 int tftp_timeout_count_max = TIMEOUT_COUNT;
65 TFTP_ERR_UNDEFINED = 0,
66 TFTP_ERR_FILE_NOT_FOUND = 1,
67 TFTP_ERR_ACCESS_DENIED = 2,
68 TFTP_ERR_DISK_FULL = 3,
69 TFTP_ERR_UNEXPECTED_OPCODE = 4,
70 TFTP_ERR_UNKNOWN_TRANSFER_ID = 5,
71 TFTP_ERR_FILE_ALREADY_EXISTS = 6,
74 static struct in_addr tftp_remote_ip;
75 /* The UDP port at their end */
76 static int tftp_remote_port;
77 /* The UDP port at our end */
78 static int tftp_our_port;
79 static int timeout_count;
80 /* packet sequence number */
81 static ulong tftp_cur_block;
82 /* last packet sequence number received */
83 static ulong tftp_prev_block;
84 /* count of sequence number wraparounds */
85 static ulong tftp_block_wrap;
86 /* memory offset due to wrapping */
87 static ulong tftp_block_wrap_offset;
88 static int tftp_state;
89 static ulong tftp_load_addr;
91 static ulong tftp_load_size;
93 #ifdef CONFIG_TFTP_TSIZE
94 /* The file size reported by the server */
95 static int tftp_tsize;
96 /* The number of hashes we printed */
97 static short tftp_tsize_num_hash;
99 #ifdef CONFIG_CMD_TFTPPUT
100 /* 1 if writing, else 0 */
101 static int tftp_put_active;
102 /* 1 if we have sent the last block */
103 static int tftp_put_final_block_sent;
105 #define tftp_put_active 0
108 #define STATE_SEND_RRQ 1
110 #define STATE_TOO_LARGE 3
111 #define STATE_BAD_MAGIC 4
113 #define STATE_RECV_WRQ 6
114 #define STATE_SEND_WRQ 7
116 /* default TFTP block size */
117 #define TFTP_BLOCK_SIZE 512
118 /* sequence number is 16 bit */
119 #define TFTP_SEQUENCE_SIZE ((ulong)(1<<16))
121 #define DEFAULT_NAME_LEN (8 + 4 + 1)
122 static char default_filename[DEFAULT_NAME_LEN];
124 #ifndef CONFIG_TFTP_FILE_NAME_MAX_LEN
127 #define MAX_LEN CONFIG_TFTP_FILE_NAME_MAX_LEN
130 static char tftp_filename[MAX_LEN];
132 /* 512 is poor choice for ethernet, MTU is typically 1500.
133 * Minus eth.hdrs thats 1468. Can get 2x better throughput with
134 * almost-MTU block sizes. At least try... fall back to 512 if need be.
135 * (but those using CONFIG_IP_DEFRAG may want to set a larger block in cfg file)
138 static unsigned short tftp_block_size = TFTP_BLOCK_SIZE;
139 static unsigned short tftp_block_size_option = CONFIG_TFTP_BLOCKSIZE;
141 static inline int store_block(int block, uchar *src, unsigned int len)
143 ulong offset = block * tftp_block_size + tftp_block_wrap_offset;
144 ulong newsize = offset + len;
145 ulong store_addr = tftp_load_addr + offset;
146 #ifdef CONFIG_SYS_DIRECT_FLASH_TFTP
149 for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; i++) {
150 /* start address in flash? */
151 if (flash_info[i].flash_id == FLASH_UNKNOWN)
153 if (store_addr >= flash_info[i].start[0]) {
159 if (rc) { /* Flash is destination for this packet */
160 rc = flash_write((char *)src, store_addr, len);
166 #endif /* CONFIG_SYS_DIRECT_FLASH_TFTP */
171 ulong end_addr = tftp_load_addr + tftp_load_size;
174 end_addr = ULONG_MAX;
176 if (store_addr < tftp_load_addr ||
177 store_addr + len > end_addr) {
178 puts("\nTFTP error: ");
179 puts("trying to overwrite reserved memory...\n");
183 ptr = map_sysmem(store_addr, len);
184 memcpy(ptr, src, len);
188 if (net_boot_file_size < newsize)
189 net_boot_file_size = newsize;
194 /* Clear our state ready for a new transfer */
195 static void new_transfer(void)
199 tftp_block_wrap_offset = 0;
200 #ifdef CONFIG_CMD_TFTPPUT
201 tftp_put_final_block_sent = 0;
205 #ifdef CONFIG_CMD_TFTPPUT
207 * Load the next block from memory to be sent over tftp.
209 * @param block Block number to send
210 * @param dst Destination buffer for data
211 * @param len Number of bytes in block (this one and every other)
212 * @return number of bytes loaded
214 static int load_block(unsigned block, uchar *dst, unsigned len)
216 /* We may want to get the final block from the previous set */
217 ulong offset = ((int)block - 1) * len + tftp_block_wrap_offset;
220 tosend = min(net_boot_file_size - offset, tosend);
221 (void)memcpy(dst, (void *)(image_save_addr + offset), tosend);
222 debug("%s: block=%u, offset=%lu, len=%u, tosend=%lu\n", __func__,
223 block, offset, len, tosend);
228 static void tftp_send(void);
229 static void tftp_timeout_handler(void);
231 /**********************************************************************/
233 static void show_block_marker(void)
235 #ifdef CONFIG_TFTP_TSIZE
237 ulong pos = tftp_cur_block * tftp_block_size +
238 tftp_block_wrap_offset;
239 if (pos > tftp_tsize)
242 while (tftp_tsize_num_hash < pos * 50 / tftp_tsize) {
244 tftp_tsize_num_hash++;
249 if (((tftp_cur_block - 1) % 10) == 0)
251 else if ((tftp_cur_block % (10 * HASHES_PER_LINE)) == 0)
257 * restart the current transfer due to an error
259 * @param msg Message to print for user
261 static void restart(const char *msg)
263 printf("\n%s; starting again\n", msg);
268 * Check if the block number has wrapped, and update progress
270 * TODO: The egregious use of global variables in this file should be tidied.
272 static void update_block_number(void)
275 * RFC1350 specifies that the first data packet will
276 * have sequence number 1. If we receive a sequence
277 * number of 0 this means that there was a wrap
278 * around of the (16 bit) counter.
280 if (tftp_cur_block == 0 && tftp_prev_block != 0) {
282 tftp_block_wrap_offset += tftp_block_size * TFTP_SEQUENCE_SIZE;
283 timeout_count = 0; /* we've done well, reset the timeout */
289 /* The TFTP get or put is complete */
290 static void tftp_complete(void)
292 #ifdef CONFIG_TFTP_TSIZE
293 /* Print hash marks for the last packet received */
294 while (tftp_tsize && tftp_tsize_num_hash < 49) {
296 tftp_tsize_num_hash++;
299 print_size(tftp_tsize, "");
301 time_start = get_timer(time_start);
302 if (time_start > 0) {
303 puts("\n\t "); /* Line up with "Loading: " */
304 print_size(net_boot_file_size /
305 time_start * 1000, "/s");
308 net_set_state(NETLOOP_SUCCESS);
311 static void tftp_send(void)
319 * We will always be sending some sort of packet, so
320 * cobble together the packet headers now.
322 pkt = net_tx_packet + net_eth_hdr_size() + IP_UDP_HDR_SIZE;
324 switch (tftp_state) {
329 #ifdef CONFIG_CMD_TFTPPUT
330 *s++ = htons(tftp_state == STATE_SEND_RRQ ? TFTP_RRQ :
333 *s++ = htons(TFTP_RRQ);
336 strcpy((char *)pkt, tftp_filename);
337 pkt += strlen(tftp_filename) + 1;
338 strcpy((char *)pkt, "octet");
339 pkt += 5 /*strlen("octet")*/ + 1;
340 strcpy((char *)pkt, "timeout");
341 pkt += 7 /*strlen("timeout")*/ + 1;
342 sprintf((char *)pkt, "%lu", timeout_ms / 1000);
343 debug("send option \"timeout %s\"\n", (char *)pkt);
344 pkt += strlen((char *)pkt) + 1;
345 #ifdef CONFIG_TFTP_TSIZE
346 pkt += sprintf((char *)pkt, "tsize%c%u%c",
347 0, net_boot_file_size, 0);
349 /* try for more effic. blk size */
350 pkt += sprintf((char *)pkt, "blksize%c%d%c",
351 0, tftp_block_size_option, 0);
361 s[0] = htons(TFTP_ACK);
362 s[1] = htons(tftp_cur_block);
363 pkt = (uchar *)(s + 2);
364 #ifdef CONFIG_CMD_TFTPPUT
365 if (tftp_put_active) {
366 int toload = tftp_block_size;
367 int loaded = load_block(tftp_cur_block, pkt, toload);
369 s[0] = htons(TFTP_DATA);
371 tftp_put_final_block_sent = (loaded < toload);
377 case STATE_TOO_LARGE:
380 *s++ = htons(TFTP_ERROR);
384 strcpy((char *)pkt, "File too large");
385 pkt += 14 /*strlen("File too large")*/ + 1;
389 case STATE_BAD_MAGIC:
392 *s++ = htons(TFTP_ERROR);
395 strcpy((char *)pkt, "File has bad magic");
396 pkt += 18 /*strlen("File has bad magic")*/ + 1;
401 net_send_udp_packet(net_server_ethaddr, tftp_remote_ip,
402 tftp_remote_port, tftp_our_port, len);
405 #ifdef CONFIG_CMD_TFTPPUT
406 static void icmp_handler(unsigned type, unsigned code, unsigned dest,
407 struct in_addr sip, unsigned src, uchar *pkt,
410 if (type == ICMP_NOT_REACH && code == ICMP_NOT_REACH_PORT) {
411 /* Oh dear the other end has gone away */
412 restart("TFTP server died");
417 static void tftp_handler(uchar *pkt, unsigned dest, struct in_addr sip,
418 unsigned src, unsigned len)
424 if (dest != tftp_our_port) {
427 if (tftp_state != STATE_SEND_RRQ && src != tftp_remote_port &&
428 tftp_state != STATE_RECV_WRQ && tftp_state != STATE_SEND_WRQ)
434 /* warning: don't use increment (++) in ntohs() macros!! */
438 switch (ntohs(proto)) {
443 #ifdef CONFIG_CMD_TFTPPUT
444 if (tftp_put_active) {
445 if (tftp_put_final_block_sent) {
449 * Move to the next block. We want our block
450 * count to wrap just like the other end!
452 int block = ntohs(*s);
453 int ack_ok = (tftp_cur_block == block);
455 tftp_cur_block = (unsigned short)(block + 1);
456 update_block_number();
458 tftp_send(); /* Send next data block */
467 #ifdef CONFIG_CMD_TFTPSRV
470 tftp_remote_ip = sip;
471 tftp_remote_port = src;
472 tftp_our_port = 1024 + (get_timer(0) % 3072);
474 tftp_send(); /* Send ACK(0) */
479 debug("Got OACK: %s %s\n",
480 pkt, pkt + strlen((char *)pkt) + 1);
481 tftp_state = STATE_OACK;
482 tftp_remote_port = src;
484 * Check for 'blksize' option.
485 * Careful: "i" is signed, "len" is unsigned, thus
486 * something like "len-8" may give a *huge* number
488 for (i = 0; i+8 < len; i++) {
489 if (strcmp((char *)pkt + i, "blksize") == 0) {
490 tftp_block_size = (unsigned short)
491 simple_strtoul((char *)pkt + i + 8,
493 debug("Blocksize ack: %s, %d\n",
494 (char *)pkt + i + 8, tftp_block_size);
496 #ifdef CONFIG_TFTP_TSIZE
497 if (strcmp((char *)pkt+i, "tsize") == 0) {
498 tftp_tsize = simple_strtoul((char *)pkt + i + 6,
500 debug("size = %s, %d\n",
501 (char *)pkt + i + 6, tftp_tsize);
505 #ifdef CONFIG_CMD_TFTPPUT
506 if (tftp_put_active) {
507 /* Get ready to send the first block */
508 tftp_state = STATE_DATA;
512 tftp_send(); /* Send ACK or first data block */
518 tftp_cur_block = ntohs(*(__be16 *)pkt);
520 update_block_number();
522 if (tftp_state == STATE_SEND_RRQ)
523 debug("Server did not acknowledge timeout option!\n");
525 if (tftp_state == STATE_SEND_RRQ || tftp_state == STATE_OACK ||
526 tftp_state == STATE_RECV_WRQ) {
527 /* first block received */
528 tftp_state = STATE_DATA;
529 tftp_remote_port = src;
532 if (tftp_cur_block != 1) { /* Assertion */
533 puts("\nTFTP error: ");
534 printf("First block is not block 1 (%ld)\n",
536 puts("Starting again\n\n");
542 if (tftp_cur_block == tftp_prev_block) {
543 /* Same block again; ignore it. */
547 tftp_prev_block = tftp_cur_block;
548 timeout_count_max = tftp_timeout_count_max;
549 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
551 if (store_block(tftp_cur_block - 1, pkt + 2, len)) {
553 net_set_state(NETLOOP_FAIL);
558 * Acknowledge the block just received, which will prompt
559 * the remote for the next one.
563 if (len < tftp_block_size)
568 printf("\nTFTP error: '%s' (%d)\n",
569 pkt + 2, ntohs(*(__be16 *)pkt));
571 switch (ntohs(*(__be16 *)pkt)) {
572 case TFTP_ERR_FILE_NOT_FOUND:
573 case TFTP_ERR_ACCESS_DENIED:
574 puts("Not retrying...\n");
576 net_set_state(NETLOOP_FAIL);
578 case TFTP_ERR_UNDEFINED:
579 case TFTP_ERR_DISK_FULL:
580 case TFTP_ERR_UNEXPECTED_OPCODE:
581 case TFTP_ERR_UNKNOWN_TRANSFER_ID:
582 case TFTP_ERR_FILE_ALREADY_EXISTS:
584 puts("Starting again\n\n");
593 static void tftp_timeout_handler(void)
595 if (++timeout_count > timeout_count_max) {
596 restart("Retry count exceeded");
599 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
600 if (tftp_state != STATE_RECV_WRQ)
605 /* Initialize tftp_load_addr and tftp_load_size from image_load_addr and lmb */
606 static int tftp_init_load_addr(void)
610 phys_size_t max_size;
612 lmb_init_and_reserve(&lmb, gd->bd, (void *)gd->fdt_blob);
614 max_size = lmb_get_free_size(&lmb, image_load_addr);
618 tftp_load_size = max_size;
620 tftp_load_addr = image_load_addr;
624 void tftp_start(enum proto_t protocol)
626 #if CONFIG_NET_TFTP_VARS
627 char *ep; /* Environment pointer */
630 * Allow the user to choose TFTP blocksize and timeout.
631 * TFTP protocol has a minimal timeout of 1 second.
634 ep = env_get("tftpblocksize");
636 tftp_block_size_option = simple_strtol(ep, NULL, 10);
638 ep = env_get("tftptimeout");
640 timeout_ms = simple_strtol(ep, NULL, 10);
642 if (timeout_ms < 1000) {
643 printf("TFTP timeout (%ld ms) too low, set min = 1000 ms\n",
648 ep = env_get("tftptimeoutcountmax");
650 tftp_timeout_count_max = simple_strtol(ep, NULL, 10);
652 if (tftp_timeout_count_max < 0) {
653 printf("TFTP timeout count max (%d ms) negative, set to 0\n",
654 tftp_timeout_count_max);
655 tftp_timeout_count_max = 0;
659 debug("TFTP blocksize = %i, timeout = %ld ms\n",
660 tftp_block_size_option, timeout_ms);
662 tftp_remote_ip = net_server_ip;
663 if (!net_parse_bootfile(&tftp_remote_ip, tftp_filename, MAX_LEN)) {
664 sprintf(default_filename, "%02X%02X%02X%02X.img",
665 net_ip.s_addr & 0xFF,
666 (net_ip.s_addr >> 8) & 0xFF,
667 (net_ip.s_addr >> 16) & 0xFF,
668 (net_ip.s_addr >> 24) & 0xFF);
670 strncpy(tftp_filename, default_filename, DEFAULT_NAME_LEN);
671 tftp_filename[DEFAULT_NAME_LEN - 1] = 0;
673 printf("*** Warning: no boot file name; using '%s'\n",
677 printf("Using %s device\n", eth_get_name());
678 printf("TFTP %s server %pI4; our IP address is %pI4",
679 #ifdef CONFIG_CMD_TFTPPUT
680 protocol == TFTPPUT ? "to" : "from",
684 &tftp_remote_ip, &net_ip);
686 /* Check if we need to send across this subnet */
687 if (net_gateway.s_addr && net_netmask.s_addr) {
688 struct in_addr our_net;
689 struct in_addr remote_net;
691 our_net.s_addr = net_ip.s_addr & net_netmask.s_addr;
692 remote_net.s_addr = tftp_remote_ip.s_addr & net_netmask.s_addr;
693 if (our_net.s_addr != remote_net.s_addr)
694 printf("; sending through gateway %pI4", &net_gateway);
698 printf("Filename '%s'.", tftp_filename);
700 if (net_boot_file_expected_size_in_blocks) {
701 printf(" Size is 0x%x Bytes = ",
702 net_boot_file_expected_size_in_blocks << 9);
703 print_size(net_boot_file_expected_size_in_blocks << 9, "");
707 #ifdef CONFIG_CMD_TFTPPUT
708 tftp_put_active = (protocol == TFTPPUT);
709 if (tftp_put_active) {
710 printf("Save address: 0x%lx\n", image_save_addr);
711 printf("Save size: 0x%lx\n", image_save_size);
712 net_boot_file_size = image_save_size;
714 tftp_state = STATE_SEND_WRQ;
719 if (tftp_init_load_addr()) {
721 net_set_state(NETLOOP_FAIL);
722 puts("\nTFTP error: ");
723 puts("trying to overwrite reserved memory...\n");
726 printf("Load address: 0x%lx\n", tftp_load_addr);
727 puts("Loading: *\b");
728 tftp_state = STATE_SEND_RRQ;
729 #ifdef CONFIG_CMD_BOOTEFI
730 efi_set_bootdev("Net", "", tftp_filename);
734 time_start = get_timer(0);
735 timeout_count_max = tftp_timeout_count_max;
737 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
738 net_set_udp_handler(tftp_handler);
739 #ifdef CONFIG_CMD_TFTPPUT
740 net_set_icmp_handler(icmp_handler);
742 tftp_remote_port = WELL_KNOWN_PORT;
744 /* Use a pseudo-random port unless a specific port is set */
745 tftp_our_port = 1024 + (get_timer(0) % 3072);
747 #ifdef CONFIG_TFTP_PORT
748 ep = env_get("tftpdstp");
750 tftp_remote_port = simple_strtol(ep, NULL, 10);
751 ep = env_get("tftpsrcp");
753 tftp_our_port = simple_strtol(ep, NULL, 10);
757 /* zero out server ether in case the server ip has changed */
758 memset(net_server_ethaddr, 0, 6);
759 /* Revert tftp_block_size to dflt */
760 tftp_block_size = TFTP_BLOCK_SIZE;
761 #ifdef CONFIG_TFTP_TSIZE
763 tftp_tsize_num_hash = 0;
769 #ifdef CONFIG_CMD_TFTPSRV
770 void tftp_start_server(void)
772 tftp_filename[0] = 0;
774 if (tftp_init_load_addr()) {
776 net_set_state(NETLOOP_FAIL);
777 puts("\nTFTP error: trying to overwrite reserved memory...\n");
780 printf("Using %s device\n", eth_get_name());
781 printf("Listening for TFTP transfer on %pI4\n", &net_ip);
782 printf("Load address: 0x%lx\n", tftp_load_addr);
784 puts("Loading: *\b");
786 timeout_count_max = tftp_timeout_count_max;
788 timeout_ms = TIMEOUT;
789 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
791 /* Revert tftp_block_size to dflt */
792 tftp_block_size = TFTP_BLOCK_SIZE;
794 tftp_our_port = WELL_KNOWN_PORT;
796 #ifdef CONFIG_TFTP_TSIZE
798 tftp_tsize_num_hash = 0;
801 tftp_state = STATE_RECV_WRQ;
802 net_set_udp_handler(tftp_handler);
804 /* zero out server ether in case the server ip has changed */
805 memset(net_server_ethaddr, 0, 6);
807 #endif /* CONFIG_CMD_TFTPSRV */