]> git.sur5r.net Git - freertos/blob
368187a913869cedae9edd59d5762c78e606ca0e
[freertos] /
1 /******************************************************************************* \r
2  * FreeRTOS+Trace v2.3.0 Recorder Library\r
3  * Percepio AB, www.percepio.com\r
4  *\r
5  * trcPort.h\r
6  *\r
7  * Contains together with trcPort.c all portability issues of the trace recorder \r
8  * library.\r
9  *\r
10  * Terms of Use\r
11  * This software is copyright Percepio AB. The recorder library is free for\r
12  * use together with Percepio products. You may distribute the recorder library\r
13  * in its original form, including modifications in trcPort.c and trcPort.h\r
14  * given that these modification are clearly marked as your own modifications\r
15  * and documented in the initial comment section of these source files. \r
16  * This software is the intellectual property of Percepio AB and may not be \r
17  * sold or in other ways commercially redistributed without explicit written \r
18  * permission by Percepio AB.\r
19  *\r
20  * Disclaimer \r
21  * The trace tool and recorder library is being delivered to you AS IS and \r
22  * Percepio AB makes no warranty as to its use or performance. Percepio AB does \r
23  * not and cannot warrant the performance or results you may obtain by using the \r
24  * software or documentation. Percepio AB make no warranties, express or \r
25  * implied, as to noninfringement of third party rights, merchantability, or \r
26  * fitness for any particular purpose. In no event will Percepio AB, its \r
27  * technology partners, or distributors be liable to you for any consequential, \r
28  * incidental or special damages, including any lost profits or lost savings, \r
29  * even if a representative of Percepio AB has been advised of the possibility \r
30  * of such damages, or for any claim by any third party. Some jurisdictions do \r
31  * not allow the exclusion or limitation of incidental, consequential or special \r
32  * damages, or the exclusion of implied warranties or limitations on how long an \r
33  * implied warranty may last, so the above limitations may not apply to you.\r
34  *\r
35  * FreeRTOS+Trace is available as Free Edition and in two premium editions.\r
36  * You may use the premium features during 30 days for evaluation.\r
37  * Download FreeRTOS+Trace at http://www.percepio.com/products/downloads/\r
38  *\r
39  * Copyright Percepio AB, 2012.\r
40  * www.percepio.com\r
41  ******************************************************************************/\r
42 \r
43 #ifndef TRCPORT_H\r
44 #define TRCPORT_H\r
45 \r
46 /* If FreeRTOS Win32 port */\r
47 #ifdef WIN32\r
48 \r
49    #undef _WIN32_WINNT\r
50    #define _WIN32_WINNT 0x0600\r
51 \r
52    /* Standard includes. */\r
53    #include <stdio.h>\r
54    #include <windows.h>\r
55    #include <direct.h>\r
56 \r
57 /*******************************************************************************\r
58  * The Win32 port by default saves the trace to file and then kills the\r
59  * program when the recorder is stopped, to facilitate quick, simple tests\r
60  * of the recorder.\r
61  ******************************************************************************/\r
62    #define WIN32_PORT_SAVE_WHEN_STOPPED 1\r
63    #define WIN32_PORT_EXIT_WHEN_STOPPED 1\r
64 #else\r
65         #define WIN32_PORT_SAVE_WHEN_STOPPED 0\r
66         #define WIN32_PORT_EXIT_WHEN_STOPPED 0\r
67 #endif\r
68 \r
69 #define DIRECTION_INCREMENTING 1\r
70 #define DIRECTION_DECREMENTING 2\r
71 \r
72 /******************************************************************************\r
73  * Supported ports\r
74  * \r
75  * PORT_HWIndependent\r
76  * A hardware independent fallback option for event timestamping. Provides low \r
77  * resolution timestamps based on the OS tick.\r
78  * This may be used on the Win32 port, but may also be used on embedded hardware \r
79  * platforms. Note that this gives suboptimal display in FreeRTOS+Trace. All \r
80  * time durations will be truncated to the OS tick frequency, typically 1 KHz. \r
81  * This means that a task or ISR that executes in less than 1 ms get an exection \r
82  * time of zero. They are however still visible in FreeRTOS+Trace. \r
83  *\r
84  * PORT_Win32\r
85  * "Accurate" timestamping based on the Windows permance counter. Note that\r
86  * this gives the host machine time, not the simulated FreeRTOS time (tick \r
87  * count). The timing of the Win32 FreeRTOS build is not real-time, since it \r
88  * depends on the scheduling and tick rate of Windows, which is very slow.\r
89  *\r
90  * Officially supported hardware timer ports:\r
91  * - PORT_Atmel_AT91SAM7\r
92  * - PORT_Atmel_UC3A0\r
93  * - PORT_ARM_CortexM \r
94  * - PORT_Renesas_RX600\r
95  * - PORT_Microchip_dsPIC_AND_PIC24\r
96  *\r
97  * We also provide several "unofficial" hardware-specific ports. There have \r
98  * been developed by external contributors, and have not yet been verified \r
99  * by Percepio AB. Let us know if you have problems getting these to work.\r
100  * \r
101  * Unoffical hardware specific ports provided are:\r
102  * - PORT_TEXAS_INSTRUMENTS_TMS570\r
103  * - PORT_TEXAS_INSTRUMENTS_MSP430\r
104  * - PORT_MICROCHIP_PIC32\r
105  * - PORT_XILINX_PPC405\r
106  * - PORT_XILINX_PPC440\r
107  * - PORT_XILINX_MICROBLAZE\r
108  * - PORT_NXP_LPC210X\r
109  *\r
110  *****************************************************************************/\r
111 \r
112 #define PORT_NOT_SET                          -1\r
113 \r
114 /*** Officially supported hardware timer ports *******************************/\r
115 #define PORT_HWIndependent                     0\r
116 #define PORT_Win32                             1\r
117 #define PORT_Atmel_AT91SAM7                    2\r
118 #define PORT_Atmel_UC3A0                       3\r
119 #define PORT_ARM_CortexM                       4\r
120 #define PORT_Renesas_RX600                     5\r
121 #define PORT_Microchip_dsPIC_AND_PIC24         6\r
122 \r
123 /*** Unofficial ports, provided by external developers, not yet verified *****/\r
124 #define PORT_TEXAS_INSTRUMENTS_TMS570          7\r
125 #define PORT_TEXAS_INSTRUMENTS_MSP430          8\r
126 #define PORT_MICROCHIP_PIC32                   9\r
127 #define PORT_XILINX_PPC405                    10\r
128 #define PORT_XILINX_PPC440                    11\r
129 #define PORT_XILINX_MICROBLAZE                12\r
130 #define PORT_NXP_LPC210X                      13\r
131 \r
132 /*** Select your port here! **************************************************/\r
133 #define SELECTED_PORT PORT_ARM_CortexM\r
134 /*****************************************************************************/\r
135 \r
136 #if (SELECTED_PORT == PORT_NOT_SET) \r
137 #error "You need to define SELECTED_PORT here!"\r
138 #endif\r
139 \r
140 /*******************************************************************************\r
141  * IRQ_PRIORITY_ORDER\r
142  *\r
143  * Macro which should be defined as an integer of 0 or 1.\r
144  *\r
145  * This should be 0 if lower irq priority values implies higher priority \r
146  * levels, such as on ARM Cortex M. If the opposite scheme is used, i.e., \r
147  * if higher irq priority values means higher priority, this should be 1.\r
148  *\r
149  * This setting is not critical. It is used only to sort and colorize the \r
150  * interrupts in priority order, in case you record interrupts using\r
151  * the vTraceStoreISRBegin and vTraceStoreISREnd routines.\r
152  *\r
153  * We provide this setting for some hardware architectures below:\r
154  * - ARM Cortex M:       0 (lower irq priority values are more significant)\r
155  * - Atmel AT91SAM7x:    1 (higher irq priority values are more significant)\r
156  * - Atmel AVR32:        1 (higher irq priority values are more significant)\r
157  * - Renesas RX600:      1 (higher irq priority values are more significant)\r
158  * - Microchip PIC24:    0 (lower irq priority values are more significant)\r
159  * - Microchip dsPIC:    0 (lower irq priority values are more significant)\r
160  * - TI TMS570:          0 (lower irq priority values are more significant)\r
161  * - Freescale HCS08:    0 (lower irq priority values are more significant)\r
162  * - Freescale HCS12:    0 (lower irq priority values are more significant)\r
163  * - PowerPC 405:        0 (lower irq priority values are more significant)\r
164  * - PowerPC 440:        0 (lower irq priority values are more significant)\r
165  * - Freescale ColdFire: 1 (higher irq priority values are more significant)\r
166  * - NXP LPC210x:        0 (lower irq priority values are more significant)\r
167  * - MicroBlaze:        0  (lower irq priority values are more significant)\r
168  *\r
169  * If your chip is not on the above list, and you perhaps know this detail by \r
170  * heart, please inform us by e-mail to support@percepio.com.\r
171  *\r
172  ******************************************************************************\r
173  *\r
174  * HWTC Macros \r
175  *\r
176  * These four HWTC macros provides a hardware isolation layer representing a \r
177  * generic hardware timer/counter used for driving the operating system tick, \r
178  * such as the SysTick feature of ARM Cortex M3/M4, or the PIT of the Atmel \r
179  * AT91SAM7X.\r
180  *\r
181  * HWTC_COUNT: The current value of the counter. This is expected to be reset \r
182  * a each tick interrupt. Thus, when the tick handler starts, the counter has \r
183  * already wrapped.\r
184  *\r
185  * HWTC_COUNT_DIRECTION: Should be one of:\r
186  * - DIRECTION_INCREMENTING - for hardware timer/counters of incrementing type\r
187  *   such as the PIT on Atmel AT91SAM7X.\r
188  *   When the counter value reach HWTC_PERIOD, it is reset to zero and the\r
189  *   interrupt is signaled.\r
190  * - DIRECTION_DECREMENTING - for hardware timer/counters of decrementing type\r
191  *   such as the SysTick on ARM Cortex M3/M4 chips.\r
192  *   When the counter value reach 0, it is reset to HWTC_PERIOD and the\r
193  *   interrupt is signaled.\r
194  *\r
195  * HWTC_PERIOD: The number of increments or decrements of HWTC_COUNT between\r
196  * two tick interrupts. This should preferably be mapped to the reload\r
197  * register of the hardware timer, to make it more portable between chips in the \r
198  * same family. The macro should in most cases be (reload register + 1).\r
199  *\r
200  * HWTC_DIVISOR: If the timer frequency is very high, like on the Cortex M chips\r
201  * (where the SysTick runs at the core clock frequency), the "differential \r
202  * timestamping" used in the recorder will more frequently insert extra XTS \r
203  * events to store the timestamps, which increases the event buffer usage. \r
204  * In such cases, to reduce the number of XTS events and thereby get longer \r
205  * traces, you use HWTC_DIVISOR to scale down the timestamps and frequency.\r
206  * Assuming a OS tick rate of 1 KHz, it is suggested to keep the effective timer\r
207  * frequency below 65 MHz to avoid an excessive amount of XTS events. Thus, a\r
208  * Cortex M chip running at 72 MHZ should use a HWTC_DIVISOR of 2, while a \r
209  * faster chip require a higher HWTC_DIVISOR value. \r
210  *\r
211  * The HWTC macros and uiTracePortGetTimeStamp is the main porting issue\r
212  * or the trace recorder library. Typically you should not need to change\r
213  * the code of uiTracePortGetTimeStamp if using the HWTC macros.\r
214  *\r
215  * FREE LICENSE OFFER FROM PERCEPIO\r
216  *\r
217  * For silicon companies and non-corporate FreeRTOS users (researchers, students,\r
218  * hobbyists or early-phase startups) we have the following offer: \r
219  * Provide a hardware port for our FreeRTOS recorder and get a FREE single-user\r
220  * license for FreeRTOS+Trace Professional Edition. Read more about this offer\r
221  * at www.percepio.com or contact us directly at support@percepio.com.\r
222  *\r
223  ******************************************************************************/\r
224 \r
225 #if (SELECTED_PORT == PORT_Win32)\r
226     \r
227     #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING\r
228     #define HWTC_COUNT (ulGetRunTimeCounterValue())\r
229     #define HWTC_PERIOD 0\r
230     #define HWTC_DIVISOR 1\r
231     \r
232     #define IRQ_PRIORITY_ORDER 1  // Please update according to your hardware...\r
233 \r
234 #elif (SELECTED_PORT == PORT_HWIndependent)\r
235     \r
236     #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING\r
237     #define HWTC_COUNT 0\r
238     #define HWTC_PERIOD 1\r
239     #define HWTC_DIVISOR 1\r
240 \r
241     #define IRQ_PRIORITY_ORDER 1  // Please update according to your hardware...\r
242 \r
243 #elif (SELECTED_PORT == PORT_Atmel_AT91SAM7)\r
244 \r
245     /* HWTC_PERIOD is hardcoded for AT91SAM7X256-EK Board (48 MHz)\r
246     A more generic solution is to get the period from pxPIT->PITC_PIMR */\r
247     \r
248     #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING\r
249     #define HWTC_COUNT (AT91C_BASE_PITC->PITC_PIIR & 0xFFFFF)\r
250     #define HWTC_PERIOD 2995 \r
251     #define HWTC_DIVISOR 1\r
252 \r
253     #define IRQ_PRIORITY_ORDER 1  // higher irq priority values are more significant\r
254 \r
255 #elif (SELECTED_PORT == PORT_Atmel_UC3A0) \r
256   \r
257     /* For Atmel AVR32 (AT32UC3A) */\r
258   \r
259     #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING\r
260     #define HWTC_COUNT sysreg_read(AVR32_COUNT)\r
261     #define HWTC_PERIOD ( configCPU_CLOCK_HZ / configTICK_RATE_HZ )\r
262     #define HWTC_DIVISOR 1    \r
263 \r
264     #define IRQ_PRIORITY_ORDER 1  // higher irq priority values are more significant\r
265 \r
266 #elif (SELECTED_PORT == PORT_ARM_CortexM)\r
267 \r
268     /* For all chips using ARM Cortex M cores */\r
269 \r
270     #define HWTC_COUNT_DIRECTION DIRECTION_DECREMENTING\r
271     #define HWTC_COUNT (*((uint32_t*)0xE000E018))\r
272     #define HWTC_PERIOD ((*(uint32_t*)0xE000E014) + 1)\r
273     #define HWTC_DIVISOR 2\r
274     \r
275     #define IRQ_PRIORITY_ORDER 0  // lower irq priority values are more significant\r
276 \r
277 #elif (SELECTED_PORT == PORT_Renesas_RX600)    \r
278 \r
279     #include "iodefine.h"\r
280 \r
281     #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING\r
282     #define HWTC_COUNT (CMT0.CMCNT)\r
283     #define HWTC_PERIOD ((((configPERIPHERAL_CLOCK_HZ/configTICK_RATE_HZ)-1)/8))\r
284     #define HWTC_DIVISOR 1\r
285 \r
286     #define IRQ_PRIORITY_ORDER 1  // higher irq priority values are more significant\r
287 \r
288 #elif (SELECTED_PORT == PORT_Microchip_dsPIC_AND_PIC24) \r
289 \r
290     /* For Microchip PIC24 and dsPIC (16 bit) */\r
291 \r
292     /* Note: The trace library was originally designed for 32-bit MCUs, and is slower\r
293        than intended on 16-bit MCUs. Storing an event on a PIC24 takes about 70 µs. \r
294        In comparison, 32-bit MCUs are often 10-20 times faster. If recording overhead \r
295        becomes a problem on PIC24, use the filters to exclude less interresting tasks \r
296        or system calls. */\r
297 \r
298     #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING\r
299     #define HWTC_COUNT (TMR1)\r
300     #define HWTC_PERIOD (PR1+1)\r
301     #define HWTC_DIVISOR 1\r
302 \r
303     #define IRQ_PRIORITY_ORDER 0  // lower irq priority values are more significant\r
304 \r
305 #elif (SELECTED_PORT == PORT_NXP_LPC210X)\r
306     /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */\r
307     \r
308     /* Tested with LPC2106, but should work with most LPC21XX chips.\r
309        Assumption: prescaler is 1:1 (this setting is hardcoded in \r
310        FreeRTOS port for LPC21XX) */\r
311       \r
312     #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING\r
313     #define HWTC_COUNT  *((uint32_t *)0xE0004008 )\r
314     #define HWTC_PERIOD ( configCPU_CLOCK_HZ / configTICK_RATE_HZ ) \r
315     #define HWTC_DIVISOR 1    \r
316 \r
317     #define IRQ_PRIORITY_ORDER 0  // lower irq priority values are more significant\r
318 \r
319 #elif (SELECTED_PORT == PORT_TEXAS_INSTRUMENTS_TMS570)\r
320     /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */\r
321 \r
322     #define RTIFRC0 *((uint32_t *)0xFFFFFC10)\r
323     #define RTICOMP0 *((uint32_t *)0xFFFFFC50)\r
324     #define RTIUDCP0 *((uint32_t *)0xFFFFFC54)\r
325     #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING\r
326     #define HWTC_COUNT (RTIFRC0 - (RTICOMP0 - RTIUDCP0))\r
327     #define HWTC_PERIOD (RTIUDCP0)\r
328     #define HWTC_DIVISOR 1\r
329 \r
330     #define IRQ_PRIORITY_ORDER 0  // lower irq priority values are more significant\r
331 \r
332 #elif (SELECTED_PORT == PORT_TEXAS_INSTRUMENTS_MSP430)\r
333     /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */\r
334 \r
335     #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING\r
336     #define HWTC_COUNT (TA0R)\r
337     #define HWTC_PERIOD configCPU_CLOCKS_PER_TICK      \r
338     #define HWTC_DIVISOR 1\r
339 \r
340     #define IRQ_PRIORITY_ORDER 1  // higher irq priority values are more significant\r
341 \r
342 #elif (SELECTED_PORT == PORT_MICROCHIP_PIC32)\r
343     /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */\r
344 \r
345     #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING\r
346     #define HWTC_COUNT (ReadTimer1())     /* Should be available in BSP */\r
347     #define HWTC_PERIOD (ReadPeriod1()+1) /* Should be available in BSP */\r
348     #define HWTC_DIVISOR 1\r
349 \r
350     #define IRQ_PRIORITY_ORDER 0  // lower irq priority values are more significant\r
351 \r
352 #elif (SELECTED_PORT == PORT_XILINX_PPC405) \r
353     /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */\r
354 \r
355     #define HWTC_COUNT_DIRECTION DIRECTION_DECREMENTING\r
356     #define HWTC_COUNT  mfspr( 0x3db)\r
357     #define HWTC_PERIOD ( configCPU_CLOCK_HZ / configTICK_RATE_HZ )\r
358     #define HWTC_DIVISOR 1\r
359 \r
360     #define IRQ_PRIORITY_ORDER 0  // lower irq priority values are more significant\r
361 \r
362 #elif (SELECTED_PORT == PORT_XILINX_PPC440) \r
363     /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */\r
364 \r
365     /* This should work with most PowerPC chips */\r
366     \r
367     #define HWTC_COUNT_DIRECTION DIRECTION_DECREMENTING\r
368     #define HWTC_COUNT  mfspr( 0x016 )\r
369     #define HWTC_PERIOD ( configCPU_CLOCK_HZ / configTICK_RATE_HZ )\r
370     #define HWTC_DIVISOR 1    \r
371 \r
372     #define IRQ_PRIORITY_ORDER 0  // lower irq priority values are more significant\r
373     \r
374 #elif (SELECTED_PORT == PORT_XILINX_MICROBLAZE)\r
375     /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */\r
376 \r
377     /* This should work with most Microblaze configurations\r
378      * This port is based on the official FreeRTOS Microlaze port and example application.\r
379      * It uses the AXI Timer 0 - the tick interrupt source.\r
380      * If an AXI Timer 0 peripheral is available on your hardware platform, no modifications are required.\r
381      */\r
382     #include "xtmrctr_l.h"\r
383 \r
384     #define HWTC_COUNT_DIRECTION DIRECTION_DECREMENTING\r
385     #define HWTC_COUNT XTmrCtr_GetTimerCounterReg( XPAR_TMRCTR_0_BASEADDR, 0 )\r
386     #define HWTC_PERIOD ( configCPU_CLOCK_HZ / configTICK_RATE_HZ )\r
387     #define HWTC_DIVISOR 16\r
388 \r
389     #define IRQ_PRIORITY_ORDER 0  // lower irq priority values are more significant\r
390 \r
391 #elif (SELECTED_PORT != PORT_NOT_SET)\r
392 \r
393     #error "SELECTED_PORT had unsupported value!"\r
394     #define SELECTED_PORT PORT_NOT_SET\r
395 \r
396 #endif\r
397 \r
398 #if (SELECTED_PORT != PORT_NOT_SET)\r
399     \r
400     #ifndef HWTC_COUNT_DIRECTION\r
401     #error "HWTC_COUNT_DIRECTION is not set!"\r
402     #endif \r
403     \r
404     #ifndef HWTC_COUNT\r
405     #error "HWTC_COUNT is not set!"    \r
406     #endif \r
407     \r
408     #ifndef HWTC_PERIOD\r
409     #error "HWTC_PERIOD is not set!"\r
410     #endif \r
411     \r
412     #ifndef HWTC_DIVISOR\r
413     #error "HWTC_DIVISOR is not set!"    \r
414     #endif \r
415     \r
416     #ifndef IRQ_PRIORITY_ORDER\r
417     #error "IRQ_PRIORITY_ORDER is not set!"\r
418     #elif (IRQ_PRIORITY_ORDER != 0) && (IRQ_PRIORITY_ORDER != 1)\r
419     #error "IRQ_PRIORITY_ORDER has bad value!"\r
420     #endif \r
421     \r
422     #if (HWTC_DIVISOR < 1)\r
423     #error "HWTC_DIVISOR must be a non-zero positive value!"\r
424     #endif \r
425 \r
426 #endif\r
427 /*******************************************************************************\r
428  * vTraceConsoleMessage\r
429  *\r
430  * A wrapper for your system-specific console "printf" console output function.\r
431  * This needs to be correctly defined to see status reports from the trace \r
432  * status monitor task (this is defined in trcUser.c).\r
433  ******************************************************************************/         \r
434 #if (SELECTED_PORT == PORT_Atmel_AT91SAM7)\r
435 /* Port specific includes */\r
436 #include "console.h"\r
437 #endif\r
438 \r
439 #define vTraceConsoleMessage(x)\r
440 \r
441 /*******************************************************************************\r
442  * uiTracePortGetTimeStamp\r
443  *\r
444  * Returns the current time based on the HWTC macros which provide a hardware\r
445  * isolation layer towards the hardware timer/counter.\r
446  *\r
447  * The HWTC macros and uiTracePortGetTimeStamp is the main porting issue\r
448  * or the trace recorder library. Typically you should not need to change\r
449  * the code of uiTracePortGetTimeStamp if using the HWTC macros.\r
450  *\r
451  * OFFER FROM PERCEPIO:\r
452  * For silicon companies and non-corporate FreeRTOS users (researchers, \r
453  * students, hobbyists or early-phase startups) we have an attractive offer: \r
454  * Provide a hardware timer port and get a FREE single-user licence for\r
455  * FreeRTOS+Trace Professional Edition. Read more about this offer at \r
456  * www.percepio.com or contact us directly at support@percepio.com.\r
457  ******************************************************************************/\r
458 void uiTracePortGetTimeStamp(uint32_t *puiTimestamp);\r
459 \r
460 /*******************************************************************************\r
461  * vTracePortEnd\r
462  * \r
463  * This function is called when the recorder is stopped due to full buffer.\r
464  * Mainly intended to show a message in the console.\r
465  * This is used by the Win32 port to store the trace to a file. The file path is\r
466  * set using vTracePortSetFileName.\r
467  ******************************************************************************/\r
468 void vTracePortEnd(void);\r
469 \r
470 #if (INCLUDE_SAVE_TO_FILE == 1)\r
471 \r
472 /*******************************************************************************\r
473  * vTracePortSetOutFile\r
474  *\r
475  * Sets the filename/path used in vTracePortSave.\r
476  * This is set in a separate function, since the Win32 port calls vTracePortSave\r
477  * in vTracePortEnd if WIN32_PORT_SAVE_WHEN_STOPPED is set.\r
478  ******************************************************************************/\r
479 void vTracePortSetOutFile(char* path);\r
480 \r
481 /******************************************************************************\r
482  * vTracePortSave\r
483  *\r
484  * Saves the trace to a file on a target-side file system. The path is set in a \r
485  * separate function, vTracePortSetOutFile, since the Win32 port may call\r
486  * vTracePortSave in vTracePortEnd, if using WIN32_PORT_SAVE_WHEN_STOPPED.\r
487  ******************************************************************************/\r
488 void vTracePortSave(void);\r
489 \r
490 #endif\r
491 \r
492 #endif\r