TFTP Client API#

TFTPc_Get()#

Description#

Gets a file from the TFTP server.

Files#

tftp_client.h/tftp_client.c

Prototype#

void  TFTPc_Get (       CPU_CHAR      *p_host_server,
                 const  TFTPc_CFG     *p_cfg,

                        CPU_CHAR      *p_filename_local,
                        CPU_CHAR      *p_filename_remote,
                        TFTPc_MODE     mode,
                        RTOS_ERR      *p_err)

Arguments#

p_host_server

Server host name.

p_cfg

  • Pointer to TFTP client configuration to use.

  • DEF_NULL, if the default configuration must be used.

p_filename_local

Pointer to name of the file to be written by the client.

p_filename_remote

Pointer to name of the file to be read from the server.

mode

TFTP transfer mode :

  • TFTPc_MODE_NETASCII ASCII mode.

  • TFTPc_MODE_OCTET Binary mode.

p_err

Pointer to the variable that will receive one of the following error code(s) from this function:

  • RTOS_ERR_NONE

  • RTOS_ERR_TX

  • RTOS_ERR_WOULD_BLOCK

  • RTOS_ERR_TIMEOUT

Returned Value#

None.

Notes / Warnings#

None.

TFTPc_Put()#

Description#

Puts a file on the TFTP server.

Files#

tftp_client.h/tftp_client.c

Prototype#

void  TFTPc_Put (       CPU_CHAR     *p_host_server,
                 const  TFTPc_CFG    *p_cfg,
                        CPU_CHAR     *p_filename_local,
                        CPU_CHAR     *p_filename_remote,
                        TFTPc_MODE    mode,
                        RTOS_ERR     *p_err)

Arguments#

p_host_server

Server host name.

p_cfg

Pointer to TFTP client configuration to use. DEF_NULL, if the default configuration must be used.

p_filename_local

Pointer to name of the file to be read by the client.

p_filename_remote

Pointer to name of the file to be written to the server.

mode

TFTP transfer mode :

  • TFTPc_MODE_NETASCII ASCII mode.

  • TFTPc_MODE_OCTET Binary mode.

p_err

Pointer to the variable that will receive one of the following error code(s) from this function:

  • RTOS_ERR_NONE

  • RTOS_ERR_TX

  • RTOS_ERR_WOULD_BLOCK

  • RTOS_ERR_TIMEOUT

Returned Value#

None.

Notes / Warnings#

None.