Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IPv4/single SAME70 emac race condition #567

Merged
merged 3 commits into from
Nov 3, 2022
Merged

IPv4/single SAME70 emac race condition #567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
06eece0
Implemented Maty's solution
Nov 2, 2022
d89a334
Added a new statistic 'tx_write_fail'
Nov 3, 2022
0c38c80
Uncrustify: triggered by comment.
actions-user Nov 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 64 additions & 48 deletions source/portable/NetworkInterface/DriverSAM/NetworkInterface.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,15 @@
/* This file is included to see if 'CONF_BOARD_ENABLE_CACHE' is defined. */
#include "conf_board.h"

/* The SAME70 family has the possibility of caching RAM.
* 'NETWORK_BUFFERS_CACHED' can be defined in either "conf_eth.h"
* or in "FreeRTOSIPConfig.h".
* For now, NETWORK_BUFFERS_CACHED should be defined as zero.
* D-cache may be enabled.
*/
#if ( NETWORK_BUFFERS_CACHED != 0 )
#error please define this macro as zero
#endif

/* Interrupt events to process. Currently only the Rx event is processed
* although code for other events is included to allow for possible future
Expand Down Expand Up @@ -95,10 +104,9 @@
#define niEMAC_HANDLER_TASK_PRIORITY configMAX_PRIORITIES - 1
#endif

#if ( __DCACHE_PRESENT != 0 ) && defined( CONF_BOARD_ENABLE_CACHE )
#if ( NETWORK_BUFFERS_CACHED != 0 ) && ( __DCACHE_PRESENT != 0 ) && defined( CONF_BOARD_ENABLE_CACHE )
#include "core_cm7.h"
#warning This driver assumes the presence of DCACHE
#define NETWORK_BUFFERS_CACHED 1
#define CACHE_LINE_SIZE 32
#define NETWORK_BUFFER_HEADER_SIZE ( ipconfigPACKET_FILLER_SIZE + 8 )

Expand All @@ -113,26 +121,24 @@
uint32_t size )
{
/* SAME70 does not have clean/invalidate per area. */
/* SCB_CleanInvalidateDCache_by_Addr( ( uint32_t * )addr, size); */
SCB_CleanInvalidateDCache();
SCB_CleanInvalidateDCache_by_Addr( ( uint32_t * ) addr, size );
}
/*-----------------------------------------------------------*/

static void cache_invalidate_by_addr( addr,
size ) \
static void cache_invalidate_by_addr( uint32_t addr,
uint32_t size )
{
/* SAME70 does not have clean/invalidate per area. */
/* SCB_InvalidateDCache_by_Addr( ( uint32_t * )addr, size); */
SCB_InvalidateDCache();
SCB_InvalidateDCache_by_Addr( ( uint32_t * ) addr, size );
}
/*-----------------------------------------------------------*/

#else /* if ( __DCACHE_PRESENT != 0 ) && defined( CONF_BOARD_ENABLE_CACHE ) */
#else /* The DMA buffers are located in non-cached RAM. */
#warning Sure there is no caching?
#define cache_clean_invalidate() do {} while( 0 )
#define cache_clean_invalidate_by_addr( addr, size ) do {} while( 0 )
#define cache_invalidate_by_addr( addr, size ) do {} while( 0 )
#endif /* if ( __DCACHE_PRESENT != 0 ) && defined( CONF_BOARD_ENABLE_CACHE ) */
#endif /* if ( NETWORK_BUFFERS_CACHED != 0 ) && ( __DCACHE_PRESENT != 0 ) && defined( CONF_BOARD_ENABLE_CACHE ) */

/*-----------------------------------------------------------*/

Expand Down Expand Up @@ -186,13 +192,8 @@ static void hand_tx_errors( void );

/*-----------------------------------------------------------*/

/* Bit map of outstanding ETH interrupt events for processing. Currently only
* the Rx interrupt is handled, although code is included for other events to
* enable future expansion. */
static volatile uint32_t ulISREvents;

/* A copy of PHY register 1: 'PHY_REG_01_BMSR' */
static volatile BaseType_t xGMACSwitchRequired;
static BaseType_t xGMACSwitchRequired;

/* LLMNR multicast address. */
static const uint8_t llmnr_mac_address[] = { 0x01, 0x00, 0x5E, 0x00, 0x00, 0xFC };
Expand All @@ -205,8 +206,9 @@ static gmac_device_t gs_gmac_dev;
* related interrupts. */
TaskHandle_t xEMACTaskHandle = NULL;

/* TX buffers that have been sent must be returned to the driver
* using this queue. */
static QueueHandle_t xTxBufferQueue;
int tx_release_count[ 4 ];

/* xTXDescriptorSemaphore is a counting semaphore with
* a maximum count of GMAC_TX_BUFFERS, which is the number of
Expand Down Expand Up @@ -271,21 +273,21 @@ void xRxCallback( uint32_t ulStatus )
if( ( ( ulStatus & GMAC_RSR_REC ) != 0 ) && ( xEMACTaskHandle != NULL ) )
{
/* let the prvEMACHandlerTask know that there was an RX event. */
ulISREvents |= EMAC_IF_RX_EVENT;
/* Only an RX interrupt can wakeup prvEMACHandlerTask. */
vTaskNotifyGiveFromISR( xEMACTaskHandle, ( BaseType_t * ) &xGMACSwitchRequired );
xTaskNotifyFromISR( xEMACTaskHandle, EMAC_IF_RX_EVENT, eSetBits, &( xGMACSwitchRequired ) );
}
}
/*-----------------------------------------------------------*/

/* The following function can be called by gmac_reset_tx_mem().
*/
void returnTxBuffer( uint8_t * puc_buffer )
{
/* Called from a non-ISR context. */
if( xTxBufferQueue != NULL )
{
/* return 'puc_buffer' to the pool of transmission buffers. */
xQueueSend( xTxBufferQueue, &puc_buffer, 0 );
xTaskNotifyGive( xEMACTaskHandle );
ulISREvents |= EMAC_IF_TX_EVENT;
xTaskNotify( xEMACTaskHandle, EMAC_IF_TX_EVENT, eSetBits );
}
}

Expand All @@ -295,11 +297,21 @@ void xTxCallback( uint32_t ulStatus,
if( ( xTxBufferQueue != NULL ) && ( xEMACTaskHandle != NULL ) )
{
/* let the prvEMACHandlerTask know that there was an TX event. */
ulISREvents |= EMAC_IF_TX_EVENT;
/* Wakeup prvEMACHandlerTask. */
vTaskNotifyGiveFromISR( xEMACTaskHandle, ( BaseType_t * ) &xGMACSwitchRequired );
xQueueSendFromISR( xTxBufferQueue, &puc_buffer, ( BaseType_t * ) &xGMACSwitchRequired );
tx_release_count[ 2 ]++;
if( puc_buffer == NULL )
{
/* (GMAC_TSR) Retry Limit Exceeded */
/* Can not send logging, we're in an ISR. */
}
else
{
xQueueSendFromISR( xTxBufferQueue, &puc_buffer, ( BaseType_t * ) &xGMACSwitchRequired );
xTaskNotifyFromISR( xEMACTaskHandle, EMAC_IF_TX_EVENT, eSetBits, &( xGMACSwitchRequired ) );

/* TX statistics. Only works when 'GMAC_STATS'
* is defined as 1. See gmac_SAM.h for more information. */
TX_STAT_INCREMENT( tx_callback );
}
}
}
/*-----------------------------------------------------------*/
Expand Down Expand Up @@ -445,7 +457,9 @@ BaseType_t xNetworkInterfaceInitialise( void )

if( xTXDescriptorSemaphore == NULL )
{
xTXDescriptorSemaphore = xSemaphoreCreateCounting( ( UBaseType_t ) GMAC_TX_BUFFERS, ( UBaseType_t ) GMAC_TX_BUFFERS );
/* When there are N TX descriptors, we want to use
* at most "N-1" simultaneously. */
xTXDescriptorSemaphore = xSemaphoreCreateCounting( ( UBaseType_t ) GMAC_TX_BUFFERS - 1U, ( UBaseType_t ) GMAC_TX_BUFFERS - 1U );
configASSERT( xTXDescriptorSemaphore );
}

Expand Down Expand Up @@ -483,7 +497,6 @@ static void hand_tx_errors( void )
gmac_enable_transmit( GMAC, false );

/* Reinit TX descriptors. */
/* gmac_tx_init(ps_gmac_dev); */
gmac_reset_tx_mem( &gs_gmac_dev );
/* Clear error status. */
gmac_clear_tx_status( GMAC, GMAC_TX_ERRORS );
Expand All @@ -498,7 +511,7 @@ BaseType_t xNetworkInterfaceOutput( NetworkBufferDescriptor_t * const pxDescript
BaseType_t bReleaseAfterSend )
{
/* Do not wait too long for a free TX DMA buffer. */
const TickType_t xBlockTimeTicks = pdMS_TO_TICKS( 50u );
const TickType_t xBlockTimeTicks = pdMS_TO_TICKS( 50U );
uint32_t ulTransmitSize;

ulTransmitSize = pxDescriptor->xDataLength;
Expand All @@ -514,6 +527,8 @@ BaseType_t xNetworkInterfaceOutput( NetworkBufferDescriptor_t * const pxDescript
* statement. */
do
{
uint32_t ulResult;

if( xPhyObject.ulLinkStatusMask == 0ul )
{
/* Do not attempt to send packets as long as the Link Status is low. */
Expand All @@ -531,10 +546,11 @@ BaseType_t xNetworkInterfaceOutput( NetworkBufferDescriptor_t * const pxDescript
if( xSemaphoreTake( xTXDescriptorSemaphore, xBlockTimeTicks ) != pdPASS )
{
/* Time-out waiting for a free TX descriptor. */
tx_release_count[ 3 ]++;
TX_STAT_INCREMENT( tx_enqueue_fail );
break;
}

TX_STAT_INCREMENT( tx_enqueue_ok );
#if ( ipconfigZERO_COPY_TX_DRIVER != 0 )
{
/* Confirm that the pxDescriptor may be kept by the driver. */
Expand All @@ -550,7 +566,12 @@ BaseType_t xNetworkInterfaceOutput( NetworkBufferDescriptor_t * const pxDescript
}
#endif

gmac_dev_write( &gs_gmac_dev, ( void * ) pxDescriptor->pucEthernetBuffer, pxDescriptor->xDataLength );
ulResult = gmac_dev_write( &gs_gmac_dev, ( void * ) pxDescriptor->pucEthernetBuffer, pxDescriptor->xDataLength );

if( ulResult != GMAC_OK )
{
TX_STAT_INCREMENT( tx_write_fail );
}

#if ( ipconfigZERO_COPY_TX_DRIVER != 0 )
{
Expand Down Expand Up @@ -594,7 +615,7 @@ static BaseType_t prvGMACInit( void )

{
/* Set MDC clock divider. */
gmac_set_mdc_clock( GMAC, sysclk_get_cpu_hz() );
gmac_set_mdc_clock( GMAC, sysclk_get_peripheral_hz() );

vPhyInitialise( &xPhyObject, xPHY_Read, xPHY_Write );
xPhyDiscover( &xPhyObject );
Expand Down Expand Up @@ -840,7 +861,7 @@ void vNetworkInterfaceAllocateRAMToBuffers( NetworkBufferDescriptor_t pxNetworkB
static void prvEMACHandlerTask( void * pvParameters )
{
UBaseType_t uxCount;
UBaseType_t uxLowestSemCount = 0;
UBaseType_t uxLowestSemCount = GMAC_TX_BUFFERS + 1;

#if ( ipconfigZERO_COPY_TX_DRIVER != 0 )
NetworkBufferDescriptor_t * pxBuffer;
Expand All @@ -849,6 +870,7 @@ static void prvEMACHandlerTask( void * pvParameters )
BaseType_t xResult = 0;
uint32_t xStatus;
const TickType_t ulMaxBlockTime = pdMS_TO_TICKS( EMAC_MAX_BLOCK_TIME_MS );
uint32_t ulISREvents = 0U;

/* Remove compiler warnings about unused parameters. */
( void ) pvParameters;
Expand Down Expand Up @@ -879,26 +901,21 @@ static void prvEMACHandlerTask( void * pvParameters )
}
#endif /* ( ipconfigHAS_PRINTF != 0 ) */

if( ( ulISREvents & EMAC_IF_ALL_EVENT ) == 0 )
{
/* No events to process now, wait for the next. */
ulTaskNotifyTake( pdFALSE, ulMaxBlockTime );
}
/* Wait for a new event or a time-out. */
xTaskNotifyWait( 0U, /* ulBitsToClearOnEntry */
EMAC_IF_ALL_EVENT, /* ulBitsToClearOnExit */
&( ulISREvents ), /* pulNotificationValue */
ulMaxBlockTime );

if( ( ulISREvents & EMAC_IF_RX_EVENT ) != 0 )
{
ulISREvents &= ~EMAC_IF_RX_EVENT;

/* Wait for the EMAC interrupt to indicate that another packet has been
* received. */
xResult = prvEMACRxPoll();
}

if( ( ulISREvents & EMAC_IF_TX_EVENT ) != 0 )
{
/* Future extension: code to release TX buffers if zero-copy is used. */
ulISREvents &= ~EMAC_IF_TX_EVENT;

while( xQueueReceive( xTxBufferQueue, &pucBuffer, 0 ) != pdFALSE )
{
#if ( ipconfigZERO_COPY_TX_DRIVER != 0 )
Expand All @@ -908,21 +925,21 @@ static void prvEMACHandlerTask( void * pvParameters )
if( pxBuffer != NULL )
{
vReleaseNetworkBufferAndDescriptor( pxBuffer );
tx_release_count[ 0 ]++;
TX_STAT_INCREMENT( tx_release_ok );
}
else
{
tx_release_count[ 1 ]++;
TX_STAT_INCREMENT( tx_release_bad );
}
}
#else /* if ( ipconfigZERO_COPY_TX_DRIVER != 0 ) */
{
tx_release_count[ 0 ]++;
TX_STAT_INCREMENT( tx_release_ok );
}
#endif /* if ( ipconfigZERO_COPY_TX_DRIVER != 0 ) */
uxCount = uxQueueMessagesWaiting( ( QueueHandle_t ) xTXDescriptorSemaphore );

if( uxCount < GMAC_TX_BUFFERS )
if( uxCount < ( GMAC_TX_BUFFERS - 1 ) )
{
/* Tell the counting semaphore that one more TX descriptor is available. */
xSemaphoreGive( xTXDescriptorSemaphore );
Expand All @@ -933,7 +950,6 @@ static void prvEMACHandlerTask( void * pvParameters )
if( ( ulISREvents & EMAC_IF_ERR_EVENT ) != 0 )
{
/* Future extension: logging about errors that occurred. */
ulISREvents &= ~EMAC_IF_ERR_EVENT;
}

gmac_enable_management( GMAC, true );
Expand Down
Loading