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 if (store_addr < tftp_load_addr ||
175 store_addr + len > tftp_load_addr + tftp_load_size) {
176 puts("\nTFTP error: ");
177 puts("trying to overwrite reserved memory...\n");
181 ptr = map_sysmem(store_addr, len);
182 memcpy(ptr, src, len);
186 if (net_boot_file_size < newsize)
187 net_boot_file_size = newsize;
192 /* Clear our state ready for a new transfer */
193 static void new_transfer(void)
197 tftp_block_wrap_offset = 0;
198 #ifdef CONFIG_CMD_TFTPPUT
199 tftp_put_final_block_sent = 0;
203 #ifdef CONFIG_CMD_TFTPPUT
205 * Load the next block from memory to be sent over tftp.
207 * @param block Block number to send
208 * @param dst Destination buffer for data
209 * @param len Number of bytes in block (this one and every other)
210 * @return number of bytes loaded
212 static int load_block(unsigned block, uchar *dst, unsigned len)
214 /* We may want to get the final block from the previous set */
215 ulong offset = ((int)block - 1) * len + tftp_block_wrap_offset;
218 tosend = min(net_boot_file_size - offset, tosend);
219 (void)memcpy(dst, (void *)(save_addr + offset), tosend);
220 debug("%s: block=%d, offset=%ld, len=%d, tosend=%ld\n", __func__,
221 block, offset, len, tosend);
226 static void tftp_send(void);
227 static void tftp_timeout_handler(void);
229 /**********************************************************************/
231 static void show_block_marker(void)
233 #ifdef CONFIG_TFTP_TSIZE
235 ulong pos = tftp_cur_block * tftp_block_size +
236 tftp_block_wrap_offset;
237 if (pos > tftp_tsize)
240 while (tftp_tsize_num_hash < pos * 50 / tftp_tsize) {
242 tftp_tsize_num_hash++;
247 if (((tftp_cur_block - 1) % 10) == 0)
249 else if ((tftp_cur_block % (10 * HASHES_PER_LINE)) == 0)
255 * restart the current transfer due to an error
257 * @param msg Message to print for user
259 static void restart(const char *msg)
261 printf("\n%s; starting again\n", msg);
266 * Check if the block number has wrapped, and update progress
268 * TODO: The egregious use of global variables in this file should be tidied.
270 static void update_block_number(void)
273 * RFC1350 specifies that the first data packet will
274 * have sequence number 1. If we receive a sequence
275 * number of 0 this means that there was a wrap
276 * around of the (16 bit) counter.
278 if (tftp_cur_block == 0 && tftp_prev_block != 0) {
280 tftp_block_wrap_offset += tftp_block_size * TFTP_SEQUENCE_SIZE;
281 timeout_count = 0; /* we've done well, reset the timeout */
287 /* The TFTP get or put is complete */
288 static void tftp_complete(void)
290 #ifdef CONFIG_TFTP_TSIZE
291 /* Print hash marks for the last packet received */
292 while (tftp_tsize && tftp_tsize_num_hash < 49) {
294 tftp_tsize_num_hash++;
297 print_size(tftp_tsize, "");
299 time_start = get_timer(time_start);
300 if (time_start > 0) {
301 puts("\n\t "); /* Line up with "Loading: " */
302 print_size(net_boot_file_size /
303 time_start * 1000, "/s");
306 net_set_state(NETLOOP_SUCCESS);
309 static void tftp_send(void)
317 * We will always be sending some sort of packet, so
318 * cobble together the packet headers now.
320 pkt = net_tx_packet + net_eth_hdr_size() + IP_UDP_HDR_SIZE;
322 switch (tftp_state) {
327 #ifdef CONFIG_CMD_TFTPPUT
328 *s++ = htons(tftp_state == STATE_SEND_RRQ ? TFTP_RRQ :
331 *s++ = htons(TFTP_RRQ);
334 strcpy((char *)pkt, tftp_filename);
335 pkt += strlen(tftp_filename) + 1;
336 strcpy((char *)pkt, "octet");
337 pkt += 5 /*strlen("octet")*/ + 1;
338 strcpy((char *)pkt, "timeout");
339 pkt += 7 /*strlen("timeout")*/ + 1;
340 sprintf((char *)pkt, "%lu", timeout_ms / 1000);
341 debug("send option \"timeout %s\"\n", (char *)pkt);
342 pkt += strlen((char *)pkt) + 1;
343 #ifdef CONFIG_TFTP_TSIZE
344 pkt += sprintf((char *)pkt, "tsize%c%u%c",
345 0, net_boot_file_size, 0);
347 /* try for more effic. blk size */
348 pkt += sprintf((char *)pkt, "blksize%c%d%c",
349 0, tftp_block_size_option, 0);
359 s[0] = htons(TFTP_ACK);
360 s[1] = htons(tftp_cur_block);
361 pkt = (uchar *)(s + 2);
362 #ifdef CONFIG_CMD_TFTPPUT
363 if (tftp_put_active) {
364 int toload = tftp_block_size;
365 int loaded = load_block(tftp_cur_block, pkt, toload);
367 s[0] = htons(TFTP_DATA);
369 tftp_put_final_block_sent = (loaded < toload);
375 case STATE_TOO_LARGE:
378 *s++ = htons(TFTP_ERROR);
382 strcpy((char *)pkt, "File too large");
383 pkt += 14 /*strlen("File too large")*/ + 1;
387 case STATE_BAD_MAGIC:
390 *s++ = htons(TFTP_ERROR);
393 strcpy((char *)pkt, "File has bad magic");
394 pkt += 18 /*strlen("File has bad magic")*/ + 1;
399 net_send_udp_packet(net_server_ethaddr, tftp_remote_ip,
400 tftp_remote_port, tftp_our_port, len);
403 #ifdef CONFIG_CMD_TFTPPUT
404 static void icmp_handler(unsigned type, unsigned code, unsigned dest,
405 struct in_addr sip, unsigned src, uchar *pkt,
408 if (type == ICMP_NOT_REACH && code == ICMP_NOT_REACH_PORT) {
409 /* Oh dear the other end has gone away */
410 restart("TFTP server died");
415 static void tftp_handler(uchar *pkt, unsigned dest, struct in_addr sip,
416 unsigned src, unsigned len)
422 if (dest != tftp_our_port) {
425 if (tftp_state != STATE_SEND_RRQ && src != tftp_remote_port &&
426 tftp_state != STATE_RECV_WRQ && tftp_state != STATE_SEND_WRQ)
432 /* warning: don't use increment (++) in ntohs() macros!! */
436 switch (ntohs(proto)) {
441 #ifdef CONFIG_CMD_TFTPPUT
442 if (tftp_put_active) {
443 if (tftp_put_final_block_sent) {
447 * Move to the next block. We want our block
448 * count to wrap just like the other end!
450 int block = ntohs(*s);
451 int ack_ok = (tftp_cur_block == block);
453 tftp_cur_block = (unsigned short)(block + 1);
454 update_block_number();
456 tftp_send(); /* Send next data block */
465 #ifdef CONFIG_CMD_TFTPSRV
468 tftp_remote_ip = sip;
469 tftp_remote_port = src;
470 tftp_our_port = 1024 + (get_timer(0) % 3072);
472 tftp_send(); /* Send ACK(0) */
477 debug("Got OACK: %s %s\n",
478 pkt, pkt + strlen((char *)pkt) + 1);
479 tftp_state = STATE_OACK;
480 tftp_remote_port = src;
482 * Check for 'blksize' option.
483 * Careful: "i" is signed, "len" is unsigned, thus
484 * something like "len-8" may give a *huge* number
486 for (i = 0; i+8 < len; i++) {
487 if (strcmp((char *)pkt + i, "blksize") == 0) {
488 tftp_block_size = (unsigned short)
489 simple_strtoul((char *)pkt + i + 8,
491 debug("Blocksize ack: %s, %d\n",
492 (char *)pkt + i + 8, tftp_block_size);
494 #ifdef CONFIG_TFTP_TSIZE
495 if (strcmp((char *)pkt+i, "tsize") == 0) {
496 tftp_tsize = simple_strtoul((char *)pkt + i + 6,
498 debug("size = %s, %d\n",
499 (char *)pkt + i + 6, tftp_tsize);
503 #ifdef CONFIG_CMD_TFTPPUT
504 if (tftp_put_active) {
505 /* Get ready to send the first block */
506 tftp_state = STATE_DATA;
510 tftp_send(); /* Send ACK or first data block */
516 tftp_cur_block = ntohs(*(__be16 *)pkt);
518 update_block_number();
520 if (tftp_state == STATE_SEND_RRQ)
521 debug("Server did not acknowledge timeout option!\n");
523 if (tftp_state == STATE_SEND_RRQ || tftp_state == STATE_OACK ||
524 tftp_state == STATE_RECV_WRQ) {
525 /* first block received */
526 tftp_state = STATE_DATA;
527 tftp_remote_port = src;
530 if (tftp_cur_block != 1) { /* Assertion */
531 puts("\nTFTP error: ");
532 printf("First block is not block 1 (%ld)\n",
534 puts("Starting again\n\n");
540 if (tftp_cur_block == tftp_prev_block) {
541 /* Same block again; ignore it. */
545 tftp_prev_block = tftp_cur_block;
546 timeout_count_max = tftp_timeout_count_max;
547 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
549 if (store_block(tftp_cur_block - 1, pkt + 2, len)) {
551 net_set_state(NETLOOP_FAIL);
556 * Acknowledge the block just received, which will prompt
557 * the remote for the next one.
561 if (len < tftp_block_size)
566 printf("\nTFTP error: '%s' (%d)\n",
567 pkt + 2, ntohs(*(__be16 *)pkt));
569 switch (ntohs(*(__be16 *)pkt)) {
570 case TFTP_ERR_FILE_NOT_FOUND:
571 case TFTP_ERR_ACCESS_DENIED:
572 puts("Not retrying...\n");
574 net_set_state(NETLOOP_FAIL);
576 case TFTP_ERR_UNDEFINED:
577 case TFTP_ERR_DISK_FULL:
578 case TFTP_ERR_UNEXPECTED_OPCODE:
579 case TFTP_ERR_UNKNOWN_TRANSFER_ID:
580 case TFTP_ERR_FILE_ALREADY_EXISTS:
582 puts("Starting again\n\n");
591 static void tftp_timeout_handler(void)
593 if (++timeout_count > timeout_count_max) {
594 restart("Retry count exceeded");
597 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
598 if (tftp_state != STATE_RECV_WRQ)
603 /* Initialize tftp_load_addr and tftp_load_size from load_addr and lmb */
604 static int tftp_init_load_addr(void)
608 phys_size_t max_size;
610 lmb_init_and_reserve(&lmb, gd->bd, (void *)gd->fdt_blob);
612 max_size = lmb_get_free_size(&lmb, load_addr);
616 tftp_load_size = max_size;
618 tftp_load_addr = load_addr;
622 void tftp_start(enum proto_t protocol)
624 #if CONFIG_NET_TFTP_VARS
625 char *ep; /* Environment pointer */
628 * Allow the user to choose TFTP blocksize and timeout.
629 * TFTP protocol has a minimal timeout of 1 second.
632 ep = env_get("tftpblocksize");
634 tftp_block_size_option = simple_strtol(ep, NULL, 10);
636 ep = env_get("tftptimeout");
638 timeout_ms = simple_strtol(ep, NULL, 10);
640 if (timeout_ms < 1000) {
641 printf("TFTP timeout (%ld ms) too low, set min = 1000 ms\n",
646 ep = env_get("tftptimeoutcountmax");
648 tftp_timeout_count_max = simple_strtol(ep, NULL, 10);
650 if (tftp_timeout_count_max < 0) {
651 printf("TFTP timeout count max (%d ms) negative, set to 0\n",
652 tftp_timeout_count_max);
653 tftp_timeout_count_max = 0;
657 debug("TFTP blocksize = %i, timeout = %ld ms\n",
658 tftp_block_size_option, timeout_ms);
660 tftp_remote_ip = net_server_ip;
661 if (!net_parse_bootfile(&tftp_remote_ip, tftp_filename, MAX_LEN)) {
662 sprintf(default_filename, "%02X%02X%02X%02X.img",
663 net_ip.s_addr & 0xFF,
664 (net_ip.s_addr >> 8) & 0xFF,
665 (net_ip.s_addr >> 16) & 0xFF,
666 (net_ip.s_addr >> 24) & 0xFF);
668 strncpy(tftp_filename, default_filename, DEFAULT_NAME_LEN);
669 tftp_filename[DEFAULT_NAME_LEN - 1] = 0;
671 printf("*** Warning: no boot file name; using '%s'\n",
675 printf("Using %s device\n", eth_get_name());
676 printf("TFTP %s server %pI4; our IP address is %pI4",
677 #ifdef CONFIG_CMD_TFTPPUT
678 protocol == TFTPPUT ? "to" : "from",
682 &tftp_remote_ip, &net_ip);
684 /* Check if we need to send across this subnet */
685 if (net_gateway.s_addr && net_netmask.s_addr) {
686 struct in_addr our_net;
687 struct in_addr remote_net;
689 our_net.s_addr = net_ip.s_addr & net_netmask.s_addr;
690 remote_net.s_addr = tftp_remote_ip.s_addr & net_netmask.s_addr;
691 if (our_net.s_addr != remote_net.s_addr)
692 printf("; sending through gateway %pI4", &net_gateway);
696 printf("Filename '%s'.", tftp_filename);
698 if (net_boot_file_expected_size_in_blocks) {
699 printf(" Size is 0x%x Bytes = ",
700 net_boot_file_expected_size_in_blocks << 9);
701 print_size(net_boot_file_expected_size_in_blocks << 9, "");
705 #ifdef CONFIG_CMD_TFTPPUT
706 tftp_put_active = (protocol == TFTPPUT);
707 if (tftp_put_active) {
708 printf("Save address: 0x%lx\n", save_addr);
709 printf("Save size: 0x%lx\n", save_size);
710 net_boot_file_size = save_size;
712 tftp_state = STATE_SEND_WRQ;
717 if (tftp_init_load_addr()) {
719 net_set_state(NETLOOP_FAIL);
720 puts("\nTFTP error: ");
721 puts("trying to overwrite reserved memory...\n");
724 printf("Load address: 0x%lx\n", tftp_load_addr);
725 puts("Loading: *\b");
726 tftp_state = STATE_SEND_RRQ;
727 #ifdef CONFIG_CMD_BOOTEFI
728 efi_set_bootdev("Net", "", tftp_filename);
732 time_start = get_timer(0);
733 timeout_count_max = tftp_timeout_count_max;
735 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
736 net_set_udp_handler(tftp_handler);
737 #ifdef CONFIG_CMD_TFTPPUT
738 net_set_icmp_handler(icmp_handler);
740 tftp_remote_port = WELL_KNOWN_PORT;
742 /* Use a pseudo-random port unless a specific port is set */
743 tftp_our_port = 1024 + (get_timer(0) % 3072);
745 #ifdef CONFIG_TFTP_PORT
746 ep = env_get("tftpdstp");
748 tftp_remote_port = simple_strtol(ep, NULL, 10);
749 ep = env_get("tftpsrcp");
751 tftp_our_port = simple_strtol(ep, NULL, 10);
755 /* zero out server ether in case the server ip has changed */
756 memset(net_server_ethaddr, 0, 6);
757 /* Revert tftp_block_size to dflt */
758 tftp_block_size = TFTP_BLOCK_SIZE;
759 #ifdef CONFIG_TFTP_TSIZE
761 tftp_tsize_num_hash = 0;
767 #ifdef CONFIG_CMD_TFTPSRV
768 void tftp_start_server(void)
770 tftp_filename[0] = 0;
772 if (tftp_init_load_addr()) {
774 net_set_state(NETLOOP_FAIL);
775 puts("\nTFTP error: trying to overwrite reserved memory...\n");
778 printf("Using %s device\n", eth_get_name());
779 printf("Listening for TFTP transfer on %pI4\n", &net_ip);
780 printf("Load address: 0x%lx\n", tftp_load_addr);
782 puts("Loading: *\b");
784 timeout_count_max = tftp_timeout_count_max;
786 timeout_ms = TIMEOUT;
787 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
789 /* Revert tftp_block_size to dflt */
790 tftp_block_size = TFTP_BLOCK_SIZE;
792 tftp_our_port = WELL_KNOWN_PORT;
794 #ifdef CONFIG_TFTP_TSIZE
796 tftp_tsize_num_hash = 0;
799 tftp_state = STATE_RECV_WRQ;
800 net_set_udp_handler(tftp_handler);
802 /* zero out server ether in case the server ip has changed */
803 memset(net_server_ethaddr, 0, 6);
805 #endif /* CONFIG_CMD_TFTPSRV */