--- /dev/null
+/*\r
+FreeRTOS+TCP V2.0.11\r
+Copyright (C) 2017 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://aws.amazon.com/freertos\r
+ http://www.FreeRTOS.org\r
+*/\r
+\r
+/******************************************************************************\r
+ *\r
+ * See the following web page for essential buffer allocation scheme usage and\r
+ * configuration details:\r
+ * http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/Embedded_Ethernet_Buffer_Management.html\r
+ *\r
+ ******************************************************************************/\r
+\r
+/* Standard includes. */\r
+#include <stdint.h>\r
+\r
+/* FreeRTOS includes. */\r
+#include "FreeRTOS.h"\r
+#include "task.h"\r
+#include "queue.h"\r
+#include "semphr.h"\r
+\r
+/* FreeRTOS+TCP includes. */\r
+#include "FreeRTOS_IP.h"\r
+#include "FreeRTOS_IP_Private.h"\r
+#include "NetworkInterface.h"\r
+#include "NetworkBufferManagement.h"\r
+\r
+/* For an Ethernet interrupt to be able to obtain a network buffer there must\r
+be at least this number of buffers available. */\r
+#define baINTERRUPT_BUFFER_GET_THRESHOLD ( 3 )\r
+\r
+/* A list of free (available) NetworkBufferDescriptor_t structures. */\r
+static List_t xFreeBuffersList;\r
+\r
+/* Some statistics about the use of buffers. */\r
+static UBaseType_t uxMinimumFreeNetworkBuffers = 0u;\r
+\r
+/* Declares the pool of NetworkBufferDescriptor_t structures that are available\r
+to the system. All the network buffers referenced from xFreeBuffersList exist\r
+in this array. The array is not accessed directly except during initialisation,\r
+when the xFreeBuffersList is filled (as all the buffers are free when the system\r
+is booted). */\r
+static NetworkBufferDescriptor_t xNetworkBuffers[ ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS ];\r
+\r
+/* This constant is defined as true to let FreeRTOS_TCP_IP.c know that the\r
+network buffers have constant size, large enough to hold the biggest Ethernet\r
+packet. No resizing will be done. */\r
+const BaseType_t xBufferAllocFixedSize = pdTRUE;\r
+\r
+/* The semaphore used to obtain network buffers. */\r
+static SemaphoreHandle_t xNetworkBufferSemaphore = NULL;\r
+\r
+#if( ipconfigTCP_IP_SANITY != 0 )\r
+ static char cIsLow = pdFALSE;\r
+ UBaseType_t bIsValidNetworkDescriptor( const NetworkBufferDescriptor_t * pxDesc );\r
+#else\r
+ static UBaseType_t bIsValidNetworkDescriptor( const NetworkBufferDescriptor_t * pxDesc );\r
+#endif /* ipconfigTCP_IP_SANITY */\r
+\r
+static void prvShowWarnings( void );\r
+\r
+/* The user can define their own ipconfigBUFFER_ALLOC_LOCK() and\r
+ipconfigBUFFER_ALLOC_UNLOCK() macros, especially for use form an ISR. If these\r
+are not defined then default them to call the normal enter/exit critical\r
+section macros. */\r
+#if !defined( ipconfigBUFFER_ALLOC_LOCK )\r
+\r
+ #define ipconfigBUFFER_ALLOC_INIT( ) do {} while (0)\r
+ #define ipconfigBUFFER_ALLOC_LOCK_FROM_ISR() \\r
+ UBaseType_t uxSavedInterruptStatus = ( UBaseType_t ) portSET_INTERRUPT_MASK_FROM_ISR(); \\r
+ {\r
+\r
+ #define ipconfigBUFFER_ALLOC_UNLOCK_FROM_ISR() \\r
+ portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ); \\r
+ }\r
+\r
+ #define ipconfigBUFFER_ALLOC_LOCK() taskENTER_CRITICAL()\r
+ #define ipconfigBUFFER_ALLOC_UNLOCK() taskEXIT_CRITICAL()\r
+\r
+#endif /* ipconfigBUFFER_ALLOC_LOCK */\r
+\r
+/*-----------------------------------------------------------*/\r
+\r
+#if( ipconfigTCP_IP_SANITY != 0 )\r
+\r
+ /* HT: SANITY code will be removed as soon as the library is stable\r
+ * and and ready to become public\r
+ * Function below gives information about the use of buffers */\r
+ #define WARN_LOW ( 2 )\r
+ #define WARN_HIGH ( ( 5 * ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS ) / 10 )\r
+\r
+#endif /* ipconfigTCP_IP_SANITY */\r
+\r
+/*-----------------------------------------------------------*/\r
+\r
+#if( ipconfigTCP_IP_SANITY != 0 )\r
+\r
+ BaseType_t prvIsFreeBuffer( const NetworkBufferDescriptor_t *pxDescr )\r
+ {\r
+ return ( bIsValidNetworkDescriptor( pxDescr ) != 0 ) &&\r
+ ( listIS_CONTAINED_WITHIN( &xFreeBuffersList, &( pxDescr->xBufferListItem ) ) != 0 );\r
+ }\r
+ /*-----------------------------------------------------------*/\r
+\r
+ static void prvShowWarnings( void )\r
+ {\r
+ UBaseType_t uxCount = uxGetNumberOfFreeNetworkBuffers( );\r
+ if( ( ( cIsLow == 0 ) && ( uxCount <= WARN_LOW ) ) || ( ( cIsLow != 0 ) && ( uxCount >= WARN_HIGH ) ) )\r
+ {\r
+ cIsLow = !cIsLow;\r
+ FreeRTOS_debug_printf( ( "*** Warning *** %s %lu buffers left\n", cIsLow ? "only" : "now", uxCount ) );\r
+ }\r
+ }\r
+ /*-----------------------------------------------------------*/\r
+\r
+ UBaseType_t bIsValidNetworkDescriptor( const NetworkBufferDescriptor_t * pxDesc )\r
+ {\r
+ uint32_t offset = ( uint32_t ) ( ((const char *)pxDesc) - ((const char *)xNetworkBuffers) );\r
+ if( ( offset >= sizeof( xNetworkBuffers ) ) ||\r
+ ( ( offset % sizeof( xNetworkBuffers[0] ) ) != 0 ) )\r
+ return pdFALSE;\r
+ return (UBaseType_t) (pxDesc - xNetworkBuffers) + 1;\r
+ }\r
+ /*-----------------------------------------------------------*/\r
+\r
+#else\r
+ static UBaseType_t bIsValidNetworkDescriptor (const NetworkBufferDescriptor_t * pxDesc)\r
+ {\r
+ ( void ) pxDesc;\r
+ return ( UBaseType_t ) pdTRUE;\r
+ }\r
+ /*-----------------------------------------------------------*/\r
+\r
+ static void prvShowWarnings( void )\r
+ {\r
+ }\r
+ /*-----------------------------------------------------------*/\r
+\r
+#endif /* ipconfigTCP_IP_SANITY */\r
+\r
+BaseType_t xNetworkBuffersInitialise( void )\r
+{\r
+BaseType_t xReturn, x;\r
+\r
+ /* Only initialise the buffers and their associated kernel objects if they\r
+ have not been initialised before. */\r
+ if( xNetworkBufferSemaphore == NULL )\r
+ {\r
+ /* In case alternative locking is used, the mutexes can be initialised\r
+ here */\r
+ ipconfigBUFFER_ALLOC_INIT();\r
+\r
+ xNetworkBufferSemaphore = xSemaphoreCreateCounting( ( UBaseType_t ) ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS, ( UBaseType_t ) ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS );\r
+ configASSERT( xNetworkBufferSemaphore );\r
+\r
+ if( xNetworkBufferSemaphore != NULL )\r
+ {\r
+ vListInitialise( &xFreeBuffersList );\r
+\r
+ /* Initialise all the network buffers. The buffer storage comes\r
+ from the network interface, and different hardware has different\r
+ requirements. */\r
+ vNetworkInterfaceAllocateRAMToBuffers( xNetworkBuffers );\r
+ for( x = 0; x < ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS; x++ )\r
+ {\r
+ /* Initialise and set the owner of the buffer list items. */\r
+ vListInitialiseItem( &( xNetworkBuffers[ x ].xBufferListItem ) );\r
+ listSET_LIST_ITEM_OWNER( &( xNetworkBuffers[ x ].xBufferListItem ), &xNetworkBuffers[ x ] );\r
+\r
+ /* Currently, all buffers are available for use. */\r
+ vListInsert( &xFreeBuffersList, &( xNetworkBuffers[ x ].xBufferListItem ) );\r
+ }\r
+\r
+ uxMinimumFreeNetworkBuffers = ( UBaseType_t ) ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS;\r
+ }\r
+ }\r
+\r
+ if( xNetworkBufferSemaphore == NULL )\r
+ {\r
+ xReturn = pdFAIL;\r
+ }\r
+ else\r
+ {\r
+ xReturn = pdPASS;\r
+ }\r
+\r
+ return xReturn;\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+NetworkBufferDescriptor_t *pxGetNetworkBufferWithDescriptor( size_t xRequestedSizeBytes, TickType_t xBlockTimeTicks )\r
+{\r
+NetworkBufferDescriptor_t *pxReturn = NULL;\r
+BaseType_t xInvalid = pdFALSE;\r
+UBaseType_t uxCount;\r
+\r
+ /* The current implementation only has a single size memory block, so\r
+ the requested size parameter is not used (yet). */\r
+ ( void ) xRequestedSizeBytes;\r
+\r
+ if( xNetworkBufferSemaphore != NULL )\r
+ {\r
+ /* If there is a semaphore available, there is a network buffer\r
+ available. */\r
+ if( xSemaphoreTake( xNetworkBufferSemaphore, xBlockTimeTicks ) == pdPASS )\r
+ {\r
+ /* Protect the structure as they are accessed from tasks and\r
+ interrupts. */\r
+ ipconfigBUFFER_ALLOC_LOCK();\r
+ {\r
+ pxReturn = ( NetworkBufferDescriptor_t * ) listGET_OWNER_OF_HEAD_ENTRY( &xFreeBuffersList );\r
+\r
+ if( ( bIsValidNetworkDescriptor( pxReturn ) != pdFALSE_UNSIGNED ) &&\r
+ listIS_CONTAINED_WITHIN( &xFreeBuffersList, &( pxReturn->xBufferListItem ) ) )\r
+ {\r
+ uxListRemove( &( pxReturn->xBufferListItem ) );\r
+ }\r
+ else\r
+ {\r
+ xInvalid = pdTRUE;\r
+ }\r
+ }\r
+ ipconfigBUFFER_ALLOC_UNLOCK();\r
+\r
+ if( xInvalid == pdTRUE )\r
+ {\r
+ /* _RB_ Can printf() be called from an interrupt? (comment\r
+ above says this can be called from an interrupt too) */\r
+ /* _HT_ The function shall not be called from an ISR. Comment\r
+ was indeed misleading. Hopefully clear now?\r
+ So the printf()is OK here. */\r
+ FreeRTOS_debug_printf( ( "pxGetNetworkBufferWithDescriptor: INVALID BUFFER: %p (valid %lu)\n",\r
+ pxReturn, bIsValidNetworkDescriptor( pxReturn ) ) );\r
+ pxReturn = NULL;\r
+ }\r
+ else\r
+ {\r
+ /* Reading UBaseType_t, no critical section needed. */\r
+ uxCount = listCURRENT_LIST_LENGTH( &xFreeBuffersList );\r
+\r
+ /* For stats, latch the lowest number of network buffers since\r
+ booting. */\r
+ if( uxMinimumFreeNetworkBuffers > uxCount )\r
+ {\r
+ uxMinimumFreeNetworkBuffers = uxCount;\r
+ }\r
+\r
+ pxReturn->xDataLength = xRequestedSizeBytes;\r
+\r
+ #if( ipconfigTCP_IP_SANITY != 0 )\r
+ {\r
+ prvShowWarnings();\r
+ }\r
+ #endif /* ipconfigTCP_IP_SANITY */\r
+\r
+ #if( ipconfigUSE_LINKED_RX_MESSAGES != 0 )\r
+ {\r
+ /* make sure the buffer is not linked */\r
+ pxReturn->pxNextBuffer = NULL;\r
+ }\r
+ #endif /* ipconfigUSE_LINKED_RX_MESSAGES */\r
+\r
+ if( xTCPWindowLoggingLevel > 3 )\r
+ {\r
+ FreeRTOS_debug_printf( ( "BUF_GET[%ld]: %p (%p)\n",\r
+ bIsValidNetworkDescriptor( pxReturn ),\r
+ pxReturn, pxReturn->pucEthernetBuffer ) );\r
+ }\r
+ }\r
+ iptraceNETWORK_BUFFER_OBTAINED( pxReturn );\r
+ }\r
+ else\r
+ {\r
+ iptraceFAILED_TO_OBTAIN_NETWORK_BUFFER();\r
+ }\r
+ }\r
+\r
+ return pxReturn;\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+NetworkBufferDescriptor_t *pxNetworkBufferGetFromISR( size_t xRequestedSizeBytes )\r
+{\r
+NetworkBufferDescriptor_t *pxReturn = NULL;\r
+\r
+ /* The current implementation only has a single size memory block, so\r
+ the requested size parameter is not used (yet). */\r
+ ( void ) xRequestedSizeBytes;\r
+\r
+ /* If there is a semaphore available then there is a buffer available, but,\r
+ as this is called from an interrupt, only take a buffer if there are at\r
+ least baINTERRUPT_BUFFER_GET_THRESHOLD buffers remaining. This prevents,\r
+ to a certain degree at least, a rapidly executing interrupt exhausting\r
+ buffer and in so doing preventing tasks from continuing. */\r
+ if( uxQueueMessagesWaitingFromISR( ( QueueHandle_t ) xNetworkBufferSemaphore ) > ( UBaseType_t ) baINTERRUPT_BUFFER_GET_THRESHOLD )\r
+ {\r
+ if( xSemaphoreTakeFromISR( xNetworkBufferSemaphore, NULL ) == pdPASS )\r
+ {\r
+ /* Protect the structure as it is accessed from tasks and interrupts. */\r
+ ipconfigBUFFER_ALLOC_LOCK_FROM_ISR();\r
+ {\r
+ pxReturn = ( NetworkBufferDescriptor_t * ) listGET_OWNER_OF_HEAD_ENTRY( &xFreeBuffersList );\r
+ uxListRemove( &( pxReturn->xBufferListItem ) );\r
+ }\r
+ ipconfigBUFFER_ALLOC_UNLOCK_FROM_ISR();\r
+\r
+ iptraceNETWORK_BUFFER_OBTAINED_FROM_ISR( pxReturn );\r
+ }\r
+ }\r
+\r
+ if( pxReturn == NULL )\r
+ {\r
+ iptraceFAILED_TO_OBTAIN_NETWORK_BUFFER_FROM_ISR();\r
+ }\r
+\r
+ return pxReturn;\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+BaseType_t vNetworkBufferReleaseFromISR( NetworkBufferDescriptor_t * const pxNetworkBuffer )\r
+{\r
+BaseType_t xHigherPriorityTaskWoken = pdFALSE;\r
+\r
+ /* Ensure the buffer is returned to the list of free buffers before the\r
+ counting semaphore is 'given' to say a buffer is available. */\r
+ ipconfigBUFFER_ALLOC_LOCK_FROM_ISR();\r
+ {\r
+ vListInsertEnd( &xFreeBuffersList, &( pxNetworkBuffer->xBufferListItem ) );\r
+ }\r
+ ipconfigBUFFER_ALLOC_UNLOCK_FROM_ISR();\r
+\r
+ xSemaphoreGiveFromISR( xNetworkBufferSemaphore, &xHigherPriorityTaskWoken );\r
+ iptraceNETWORK_BUFFER_RELEASED( pxNetworkBuffer );\r
+\r
+ return xHigherPriorityTaskWoken;\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+void vReleaseNetworkBufferAndDescriptor( NetworkBufferDescriptor_t * const pxNetworkBuffer )\r
+{\r
+BaseType_t xListItemAlreadyInFreeList;\r
+\r
+ if( bIsValidNetworkDescriptor( pxNetworkBuffer ) == pdFALSE_UNSIGNED )\r
+ {\r
+ FreeRTOS_debug_printf( ( "vReleaseNetworkBufferAndDescriptor: Invalid buffer %p\n", pxNetworkBuffer ) );\r
+ return ;\r
+ }\r
+ /* Ensure the buffer is returned to the list of free buffers before the\r
+ counting semaphore is 'given' to say a buffer is available. */\r
+ ipconfigBUFFER_ALLOC_LOCK();\r
+ {\r
+ {\r
+ xListItemAlreadyInFreeList = listIS_CONTAINED_WITHIN( &xFreeBuffersList, &( pxNetworkBuffer->xBufferListItem ) );\r
+\r
+ if( xListItemAlreadyInFreeList == pdFALSE )\r
+ {\r
+ vListInsertEnd( &xFreeBuffersList, &( pxNetworkBuffer->xBufferListItem ) );\r
+ }\r
+ }\r
+ }\r
+ ipconfigBUFFER_ALLOC_UNLOCK();\r
+\r
+ if( xListItemAlreadyInFreeList )\r
+ {\r
+ FreeRTOS_debug_printf( ( "vReleaseNetworkBufferAndDescriptor: %p ALREADY RELEASED (now %lu)\n",\r
+ pxNetworkBuffer, uxGetNumberOfFreeNetworkBuffers( ) ) );\r
+ }\r
+ if( xListItemAlreadyInFreeList == pdFALSE )\r
+ {\r
+ xSemaphoreGive( xNetworkBufferSemaphore );\r
+ prvShowWarnings();\r
+ if( xTCPWindowLoggingLevel > 3 )\r
+ FreeRTOS_debug_printf( ( "BUF_PUT[%ld]: %p (%p) (now %lu)\n",\r
+ bIsValidNetworkDescriptor( pxNetworkBuffer ),\r
+ pxNetworkBuffer, pxNetworkBuffer->pucEthernetBuffer,\r
+ uxGetNumberOfFreeNetworkBuffers( ) ) );\r
+ }\r
+ iptraceNETWORK_BUFFER_RELEASED( pxNetworkBuffer );\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+UBaseType_t uxGetMinimumFreeNetworkBuffers( void )\r
+{\r
+ return uxMinimumFreeNetworkBuffers;\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+UBaseType_t uxGetNumberOfFreeNetworkBuffers( void )\r
+{\r
+ return listCURRENT_LIST_LENGTH( &xFreeBuffersList );\r
+}\r
+\r
+NetworkBufferDescriptor_t *pxResizeNetworkBufferWithDescriptor( NetworkBufferDescriptor_t * pxNetworkBuffer, size_t xNewSizeBytes )\r
+{\r
+ /* In BufferAllocation_1.c all network buffer are allocated with a\r
+ maximum size of 'ipTOTAL_ETHERNET_FRAME_SIZE'.No need to resize the\r
+ network buffer. */\r
+ ( void ) xNewSizeBytes;\r
+ return pxNetworkBuffer;\r
+}\r
+\r
+/*#endif */ /* ipconfigINCLUDE_TEST_CODE */\r
projects / freertos / blobdiff