xref: /kernel/liteos_a/apps/tftp/include/tftpc.h

/*
 * Copyright (c) 2013-2019 Huawei Technologies Co., Ltd. All rights reserved.
 * Copyright (c) 2020-2021 Huawei Device Co., Ltd. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 *    conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
 *    of conditions and the following disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
 *    to endorse or promote products derived from this software without specific prior written
 *    permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef TFTPC_H
#define TFTPC_H

#include "types_adapt.h"

#if LWIP_TFTP /* don't build if not configured for use in lwipopts.h */

#if defined (__cplusplus) && __cplusplus
extern "C" {
#endif

#define TFTP_NULL_UINT32        ((u32_t)0xffffffffUL)

#define TFTP_NULL_INT32         (-1)

/** @cond liteos
* @defgroup TFTP_Interfaces
* @ingroup Enums
* * This section contains the TFTP enums.
*/
/**
*
* This Enum is used to specify the transfer mode of the file to be handled by TFTP client.
*/
typedef enum tagTFTPC_TransferMode {
    TRANSFER_MODE_ASCII = 0,  /**< Indicates that the mode of transfer is ASCII. */
    TRANSFER_MODE_BINARY,     /**< Indicates that the mode of transfer is Binary */
    TRANSFER_MODE_BUTT        /**< Indicates invalid transfer mode.*/
} TFTPC_TRANSFER_MODE_E;

/**
* This Enum is used to specify the transfer mode to be handled by TFTP client
* This Enum indicates the TFTP client transfer mode of the file

*/
typedef enum tagTFTPC_ErrCode {
    TFTPC_SOCKET_FAILURE = 1, /**< Error while creating UDP socket. */
    TFTPC_BIND_FAILURE = 2, /**< Error while binding to the UDP socket. */
    TFTPC_SELECT_ERROR = 3, /**< Error returned by select() system call. */
    TFTPC_RECVFROM_ERROR = 4, /**< Error while receiving data from the peer. */
    TFTPC_SENDTO_ERROR = 5, /**< Error while sending data to the peer. */
    TFTPC_FILE_NOT_FOUND = 6, /**< Requested file is not found. */

    /**< This is the error sent by the server when host name cannot be resolved. */
    TFTPC_CANNOT_RESOLVE_HOSTNAME = 7,
    TFTPC_INVALID_PARAVALUE = 8, /**< Input parameters passed to TFTP interfaces are invalid. */

    /**< Error detected in TFTP packet or the error received from the TFTP server. */
    TFTPC_PROTO_ERROR = 9,
    /**< Error during packet synchronization while sending or unexpected packet is received. */
    TFTPC_SYNC_FAILURE = 10,
    /**< File size limit crossed, Max block can be 0xFFFF, each block containing 512 bytes. */
    TFTPC_FILE_TOO_BIG = 11,
    TFTPC_SRC_FILENAME_LENGTH_ERROR = 12, /**< File name length greater than 256. */
    TFTPC_IP_NOT_WITHIN_RANGE = 13, /**< Host name IP is not valid. */
    TFTPC_ACCESS_ERROR = 14, /**< TFTP server returned file access error. */

    /**< TFTP server returned error signifying that the DISK is full to write. */
    TFTPC_DISK_FULL = 15,
    TFTPC_FILE_EXISTS = 16, /**< TFTP server returned error signifying that the file exists. */

    /**< tftp_put_file_by_filename returned error signifying that the source file name do not exist. */
    TFTPC_FILE_NOT_EXIST = 17,
    TFTPC_MEMALLOC_ERROR = 18, /**< Memory allocation failed in TFTP client. */
    TFTPC_FILEOPEN_ERROR = 19, /**< File open failed. */
    TFTPC_FILEREAD_ERROR = 20, /**< File read error. */
    TFTPC_FILECREATE_ERROR = 21, /**< File create error. */
    TFTPC_FILEWRITE_ERROR = 22, /**< File write error. */
    TFTPC_TIMEOUT_ERROR = 23, /**< Max time expired while waiting for file to be received. */

    /**< Error when the received packet is less than 4 bytes (error length) or greater than 512 bytes. */
    TFTPC_PKT_SIZE_ERROR = 24,
    TFTPC_ERROR_NOT_DEFINED = 25, /**< Returned by TFTP server for protocol user error. */
    TFTPC_DEST_PATH_LENGTH_ERROR = 26, /**< If the destination file path length is greater than 256. */
    TFTPC_UNKNOWN_TRANSFER_ID = 27, /**< Returned by TFTP server for undefined transfer ID. */

    /**<  IOCTL function failed at TFTP client while setting the socket to non-block. */
    TFTPC_IOCTLSOCKET_FAILURE = 28,
    TFTPC_MEMCPY_FAILURE = 29 /**< TFTP memcpy failure. */
} TFTPC_ERR_CODE_E;

typedef enum tagTFTPC_OpCode {
    TFTPC_OP_RRQ = 1,         /* read request */
    TFTPC_OP_WRQ,             /* write request */
    TFTPC_OP_DATA,            /* data packet */
    TFTPC_OP_ACK,             /* acknowledgment */
    TFTPC_OP_ERROR,           /* error code */
    TFTPC_OP_OPT              /* option code */
} TFTPC_OPCODE_E;

typedef enum tagTFTPC_PROTOCOL_ErrCode {
    TFTPC_PROTOCOL_USER_DEFINED = 0,
    TFTPC_PROTOCOL_FILE_NOT_FOUND,
    TFTPC_PROTOCOL_ACCESS_ERROR,
    TFTPC_PROTOCOL_DISK_FULL,
    TFTPC_PROTOCOL_PROTO_ERROR,
    TFTPC_PROTOCOL_UNKNOWN_TRANSFER_ID,
    TFTPC_PROTOCOL_FILE_EXISTS,
    TFTPC_PROTOCOL_CANNOT_RESOLVE_HOSTNAME
} TFTPC_PROT_ERRCODE_E;


#ifndef TFTPC_MAX_SEND_REQ_ATTEMPTS
#define TFTPC_MAX_SEND_REQ_ATTEMPTS         5 /* tftp max attempts */
#endif

#ifndef TFTPC_TIMEOUT_PERIOD
#define TFTPC_TIMEOUT_PERIOD         5 /* tftp timeout period,unit :s */
#endif

#define TFTPC_SERVER_PORT          69 /* tftp server well known port no. */

/*  MAX file size in TFTP is 32 MB.
    Reason for keeping 75 here , is ((75*512=38400bytes)/1024) =  37MB. So the recv/Send Loop can
    receive the complete MAX message from the network
*/
#define TFTPC_MAX_WAIT_IN_LOOP         75

#define TFTP_BLKSIZE               512     /* data block size (IEN-133) */
#define TFTP_HDRSIZE               4       /* TFTP header size */
#define TFTP_PKTSIZE              (TFTP_BLKSIZE + TFTP_HDRSIZE) /* Packet size */
#define TFTP_MAX_MODE_SIZE         9  /* max size of mode string */
#define TFTP_MAXERRSTRSIZE         100 /* max size of error message string */
#define TFTP_MAX_PATH_LENGTH       256 /* Max path or filename length */
#define TFTP_MAX_BLK_NUM          (0xFFFFL) /* MAximum block number */

/* IP address not including reserved IPs(0 and 127) and multicast addresses(Class D) */
#define TFTPC_IP_ADDR_MIN         0x01000000
#define TFTPC_IP_ADDR_EX_RESV     0x7effffff
#define TFTPC_IP_ADDR_CLASS_B     0x80000000
#define TFTPC_IP_ADDR_EX_CLASS_DE 0xdfffffff

#define TFTPC_FOUR 4  /* minimum packet size */

/****************************************************************************/
/*                            Structure definitions                         */
/****************************************************************************/
/* Tftp data packet */
typedef struct tagTFTPC_DATA {
    u16_t usBlknum;                      /* block number */
    u8_t ucDataBuf[TFTP_BLKSIZE];       /* Actual data */
} TFTPC_DATA_S;


/* TFTP error packet */
typedef struct tagTFTPC_ERROR {
    u16_t usErrNum;                       /* error number */
    u8_t ucErrMesg[TFTP_MAXERRSTRSIZE]; /* error message */
} TFTPC_ERROR_S;


/* TFTP packet format */
typedef struct tagTFTPC_PACKET {
    u16_t usOpcode; /* Opcode value */
    union {
        /* it contains mode and filename */
        s8_t ucName_Mode[TFTP_MAX_PATH_LENGTH + TFTP_MAX_MODE_SIZE];
        u16_t usBlknum; /* Block Number */
        TFTPC_DATA_S stTFTP_Data; /* Data Packet */
        TFTPC_ERROR_S stTFTP_Err; /* Error Packet */
    } u;
} TFTPC_PACKET_S;


/** @defgroup TFTP_Interfaces
* This section contains the TFTP Interfaces
*/
/*
Func Name:  lwip_tftp_get_file_by_filename
*/
/**
* @ingroup TFTP_Interfaces
* @brief
* This API gets the source file from the server. It then stores the received file in the destination path
* on the client system.
*
* @param[in]    ulHostAddr          IP address of Host. This is the TFTP server IP. [NA]
* @param[in]    usTftpServPort    TFTP server port. If the value is passed as 0 then the default TFTP
*                                                   PORT 69 is used. [NA]
* @param[in]    ucTftpTransMode File transfer mode, either TRANSFER_MODE_BINARY or TRANSFER_MODE_ASCII. [NA]
* @param[in]    szSrcFileName     Source file in the tftp server. [NA]
* @param[in]    szDestDirPath     Destination file path in the in the client. [NA]
* @param[out]  [N/A]
*
* @return
*  ERR_OK: On success \n
*  TFTPC_ERR_CODE_E: On failure
*
* @note
* \n
* The behavior of this API is such that if the destination file already exists, it will be overwritten.
*/
u32_t lwip_tftp_get_file_by_filename(u32_t ulHostAddr,
                                     u16_t usTftpServPort,
                                     u8_t ucTftpTransMode,
                                     s8_t *szSrcFileName,
                                     s8_t *szDestDirPath);


/* @defgroup TFTP_Interfaces
* This section contains the TFTP Interfaces
*/
/*
Func Name:  lwip_tftp_put_file_by_filename
*/
/**
* @ingroup TFTP_Interfaces

* @brief
* This API reads the contents of the source file on the client system and sends it to the server and
* server then receives the data and stores it in the specified destination path.
*
* @param[in]    ulHostAddr         Indicates the IP address of Host. This is the TFTP server IP.
* @param[in]    usTftpServPort    Indicates the TFTP server port. If the value is passed as 0 then the default TFTP
*                                                   PORT 69 is used.
* @param[in]    ucTftpTransMode  Indicates the file transfer mode, either TRANSFER_MODE_BINARY or TRANSFER_MODE_ASCII.
* @param[in]    szSrcFileName     Indicates the source file in the client.
* @param[in]    szDestDirPath     Indicates the destination file path on the tftp server.
*
* @return
*  ERR_OK: On success \n
*  TFTPC_ERR_CODE_E: On failure
*
*/
u32_t lwip_tftp_put_file_by_filename(u32_t ulHostAddr,
                                     u16_t usTftpServPort,
                                     u8_t cTftpTransMode,
                                     s8_t *szSrcFileName,
                                     s8_t *szDestDirPath);

#ifdef TFTP_TO_RAWMEM
/* @defgroup TFTP_Interfaces
* This section contains the TFTP Interfaces
*/
/*
Func Name:  lwip_tftp_get_file_by_filename_to_rawmem
*/
/**
* @ingroup TFTP_Interfaces

* @brief
* This API gets the source file from the server. It then stores the received file in the target memory
* on the client system.
*
* @param[in]    ulHostAddr         Indicates the IP address of the Host. This is the TFTP server IP.
* @param[in]    usTftpServPort     Indicates the TFTP server port. If the value is passed as 0 then the default TFTP
*                                                   PORT 69 is used.
* @param[in]    ucTftpTransMode  Indicates the File transfer mode, either TRANSFER_MODE_BINARY or TRANSFER_MODE_ASCII.
* @param[in]    szSrcFileName      Indicates the Source file in the TFTP server.
* @param[in]    szDestMemAddr      Indicates the target memory address in the client.
* @param[in/out]    ulFileLength       Indicates the target memory address can cache the size of the content,
                                       and The real size of the Source file.
*
* @return
*  ERR_OK: On success \n
*  TFTPC_ERR_CODE_E: On failure
* @note

* 1.You must define TFTP_TO_RAWMEM when using this API. \n
* 2.The behavior of this API is such that if the destination file already exists, it will be overwritten.
* @endcond
*/

u32_t lwip_tftp_get_file_by_filename_to_rawmem(u32_t ulHostAddr,
                                               u16_t usTftpServPort,
                                               u8_t ucTftpTransMode,
                                               s8_t *szSrcFileName,
                                               s8_t *szDestMemAddr,
                                               u32_t *ulFileLength);
#endif

#if defined (__cplusplus) && __cplusplus
}
#endif

#endif /* LWIP_TFTP */

#endif /* TFTPC_H */