tftp_server.h

Go to the documentation of this file.

 
#ifndef _TFTP_SERVER_H
#define _TFTP_SERVER_H
 
//Dependencies
#include "core/net.h"
#include "tftp/tftp_common.h"
 
//TFTP server support
#ifndef TFTP_SERVER_SUPPORT
   #define TFTP_SERVER_SUPPORT ENABLED
#elif (TFTP_SERVER_SUPPORT != ENABLED && TFTP_SERVER_SUPPORT != DISABLED)
   #error TFTP_SERVER_SUPPORT parameter is not valid
#endif
 
//Stack size required to run the TFTP server
#ifndef TFTP_SERVER_STACK_SIZE
   #define TFTP_SERVER_STACK_SIZE 650
#elif (TFTP_SERVER_STACK_SIZE < 1)
   #error TFTP_SERVER_STACK_SIZE parameter is not valid
#endif
 
//Priority at which the TFTP server should run
#ifndef TFTP_SERVER_PRIORITY
   #define TFTP_SERVER_PRIORITY OS_TASK_PRIORITY_NORMAL
#endif
 
//Maximum number of simultaneous connections
#ifndef TFTP_SERVER_MAX_CONNECTIONS
   #define TFTP_SERVER_MAX_CONNECTIONS 2
#elif (TFTP_SERVER_MAX_CONNECTIONS < 1)
   #error TFTP_SERVER_MAX_CONNECTIONS parameter is not valid
#endif
 
//TFTP server tick interval
#ifndef TFTP_SERVER_TICK_INTERVAL
   #define TFTP_SERVER_TICK_INTERVAL 500
#elif (TFTP_SERVER_TICK_INTERVAL < 100)
   #error TFTP_SERVER_TICK_INTERVAL parameter is not valid
#endif
 
//Maximum number of retransmissions of packets
#ifndef TFTP_SERVER_MAX_RETRIES
   #define TFTP_SERVER_MAX_RETRIES 5
#elif (TFTP_SERVER_MAX_RETRIES < 1)
   #error TFTP_SERVER_MAX_RETRIES parameter is not valid
#endif
 
//Retransmission timeout
#ifndef TFTP_SERVER_TIMEOUT
   #define TFTP_SERVER_TIMEOUT 5000
#elif (TFTP_SERVER_TIMEOUT < 1000)
   #error TFTP_SERVER_TIMEOUT parameter is not valid
#endif
 
//Additional delay before closing the connection (when sending the final ACK)
#ifndef TFTP_SERVER_FINAL_DELAY
   #define TFTP_SERVER_FINAL_DELAY 10000
#elif (TFTP_SERVER_FINAL_DELAY < 1000)
   #error TFTP_SERVER_FINAL_DELAY parameter is not valid
#endif
 
//Block size
#ifndef TFTP_SERVER_BLOCK_SIZE
   #define TFTP_SERVER_BLOCK_SIZE 512
#elif (TFTP_SERVER_BLOCK_SIZE < 512)
   #error TFTP_SERVER_BLOCK_SIZE parameter is not valid
#endif
 
//Application specific context
#ifndef TFTP_SERVER_PRIVATE_CONTEXT
   #define TFTP_SERVER_PRIVATE_CONTEXT
#endif
 
//Maximum size of TFTP packets
#define TFTP_SERVER_MAX_PACKET_SIZE (sizeof(TftpDataPacket) + TFTP_SERVER_BLOCK_SIZE)
 
//Forward declaration of TftpClientConnection structure
struct _TftpClientConnection;
#define TftpClientConnection struct _TftpClientConnection
 
//Forward declaration of TftpServerContext structure
struct _TftpServerContext;
#define TftpServerContext struct _TftpServerContext
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef enum
{
   TFTP_STATE_CLOSED         = 0,
   TFTP_STATE_OPEN           = 1,
   TFTP_STATE_READING        = 2,
   TFTP_STATE_WRITING        = 3,
   TFTP_STATE_READ_COMPLETE  = 4,
   TFTP_STATE_WRITE_COMPLETE = 5
} TftpConnectionState;
 
 
typedef void *(*TftpServerOpenFileCallback)(const char_t *filename,
   const char_t *mode, bool_t writeAccess);
 
 
typedef error_t (*TftpServerWriteFileCallback)(void *file,
   size_t offset, const uint8_t *data, size_t length);
 
 
typedef error_t (*TftpServerReadFileCallback)(void *file,
   size_t offset, uint8_t *data, size_t size, size_t *length);
 
 
typedef void (*TftpServerCloseFileCallback)(void *file);
 
 
typedef struct
{
   NetInterface *interface;                       
   uint16_t port;                                 
   TftpServerOpenFileCallback openFileCallback;   
   TftpServerWriteFileCallback writeFileCallback; 
   TftpServerReadFileCallback readFileCallback;   
   TftpServerCloseFileCallback closeFileCallback; 
} TftpServerSettings;
 
 
struct _TftpClientConnection
{
   TftpServerSettings *settings;                
   TftpConnectionState state;                   
   Socket *socket;                              
   void *file;                                  
   uint16_t block;                              
   systime_t timestamp;                         
   uint_t retransmitCount;                      
   uint8_t packet[TFTP_SERVER_MAX_PACKET_SIZE]; 
   size_t packetLen;                            
};
 
 
struct _TftpServerContext
{
   TftpServerSettings settings;                                  
   bool_t running;                                               
   bool_t stop;                                                  
   OsEvent event;                                                
   OsTaskId taskId;                                              
#if (OS_STATIC_TASK_SUPPORT == ENABLED)
   OsTaskTcb taskTcb;                                            
   OsStackType taskStack[TFTP_SERVER_STACK_SIZE];                
#endif
   Socket *socket;                                               
   TftpClientConnection connection[TFTP_SERVER_MAX_CONNECTIONS]; 
   SocketEventDesc eventDesc[TFTP_SERVER_MAX_CONNECTIONS + 1];   
   uint8_t packet[TFTP_SERVER_MAX_PACKET_SIZE];                  
   TFTP_SERVER_PRIVATE_CONTEXT                                   
};
 
 
//TFTP server related functions
void tftpServerGetDefaultSettings(TftpServerSettings *settings);
 
error_t tftpServerInit(TftpServerContext *context,
   const TftpServerSettings *settings);
 
error_t tftpServerStart(TftpServerContext *context);
error_t tftpServerStop(TftpServerContext *context);
 
void tftpServerTask(TftpServerContext *context);
 
void tftpServerDeinit(TftpServerContext *context);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif