2 * Copyright 1994, 1995, 2000 Neil Russell.
5 * Copyright 2011 Comelit Group SpA,
11 #include <efi_loader.h>
18 #ifdef CONFIG_SYS_DIRECT_FLASH_TFTP
22 DECLARE_GLOBAL_DATA_PTR;
24 /* Well known TFTP port # */
25 #define WELL_KNOWN_PORT 69
26 /* Millisecs to timeout for lost pkt */
27 #define TIMEOUT 5000UL
28 #ifndef CONFIG_NET_RETRY_COUNT
29 /* # of timeouts before giving up */
30 # define TIMEOUT_COUNT 10
32 # define TIMEOUT_COUNT (CONFIG_NET_RETRY_COUNT * 2)
34 /* Number of "loading" hashes per line (for checking the image size) */
35 #define HASHES_PER_LINE 65
47 static ulong timeout_ms = TIMEOUT;
48 static int timeout_count_max = TIMEOUT_COUNT;
49 static ulong time_start; /* Record time we started tftp */
52 * These globals govern the timeout behavior when attempting a connection to a
53 * TFTP server. tftp_timeout_ms specifies the number of milliseconds to
54 * wait for the server to respond to initial connection. Second global,
55 * tftp_timeout_count_max, gives the number of such connection retries.
56 * tftp_timeout_count_max must be non-negative and tftp_timeout_ms must be
57 * positive. The globals are meant to be set (and restored) by code needing
58 * non-standard timeout behavior when initiating a TFTP transfer.
60 ulong tftp_timeout_ms = TIMEOUT;
61 int tftp_timeout_count_max = TIMEOUT_COUNT;
64 TFTP_ERR_UNDEFINED = 0,
65 TFTP_ERR_FILE_NOT_FOUND = 1,
66 TFTP_ERR_ACCESS_DENIED = 2,
67 TFTP_ERR_DISK_FULL = 3,
68 TFTP_ERR_UNEXPECTED_OPCODE = 4,
69 TFTP_ERR_UNKNOWN_TRANSFER_ID = 5,
70 TFTP_ERR_FILE_ALREADY_EXISTS = 6,
73 static struct in_addr tftp_remote_ip;
74 /* The UDP port at their end */
75 static int tftp_remote_port;
76 /* The UDP port at our end */
77 static int tftp_our_port;
78 static int timeout_count;
79 /* packet sequence number */
80 static ulong tftp_cur_block;
81 /* last packet sequence number received */
82 static ulong tftp_prev_block;
83 /* count of sequence number wraparounds */
84 static ulong tftp_block_wrap;
85 /* memory offset due to wrapping */
86 static ulong tftp_block_wrap_offset;
87 static int tftp_state;
88 static ulong tftp_load_addr;
90 static ulong tftp_load_size;
92 #ifdef CONFIG_TFTP_TSIZE
93 /* The file size reported by the server */
94 static int tftp_tsize;
95 /* The number of hashes we printed */
96 static short tftp_tsize_num_hash;
98 #ifdef CONFIG_CMD_TFTPPUT
99 /* 1 if writing, else 0 */
100 static int tftp_put_active;
101 /* 1 if we have sent the last block */
102 static int tftp_put_final_block_sent;
104 #define tftp_put_active 0
107 #define STATE_SEND_RRQ 1
109 #define STATE_TOO_LARGE 3
110 #define STATE_BAD_MAGIC 4
112 #define STATE_RECV_WRQ 6
113 #define STATE_SEND_WRQ 7
115 /* default TFTP block size */
116 #define TFTP_BLOCK_SIZE 512
117 /* sequence number is 16 bit */
118 #define TFTP_SEQUENCE_SIZE ((ulong)(1<<16))
120 #define DEFAULT_NAME_LEN (8 + 4 + 1)
121 static char default_filename[DEFAULT_NAME_LEN];
123 #ifndef CONFIG_TFTP_FILE_NAME_MAX_LEN
126 #define MAX_LEN CONFIG_TFTP_FILE_NAME_MAX_LEN
129 static char tftp_filename[MAX_LEN];
131 /* 512 is poor choice for ethernet, MTU is typically 1500.
132 * Minus eth.hdrs thats 1468. Can get 2x better throughput with
133 * almost-MTU block sizes. At least try... fall back to 512 if need be.
134 * (but those using CONFIG_IP_DEFRAG may want to set a larger block in cfg file)
136 #ifdef CONFIG_TFTP_BLOCKSIZE
137 #define TFTP_MTU_BLOCKSIZE CONFIG_TFTP_BLOCKSIZE
139 #define TFTP_MTU_BLOCKSIZE 1468
142 static unsigned short tftp_block_size = TFTP_BLOCK_SIZE;
143 static unsigned short tftp_block_size_option = TFTP_MTU_BLOCKSIZE;
145 static inline int store_block(int block, uchar *src, unsigned int len)
147 ulong offset = block * tftp_block_size + tftp_block_wrap_offset;
148 ulong newsize = offset + len;
149 ulong store_addr = tftp_load_addr + offset;
150 #ifdef CONFIG_SYS_DIRECT_FLASH_TFTP
153 for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; i++) {
154 /* start address in flash? */
155 if (flash_info[i].flash_id == FLASH_UNKNOWN)
157 if (store_addr >= flash_info[i].start[0]) {
163 if (rc) { /* Flash is destination for this packet */
164 rc = flash_write((char *)src, store_addr, len);
170 #endif /* CONFIG_SYS_DIRECT_FLASH_TFTP */
175 ulong end_addr = tftp_load_addr + tftp_load_size;
178 end_addr = ULONG_MAX;
180 if (store_addr < tftp_load_addr ||
181 store_addr + len > end_addr) {
182 puts("\nTFTP error: ");
183 puts("trying to overwrite reserved memory...\n");
187 ptr = map_sysmem(store_addr, len);
188 memcpy(ptr, src, len);
192 if (net_boot_file_size < newsize)
193 net_boot_file_size = newsize;
198 /* Clear our state ready for a new transfer */
199 static void new_transfer(void)
203 tftp_block_wrap_offset = 0;
204 #ifdef CONFIG_CMD_TFTPPUT
205 tftp_put_final_block_sent = 0;
209 #ifdef CONFIG_CMD_TFTPPUT
211 * Load the next block from memory to be sent over tftp.
213 * @param block Block number to send
214 * @param dst Destination buffer for data
215 * @param len Number of bytes in block (this one and every other)
216 * @return number of bytes loaded
218 static int load_block(unsigned block, uchar *dst, unsigned len)
220 /* We may want to get the final block from the previous set */
221 ulong offset = ((int)block - 1) * len + tftp_block_wrap_offset;
224 tosend = min(net_boot_file_size - offset, tosend);
225 (void)memcpy(dst, (void *)(image_save_addr + offset), tosend);
226 debug("%s: block=%u, offset=%lu, len=%u, tosend=%lu\n", __func__,
227 block, offset, len, tosend);
232 static void tftp_send(void);
233 static void tftp_timeout_handler(void);
235 /**********************************************************************/
237 static void show_block_marker(void)
239 #ifdef CONFIG_TFTP_TSIZE
241 ulong pos = tftp_cur_block * tftp_block_size +
242 tftp_block_wrap_offset;
243 if (pos > tftp_tsize)
246 while (tftp_tsize_num_hash < pos * 50 / tftp_tsize) {
248 tftp_tsize_num_hash++;
253 if (((tftp_cur_block - 1) % 10) == 0)
255 else if ((tftp_cur_block % (10 * HASHES_PER_LINE)) == 0)
261 * restart the current transfer due to an error
263 * @param msg Message to print for user
265 static void restart(const char *msg)
267 printf("\n%s; starting again\n", msg);
272 * Check if the block number has wrapped, and update progress
274 * TODO: The egregious use of global variables in this file should be tidied.
276 static void update_block_number(void)
279 * RFC1350 specifies that the first data packet will
280 * have sequence number 1. If we receive a sequence
281 * number of 0 this means that there was a wrap
282 * around of the (16 bit) counter.
284 if (tftp_cur_block == 0 && tftp_prev_block != 0) {
286 tftp_block_wrap_offset += tftp_block_size * TFTP_SEQUENCE_SIZE;
287 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 update_block_number();
526 if (tftp_state == STATE_SEND_RRQ)
527 debug("Server did not acknowledge timeout option!\n");
529 if (tftp_state == STATE_SEND_RRQ || tftp_state == STATE_OACK ||
530 tftp_state == STATE_RECV_WRQ) {
531 /* first block received */
532 tftp_state = STATE_DATA;
533 tftp_remote_port = src;
536 if (tftp_cur_block != 1) { /* Assertion */
537 puts("\nTFTP error: ");
538 printf("First block is not block 1 (%ld)\n",
540 puts("Starting again\n\n");
546 if (tftp_cur_block == tftp_prev_block) {
547 /* Same block again; ignore it. */
551 tftp_prev_block = tftp_cur_block;
552 timeout_count_max = tftp_timeout_count_max;
553 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
555 if (store_block(tftp_cur_block - 1, pkt + 2, len)) {
557 net_set_state(NETLOOP_FAIL);
562 * Acknowledge the block just received, which will prompt
563 * the remote for the next one.
567 if (len < tftp_block_size)
572 printf("\nTFTP error: '%s' (%d)\n",
573 pkt + 2, ntohs(*(__be16 *)pkt));
575 switch (ntohs(*(__be16 *)pkt)) {
576 case TFTP_ERR_FILE_NOT_FOUND:
577 case TFTP_ERR_ACCESS_DENIED:
578 puts("Not retrying...\n");
580 net_set_state(NETLOOP_FAIL);
582 case TFTP_ERR_UNDEFINED:
583 case TFTP_ERR_DISK_FULL:
584 case TFTP_ERR_UNEXPECTED_OPCODE:
585 case TFTP_ERR_UNKNOWN_TRANSFER_ID:
586 case TFTP_ERR_FILE_ALREADY_EXISTS:
588 puts("Starting again\n\n");
597 static void tftp_timeout_handler(void)
599 if (++timeout_count > timeout_count_max) {
600 restart("Retry count exceeded");
603 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
604 if (tftp_state != STATE_RECV_WRQ)
609 /* Initialize tftp_load_addr and tftp_load_size from image_load_addr and lmb */
610 static int tftp_init_load_addr(void)
614 phys_size_t max_size;
616 lmb_init_and_reserve(&lmb, gd->bd, (void *)gd->fdt_blob);
618 max_size = lmb_get_free_size(&lmb, image_load_addr);
622 tftp_load_size = max_size;
624 tftp_load_addr = image_load_addr;
628 void tftp_start(enum proto_t protocol)
630 #if CONFIG_NET_TFTP_VARS
631 char *ep; /* Environment pointer */
634 * Allow the user to choose TFTP blocksize and timeout.
635 * TFTP protocol has a minimal timeout of 1 second.
638 ep = env_get("tftpblocksize");
640 tftp_block_size_option = simple_strtol(ep, NULL, 10);
642 ep = env_get("tftptimeout");
644 timeout_ms = simple_strtol(ep, NULL, 10);
646 if (timeout_ms < 1000) {
647 printf("TFTP timeout (%ld ms) too low, set min = 1000 ms\n",
652 ep = env_get("tftptimeoutcountmax");
654 tftp_timeout_count_max = simple_strtol(ep, NULL, 10);
656 if (tftp_timeout_count_max < 0) {
657 printf("TFTP timeout count max (%d ms) negative, set to 0\n",
658 tftp_timeout_count_max);
659 tftp_timeout_count_max = 0;
663 debug("TFTP blocksize = %i, timeout = %ld ms\n",
664 tftp_block_size_option, timeout_ms);
666 tftp_remote_ip = net_server_ip;
667 if (!net_parse_bootfile(&tftp_remote_ip, tftp_filename, MAX_LEN)) {
668 sprintf(default_filename, "%02X%02X%02X%02X.img",
669 net_ip.s_addr & 0xFF,
670 (net_ip.s_addr >> 8) & 0xFF,
671 (net_ip.s_addr >> 16) & 0xFF,
672 (net_ip.s_addr >> 24) & 0xFF);
674 strncpy(tftp_filename, default_filename, DEFAULT_NAME_LEN);
675 tftp_filename[DEFAULT_NAME_LEN - 1] = 0;
677 printf("*** Warning: no boot file name; using '%s'\n",
681 printf("Using %s device\n", eth_get_name());
682 printf("TFTP %s server %pI4; our IP address is %pI4",
683 #ifdef CONFIG_CMD_TFTPPUT
684 protocol == TFTPPUT ? "to" : "from",
688 &tftp_remote_ip, &net_ip);
690 /* Check if we need to send across this subnet */
691 if (net_gateway.s_addr && net_netmask.s_addr) {
692 struct in_addr our_net;
693 struct in_addr remote_net;
695 our_net.s_addr = net_ip.s_addr & net_netmask.s_addr;
696 remote_net.s_addr = tftp_remote_ip.s_addr & net_netmask.s_addr;
697 if (our_net.s_addr != remote_net.s_addr)
698 printf("; sending through gateway %pI4", &net_gateway);
702 printf("Filename '%s'.", tftp_filename);
704 if (net_boot_file_expected_size_in_blocks) {
705 printf(" Size is 0x%x Bytes = ",
706 net_boot_file_expected_size_in_blocks << 9);
707 print_size(net_boot_file_expected_size_in_blocks << 9, "");
711 #ifdef CONFIG_CMD_TFTPPUT
712 tftp_put_active = (protocol == TFTPPUT);
713 if (tftp_put_active) {
714 printf("Save address: 0x%lx\n", image_save_addr);
715 printf("Save size: 0x%lx\n", image_save_size);
716 net_boot_file_size = image_save_size;
718 tftp_state = STATE_SEND_WRQ;
723 if (tftp_init_load_addr()) {
725 net_set_state(NETLOOP_FAIL);
726 puts("\nTFTP error: ");
727 puts("trying to overwrite reserved memory...\n");
730 printf("Load address: 0x%lx\n", tftp_load_addr);
731 puts("Loading: *\b");
732 tftp_state = STATE_SEND_RRQ;
733 #ifdef CONFIG_CMD_BOOTEFI
734 efi_set_bootdev("Net", "", tftp_filename);
738 time_start = get_timer(0);
739 timeout_count_max = tftp_timeout_count_max;
741 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
742 net_set_udp_handler(tftp_handler);
743 #ifdef CONFIG_CMD_TFTPPUT
744 net_set_icmp_handler(icmp_handler);
746 tftp_remote_port = WELL_KNOWN_PORT;
748 /* Use a pseudo-random port unless a specific port is set */
749 tftp_our_port = 1024 + (get_timer(0) % 3072);
751 #ifdef CONFIG_TFTP_PORT
752 ep = env_get("tftpdstp");
754 tftp_remote_port = simple_strtol(ep, NULL, 10);
755 ep = env_get("tftpsrcp");
757 tftp_our_port = simple_strtol(ep, NULL, 10);
761 /* zero out server ether in case the server ip has changed */
762 memset(net_server_ethaddr, 0, 6);
763 /* Revert tftp_block_size to dflt */
764 tftp_block_size = TFTP_BLOCK_SIZE;
765 #ifdef CONFIG_TFTP_TSIZE
767 tftp_tsize_num_hash = 0;
773 #ifdef CONFIG_CMD_TFTPSRV
774 void tftp_start_server(void)
776 tftp_filename[0] = 0;
778 if (tftp_init_load_addr()) {
780 net_set_state(NETLOOP_FAIL);
781 puts("\nTFTP error: trying to overwrite reserved memory...\n");
784 printf("Using %s device\n", eth_get_name());
785 printf("Listening for TFTP transfer on %pI4\n", &net_ip);
786 printf("Load address: 0x%lx\n", tftp_load_addr);
788 puts("Loading: *\b");
790 timeout_count_max = tftp_timeout_count_max;
792 timeout_ms = TIMEOUT;
793 net_set_timeout_handler(timeout_ms, tftp_timeout_handler);
795 /* Revert tftp_block_size to dflt */
796 tftp_block_size = TFTP_BLOCK_SIZE;
798 tftp_our_port = WELL_KNOWN_PORT;
800 #ifdef CONFIG_TFTP_TSIZE
802 tftp_tsize_num_hash = 0;
805 tftp_state = STATE_RECV_WRQ;
806 net_set_udp_handler(tftp_handler);
808 /* zero out server ether in case the server ip has changed */
809 memset(net_server_ethaddr, 0, 6);
811 #endif /* CONFIG_CMD_TFTPSRV */