FreeRTOS+TCP NetworkInterface for STM32F7xx - hard fault after ethernet mac interrupt callback

Hi,

I’m using the latest FreeRTOS+TCP network interface on stm32f767zi(nucleo-f767zi board). after a little bit tweaks following the forum topics in the archive(replacing st hal - stm32f7xx_hal_eth.h/c, add HAL_ETH_MspInit() etc.), I can compile and load the project but it’s not working. after a little bit debug. I find after the ethernet mac interrupt enabled, the HAL_ETH_IRQHandler will hit and HAL_ETH_TxCpltCallback called then enter into hard fault. check the call stack, there is a signal handler 0xffff fffd before the callback. seems like the behavior of ISR_Vector corrupted. when stepping, I can go further then HAL_ETH_RxCpltCallback will be called then hard fault(my understanding, DHCP enabled, there are several packets Tx/Rx for init process to bring up the network).

I have no clue what’s wrong/what’s missing. I have checked the ethernet driver code seems no flaw. I have read the application note of mpu(memory protection unit) and even tried i-cache/d-cache/mpu disabled but the same result. for debug printf I also checked it’s implemented with queue and handle by a dedicate log task. I also tried to add a semaphore to sync the logging.

I’m putting the ethernet mac dma descriptors on the last 512Byte sram of stm32f767zi(0x2007 fe00 - Rx, 0x2007 ff00 - Tx, sharable, non-cacheable, non-bufferable device memory). the last 128K byte sram as network buffer(0x2006 0000 - 0x2008 0000, shareable, non-cacheable, bufferable, normal memory).

any hints ?

thanks.

I suspect this is an exception return code, not a return address. Not that that helps you.

Hi, the latest network interface can be found here

Also please make sure that you use the stm32fxx_hal_eth.c that is included in the directory.

void ETH_IRQHandler( void )
{
    HAL_ETH_IRQHandler( &xETH );
}

void HAL_ETH_IRQHandler(ETH_HandleTypeDef *heth)
{
    HAL_ETH_TxCpltCallback( heth );
}

void HAL_ETH_TxCpltCallback( ETH_HandleTypeDef *heth )
{
    if( xEMACTaskHandle != NULL )
    {
        vTaskNotifyGiveFromISR( xEMACTaskHandle, &xHigherPriorityTaskWoken );
        portYIELD_FROM_ISR( xHigherPriorityTaskWoken );
    }
}

This code doesn’t look really complicated.

Did the initialisation go well?

Often, an STM32F7xx has a RMII interface, is that also true on your board? If so, ipconfigUSE_RMII should be defined as 1.
Indeed, you have to provide a HAL_ETH_MspInit() function that sets all GPIO ports and assign their proper (peripheral) function.

Can you confirm that the ETH_IRQHandler() from NetworkInterface is being called?

When you have caching disabled, it doesn’t matter where you put the DMA buffers.

Could you attach your FreeRTOSIPConfig.h please?

Hi Hein,

thanks for your help hand.

I’m using the network interface from freertos repo:

what’s the difference between these two?

I have added HAL_ETH_MspInit() and enabled RMII, the breakpoint in ETH_IRQHandler() is being called, just hard fault after portYIELD_FROM_ISR()(both TxCpltCallback and RxCpltCallback):

void HAL_ETH_TxCpltCallback( ETH_HandleTypeDef *heth )
{
if( xEMACTaskHandle != NULL )
{
vTaskNotifyGiveFromISR( xEMACTaskHandle, &xHigherPriorityTaskWoken );
portYIELD_FROM_ISR( xHigherPriorityTaskWoken );
}
}

I will check the hard fault registers to identify the source of fault and let you know soon(together with my FreeRTOSConfig.h).

appreciate the help and thanks.

I would recommend to use the newer STM32Fxx driver. That works for both the STM32F2xx, STM32F4xx and STM32F7xx. You will define STM32F7xx when compiling it.

Hi Hein,

understood.

I have a try with it. still the same error.

so I put the breakpoint on the entry of HardFault_Handler() and checked the CFSR(configurable fault status register – 0xe000ed28), the value is 0x40000.

this is a forced usage fault(INVPC – attempt to do exception with bad value in EXEC_RETURN number).

Checked the core registers value, it shows pc = 0x804 3dc8, lr = 0x804 3fc9.

The pc is instruction “isb sy” inside ulTaskNotifyTake(from the disassembly), lr is instruction “ldr r3, [pc, #44] inside prvAddCurrentTaskToDelayedList.

From my understanding, lr should be 0xfffffffd(as the lr value when it enter into isr - handler mode), which is thread mode, non-fpu, from psp, use psp per ARM docs.

But here lr = 0x804 3fc9( this is my understanding why INVPC bit is set as the EXEC_RETURN value is wrong).

I have checked the port.c code of freertos porting for arm-cm7, no error find.

I think your ethernet driver is working, just need further investigate why lr have been modified.

is it due to some wrong configurations, for my code inside isr, called yield_from_isr() inside the HAL_ETH_TxCpltCallback/HAL_ETH_RxCpltCallback(), corrupt the lr ?

thanks again for the helpful hand.

Hi Hein,

here is my FreeRTOSIPConfig.h :

#ifndef FREERTOS_IP_CONFIG_H
#define FREERTOS_IP_CONFIG_H

/* Prototype for the function used to print out. In this case it prints to the

  • console before the network is connected then a UDP port after the network has
  • connected. */
    extern void vLoggingPrintf( const char * pcFormatString,
    … );

/* Set to 1 to print out debug messages. If ipconfigHAS_DEBUG_PRINTF is set to

  • 1 then FreeRTOS_debug_printf should be defined to the function used to print
  • out the debugging messages. */
    #define ipconfigHAS_DEBUG_PRINTF 0
    #if ( ipconfigHAS_DEBUG_PRINTF == 1 )
    #define FreeRTOS_debug_printf( X ) configPRINTF( X )
    #endif

/* Set to 1 to print out non debugging messages, for example the output of the

  • FreeRTOS_netstat() command, and ping replies. If ipconfigHAS_PRINTF is set to 1
  • then FreeRTOS_printf should be set to the function used to print out the
  • messages. */
    #define ipconfigHAS_PRINTF 1
    #if ( ipconfigHAS_PRINTF == 1 )
    #define FreeRTOS_printf( X ) configPRINTF( X )
    #endif

/* Define the byte order of the target MCU (the MCU FreeRTOS+TCP is executing

  • on). Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */
    #define ipconfigBYTE_ORDER pdFREERTOS_LITTLE_ENDIAN

/* If the network card/driver includes checksum offloading (IP/TCP/UDP checksums)

  • then set ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
  • stack repeating the checksum calculations. */
    #define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM 1

/* The TX checksum will be checked and calculated by the STM32H7 Ethernet

  • peripheral. */
    #define ipconfigDRIVER_INCLUDED_TX_IP_CHECKSUM ( 1 )

/* Several API’s will block until the result is known, or the action has been

  • performed, for example FreeRTOS_send() and FreeRTOS_recv(). The timeouts can be
  • set per socket, using setsockopt(). If not set, the times below will be
  • used as defaults. */
    #define ipconfigSOCK_DEFAULT_RECEIVE_BLOCK_TIME ( 10000 )
    #define ipconfigSOCK_DEFAULT_SEND_BLOCK_TIME ( 10000 )

/* Include support for DNS caching. For TCP, having a small DNS cache is very

  • useful. When a cache is present, ipconfigDNS_REQUEST_ATTEMPTS can be kept low
  • and also DNS may use small timeouts. If a DNS reply comes in after the DNS
  • socket has been destroyed, the result will be stored into the cache. The next
  • call to FreeRTOS_gethostbyname() will return immediately, without even creating
  • a socket. */
    #define ipconfigUSE_DNS_CACHE ( 1 )
    #define ipconfigDNS_REQUEST_ATTEMPTS ( 2 )

/* The IP stack executes it its own task (although any application task can make

  • use of its services through the published sockets API). ipconfigUDP_TASK_PRIORITY
  • sets the priority of the task that executes the IP stack. The priority is a
  • standard FreeRTOS task priority so can take any value from 0 (the lowest
  • priority) to (configMAX_PRIORITIES - 1) (the highest priority).
  • configMAX_PRIORITIES is a standard FreeRTOS configuration parameter defined in
  • FreeRTOSConfig.h, not FreeRTOSIPConfig.h. Consideration needs to be given as to
  • the priority assigned to the task executing the IP stack relative to the
  • priority assigned to tasks that use the IP stack. */
    #define ipconfigIP_TASK_PRIORITY ( configMAX_PRIORITIES - 2 )

/* The size, in words (not bytes), of the stack allocated to the FreeRTOS+TCP

  • task. This setting is less important when the FreeRTOS Win32 simulator is used
  • as the Win32 simulator only stores a fixed amount of information on the task
  • stack. FreeRTOS includes optional stack overflow detection, see:
  • http://www.freertos.org/Stacks-and-stack-overflow-checking.html. */
    #define ipconfigIP_TASK_STACK_SIZE_WORDS ( configMINIMAL_STACK_SIZE * 5 )

/* ipconfigRAND32() is called by the IP stack to generate random numbers for

  • things such as a DHCP transaction number or initial sequence number. Random
  • number generation is performed via this macro to allow applications to use their
  • own random number generation method. For example, it might be possible to
  • generate a random number by sampling noise on an analogue input. */
    extern uint32_t ulRand();
    #define ipconfigRAND32() ulRand()

/* If ipconfigUSE_NETWORK_EVENT_HOOK is set to 1 then FreeRTOS+TCP will call the

/* Sockets have a send block time attribute. If FreeRTOS_sendto() is called but

  • a network buffer cannot be obtained then the calling task is held in the Blocked
  • state (so other tasks can continue to executed) until either a network buffer
  • becomes available or the send block time expires. If the send block time expires
  • then the send operation is aborted. The maximum allowable send block time is
  • capped to the value set by ipconfigMAX_SEND_BLOCK_TIME_TICKS. Capping the
  • maximum allowable send block time prevents prevents a deadlock occurring when
  • all the network buffers are in use and the tasks that process (and subsequently
  • free) the network buffers are themselves blocked waiting for a network buffer.
  • ipconfigMAX_SEND_BLOCK_TIME_TICKS is specified in RTOS ticks. A time in
  • milliseconds can be converted to a time in ticks by dividing the time in
  • milliseconds by portTICK_PERIOD_MS. */
    #define ipconfigUDP_MAX_SEND_BLOCK_TIME_TICKS ( 5000 / portTICK_PERIOD_MS )

/* If ipconfigUSE_DHCP is 1 then FreeRTOS+TCP will attempt to retrieve an IP

  • address, netmask, DNS server address and gateway address from a DHCP server. If
  • ipconfigUSE_DHCP is 0 then FreeRTOS+TCP will use a static IP address. The
  • stack will revert to using the static IP address even when ipconfigUSE_DHCP is
  • set to 1 if a valid configuration cannot be obtained from a DHCP server for any
  • reason. The static configuration used is that passed into the stack by the
  • FreeRTOS_IPInit() function call. */
    #define ipconfigUSE_DHCP 1
    #define ipconfigDHCP_REGISTER_HOSTNAME 1
    #define ipconfigDHCP_USES_UNICAST 1

/* If ipconfigDHCP_USES_USER_HOOK is set to 1 then the application writer must

  • provide an implementation of the DHCP callback function,
  • xApplicationDHCPUserHook(). */
    #define ipconfigUSE_DHCP_HOOK 0

/* When ipconfigUSE_DHCP is set to 1, DHCP requests will be sent out at

  • increasing time intervals until either a reply is received from a DHCP server
  • and accepted, or the interval between transmissions reaches
  • ipconfigMAXIMUM_DISCOVER_TX_PERIOD. The IP stack will revert to using the
  • static IP address passed as a parameter to FreeRTOS_IPInit() if the
  • re-transmission time interval reaches ipconfigMAXIMUM_DISCOVER_TX_PERIOD without
  • a DHCP reply being received. */
    #define ipconfigMAXIMUM_DISCOVER_TX_PERIOD
    ( 120000 / portTICK_PERIOD_MS )

/* The ARP cache is a table that maps IP addresses to MAC addresses. The IP

  • stack can only send a UDP message to a remove IP address if it knowns the MAC
  • address associated with the IP address, or the MAC address of the router used to
  • contact the remote IP address. When a UDP message is received from a remote IP
  • address the MAC address and IP address are added to the ARP cache. When a UDP
  • message is sent to a remote IP address that does not already appear in the ARP
  • cache then the UDP message is replaced by a ARP message that solicits the
  • required MAC address information. ipconfigARP_CACHE_ENTRIES defines the maximum
  • number of entries that can exist in the ARP table at any one time. */
    #define ipconfigARP_CACHE_ENTRIES 6

/* ARP requests that do not result in an ARP response will be re-transmitted a

  • maximum of ipconfigMAX_ARP_RETRANSMISSIONS times before the ARP request is
  • aborted. */
    #define ipconfigMAX_ARP_RETRANSMISSIONS ( 5 )

/* ipconfigMAX_ARP_AGE defines the maximum time between an entry in the ARP

  • table being created or refreshed and the entry being removed because it is stale.
  • New ARP requests are sent for ARP cache entries that are nearing their maximum
  • age. ipconfigMAX_ARP_AGE is specified in tens of seconds, so a value of 150 is
  • equal to 1500 seconds (or 25 minutes). */
    #define ipconfigMAX_ARP_AGE 150

/* Implementing FreeRTOS_inet_addr() necessitates the use of string handling

  • routines, which are relatively large. To save code space the full
  • FreeRTOS_inet_addr() implementation is made optional, and a smaller and faster
  • alternative called FreeRTOS_inet_addr_quick() is provided. FreeRTOS_inet_addr()
  • takes an IP in decimal dot format (for example, “192.168.0.1”) as its parameter.
  • FreeRTOS_inet_addr_quick() takes an IP address as four separate numerical octets
  • (for example, 192, 168, 0, 1) as its parameters. If
  • ipconfigINCLUDE_FULL_INET_ADDR is set to 1 then both FreeRTOS_inet_addr() and
  • FreeRTOS_indet_addr_quick() are available. If ipconfigINCLUDE_FULL_INET_ADDR is
  • not set to 1 then only FreeRTOS_indet_addr_quick() is available. */
    #define ipconfigINCLUDE_FULL_INET_ADDR 1

/* ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS defines the total number of network buffer that

  • are available to the IP stack. The total number of network buffers is limited
  • to ensure the total amount of RAM that can be consumed by the IP stack is capped
  • to a pre-determinable value. */
    #define ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS 60

/* A FreeRTOS queue is used to send events from application tasks to the IP

  • stack. ipconfigEVENT_QUEUE_LENGTH sets the maximum number of events that can
  • be queued for processing at any one time. The event queue must be a minimum of
  • 5 greater than the total number of network buffers. */
    #define ipconfigEVENT_QUEUE_LENGTH
    ( ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS + 5 )

/* The address of a socket is the combination of its IP address and its port

  • number. FreeRTOS_bind() is used to manually allocate a port number to a socket
  • (to ‘bind’ the socket to a port), but manual binding is not normally necessary
  • for client sockets (those sockets that initiate outgoing connections rather than
  • wait for incoming connections on a known port number). If
  • ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 1 then calling
  • FreeRTOS_sendto() on a socket that has not yet been bound will result in the IP
  • stack automatically binding the socket to a port number from the range
  • socketAUTO_PORT_ALLOCATION_START_NUMBER to 0xffff. If
  • ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 0 then calling FreeRTOS_sendto()
  • on a socket that has not yet been bound will result in the send operation being
  • aborted. */
    #define ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND 1

/* Defines the Time To Live (TTL) values used in outgoing UDP packets. /
#define ipconfigUDP_TIME_TO_LIVE 128
/
Also defined in FreeRTOSIPConfigDefaults.h. */
#define ipconfigTCP_TIME_TO_LIVE 128

/* USE_TCP: Use TCP and all its features. */
#define ipconfigUSE_TCP ( 1 )

/* USE_WIN: Let TCP use windowing mechanism. */
#define ipconfigUSE_TCP_WIN ( 0 )

/* The MTU is the maximum number of bytes the payload of a network frame can

  • contain. For normal Ethernet V2 frames the maximum MTU is 1500. Setting a
  • lower value can save RAM, depending on the buffer management scheme used. If
  • ipconfigCAN_FRAGMENT_OUTGOING_PACKETS is 1 then (ipconfigNETWORK_MTU - 28) must
  • be divisible by 8. */
    #define ipconfigNETWORK_MTU 1500

/* Set ipconfigUSE_DNS to 1 to include a basic DNS client/resolver. DNS is used

  • through the FreeRTOS_gethostbyname() API function. */
    #define ipconfigUSE_DNS 1

/* If ipconfigREPLY_TO_INCOMING_PINGS is set to 1 then the IP stack will

  • generate replies to incoming ICMP echo (ping) requests. */
    #define ipconfigREPLY_TO_INCOMING_PINGS 1

/* If ipconfigSUPPORT_OUTGOING_PINGS is set to 1 then the

  • FreeRTOS_SendPingRequest() API function is available. */
    #define ipconfigSUPPORT_OUTGOING_PINGS 0

/* If ipconfigSUPPORT_SELECT_FUNCTION is set to 1 then the FreeRTOS_select()

  • (and associated) API function is available. */
    #define ipconfigSUPPORT_SELECT_FUNCTION 0

/* If ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES is set to 1 then Ethernet frames

  • that are not in Ethernet II format will be dropped. This option is included for
  • potential future IP stack developments. */
    #define ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES 1

/* If ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES is set to 1 then it is the

  • responsibility of the Ethernet interface to filter out packets that are of no
  • interest. If the Ethernet interface does not implement this functionality, then
  • set ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES to 0 to have the IP stack
  • perform the filtering instead (it is much less efficient for the stack to do it
  • because the packet will already have been passed into the stack). If the
  • Ethernet driver does all the necessary filtering in hardware then software
  • filtering can be removed by using a value other than 1 or 0. */
    #define ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES 1

/* The windows simulator cannot really simulate MAC interrupts, and needs to

  • block occasionally to allow other tasks to run. */
    #define configWINDOWS_MAC_INTERRUPT_SIMULATOR_DELAY ( 20 / portTICK_PERIOD_MS )

/* Advanced only: in order to access 32-bit fields in the IP packets with

  • 32-bit memory instructions, all packets will be stored 32-bit-aligned,
  • plus 16-bits. This has to do with the contents of the IP-packets: all
  • 32-bit fields are 32-bit-aligned, plus 16-bit. */
    #define ipconfigPACKET_FILLER_SIZE 2
    #define ipconfigBUFFER_PADDING 8

/* Define the size of the pool of TCP window descriptors. On the average, each

  • TCP socket will use up to 2 x 6 descriptors, meaning that it can have 2 x 6
  • outstanding packets (for Rx and Tx). When using up to 10 TP sockets
  • simultaneously, one could define TCP_WIN_SEG_COUNT as 120. */
    #define ipconfigTCP_WIN_SEG_COUNT 240

/* Each TCP socket has a circular buffers for Rx and Tx, which have a fixed

  • maximum size. Define the size of Rx buffer for TCP sockets. */
    #define ipconfigTCP_RX_BUFFER_LENGTH ( 3000 )

/* Define the size of Tx buffer for TCP sockets. */
#define ipconfigTCP_TX_BUFFER_LENGTH ( 3000 )

/* When using call-back handlers, the driver may check if the handler points to

  • real program memory (RAM or flash) or just has a random non-zero value. */
    #define ipconfigIS_VALID_PROG_ADDRESS( x ) ( ( x ) != NULL )

/* Include support for TCP keep-alive messages. /
#define ipconfigTCP_KEEP_ALIVE ( 1 )
#define ipconfigTCP_KEEP_ALIVE_INTERVAL ( 20 ) /
Seconds. */

/* The socket semaphore is used to unblock the MQTT task. */
#define ipconfigSOCKET_HAS_USER_SEMAPHORE ( 0 )

#define ipconfigSOCKET_HAS_USER_WAKE_CALLBACK ( 1 )
#define ipconfigUSE_CALLBACKS ( 0 )

#ifndef portINLINE
#define portINLINE inline
#endif

void vApplicationMQTTGetKeys( const char ** ppcRootCA,
const char ** ppcClientCert,
const char ** ppcClientPrivateKey );

#define ipconfigZERO_COPY_TX_DRIVER 1
#define ipconfigZERO_COPY_RX_DRIVER 1
#define ipconfigUSE_LINKED_RX_MESSAGES 1

#endif /* FREERTOS_IP_CONFIG_H */

Today I looked up my STM32F7 Discovery and tested it with the latest driver.

Everything worked as expected: the PHY was recognised, the peripheral was initialised and there was communication.

Your IP config file is difficult to read because certain characters /* */ are interpreted for text styles. You can use a source block like this:

~~~c

    /* This is a comment. */
    void function( int n )

~~~

Mind the 2 lines with tildas: begin and end of source code.

But it is easier to attach the files using this button:

image

Please attach both your FreeRTOSConfig.h and FreeRTOSIPConfig.h.

May you should also check basic things like: is there enough heap and stack. Did you define configUSE_MALLOC_FAILED_HOOK and a function vApplicationMallocFailedHook?
What is the value of configCHECK_FOR_STACK_OVERFLOW?
Did you enable configASSERT?

void vAssertCalled( const char *pcFile, uint32_t ulLine );
#define configASSERT( x ) if( ( x ) == 0 ) vAssertCalled( __FILE__, __LINE__ );

Hi Hein,

sorry I can’t upload files…

configUSE_MALLOC_FAILED_HOOK, configCHECK_FOR_STACK_OVERFLOW and vAssertCalled are enabled.

hooks like vApplicationMallocFailedHook are exist too(inside tests/common/iot_test_afr.c).

FreeRTOSConfig.h

/*
FreeRTOS Kernel V10.2.0
Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

 http://aws.amazon.com/freertos
 http://www.FreeRTOS.org
*/

#ifndef FREERTOS_CONFIG_H
#define FREERTOS_CONFIG_H

/* Unity includes for testing. */
#include "unity_internals.h"

/*-----------------------------------------------------------
* Application specific definitions.
*
* These definitions should be adjusted for your particular hardware and
* application requirements.
*
* THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
* FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.
* http://www.freertos.org/a00110.html
*
* The bottom of this file contains some constants specific to running the UDP
* stack in this demo.  Constants specific to FreeRTOS+TCP itself (rather than
* the demo) are contained in FreeRTOSIPConfig.h.
*----------------------------------------------------------*/

/* Ensure stdint is only used by the compiler, and not the assembler. */
#if defined( __ICCARM__ ) || defined( __CC_ARM ) || defined( __GNUC__ )
    #include <stdint.h>
    extern uint32_t SystemCoreClock;
#endif

#define configCPU_CLOCK_HZ                         ( SystemCoreClock )

#define configUSE_DAEMON_TASK_STARTUP_HOOK         0
#define configENABLE_BACKWARD_COMPATIBILITY        1
#define configUSE_PREEMPTION                       1
#define configUSE_PORT_OPTIMISED_TASK_SELECTION    1
#define configMAX_PRIORITIES                       ( 7 )
#define configTICK_RATE_HZ                         ( ( TickType_t )  1000 )
#define configMINIMAL_STACK_SIZE                   ( ( unsigned short ) 128U )
#define configTOTAL_HEAP_SIZE                      ( ( size_t ) ( 80U * 1024U ) )
#define configMAX_TASK_NAME_LEN                    ( 16 )
#define configUSE_TRACE_FACILITY                   1
#define configUSE_16_BIT_TICKS                     0
#define configIDLE_SHOULD_YIELD                    1
#define configUSE_CO_ROUTINES                      0
#define configUSE_MUTEXES                          1
#define configUSE_RECURSIVE_MUTEXES                1
#define configQUEUE_REGISTRY_SIZE                  8
#define configUSE_APPLICATION_TASK_TAG             1
#define configUSE_COUNTING_SEMAPHORES              1
#define configUSE_ALTERNATIVE_API                  0
#define configNUM_THREAD_LOCAL_STORAGE_POINTERS    3      /* FreeRTOS+FAT requires 2 pointers if a CWD is supported. */
#define configRECORD_STACK_HIGH_ADDRESS            1
#define configUSE_POSIX_ERRNO                      1

/* Hook function related definitions. */
#define configUSE_TICK_HOOK                        0
#define configUSE_IDLE_HOOK                        1
#define configUSE_MALLOC_FAILED_HOOK               1
#define configCHECK_FOR_STACK_OVERFLOW             2

/* Software timer related definitions. */
#define configUSE_TIMERS                           1
#define configTIMER_TASK_PRIORITY                  ( configMAX_PRIORITIES - 2 )
#define configTIMER_QUEUE_LENGTH                   10
#define configTIMER_TASK_STACK_DEPTH               ( configMINIMAL_STACK_SIZE * 4 )

/* Event group related definitions. */
#define configUSE_EVENT_GROUPS                     1

/* Run time stats gathering definitions. */
/* FIX ME: Uncomment if you plan to use Tracealyzer.
unsigned long ulGetRunTimeCounterValue( void );
void vConfigureTimerForRunTimeStats( void );
#define configGENERATE_RUN_TIME_STATS    1
#define portCONFIGURE_TIMER_FOR_RUN_TIME_STATS()    vConfigureTimerForRunTimeStats()
#define portGET_RUN_TIME_COUNTER_VALUE()            ulGetRunTimeCounterValue()
*/

/* Co-routine definitions. */
#define configUSE_CO_ROUTINES                   0
#define configMAX_CO_ROUTINE_PRIORITIES         ( 2 )

/* Currently the TCP/IP stack is using dynamic allocation, and the MQTT task is
 * using static allocation. */
#define configSUPPORT_DYNAMIC_ALLOCATION        1
#define configSUPPORT_STATIC_ALLOCATION         1

/* Set the following definitions to 1 to include the API function, or zero
 * to exclude the API function. */
#define INCLUDE_vTaskPrioritySet                1
#define INCLUDE_uxTaskPriorityGet               1
#define INCLUDE_vTaskDelete                     1
#define INCLUDE_vTaskCleanUpResources           0
#define INCLUDE_vTaskSuspend                    1
#define INCLUDE_vTaskDelayUntil                 1
#define INCLUDE_vTaskDelay                      1
#define INCLUDE_uxTaskGetStackHighWaterMark     1
#define INCLUDE_xTaskGetSchedulerState          1
#define INCLUDE_xTimerGetTimerTaskHandle        0
#define INCLUDE_xTaskGetIdleTaskHandle          0
#define INCLUDE_xQueueGetMutexHolder            1
#define INCLUDE_eTaskGetState                   1
#define INCLUDE_xEventGroupSetBitsFromISR       1
#define INCLUDE_xTimerPendFunctionCall          1
#define INCLUDE_xTaskGetCurrentTaskHandle       1
#define INCLUDE_xTaskAbortDelay                 1

/* Cortex-M specific definitions. */
#ifdef __NVIC_PRIO_BITS
    /* __NVIC_PRIO_BITS will be specified when CMSIS is being used. */
    #define configPRIO_BITS    __NVIC_PRIO_BITS
#else
    #define configPRIO_BITS    4                                 /* 8 priority levels. */
#endif

/* This demo makes use of one or more example stats formatting functions.  These
 * format the raw data provided by the uxTaskGetSystemState() function in to human
 * readable ASCII form.  See the notes in the implementation of vTaskList() within
 * FreeRTOS/Source/tasks.c for limitations.  configUSE_STATS_FORMATTING_FUNCTIONS
 * is set to 2 so the formatting functions are included without the stdio.h being
 * included in tasks.c.  That is because this project defines its own sprintf()
 * functions. */
#define configUSE_STATS_FORMATTING_FUNCTIONS    1

/* Assert call defined for debug builds. */
#if defined( __ICCARM__ ) || defined( __ARMCC_VERSION ) || defined( __GNUC__ )
extern void vAssertCalled( const char * pcFile,
                           uint32_t ulLine );
#endif
#define configASSERT( x )    if( ( x ) == 0 )  TEST_ABORT()

/* The function that implements FreeRTOS printf style output, and the macro
 * that maps the configPRINTF() macros to that function. */
#if defined( __ICCARM__ ) || defined( __ARMCC_VERSION ) || defined( __GNUC__ )
extern void vLoggingPrintf( const char * pcFormat, ... );
#endif
#define configPRINTF( X )    vLoggingPrintf X

/* Non-format version thread-safe print */
#if defined( __ICCARM__ ) || defined( __ARMCC_VERSION ) || defined( __GNUC__ )
extern void vLoggingPrint( const char * pcMessage );
#endif
#define configPRINT( X )     vLoggingPrint( X )

/* Map the logging task's printf to the board specific output function. */
#if defined( __ICCARM__ ) || defined( __ARMCC_VERSION ) || defined( __GNUC__ )
#include <stdio.h>
void vMainUARTPrintString( char * pcString );
#endif
#define configPRINT_STRING( X )    vMainUARTPrintString( X );

/* Sets the length of the buffers into which logging messages are written - so
 * also defines the maximum length of each log message. */
#define configLOGGING_MAX_MESSAGE_LENGTH            160

/* Set to 1 to prepend each log message with a message number, the task name,
 * and a time stamp. */
#define configLOGGING_INCLUDE_TIME_AND_TASK_NAME    1

/* The priority at which the tick interrupt runs.  This should probably be kept at 1. */
#define configKERNEL_INTERRUPT_PRIORITY             1

/* The maximum interrupt priority from which FreeRTOS API functions can be called.
 * Only API functions that end in ...FromISR() can be used within interrupts. */
#define configMAX_SYSCALL_INTERRUPT_PRIORITY        ( 1 << 5 )

/* Application specific definitions follow. **********************************/

/* If configINCLUDE_DEMO_DEBUG_STATS is set to one, then a few basic IP trace
 * macros are defined to gather some UDP stack statistics that can then be viewed
 * through the CLI interface. */
#define configINCLUDE_DEMO_DEBUG_STATS       1

/* The size of the global output buffer that is available for use when there
 * are multiple command interpreters running at once (for example, one on a UART
 * and one on TCP/IP).  This is done to prevent an output buffer being defined by
 * each implementation - which would waste RAM.  In this case, there is only one
 * command interpreter running, and it has its own local output buffer, so the
 * global buffer is just set to be one byte long as it is not used and should not
 * take up unnecessary RAM. */
#define configCOMMAND_INT_MAX_OUTPUT_SIZE    1

/* Only used when running in the FreeRTOS Windows simulator.  Defines the
 * priority of the task used to simulate Ethernet interrupts. */
#define configMAC_ISR_SIMULATOR_PRIORITY     ( configMAX_PRIORITIES - 1 )

/* This demo creates a virtual network connection by accessing the raw Ethernet
 * or WiFi data to and from a real network connection.  Many computers have more
 * than one real network port, and configNETWORK_INTERFACE_TO_USE is used to tell
 * the demo which real port should be used to create the virtual port.  The ports
 * available are displayed on the console when the application is executed.  For
 * example, on my development laptop setting configNETWORK_INTERFACE_TO_USE to 4
 * results in the wired network being used, while setting
 * configNETWORK_INTERFACE_TO_USE to 2 results in the wireless network being
 * used. */
#define configNETWORK_INTERFACE_TO_USE       2L

/* The address of an echo server that will be used by the two demo echo client
 * tasks:
 * http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_Echo_Clients.html,
 * http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/UDP_Echo_Clients.html. */
#define configECHO_SERVER_ADDR0              192
#define configECHO_SERVER_ADDR1              168
#define configECHO_SERVER_ADDR2              0
#define configECHO_SERVER_ADDR3              56
#define configTCP_ECHO_CLIENT_PORT           7

/* Default MAC address configuration.  The demo creates a virtual network
 * connection that uses this MAC address by accessing the raw Ethernet/WiFi data
 * to and from a real network connection on the host PC.  See the
 * configNETWORK_INTERFACE_TO_USE definition above for information on how to
 * configure the real network connection to use. */
#define configMAC_ADDR0                      0x00
#define configMAC_ADDR1                      0x11
#define configMAC_ADDR2                      0x22
#define configMAC_ADDR3                      0x33
#define configMAC_ADDR4                      0x44
#define configMAC_ADDR5                      0x21

/* Default IP address configuration.  Used in ipconfigUSE_DHCP is set to 0, or
 * ipconfigUSE_DHCP is set to 1 but a DNS server cannot be contacted. */
#define configIP_ADDR0                       192
#define configIP_ADDR1                       168
#define configIP_ADDR2                       0
#define configIP_ADDR3                       104

/* Default gateway IP address configuration.  Used in ipconfigUSE_DHCP is set to
 * 0, or ipconfigUSE_DHCP is set to 1 but a DNS server cannot be contacted. */
#define configGATEWAY_ADDR0                  192
#define configGATEWAY_ADDR1                  168
#define configGATEWAY_ADDR2                  0
#define configGATEWAY_ADDR3                  1

/* Default DNS server configuration.  OpenDNS addresses are 208.67.222.222 and
 * 208.67.220.220.  Used in ipconfigUSE_DHCP is set to 0, or ipconfigUSE_DHCP is
 * set to 1 but a DNS server cannot be contacted.*/
#define configDNS_SERVER_ADDR0               208
#define configDNS_SERVER_ADDR1               67
#define configDNS_SERVER_ADDR2               222
#define configDNS_SERVER_ADDR3               222

/* Default netmask configuration.  Used in ipconfigUSE_DHCP is set to 0, or
 * ipconfigUSE_DHCP is set to 1 but a DNS server cannot be contacted. */
#define configNET_MASK0                      255
#define configNET_MASK1                      255
#define configNET_MASK2                      255
#define configNET_MASK3                      0

/* The UDP port to which print messages are sent. */
#define configPRINT_PORT                     ( 15000 )

#define configPROFILING                      ( 0 )

/* Pseudo random number generater used by some demo tasks. */
#if defined( __ICCARM__ ) || defined( __ARMCC_VERSION ) || defined( __GNUC__ )
extern uint32_t ulRand();
#endif
//#define configRAND32()    ulRand()

/* Definitions that map the FreeRTOS port interrupt handlers to their CMSIS
 * standard names. */
#define vPortSVCHandler               SVC_Handler
#define xPortPendSVHandler            PendSV_Handler
#define vHardFault_Handler            HardFault_Handler

/* FIX ME: The platform FreeRTOS is running on. */
#define configPLATFORM_NAME    "NUCLEO_F767ZI"

/* Header required for the tracealyzer recorder library. */
/* #include "trcRecorder.h" */

#endif /* FREERTOS_CONFIG_H */

FreeRTOSIPConfig.h

/*
 * FreeRTOS Kernel V10.2.0
 * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */


/*****************************************************************************
*
* See the following URL for configuration information.
* http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_IP_Configuration.html
*
*****************************************************************************/

#ifndef FREERTOS_IP_CONFIG_H
#define FREERTOS_IP_CONFIG_H

/* Prototype for the function used to print out.  In this case it prints to the
 * console before the network is connected then a UDP port after the network has
 * connected. */
extern void vLoggingPrintf( const char * pcFormatString,
                            ... );

/* Set to 1 to print out debug messages.  If ipconfigHAS_DEBUG_PRINTF is set to
 * 1 then FreeRTOS_debug_printf should be defined to the function used to print
 * out the debugging messages. */
#define ipconfigHAS_DEBUG_PRINTF    0
#if ( ipconfigHAS_DEBUG_PRINTF == 1 )
    #define FreeRTOS_debug_printf( X )    configPRINTF( X )
#endif

/* Set to 1 to print out non debugging messages, for example the output of the
 * FreeRTOS_netstat() command, and ping replies.  If ipconfigHAS_PRINTF is set to 1
 * then FreeRTOS_printf should be set to the function used to print out the
 * messages. */
#define ipconfigHAS_PRINTF    1
#if ( ipconfigHAS_PRINTF == 1 )
    #define FreeRTOS_printf( X )    configPRINTF( X )
#endif

/* Define the byte order of the target MCU (the MCU FreeRTOS+TCP is executing
 * on).  Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */
#define ipconfigBYTE_ORDER                         pdFREERTOS_LITTLE_ENDIAN

/* If the network card/driver includes checksum offloading (IP/TCP/UDP checksums)
 * then set ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
 * stack repeating the checksum calculations. */
#define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM     1

/* The TX checksum will be checked and calculated by the STM32H7 Ethernet
 * peripheral. */
#define ipconfigDRIVER_INCLUDED_TX_IP_CHECKSUM		( 1 )

/* Several API's will block until the result is known, or the action has been
 * performed, for example FreeRTOS_send() and FreeRTOS_recv().  The timeouts can be
 * set per socket, using setsockopt().  If not set, the times below will be
 * used as defaults. */
#define ipconfigSOCK_DEFAULT_RECEIVE_BLOCK_TIME    ( 10000 )
#define ipconfigSOCK_DEFAULT_SEND_BLOCK_TIME       ( 10000 )

/* Include support for DNS caching.  For TCP, having a small DNS cache is very
 * useful.  When a cache is present, ipconfigDNS_REQUEST_ATTEMPTS can be kept low
 * and also DNS may use small timeouts.  If a DNS reply comes in after the DNS
 * socket has been destroyed, the result will be stored into the cache.  The next
 * call to FreeRTOS_gethostbyname() will return immediately, without even creating
 * a socket. */
#define ipconfigUSE_DNS_CACHE                      ( 1 )
#define ipconfigDNS_REQUEST_ATTEMPTS               ( 2 )

/* The IP stack executes it its own task (although any application task can make
 * use of its services through the published sockets API). ipconfigUDP_TASK_PRIORITY
 * sets the priority of the task that executes the IP stack.  The priority is a
 * standard FreeRTOS task priority so can take any value from 0 (the lowest
 * priority) to (configMAX_PRIORITIES - 1) (the highest priority).
 * configMAX_PRIORITIES is a standard FreeRTOS configuration parameter defined in
 * FreeRTOSConfig.h, not FreeRTOSIPConfig.h. Consideration needs to be given as to
 * the priority assigned to the task executing the IP stack relative to the
 * priority assigned to tasks that use the IP stack. */
#define ipconfigIP_TASK_PRIORITY                   ( configMAX_PRIORITIES - 2 )

/* The size, in words (not bytes), of the stack allocated to the FreeRTOS+TCP
 * task.  This setting is less important when the FreeRTOS Win32 simulator is used
 * as the Win32 simulator only stores a fixed amount of information on the task
 * stack.  FreeRTOS includes optional stack overflow detection, see:
 * http://www.freertos.org/Stacks-and-stack-overflow-checking.html. */
#define ipconfigIP_TASK_STACK_SIZE_WORDS           ( configMINIMAL_STACK_SIZE * 5 )

/* ipconfigRAND32() is called by the IP stack to generate random numbers for
 * things such as a DHCP transaction number or initial sequence number.  Random
 * number generation is performed via this macro to allow applications to use their
 * own random number generation method.  For example, it might be possible to
 * generate a random number by sampling noise on an analogue input. */
extern uint32_t ulRand();
#define ipconfigRAND32()    ulRand()

/* If ipconfigUSE_NETWORK_EVENT_HOOK is set to 1 then FreeRTOS+TCP will call the
 * network event hook at the appropriate times.  If ipconfigUSE_NETWORK_EVENT_HOOK
 * is not set to 1 then the network event hook will never be called. See:
 * http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_UDP/API/vApplicationIPNetworkEventHook.shtml.
 */
#define ipconfigUSE_NETWORK_EVENT_HOOK           1

/* Sockets have a send block time attribute.  If FreeRTOS_sendto() is called but
 * a network buffer cannot be obtained then the calling task is held in the Blocked
 * state (so other tasks can continue to executed) until either a network buffer
 * becomes available or the send block time expires.  If the send block time expires
 * then the send operation is aborted.  The maximum allowable send block time is
 * capped to the value set by ipconfigMAX_SEND_BLOCK_TIME_TICKS.  Capping the
 * maximum allowable send block time prevents prevents a deadlock occurring when
 * all the network buffers are in use and the tasks that process (and subsequently
 * free) the network buffers are themselves blocked waiting for a network buffer.
 * ipconfigMAX_SEND_BLOCK_TIME_TICKS is specified in RTOS ticks.  A time in
 * milliseconds can be converted to a time in ticks by dividing the time in
 * milliseconds by portTICK_PERIOD_MS. */
#define ipconfigUDP_MAX_SEND_BLOCK_TIME_TICKS    ( 5000 / portTICK_PERIOD_MS )

/* If ipconfigUSE_DHCP is 1 then FreeRTOS+TCP will attempt to retrieve an IP
 * address, netmask, DNS server address and gateway address from a DHCP server.  If
 * ipconfigUSE_DHCP is 0 then FreeRTOS+TCP will use a static IP address.  The
 * stack will revert to using the static IP address even when ipconfigUSE_DHCP is
 * set to 1 if a valid configuration cannot be obtained from a DHCP server for any
 * reason.  The static configuration used is that passed into the stack by the
 * FreeRTOS_IPInit() function call. */
#define ipconfigUSE_DHCP                         1
#define ipconfigDHCP_REGISTER_HOSTNAME           1
#define ipconfigDHCP_USES_UNICAST                1

/* If ipconfigDHCP_USES_USER_HOOK is set to 1 then the application writer must
 * provide an implementation of the DHCP callback function,
 * xApplicationDHCPUserHook(). */
#define ipconfigUSE_DHCP_HOOK                    0

/* When ipconfigUSE_DHCP is set to 1, DHCP requests will be sent out at
 * increasing time intervals until either a reply is received from a DHCP server
 * and accepted, or the interval between transmissions reaches
 * ipconfigMAXIMUM_DISCOVER_TX_PERIOD.  The IP stack will revert to using the
 * static IP address passed as a parameter to FreeRTOS_IPInit() if the
 * re-transmission time interval reaches ipconfigMAXIMUM_DISCOVER_TX_PERIOD without
 * a DHCP reply being received. */
#define ipconfigMAXIMUM_DISCOVER_TX_PERIOD \
    ( 120000 / portTICK_PERIOD_MS )

/* The ARP cache is a table that maps IP addresses to MAC addresses.  The IP
 * stack can only send a UDP message to a remove IP address if it knowns the MAC
 * address associated with the IP address, or the MAC address of the router used to
 * contact the remote IP address.  When a UDP message is received from a remote IP
 * address the MAC address and IP address are added to the ARP cache.  When a UDP
 * message is sent to a remote IP address that does not already appear in the ARP
 * cache then the UDP message is replaced by a ARP message that solicits the
 * required MAC address information.  ipconfigARP_CACHE_ENTRIES defines the maximum
 * number of entries that can exist in the ARP table at any one time. */
#define ipconfigARP_CACHE_ENTRIES                 6

/* ARP requests that do not result in an ARP response will be re-transmitted a
 * maximum of ipconfigMAX_ARP_RETRANSMISSIONS times before the ARP request is
 * aborted. */
#define ipconfigMAX_ARP_RETRANSMISSIONS           ( 5 )

/* ipconfigMAX_ARP_AGE defines the maximum time between an entry in the ARP
 * table being created or refreshed and the entry being removed because it is stale.
 * New ARP requests are sent for ARP cache entries that are nearing their maximum
 * age.  ipconfigMAX_ARP_AGE is specified in tens of seconds, so a value of 150 is
 * equal to 1500 seconds (or 25 minutes). */
#define ipconfigMAX_ARP_AGE                       150

/* Implementing FreeRTOS_inet_addr() necessitates the use of string handling
 * routines, which are relatively large.  To save code space the full
 * FreeRTOS_inet_addr() implementation is made optional, and a smaller and faster
 * alternative called FreeRTOS_inet_addr_quick() is provided.  FreeRTOS_inet_addr()
 * takes an IP in decimal dot format (for example, "192.168.0.1") as its parameter.
 * FreeRTOS_inet_addr_quick() takes an IP address as four separate numerical octets
 * (for example, 192, 168, 0, 1) as its parameters.  If
 * ipconfigINCLUDE_FULL_INET_ADDR is set to 1 then both FreeRTOS_inet_addr() and
 * FreeRTOS_indet_addr_quick() are available.  If ipconfigINCLUDE_FULL_INET_ADDR is
 * not set to 1 then only FreeRTOS_indet_addr_quick() is available. */
#define ipconfigINCLUDE_FULL_INET_ADDR            1

/* ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS defines the total number of network buffer that
 * are available to the IP stack.  The total number of network buffers is limited
 * to ensure the total amount of RAM that can be consumed by the IP stack is capped
 * to a pre-determinable value. */
#define ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS    60

/* A FreeRTOS queue is used to send events from application tasks to the IP
 * stack.  ipconfigEVENT_QUEUE_LENGTH sets the maximum number of events that can
 * be queued for processing at any one time.  The event queue must be a minimum of
 * 5 greater than the total number of network buffers. */
#define ipconfigEVENT_QUEUE_LENGTH \
    ( ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS + 5 )

/* The address of a socket is the combination of its IP address and its port
 * number.  FreeRTOS_bind() is used to manually allocate a port number to a socket
 * (to 'bind' the socket to a port), but manual binding is not normally necessary
 * for client sockets (those sockets that initiate outgoing connections rather than
 * wait for incoming connections on a known port number).  If
 * ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 1 then calling
 * FreeRTOS_sendto() on a socket that has not yet been bound will result in the IP
 * stack automatically binding the socket to a port number from the range
 * socketAUTO_PORT_ALLOCATION_START_NUMBER to 0xffff.  If
 * ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 0 then calling FreeRTOS_sendto()
 * on a socket that has not yet been bound will result in the send operation being
 * aborted. */
#define ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND         1

/* Defines the Time To Live (TTL) values used in outgoing UDP packets. */
#define ipconfigUDP_TIME_TO_LIVE                       128
/* Also defined in FreeRTOSIPConfigDefaults.h. */
#define ipconfigTCP_TIME_TO_LIVE                       128

/* USE_TCP: Use TCP and all its features. */
#define ipconfigUSE_TCP                                ( 1 )

/* USE_WIN: Let TCP use windowing mechanism. */
#define ipconfigUSE_TCP_WIN                            ( 0 )

/* The MTU is the maximum number of bytes the payload of a network frame can
 * contain.  For normal Ethernet V2 frames the maximum MTU is 1500.  Setting a
 * lower value can save RAM, depending on the buffer management scheme used.  If
 * ipconfigCAN_FRAGMENT_OUTGOING_PACKETS is 1 then (ipconfigNETWORK_MTU - 28) must
 * be divisible by 8. */
#define ipconfigNETWORK_MTU                            1500

/* Set ipconfigUSE_DNS to 1 to include a basic DNS client/resolver.  DNS is used
 * through the FreeRTOS_gethostbyname() API function. */
#define ipconfigUSE_DNS                                1

/* If ipconfigREPLY_TO_INCOMING_PINGS is set to 1 then the IP stack will
 * generate replies to incoming ICMP echo (ping) requests. */
#define ipconfigREPLY_TO_INCOMING_PINGS                1

/* If ipconfigSUPPORT_OUTGOING_PINGS is set to 1 then the
 * FreeRTOS_SendPingRequest() API function is available. */
#define ipconfigSUPPORT_OUTGOING_PINGS                 0

/* If ipconfigSUPPORT_SELECT_FUNCTION is set to 1 then the FreeRTOS_select()
 * (and associated) API function is available. */
#define ipconfigSUPPORT_SELECT_FUNCTION                0

/* If ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES is set to 1 then Ethernet frames
 * that are not in Ethernet II format will be dropped.  This option is included for
 * potential future IP stack developments. */
#define ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES      1

/* If ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES is set to 1 then it is the
 * responsibility of the Ethernet interface to filter out packets that are of no
 * interest.  If the Ethernet interface does not implement this functionality, then
 * set ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES to 0 to have the IP stack
 * perform the filtering instead (it is much less efficient for the stack to do it
 * because the packet will already have been passed into the stack).  If the
 * Ethernet driver does all the necessary filtering in hardware then software
 * filtering can be removed by using a value other than 1 or 0. */
#define ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES    1

/* The windows simulator cannot really simulate MAC interrupts, and needs to
 * block occasionally to allow other tasks to run. */
#define configWINDOWS_MAC_INTERRUPT_SIMULATOR_DELAY    ( 20 / portTICK_PERIOD_MS )

/* Advanced only: in order to access 32-bit fields in the IP packets with
 * 32-bit memory instructions, all packets will be stored 32-bit-aligned,
 * plus 16-bits. This has to do with the contents of the IP-packets: all
 * 32-bit fields are 32-bit-aligned, plus 16-bit. */
#define ipconfigPACKET_FILLER_SIZE                     2
#define ipconfigBUFFER_PADDING                         8

/* Define the size of the pool of TCP window descriptors.  On the average, each
 * TCP socket will use up to 2 x 6 descriptors, meaning that it can have 2 x 6
 * outstanding packets (for Rx and Tx).  When using up to 10 TP sockets
 * simultaneously, one could define TCP_WIN_SEG_COUNT as 120. */
#define ipconfigTCP_WIN_SEG_COUNT                      240

/* Each TCP socket has a circular buffers for Rx and Tx, which have a fixed
 * maximum size.  Define the size of Rx buffer for TCP sockets. */
#define ipconfigTCP_RX_BUFFER_LENGTH                   ( 3000 )

/* Define the size of Tx buffer for TCP sockets. */
#define ipconfigTCP_TX_BUFFER_LENGTH                   ( 3000 )

/* When using call-back handlers, the driver may check if the handler points to
 * real program memory (RAM or flash) or just has a random non-zero value. */
#define ipconfigIS_VALID_PROG_ADDRESS( x )    ( ( x ) != NULL )

/* Include support for TCP keep-alive messages. */
#define ipconfigTCP_KEEP_ALIVE                   ( 1 )
#define ipconfigTCP_KEEP_ALIVE_INTERVAL          ( 20 ) /* Seconds. */

/* The socket semaphore is used to unblock the MQTT task. */
#define ipconfigSOCKET_HAS_USER_SEMAPHORE        ( 0 )

#define ipconfigSOCKET_HAS_USER_WAKE_CALLBACK    ( 1 )
#define ipconfigUSE_CALLBACKS                    ( 0 )

#ifndef portINLINE
#define portINLINE                               inline
#endif

void vApplicationMQTTGetKeys( const char ** ppcRootCA,
                              const char ** ppcClientCert,
                              const char ** ppcClientPrivateKey );

#define  ipconfigZERO_COPY_TX_DRIVER   1
#define  ipconfigZERO_COPY_RX_DRIVER   1
#define  ipconfigUSE_LINKED_RX_MESSAGES   1

#endif /* FREERTOS_IP_CONFIG_H */

Thanks for these config files. Just a few remarks, and one might be essential for your project:

#define ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS       60

/* For later: you declare 60 buffers for network packets.
If you looking for RAM space, you might want to decrease this to e.g. 20 */

#define ipconfigUSE_TCP_WIN                          ( 0 )

/* This means that TCP will not use sliding windows.
That is a good choice (less code, less RAM), unless you want fast
TCP transmission. */

#define ipconfigPACKET_FILLER_SIZE                     2

/* ipconfigPACKET_FILLER_SIZE has a value of 2 by default.
Can be taken away here. */

#define ipconfigBUFFER_PADDING                         8

/* Defining ipconfigBUFFER_PADDING might cause an alignment problem,
which might cause an exception.
Can be taken away here. */

Network packets are stored in an array of unsigned bytes. The first byte must be aligned at a (4-byte) word plus 2 bytes. That has to do with the alignment of 4-byte IP addresses.
The Ethernet Header has 14 bytes, which is 3 words plus 2 bytes. So the IP- and other headers will get well aligned.

See also here.

In fact I have not seen a project that needed to change the value of the two macro.s

So if you take away ipconfigBUFFER_PADDING, things might go better, I hope.

Hi Hein,

my linker defined as:

_estack = 0x20060000;    /* end of user mode stack */

/* Generate a link error if heap and stack don't fit into RAM */
/* _Min_Heap_Size = 0x200;      required amount of heap  */
_Min_Heap_Size = 0x2000;      /* required amount of heap  */
_Min_Stack_Size = 0x4000; /* required amount of stack */

/* Specify the memory areas */
MEMORY
{
DTCMRAM (xrw)                   : ORIGIN = 0x20000000, LENGTH = 128K
SRAM (xrw)                      : ORIGIN = 0x20020000, LENGTH = 128K
FREERTOS_HEAP2 (xrw)            : ORIGIN = 0x20040000, LENGTH = 128K
RAM_NO_CACHE_NORMAL (xrw)       : ORIGIN = 0x20060000, LENGTH = 128K
RAM_NO_CACHE_DEVICE (xrw)       : ORIGIN = 0x2007FE00, LENGTH = 512
/* 128KB * 6 sectors = 768KB */
FLASH (rx)      : ORIGIN = 0x8040000, LENGTH = 768K
/* 128KB * 6 sectors = 768KB, leave the last sector 128KB as swap */
FLASH_B2 (rx)      : ORIGIN = 0x8120000, LENGTH = 768K
}

  /* User_heap_stack section, used to check that there is enough RAM left */
  ._user_heap_stack :
  {
    . = ALIGN(8);
    PROVIDE ( end = . );
    PROVIDE ( _end = . );
    . = . + _Min_Heap_Size;
    . = . + _Min_Stack_Size;
    . = ALIGN(8);
  } >DTCMRAM

  .freertos_heap2 (NOLOAD) : {
    . = ALIGN(8);
    *(.freertos_heap2)
    . = ALIGN(8);
  } >FREERTOS_HEAP2 AT>FLASH

  .net_buff (NOLOAD) : {

    *(.pNetBuff)

  } >RAM_NO_CACHE_NORMAL AT>FLASH

  .net_desc (NOLOAD) : {

    . = ABSOLUTE(0x2007FE00);
    *(.RxDecripSection)

    . = ABSOLUTE(0x2007FF00);
    *(.TxDecripSection)

  } >RAM_NO_CACHE_DEVICE AT>FLASH

I’m using heap_5, so I have 2 heaps: ucHeap1[configTOTAL_HEAP_SIZE] = 80K, ucHeap2 = 100K, put under section .freertos_heap2.

per the build report, 128K DTCMAM used 124K, SRAM is totally free, 128K FREERTOS_HEAP2 used 100K as the code initialized(prvInitializeHeap). 128K RAM_NO_CACHE_NORMAL used 90K as net buffer(60 ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS * 1536), 512 Byte RAM_NO_CACHE_DEVICE uaws 384 byte.

before the entry of HardFault_Handler(), the CFSR(configurable fault status register – 0xe000ed28) showed the value is 0x40000, which means a forced usage fault(INVPC – attempt to do exception with bad value in EXEC_RETURN number).

the core registers value auto-saved before the exception enter shows PC = 0x804 3dc8, LR = 0x804 3fc9.

The PC is instruction “isb sy” inside ulTaskNotifyTake(from the disassembly), LR is instruction “ldr r3, [pc, #44] inside prvAddCurrentTaskToDelayedList.

I print current LR in GDB console, which shows LR = 0xfffffffd, this EXC_RETURN value, per ARM’s docs means when exception exit, return to thread mode, use PSP stack, non-FPU context saved. print current PSP is 0x2000 2730.

I’m not clear, how hard fault triggered by bad value in EXEC_RETURN number, this value is typically mirror LR value when enter into exception, or changed due to SPSEL bit set in CONTROL register(switch from MSP to PSP).

thanks.

Hi Hein,

I have tried comment out:

#define ipconfigBUFFER_PADDING                         8

still the same result.

in the linker, I added the alignment requirement too:

  .net_buff (NOLOAD) : {

    . = ALIGN(4);
    *(.pNetBuff)
    . = ALIGN(4);

  } >RAM_NO_CACHE_NORMAL AT>FLASH

I added some code to restore the core registers but similiar finding as manual process:

void prvGetRegistersFromStack( uint32_t * pulFaultStackAddress )
{
    volatile uint32_t r0;
    volatile uint32_t r1;
    volatile uint32_t r2;
    volatile uint32_t r3;
    volatile uint32_t r12;
    volatile uint32_t lr;   // Link register.
    volatile uint32_t pc;   // Program counter.
    volatile uint32_t psr;  // Program status register.

    r0 = pulFaultStackAddress[ 0 ];
    r1 = pulFaultStackAddress[ 1 ];
    r2 = pulFaultStackAddress[ 2 ];
    r3 = pulFaultStackAddress[ 3 ];

    r12 = pulFaultStackAddress[ 4 ];
    lr = pulFaultStackAddress[ 5 ];
    pc = pulFaultStackAddress[ 6 ];
    psr = pulFaultStackAddress[ 7 ];

    // Remove compiler warnings about the variables not being used.
    ( void ) r0;
    ( void ) r1;
    ( void ) r2;
    ( void ) r3;
    ( void ) r12;
    ( void ) lr;   // Link register.
    ( void ) pc;   // Program counter.
    ( void ) psr;  // Program status register.

    // When the following line is hit, the variables contain the register values.
    for( ; ; )
    {
    }
}

void HardFault_Handler( void )
{
    __asm volatile
    (
        " tst lr, #4                                                \n"
        " ite eq                                                    \n"
        " mrseq r0, msp                                             \n"
        " mrsne r0, psp                                             \n"
        " ldr r1, [r0, #24]                                         \n"
        " ldr r2, handler2_address_const                            \n"
        " bx r2                                                     \n"
        " handler2_address_const: .word prvGetRegistersFromStack    \n"
    );
}

the call stack when hit HardFault_Handler() is:

HardFault_Handler() at stm32f7xx_it.c:122 0x8040f58
<signal handler called>() at 0xfffffffd
HAL_ETH_TxCpltCallback() at NetworkInterface.c:313 0x806fc1e
prvEMACHandlerTask() at NetworkInterface.c:1,151 0x807046a
pxPortInitialiseStack() at port.c:208 0x8044720

enter into prvGetRegistersFromStack and breakpoint at (void) r0; the call stack is:

prvGetRegistersFromStack() at stm32f7xx_it.c:106 0x8040f46
<signal handler called> at 0xfffffffd
vTaskNotifyGiveFromISR() at tasks.c:5,005 0x8043f38
0x68c

What I normally do when I have an exception, I look for registers with addresses in the flash range, 0x8000000 and up ( for STMF32 ).

Then I open the LSS listing of the project and look up these addresses. When an addresses is ‘odd’, strip off the LSB ( the Thumb-mode bit ).

The register values will also change when you use a different optimisation level, -Os in stead of -O0.

I also wonder about the stack during an ISR. Richard knows a lot more about this subject. But I remember that in some ports the stack used in main(), the default application stack, is being recycled and used for ISR stack.

This stack is defined in your linker file xxx.ld:

_estack = 0x20050000;    /* end of RAM */
_Min_Stack_Size = 0x460; /* required amount of stack */

In this example, the last 1120 bytes of RAM are dedicated to the stack.

Hi Hein,

a lot crash course to me : )

do you have a tutorial/project template link recommend to me(for f7) ?

I try to create a project from scratch instead of using the code base from other platform.

I think your ethernet driver is working and very high chance it’s other bug…

in this way I can have a clean freertos project working then I can start adding ethernet driver.

I check the code again and f7 reference manual. I will try to use heap_4 instead of heap_5, as f7 do not have discontinuous ram region issue.

I doubt freertos_heap2 may raise issue.

I will try relocate the net descriptor and net buff to DTCMRAM to avoid potential cache issue too.

I read some docs, the core have handler mode and thread mode, handler mode use msp(main stack pointer), thread mode use psp(process stack pointer).

so my understanding, exception use msp only, freertos use psp. task stack is purely under heap.

will let you know the progress.

thanks.

so my understanding, exception use msp only, freertos use psp.

Thanks for looking this up. I had forgotten the details of it.
Exceptions and interrupts use MSP, normal processes use PSP.

Now my question is: if you put a break in an interrupt ( e.g. ETH_IRQHandler() ), what is the value of the MSP ? Is that a reasonable value, somewhere at the end of your RAM? And there is overlap between this stack and your heap?

I will try to use heap_4 instead of heap_5, as f7 do not have discontinuous ram region issue.

heap_5 still has an advantage: you don’t know in advance how much RAM is left for your heap. Once everything is compiled and linked, the symbol _end is known. That marks the and of objects in RAM, and the beginning of the HEAP. The top of the heap is where the main stack ends.

I doubt freertos_heap2 may raise issue.

All heap_x modules should work. I like the versions 4 and 5, which use the same algorithm.

I will try relocate the net descriptor and net buff to DTCMRAM to avoid potential cache issue.

Yes, good move.

Hi Hein,

do you have a tutorial/project template link recommend to me(for f7) ?

I try to create a project from scratch instead of using the code base from other platform.

I think your ethernet driver is working and very high chance it’s other bug somewhere…

in this way I can have a clean freertos project working then I can start adding ethernet driver.

Hi Hein,

when break at ETH_IRQHandler(), the SP is MSP and value is 0x2005 ffd8, which is almost the end of _estack(0x2006 0000), and is overlap with freertos_heap2(0x2000 4000 - 0x2000 6000, 128K), but freertos_heap2 is 100K hard coded so should not reach this position yet…

the LR is 0xffff fffd, PSP is 0x2000 1400

Good idea, to start from scratch!

I uploaded the linker script that I use for my STM32F746 testing project:
STM32F746NGHx_FLASH.zip (1.8 KB)

Note that the actual memory layout is different in your STM32F767.
And PS, I have the caching enabled by calling SCB_EnableDCache().

I used heap_5.c and use these symbols to calculate the available memory:

    extern uint8_t __bss_end__, _estack, _Min_Stack_Size;
    #define HEAP_START     __bss_end__
    #define HEAP_END       _estack

volatile uint32_t ulHeapSize;
volatile uint8_t *pucHeapStart;
uint32_t ulStackSize = ( uint32_t ) & ( _Min_Stack_Size );
    pucHeapStart = ( uint8_t * ) ( ( ( ( uint32_t ) &HEAP_START ) + 7 ) & ~0x07ul );
    ulHeapSize = ( uint32_t ) ( &HEAP_END - &HEAP_START );
    ulHeapSize &= ~0x07uL;
    ulHeapSize -= ulStackSize;

But for you I recomment first using the simpler heap_4.c.

Hi Hein,

where you put this variables? main.c for prvInitializeHeap() to use ?

from these codes, you use all the free ram as heap.

I find that MSP is using _estack after reset and growing downwards(decrease from 0x2005 0000 as your _estack). PSP is using bss_end and growing upwards(increase from 0x2000 xxxx).

so I’m a little bit confused, is it freertos manage both kernel stack and task stack purely from one heap pool?

extern uint8_t __bss_end__, _estack, _Min_Stack_Size;
    
#define HEAP_START     __bss_end__
#define HEAP_END       _estack

volatile uint32_t ulHeapSize;
volatile uint8_t *pucHeapStart;

uint32_t ulStackSize = ( uint32_t ) & ( _Min_Stack_Size );
pucHeapStart = ( uint8_t * ) ( ( ( ( uint32_t ) &HEAP_START ) + 7 ) & ~0x07ul );
ulHeapSize = ( uint32_t ) ( &HEAP_END - &HEAP_START );
ulHeapSize &= ~0x07uL;
ulHeapSize -= ulStackSize;

could you also help share with me your prvInitializeHeap() ? below is mine I think it’s not good fit for f7(freertos_heap2):

static void prvInitializeHeap( void )
{
    static uint8_t ucHeap1[ configTOTAL_HEAP_SIZE ];
    static uint8_t ucHeap2[ 100 * 1024 ] __attribute__( ( section( ".freertos_heap2" ) ) );

    HeapRegion_t xHeapRegions[] =
    {
        { ( unsigned char * ) ucHeap1, sizeof( ucHeap1 ) },
        { ( unsigned char * ) ucHeap2, sizeof( ucHeap2 ) },
        { NULL,                                        0 }
    };

    vPortDefineHeapRegions( xHeapRegions );
}

I also checked your NetworkInterface.c and linker file, seems you do not use below memory region and sections:

MEMORY
{
Memory_B1(xrw)   : ORIGIN = 0x20010000, LENGTH = 0x80
Memory_B2(xrw)   : ORIGIN = 0x20010080, LENGTH = 0x80
Memory_B3(xrw)   : ORIGIN = 0x2004C000, LENGTH = 0x17d0 
Memory_B4(xrw)   : ORIGIN = 0x2004D7D0, LENGTH = 0x17d0
}
  .RxDecripSection : { *(.RxDescripSection) } >Memory_B1
  .TxDescripSection : { *(.TxDescripSection) } >Memory_B2
  .RxarraySection : { *(.RxBUF) } >Memory_B3
  .TxarraySection : { *(.TxBUF) } >Memory_B4 

I can only find .first_data sections in your NetworkInterface.c and you put it in the first data sections:

  /* Initialized data sections goes into RAM, load LMA copy after code */
  .data : 
  {
    . = ALIGN(4);
    _sdata = .;        /* create a global symbol at data start */
    *(.first_data)     /* .first_data sections */
    *(.data)           /* .data sections */
    *(.data*)          /* .data* sections */

    . = ALIGN(4);
    _edata = .;        /* define a global symbol at data end */
  } >RAM AT> FLASH

my understanding, use zero-copy Tx/Rx driver, I do not need Rx_Buff/Tx_Buff as:

  .RxarraySection : { *(.RxBUF) } >Memory_B3
  .TxarraySection : { *(.TxBUF) } >Memory_B4 

in your code, I do not see them referenced somewhere…

same for DMA Rx/Tx descriptors as:

  .RxDecripSection : { *(.RxDescripSection) } >Memory_B1
  .TxDescripSection : { *(.TxDescripSection) } >Memory_B2

I do not see them referenced in your code.

seems you are using .first_data for network buffer:

/* Ethernet Rx MA Descriptor */
__attribute__ ((aligned (32)))
#if defined(STM32F7xx)
	__attribute__ ((section(".first_data")))
#endif
	ETH_DMADescTypeDef  DMARxDscrTab[ ETH_RXBUFNB ];

#if( ipconfigZERO_COPY_RX_DRIVER == 0 )
	/* Ethernet Receive Buffer */
	__ALIGN_BEGIN uint8_t Rx_Buff[ ETH_RXBUFNB ][ ETH_RX_BUF_SIZE ] __ALIGN_END;
#endif

/* Ethernet Tx DMA Descriptor */
__attribute__ ((aligned (32)))
#if defined(STM32F7xx)
	__attribute__ ((section(".first_data")))
#endif
	ETH_DMADescTypeDef  DMATxDscrTab[ ETH_TXBUFNB ];

#if( ipconfigZERO_COPY_TX_DRIVER == 0 )
	/* Ethernet Transmit Buffer */
	__ALIGN_BEGIN uint8_t Tx_Buff[ ETH_TXBUFNB ][ ETH_TX_BUF_SIZE ] __ALIGN_END;
#endif
static
#if defined(STM32F7xx)
	__attribute__ ((section(".first_data")))
#endif
	uint8_t ucNetworkPackets[ ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS * ETH_MAX_PACKET_SIZE ] __attribute__ ( ( aligned( 32 ) ) );

thanks again.

Hi Hein,

after read some docs and re-visit your latest driver, I have one step ahead:

from the log, seems at least ethernet driver is working, though network buffer is depleted very fast and most of the time is fall in idle task instead of return to my ip-task or test task(I need move forward to solve new issue…)

thanks for your great help though I still do not figure out the root cause of the previous hard fault issue…