Add initial doc
This commit is contained in:
2023-11-09 16:48:00 +01:00
parent 989b8b620c
commit b2345b66a0

21
docs/tftp.md Normal file
View File

@@ -0,0 +1,21 @@
# TFTP
This is the documentation of the TFTP task
## Initialization
The TFTP task is initialized in the main function.
```c
// Initialize TFTP task
tftp_init();
```
## Usage
The TFTP task is used to receive and send files via TFTP.
### Receive a file
index.txt contains a list of files on the file system.
```bash
tftp -g -r <filename> <ip>
```
### Send a file
You can only write to the following files:
- virtImage.raw
```bash
tftp -p -l <filename> <ip>
```