Update copyright date ready for tagging V10.1.0.

[freertos] / FreeRTOS / Demo / CORTEX_M4F_ATSAM4E_Atmel_Studio / src / config / FreeRTOSIPConfig.h

/*\r
 * FreeRTOS+UDP V1.0.4\r
 * Copyright (C) 2018 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
 *\r
 * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
 * this software and associated documentation files (the "Software"), to deal in\r
 * the Software without restriction, including without limitation the rights to\r
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
 * the Software, and to permit persons to whom the Software is furnished to do so,\r
 * subject to the following conditions:\r
 *\r
 * The above copyright notice and this permission notice shall be included in all\r
 * copies or substantial portions of the Software.\r
 *\r
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
 *\r
 * http://www.FreeRTOS.org\r
 * http://aws.amazon.com/freertos\r
 *\r
 * 1 tab == 4 spaces!\r
 */\r
\r
/*****************************************************************************\r
 *\r
 * See the following URL for configuration information.\r
 * http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_UDP/UDP_IP_Configuration.shtml\r
 *\r
 *****************************************************************************/\r
\r
#ifndef FREERTOS_IP_CONFIG_H\r
#define FREERTOS_IP_CONFIG_H\r
\r
/* The IP stack executes it its own task (although any application task can make\r
use of its services through the published sockets API). ipconfigUDP_TASK_PRIORITY\r
sets the priority of the task that executes the IP stack.  The priority is a\r
standard FreeRTOS task priority so can take any value from 0 (the lowest\r
priority) to (configMAX_PRIORITIES - 1) (the highest priority).\r
configMAX_PRIORITIES is a standard FreeRTOS configuration parameter defined in\r
FreeRTOSConfig.h, not FreeRTOSIPConfig.h. Consideration needs to be given as to\r
the priority assigned to the task executing the IP stack relative to the\r
priority assigned to tasks that use the IP stack.\r
\r
Note:  If the application is started without the network cable plugged in then\r
this should be set to the lowest priority - otherwise the Atmel ASF GMAC driver\r
will poll the GMAC interface waiting for a connection to be established.  The\r
driver uses a very long timeout and no lower priority tasks will be able to\r
execute during this time.  This demo starts with the IP task running at the idle\r
priority - then raises the priority of the IP task in the network event hook\r
when a connection has been established. */\r
#define ipconfigUDP_TASK_PRIORITY                       ( tskIDLE_PRIORITY )\r
\r
/* The size, in words (not bytes), of the stack allocated to the FreeRTOS+UDP\r
task.  This setting is less important when the FreeRTOS Win32 simulator is used\r
as the Win32 simulator only stores a fixed amount of information on the task\r
stack.  FreeRTOS includes optional stack overflow detection, see:\r
http://www.freertos.org/Stacks-and-stack-overflow-checking.html */\r
#define ipconfigUDP_TASK_STACK_SIZE_WORDS       ( configMINIMAL_STACK_SIZE * 2 )\r
\r
/* ipconfigRAND32() is called by the IP stack to generate a random number that\r
is then used as a DHCP transaction number.  Random number generation is performed\r
via this macro to allow applications to use their own random number generation\r
method.  For example, it might be possible to generate a random number by\r
sampling noise on an analogue input. */\r
#define ipconfigRAND32()        1\r
\r
/* If ipconfigUSE_NETWORK_EVENT_HOOK is set to 1 then FreeRTOS+UDP will call the\r
network event hook at the appropriate times.  If ipconfigUSE_NETWORK_EVENT_HOOK\r
is not set to 1 then the network event hook will never be called.  See\r
http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_UDP/API/vApplicationIPNetworkEventHook.shtml\r
*/\r
#define ipconfigUSE_NETWORK_EVENT_HOOK 1\r
\r
/* Sockets have a send block time attribute.  If FreeRTOS_sendto() is called but\r
a network buffer cannot be obtained then the calling task is held in the Blocked\r
state (so other tasks can continue to executed) until either a network buffer\r
becomes available or the send block time expires.  If the send block time expires\r
then the send operation is aborted.  The maximum allowable send block time is\r
capped to the value set by ipconfigMAX_SEND_BLOCK_TIME_TICKS.  Capping the\r
maximum allowable send block time prevents prevents a deadlock occurring when\r
all the network buffers are in use and the tasks that process (and subsequently\r
free) the network buffers are themselves blocked waiting for a network buffer.\r
ipconfigMAX_SEND_BLOCK_TIME_TICKS is specified in RTOS ticks.  A time in\r
milliseconds can be converted to a time in ticks by dividing the time in\r
milliseconds by portTICK_PERIOD_MS. */\r
#define ipconfigMAX_SEND_BLOCK_TIME_TICKS ( 20 / portTICK_PERIOD_MS )\r
\r
/* If ipconfigUSE_DHCP is 1 then FreeRTOS+UDP will attempt to retrieve an IP\r
address, netmask, DNS server address and gateway address from a DHCP server.  If\r
ipconfigUSE_DHCP is 0 then FreeRTOS+UDP will use a static IP address.  The\r
stack will revert to using the static IP address even when ipconfigUSE_DHCP is\r
set to 1 if a valid configuration cannot be obtained from a DHCP server for any\r
reason.  The static configuration used is that passed into the stack by the\r
FreeRTOS_IPInit() function call. */\r
#define ipconfigUSE_DHCP        1\r
\r
/* When ipconfigUSE_DHCP is set to 1, DHCP requests will be sent out at\r
increasing time intervals until either a reply is received from a DHCP server\r
and accepted, or the interval between transmissions reaches\r
ipconfigMAXIMUM_DISCOVER_TX_PERIOD.  The IP stack will revert to using the\r
static IP address passed as a parameter to FreeRTOS_IPInit() if the\r
re-transmission time interval reaches ipconfigMAXIMUM_DISCOVER_TX_PERIOD without\r
a DHCP reply being received. */\r
#define ipconfigMAXIMUM_DISCOVER_TX_PERIOD              ( 999 / portTICK_PERIOD_MS )\r
\r
/* The ARP cache is a table that maps IP addresses to MAC addresses.  The IP\r
stack can only send a UDP message to a remove IP address if it knowns the MAC\r
address associated with the IP address, or the MAC address of the router used to\r
contact the remote IP address.  When a UDP message is received from a remote IP\r
address the MAC address and IP address are added to the ARP cache.  When a UDP\r
message is sent to a remote IP address that does not already appear in the ARP\r
cache then the UDP message is replaced by a ARP message that solicits the\r
required MAC address information.  ipconfigARP_CACHE_ENTRIES defines the maximum\r
number of entries that can exist in the ARP table at any one time. */\r
#define ipconfigARP_CACHE_ENTRIES               6\r
\r
/* ARP requests that do not result in an ARP response will be re-transmitted a\r
maximum of ipconfigMAX_ARP_RETRANSMISSIONS times before the ARP request is\r
aborted. */\r
#define ipconfigMAX_ARP_RETRANSMISSIONS ( 5 )\r
\r
/* ipconfigMAX_ARP_AGE defines the maximum time between an entry in the ARP\r
table being created or refreshed and the entry being removed because it is stale.\r
New ARP requests are sent for ARP cache entries that are nearing their maximum\r
age.  ipconfigMAX_ARP_AGE is specified in tens of seconds, so a value of 150 is\r
equal to 1500 seconds (or 25 minutes). */\r
#define ipconfigMAX_ARP_AGE                     150\r
\r
/* Implementing FreeRTOS_inet_addr() necessitates the use of string handling\r
routines, which are relatively large.  To save code space the full\r
FreeRTOS_inet_addr() implementation is made optional, and a smaller and faster\r
alternative called FreeRTOS_inet_addr_quick() is provided.  FreeRTOS_inet_addr()\r
takes an IP in decimal dot format (for example, "192.168.0.1") as its parameter.\r
FreeRTOS_inet_addr_quick() takes an IP address as four separate numerical octets\r
(for example, 192, 168, 0, 1) as its parameters.  If\r
ipconfigINCLUDE_FULL_INET_ADDR is set to 1 then both FreeRTOS_inet_addr() and\r
FreeRTOS_indet_addr_quick() are available.  If ipconfigINCLUDE_FULL_INET_ADDR is\r
not set to 1 then only FreeRTOS_indet_addr_quick() is available. */\r
#define ipconfigINCLUDE_FULL_INET_ADDR  1\r
\r
/* ipconfigNUM_NETWORK_BUFFERS defines the total number of network buffer that\r
are available to the IP stack.  The total number of network buffers is limited\r
to ensure the total amount of RAM that can be consumed by the IP stack is capped\r
to a pre-determinable value. */\r
#define ipconfigNUM_NETWORK_BUFFERS             10\r
\r
/* A FreeRTOS queue is used to send events from application tasks to the IP\r
stack.  ipconfigEVENT_QUEUE_LENGTH sets the maximum number of events that can\r
be queued for processing at any one time.  The event queue must be a minimum of\r
5 greater than the total number of network buffers. */\r
#define ipconfigEVENT_QUEUE_LENGTH              ( ipconfigNUM_NETWORK_BUFFERS + 5 )\r
\r
/* The address of a socket is the combination of its IP address and its port\r
number.  FreeRTOS_bind() is used to manually allocate a port number to a socket\r
(to 'bind' the socket to a port), but manual binding is not normally necessary\r
for client sockets (those sockets that initiate outgoing connections rather than\r
wait for incoming connections on a known port number).  If\r
ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 1 then calling\r
FreeRTOS_sendto() on a socket that has not yet been bound will result in the IP\r
stack automatically binding the socket to a port number from the range\r
socketAUTO_PORT_ALLOCATION_START_NUMBER to 0xffff.  If\r
ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 0 then calling FreeRTOS_sendto()\r
on a socket that has not yet been bound will result in the send operation being\r
aborted. */\r
#define ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND 1\r
\r
/* Defines the Time To Live (TTL) values used in outgoing UDP packets. */\r
#define updconfigIP_TIME_TO_LIVE                128\r
\r
/* If ipconfigCAN_FRAGMENT_OUTGOING_PACKETS is set to 1 then UDP packets that\r
contain more data than will fit in a single network frame will be fragmented\r
across multiple IP packets.  Also see the ipconfigNETWORK_MTU setting.  If\r
ipconfigCAN_FRAGMENT_OUTGOING_PACKETS is 1 then (ipconfigNETWORK_MTU - 28) must\r
be divisible by 8.  Setting ipconfigCAN_FRAGMENT_OUTGOING_PACKETS to 1 will\r
increase both the code size and execution time. */\r
#define ipconfigCAN_FRAGMENT_OUTGOING_PACKETS 0\r
\r
/* The MTU is the maximum number of bytes the payload of a network frame can\r
contain.  For normal Ethernet V2 frames the maximum MTU is 1500.  Setting a\r
lower value can save RAM, depending on the buffer management scheme used.  If\r
ipconfigCAN_FRAGMENT_OUTGOING_PACKETS is 1 then (ipconfigNETWORK_MTU - 28) must\r
be divisible by 8. */\r
#define ipconfigNETWORK_MTU 1500 /* Leave at 1500 for SAM4E. */\r
\r
/* Set ipconfigUSE_DNS to 1 to include a basic DNS client/resolver.  DNS is used\r
through the FreeRTOS_gethostbyname() API function. */\r
#define ipconfigUSE_DNS         1\r
\r
/* If ipconfigREPLY_TO_INCOMING_PINGS is set to 1 then the IP stack will\r
generate replies to incoming ICMP echo (ping) requests. */\r
#define ipconfigREPLY_TO_INCOMING_PINGS                         1\r
\r
/* If ipconfigSUPPORT_OUTGOING_PINGS is set to 1 then the\r
FreeRTOS_SendPingRequest() API function is available. */\r
#define ipconfigSUPPORT_OUTGOING_PINGS                          1\r
\r
/* If ipconfigSUPPORT_SELECT_FUNCTION is set to 1 then the FreeRTOS_select()\r
(and associated) API function is available. */\r
#define ipconfigSUPPORT_SELECT_FUNCTION                         1\r
\r
/* Used for stack testing only, and must be implemented in the network\r
interface. */\r
#define updconfigLOOPBACK_ETHERNET_PACKETS      0\r
\r
/* If ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES is set to 1 then Ethernet frames\r
that are not in Ethernet II format will be dropped.  This option is included for\r
potential future IP stack developments. */\r
#define ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES 1\r
\r
/* If ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES is set to 1 then it is the\r
responsibility of the Ethernet interface to filter out packets that are of no\r
interest.  If the Ethernet interface does not implement this functionality, then\r
set ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES to 0 to have the IP stack\r
perform the filtering instead (it is much less efficient for the stack to do it\r
because the packet will already have been passed into the stack).  If the\r
Ethernet driver does all the necessary filtering in hardware then software\r
filtering can be removed by using a value other than 1 or 0. */\r
#define ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES     0\r
\r
/* If ipconfigETHERNET_DRIVER_ADDS_UDP_CHECKSUM is set to 1 then a UDP checksum\r
will not be calculated and added to a packet before the packet is sent to the\r
hardware for transmission. */\r
#define ipconfigETHERNET_DRIVER_ADDS_UDP_CHECKSUM       0\r
\r
/* If ipconfigETHERNET_DRIVER_ADDS_IP_CHECKSUM is set to 1 then an IP checksum\r
will not be calculated and added to a packet before the packet is sent to the\r
hardware for transmission. */\r
#define ipconfigETHERNET_DRIVER_ADDS_IP_CHECKSUM        0\r
\r
/* If ipconfigETHERNET_DRIVER_CHECKS_IP_CHECKSUM is set to 1 then the IP\r
checksum will be ignored on incoming packets on the assumption IP packets with\r
an invalid checksum are not passed to the stack. */\r
#define ipconfigETHERNET_DRIVER_CHECKS_IP_CHECKSUM      0\r
\r
/* If ipconfigETHERNET_DRIVER_CHECKS_UDP_CHECKSUM is set to 1 then the UDP\r
checksum will be ignored on incoming packets on the assumption the UDP packets\r
with an invalid checksum are not passed to the stack. */\r
#define ipconfigETHERNET_DRIVER_CHECKS_UDP_CHECKSUM 0\r
\r
/* Set ipconfigFREERTOS_PLUS_NABTO to 1 to support the Nabto protocol, or 0 to\r
exclude support for the Nabto protocol.  If ipconfigFREERTOS_PLUS_NABTO is set\r
to one then the project must build the Nabto source code (or reference a\r
pre-build Nabto library. */\r
#define ipconfigFREERTOS_PLUS_NABTO                                     0\r
\r
/* Sets the size of the stack used by the Nabto service task.  The Nabto event\r
handler executes in the context of the Nabto service task.  If the event handler\r
uses a lot of stack then it is possible the value set here will need to be\r
increased.  It is recommended to have FreeRTOS stack overflow checking turned\r
on during development (see the configCHECK_FOR_STACK_OVERFLOW in\r
FreeRTOSConfig.h and in the documentation. */\r
#define ipconfigNABTO_TASK_STACK_SIZE ( configMINIMAL_STACK_SIZE * 2 )\r
\r
/* Sets the priority of the Nabto service task.  This is a standard FreeRTOS\r
task priority so can take values between 0 (the lowest priority) and\r
configMAX_PRIORITIES - 1 (the highest priority).  Also see the definition of\r
ipconfigUDP_TASK_PRIORITY.  This would normally be set to be either one higher\r
or one lower than ipconfigUDP_TASK_PRIORITY, depending on the application. */\r
#define ipconfigNABTO_TASK_PRIORITY      ( ipconfigUDP_TASK_PRIORITY + 1 )\r
\r
/* The windows simulator cannot really simulate MAC interrupts, and needs to\r
block occasionally to allow other tasks to run. */\r
#ifdef _WINDOWS_\r
        #define configWINDOWS_MAC_INTERRUPT_SIMULATOR_DELAY ( 3 / portTICK_PERIOD_MS )\r
#endif\r
\r
/* The example IP trace macros are included here so the definitions are\r
available in all the FreeRTOS+UDP source files. */\r
#include "DemoIPTrace.h"\r
\r
#endif /* FREERTOS_IP_CONFIG_H */\r