git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Demo/Common/FreeRTOS_Plus_UDP_Demos/TraceMacros/Example1/DemoIPTrace.c

   1 /*\r
   2     FreeRTOS V7.4.0 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not itcan be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 /* \r
  76  * This file, along with DemoIPTrace.h, provides a basic example use of the\r
  77  * FreeRTOS+UDP trace macros.  The statistics gathered here can be viewed in\r
  78  * the command line interface.\r
  79  * See http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_UDP/UDP_IP_Trace.shtml\r
  80  */\r
  81 \r
  82 /* Standard includes. */\r
  83 #include <stdint.h>\r
  84 \r
  85 /* FreeRTOS includes. */ \r
  86 #include "FreeRTOS.h"\r
  87 #include "task.h"\r
  88 \r
  89 /* FreeRTOS+UDP includes. */\r
  90 #include "FreeRTOS_UDP_IP.h"\r
  91 #include "DemoIPTrace.h"\r
  92 \r
  93 /* It is possible to remove the trace macros using the \r
  94 configINCLUDE_DEMO_DEBUG_STATS setting in FreeRTOSIPConfig.h. */\r
  95 #if configINCLUDE_DEMO_DEBUG_STATS == 1\r
  96 \r
  97 /*\r
  98  * Each row in the xIPTraceValues[] table contains a pointer to a function that\r
  99  * updates the value for that row.  Rows that latch the lowest value point to\r
 100  * this function (for example, this function can be used to latch the lowest\r
 101  * number of network buffers that were available during the execution of the\r
 102  * stack).\r
 103  */\r
 104 static void prvStoreLowest( uint32_t *pulCurrentValue, uint32_t ulCount );\r
 105 \r
 106 /*\r
 107  * Each row in the xIPTraceValues[] table contains a pointer to a function that\r
 108  * updates the value for that row.  Rows that simply increment an event count\r
 109  * point to this function.\r
 110  */\r
 111 static void prvIncrementEventCount( uint32_t *pulCurrentValue, uint32_t ulCount );\r
 112 \r
 113 \r
 114 xExampleDebugStatEntry_t xIPTraceValues[] =\r
 115 {\r
 116         /* Comment out array entries to remove individual trace items. */\r
 117 \r
 118         { iptraceID_NETWORK_BUFFER_OBTAINED,                    ( const uint8_t * const ) "Lowest ever available network buffers",                              prvStoreLowest, 0xffffUL },\r
 119         { iptraceID_NETWORK_EVENT_RECEIVED,                             ( const uint8_t * const ) "Lowest ever free space in network event queue",              prvStoreLowest, 0xffffUL },\r
 120         { iptraceID_FAILED_TO_OBTAIN_NETWORK_BUFFER,    ( const uint8_t * const ) "Count of failed attempts to obtain a network buffer",prvIncrementEventCount, 0 },\r
 121         { iptraceID_ARP_TABLE_ENTRY_EXPIRED,                    ( const uint8_t * const ) "Count of expired ARP entries",                                               prvIncrementEventCount, 0 },\r
 122         { iptraceID_PACKET_DROPPED_TO_GENERATE_ARP,             ( const uint8_t * const ) "Count of packets dropped to generate ARP",                   prvIncrementEventCount, 0 },\r
 123         { iptraceID_FAILED_TO_CREATE_SOCKET,                    ( const uint8_t * const ) "Count of failures to create a socket",                               prvIncrementEventCount, 0 },\r
 124         { iptraceID_RECVFROM_DISCARDING_BYTES,                  ( const uint8_t * const ) "Count of times recvfrom() has discarding bytes",             prvIncrementEventCount, 0 },\r
 125         { iptraceID_ETHERNET_RX_EVENT_LOST,                             ( const uint8_t * const ) "Count of lost Ethenret Rx events (event queue full?)",prvIncrementEventCount, 0 },\r
 126         { iptraceID_STACK_TX_EVENT_LOST,                                ( const uint8_t * const ) "Count of lost IP stack events (event queue full?)",  prvIncrementEventCount, 0 },\r
 127         { ipconfigID_BIND_FAILED,                                               ( const uint8_t * const ) "Count of failed calls to bind()",                                    prvIncrementEventCount, 0 },\r
 128         { iptraceID_NETWORK_INTERFACE_TRANSMIT,                 ( const uint8_t * const ) "Count of transmitted packets",                                               prvIncrementEventCount, 0 },\r
 129         { iptraceID_RECVFROM_TIMEOUT,                                   ( const uint8_t * const ) "Count of receive timeouts",                                                  prvIncrementEventCount, 0 },\r
 130         { iptraceID_SENDTO_DATA_TOO_LONG,                               ( const uint8_t * const ) "Count of failed sends due to oversized payload",             prvIncrementEventCount, 0 },\r
 131         { iptraceID_SENDTO_SOCKET_NOT_BOUND,                    ( const uint8_t * const ) "Count of failed sends due to unbound socket",                prvIncrementEventCount, 0 },\r
 132         { iptraceID_NO_BUFFER_FOR_SENDTO,                               ( const uint8_t * const ) "Count of failed transmits due to timeout",                   prvIncrementEventCount, 0 },\r
 133         { iptraceID_WAIT_FOR_TX_DMA_DESCRIPTOR,                 ( const uint8_t * const ) "Number of times task had to wait to obtain a DMA Tx descriptor", prvIncrementEventCount, 0 },\r
 134         { iptraceID_FAILED_TO_NOTIFY_SELECT_GROUP,              ( const uint8_t * const ) "Failed to notify select group",                                              prvIncrementEventCount, 0 }\r
 135 };\r
 136 \r
 137 /*-----------------------------------------------------------*/\r
 138 \r
 139 portBASE_TYPE xExampleDebugStatEntries( void )\r
 140 {\r
 141         /* Return the number of entries in the xIPTraceValues[] table. */\r
 142         return ( portBASE_TYPE ) ( sizeof( xIPTraceValues ) / sizeof( xExampleDebugStatEntry_t ) );\r
 143 }\r
 144 /*-----------------------------------------------------------*/\r
 145 \r
 146 void vExampleDebugStatUpdate( uint8_t ucIdentifier, uint32_t ulValue )\r
 147 {\r
 148 portBASE_TYPE xIndex;\r
 149 const portBASE_TYPE xEntries = sizeof( xIPTraceValues ) / sizeof( xExampleDebugStatEntry_t );\r
 150 \r
 151         /* Update an entry in the xIPTraceValues[] table.  Each row in the table\r
 152         includes a pointer to a function that performs the actual update.  This\r
 153         function just executes the update function from that table row. */\r
 154         for( xIndex = 0; xIndex < xEntries; xIndex++ )\r
 155         {\r
 156                 if( xIPTraceValues[ xIndex ].ucIdentifier == ucIdentifier )\r
 157                 {\r
 158                         xIPTraceValues[ xIndex ].vPerformAction( &( xIPTraceValues[ xIndex ].ulData ), ulValue );\r
 159                         break;\r
 160                 }\r
 161         }\r
 162 \r
 163         configASSERT( xIndex != xEntries );\r
 164 }\r
 165 /*-----------------------------------------------------------*/\r
 166 \r
 167 static void prvIncrementEventCount( uint32_t *pulCurrentValue, uint32_t ulCount )\r
 168 {\r
 169         /* Each row in the xIPTraceValues[] table contains a pointer to a function\r
 170         that updates the value for that row.  Rows that simply increment an event\r
 171         count point to this function. */\r
 172         ( void ) ulCount;\r
 173         ( *pulCurrentValue )++;\r
 174 }\r
 175 /*-----------------------------------------------------------*/\r
 176 \r
 177 static void prvStoreLowest( uint32_t *pulCurrentValue, uint32_t ulCount )\r
 178 {\r
 179         /* Each row in the xIPTraceValues[] table contains a pointer to a function\r
 180         that updates the value for that row.  Rows that latch the lowest value\r
 181         point to this function (for example, this function can be used to latch\r
 182         the lowest number of network buffers that were available during the\r
 183         execution of the stack). */\r
 184         if( ulCount < *pulCurrentValue )\r
 185         {\r
 186                 *pulCurrentValue = ulCount;\r
 187         }\r
 188 }\r
 189 /*-----------------------------------------------------------*/\r
 190 \r
 191 \r
 192 #endif /* configINCLUDE_DEMO_DEBUG_STATS == 1 */\r
 193 \r
 194 \r
 195 \r
 196 \r