Skip to content

Commit 825801b

Browse files
committed
doc/configuration: add more info on TFTP server requirements
While trying to make TFTPProviderDriver work with tftpd-hpa on Debian Bookworm, I hit various different issues and ultimately couldn't really make things work properly. The closest I got was by removing --secure from the server's option but I would then need U-Boot to provide the full path to the files and not relative to the TFTP server's root directory, which makes things not go nicely in general and especially not with labgrid (it uses external property as prefix for the path, and not internal). I installed atftpd instead and things worked out nicely out-of-the-box on Debian Bookworm, so let's mention that in the docs along with the requirements for the labgrid setup to work with the TFTPProvider Signed-off-by: Quentin Schulz <[email protected]>
1 parent 4398da7 commit 825801b

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

doc/configuration.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1366,6 +1366,17 @@ see below.
13661366
For now, the TFTP/NFS/HTTP server needs to be configured before using it from
13671367
labgrid.
13681368

1369+
Because labgrid uses absolute paths as targets for symlinks for exposing files
1370+
on the TFTP server and because the target of those symlinks is in
1371+
``/var/cache/labgrid/``, the TFTP server needs to follow symlinks whose target
1372+
path is both absolute and in ``/var/cache/labgrid``. Note that depending on the
1373+
configuration of the TFTP server, ``/var/cache/labgrid`` may not be the root
1374+
directory of your TFTP server.
1375+
1376+
`atftpd <https://sourceforge.net/projects/atftp/>`_ is known to work whereas
1377+
`tftpd-hpa <https://git.kernel.org/pub/scm/network/tftp/tftp-hpa.git/>`_ doesn't
1378+
seem to be working well with such symlinks.
1379+
13691380
TFTPProvider
13701381
++++++++++++
13711382
A :any:`TFTPProvider` resource describes a TFTP server.

0 commit comments

Comments
 (0)