]> git.sur5r.net Git - freertos/blob
e2e60ea6db4fe58fd5c467da1cccfe0b5b531cc4
[freertos] /
1 /*******************************************************************************\r
2  * Tracealyzer v2.4.1 Recorder Library\r
3  * Percepio AB, www.percepio.com\r
4  *\r
5  * trcConfig.h\r
6  *\r
7  * Configuration parameters for the trace recorder library. Before using the \r
8  * trace recorder library, please check that the default settings are \r
9  * appropriate for your system, and if necessary adjust these. Most likely, you \r
10  * will need to adjust the NTask, NISR, NQueue, NMutex and NSemaphore values to \r
11  * reflect the number of such objects in your system. These may be \r
12  * over-approximated, although larger values values implies more RAM usage.\r
13  *\r
14  * Terms of Use\r
15  * This software is copyright Percepio AB. The recorder library is free for\r
16  * use together with Percepio products. You may distribute the recorder library\r
17  * in its original form, including modifications in trcHardwarePort.c/.h\r
18  * given that these modification are clearly marked as your own modifications\r
19  * and documented in the initial comment section of these source files. \r
20  * This software is the intellectual property of Percepio AB and may not be \r
21  * sold or in other ways commercially redistributed without explicit written \r
22  * permission by Percepio AB.\r
23  *\r
24  * Disclaimer \r
25  * The trace tool and recorder library is being delivered to you AS IS and \r
26  * Percepio AB makes no warranty as to its use or performance. Percepio AB does \r
27  * not and cannot warrant the performance or results you may obtain by using the \r
28  * software or documentation. Percepio AB make no warranties, express or \r
29  * implied, as to noninfringement of third party rights, merchantability, or \r
30  * fitness for any particular purpose. In no event will Percepio AB, its \r
31  * technology partners, or distributors be liable to you for any consequential, \r
32  * incidental or special damages, including any lost profits or lost savings, \r
33  * even if a representative of Percepio AB has been advised of the possibility \r
34  * of such damages, or for any claim by any third party. Some jurisdictions do \r
35  * not allow the exclusion or limitation of incidental, consequential or special \r
36  * damages, or the exclusion of implied warranties or limitations on how long an \r
37  * implied warranty may last, so the above limitations may not apply to you.\r
38  *\r
39  * Copyright Percepio AB, 2013.\r
40  * www.percepio.com\r
41  ******************************************************************************/\r
42 \r
43 #ifndef TRCCONFIG_H\r
44 #define TRCCONFIG_H\r
45 \r
46 #include <stdint.h>\r
47 \r
48 /*******************************************************************************\r
49  * CONFIGURATION RELATED TO CAPACITY AND ALLOCATION \r
50  ******************************************************************************/\r
51 \r
52 /*******************************************************************************\r
53  * EVENT_BUFFER_SIZE\r
54  *\r
55  * Macro which should be defined as an integer value.\r
56  *\r
57  * This defines the capacity of the event buffer, i.e., the number of records\r
58  * it may store. Each registered event typically use one record (4 byte), but\r
59  * vTracePrintF may use multiple records depending on the number of data args.\r
60  ******************************************************************************/\r
61 \r
62 #define EVENT_BUFFER_SIZE 4000 /* Adjust wrt. to available RAM */\r
63 \r
64 \r
65 /*******************************************************************************\r
66  * USE_LINKER_PRAGMA\r
67  *\r
68  * Macro which should be defined as an integer value, default is 0.\r
69  *\r
70  * If this is 1, the header file "recorderdata_linker_pragma.h" is included just\r
71  * before the declaration of RecorderData (in trcBase.c), i.e., the trace data \r
72  * structure. This allows the user to specify a pragma with linker options. \r
73  *\r
74  * Example (for IAR Embedded Workbench and NXP LPC17xx):\r
75  * #pragma location="AHB_RAM_MEMORY"\r
76  * \r
77  * This example instructs the IAR linker to place RecorderData in another RAM \r
78  * bank, the AHB RAM. This can also be used for other compilers with a similar\r
79  * pragmas for linker options.\r
80  * \r
81  * Note that this only applies if using static allocation, see below.\r
82  ******************************************************************************/\r
83 \r
84 #define USE_LINKER_PRAGMA 0\r
85 \r
86 \r
87 /*******************************************************************************\r
88  * SYMBOL_TABLE_SIZE\r
89  *\r
90  * Macro which should be defined as an integer value.\r
91  *\r
92  * This defines the capacity of the symbol table, in bytes. This symbol table \r
93  * stores User Events labels and names of deleted tasks, queues, or other kernel\r
94  * objects. Note that the names of active objects not stored here but in the \r
95  * Object Table. Thus, if you don't use User Events or delete any kernel \r
96  * objects you set this to zero (0) to minimize RAM usage.\r
97  ******************************************************************************/\r
98 #define SYMBOL_TABLE_SIZE 1000\r
99 \r
100 /*******************************************************************************\r
101  * USE_SEPARATE_USER_EVENT_BUFFER\r
102  *\r
103  * Macro which should be defined as an integer value.\r
104  * Default is zero (0).\r
105  *\r
106  * This enables and disables the use of the separate user event buffer.\r
107  *\r
108  * Note: When using the separate user event buffer, you may get an artificial\r
109  * task instance named "Unknown actor". This is added as a placeholder when the \r
110  * user event history is longer than the task scheduling history.\r
111  ******************************************************************************/\r
112 #define USE_SEPARATE_USER_EVENT_BUFFER 0\r
113 \r
114 /*******************************************************************************\r
115  * USER_EVENT_BUFFER_SIZE\r
116  *\r
117  * Macro which should be defined as an integer value.\r
118  *\r
119  * This defines the capacity of the user event buffer, in number of slots.\r
120  * A single user event can use between 1 and X slots, depending on the data.\r
121  *\r
122  * Only in use if USE_SEPARATE_USER_EVENT_BUFFER is set to 1.\r
123  ******************************************************************************/\r
124 #define USER_EVENT_BUFFER_SIZE 500\r
125 \r
126 /*******************************************************************************\r
127  * USER_EVENT_CHANNELS\r
128  *\r
129  * Macro which should be defined as an integer value.\r
130  *\r
131  * This defines the number of allowed user event channels.\r
132  *\r
133  * Only in use if USE_SEPARATE_USER_EVENT_BUFFER is set to 1.\r
134  ******************************************************************************/\r
135 #define CHANNEL_FORMAT_PAIRS 32\r
136 \r
137 /*******************************************************************************\r
138  * NTask, NISR, NQueue, NSemaphore, NMutex\r
139  *\r
140  * A group of Macros which should be defined as an integer value of zero (0) \r
141  * or larger.\r
142  *\r
143  * This defines the capacity of the Object Property Table - the maximum number\r
144  * of objects active at any given point within each object class.\r
145  * \r
146  * NOTE: In case objects are deleted and created during runtime, this setting\r
147  * does not limit the total amount of objects, only the number of concurrently\r
148  * active objects. \r
149  *\r
150  * Using too small values will give an error message through the vTraceError\r
151  * routine, which makes the error message appear when opening the trace data\r
152  * in Tracealyzer. If you are using the recorder status monitor task,\r
153  * any error messages are displayed in console prints, assuming that the\r
154  * print macro has been defined properly (vConsolePrintMessage). \r
155  *\r
156  * It can be wise to start with very large values for these constants, \r
157  * unless you are very confident on these numbers. Then do a recording and\r
158  * check the actual usage in Tracealyzer. This is shown by selecting\r
159  * View -> Trace Details -> Resource Usage -> Object Table\r
160  * \r
161  * NOTE 2: Remember to account for all tasks created by the kernel, such as the \r
162  * IDLE task, timer task, and any tasks created by other 3rd party \r
163  * software components, such as communication stacks. The recorder also has an \r
164  * optional monitor task to account for, if this is used.\r
165  * Moreover, one task slot is used to indicate "(startup)", i.e., a fictive \r
166  * task that represent the time before the scheduler starts. \r
167  * NTask should thus be at least 2-3 slots larger than your application task count.\r
168  *\r
169  ******************************************************************************/\r
170 #define NTask             15\r
171 #define NISR              15\r
172 #define NQueue            15\r
173 #define NSemaphore        15\r
174 #define NMutex            15\r
175 \r
176 /* Maximum object name length for each class (includes zero termination) */\r
177 #define NameLenTask       15\r
178 #define NameLenISR        15\r
179 #define NameLenQueue      15\r
180 #define NameLenSemaphore  15\r
181 #define NameLenMutex      15\r
182 \r
183 /******************************************************************************\r
184  * TRACE_DESCRIPTION\r
185  *\r
186  * Macro which should be defined as a string.\r
187  *\r
188  * This string is stored in the trace and displayed in Tracealyzer. Can be\r
189  * used to store, e.g., system version or build date. This is also used to store\r
190  * internal error messages from the recorder, which if occurs overwrites the\r
191  * value defined here. This may be maximum 256 chars.\r
192  *****************************************************************************/\r
193 #define TRACE_DESCRIPTION "Tracealyzer Recorder Test Program"\r
194 \r
195 /******************************************************************************\r
196  * TRACE_DESCRIPTION_MAX_LENGTH\r
197  *\r
198  * The maximum length (including zero termination) for the TRACE_DESCRIPTION\r
199  * string. Since this string also is used for internal error messages from the \r
200  * recorder do not make it too short, as this may truncate the error messages.\r
201  * Default is 80. \r
202  * Maximum allowed length is 256 - the trace will fail to load if longer.\r
203  *****************************************************************************/\r
204 #define TRACE_DESCRIPTION_MAX_LENGTH 80\r
205 \r
206 \r
207 /******************************************************************************\r
208  * TRACE_DATA_ALLOCATION\r
209  *\r
210  * This defines how to allocate the recorder data structure, i.e., using a \r
211  * static declaration or using a dynamic allocation in runtime (malloc).\r
212  *\r
213  * Should be one of these two options:\r
214  * - TRACE_DATA_ALLOCATION_STATIC (default)\r
215  * - TRACE_DATA_ALLOCATION_DYNAMIC\r
216  *\r
217  * Using static allocation has the benefits of compile-time errors if the buffer \r
218  * is too large (too large constants in trcConfig.h) and no need to call the \r
219  * initialization routine (xTraceInitTraceData).\r
220  *\r
221  * Using dynamic allocation may give more flexibility in some cases.\r
222  *****************************************************************************/\r
223 \r
224 #define TRACE_DATA_ALLOCATION TRACE_DATA_ALLOCATION_STATIC\r
225 \r
226 \r
227 /******************************************************************************\r
228  * CONFIGURATION REGARDING WHAT CODE/FEATURES TO INCLUDE\r
229  *****************************************************************************/\r
230 \r
231 /******************************************************************************\r
232  * USE_TRACE_ASSERT\r
233  *\r
234  * Macro which should be defined as either zero (0) or one (1). \r
235  * Default is 0.\r
236  *\r
237  * If this is one (1), the TRACE_ASSERT macro will verify that a condition is \r
238  * true. If the condition is false, vTraceError() will be called.\r
239  *****************************************************************************/\r
240 #define USE_TRACE_ASSERT 1\r
241 \r
242 /******************************************************************************\r
243  * INCLUDE_FLOAT_SUPPORT\r
244  *\r
245  * Macro which should be defined as either zero (0) or one (1). \r
246  * Default is 1.\r
247  *\r
248  * If this is zero (0), all references to floating point values are removed,\r
249  * in case floating point values are not supported by the platform used.\r
250  * Floating point values are only used in vTracePrintF and its subroutines, to \r
251  * store float (%f) or double (%lf) argments. \r
252  *\r
253  * Note: vTracePrintF can still be used with integer and string arguments in\r
254  * either case.\r
255  *****************************************************************************/\r
256 #define INCLUDE_FLOAT_SUPPORT 0\r
257 \r
258 /******************************************************************************\r
259  * INCLUDE_USER_EVENTS\r
260  *\r
261  * Macro which should be defined as either zero (0) or one (1). \r
262  * Default is 1.\r
263  *\r
264  * If this is zero (0) the code for creating User Events is excluded to\r
265  * reduce code size. User Events are application-generated events, like \r
266  * "printf" but for the trace log instead of console output. User Events are \r
267  * much faster than a printf and can therefore be used in timing critical code.\r
268  * See vTraceUserEvent() and vTracePrintF() in trcUser.h\r
269  * \r
270  * Note that Tracealyzer Standard Edition or Professional Edition is required\r
271  * for User Events, they are not displayed in Tracealyzer Free Edition.\r
272  *****************************************************************************/\r
273 #define INCLUDE_USER_EVENTS 1\r
274 \r
275 /*****************************************************************************\r
276  * INCLUDE_READY_EVENTS\r
277  *\r
278  * Macro which should be defined as either zero (0) or one (1). \r
279  * Default is 1.\r
280  *\r
281  * If this is zero (0), the code for recording Ready events is \r
282  * excluded. Note, this will make it impossible to calculate the correct\r
283  * response times.\r
284  *****************************************************************************/\r
285 #define INCLUDE_READY_EVENTS 1\r
286 \r
287 /*****************************************************************************\r
288  * INCLUDE_NEW_TIME_EVENTS\r
289  *\r
290  * Macro which should be defined as either zero (0) or one (1). \r
291  * Default is 0.\r
292  *\r
293  * If this is zero (1), events will be generated whenever the os clock is\r
294  * increased.\r
295  *****************************************************************************/\r
296 #define INCLUDE_NEW_TIME_EVENTS 0\r
297 \r
298 /*****************************************************************************\r
299  * INCLUDE_ISR_TRACING\r
300  *\r
301  * Macro which should be defined as either zero (0) or one (1). \r
302  * Default is 1.\r
303  *\r
304  * If this is zero (0), the code for recording Interrupt Service Routines is \r
305  * excluded to reduce code size.\r
306  * \r
307  * Note, if the kernel has no central interrupt dispatcher, recording ISRs \r
308  * require that you insert calls to vTraceStoreISRBegin and vTraceStoreISREnd \r
309  * in your interrupt handlers.\r
310  *****************************************************************************/\r
311 #define INCLUDE_ISR_TRACING 1\r
312 \r
313 /******************************************************************************\r
314  * INCLUDE_OBJECT_DELETE\r
315  * \r
316  * Macro which should be defined as either zero (0) or one (1). \r
317  * Default is 1.\r
318  *\r
319  * This must be enabled (1) if tasks, queues or other \r
320  * traced kernel objects are deleted at runtime. If no deletes are made, this \r
321  * can be set to 0 in order to exclude the delete-handling code.\r
322  *****************************************************************************/\r
323 #define INCLUDE_OBJECT_DELETE 0\r
324 \r
325 /******************************************************************************\r
326  * CONFIGURATION RELATED TO BEHAVIOR\r
327  *****************************************************************************/\r
328 \r
329 /******************************************************************************\r
330  * TRACE_RECORDER_STORE_MODE\r
331  *\r
332  * Macro which should be defined as one of:\r
333  * - TRACE_STORE_MODE_RING_BUFFER\r
334  * - TRACE_STORE_MODE_STOP_WHEN_FULL\r
335  * Default is TRACE_STORE_MODE_RING_BUFFER.\r
336  *\r
337  * With TRACE_RECORDER_STORE_MODE set to TRACE_STORE_MODE_RING_BUFFER, the events are \r
338  * stored in a ring buffer, i.e., where the oldest events are overwritten when \r
339  * the buffer becomes full. This allows you to get the last events leading up \r
340  * to an interesting state, e.g., an error, without having a large trace buffer\r
341  * for string the whole run since startup. In this mode, the recorder can run\r
342  * "forever" as the buffer never gets full, i.e., in the sense that it always\r
343  * has room for more events.\r
344  *\r
345  * To fetch the trace in mode TRACE_STORE_MODE_RING_BUFFER, you need to first halt the\r
346  * system using your debugger and then do a RAM dump, or to explicitly stop the\r
347  * recorder using vTraceStop() and then store/upload the trace data using a\r
348  * task that you need to provide yourself. The trace data is found in the struct\r
349  * RecorderData, initialized in trcBase.c.\r
350  *\r
351  * Note that, if you upload the trace using a RAM dump, i.e., when the system is \r
352  * halted on a breakpoint or by a debugger command, there is no need to stop the \r
353  * recorder first.\r
354  *\r
355  * When TRACE_RECORDER_STORE_MODE is TRACE_STORE_MODE_STOP_WHEN_FULL, the recording is\r
356  * stopped when the buffer becomes full. When the recorder stops itself this way\r
357  * vTracePortEnd() is called which allows for custom actions, such as triggering\r
358  * a task that stores the trace buffer, i.e., in case taking a RAM dump\r
359  * using an on-chip debugger is not possible. In the Windows port, vTracePortEnd\r
360  * saves the trace to file directly, but this is not recommended in a real-time\r
361  * system since the scheduler is blocked during the processing of vTracePortEnd.\r
362  *****************************************************************************/\r
363 \r
364 #define TRACE_RECORDER_STORE_MODE TRACE_STORE_MODE_RING_BUFFER\r
365 \r
366 /******************************************************************************\r
367  * STOP_AFTER_N_EVENTS\r
368  *\r
369  * Macro which should be defined as an integer value, or not defined.\r
370  * Default is -1\r
371  *\r
372  * STOP_AFTER_N_EVENTS is intended for tests of the ring buffer mode (when\r
373  * RECORDER_STORE_MODE is STORE_MODE_RING_BUFFER). It stops the recording when\r
374  * the specified number of events has been observed. This value can be larger\r
375  * than the buffer size, to allow for test of the "wrapping around" that occurs\r
376  * in ring buffer mode . A negative value (or no definition of this macro)\r
377  * disables this feature.\r
378  *****************************************************************************/\r
379 #define STOP_AFTER_N_EVENTS -1\r
380 \r
381 /******************************************************************************\r
382  * USE_IMPLICIT_IFE_RULES\r
383  *\r
384  * Macro which should be defined as either zero (0) or one (1). \r
385  * Default is 1.\r
386  *\r
387  * ### Instance Finish Events (IFE) ###\r
388  *\r
389  * For tasks with "infinite" main loops (non-terminating tasks), the concept\r
390  * of a task instance has no clear definition, it is an application-specific\r
391  * thing. Tracealyzer allows you to define Instance Finish Events (IFEs),\r
392  * which marks the point in a cyclic task when the "task instance" ends.\r
393  * The IFE is a blocking kernel call, typically in the main loop of a task\r
394  * which typically reads a message queue, waits for a semaphore or performs\r
395  * an explicit delay.\r
396  *\r
397  * If USE_IMPLICIT_IFE_RULES is one (1), the kernel macros (trcKernelPort.h)\r
398  * will define what kernel calls are considered by default to be IFEs.\r
399  *\r
400  * However, Implicit IFEs only applies to blocking kernel calls. If a\r
401  * service reads a message without blocking, it does not create a new\r
402  * instance since no blocking occurred.\r
403  *\r
404  * Moreover, the actual IFE might sometimes be another blocking call. We \r
405  * therefore allow for user-defined Explicit IFEs by calling\r
406  *\r
407  *     vTraceTaskInstanceIsFinished()\r
408  *\r
409  * right before the kernel call considered as IFE. This does not create an\r
410  * additional event but instead stores the service code and object handle\r
411  * of the IFE call as properties of the task.\r
412  *\r
413  * If using Explicit IFEs and the task also calls an Implicit IFE, this may \r
414  * result in additional incorrect task instances.\r
415  * This is solved by disabling the Implicit IFEs for the task, by adding\r
416  * a call to\r
417  * \r
418  *     vTraceTaskSkipDefaultInstanceFinishedEvents()\r
419  * \r
420  * in the very beginning of that task. This allows you to combine Explicit IFEs\r
421  * for some tasks with Implicit IFEs for the rest of the tasks, if\r
422  * USE_IMPLICIT_IFE_RULES is 1.\r
423  *\r
424  * By setting USE_IMPLICIT_IFE_RULES to zero (0), the implicit IFEs are disabled\r
425  * for all tasks. Tasks will then be considered to have a single instance only, \r
426  * covering all execution fragments, unless you define an explicit IFE in each\r
427  * task by calling vTraceTaskInstanceIsFinished before the blocking call.\r
428  *****************************************************************************/\r
429 #define USE_IMPLICIT_IFE_RULES 1\r
430 \r
431 /******************************************************************************\r
432  * INCLUDE_SAVE_TO_FILE\r
433  *\r
434  * Macro which should be defined as either zero (0) or one (1).\r
435  * Default is 0.\r
436  *\r
437  * If enabled (1), the recorder will include code for saving the trace\r
438  * to a local file system.\r
439  ******************************************************************************/\r
440 #ifdef WIN32\r
441     #define INCLUDE_SAVE_TO_FILE 1\r
442 #else\r
443     #define INCLUDE_SAVE_TO_FILE 0\r
444 #endif\r
445 \r
446 /******************************************************************************\r
447  * TRACE_PROGRESS_MONITOR_TASK_PRIORITY\r
448  *\r
449  * Macro which sets the priority of the "recorder status monitor" task.\r
450  *\r
451  * This task, vTraceMonitorTask in trcUser.c, periodically writes\r
452  * the recorder status using the vTraceConsoleMessage macro, which is to\r
453  * be mapped to your console "printf" routine. The task is named TraceMon but \r
454  * is intentionally excluded from the demo trace.\r
455  *\r
456  * Default is tskIDLE_PRIORITY + 1\r
457  * Note that if your system constantly has a high CPU load from high-priority \r
458  * tasks, this might not be get a chance to execute.\r
459  * \r
460  * See vTraceMonitorTask in trcUser.c\r
461  *****************************************************************************/\r
462 #define TRACE_PROGRESS_MONITOR_TASK_PRIORITY (tskIDLE_PRIORITY + 1)\r
463 \r
464 /******************************************************************************\r
465  * TRACE_PROGRESS_MONITOR_TASK_STACKSIZE\r
466  *\r
467  * Macro which sets the stack size of the "recorder status monitor" task.\r
468  *\r
469  * This task, vTraceMonitorTask in trcUser.c, periodically writes\r
470  * the recorder status using the vTraceConsoleMessage macro, which is to\r
471  * be mapped to your console "printf" routine. The task is intentionally \r
472  * excluded from the demo trace.\r
473  *\r
474  * See vTraceMonitorTask in trcUser.c\r
475  *****************************************************************************/\r
476 #define TRACE_PROGRESS_MONITOR_TASK_STACKSIZE 500\r
477 \r
478 /******************************************************************************\r
479  * TRACE_PROGRESS_MONITOR_TASK_PERIOD\r
480  *\r
481  * Macro which sets the period of the "recorder status monitor" task.\r
482  *\r
483  * This task, vTraceMonitorTask in trcUser.c, periodically writes\r
484  * the recorder status using the vTraceConsoleMessage macro, which is to\r
485  * be mapped to your console "printf" routine. The task is named TraceMon but \r
486  * is intentionally excluded from the demo trace.\r
487  *\r
488  * Default is 1000 ticks (typically 1 second). On the Windows port, a lower \r
489  * value is suggested since the Windows port runs very slowly, often 20-40\r
490  * times slower than the simulated time.\r
491  *\r
492  * See vTraceMonitorTask in trcUser.c\r
493  *****************************************************************************/\r
494 #ifdef WIN32\r
495     #define TRACE_PROGRESS_MONITOR_TASK_PERIOD 100\r
496 #else\r
497     #define TRACE_PROGRESS_MONITOR_TASK_PERIOD 1000\r
498 #endif\r
499 \r
500 /******************************************************************************\r
501  * TEAM_LICENSE_CODE\r
502  *\r
503  * Macro which defines a string - the team license code.\r
504  * If no team license is available, this should be an empty string "".\r
505  * This should be maximum 32 chars, including zero-termination.\r
506  *****************************************************************************/\r
507 #define TEAM_LICENSE_CODE ""\r
508 \r
509 #endif\r
510 \r