tftp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 InnBlue
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_TFTP_H_
#define ZEPHYR_INCLUDE_NET_TFTP_H_
 
#include <zephyr/kernel.h>
#include <zephyr/net/socket.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define TFTP_BLOCK_SIZE          512
 
#define TFTP_HEADER_SIZE         4
 
/* Maximum amount of data that can be sent or received */
#define TFTPC_MAX_BUF_SIZE       (TFTP_BLOCK_SIZE + TFTP_HEADER_SIZE)
 
/* TFTP Client Error codes. */
#define TFTPC_SUCCESS             0
#define TFTPC_DUPLICATE_DATA     -1
#define TFTPC_BUFFER_OVERFLOW    -2
#define TFTPC_UNKNOWN_FAILURE    -3
#define TFTPC_REMOTE_ERROR       -4
#define TFTPC_RETRIES_EXHAUSTED  -5
 
enum tftp_evt_type {
        TFTP_EVT_DATA,
 
        TFTP_EVT_ERROR
};
 
struct tftp_data_param {
        uint8_t *data_ptr;         
        uint32_t len;              
};
 
struct tftp_error_param {
        char *msg;                 
        int code;                  
};
 
union tftp_evt_param {
        struct tftp_data_param data;
 
        struct tftp_error_param error;
};
 
struct tftp_evt {
        enum tftp_evt_type type;
 
        union tftp_evt_param param;
};
 
typedef void (*tftp_callback_t)(const struct tftp_evt *evt);
 
struct tftpc {
        struct sockaddr server;
 
        tftp_callback_t callback;
 
        uint8_t tftp_buf[TFTPC_MAX_BUF_SIZE];
};
 
/* @brief This function gets data from a "file" on the remote server.
 *
 * @param client      Client information of type @ref tftpc.
 * @param remote_file Name of the remote file to get.
 * @param mode        TFTP Client "mode" setting.
 *
 * @return The size of data being received if the operation completed successfully.
 *         TFTPC_BUFFER_OVERFLOW if the file is larger than the user buffer.
 *         TFTPC_REMOTE_ERROR if the server failed to process our request.
 *         TFTPC_RETRIES_EXHAUSTED if the client timed out waiting for server.
 *         -EINVAL if `client` is NULL.
 *
 * @note This function blocks until the transfer is completed or network error happens. The
 *       integrity of the `client` structure must be ensured until the function returns.
 */
int tftp_get(struct tftpc *client,
             const char *remote_file, const char *mode);
 
/* @brief This function puts data to a "file" on the remote server.
 *
 * @param client      Client information of type @ref tftpc.
 * @param remote_file Name of the remote file to put.
 * @param mode        TFTP Client "mode" setting.
 * @param user_buf    Data buffer containing the data to put.
 * @param user_buf_size Length of the data to put.
 *
 * @return The size of data being sent if the operation completed successfully.
 *         TFTPC_REMOTE_ERROR if the server failed to process our request.
 *         TFTPC_RETRIES_EXHAUSTED if the client timed out waiting for server.
 *         -EINVAL if `client` or `user_buf` is NULL or if `user_buf_size` is zero.
 *
 * @note This function blocks until the transfer is completed or network error happens. The
 *       integrity of the `client` structure must be ensured until the function returns.
 */
int tftp_put(struct tftpc *client,
             const char *remote_file, const char *mode,
             const uint8_t *user_buf, uint32_t user_buf_size);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_TFTP_H_ */