2 FreeRTOS V8.2.0rc1 - Copyright (C) 2014 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\r
9 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
10 the terms of the GNU General Public License (version 2) as published by the
\r
11 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
13 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
14 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
15 >>! obliged to provide the source code for proprietary components !<<
\r
16 >>! outside of the FreeRTOS kernel. !<<
\r
18 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
19 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
20 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
21 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * Having a problem? Start by reading the FAQ "My application does *
\r
28 * not run, what could be wrong?". Have you defined configASSERT()? *
\r
30 * http://www.FreeRTOS.org/FAQHelp.html *
\r
32 ***************************************************************************
\r
34 ***************************************************************************
\r
36 * FreeRTOS provides completely free yet professionally developed, *
\r
37 * robust, strictly quality controlled, supported, and cross *
\r
38 * platform software that is more than just the market leader, it *
\r
39 * is the industry's de facto standard. *
\r
41 * Help yourself get started quickly while simultaneously helping *
\r
42 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
43 * tutorial book, reference manual, or both: *
\r
44 * http://www.FreeRTOS.org/Documentation *
\r
46 ***************************************************************************
\r
48 ***************************************************************************
\r
50 * Investing in training allows your team to be as productive as *
\r
51 * possible as early as possible, lowering your overall development *
\r
52 * cost, and enabling you to bring a more robust product to market *
\r
53 * earlier than would otherwise be possible. Richard Barry is both *
\r
54 * the architect and key author of FreeRTOS, and so also the world's *
\r
55 * leading authority on what is the world's most popular real time *
\r
56 * kernel for deeply embedded MCU designs. Obtaining your training *
\r
57 * from Richard ensures your team will gain directly from his in-depth *
\r
58 * product knowledge and years of usage experience. Contact Real Time *
\r
59 * Engineers Ltd to enquire about the FreeRTOS Masterclass, presented *
\r
60 * by Richard Barry: http://www.FreeRTOS.org/contact
\r
62 ***************************************************************************
\r
64 ***************************************************************************
\r
66 * You are receiving this top quality software for free. Please play *
\r
67 * fair and reciprocate by reporting any suspected issues and *
\r
68 * participating in the community forum: *
\r
69 * http://www.FreeRTOS.org/support *
\r
73 ***************************************************************************
\r
75 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
76 license and Real Time Engineers Ltd. contact details.
\r
78 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
79 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
80 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
82 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
83 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
85 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
86 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
87 licenses offer ticketed support, indemnification and commercial middleware.
\r
89 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
90 engineered and independently SIL3 certified version for use in safety and
\r
91 mission critical applications that require provable dependability.
\r
97 * This file, along with DemoIPTrace.h, provides a basic example use of the
\r
98 * FreeRTOS+UDP trace macros. The statistics gathered here can be viewed in
\r
99 * the command line interface.
\r
100 * See http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_UDP/UDP_IP_Trace.shtml
\r
103 #ifndef DEMO_IP_TRACE_MACROS_H
\r
104 #define DEMO_IP_TRACE_MACROS_H
\r
106 typedef void ( *vTraceAction_t )( uint32_t *, uint32_t );
\r
108 /* Type that defines each statistic being gathered. */
\r
109 typedef struct ExampleDebugStatEntry
\r
111 uint8_t ucIdentifier; /* Unique identifier for statistic. */
\r
112 const uint8_t * const pucDescription; /* Text description for the statistic. */
\r
113 vTraceAction_t vPerformAction; /* Action to perform when the statistic is updated (increment counter, store minimum value, store maximum value, etc. */
\r
114 uint32_t ulData; /* The meaning of this data is dependent on the trace macro ID. */
\r
115 } xExampleDebugStatEntry_t;
\r
117 /* Unique identifiers used to locate the entry for each trace macro in the
\r
118 xIPTraceValues[] table defined in DemoIPTrace.c. */
\r
119 #define iptraceID_NETWORK_INTERFACE_RECEIVE 0
\r
120 #define iptraceID_NETWORK_INTERFACE_TRANSMIT 1
\r
121 #define iptraceID_PACKET_DROPPED_TO_GENERATE_ARP 2
\r
122 /* Do not change IDs above this line as the ID is shared with a FreeRTOS+Nabto
\r
124 #define iptraceID_NETWORK_BUFFER_OBTAINED 3
\r
125 #define iptraceID_NETWORK_BUFFER_OBTAINED_FROM_ISR 4
\r
126 #define iptraceID_NETWORK_EVENT_RECEIVED 5
\r
127 #define iptraceID_FAILED_TO_OBTAIN_NETWORK_BUFFER 6
\r
128 #define iptraceID_ARP_TABLE_ENTRY_EXPIRED 7
\r
129 #define iptraceID_FAILED_TO_CREATE_SOCKET 8
\r
130 #define iptraceID_RECVFROM_DISCARDING_BYTES 9
\r
131 #define iptraceID_ETHERNET_RX_EVENT_LOST 10
\r
132 #define iptraceID_STACK_TX_EVENT_LOST 11
\r
133 #define ipconfigID_BIND_FAILED 12
\r
134 #define iptraceID_RECVFROM_TIMEOUT 13
\r
135 #define iptraceID_SENDTO_DATA_TOO_LONG 14
\r
136 #define iptraceID_SENDTO_SOCKET_NOT_BOUND 15
\r
137 #define iptraceID_NO_BUFFER_FOR_SENDTO 16
\r
138 #define iptraceID_WAIT_FOR_TX_DMA_DESCRIPTOR 17
\r
139 #define iptraceID_FAILED_TO_NOTIFY_SELECT_GROUP 18
\r
141 /* It is possible to remove the trace macros using the
\r
142 configINCLUDE_DEMO_DEBUG_STATS setting in FreeRTOSIPConfig.h. */
\r
143 #if configINCLUDE_DEMO_DEBUG_STATS == 1
\r
145 /* The trace macro definitions themselves. Any trace macros left undefined
\r
146 will default to be empty macros. */
\r
147 #define iptraceNETWORK_BUFFER_OBTAINED( pxBufferAddress ) vExampleDebugStatUpdate( iptraceID_NETWORK_BUFFER_OBTAINED, uxQueueMessagesWaiting( ( xQueueHandle ) xNetworkBufferSemaphore ) )
\r
148 #define iptraceNETWORK_BUFFER_OBTAINED_FROM_ISR( pxBufferAddress ) vExampleDebugStatUpdate( iptraceID_NETWORK_BUFFER_OBTAINED, uxQueueMessagesWaiting( ( xQueueHandle ) xNetworkBufferSemaphore ) )
\r
150 #define iptraceNETWORK_EVENT_RECEIVED( eEvent ) { \
\r
151 uint16_t usSpace; \
\r
152 usSpace = ( uint16_t ) uxQueueMessagesWaiting( xNetworkEventQueue ); \
\r
153 /* Minus one as an event was removed before the space was queried. */ \
\r
154 usSpace = ( ipconfigEVENT_QUEUE_LENGTH - usSpace ) - 1; \
\r
155 vExampleDebugStatUpdate( iptraceID_NETWORK_EVENT_RECEIVED, usSpace ); \
\r
158 #define iptraceFAILED_TO_OBTAIN_NETWORK_BUFFER() vExampleDebugStatUpdate( iptraceID_FAILED_TO_OBTAIN_NETWORK_BUFFER, 0 )
\r
159 #define iptraceARP_TABLE_ENTRY_EXPIRED( ulIPAddress ) vExampleDebugStatUpdate( iptraceID_ARP_TABLE_ENTRY_EXPIRED, 0 )
\r
160 #define iptracePACKET_DROPPED_TO_GENERATE_ARP( ulIPAddress ) vExampleDebugStatUpdate( iptraceID_PACKET_DROPPED_TO_GENERATE_ARP, 0 )
\r
161 #define iptraceFAILED_TO_CREATE_SOCKET() vExampleDebugStatUpdate( iptraceID_FAILED_TO_CREATE_SOCKET, 0 )
\r
162 #define iptraceRECVFROM_DISCARDING_BYTES( xNumberOfBytesDiscarded ) vExampleDebugStatUpdate( iptraceID_RECVFROM_DISCARDING_BYTES, 0 )
\r
163 #define iptraceETHERNET_RX_EVENT_LOST() vExampleDebugStatUpdate( iptraceID_ETHERNET_RX_EVENT_LOST, 0 )
\r
164 #define iptraceSTACK_TX_EVENT_LOST( xEvent ) vExampleDebugStatUpdate( iptraceID_STACK_TX_EVENT_LOST, 0 )
\r
165 #define iptraceBIND_FAILED( xSocket, usPort ) vExampleDebugStatUpdate( ipconfigID_BIND_FAILED, 0 )
\r
166 #define iptraceNETWORK_INTERFACE_TRANSMIT() vExampleDebugStatUpdate( iptraceID_NETWORK_INTERFACE_TRANSMIT, 0 )
\r
167 #define iptraceRECVFROM_TIMEOUT() vExampleDebugStatUpdate( iptraceID_RECVFROM_TIMEOUT, 0 )
\r
168 #define iptraceSENDTO_DATA_TOO_LONG() vExampleDebugStatUpdate( iptraceID_SENDTO_DATA_TOO_LONG, 0 )
\r
169 #define iptraceSENDTO_SOCKET_NOT_BOUND() vExampleDebugStatUpdate( iptraceID_SENDTO_SOCKET_NOT_BOUND, 0 )
\r
170 #define iptraceNO_BUFFER_FOR_SENDTO() vExampleDebugStatUpdate( iptraceID_NO_BUFFER_FOR_SENDTO, 0 )
\r
171 #define iptraceWAITING_FOR_TX_DMA_DESCRIPTOR() vExampleDebugStatUpdate( iptraceID_WAIT_FOR_TX_DMA_DESCRIPTOR, 0 )
\r
172 #define iptraceFAILED_TO_NOTIFY_SELECT_GROUP( xSocket ) vExampleDebugStatUpdate( iptraceID_FAILED_TO_NOTIFY_SELECT_GROUP, 0 )
\r
173 #define iptraceNETWORK_INTERFACE_RECEIVE() vExampleDebugStatUpdate( iptraceID_NETWORK_INTERFACE_RECEIVE, 0 )
\r
176 * The function that updates a line in the xIPTraceValues table.
\r
178 void vExampleDebugStatUpdate( uint8_t ucIdentifier, uint32_t ulValue );
\r
181 * Returns the number of entries in the xIPTraceValues table.
\r
183 BaseType_t xExampleDebugStatEntries( void );
\r
185 #endif /* configINCLUDE_DEMO_DEBUG_STATS == 1 */
\r
188 #endif /* DEMO_IP_TRACE_MACROS_H */
\r
projects / freertos / blob