tftp_opts.h

00001 /**
00002  *
00003  * @file tftp_opts.h
00004  *
00005  * @author   Logan Gunthorpe <logang@deltatee.com>
00006  *
00007  * @brief    Trivial File Transfer Protocol (RFC 1350) implementation options
00008  *
00009  * Copyright (c) Deltatee Enterprises Ltd. 2013
00010  * All rights reserved.
00011  *
00012  */
00013 
00014 /* 
00015  * Redistribution and use in source and binary forms, with or without
00016  * modification,are permitted provided that the following conditions are met:
00017  *
00018  * 1. Redistributions of source code must retain the above copyright notice,
00019  *    this list of conditions and the following disclaimer.
00020  * 2. Redistributions in binary form must reproduce the above copyright notice,
00021  *    this list of conditions and the following disclaimer in the documentation
00022  *    and/or other materials provided with the distribution.
00023  * 3. The name of the author may not be used to endorse or promote products
00024  *    derived from this software without specific prior written permission.
00025  *
00026  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
00027  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00028  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
00029  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00030  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00031  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036  *
00037  * Author: Logan Gunthorpe <logang@deltatee.com>
00038  *
00039  */
00040 
00041 #ifndef LWIP_HDR_APPS_TFTP_OPTS_H
00042 #define LWIP_HDR_APPS_TFTP_OPTS_H
00043 
00044 #include "lwip/opt.h"
00045 #include "lwip/prot/iana.h"
00046 
00047 /**
00048  * @defgroup tftp_opts Options
00049  * @ingroup tftp
00050  * @{
00051  */
00052 
00053 /**
00054  * Enable TFTP debug messages
00055  */
00056 #if !defined TFTP_DEBUG || defined __DOXYGEN__
00057 #define TFTP_DEBUG            LWIP_DBG_OFF
00058 #endif
00059 
00060 /**
00061  * TFTP server port
00062  */
00063 #if !defined TFTP_PORT || defined __DOXYGEN__
00064 #define TFTP_PORT             LWIP_IANA_PORT_TFTP
00065 #endif
00066 
00067 /**
00068  * TFTP timeout
00069  */
00070 #if !defined TFTP_TIMEOUT_MSECS || defined __DOXYGEN__
00071 #define TFTP_TIMEOUT_MSECS    10000
00072 #endif
00073 
00074 /**
00075  * Max. number of retries when a file is read from server
00076  */
00077 #if !defined TFTP_MAX_RETRIES || defined __DOXYGEN__
00078 #define TFTP_MAX_RETRIES      5
00079 #endif
00080 
00081 /**
00082  * TFTP timer cyclic interval
00083  */
00084 #if !defined TFTP_TIMER_MSECS || defined __DOXYGEN__
00085 #define TFTP_TIMER_MSECS      (TFTP_TIMEOUT_MSECS / 10)
00086 #endif
00087 
00088 /**
00089  * Max. length of TFTP filename
00090  */
00091 #if !defined TFTP_MAX_FILENAME_LEN || defined __DOXYGEN__
00092 #define TFTP_MAX_FILENAME_LEN 20
00093 #endif
00094 
00095 /**
00096  * Max. length of TFTP mode
00097  */
00098 #if !defined TFTP_MAX_MODE_LEN || defined __DOXYGEN__
00099 #define TFTP_MAX_MODE_LEN     7
00100 #endif
00101 
00102 /**
00103  * @}
00104  */
00105 
00106 #endif /* LWIP_HDR_APPS_TFTP_OPTS_H */