git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/WIN32-MingW/Trace_Recorder_Configuration/trcConfig.h

   1 /*******************************************************************************\r
   2  * Tracealyzer v2.6.0 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 /*******************************************************************************\r
  47  * CONFIGURATION RELATED TO CAPACITY AND ALLOCATION \r
  48  ******************************************************************************/\r
  49 \r
  50 /*******************************************************************************\r
  51  * EVENT_BUFFER_SIZE\r
  52  *\r
  53  * Macro which should be defined as an integer value.\r
  54  *\r
  55  * This defines the capacity of the event buffer, i.e., the number of records\r
  56  * it may store. Each registered event typically use one record (4 byte), but\r
  57  * vTracePrintF may use multiple records depending on the number of data args.\r
  58  ******************************************************************************/\r
  59 \r
  60 #define EVENT_BUFFER_SIZE 10000 /* Adjust wrt. to available RAM */\r
  61 \r
  62 \r
  63 /*******************************************************************************\r
  64  * USE_LINKER_PRAGMA\r
  65  *\r
  66  * Macro which should be defined as an integer value, default is 0.\r
  67  *\r
  68  * If this is 1, the header file "recorderdata_linker_pragma.h" is included just\r
  69  * before the declaration of RecorderData (in trcBase.c), i.e., the trace data \r
  70  * structure. This allows the user to specify a pragma with linker options. \r
  71  *\r
  72  * Example (for IAR Embedded Workbench and NXP LPC17xx):\r
  73  * #pragma location="AHB_RAM_MEMORY"\r
  74  * \r
  75  * This example instructs the IAR linker to place RecorderData in another RAM \r
  76  * bank, the AHB RAM. This can also be used for other compilers with a similar\r
  77  * pragmas for linker options.\r
  78  * \r
  79  * Note that this only applies if using static allocation, see below.\r
  80  ******************************************************************************/\r
  81 \r
  82 #define USE_LINKER_PRAGMA 0\r
  83 \r
  84 \r
  85 /*******************************************************************************\r
  86  * SYMBOL_TABLE_SIZE\r
  87  *\r
  88  * Macro which should be defined as an integer value.\r
  89  *\r
  90  * This defines the capacity of the symbol table, in bytes. This symbol table \r
  91  * stores User Events labels and names of deleted tasks, queues, or other kernel\r
  92  * objects. Note that the names of active objects not stored here but in the \r
  93  * Object Table. Thus, if you don't use User Events or delete any kernel \r
  94  * objects you set this to a very low value, e.g. 4, but not zero (0) since \r
  95  * this causes a declaration of a zero-sized array, for which the C compiler\r
  96  * behavior is not standardized and may cause misaligned data.\r
  97  ******************************************************************************/\r
  98 #define SYMBOL_TABLE_SIZE 5000\r
  99 \r
 100 #if (SYMBOL_TABLE_SIZE == 0)\r
 101 #error "SYMBOL_TABLE_SIZE may not be zero!"\r
 102 #endif\r
 103 \r
 104 /*******************************************************************************\r
 105  * USE_SEPARATE_USER_EVENT_BUFFER\r
 106  *\r
 107  * Macro which should be defined as an integer value.\r
 108  * Default is zero (0).\r
 109  *\r
 110  * This enables and disables the use of the separate user event buffer.\r
 111  *\r
 112  * Note: When using the separate user event buffer, you may get an artificial\r
 113  * task instance named "Unknown actor". This is added as a placeholder when the \r
 114  * user event history is longer than the task scheduling history.\r
 115  ******************************************************************************/\r
 116 #define USE_SEPARATE_USER_EVENT_BUFFER 0\r
 117 \r
 118 /*******************************************************************************\r
 119  * USER_EVENT_BUFFER_SIZE\r
 120  *\r
 121  * Macro which should be defined as an integer value.\r
 122  *\r
 123  * This defines the capacity of the user event buffer, in number of slots.\r
 124  * A single user event can use between 1 and X slots, depending on the data.\r
 125  *\r
 126  * Only in use if USE_SEPARATE_USER_EVENT_BUFFER is set to 1.\r
 127  ******************************************************************************/\r
 128 #define USER_EVENT_BUFFER_SIZE 500\r
 129 \r
 130 /*******************************************************************************\r
 131  * USER_EVENT_CHANNELS\r
 132  *\r
 133  * Macro which should be defined as an integer value.\r
 134  *\r
 135  * This defines the number of allowed user event channels.\r
 136  *\r
 137  * Only in use if USE_SEPARATE_USER_EVENT_BUFFER is set to 1.\r
 138  ******************************************************************************/\r
 139 #define CHANNEL_FORMAT_PAIRS 32\r
 140 \r
 141 /*******************************************************************************\r
 142  * NTask, NISR, NQueue, NSemaphore, NMutex\r
 143  *\r
 144  * A group of Macros which should be defined as an integer value of zero (0) \r
 145  * or larger.\r
 146  *\r
 147  * This defines the capacity of the Object Property Table - the maximum number\r
 148  * of objects active at any given point within each object class.\r
 149  * \r
 150  * NOTE: In case objects are deleted and created during runtime, this setting\r
 151  * does not limit the total amount of objects, only the number of concurrently\r
 152  * active objects. \r
 153  *\r
 154  * Using too small values will give an error message through the vTraceError\r
 155  * routine, which makes the error message appear when opening the trace data\r
 156  * in Tracealyzer. If you are using the recorder status monitor task,\r
 157  * any error messages are displayed in console prints, assuming that the\r
 158  * print macro has been defined properly (vConsolePrintMessage). \r
 159  *\r
 160  * It can be wise to start with very large values for these constants, \r
 161  * unless you are very confident on these numbers. Then do a recording and\r
 162  * check the actual usage in Tracealyzer. This is shown by selecting\r
 163  * View -> Trace Details -> Resource Usage -> Object Table\r
 164  * \r
 165  * NOTE 2: Remember to account for all tasks and other objects created by \r
 166  * the kernel, such as the IDLE task, any timer tasks, and any tasks created \r
 167  * by other 3rd party software components, such as communication stacks.\r
 168  * Moreover, one task slot is used to indicate "(startup)", i.e., a fictive \r
 169  * task that represent the time before the scheduler starts. \r
 170  * NTask should thus be at least 2-3 slots larger than your application task count.\r
 171  *\r
 172  ******************************************************************************/\r
 173 #define NTask             100\r
 174 #define NISR              20\r
 175 #define NQueue            60\r
 176 #define NSemaphore        60\r
 177 #define NMutex            60\r
 178 #define NTimer            200\r
 179 #define NEventGroup       60\r
 180 \r
 181 /* Maximum object name length for each class (includes zero termination) */\r
 182 #define NameLenTask       15\r
 183 #define NameLenISR        15\r
 184 #define NameLenQueue      15\r
 185 #define NameLenSemaphore  15\r
 186 #define NameLenMutex      15\r
 187 #define NameLenTimer      15\r
 188 #define NameLenEventGroup 15\r
 189 \r
 190 /******************************************************************************\r
 191  * TRACE_DESCRIPTION\r
 192  *\r
 193  * Macro which should be defined as a string.\r
 194  *\r
 195  * This string is stored in the trace and displayed in Tracealyzer. Can be\r
 196  * used to store, e.g., system version or build date. This is also used to store\r
 197  * internal error messages from the recorder, which if occurs overwrites the\r
 198  * value defined here. This may be maximum 256 chars.\r
 199  *****************************************************************************/\r
 200 #define TRACE_DESCRIPTION "Tracealyzer Recorder Test Program"\r
 201 \r
 202 /******************************************************************************\r
 203  * TRACE_DESCRIPTION_MAX_LENGTH\r
 204  *\r
 205  * The maximum length (including zero termination) for the TRACE_DESCRIPTION\r
 206  * string. Since this string also is used for internal error messages from the \r
 207  * recorder do not make it too short, as this may truncate the error messages.\r
 208  * Default is 80. \r
 209  * Maximum allowed length is 256 - the trace will fail to load if longer.\r
 210  *****************************************************************************/\r
 211 #define TRACE_DESCRIPTION_MAX_LENGTH 80\r
 212 \r
 213 \r
 214 /******************************************************************************\r
 215  * TRACE_DATA_ALLOCATION\r
 216  *\r
 217  * This defines how to allocate the recorder data structure, i.e., using a \r
 218  * static declaration or using a dynamic allocation in runtime (malloc).\r
 219  *\r
 220  * Should be one of these two options:\r
 221  * - TRACE_DATA_ALLOCATION_STATIC (default)\r
 222  * - TRACE_DATA_ALLOCATION_DYNAMIC\r
 223  *\r
 224  * Using static allocation has the benefits of compile-time errors if the buffer \r
 225  * is too large (too large constants in trcConfig.h) and no need to call the \r
 226  * initialization routine (xTraceInitTraceData).\r
 227  *\r
 228  * Using dynamic allocation may give more flexibility in some cases.\r
 229  *****************************************************************************/\r
 230 \r
 231 #define TRACE_DATA_ALLOCATION TRACE_DATA_ALLOCATION_STATIC\r
 232 \r
 233 \r
 234 /******************************************************************************\r
 235  * CONFIGURATION REGARDING WHAT CODE/FEATURES TO INCLUDE\r
 236  *****************************************************************************/\r
 237 \r
 238 /******************************************************************************\r
 239  * USE_TRACE_ASSERT\r
 240  *\r
 241  * Macro which should be defined as either zero (0) or one (1). \r
 242  * Default is 0.\r
 243  *\r
 244  * If this is one (1), the TRACE_ASSERT macro will verify that a condition is \r
 245  * true. If the condition is false, vTraceError() will be called.\r
 246  *****************************************************************************/\r
 247 #define USE_TRACE_ASSERT 1\r
 248 \r
 249 /******************************************************************************\r
 250  * INCLUDE_FLOAT_SUPPORT\r
 251  *\r
 252  * Macro which should be defined as either zero (0) or one (1). \r
 253  * Default is 1.\r
 254  *\r
 255  * If this is zero (0), all references to floating point values are removed,\r
 256  * in case floating point values are not supported by the platform used.\r
 257  * Floating point values are only used in vTracePrintF and its subroutines, to \r
 258  * store float (%f) or double (%lf) argments. \r
 259  *\r
 260  * Note: vTracePrintF can still be used with integer and string arguments in\r
 261  * either case.\r
 262  *****************************************************************************/\r
 263 #define INCLUDE_FLOAT_SUPPORT 0\r
 264 \r
 265 /******************************************************************************\r
 266  * INCLUDE_USER_EVENTS\r
 267  *\r
 268  * Macro which should be defined as either zero (0) or one (1). \r
 269  * Default is 1.\r
 270  *\r
 271  * If this is zero (0) the code for creating User Events is excluded to\r
 272  * reduce code size. User Events are application-generated events, like \r
 273  * "printf" but for the trace log instead of console output. User Events are \r
 274  * much faster than a printf and can therefore be used in timing critical code.\r
 275  * See vTraceUserEvent() and vTracePrintF() in trcUser.h\r
 276  * \r
 277  * Note that User Events are not displayed in FreeRTOS+Trace Free Edition.\r
 278  *****************************************************************************/\r
 279 #define INCLUDE_USER_EVENTS 1\r
 280 \r
 281 /*****************************************************************************\r
 282  * INCLUDE_READY_EVENTS\r
 283  *\r
 284  * Macro which should be defined as either zero (0) or one (1). \r
 285  * Default is 1.\r
 286  *\r
 287  * If this is zero (0), the code for recording Ready events is \r
 288  * excluded. Note, this will make it impossible to calculate the correct\r
 289  * response times.\r
 290  *****************************************************************************/\r
 291 #define INCLUDE_READY_EVENTS 1\r
 292 \r
 293 /*****************************************************************************\r
 294  * INCLUDE_NEW_TIME_EVENTS\r
 295  *\r
 296  * Macro which should be defined as either zero (0) or one (1). \r
 297  * Default is 0.\r
 298  *\r
 299  * If this is zero (1), events will be generated whenever the os clock is\r
 300  * increased.\r
 301  *****************************************************************************/\r
 302 #define INCLUDE_NEW_TIME_EVENTS 0\r
 303 \r
 304 /*****************************************************************************\r
 305  * INCLUDE_ISR_TRACING\r
 306  *\r
 307  * Macro which should be defined as either zero (0) or one (1). \r
 308  * Default is 1.\r
 309  *\r
 310  * If this is zero (0), the code for recording Interrupt Service Routines is \r
 311  * excluded to reduce code size.\r
 312  * \r
 313  * Note, if the kernel has no central interrupt dispatcher, recording ISRs \r
 314  * require that you insert calls to vTraceStoreISRBegin and vTraceStoreISREnd \r
 315  * in your interrupt handlers.\r
 316  *****************************************************************************/\r
 317 #define INCLUDE_ISR_TRACING 1\r
 318 \r
 319 /******************************************************************************\r
 320  * INCLUDE_OBJECT_DELETE\r
 321  * \r
 322  * Macro which should be defined as either zero (0) or one (1). \r
 323  * Default is 1.\r
 324  *\r
 325  * This must be enabled (1) if tasks, queues or other \r
 326  * traced kernel objects are deleted at runtime. If no deletes are made, this \r
 327  * can be set to 0 in order to exclude the delete-handling code.\r
 328  *****************************************************************************/\r
 329 #define INCLUDE_OBJECT_DELETE 1\r
 330 \r
 331 /******************************************************************************\r
 332  * CONFIGURATION RELATED TO BEHAVIOR\r
 333  *****************************************************************************/\r
 334 \r
 335 /******************************************************************************\r
 336  * TRACE_RECORDER_STORE_MODE\r
 337  *\r
 338  * Macro which should be defined as one of:\r
 339  * - TRACE_STORE_MODE_RING_BUFFER\r
 340  * - TRACE_STORE_MODE_STOP_WHEN_FULL\r
 341  * Default is TRACE_STORE_MODE_RING_BUFFER.\r
 342  *\r
 343  * With TRACE_RECORDER_STORE_MODE set to TRACE_STORE_MODE_RING_BUFFER, the events are \r
 344  * stored in a ring buffer, i.e., where the oldest events are overwritten when \r
 345  * the buffer becomes full. This allows you to get the last events leading up \r
 346  * to an interesting state, e.g., an error, without having a large trace buffer\r
 347  * for string the whole run since startup. In this mode, the recorder can run\r
 348  * "forever" as the buffer never gets full, i.e., in the sense that it always\r
 349  * has room for more events.\r
 350  *\r
 351  * To fetch the trace in mode TRACE_STORE_MODE_RING_BUFFER, you need to first halt the\r
 352  * system using your debugger and then do a RAM dump, or to explicitly stop the\r
 353  * recorder using vTraceStop() and then store/upload the trace data using a\r
 354  * task that you need to provide yourself. The trace data is found in the struct\r
 355  * RecorderData, initialized in trcBase.c.\r
 356  *\r
 357  * Note that, if you upload the trace using a RAM dump, i.e., when the system is \r
 358  * halted on a breakpoint or by a debugger command, there is no need to stop the \r
 359  * recorder first.\r
 360  *\r
 361  * When TRACE_RECORDER_STORE_MODE is TRACE_STORE_MODE_STOP_WHEN_FULL, the recording is\r
 362  * stopped when the buffer becomes full. When the recorder stops itself this way\r
 363  * vTracePortEnd() is called which allows for custom actions, such as triggering\r
 364  * a task that stores the trace buffer, i.e., in case taking a RAM dump\r
 365  * using an on-chip debugger is not possible. In the Windows port, vTracePortEnd\r
 366  * saves the trace to file directly, but this is not recommended in a real-time\r
 367  * system since the scheduler is blocked during the processing of vTracePortEnd.\r
 368  *****************************************************************************/\r
 369 \r
 370 #define TRACE_RECORDER_STORE_MODE TRACE_STORE_MODE_RING_BUFFER\r
 371 \r
 372 /******************************************************************************\r
 373  * STOP_AFTER_N_EVENTS\r
 374  *\r
 375  * Macro which should be defined as an integer value, or not defined.\r
 376  * Default is -1\r
 377  *\r
 378  * STOP_AFTER_N_EVENTS is intended for tests of the ring buffer mode (when\r
 379  * RECORDER_STORE_MODE is STORE_MODE_RING_BUFFER). It stops the recording when\r
 380  * the specified number of events has been observed. This value can be larger\r
 381  * than the buffer size, to allow for test of the "wrapping around" that occurs\r
 382  * in ring buffer mode . A negative value (or no definition of this macro)\r
 383  * disables this feature.\r
 384  *****************************************************************************/\r
 385 #define STOP_AFTER_N_EVENTS -1\r
 386 \r
 387 /******************************************************************************\r
 388  * USE_IMPLICIT_IFE_RULES\r
 389  *\r
 390  * Macro which should be defined as either zero (0) or one (1). \r
 391  * Default is 1.\r
 392  *\r
 393  * ### Instance Finish Events (IFE) ###\r
 394  *\r
 395  * For tasks with "infinite" main loops (non-terminating tasks), the concept\r
 396  * of a task instance has no clear definition, it is an application-specific\r
 397  * thing. Tracealyzer allows you to define Instance Finish Events (IFEs),\r
 398  * which marks the point in a cyclic task when the "task instance" ends.\r
 399  * The IFE is a blocking kernel call, typically in the main loop of a task\r
 400  * which typically reads a message queue, waits for a semaphore or performs\r
 401  * an explicit delay.\r
 402  *\r
 403  * If USE_IMPLICIT_IFE_RULES is one (1), the kernel macros (trcKernelPort.h)\r
 404  * will define what kernel calls are considered by default to be IFEs.\r
 405  *\r
 406  * However, Implicit IFEs only applies to blocking kernel calls. If a\r
 407  * service reads a message without blocking, it does not create a new\r
 408  * instance since no blocking occurred.\r
 409  *\r
 410  * Moreover, the actual IFE might sometimes be another blocking call. We \r
 411  * therefore allow for user-defined Explicit IFEs by calling\r
 412  *\r
 413  *     vTraceTaskInstanceIsFinished()\r
 414  *\r
 415  * right before the kernel call considered as IFE. This does not create an\r
 416  * additional event but instead stores the service code and object handle\r
 417  * of the IFE call as properties of the task.\r
 418  *\r
 419  * If using Explicit IFEs and the task also calls an Implicit IFE, this may \r
 420  * result in additional incorrect task instances.\r
 421  * This is solved by disabling the Implicit IFEs for the task, by adding\r
 422  * a call to\r
 423  * \r
 424  *     vTraceTaskSkipDefaultInstanceFinishedEvents()\r
 425  * \r
 426  * in the very beginning of that task. This allows you to combine Explicit IFEs\r
 427  * for some tasks with Implicit IFEs for the rest of the tasks, if\r
 428  * USE_IMPLICIT_IFE_RULES is 1.\r
 429  *\r
 430  * By setting USE_IMPLICIT_IFE_RULES to zero (0), the implicit IFEs are disabled\r
 431  * for all tasks. Tasks will then be considered to have a single instance only, \r
 432  * covering all execution fragments, unless you define an explicit IFE in each\r
 433  * task by calling vTraceTaskInstanceIsFinished before the blocking call.\r
 434  *****************************************************************************/\r
 435 #define USE_IMPLICIT_IFE_RULES 1\r
 436 \r
 437 /******************************************************************************\r
 438  * INCLUDE_SAVE_TO_FILE\r
 439  *\r
 440  * Macro which should be defined as either zero (0) or one (1).\r
 441  * Default is 0.\r
 442  *\r
 443  * If enabled (1), the recorder will include code for saving the trace\r
 444  * to a local file system.\r
 445  ******************************************************************************/\r
 446 #ifdef WIN32\r
 447     #define INCLUDE_SAVE_TO_FILE 1\r
 448 #else\r
 449     #define INCLUDE_SAVE_TO_FILE 0\r
 450 #endif\r
 451 \r
 452 /******************************************************************************\r
 453  * TRACE_PROGRESS_MONITOR_TASK_PRIORITY\r
 454  *\r
 455  * Macro which sets the priority of the "recorder status monitor" task.\r
 456  *\r
 457  * This task, vTraceMonitorTask in trcUser.c, periodically writes\r
 458  * the recorder status using the vTraceConsoleMessage macro, which is to\r
 459  * be mapped to your console "printf" routine. The task is named TraceMon but \r
 460  * is intentionally excluded from the demo trace.\r
 461  *\r
 462  * Default is tskIDLE_PRIORITY + 1\r
 463  * Note that if your system constantly has a high CPU load from high-priority \r
 464  * tasks, this might not be get a chance to execute.\r
 465  * \r
 466  * See vTraceMonitorTask in trcUser.c\r
 467  *****************************************************************************/\r
 468 #define TRACE_PROGRESS_MONITOR_TASK_PRIORITY (tskIDLE_PRIORITY + 1)\r
 469 \r
 470 /******************************************************************************\r
 471  * TRACE_PROGRESS_MONITOR_TASK_STACKSIZE\r
 472  *\r
 473  * Macro which sets the stack size of the "recorder status monitor" task.\r
 474  *\r
 475  * This task, vTraceMonitorTask in trcUser.c, periodically writes\r
 476  * the recorder status using the vTraceConsoleMessage macro, which is to\r
 477  * be mapped to your console "printf" routine. The task is intentionally \r
 478  * excluded from the demo trace.\r
 479  *\r
 480  * See vTraceMonitorTask in trcUser.c\r
 481  *****************************************************************************/\r
 482 #define TRACE_PROGRESS_MONITOR_TASK_STACKSIZE 500\r
 483 \r
 484 /******************************************************************************\r
 485  * TRACE_PROGRESS_MONITOR_TASK_PERIOD\r
 486  *\r
 487  * Macro which sets the period of the "recorder status monitor" task.\r
 488  *\r
 489  * This task, vTraceMonitorTask in trcUser.c, periodically writes\r
 490  * the recorder status using the vTraceConsoleMessage macro, which is to\r
 491  * be mapped to your console "printf" routine. The task is named TraceMon but \r
 492  * is intentionally excluded from the demo trace.\r
 493  *\r
 494  * Default is 1000 ticks (typically 1 second). On the Windows port, a lower \r
 495  * value is suggested since the Windows port runs very slowly, often 20-40\r
 496  * times slower than the simulated time.\r
 497  *\r
 498  * See vTraceMonitorTask in trcUser.c\r
 499  *****************************************************************************/\r
 500 #ifdef WIN32\r
 501     #define TRACE_PROGRESS_MONITOR_TASK_PERIOD 100\r
 502 #else\r
 503     #define TRACE_PROGRESS_MONITOR_TASK_PERIOD 1000\r
 504 #endif\r
 505 \r
 506 \r
 507 /******************************************************************************\r
 508  * USE_16BIT_OBJECT_HANDLES\r
 509  *\r
 510  * Macro which should be defined as either zero (0) or one (1).\r
 511  * Default is 0.\r
 512  *\r
 513  * If set to 0 (zero), the recorder uses 8-bit handles to identify kernel \r
 514  * objects such as tasks and queues. This limits the supported number of\r
 515  * concurrently active objects to 255 of each type (object class).\r
 516  *\r
 517  * If set to 1 (one), the recorder uses 16-bit handles to identify kernel \r
 518  * objects such as tasks and queues. This limits the supported number of\r
 519  * concurrent objects to 65535 of each type (object class). However, since the\r
 520  * object property table is limited to 64 KB, the practical limit is about\r
 521  * 3000 objects in total. \r
 522  * \r
 523  * NOTE: An object with a high ID (> 255) will generate an extra event \r
 524  * (= 4 byte) in the event buffer. \r
 525  * \r
 526  * NOTE: Some internal tables in the recorder gets larger when using 16-bit \r
 527  * handles. The additional RAM usage is 5-10 byte plus 1 byte per kernel object\r
 528  *, i.e., task, queue, semaphore, mutex, etc.\r
 529  *****************************************************************************/\r
 530 #define USE_16BIT_OBJECT_HANDLES 0\r
 531 \r
 532 /****** Port Name ******************** Code ** Official ** OS Platform ******\r
 533 * PORT_APPLICATION_DEFINED               -2     -           -                 \r
 534 * PORT_NOT_SET                           -1     -           -                 \r
 535 * PORT_HWIndependent                     0      Yes         Any               \r
 536 * PORT_Win32                             1      Yes         FreeRTOS Win32\r
 537 * PORT_Atmel_AT91SAM7                    2      No          Any               \r
 538 * PORT_Atmel_UC3A0                       3      No          Any               \r
 539 * PORT_ARM_CortexM                       4      Yes         Any               \r
 540 * PORT_Renesas_RX600                     5      Yes         Any               \r
 541 * PORT_Microchip_dsPIC_AND_PIC24         6      Yes         Any               \r
 542 * PORT_TEXAS_INSTRUMENTS_TMS570          7      No          Any               \r
 543 * PORT_TEXAS_INSTRUMENTS_MSP430          8      No          Any               \r
 544 * PORT_MICROCHIP_PIC32                   9      No          Any               \r
 545 * PORT_XILINX_PPC405                     10     No          FreeRTOS          \r
 546 * PORT_XILINX_PPC440                     11     No          FreeRTOS          \r
 547 * PORT_XILINX_MICROBLAZE                 12     No          Any               \r
 548 * PORT_NXP_LPC210X                       13     No          Any               \r
 549 *****************************************************************************/\r
 550 #define SELECTED_PORT PORT_Win32\r
 551 \r
 552 #if (SELECTED_PORT == PORT_NOT_SET)\r
 553 #error "You need to define SELECTED_PORT here!"\r
 554 #endif\r
 555 \r
 556 /******************************************************************************\r
 557 * USE_PRIMASK_CS (for Cortex M devices only)\r
 558 *\r
 559 * An integer constant that selects between two options for the critical\r
 560 * sections of the recorder library.\r
 561  *\r
 562 *   0: The default FreeRTOS critical section (BASEPRI) - default setting\r
 563 *   1: Always disable ALL interrupts (using PRIMASK)\r
 564  *\r
 565 * Option 0 uses the standard FreeRTOS macros for critical sections.\r
 566 * However, on Cortex-M devices they only disable interrupts with priorities \r
 567 * below a certain configurable level, while higher priority ISRs remain active.\r
 568 * Such high-priority ISRs may not use the recorder functions in this mode.\r
 569 *\r
 570 * Option 1 allows you to safely call the recorder from any ISR, independent of \r
 571 * the interrupt priority. This mode may however cause higher IRQ latencies\r
 572 * (some microseconds) since ALL configurable interrupts are disabled during \r
 573 * the recorder's critical sections in this mode, using the PRIMASK register.\r
 574  ******************************************************************************/\r
 575 #define USE_PRIMASK_CS 0\r
 576 \r
 577 \r
 578 #endif\r
 579 \r