mirror/lwip
1
0
Fork 0
mirror of https://github.com/lwip-tcpip/lwip.git synced 2025-02-11 06:40:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add SNMP and HTTPD options to doxygen docs

Browse Source
This commit is contained in:
Dirk Ziegelmeier 2016-07-28 08:03:32 +02:00
parent f322e782f8
commit 93ad162aa6
2 changed files with 109 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
src/include/lwip/apps/httpd_opts.h
View File

@ -43,34 +43,40 @@
#include "lwip/opt.h" #include "lwip/opt.h"
/**
* @defgroup httpd_opts Options
* @ingroup httpd
* @{
*/
/** Set this to 1 to support CGI (old style) */ /** Set this to 1 to support CGI (old style) */
#ifndef LWIP_HTTPD_CGI #if !defined LWIP_HTTPD_CGI || defined __DOXYGEN__
#define LWIP_HTTPD_CGI 0 #define LWIP_HTTPD_CGI 0
#endif #endif
/** Set this to 1 to support CGI (new style) */ /** Set this to 1 to support CGI (new style) */
#ifndef LWIP_HTTPD_CGI_SSI #if !defined LWIP_HTTPD_CGI_SSI || defined __DOXYGEN__
#define LWIP_HTTPD_CGI_SSI 0 #define LWIP_HTTPD_CGI_SSI 0
#endif #endif
/** Set this to 1 to support SSI (Server-Side-Includes) */ /** Set this to 1 to support SSI (Server-Side-Includes) */
#ifndef LWIP_HTTPD_SSI #if !defined LWIP_HTTPD_SSI || defined __DOXYGEN__
#define LWIP_HTTPD_SSI 0 #define LWIP_HTTPD_SSI 0
#endif #endif
/** Set this to 1 to implement an SSI tag handler callback that gets a const char* /** Set this to 1 to implement an SSI tag handler callback that gets a const char*
* to the tag (instead of an index into a pre-registered array of known tags) */ * to the tag (instead of an index into a pre-registered array of known tags) */
#ifndef LWIP_HTTPD_SSI_RAW #if !defined LWIP_HTTPD_SSI_RAW || defined __DOXYGEN__
#define LWIP_HTTPD_SSI_RAW 0 #define LWIP_HTTPD_SSI_RAW 0
#endif #endif
/** Set this to 1 to support HTTP POST */ /** Set this to 1 to support HTTP POST */
#ifndef LWIP_HTTPD_SUPPORT_POST #if !defined LWIP_HTTPD_SUPPORT_POST || defined __DOXYGEN__
#define LWIP_HTTPD_SUPPORT_POST 0 #define LWIP_HTTPD_SUPPORT_POST 0
#endif #endif
/* The maximum number of parameters that the CGI handler can be sent. */ /* The maximum number of parameters that the CGI handler can be sent. */
#ifndef LWIP_HTTPD_MAX_CGI_PARAMETERS #if !defined LWIP_HTTPD_MAX_CGI_PARAMETERS || defined __DOXYGEN__
#define LWIP_HTTPD_MAX_CGI_PARAMETERS 16 #define LWIP_HTTPD_MAX_CGI_PARAMETERS 16
#endif #endif
@ -78,26 +84,26 @@
* arguments indicating a counter for insert string that are too long to be * arguments indicating a counter for insert string that are too long to be
* inserted at once: the SSI handler function must then set 'next_tag_part' * inserted at once: the SSI handler function must then set 'next_tag_part'
* which will be passed back to it in the next call. */ * which will be passed back to it in the next call. */
#ifndef LWIP_HTTPD_SSI_MULTIPART #if !defined LWIP_HTTPD_SSI_MULTIPART || defined __DOXYGEN__
#define LWIP_HTTPD_SSI_MULTIPART 0 #define LWIP_HTTPD_SSI_MULTIPART 0
#endif #endif
/* The maximum length of the string comprising the tag name */ /* The maximum length of the string comprising the tag name */
#ifndef LWIP_HTTPD_MAX_TAG_NAME_LEN #if !defined LWIP_HTTPD_MAX_TAG_NAME_LEN || defined __DOXYGEN__
#define LWIP_HTTPD_MAX_TAG_NAME_LEN 8 #define LWIP_HTTPD_MAX_TAG_NAME_LEN 8
#endif #endif
/* The maximum length of string that can be returned to replace any given tag */ /* The maximum length of string that can be returned to replace any given tag */
#ifndef LWIP_HTTPD_MAX_TAG_INSERT_LEN #if !defined LWIP_HTTPD_MAX_TAG_INSERT_LEN || defined __DOXYGEN__
#define LWIP_HTTPD_MAX_TAG_INSERT_LEN 192 #define LWIP_HTTPD_MAX_TAG_INSERT_LEN 192
#endif #endif
#ifndef LWIP_HTTPD_POST_MANUAL_WND #if !defined LWIP_HTTPD_POST_MANUAL_WND || defined __DOXYGEN__
#define LWIP_HTTPD_POST_MANUAL_WND 0 #define LWIP_HTTPD_POST_MANUAL_WND 0
#endif #endif
/** This string is passed in the HTTP header as "Server: " */ /** This string is passed in the HTTP header as "Server: " */
#ifndef HTTPD_SERVER_AGENT #if !defined HTTPD_SERVER_AGENT || defined __DOXYGEN__
#define HTTPD_SERVER_AGENT "lwIP/" LWIP_VERSION_STRING " (http://savannah.nongnu.org/projects/lwip)" #define HTTPD_SERVER_AGENT "lwIP/" LWIP_VERSION_STRING " (http://savannah.nongnu.org/projects/lwip)"
#endif #endif
@ -106,23 +112,23 @@
* by the makefsdata tool. Static headers mean smaller code size, but * by the makefsdata tool. Static headers mean smaller code size, but
* the (readonly) fsdata will grow a bit as every file includes the HTTP * the (readonly) fsdata will grow a bit as every file includes the HTTP
* header. */ * header. */
#ifndef LWIP_HTTPD_DYNAMIC_HEADERS #if !defined LWIP_HTTPD_DYNAMIC_HEADERS || defined __DOXYGEN__
#define LWIP_HTTPD_DYNAMIC_HEADERS 0 #define LWIP_HTTPD_DYNAMIC_HEADERS 0
#endif #endif
#ifndef HTTPD_DEBUG #if !defined HTTPD_DEBUG || defined __DOXYGEN__
#define HTTPD_DEBUG LWIP_DBG_OFF #define HTTPD_DEBUG LWIP_DBG_OFF
#endif #endif
/** Set this to 1 to use a memp pool for allocating /** Set this to 1 to use a memp pool for allocating
* struct http_state instead of the heap. * struct http_state instead of the heap.
*/ */
#ifndef HTTPD_USE_MEM_POOL #if !defined HTTPD_USE_MEM_POOL || defined __DOXYGEN__
#define HTTPD_USE_MEM_POOL 0 #define HTTPD_USE_MEM_POOL 0
#endif #endif
/** The server port for HTTPD to use */ /** The server port for HTTPD to use */
#ifndef HTTPD_SERVER_PORT #if !defined HTTPD_SERVER_PORT || defined __DOXYGEN__
#define HTTPD_SERVER_PORT 80 #define HTTPD_SERVER_PORT 80
#endif #endif
@ -130,43 +136,44 @@
* - number of times pcb->poll is called -> default is 4*500ms = 2s; * - number of times pcb->poll is called -> default is 4*500ms = 2s;
* - reset when pcb->sent is called * - reset when pcb->sent is called
*/ */
#ifndef HTTPD_MAX_RETRIES #if !defined HTTPD_MAX_RETRIES || defined __DOXYGEN__
#define HTTPD_MAX_RETRIES 4 #define HTTPD_MAX_RETRIES 4
#endif #endif
/** The poll delay is X*500ms */ /** The poll delay is X*500ms */
#ifndef HTTPD_POLL_INTERVAL #if !defined HTTPD_POLL_INTERVAL || defined __DOXYGEN__
#define HTTPD_POLL_INTERVAL 4 #define HTTPD_POLL_INTERVAL 4
#endif #endif
/** Priority for tcp pcbs created by HTTPD (very low by default). /** Priority for tcp pcbs created by HTTPD (very low by default).
* Lower priorities get killed first when running out of memory. * Lower priorities get killed first when running out of memory.
*/ */
#ifndef HTTPD_TCP_PRIO #if !defined HTTPD_TCP_PRIO || defined __DOXYGEN__
#define HTTPD_TCP_PRIO TCP_PRIO_MIN #define HTTPD_TCP_PRIO TCP_PRIO_MIN
#endif #endif
/** Set this to 1 to enable timing each file sent */ /** Set this to 1 to enable timing each file sent */
#ifndef LWIP_HTTPD_TIMING #if !defined LWIP_HTTPD_TIMING || defined __DOXYGEN__
#define LWIP_HTTPD_TIMING 0 #define LWIP_HTTPD_TIMING 0
#endif #endif
#ifndef HTTPD_DEBUG_TIMING /** Set this to 1 to enable timing each file sent */
#if !defined HTTPD_DEBUG_TIMING || defined __DOXYGEN__
#define HTTPD_DEBUG_TIMING LWIP_DBG_OFF #define HTTPD_DEBUG_TIMING LWIP_DBG_OFF
#endif #endif
/** Set this to 1 on platforms where strnstr is not available */ /** Set this to 1 on platforms where strnstr is not available */
#ifndef LWIP_HTTPD_STRNSTR_PRIVATE #if !defined LWIP_HTTPD_STRNSTR_PRIVATE || defined __DOXYGEN__
#define LWIP_HTTPD_STRNSTR_PRIVATE 1 #define LWIP_HTTPD_STRNSTR_PRIVATE 1
#endif #endif
/** Set this to 1 on platforms where stricmp is not available */ /** Set this to 1 on platforms where stricmp is not available */
#ifndef LWIP_HTTPD_STRICMP_PRIVATE #if !defined LWIP_HTTPD_STRICMP_PRIVATE || defined __DOXYGEN__
#define LWIP_HTTPD_STRICMP_PRIVATE 0 #define LWIP_HTTPD_STRICMP_PRIVATE 0
#endif #endif
/** Define this to a smaller function if you have itoa() at hand... */ /** Define this to a smaller function if you have itoa() at hand... */
#ifndef LWIP_HTTPD_ITOA #if !defined LWIP_HTTPD_ITOA || defined __DOXYGEN__
#ifndef LWIP_HTTPD_ITOA_PRIVATE #if !defined LWIP_HTTPD_ITOA_PRIVATE || defined __DOXYGEN__
#define LWIP_HTTPD_ITOA_PRIVATE 1 #define LWIP_HTTPD_ITOA_PRIVATE 1
#endif #endif
#if LWIP_HTTPD_ITOA_PRIVATE #if LWIP_HTTPD_ITOA_PRIVATE
@ -178,12 +185,12 @@
/** Set this to one to show error pages when parsing a request fails instead /** Set this to one to show error pages when parsing a request fails instead
of simply closing the connection. */ of simply closing the connection. */
#ifndef LWIP_HTTPD_SUPPORT_EXTSTATUS #if !defined LWIP_HTTPD_SUPPORT_EXTSTATUS || defined __DOXYGEN__
#define LWIP_HTTPD_SUPPORT_EXTSTATUS 0 #define LWIP_HTTPD_SUPPORT_EXTSTATUS 0
#endif #endif
/** Set this to 0 to drop support for HTTP/0.9 clients (to save some bytes) */ /** Set this to 0 to drop support for HTTP/0.9 clients (to save some bytes) */
#ifndef LWIP_HTTPD_SUPPORT_V09 #if !defined LWIP_HTTPD_SUPPORT_V09 || defined __DOXYGEN__
#define LWIP_HTTPD_SUPPORT_V09 1 #define LWIP_HTTPD_SUPPORT_V09 1
#endif #endif
@ -191,32 +198,32 @@
* ATTENTION: If the generated file system includes HTTP headers, these must * ATTENTION: If the generated file system includes HTTP headers, these must
* include the "Connection: keep-alive" header (pass argument "-11" to makefsdata). * include the "Connection: keep-alive" header (pass argument "-11" to makefsdata).
*/ */
#ifndef LWIP_HTTPD_SUPPORT_11_KEEPALIVE #if !defined LWIP_HTTPD_SUPPORT_11_KEEPALIVE || defined __DOXYGEN__
#define LWIP_HTTPD_SUPPORT_11_KEEPALIVE 0 #define LWIP_HTTPD_SUPPORT_11_KEEPALIVE 0
#endif #endif
/** Set this to 1 to support HTTP request coming in in multiple packets/pbufs */ /** Set this to 1 to support HTTP request coming in in multiple packets/pbufs */
#ifndef LWIP_HTTPD_SUPPORT_REQUESTLIST #if !defined LWIP_HTTPD_SUPPORT_REQUESTLIST || defined __DOXYGEN__
#define LWIP_HTTPD_SUPPORT_REQUESTLIST 1 #define LWIP_HTTPD_SUPPORT_REQUESTLIST 1
#endif #endif
#if LWIP_HTTPD_SUPPORT_REQUESTLIST #if LWIP_HTTPD_SUPPORT_REQUESTLIST
/** Number of rx pbufs to enqueue to parse an incoming request (up to the first /** Number of rx pbufs to enqueue to parse an incoming request (up to the first
newline) */ newline) */
#ifndef LWIP_HTTPD_REQ_QUEUELEN #if !defined LWIP_HTTPD_REQ_QUEUELEN || defined __DOXYGEN__
#define LWIP_HTTPD_REQ_QUEUELEN 5 #define LWIP_HTTPD_REQ_QUEUELEN 5
#endif #endif
/** Number of (TCP payload-) bytes (in pbufs) to enqueue to parse and incoming /** Number of (TCP payload-) bytes (in pbufs) to enqueue to parse and incoming
request (up to the first double-newline) */ request (up to the first double-newline) */
#ifndef LWIP_HTTPD_REQ_BUFSIZE #if !defined LWIP_HTTPD_REQ_BUFSIZE || defined __DOXYGEN__
#define LWIP_HTTPD_REQ_BUFSIZE LWIP_HTTPD_MAX_REQ_LENGTH #define LWIP_HTTPD_REQ_BUFSIZE LWIP_HTTPD_MAX_REQ_LENGTH
#endif #endif
/** Defines the maximum length of a HTTP request line (up to the first CRLF, /** Defines the maximum length of a HTTP request line (up to the first CRLF,
copied from pbuf into this a global buffer when pbuf- or packet-queues copied from pbuf into this a global buffer when pbuf- or packet-queues
are received - otherwise the input pbuf is used directly) */ are received - otherwise the input pbuf is used directly) */
#ifndef LWIP_HTTPD_MAX_REQ_LENGTH #if !defined LWIP_HTTPD_MAX_REQ_LENGTH || defined __DOXYGEN__
#define LWIP_HTTPD_MAX_REQ_LENGTH LWIP_MIN(1023, (LWIP_HTTPD_REQ_QUEUELEN * PBUF_POOL_BUFSIZE)) #define LWIP_HTTPD_MAX_REQ_LENGTH LWIP_MIN(1023, (LWIP_HTTPD_REQ_QUEUELEN * PBUF_POOL_BUFSIZE))
#endif #endif
#endif /* LWIP_HTTPD_SUPPORT_REQUESTLIST */ #endif /* LWIP_HTTPD_SUPPORT_REQUESTLIST */
@ -226,27 +233,27 @@
* configured default file names. * configured default file names.
* Set to 0 to disable checking default filenames on non-root directories. * Set to 0 to disable checking default filenames on non-root directories.
*/ */
#ifndef LWIP_HTTPD_MAX_REQUEST_URI_LEN #if !defined LWIP_HTTPD_MAX_REQUEST_URI_LEN || defined __DOXYGEN__
#define LWIP_HTTPD_MAX_REQUEST_URI_LEN 63 #define LWIP_HTTPD_MAX_REQUEST_URI_LEN 63
#endif #endif
/** Maximum length of the filename to send as response to a POST request, /** Maximum length of the filename to send as response to a POST request,
* filled in by the application when a POST is finished. * filled in by the application when a POST is finished.
*/ */
#ifndef LWIP_HTTPD_POST_MAX_RESPONSE_URI_LEN #if !defined LWIP_HTTPD_POST_MAX_RESPONSE_URI_LEN || defined __DOXYGEN__
#define LWIP_HTTPD_POST_MAX_RESPONSE_URI_LEN 63 #define LWIP_HTTPD_POST_MAX_RESPONSE_URI_LEN 63
#endif #endif
/** Set this to 0 to not send the SSI tag (default is on, so the tag will /** Set this to 0 to not send the SSI tag (default is on, so the tag will
* be sent in the HTML page */ * be sent in the HTML page */
#ifndef LWIP_HTTPD_SSI_INCLUDE_TAG #if !defined LWIP_HTTPD_SSI_INCLUDE_TAG || defined __DOXYGEN__
#define LWIP_HTTPD_SSI_INCLUDE_TAG 1 #define LWIP_HTTPD_SSI_INCLUDE_TAG 1
#endif #endif
/** Set this to 1 to call tcp_abort when tcp_close fails with memory error. /** Set this to 1 to call tcp_abort when tcp_close fails with memory error.
* This can be used to prevent consuming all memory in situations where the * This can be used to prevent consuming all memory in situations where the
* HTTP server has low priority compared to other communication. */ * HTTP server has low priority compared to other communication. */
#ifndef LWIP_HTTPD_ABORT_ON_CLOSE_MEM_ERROR #if !defined LWIP_HTTPD_ABORT_ON_CLOSE_MEM_ERROR || defined __DOXYGEN__
#define LWIP_HTTPD_ABORT_ON_CLOSE_MEM_ERROR 0 #define LWIP_HTTPD_ABORT_ON_CLOSE_MEM_ERROR 0
#endif #endif
@ -254,30 +261,30 @@
* memory for 'struct http_state' or 'struct http_ssi_state'. * memory for 'struct http_state' or 'struct http_ssi_state'.
* ATTENTION: This puts all connections on a linked list, so may be kind of slow. * ATTENTION: This puts all connections on a linked list, so may be kind of slow.
*/ */
#ifndef LWIP_HTTPD_KILL_OLD_ON_CONNECTIONS_EXCEEDED #if !defined LWIP_HTTPD_KILL_OLD_ON_CONNECTIONS_EXCEEDED || defined __DOXYGEN__
#define LWIP_HTTPD_KILL_OLD_ON_CONNECTIONS_EXCEEDED 0 #define LWIP_HTTPD_KILL_OLD_ON_CONNECTIONS_EXCEEDED 0
#endif #endif
/** Set this to 1 to send URIs without extension without headers /** Set this to 1 to send URIs without extension without headers
* (who uses this at all??) */ * (who uses this at all??) */
#ifndef LWIP_HTTPD_OMIT_HEADER_FOR_EXTENSIONLESS_URI #if !defined LWIP_HTTPD_OMIT_HEADER_FOR_EXTENSIONLESS_URI || defined __DOXYGEN__
#define LWIP_HTTPD_OMIT_HEADER_FOR_EXTENSIONLESS_URI 0 #define LWIP_HTTPD_OMIT_HEADER_FOR_EXTENSIONLESS_URI 0
#endif #endif
/** Default: Tags are sent from struct http_state and are therefore volatile */ /** Default: Tags are sent from struct http_state and are therefore volatile */
#ifndef HTTP_IS_TAG_VOLATILE #if !defined HTTP_IS_TAG_VOLATILE || defined __DOXYGEN__
#define HTTP_IS_TAG_VOLATILE(ptr) TCP_WRITE_FLAG_COPY #define HTTP_IS_TAG_VOLATILE(ptr) TCP_WRITE_FLAG_COPY
#endif #endif
/* By default, the httpd is limited to send 2*pcb->mss to keep resource usage low /* By default, the httpd is limited to send 2*pcb->mss to keep resource usage low
when http is not an important protocol in the device. */ when http is not an important protocol in the device. */
#ifndef HTTPD_LIMIT_SENDING_TO_2MSS #if !defined HTTPD_LIMIT_SENDING_TO_2MSS || defined __DOXYGEN__
#define HTTPD_LIMIT_SENDING_TO_2MSS 1 #define HTTPD_LIMIT_SENDING_TO_2MSS 1
#endif #endif
/* Define this to a function that returns the maximum amount of data to enqueue. /* Define this to a function that returns the maximum amount of data to enqueue.
The function have this signature: u16_t fn(struct tcp_pcb* pcb); */ The function have this signature: u16_t fn(struct tcp_pcb* pcb); */
#ifndef HTTPD_MAX_WRITE_LEN #if !defined HTTPD_MAX_WRITE_LEN || defined __DOXYGEN__
#if HTTPD_LIMIT_SENDING_TO_2MSS #if HTTPD_LIMIT_SENDING_TO_2MSS
#define HTTPD_MAX_WRITE_LEN(pcb) (2 * tcp_mss(pcb)) #define HTTPD_MAX_WRITE_LEN(pcb) (2 * tcp_mss(pcb))
#endif #endif
@ -292,7 +299,7 @@
* - "void fs_close_custom(struct fs_file *file)" * - "void fs_close_custom(struct fs_file *file)"
* Called to free resources allocated by fs_open_custom(). * Called to free resources allocated by fs_open_custom().
*/ */
#ifndef LWIP_HTTPD_CUSTOM_FILES #if !defined LWIP_HTTPD_CUSTOM_FILES || defined __DOXYGEN__
#define LWIP_HTTPD_CUSTOM_FILES 0 #define LWIP_HTTPD_CUSTOM_FILES 0
#endif #endif
@ -300,35 +307,39 @@
* Without this (default=off), only one-block files are supported, * Without this (default=off), only one-block files are supported,
* and the contents must be ready after fs_open(). * and the contents must be ready after fs_open().
*/ */
#ifndef LWIP_HTTPD_DYNAMIC_FILE_READ #if !defined LWIP_HTTPD_DYNAMIC_FILE_READ || defined __DOXYGEN__
#define LWIP_HTTPD_DYNAMIC_FILE_READ 0 #define LWIP_HTTPD_DYNAMIC_FILE_READ 0
#endif #endif
/** Set this to 1 to include an application state argument per file /** Set this to 1 to include an application state argument per file
* that is opened. This allows to keep a state per connection/file. * that is opened. This allows to keep a state per connection/file.
*/ */
#ifndef LWIP_HTTPD_FILE_STATE #if !defined LWIP_HTTPD_FILE_STATE || defined __DOXYGEN__
#define LWIP_HTTPD_FILE_STATE 0 #define LWIP_HTTPD_FILE_STATE 0
#endif #endif
/** HTTPD_PRECALCULATED_CHECKSUM==1: include precompiled checksums for /** HTTPD_PRECALCULATED_CHECKSUM==1: include precompiled checksums for
* predefined (MSS-sized) chunks of the files to prevent having to calculate * predefined (MSS-sized) chunks of the files to prevent having to calculate
* the checksums at runtime. */ * the checksums at runtime. */
#ifndef HTTPD_PRECALCULATED_CHECKSUM #if !defined HTTPD_PRECALCULATED_CHECKSUM || defined __DOXYGEN__
#define HTTPD_PRECALCULATED_CHECKSUM 0 #define HTTPD_PRECALCULATED_CHECKSUM 0
#endif #endif
/** LWIP_HTTPD_FS_ASYNC_READ==1: support asynchronous read operations /** LWIP_HTTPD_FS_ASYNC_READ==1: support asynchronous read operations
* (fs_read_async returns FS_READ_DELAYED and calls a callback when finished). * (fs_read_async returns FS_READ_DELAYED and calls a callback when finished).
*/ */
#ifndef LWIP_HTTPD_FS_ASYNC_READ #if !defined LWIP_HTTPD_FS_ASYNC_READ || defined __DOXYGEN__
#define LWIP_HTTPD_FS_ASYNC_READ 0 #define LWIP_HTTPD_FS_ASYNC_READ 0
#endif #endif
/** Set this to 1 to include "fsdata_custom.c" instead of "fsdata.c" for the /** Set this to 1 to include "fsdata_custom.c" instead of "fsdata.c" for the
* file system (to prevent changing the file included in CVS) */ * file system (to prevent changing the file included in CVS) */
#ifndef HTTPD_USE_CUSTOM_FSDATA #if !defined HTTPD_USE_CUSTOM_FSDATA || defined __DOXYGEN__
#define HTTPD_USE_CUSTOM_FSDATA 0 #define HTTPD_USE_CUSTOM_FSDATA 0
#endif #endif
#endif /* LWIP_HDR_APPS_HTTPD_OPTS_H */ /**
* @}
*/
#endif /* LWIP_HDR_APPS_HTTPD_OPTS_H */

86
src/include/lwip/apps/snmp_opts.h
View File

@ -39,6 +39,12 @@
#include "lwip/opt.h" #include "lwip/opt.h"
/**
* @defgroup snmp_opts Options
* @ingroup snmp
* @{
*/
/** /**
* LWIP_SNMP==1: This enables the lwIP SNMP agent. UDP must be available * LWIP_SNMP==1: This enables the lwIP SNMP agent. UDP must be available
* for SNMP transport. * for SNMP transport.
@ -47,25 +53,16 @@
* LWIP_MIB2_CALLBACKS and MIB2_STATS. This will give you the callbacks * LWIP_MIB2_CALLBACKS and MIB2_STATS. This will give you the callbacks
* and statistics counters you need to get MIB2 working. * and statistics counters you need to get MIB2 working.
*/ */
#ifndef LWIP_SNMP #if !defined LWIP_SNMP || defined __DOXYGEN__
#define LWIP_SNMP 0 #define LWIP_SNMP 0
#endif #endif
/**
* LWIP_SNMP_V3==1: This enables EXPERIMENTAL SNMPv3 support. LWIP_SNMP must
* also be enabled.
* THIS IS UNDER DEVELOPMENT AND SHOULD NOT BE ENABLED IN PRODUCTS.
*/
#ifndef LWIP_SNMP_V3
#define LWIP_SNMP_V3 0
#endif
/** /**
* SNMP_USE_NETCONN: Use netconn API instead of raw API. * SNMP_USE_NETCONN: Use netconn API instead of raw API.
* Makes SNMP agent run in a worker thread, so blocking operations * Makes SNMP agent run in a worker thread, so blocking operations
* can be done in MIB calls. * can be done in MIB calls.
*/ */
#ifndef SNMP_USE_NETCONN #if !defined SNMP_USE_NETCONN || defined __DOXYGEN__
#define SNMP_USE_NETCONN 0 #define SNMP_USE_NETCONN 0
#endif #endif
@ -74,7 +71,7 @@
* SNMP agent does not run in a worker thread, so blocking operations * SNMP agent does not run in a worker thread, so blocking operations
* should not be done in MIB calls. * should not be done in MIB calls.
*/ */
#ifndef SNMP_USE_RAW #if !defined SNMP_USE_RAW || defined __DOXYGEN__
#define SNMP_USE_RAW 1 #define SNMP_USE_RAW 1
#endif #endif
@ -88,16 +85,16 @@
#if SNMP_USE_NETCONN #if SNMP_USE_NETCONN
/** /**
* SNMP_STACK_SIZE: Stack size of SNMP worker thread * SNMP_STACK_SIZE: Stack size of SNMP netconn worker thread
*/ */
#ifndef SNMP_STACK_SIZE #if !defined SNMP_STACK_SIZE || defined __DOXYGEN__
#define SNMP_STACK_SIZE DEFAULT_THREAD_STACKSIZE #define SNMP_STACK_SIZE DEFAULT_THREAD_STACKSIZE
#endif #endif
/** /**
* SNMP_THREAD_PRIO: SNMP worker thread priority * SNMP_THREAD_PRIO: SNMP netconn worker thread priority
*/ */
#ifndef SNMP_THREAD_PRIO #if !defined SNMP_THREAD_PRIO || defined __DOXYGEN__
#define SNMP_THREAD_PRIO DEFAULT_THREAD_PRIO #define SNMP_THREAD_PRIO DEFAULT_THREAD_PRIO
#endif #endif
#endif /* SNMP_USE_NETCONN */ #endif /* SNMP_USE_NETCONN */
@ -106,7 +103,7 @@
* SNMP_TRAP_DESTINATIONS: Number of trap destinations. At least one trap * SNMP_TRAP_DESTINATIONS: Number of trap destinations. At least one trap
* destination is required * destination is required
*/ */
#ifndef SNMP_TRAP_DESTINATIONS #if !defined SNMP_TRAP_DESTINATIONS || defined __DOXYGEN__
#define SNMP_TRAP_DESTINATIONS 1 #define SNMP_TRAP_DESTINATIONS 1
#endif #endif
@ -115,14 +112,14 @@
* a safe action and disabled when SNMP_SAFE_REQUESTS = 1). * a safe action and disabled when SNMP_SAFE_REQUESTS = 1).
* Unsafe requests are disabled by default! * Unsafe requests are disabled by default!
*/ */
#ifndef SNMP_SAFE_REQUESTS #if !defined SNMP_SAFE_REQUESTS || defined __DOXYGEN__
#define SNMP_SAFE_REQUESTS 1 #define SNMP_SAFE_REQUESTS 1
#endif #endif
/** /**
* The maximum length of strings used. * The maximum length of strings used.
*/ */
#ifndef SNMP_MAX_OCTET_STRING_LEN #if !defined SNMP_MAX_OCTET_STRING_LEN || defined __DOXYGEN__
#define SNMP_MAX_OCTET_STRING_LEN 127 #define SNMP_MAX_OCTET_STRING_LEN 127
#endif #endif
@ -130,15 +127,18 @@
* The maximum number of Sub ID's inside an object identifier. * The maximum number of Sub ID's inside an object identifier.
* Indirectly this also limits the maximum depth of SNMP tree. * Indirectly this also limits the maximum depth of SNMP tree.
*/ */
#ifndef SNMP_MAX_OBJ_ID_LEN #if !defined SNMP_MAX_OBJ_ID_LEN || defined __DOXYGEN__
#define SNMP_MAX_OBJ_ID_LEN 50 #define SNMP_MAX_OBJ_ID_LEN 50
#endif #endif
#if !defined SNMP_MAX_VALUE_SIZE || defined __DOXYGEN__
/** /**
* The maximum size of a value. * The maximum size of a value.
*/ */
#ifndef SNMP_MAX_VALUE_SIZE
#define SNMP_MIN_VALUE_SIZE (2 * sizeof(u32_t*)) /* size required to store the basic types (8 bytes for counter64) */ #define SNMP_MIN_VALUE_SIZE (2 * sizeof(u32_t*)) /* size required to store the basic types (8 bytes for counter64) */
/**
* The minimum size of a value.
*/
#define SNMP_MAX_VALUE_SIZE LWIP_MAX(LWIP_MAX((SNMP_MAX_OCTET_STRING_LEN), sizeof(u32_t)*(SNMP_MAX_OBJ_ID_LEN)), SNMP_MIN_VALUE_SIZE) #define SNMP_MAX_VALUE_SIZE LWIP_MAX(LWIP_MAX((SNMP_MAX_OCTET_STRING_LEN), sizeof(u32_t)*(SNMP_MAX_OBJ_ID_LEN)), SNMP_MIN_VALUE_SIZE)
#endif #endif
@ -146,7 +146,7 @@
* The snmp read-access community. Used for write-access and traps, too * The snmp read-access community. Used for write-access and traps, too
* unless SNMP_COMMUNITY_WRITE or SNMP_COMMUNITY_TRAP are enabled, respectively. * unless SNMP_COMMUNITY_WRITE or SNMP_COMMUNITY_TRAP are enabled, respectively.
*/ */
#ifndef SNMP_COMMUNITY #if !defined SNMP_COMMUNITY || defined __DOXYGEN__
#define SNMP_COMMUNITY "public" #define SNMP_COMMUNITY "public"
#endif #endif
@ -154,14 +154,14 @@
* The snmp write-access community. * The snmp write-access community.
* Set this community to "" in order to disallow any write access. * Set this community to "" in order to disallow any write access.
*/ */
#ifndef SNMP_COMMUNITY_WRITE #if !defined SNMP_COMMUNITY_WRITE || defined __DOXYGEN__
#define SNMP_COMMUNITY_WRITE "private" #define SNMP_COMMUNITY_WRITE "private"
#endif #endif
/** /**
* The snmp community used for sending traps. * The snmp community used for sending traps.
*/ */
#ifndef SNMP_COMMUNITY_TRAP #if !defined SNMP_COMMUNITY_TRAP || defined __DOXYGEN__
#define SNMP_COMMUNITY_TRAP "public" #define SNMP_COMMUNITY_TRAP "public"
#endif #endif
@ -170,14 +170,15 @@
* If community names shall be adjusted at runtime via snmp_set_community() calls, * If community names shall be adjusted at runtime via snmp_set_community() calls,
* enter here the possible maximum length (+1 for terminating null character). * enter here the possible maximum length (+1 for terminating null character).
*/ */
#ifndef SNMP_MAX_COMMUNITY_STR_LEN #if !defined SNMP_MAX_COMMUNITY_STR_LEN || defined __DOXYGEN__
#define SNMP_MAX_COMMUNITY_STR_LEN LWIP_MAX(LWIP_MAX(sizeof(SNMP_COMMUNITY), sizeof(SNMP_COMMUNITY_WRITE)), sizeof(SNMP_COMMUNITY_TRAP)) #define SNMP_MAX_COMMUNITY_STR_LEN LWIP_MAX(LWIP_MAX(sizeof(SNMP_COMMUNITY), sizeof(SNMP_COMMUNITY_WRITE)), sizeof(SNMP_COMMUNITY_TRAP))
#endif #endif
/** /**
* The OID identifiying the device. This may be the enterprise OID itself or any OID located below it in tree. * The OID identifiying the device. This may be the enterprise OID itself or any OID located below it in tree.
*/ */
#ifndef SNMP_DEVICE_ENTERPRISE_OID #if !defined SNMP_DEVICE_ENTERPRISE_OID || defined __DOXYGEN__
#define SNMP_LWIP_ENTERPRISE_OID 26381
/** /**
* IANA assigned enterprise ID for lwIP is 26381 * IANA assigned enterprise ID for lwIP is 26381
* @see http://www.iana.org/assignments/enterprise-numbers * @see http://www.iana.org/assignments/enterprise-numbers
@ -191,36 +192,38 @@
* to apply for your own enterprise ID with IANA: * to apply for your own enterprise ID with IANA:
* http://www.iana.org/numbers.html * http://www.iana.org/numbers.html
*/ */
#define SNMP_LWIP_ENTERPRISE_OID 26381
#define SNMP_DEVICE_ENTERPRISE_OID {1, 3, 6, 1, 4, 1, SNMP_LWIP_ENTERPRISE_OID} #define SNMP_DEVICE_ENTERPRISE_OID {1, 3, 6, 1, 4, 1, SNMP_LWIP_ENTERPRISE_OID}
/**
* Length of SNMP_DEVICE_ENTERPRISE_OID
*/
#define SNMP_DEVICE_ENTERPRISE_OID_LEN 7 #define SNMP_DEVICE_ENTERPRISE_OID_LEN 7
#endif #endif
/** /**
* SNMP_DEBUG: Enable debugging for SNMP messages. * SNMP_DEBUG: Enable debugging for SNMP messages.
*/ */
#ifndef SNMP_DEBUG #if !defined SNMP_DEBUG || defined __DOXYGEN__
#define SNMP_DEBUG LWIP_DBG_OFF #define SNMP_DEBUG LWIP_DBG_OFF
#endif #endif
/** /**
* SNMP_MIB_DEBUG: Enable debugging for SNMP MIBs. * SNMP_MIB_DEBUG: Enable debugging for SNMP MIBs.
*/ */
#ifndef SNMP_MIB_DEBUG #if !defined SNMP_MIB_DEBUG || defined __DOXYGEN__
#define SNMP_MIB_DEBUG LWIP_DBG_OFF #define SNMP_MIB_DEBUG LWIP_DBG_OFF
#endif #endif
/** /**
* Indicates if the MIB2 implementation of LWIP SNMP stack is used. * Indicates if the MIB2 implementation of LWIP SNMP stack is used.
*/ */
#ifndef SNMP_LWIP_MIB2 #if !defined SNMP_LWIP_MIB2 || defined __DOXYGEN__
#define SNMP_LWIP_MIB2 LWIP_SNMP #define SNMP_LWIP_MIB2 LWIP_SNMP
#endif #endif
/** /**
* Value return for sysDesc field of MIB2. * Value return for sysDesc field of MIB2.
*/ */
#ifndef SNMP_LWIP_MIB2_SYSDESC #if !defined SNMP_LWIP_MIB2_SYSDESC || defined __DOXYGEN__
#define SNMP_LWIP_MIB2_SYSDESC "lwIP" #define SNMP_LWIP_MIB2_SYSDESC "lwIP"
#endif #endif
@ -228,7 +231,7 @@
* Value return for sysName field of MIB2. * Value return for sysName field of MIB2.
* To make sysName field settable, call snmp_mib2_set_sysname() to provide the necessary buffers. * To make sysName field settable, call snmp_mib2_set_sysname() to provide the necessary buffers.
*/ */
#ifndef SNMP_LWIP_MIB2_SYSNAME #if !defined SNMP_LWIP_MIB2_SYSNAME || defined __DOXYGEN__
#define SNMP_LWIP_MIB2_SYSNAME "FQDN-unk" #define SNMP_LWIP_MIB2_SYSNAME "FQDN-unk"
#endif #endif
@ -236,7 +239,7 @@
* Value return for sysContact field of MIB2. * Value return for sysContact field of MIB2.
* To make sysContact field settable, call snmp_mib2_set_syscontact() to provide the necessary buffers. * To make sysContact field settable, call snmp_mib2_set_syscontact() to provide the necessary buffers.
*/ */
#ifndef SNMP_LWIP_MIB2_SYSCONTACT #if !defined SNMP_LWIP_MIB2_SYSCONTACT || defined __DOXYGEN__
#define SNMP_LWIP_MIB2_SYSCONTACT "" #define SNMP_LWIP_MIB2_SYSCONTACT ""
#endif #endif
@ -244,7 +247,7 @@
* Value return for sysLocation field of MIB2. * Value return for sysLocation field of MIB2.
* To make sysLocation field settable, call snmp_mib2_set_syslocation() to provide the necessary buffers. * To make sysLocation field settable, call snmp_mib2_set_syslocation() to provide the necessary buffers.
*/ */
#ifndef SNMP_LWIP_MIB2_SYSLOCATION #if !defined SNMP_LWIP_MIB2_SYSLOCATION || defined __DOXYGEN__
#define SNMP_LWIP_MIB2_SYSLOCATION "" #define SNMP_LWIP_MIB2_SYSLOCATION ""
#endif #endif
@ -256,16 +259,29 @@
* For the stack this could be useful in case that SNMP processing is done in TCP/IP thread. In this situation a request with many * For the stack this could be useful in case that SNMP processing is done in TCP/IP thread. In this situation a request with many
* repetitions could block the thread for a longer time. Setting limit here will keep the stack more responsive. * repetitions could block the thread for a longer time. Setting limit here will keep the stack more responsive.
*/ */
#ifndef SNMP_LWIP_GETBULK_MAX_REPETITIONS #if !defined SNMP_LWIP_GETBULK_MAX_REPETITIONS || defined __DOXYGEN__
#define SNMP_LWIP_GETBULK_MAX_REPETITIONS 0 #define SNMP_LWIP_GETBULK_MAX_REPETITIONS 0
#endif #endif
/**
* @}
*/
/* /*
------------------------------------ ------------------------------------
---------- SNMPv3 options ---------- ---------- SNMPv3 options ----------
------------------------------------ ------------------------------------
*/ */
/**
* LWIP_SNMP_V3==1: This enables EXPERIMENTAL SNMPv3 support. LWIP_SNMP must
* also be enabled.
* THIS IS UNDER DEVELOPMENT AND SHOULD NOT BE ENABLED IN PRODUCTS.
*/
#ifndef LWIP_SNMP_V3
#define LWIP_SNMP_V3 0
#endif
#ifndef LWIP_SNMP_V3_CRYPTO #ifndef LWIP_SNMP_V3_CRYPTO
#define LWIP_SNMP_V3_CRYPTO LWIP_SNMP_V3 #define LWIP_SNMP_V3_CRYPTO LWIP_SNMP_V3
#endif #endif