net/tftpc.h File Reference

#include "net\stacktsk.h"
#include "net\udp.h"

Defines
#define	TFTP_ARP_TIMEOUT_VAL   ((TICK16)3 * (TICK16)TICKS_PER_SECOND)
#define	TFTP_GET_TIMEOUT_VAL   ((TICK16)3 * (TICK16)TICKS_PER_SECOND)
#define	TFTP_MAX_RETRIES   (3ul)
#define	TFTPClose(void)   UDPClose(_tftpSocket)
#define	TFTPGetError()   (_tftpError)
#define	TFTPIsFileOpenReady()   UDPIsPutReady(_tftpSocket)
Typedefs
typedef enum _TFTP_ACCESS_ERROR	TFTP_ACCESS_ERROR
typedef enum _TFTP_FILE_MODE	TFTP_FILE_MODE
typedef enum _TFTP_RESULT	TFTP_RESULT
Enumerations
enum	_TFTP_ACCESS_ERROR {   TFTP_ERROR_NOT_DEFINED = 0, TFTP_ERROR_FILE_NOT_FOUND, TFTP_ERROR_ACCESS_VIOLATION, TFTP_ERROR_DISK_FULL,   TFTP_ERROR_INVALID_OPERATION, TFTP_ERROR_UNKNOWN_TID, TFTP_ERROR_FILE_EXISTS, TFTP_ERROR_NO_SUCH_USE }
enum	_TFTP_FILE_MODE { TFTP_FILE_MODE_READ = 1, TFTP_FILE_MODE_WRITE = 2 }
enum	_TFTP_RESULT {   TFTP_OK = 0, TFTP_NOT_READY, TFTP_END_OF_FILE, TFTP_ERROR,   TFTP_RETRY, TFTP_TIMEOUT }
Functions
void	TFTPCloseFile (void)
BYTE	TFTPGet (void)
TFTP_RESULT	TFTPIsFileClosed (void)
TFTP_RESULT	TFTPIsFileOpened (void)
TFTP_RESULT	TFTPIsGetReady (void)
TFTP_RESULT	TFTPIsOpened (void)
TFTP_RESULT	TFTPIsPutReady (void)
void	TFTPOpen (IP_ADDR *host)
void	TFTPOpenFile (char *fileName, TFTP_FILE_MODE mode)
void	TFTPPut (BYTE c)
Variables
WORD	_tftpError
UDP_SOCKET	_tftpSocket

---

Define Documentation

#define TFTP_ARP_TIMEOUT_VAL   ((TICK16)3 * (TICK16)TICKS_PER_SECOND)

#define TFTP_GET_TIMEOUT_VAL   ((TICK16)3 * (TICK16)TICKS_PER_SECOND)

#define TFTP_MAX_RETRIES   (3ul)

#define TFTPClose

(

void

)

UDPClose(_tftpSocket)

 

#define TFTPGetError

(

)

(_tftpError)

 

#define TFTPIsFileOpenReady

(

)

UDPIsPutReady(_tftpSocket)

---

Typedef Documentation

typedef enum _TFTP_ACCESS_ERROR TFTP_ACCESS_ERROR

typedef enum _TFTP_FILE_MODE TFTP_FILE_MODE

typedef enum _TFTP_RESULT TFTP_RESULT

---

Enumeration Type Documentation

enum _TFTP_ACCESS_ERROR

Enumerator:

TFTP_ERROR_NOT_DEFINED
TFTP_ERROR_FILE_NOT_FOUND
TFTP_ERROR_ACCESS_VIOLATION
TFTP_ERROR_DISK_FULL
TFTP_ERROR_INVALID_OPERATION
TFTP_ERROR_UNKNOWN_TID
TFTP_ERROR_FILE_EXISTS
TFTP_ERROR_NO_SUCH_USE

enum _TFTP_FILE_MODE

Enumerator:

TFTP_FILE_MODE_READ
TFTP_FILE_MODE_WRITE

enum _TFTP_RESULT

Enumerator:

TFTP_OK
TFTP_NOT_READY
TFTP_END_OF_FILE
TFTP_ERROR
TFTP_RETRY
TFTP_TIMEOUT

---

Function Documentation

void TFTPCloseFile

(

void

)

BYTE TFTPGet

(

void

)

TFTP_RESULT TFTPIsFileClosed

(

void

)

TFTP_RESULT TFTPIsFileOpened

(

void

)

TFTP_RESULT TFTPIsGetReady

(

void

)

TFTP_RESULT TFTPIsOpened

(

void

)

TFTP_RESULT TFTPIsPutReady

(

void

)

void TFTPOpen

(

IP_ADDR *

host

)

void TFTPOpenFile	(	char *	fileName,
		TFTP_FILE_MODE	mode
	)

void TFTPPut

(

BYTE

c

)

---

Variable Documentation

WORD _tftpError

UDP_SOCKET _tftpSocket