mirror of
https://github.com/FreeRTOS/FreeRTOS-Plus-TCP
synced 2025-10-24 03:32:36 +08:00
a6ca0be209
Libslirp is used by qemu to provide userspace NAT networking. This serves as a replacement for the current libpcap / winpcap NetworkInterface but does not require elevated privileges or selecting a particular interface to bind to. In this implementation, incoming connections are not supported. Tested with git revision 38638382c8f3dc2523468f0c54014f4fdf0aa38f on MacOS and Windows.
293 lines
9.5 KiB
C
293 lines
9.5 KiB
C
/*
|
|
* FreeRTOS+TCP <DEVELOPMENT BRANCH>
|
|
* Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
/* FreeRTOS includes. */
|
|
#include "FreeRTOS.h"
|
|
#include "list.h"
|
|
#include "task.h"
|
|
#include "message_buffer.h"
|
|
|
|
#if !defined( _WIN32 )
|
|
#include "wait_for_event.h"
|
|
#endif
|
|
|
|
/* FreeRTOS+TCP includes. */
|
|
#include "FreeRTOS_IP.h"
|
|
|
|
/* If ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES is set to 1, then the Ethernet
|
|
* driver will filter incoming packets and only pass the stack those packets it
|
|
* considers need processing. */
|
|
#if ( ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES == 0 )
|
|
#define ipCONSIDER_FRAME_FOR_PROCESSING( pucEthernetBuffer ) eProcessBuffer
|
|
#else
|
|
#define ipCONSIDER_FRAME_FOR_PROCESSING( pucEthernetBuffer ) eConsiderFrameForProcessing( ( pucEthernetBuffer ) )
|
|
#endif
|
|
|
|
#if ipconfigNETWORK_MTU < 1500U
|
|
#error ipconfigNETWORK_MTU must be at least 1500
|
|
#endif
|
|
|
|
#define NETWORK_BUFFER_LEN ( ipconfigNETWORK_MTU + ipSIZE_OF_ETH_HEADER )
|
|
|
|
#define xSEND_BUFFER_SIZE ( 32U * NETWORK_BUFFER_LEN )
|
|
#define xRECV_BUFFER_SIZE ( 32U * NETWORK_BUFFER_LEN )
|
|
|
|
typedef struct
|
|
{
|
|
BaseType_t xInterfaceState;
|
|
MessageBufferHandle_t xSendMsgBuffer;
|
|
MessageBufferHandle_t xRecvMsgBuffer;
|
|
TaskHandle_t xRecvTask;
|
|
void * pvSendEvent;
|
|
void * pvBackendContext;
|
|
} MBuffNetDriverContext_t;
|
|
|
|
extern void vMBuffNetifBackendInit( MessageBufferHandle_t * pxSendMsgBuffer,
|
|
MessageBufferHandle_t * pxRecvMsgBuffer,
|
|
void * pvSendEvent,
|
|
void ** ppvBackendContext );
|
|
|
|
extern void vMBuffNetifBackendDeInit( void * pvBackendContext );
|
|
|
|
static void vNetifReceiveTask( void * pvParameters );
|
|
|
|
MBuffNetDriverContext_t xDriverCtx = { 0 };
|
|
|
|
/**
|
|
* @brief Initialize the MessageBuffer backed network interface.
|
|
*
|
|
* @return BaseType_t pdTRUE on success
|
|
*/
|
|
BaseType_t xNetworkInterfaceInitialise( void )
|
|
{
|
|
BaseType_t xResult = pdTRUE;
|
|
|
|
if( xDriverCtx.xInterfaceState == pdFALSE )
|
|
{
|
|
xDriverCtx.xInterfaceState = pdFALSE;
|
|
|
|
#if defined( _WIN32 )
|
|
xDriverCtx.pvSendEvent = CreateEvent( NULL, FALSE, TRUE, NULL );
|
|
#else
|
|
xDriverCtx.pvSendEvent = ( void * ) event_create();
|
|
#endif
|
|
|
|
if( xDriverCtx.pvSendEvent == NULL )
|
|
{
|
|
xResult = pdFALSE;
|
|
}
|
|
else
|
|
{
|
|
vMBuffNetifBackendInit( &( xDriverCtx.xSendMsgBuffer ),
|
|
&( xDriverCtx.xRecvMsgBuffer ),
|
|
xDriverCtx.pvSendEvent,
|
|
&( xDriverCtx.pvBackendContext ) );
|
|
|
|
if( xDriverCtx.pvBackendContext == NULL )
|
|
{
|
|
xResult = pdFALSE;
|
|
#if defined( _WIN32 )
|
|
( void ) CloseHandle( xDriverCtx.pvSendEvent );
|
|
#else
|
|
( void ) event_delete( xDriverCtx.pvSendEvent );
|
|
#endif
|
|
}
|
|
}
|
|
|
|
if( xResult == pdTRUE )
|
|
{
|
|
xResult = xTaskCreate( vNetifReceiveTask, "NetRX",
|
|
configMINIMAL_STACK_SIZE, NULL,
|
|
tskIDLE_PRIORITY,
|
|
&( xDriverCtx.xRecvTask ) );
|
|
}
|
|
|
|
/* Cleanup on failure */
|
|
if( xResult != pdTRUE )
|
|
{
|
|
if( xDriverCtx.pvSendEvent != NULL )
|
|
{
|
|
#if defined( _WIN32 )
|
|
( void ) CloseHandle( xDriverCtx.pvSendEvent );
|
|
#else
|
|
event_delete( xDriverCtx.pvSendEvent );
|
|
#endif
|
|
}
|
|
|
|
if( xDriverCtx.pvBackendContext != NULL )
|
|
{
|
|
vMBuffNetifBackendDeInit( xDriverCtx.pvBackendContext );
|
|
}
|
|
}
|
|
|
|
xDriverCtx.xInterfaceState = xResult;
|
|
}
|
|
|
|
return xResult;
|
|
}
|
|
|
|
/**
|
|
* @brief Deinitialize the message buffer backed network interface.
|
|
*
|
|
* @return BaseType_t pdTRUE
|
|
*/
|
|
BaseType_t xNetworkInterfaceDeInitialise( void )
|
|
{
|
|
#if defined( _WIN32 )
|
|
( void ) CloseHandle( xDriverCtx.pvSendEvent );
|
|
#else
|
|
event_delete( xDriverCtx.pvSendEvent );
|
|
#endif
|
|
|
|
vTaskDelete( xDriverCtx.xRecvTask );
|
|
|
|
return pdTRUE;
|
|
}
|
|
|
|
/*!
|
|
* @brief FreeRTOS task which reads from xRecvMsgBuffer and passes new frames to FreeRTOS+TCP.
|
|
* @param [in] pvParameters not used
|
|
*/
|
|
static void vNetifReceiveTask( void * pvParameters )
|
|
{
|
|
NetworkBufferDescriptor_t * pxDescriptor = NULL;
|
|
|
|
( void ) pvParameters;
|
|
|
|
for( ; ; )
|
|
{
|
|
size_t uxMessageLen;
|
|
|
|
while( pxDescriptor == NULL )
|
|
{
|
|
/* Wait for an MTU + header sized buffer */
|
|
pxDescriptor = pxGetNetworkBufferWithDescriptor( NETWORK_BUFFER_LEN, portMAX_DELAY );
|
|
configASSERT( pxDescriptor->xDataLength >= NETWORK_BUFFER_LEN );
|
|
}
|
|
|
|
/* Read an incoming frame */
|
|
uxMessageLen = xMessageBufferReceive( xDriverCtx.xRecvMsgBuffer,
|
|
pxDescriptor->pucEthernetBuffer,
|
|
pxDescriptor->xDataLength,
|
|
portMAX_DELAY );
|
|
|
|
if( uxMessageLen > 0 )
|
|
{
|
|
IPStackEvent_t xRxEvent;
|
|
eFrameProcessingResult_t xFrameProcess;
|
|
|
|
pxDescriptor->xDataLength = uxMessageLen;
|
|
|
|
/* eConsiderFrameForProcessing is interrupt safe */
|
|
xFrameProcess = ipCONSIDER_FRAME_FOR_PROCESSING( pxDescriptor->pucEthernetBuffer );
|
|
|
|
if( xFrameProcess != eProcessBuffer )
|
|
{
|
|
FreeRTOS_debug_printf( ( "Dropping RX frame of length: %lu. eConsiderFrameForProcessing returned %lu.\n",
|
|
uxMessageLen, xFrameProcess ) );
|
|
}
|
|
|
|
xRxEvent.eEventType = eNetworkRxEvent;
|
|
xRxEvent.pvData = ( void * ) pxDescriptor;
|
|
|
|
if( xSendEventStructToIPTask( &xRxEvent, 0U ) == pdTRUE )
|
|
{
|
|
iptraceNETWORK_INTERFACE_RECEIVE();
|
|
|
|
/* Clear pxDescriptor so that the task requests a new buffer */
|
|
pxDescriptor = NULL;
|
|
}
|
|
else
|
|
{
|
|
FreeRTOS_debug_printf( ( "Dropping TX frame of length: %lu. FreeRTOS+TCP event queue is full.\n",
|
|
pxDescriptor->xDataLength ) );
|
|
/* Drop the frame and reuse the descriptor for the next incomming frame */
|
|
iptraceETHERNET_RX_EVENT_LOST();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
/*
|
|
* xMessageBufferReceive returned zero.
|
|
*/
|
|
}
|
|
}
|
|
}
|
|
|
|
/*!
|
|
* @brief API call, called from reeRTOS_IP.c to send a network packet over the
|
|
* selected interface
|
|
* @return pdTRUE if successful else pdFALSE
|
|
*/
|
|
BaseType_t xNetworkInterfaceOutput( NetworkBufferDescriptor_t * const pxNetworkBuffer,
|
|
BaseType_t xReleaseAfterSend )
|
|
{
|
|
BaseType_t xResult = pdFALSE;
|
|
|
|
configASSERT( pxNetworkBuffer != NULL );
|
|
configASSERT( pxNetworkBuffer->pucEthernetBuffer != NULL );
|
|
configASSERT( pxNetworkBuffer->xDataLength >= sizeof( EthernetHeader_t ) );
|
|
|
|
if( xDriverCtx.xInterfaceState == pdTRUE )
|
|
{
|
|
if( xMessageBufferSpacesAvailable( xDriverCtx.xSendMsgBuffer ) > pxNetworkBuffer->xDataLength + 4U )
|
|
{
|
|
size_t uxBytesSent;
|
|
uxBytesSent = xMessageBufferSend( xDriverCtx.xSendMsgBuffer,
|
|
pxNetworkBuffer->pucEthernetBuffer,
|
|
pxNetworkBuffer->xDataLength,
|
|
0U );
|
|
( void ) uxBytesSent;
|
|
configASSERT( uxBytesSent == pxNetworkBuffer->xDataLength );
|
|
xResult = pdTRUE;
|
|
}
|
|
else
|
|
{
|
|
FreeRTOS_debug_printf( ( "Dropping TX frame of length: %lu. xSendMsgBuffer is full.\n",
|
|
pxNetworkBuffer->xDataLength ) );
|
|
}
|
|
|
|
iptraceNETWORK_INTERFACE_TRANSMIT();
|
|
|
|
if( xReleaseAfterSend != pdFALSE )
|
|
{
|
|
vReleaseNetworkBufferAndDescriptor( pxNetworkBuffer );
|
|
}
|
|
|
|
if( xResult == pdTRUE )
|
|
{
|
|
#if defined( _WIN32 )
|
|
SetEvent( xDriverCtx.pvSendEvent );
|
|
#else
|
|
event_signal( xDriverCtx.pvSendEvent );
|
|
#endif
|
|
}
|
|
}
|
|
|
|
return xResult;
|
|
}
|