]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/portable/NetworkInterface/LPC17xx/NetworkInterface.c
Update version number in readiness for V10.3.0 release. Sync SVN with reviewed releas...
[freertos] / FreeRTOS-Plus / Source / FreeRTOS-Plus-TCP / portable / NetworkInterface / LPC17xx / NetworkInterface.c
index e0d04e45472b3eba6fb5de15bae301774ce725e0..7cee711cd3dc89132c114b5554820808640bd1f4 100644 (file)
-/*\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
-/* 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
-/* Hardware abstraction. */\r
-#include "FreeRTOS_IO.h"\r
-\r
-/* FreeRTOS+TCP includes. */\r
-#include "FreeRTOS_UDP_IP.h"\r
-#include "FreeRTOS_Sockets.h"\r
-#include "NetworkBufferManagement.h"\r
-\r
-/* Driver includes. */\r
-#include "lpc17xx_emac.h"\r
-#include "lpc17xx_pinsel.h"\r
-\r
-/* Demo includes. */\r
-#include "NetworkInterface.h"\r
-\r
-#if ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES != 1\r
-       #define ipCONSIDER_FRAME_FOR_PROCESSING( pucEthernetBuffer ) eProcessBuffer\r
-#else\r
-       #define ipCONSIDER_FRAME_FOR_PROCESSING( pucEthernetBuffer ) eConsiderFrameForProcessing( ( pucEthernetBuffer ) )\r
-#endif\r
-\r
-/* When a packet is ready to be sent, if it cannot be sent immediately then the\r
-task performing the transmit will block for niTX_BUFFER_FREE_WAIT\r
-milliseconds.  It will do this a maximum of niMAX_TX_ATTEMPTS before giving\r
-up. */\r
-#define niTX_BUFFER_FREE_WAIT  ( pdMS_TO_TICKS( 2UL ) )\r
-#define niMAX_TX_ATTEMPTS              ( 5 )\r
-\r
-/* The length of the queue used to send interrupt status words from the\r
-interrupt handler to the deferred handler task. */\r
-#define niINTERRUPT_QUEUE_LENGTH       ( 10 )\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/*\r
- * A deferred interrupt handler task that processes\r
- */\r
-static void prvEMACHandlerTask( void *pvParameters );\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/* The queue used to communicate Ethernet events with the IP task. */\r
-extern QueueHandle_t xNetworkEventQueue;\r
-\r
-/* The semaphore used to wake the deferred interrupt handler task when an Rx\r
-interrupt is received. */\r
-static SemaphoreHandle_t xEMACRxEventSemaphore = NULL;\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xNetworkInterfaceInitialise( void )\r
-{\r
-EMAC_CFG_Type Emac_Config;\r
-PINSEL_CFG_Type xPinConfig;\r
-BaseType_t xStatus, xReturn;\r
-extern uint8_t ucMACAddress[ 6 ];\r
-\r
-       /* Enable Ethernet Pins */\r
-       boardCONFIGURE_ENET_PINS( xPinConfig );\r
-\r
-       Emac_Config.Mode = EMAC_MODE_AUTO;\r
-       Emac_Config.pbEMAC_Addr = ucMACAddress;\r
-       xStatus = EMAC_Init( &Emac_Config );\r
-\r
-       LPC_EMAC->IntEnable &= ~( EMAC_INT_TX_DONE );\r
-\r
-       if( xStatus != ERROR )\r
-       {\r
-               vSemaphoreCreateBinary( xEMACRxEventSemaphore );\r
-               configASSERT( xEMACRxEventSemaphore );\r
-\r
-               /* The handler task is created at the highest possible priority to\r
-               ensure the interrupt handler can return directly to it. */\r
-               xTaskCreate( prvEMACHandlerTask, "EMAC", configMINIMAL_STACK_SIZE, NULL, configMAX_PRIORITIES - 1, NULL );\r
-\r
-               /* Enable the interrupt and set its priority to the minimum\r
-               interrupt priority.  */\r
-               NVIC_SetPriority( ENET_IRQn, configMAC_INTERRUPT_PRIORITY );\r
-               NVIC_EnableIRQ( ENET_IRQn );\r
-\r
-               xReturn = pdPASS;\r
-       }\r
-       else\r
-       {\r
-               xReturn = pdFAIL;\r
-       }\r
-\r
-       configASSERT( xStatus != ERROR );\r
-\r
-       return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xNetworkInterfaceOutput( NetworkBufferDescriptor_t * const pxNetworkBuffer )\r
-{\r
-BaseType_t xReturn = pdFAIL;\r
-int32_t x;\r
-extern void EMAC_StartTransmitNextBuffer( uint32_t ulLength );\r
-extern void EMAC_SetNextPacketToSend( uint8_t * pucBuffer );\r
-\r
-\r
-       /* Attempt to obtain access to a Tx buffer. */\r
-       for( x = 0; x < niMAX_TX_ATTEMPTS; x++ )\r
-       {\r
-               if( EMAC_CheckTransmitIndex() == TRUE )\r
-               {\r
-                       /* Will the data fit in the Tx buffer? */\r
-                       if( pxNetworkBuffer->xDataLength < EMAC_ETH_MAX_FLEN ) /*_RB_ The size needs to come from FreeRTOSIPConfig.h. */\r
-                       {\r
-                               /* Assign the buffer to the Tx descriptor that is now known to\r
-                               be free. */\r
-                               EMAC_SetNextPacketToSend( pxNetworkBuffer->pucBuffer );\r
-\r
-                               /* The EMAC now owns the buffer. */\r
-                               pxNetworkBuffer->pucBuffer = NULL;\r
-\r
-                               /* Initiate the Tx. */\r
-                               EMAC_StartTransmitNextBuffer( pxNetworkBuffer->xDataLength );\r
-                               iptraceNETWORK_INTERFACE_TRANSMIT();\r
-\r
-                               /* The Tx has been initiated. */\r
-                               xReturn = pdPASS;\r
-                       }\r
-                       break;\r
-               }\r
-               else\r
-               {\r
-                       vTaskDelay( niTX_BUFFER_FREE_WAIT );\r
-               }\r
-       }\r
-\r
-       /* Finished with the network buffer. */\r
-       vReleaseNetworkBufferAndDescriptor( pxNetworkBuffer );\r
-\r
-       return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void ENET_IRQHandler( void )\r
-{\r
-uint32_t ulInterruptCause;\r
-\r
-       while( ( ulInterruptCause = LPC_EMAC->IntStatus ) != 0 )\r
-       {\r
-               /* Clear the interrupt. */\r
-               LPC_EMAC->IntClear = ulInterruptCause;\r
-\r
-               /* Clear fatal error conditions.  NOTE:  The driver does not clear all\r
-               errors, only those actually experienced.  For future reference, range\r
-               errors are not actually errors so can be ignored. */\r
-               if( ( ulInterruptCause & EMAC_INT_TX_UNDERRUN ) != 0U )\r
-               {\r
-                       LPC_EMAC->Command |= EMAC_CR_TX_RES;\r
-               }\r
-\r
-               /* Unblock the deferred interrupt handler task if the event was an\r
-               Rx. */\r
-               if( ( ulInterruptCause & EMAC_INT_RX_DONE ) != 0UL )\r
-               {\r
-                       xSemaphoreGiveFromISR( xEMACRxEventSemaphore, NULL );\r
-               }\r
-       }\r
-\r
-       /* ulInterruptCause is used for convenience here.  A context switch is\r
-       wanted, but coding portEND_SWITCHING_ISR( 1 ) would likely result in a\r
-       compiler warning. */\r
-       portEND_SWITCHING_ISR( ulInterruptCause );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvEMACHandlerTask( void *pvParameters )\r
-{\r
-size_t xDataLength;\r
-const uint16_t usCRCLength = 4;\r
-NetworkBufferDescriptor_t *pxNetworkBuffer;\r
-IPStackEvent_t xRxEvent = { eNetworkRxEvent, NULL };\r
-\r
-/* This is not included in the header file for some reason. */\r
-extern uint8_t *EMAC_NextPacketToRead( void );\r
-\r
-       ( void ) pvParameters;\r
-       configASSERT( xEMACRxEventSemaphore );\r
-\r
-       for( ;; )\r
-       {\r
-               /* Wait for the EMAC interrupt to indicate that another packet has been\r
-               received.  The while() loop is only needed if INCLUDE_vTaskSuspend is\r
-               set to 0 in FreeRTOSConfig.h. */\r
-               while( xSemaphoreTake( xEMACRxEventSemaphore, portMAX_DELAY ) == pdFALSE );\r
-\r
-               /* At least one packet has been received. */\r
-               while( EMAC_CheckReceiveIndex() != FALSE )\r
-               {\r
-                       /* Obtain the length, minus the CRC.  The CRC is four bytes\r
-                       but the length is already minus 1. */\r
-                       xDataLength = ( size_t ) EMAC_GetReceiveDataSize() - ( usCRCLength - 1U );\r
-\r
-                       if( xDataLength > 0U )\r
-                       {\r
-                               /* Obtain a network buffer to pass this data into the\r
-                               stack.  No storage is required as the network buffer\r
-                               will point directly to the buffer that already holds\r
-                               the     received data. */\r
-                               pxNetworkBuffer = pxGetNetworkBufferWithDescriptor( 0, ( TickType_t ) 0 );\r
-\r
-                               if( pxNetworkBuffer != NULL )\r
-                               {\r
-                                       pxNetworkBuffer->pucBuffer = EMAC_NextPacketToRead();\r
-                                       pxNetworkBuffer->xDataLength = xDataLength;\r
-                                       xRxEvent.pvData = ( void * ) pxNetworkBuffer;\r
-\r
-                                       /* Data was received and stored.  Send a message to the IP\r
-                                       task to let it know. */\r
-                                       if( xSendEventStructToIPTask( &xRxEvent, ( TickType_t ) 0 ) == pdFAIL )\r
-                                       {\r
-                                               vReleaseNetworkBufferAndDescriptor( pxNetworkBuffer );\r
-                                               iptraceETHERNET_RX_EVENT_LOST();\r
-                                       }\r
-                               }\r
-                               else\r
-                               {\r
-                                       iptraceETHERNET_RX_EVENT_LOST();\r
-                               }\r
-\r
-                               iptraceNETWORK_INTERFACE_RECEIVE();\r
-                       }\r
-\r
-                       /* Release the frame. */\r
-                       EMAC_UpdateRxConsumeIndex();\r
-               }\r
-       }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
+/*
+FreeRTOS+TCP V2.0.11
+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
+*/
+
+/* Standard includes. */
+#include <stdint.h>
+
+/* FreeRTOS includes. */
+#include "FreeRTOS.h"
+#include "task.h"
+#include "queue.h"
+#include "semphr.h"
+
+/* Hardware abstraction. */
+#include "FreeRTOS_IO.h"
+
+/* FreeRTOS+TCP includes. */
+#include "FreeRTOS_UDP_IP.h"
+#include "FreeRTOS_Sockets.h"
+#include "NetworkBufferManagement.h"
+
+/* Driver includes. */
+#include "lpc17xx_emac.h"
+#include "lpc17xx_pinsel.h"
+
+/* Demo includes. */
+#include "NetworkInterface.h"
+
+#if ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES != 1
+       #define ipCONSIDER_FRAME_FOR_PROCESSING( pucEthernetBuffer ) eProcessBuffer
+#else
+       #define ipCONSIDER_FRAME_FOR_PROCESSING( pucEthernetBuffer ) eConsiderFrameForProcessing( ( pucEthernetBuffer ) )
+#endif
+
+/* When a packet is ready to be sent, if it cannot be sent immediately then the
+task performing the transmit will block for niTX_BUFFER_FREE_WAIT
+milliseconds.  It will do this a maximum of niMAX_TX_ATTEMPTS before giving
+up. */
+#define niTX_BUFFER_FREE_WAIT  ( pdMS_TO_TICKS( 2UL ) )
+#define niMAX_TX_ATTEMPTS              ( 5 )
+
+/* The length of the queue used to send interrupt status words from the
+interrupt handler to the deferred handler task. */
+#define niINTERRUPT_QUEUE_LENGTH       ( 10 )
+
+/*-----------------------------------------------------------*/
+
+/*
+ * A deferred interrupt handler task that processes
+ */
+static void prvEMACHandlerTask( void *pvParameters );
+
+/*-----------------------------------------------------------*/
+
+/* The queue used to communicate Ethernet events with the IP task. */
+extern QueueHandle_t xNetworkEventQueue;
+
+/* The semaphore used to wake the deferred interrupt handler task when an Rx
+interrupt is received. */
+static SemaphoreHandle_t xEMACRxEventSemaphore = NULL;
+/*-----------------------------------------------------------*/
+
+BaseType_t xNetworkInterfaceInitialise( void )
+{
+EMAC_CFG_Type Emac_Config;
+PINSEL_CFG_Type xPinConfig;
+BaseType_t xStatus, xReturn;
+extern uint8_t ucMACAddress[ 6 ];
+
+       /* Enable Ethernet Pins */
+       boardCONFIGURE_ENET_PINS( xPinConfig );
+
+       Emac_Config.Mode = EMAC_MODE_AUTO;
+       Emac_Config.pbEMAC_Addr = ucMACAddress;
+       xStatus = EMAC_Init( &Emac_Config );
+
+       LPC_EMAC->IntEnable &= ~( EMAC_INT_TX_DONE );
+
+       if( xStatus != ERROR )
+       {
+               vSemaphoreCreateBinary( xEMACRxEventSemaphore );
+               configASSERT( xEMACRxEventSemaphore );
+
+               /* The handler task is created at the highest possible priority to
+               ensure the interrupt handler can return directly to it. */
+               xTaskCreate( prvEMACHandlerTask, "EMAC", configMINIMAL_STACK_SIZE, NULL, configMAX_PRIORITIES - 1, NULL );
+
+               /* Enable the interrupt and set its priority to the minimum
+               interrupt priority.  */
+               NVIC_SetPriority( ENET_IRQn, configMAC_INTERRUPT_PRIORITY );
+               NVIC_EnableIRQ( ENET_IRQn );
+
+               xReturn = pdPASS;
+       }
+       else
+       {
+               xReturn = pdFAIL;
+       }
+
+       configASSERT( xStatus != ERROR );
+
+       return xReturn;
+}
+/*-----------------------------------------------------------*/
+
+BaseType_t xNetworkInterfaceOutput( NetworkBufferDescriptor_t * const pxNetworkBuffer )
+{
+BaseType_t xReturn = pdFAIL;
+int32_t x;
+extern void EMAC_StartTransmitNextBuffer( uint32_t ulLength );
+extern void EMAC_SetNextPacketToSend( uint8_t * pucBuffer );
+
+
+       /* Attempt to obtain access to a Tx buffer. */
+       for( x = 0; x < niMAX_TX_ATTEMPTS; x++ )
+       {
+               if( EMAC_CheckTransmitIndex() == TRUE )
+               {
+                       /* Will the data fit in the Tx buffer? */
+                       if( pxNetworkBuffer->xDataLength < EMAC_ETH_MAX_FLEN ) /*_RB_ The size needs to come from FreeRTOSIPConfig.h. */
+                       {
+                               /* Assign the buffer to the Tx descriptor that is now known to
+                               be free. */
+                               EMAC_SetNextPacketToSend( pxNetworkBuffer->pucBuffer );
+
+                               /* The EMAC now owns the buffer. */
+                               pxNetworkBuffer->pucBuffer = NULL;
+
+                               /* Initiate the Tx. */
+                               EMAC_StartTransmitNextBuffer( pxNetworkBuffer->xDataLength );
+                               iptraceNETWORK_INTERFACE_TRANSMIT();
+
+                               /* The Tx has been initiated. */
+                               xReturn = pdPASS;
+                       }
+                       break;
+               }
+               else
+               {
+                       vTaskDelay( niTX_BUFFER_FREE_WAIT );
+               }
+       }
+
+       /* Finished with the network buffer. */
+       vReleaseNetworkBufferAndDescriptor( pxNetworkBuffer );
+
+       return xReturn;
+}
+/*-----------------------------------------------------------*/
+
+void ENET_IRQHandler( void )
+{
+uint32_t ulInterruptCause;
+
+       while( ( ulInterruptCause = LPC_EMAC->IntStatus ) != 0 )
+       {
+               /* Clear the interrupt. */
+               LPC_EMAC->IntClear = ulInterruptCause;
+
+               /* Clear fatal error conditions.  NOTE:  The driver does not clear all
+               errors, only those actually experienced.  For future reference, range
+               errors are not actually errors so can be ignored. */
+               if( ( ulInterruptCause & EMAC_INT_TX_UNDERRUN ) != 0U )
+               {
+                       LPC_EMAC->Command |= EMAC_CR_TX_RES;
+               }
+
+               /* Unblock the deferred interrupt handler task if the event was an
+               Rx. */
+               if( ( ulInterruptCause & EMAC_INT_RX_DONE ) != 0UL )
+               {
+                       xSemaphoreGiveFromISR( xEMACRxEventSemaphore, NULL );
+               }
+       }
+
+       /* ulInterruptCause is used for convenience here.  A context switch is
+       wanted, but coding portEND_SWITCHING_ISR( 1 ) would likely result in a
+       compiler warning. */
+       portEND_SWITCHING_ISR( ulInterruptCause );
+}
+/*-----------------------------------------------------------*/
+
+static void prvEMACHandlerTask( void *pvParameters )
+{
+size_t xDataLength;
+const uint16_t usCRCLength = 4;
+NetworkBufferDescriptor_t *pxNetworkBuffer;
+IPStackEvent_t xRxEvent = { eNetworkRxEvent, NULL };
+
+/* This is not included in the header file for some reason. */
+extern uint8_t *EMAC_NextPacketToRead( void );
+
+       ( void ) pvParameters;
+       configASSERT( xEMACRxEventSemaphore );
+
+       for( ;; )
+       {
+               /* Wait for the EMAC interrupt to indicate that another packet has been
+               received.  The while() loop is only needed if INCLUDE_vTaskSuspend is
+               set to 0 in FreeRTOSConfig.h. */
+               while( xSemaphoreTake( xEMACRxEventSemaphore, portMAX_DELAY ) == pdFALSE );
+
+               /* At least one packet has been received. */
+               while( EMAC_CheckReceiveIndex() != FALSE )
+               {
+                       /* Obtain the length, minus the CRC.  The CRC is four bytes
+                       but the length is already minus 1. */
+                       xDataLength = ( size_t ) EMAC_GetReceiveDataSize() - ( usCRCLength - 1U );
+
+                       if( xDataLength > 0U )
+                       {
+                               /* Obtain a network buffer to pass this data into the
+                               stack.  No storage is required as the network buffer
+                               will point directly to the buffer that already holds
+                               the     received data. */
+                               pxNetworkBuffer = pxGetNetworkBufferWithDescriptor( 0, ( TickType_t ) 0 );
+
+                               if( pxNetworkBuffer != NULL )
+                               {
+                                       pxNetworkBuffer->pucBuffer = EMAC_NextPacketToRead();
+                                       pxNetworkBuffer->xDataLength = xDataLength;
+                                       xRxEvent.pvData = ( void * ) pxNetworkBuffer;
+
+                                       /* Data was received and stored.  Send a message to the IP
+                                       task to let it know. */
+                                       if( xSendEventStructToIPTask( &xRxEvent, ( TickType_t ) 0 ) == pdFAIL )
+                                       {
+                                               vReleaseNetworkBufferAndDescriptor( pxNetworkBuffer );
+                                               iptraceETHERNET_RX_EVENT_LOST();
+                                       }
+                               }
+                               else
+                               {
+                                       iptraceETHERNET_RX_EVENT_LOST();
+                               }
+
+                               iptraceNETWORK_INTERFACE_RECEIVE();
+                       }
+
+                       /* Release the frame. */
+                       EMAC_UpdateRxConsumeIndex();
+               }
+       }
+}
+/*-----------------------------------------------------------*/
+