u-boot/doc/usage/cmd/tftpput.rst
Tom Rini a5fc388ed9 Pull request for efi-2022-10-rc5
Documentation:
 
 * man-page for tftpput
 
 UEFI:
 
 * fix driver binding protocol for block IO devices
 * don't delete invalid handles
 * add a unit test for the EFI Conformance Profile Table
 
 Other:
 
 * correct short text for tftpboot
 -----BEGIN PGP SIGNATURE-----
 
 iQIzBAABCAAdFiEEbcT5xx8ppvoGt20zxIHbvCwFGsQFAmMbeUEACgkQxIHbvCwF
 GsSGsw//WJAuuzP5ufWGxJk2pR9v9LatIsV+w2W1fBTsTb/dbMZ4Sika2Z1izeer
 vmakldnOTLoTXZxng/Ke9J7PEefS8NSUgHbXYLq6a5ckrsji58kGHhDvUjrU2eOf
 D4SBh8eGW/wgmnzHgmsVU0vcXbtWUomWlV4v8SGjYWq5KOTOdFGYmMddqv8cnUVa
 wXHktLaDi9TzzFdfeYPbAlKboQTdRkw0CbzY8z6jlxm2Yd/i7Iw9v7MWwFN5rv1N
 Zlx9Kl0SV1Jz//yzUajyiXXVYK+kVcpjDcvOPhx4GL96mcvW4yyGlOKjpUkTR3H3
 l7112u4lwNSUIJIeDMCazqKgdGMsl+RLuJymAIRCdaBs3c0FsuX4WHNAr0H1KT9X
 oVnzeBKZKjFTT76Q39F80O0JrdDMxqMm1fGiy1ySlRCJNd+dlYZKoopt8PpWkk1E
 IBHsE1m1OXe+n2PNrh6YR9egv9RmfdwBEl0wBftNb9DQ+gNAvR7wVRpmDRCqYuBR
 l/k6GsznHK4hh1Wh+BhrrUeQ3YbboK3RvGA9toYp6BEk/5F2dDuy5pVM7OETjGEY
 DaKjqPjMv41SCIzpcEkzPJEvQ0tEFuk+GEC168IXQmcV/gttvuLNLFfnlLE1amQr
 g09ePeaXKzjiWYSi5wEz1GQs7W9WBnJ5+2zOL41ih125xra6/NE=
 =1zZW
 -----END PGP SIGNATURE-----

Merge tag 'efi-2022-10-rc5' of https://source.denx.de/u-boot/custodians/u-boot-efi

Pull request for efi-2022-10-rc5

Documentation:

* man-page for tftpput

UEFI:

* fix driver binding protocol for block IO devices
* don't delete invalid handles
* add a unit test for the EFI Conformance Profile Table

Other:

* correct short text for tftpboot
2022-09-09 15:07:05 -04:00

87 lines
2.3 KiB
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0+:
tftpput command
===============
Synopsis
--------
::
tftpput address size [[hostIPaddr:]filename]
Description
-----------
The tftpput command is used to transfer a file to a TFTP server.
By default the destination port is 69 and the source port is pseudo-random.
If CONFIG_TFTP_PORT=y, the environment variable *tftpsrcp* can be used to set
the source port and the environment variable *tftpdstp* can be used to set
the destination port.
address
memory address where the data starts
size
number of bytes to be transferred
hostIPaddr
IP address of the TFTP server, defaults to the value of environment
variable *serverip*
filename
path of the file to be written. If not provided, the client's IP address is
used to construct a default file name, e.g. C0.A8.00.28.img for IP address
192.168.0.40.
Example
-------
In the example the following steps are executed:
* setup client network address
* load a file from the SD-card
* send the file via TFTP to a server
::
=> setenv autoload no
=> dhcp
BOOTP broadcast 1
DHCP client bound to address 192.168.1.40 (7 ms)
=> load mmc 0:1 $loadaddr test.txt
260096 bytes read in 13 ms (19.1 MiB/s)
=> tftpput $loadaddr $filesize 192.168.1.3:upload/test.txt
Using ethernet@1c30000 device
TFTP to server 192.168.1.3; our IP address is 192.168.1.40
Filename 'upload/test.txt'.
Save address: 0x42000000
Save size: 0x3f800
Saving: #################
4.4 MiB/s
done
Bytes transferred = 260096 (3f800 hex)
=>
Configuration
-------------
The command is only available if CONFIG_CMD_TFTPPUT=y.
CONFIG_TFTP_BLOCKSIZE defines the size of the TFTP blocks sent. It defaults
to 1468 matching an ethernet MTU of 1500.
If CONFIG_TFTP_PORT=y, the environment variables *tftpsrcp* and *tftpdstp* can
be used to set the source and the destination ports.
CONFIG_TFTP_WINDOWSIZE can be used to set the TFTP window size of transmits
after which an ACK response is required. The window size defaults to 1.
If CONFIG_TFTP_TSIZE=y, the progress bar is limited to 50 '#' characters.
Otherwise an '#' is written per UDP package which may decrease performance.
Return value
------------
The return value $? is 0 (true) on success and 1 (false) otherwise.