From 4aef70a52970669ee9aca8d8af518c59d70558b2 Mon Sep 17 00:00:00 2001 From: rtel Date: Mon, 17 Feb 2014 15:11:16 +0000 Subject: [PATCH] Update final demos that use the trace recorder code to use the new version. git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@2211 1d2547de-c912-0410-9cb9-b8ca96c0e9e2 --- .../UARTCommandConsole.c | 256 ++++++++++ .../Trace_Recorder_Configuration/trcConfig.h | 172 ++++--- .../trcHardwarePort.h | 474 ------------------ .../FreeRTOS-Plus-Trace/Include/trcBase.h | 4 +- .../Include/trcKernelPort.h | 4 +- 5 files changed, 356 insertions(+), 554 deletions(-) create mode 100644 FreeRTOS-Plus/Demo/Common/FreeRTOS_Plus_CLI_Demos/UARTCommandConsole.c delete mode 100644 FreeRTOS-Plus/Demo/FreeRTOS_Plus_CLI_with_Trace_Windows_Simulator/Trace_Recorder_Configuration/trcHardwarePort.h diff --git a/FreeRTOS-Plus/Demo/Common/FreeRTOS_Plus_CLI_Demos/UARTCommandConsole.c b/FreeRTOS-Plus/Demo/Common/FreeRTOS_Plus_CLI_Demos/UARTCommandConsole.c new file mode 100644 index 000000000..867d5fd71 --- /dev/null +++ b/FreeRTOS-Plus/Demo/Common/FreeRTOS_Plus_CLI_Demos/UARTCommandConsole.c @@ -0,0 +1,256 @@ +/* + FreeRTOS V8.0.0:rc1 - Copyright (C) 2014 Real Time Engineers Ltd. + All rights reserved + + VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION. + + *************************************************************************** + * * + * FreeRTOS provides completely free yet professionally developed, * + * robust, strictly quality controlled, supported, and cross * + * platform software that has become a de facto standard. * + * * + * Help yourself get started quickly and support the FreeRTOS * + * project by purchasing a FreeRTOS tutorial book, reference * + * manual, or both from: http://www.FreeRTOS.org/Documentation * + * * + * Thank you! * + * * + *************************************************************************** + + This file is part of the FreeRTOS distribution. + + FreeRTOS is free software; you can redistribute it and/or modify it under + the terms of the GNU General Public License (version 2) as published by the + Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception. + + >>! NOTE: The modification to the GPL is included to allow you to distribute + >>! a combined work that includes FreeRTOS without being obliged to provide + >>! the source code for proprietary components outside of the FreeRTOS + >>! kernel. + + FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + FOR A PARTICULAR PURPOSE. Full license text is available from the following + link: http://www.freertos.org/a00114.html + + 1 tab == 4 spaces! + + *************************************************************************** + * * + * Having a problem? Start by reading the FAQ "My application does * + * not run, what could be wrong?" * + * * + * http://www.FreeRTOS.org/FAQHelp.html * + * * + *************************************************************************** + + http://www.FreeRTOS.org - Documentation, books, training, latest versions, + license and Real Time Engineers Ltd. contact details. + + http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products, + including FreeRTOS+Trace - an indispensable productivity tool, a DOS + compatible FAT file system, and our tiny thread aware UDP/IP stack. + + http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High + Integrity Systems to sell under the OpenRTOS brand. Low cost OpenRTOS + licenses offer ticketed support, indemnification and middleware. + + http://www.SafeRTOS.com - High Integrity Systems also provide a safety + engineered and independently SIL3 certified version for use in safety and + mission critical applications that require provable dependability. + + 1 tab == 4 spaces! +*/ + +/* + * NOTE: This file uses a third party USB CDC driver. + */ + +/* Standard includes. */ +#include "string.h" +#include "stdio.h" + +/* FreeRTOS includes. */ +#include "FreeRTOS.h" +#include "task.h" +#include "semphr.h" + +/* Example includes. */ +#include "FreeRTOS_CLI.h" + +/* Demo application includes. */ +#include "serial.h" + +/* Dimensions the buffer into which input characters are placed. */ +#define cmdMAX_INPUT_SIZE 50 + +#define cmdQUEUE_LENGTH 25 + +/* DEL acts as a backspace. */ +#define cmdASCII_DEL ( 0x7F ) + +#define cmdMAX_MUTEX_WAIT ( ( ( TickType_t ) 300 ) / ( portTICK_PERIOD_MS ) ) + +#ifndef configCLI_BAUD_RATE + #define configCLI_BAUD_RATE 115200 +#endif + +/*-----------------------------------------------------------*/ + +/* + * The task that implements the command console processing. + */ +static void prvUARTCommandConsoleTask( void *pvParameters ); +void vUARTCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority ); + +/*-----------------------------------------------------------*/ + +/* Const messages output by the command console. */ +static const char * const pcWelcomeMessage = "FreeRTOS command server.\r\nType Help to view a list of registered commands.\r\n\r\n>"; +static const char * const pcEndOfOutputMessage = "\r\n[Press ENTER to execute the previous command again]\r\n>"; +static const char * const pcNewLine = "\r\n"; + +SemaphoreHandle_t xTxMutex = NULL; +static xComPortHandle xPort = 0; + +/*-----------------------------------------------------------*/ + +void vUARTCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority ) +{ + /* Create the semaphore used to access the UART Tx. */ + xTxMutex = xSemaphoreCreateMutex(); + configASSERT( xTxMutex ); + + /* Create that task that handles the console itself. */ + xTaskCreate( prvUARTCommandConsoleTask, /* The task that implements the command console. */ + "CLI", /* Text name assigned to the task. This is just to assist debugging. The kernel does not use this name itself. */ + usStackSize, /* The size of the stack allocated to the task. */ + NULL, /* The parameter is not used, so NULL is passed. */ + uxPriority, /* The priority allocated to the task. */ + NULL ); /* A handle is not required, so just pass NULL. */ +} +/*-----------------------------------------------------------*/ + +static void prvUARTCommandConsoleTask( void *pvParameters ) +{ +signed char cRxedChar; +uint8_t ucInputIndex = 0; +char *pcOutputString; +static char cInputString[ cmdMAX_INPUT_SIZE ], cLastInputString[ cmdMAX_INPUT_SIZE ]; +portBASE_TYPE xReturned; +xComPortHandle xPort; + + ( void ) pvParameters; + + /* Obtain the address of the output buffer. Note there is no mutual + exclusion on this buffer as it is assumed only one command console interface + will be used at any one time. */ + pcOutputString = FreeRTOS_CLIGetOutputBuffer(); + + /* Initialise the UART. */ + xPort = xSerialPortInitMinimal( configCLI_BAUD_RATE, cmdQUEUE_LENGTH ); + + /* Send the welcome message. */ + vSerialPutString( xPort, ( signed char * ) pcWelcomeMessage, strlen( pcWelcomeMessage ) ); + + for( ;; ) + { + /* Wait for the next character. The while loop is used in case + INCLUDE_vTaskSuspend is not set to 1 - in which case portMAX_DELAY will + be a genuine block time rather than an infinite block time. */ + while( xSerialGetChar( xPort, &cRxedChar, portMAX_DELAY ) != pdPASS ); + + /* Ensure exclusive access to the UART Tx. */ + if( xSemaphoreTake( xTxMutex, cmdMAX_MUTEX_WAIT ) == pdPASS ) + { + /* Echo the character back. */ + xSerialPutChar( xPort, cRxedChar, portMAX_DELAY ); + + /* Was it the end of the line? */ + if( cRxedChar == '\n' || cRxedChar == '\r' ) + { + /* Just to space the output from the input. */ + vSerialPutString( xPort, ( signed char * ) pcNewLine, strlen( pcNewLine ) ); + + /* See if the command is empty, indicating that the last command + is to be executed again. */ + if( ucInputIndex == 0 ) + { + /* Copy the last command back into the input string. */ + strcpy( cInputString, cLastInputString ); + } + + /* Pass the received command to the command interpreter. The + command interpreter is called repeatedly until it returns + pdFALSE (indicating there is no more output) as it might + generate more than one string. */ + do + { + /* Get the next output string from the command interpreter. */ + xReturned = FreeRTOS_CLIProcessCommand( cInputString, pcOutputString, configCOMMAND_INT_MAX_OUTPUT_SIZE ); + + /* Write the generated string to the UART. */ + vSerialPutString( xPort, ( signed char * ) pcOutputString, strlen( pcOutputString ) ); + + } while( xReturned != pdFALSE ); + + /* All the strings generated by the input command have been + sent. Clear the input string ready to receive the next command. + Remember the command that was just processed first in case it is + to be processed again. */ + strcpy( cLastInputString, cInputString ); + ucInputIndex = 0; + memset( cInputString, 0x00, cmdMAX_INPUT_SIZE ); + + vSerialPutString( xPort, ( signed char * ) pcEndOfOutputMessage, strlen( pcEndOfOutputMessage ) ); + } + else + { + if( cRxedChar == '\r' ) + { + /* Ignore the character. */ + } + else if( ( cRxedChar == '\b' ) || ( cRxedChar == cmdASCII_DEL ) ) + { + /* Backspace was pressed. Erase the last character in the + string - if any. */ + if( ucInputIndex > 0 ) + { + ucInputIndex--; + cInputString[ ucInputIndex ] = '\0'; + } + } + else + { + /* A character was entered. Add it to the string entered so + far. When a \n is entered the complete string will be + passed to the command interpreter. */ + if( ( cRxedChar >= ' ' ) && ( cRxedChar <= '~' ) ) + { + if( ucInputIndex < cmdMAX_INPUT_SIZE ) + { + cInputString[ ucInputIndex ] = cRxedChar; + ucInputIndex++; + } + } + } + } + + /* Must ensure to give the mutex back. */ + xSemaphoreGive( xTxMutex ); + } + } +} +/*-----------------------------------------------------------*/ + +void vOutputString( const char * const pcMessage ) +{ + if( xSemaphoreTake( xTxMutex, cmdMAX_MUTEX_WAIT ) == pdPASS ) + { + vSerialPutString( xPort, ( signed char * ) pcMessage, strlen( pcMessage ) ); + xSemaphoreGive( xTxMutex ); + } +} +/*-----------------------------------------------------------*/ + diff --git a/FreeRTOS-Plus/Demo/FreeRTOS_Plus_CLI_with_Trace_Windows_Simulator/Trace_Recorder_Configuration/trcConfig.h b/FreeRTOS-Plus/Demo/FreeRTOS_Plus_CLI_with_Trace_Windows_Simulator/Trace_Recorder_Configuration/trcConfig.h index e2e60ea6d..a81aeb8e0 100644 --- a/FreeRTOS-Plus/Demo/FreeRTOS_Plus_CLI_with_Trace_Windows_Simulator/Trace_Recorder_Configuration/trcConfig.h +++ b/FreeRTOS-Plus/Demo/FreeRTOS_Plus_CLI_with_Trace_Windows_Simulator/Trace_Recorder_Configuration/trcConfig.h @@ -1,5 +1,5 @@ /******************************************************************************* - * Tracealyzer v2.4.1 Recorder Library + * Tracealyzer v2.6.0 Recorder Library * Percepio AB, www.percepio.com * * trcConfig.h @@ -43,8 +43,6 @@ #ifndef TRCCONFIG_H #define TRCCONFIG_H -#include - /******************************************************************************* * CONFIGURATION RELATED TO CAPACITY AND ALLOCATION ******************************************************************************/ @@ -93,10 +91,16 @@ * stores User Events labels and names of deleted tasks, queues, or other kernel * objects. Note that the names of active objects not stored here but in the * Object Table. Thus, if you don't use User Events or delete any kernel - * objects you set this to zero (0) to minimize RAM usage. + * objects you set this to a very low value, e.g. 4, but not zero (0) since + * this causes a declaration of a zero-sized array, for which the C compiler + * behavior is not standardized and may cause misaligned data. ******************************************************************************/ #define SYMBOL_TABLE_SIZE 1000 +#if (SYMBOL_TABLE_SIZE == 0) +#error "SYMBOL_TABLE_SIZE may not be zero!" +#endif + /******************************************************************************* * USE_SEPARATE_USER_EVENT_BUFFER * @@ -158,10 +162,9 @@ * check the actual usage in Tracealyzer. This is shown by selecting * View -> Trace Details -> Resource Usage -> Object Table * - * NOTE 2: Remember to account for all tasks created by the kernel, such as the - * IDLE task, timer task, and any tasks created by other 3rd party - * software components, such as communication stacks. The recorder also has an - * optional monitor task to account for, if this is used. + * NOTE 2: Remember to account for all tasks and other objects created by + * the kernel, such as the IDLE task, any timer tasks, and any tasks created + * by other 3rd party software components, such as communication stacks. * Moreover, one task slot is used to indicate "(startup)", i.e., a fictive * task that represent the time before the scheduler starts. * NTask should thus be at least 2-3 slots larger than your application task count. @@ -172,6 +175,8 @@ #define NQueue 15 #define NSemaphore 15 #define NMutex 15 +#define NTimer 15 +#define NEventGroup 15 /* Maximum object name length for each class (includes zero termination) */ #define NameLenTask 15 @@ -179,6 +184,8 @@ #define NameLenQueue 15 #define NameLenSemaphore 15 #define NameLenMutex 15 +#define NameLenTimer 15 +#define NameLenEventGroup 15 /****************************************************************************** * TRACE_DESCRIPTION @@ -267,8 +274,7 @@ * much faster than a printf and can therefore be used in timing critical code. * See vTraceUserEvent() and vTracePrintF() in trcUser.h * - * Note that Tracealyzer Standard Edition or Professional Edition is required - * for User Events, they are not displayed in Tracealyzer Free Edition. + * Note that User Events are not displayed in FreeRTOS+Trace Free Edition. *****************************************************************************/ #define INCLUDE_USER_EVENTS 1 @@ -320,7 +326,18 @@ * traced kernel objects are deleted at runtime. If no deletes are made, this * can be set to 0 in order to exclude the delete-handling code. *****************************************************************************/ -#define INCLUDE_OBJECT_DELETE 0 +#define INCLUDE_OBJECT_DELETE 1 + +/****************************************************************************** + * INCLUDE_MEMMANG_EVENTS + * + * Macro which should be defined as either zero (0) or one (1). + * Default is 1. + * + * This controls if malloc and free calls should be traced. Set this to zero to + * exclude malloc/free calls from the tracing. + *****************************************************************************/ +#define INCLUDE_MEMMANG_EVENTS 1 /****************************************************************************** * CONFIGURATION RELATED TO BEHAVIOR @@ -428,83 +445,86 @@ *****************************************************************************/ #define USE_IMPLICIT_IFE_RULES 1 + /****************************************************************************** - * INCLUDE_SAVE_TO_FILE + * USE_16BIT_OBJECT_HANDLES * * Macro which should be defined as either zero (0) or one (1). * Default is 0. * - * If enabled (1), the recorder will include code for saving the trace - * to a local file system. - ******************************************************************************/ -#ifdef WIN32 - #define INCLUDE_SAVE_TO_FILE 1 -#else - #define INCLUDE_SAVE_TO_FILE 0 -#endif - -/****************************************************************************** - * TRACE_PROGRESS_MONITOR_TASK_PRIORITY - * - * Macro which sets the priority of the "recorder status monitor" task. - * - * This task, vTraceMonitorTask in trcUser.c, periodically writes - * the recorder status using the vTraceConsoleMessage macro, which is to - * be mapped to your console "printf" routine. The task is named TraceMon but - * is intentionally excluded from the demo trace. + * If set to 0 (zero), the recorder uses 8-bit handles to identify kernel + * objects such as tasks and queues. This limits the supported number of + * concurrently active objects to 255 of each type (object class). * - * Default is tskIDLE_PRIORITY + 1 - * Note that if your system constantly has a high CPU load from high-priority - * tasks, this might not be get a chance to execute. + * If set to 1 (one), the recorder uses 16-bit handles to identify kernel + * objects such as tasks and queues. This limits the supported number of + * concurrent objects to 65535 of each type (object class). However, since the + * object property table is limited to 64 KB, the practical limit is about + * 3000 objects in total. * - * See vTraceMonitorTask in trcUser.c - *****************************************************************************/ -#define TRACE_PROGRESS_MONITOR_TASK_PRIORITY (tskIDLE_PRIORITY + 1) - -/****************************************************************************** - * TRACE_PROGRESS_MONITOR_TASK_STACKSIZE - * - * Macro which sets the stack size of the "recorder status monitor" task. - * - * This task, vTraceMonitorTask in trcUser.c, periodically writes - * the recorder status using the vTraceConsoleMessage macro, which is to - * be mapped to your console "printf" routine. The task is intentionally - * excluded from the demo trace. - * - * See vTraceMonitorTask in trcUser.c + * NOTE: An object with a high ID (> 255) will generate an extra event + * (= 4 byte) in the event buffer. + * + * NOTE: Some internal tables in the recorder gets larger when using 16-bit + * handles. The additional RAM usage is 5-10 byte plus 1 byte per kernel object + *, i.e., task, queue, semaphore, mutex, etc. *****************************************************************************/ -#define TRACE_PROGRESS_MONITOR_TASK_STACKSIZE 500 +#define USE_16BIT_OBJECT_HANDLES 0 + +/****** Port Name ******************** Code ** Official ** OS Platform ****** +* PORT_APPLICATION_DEFINED -2 - - +* PORT_NOT_SET -1 - - +* PORT_HWIndependent 0 Yes Any +* PORT_Win32 1 Yes FreeRTOS Win32 +* PORT_Atmel_AT91SAM7 2 No Any +* PORT_Atmel_UC3A0 3 No Any +* PORT_ARM_CortexM 4 Yes Any +* PORT_Renesas_RX600 5 Yes Any +* PORT_Microchip_dsPIC_AND_PIC24 6 Yes Any +* PORT_TEXAS_INSTRUMENTS_TMS570 7 No Any +* PORT_TEXAS_INSTRUMENTS_MSP430 8 No Any +* PORT_MICROCHIP_PIC32 9 No Any +* PORT_XILINX_PPC405 10 No FreeRTOS +* PORT_XILINX_PPC440 11 No FreeRTOS +* PORT_XILINX_MICROBLAZE 12 No Any +* PORT_NXP_LPC210X 13 No Any +*****************************************************************************/ +#define SELECTED_PORT PORT_Win32 + +#if (SELECTED_PORT == PORT_NOT_SET) +#error "You need to define SELECTED_PORT here!" +#endif /****************************************************************************** - * TRACE_PROGRESS_MONITOR_TASK_PERIOD - * - * Macro which sets the period of the "recorder status monitor" task. - * - * This task, vTraceMonitorTask in trcUser.c, periodically writes - * the recorder status using the vTraceConsoleMessage macro, which is to - * be mapped to your console "printf" routine. The task is named TraceMon but - * is intentionally excluded from the demo trace. - * - * Default is 1000 ticks (typically 1 second). On the Windows port, a lower - * value is suggested since the Windows port runs very slowly, often 20-40 - * times slower than the simulated time. - * - * See vTraceMonitorTask in trcUser.c - *****************************************************************************/ -#ifdef WIN32 - #define TRACE_PROGRESS_MONITOR_TASK_PERIOD 100 -#else - #define TRACE_PROGRESS_MONITOR_TASK_PERIOD 1000 -#endif +* USE_PRIMASK_CS (for Cortex M devices only) +* +* An integer constant that selects between two options for the critical +* sections of the recorder library. + * +* 0: The default FreeRTOS critical section (BASEPRI) - default setting +* 1: Always disable ALL interrupts (using PRIMASK) + * +* Option 0 uses the standard FreeRTOS macros for critical sections. +* However, on Cortex-M devices they only disable interrupts with priorities +* below a certain configurable level, while higher priority ISRs remain active. +* Such high-priority ISRs may not use the recorder functions in this mode. +* +* Option 1 allows you to safely call the recorder from any ISR, independent of +* the interrupt priority. This mode may however cause higher IRQ latencies +* (some microseconds) since ALL configurable interrupts are disabled during +* the recorder's critical sections in this mode, using the PRIMASK register. + ******************************************************************************/ +#define USE_PRIMASK_CS 0 /****************************************************************************** - * TEAM_LICENSE_CODE - * - * Macro which defines a string - the team license code. - * If no team license is available, this should be an empty string "". - * This should be maximum 32 chars, including zero-termination. - *****************************************************************************/ -#define TEAM_LICENSE_CODE "" +* HEAP_SIZE_BELOW_16M +* +* An integer constant that can be used to reduce the buffer usage of memory +* allocation events (malloc/free). This value should be 1 if the heap size is +* below 16 MB (2^24 byte), and you can live with addresses truncated to the +* lower 24 bit. Otherwise set it to 0 to get the full 32-bit addresses. +******************************************************************************/ +#define HEAP_SIZE_BELOW_16M 0 #endif diff --git a/FreeRTOS-Plus/Demo/FreeRTOS_Plus_CLI_with_Trace_Windows_Simulator/Trace_Recorder_Configuration/trcHardwarePort.h b/FreeRTOS-Plus/Demo/FreeRTOS_Plus_CLI_with_Trace_Windows_Simulator/Trace_Recorder_Configuration/trcHardwarePort.h deleted file mode 100644 index ac8347765..000000000 --- a/FreeRTOS-Plus/Demo/FreeRTOS_Plus_CLI_with_Trace_Windows_Simulator/Trace_Recorder_Configuration/trcHardwarePort.h +++ /dev/null @@ -1,474 +0,0 @@ -/******************************************************************************* - * Tracealyzer v2.4.1 Recorder Library - * Percepio AB, www.percepio.com - * - * trcHardwarePort.h - * - * Contains together with trcHardwarePort.c all hardware portability issues of - * the trace recorder library. - * - * Terms of Use - * This software is copyright Percepio AB. The recorder library is free for - * use together with Percepio products. You may distribute the recorder library - * in its original form, including modifications in trcPort.c and trcPort.h - * given that these modification are clearly marked as your own modifications - * and documented in the initial comment section of these source files. - * This software is the intellectual property of Percepio AB and may not be - * sold or in other ways commercially redistributed without explicit written - * permission by Percepio AB. - * - * Disclaimer - * The trace tool and recorder library is being delivered to you AS IS and - * Percepio AB makes no warranty as to its use or performance. Percepio AB does - * not and cannot warrant the performance or results you may obtain by using the - * software or documentation. Percepio AB make no warranties, express or - * implied, as to noninfringement of third party rights, merchantability, or - * fitness for any particular purpose. In no event will Percepio AB, its - * technology partners, or distributors be liable to you for any consequential, - * incidental or special damages, including any lost profits or lost savings, - * even if a representative of Percepio AB has been advised of the possibility - * of such damages, or for any claim by any third party. Some jurisdictions do - * not allow the exclusion or limitation of incidental, consequential or special - * damages, or the exclusion of implied warranties or limitations on how long an - * implied warranty may last, so the above limitations may not apply to you. - * - * Copyright Percepio AB, 2013. - * www.percepio.com - ******************************************************************************/ - -#ifndef TRCPORT_H -#define TRCPORT_H - -#include "trcKernelPort.h" - -/* If Win32 port */ -#ifdef WIN32 - - #undef _WIN32_WINNT - #define _WIN32_WINNT 0x0600 - - /* Standard includes. */ - #include - #include - #include - -/******************************************************************************* - * The Win32 port by default saves the trace to file and then kills the - * program when the recorder is stopped, to facilitate quick, simple tests - * of the recorder. - ******************************************************************************/ - #define WIN32_PORT_SAVE_WHEN_STOPPED 1 - #define WIN32_PORT_EXIT_WHEN_STOPPED 1 - -#endif - -#define DIRECTION_INCREMENTING 1 -#define DIRECTION_DECREMENTING 2 - -/****************************************************************************** - * Supported ports - * - * PORT_HWIndependent - * A hardware independent fallback option for event timestamping. Provides low - * resolution timestamps based on the OS tick. - * This may be used on the Win32 port, but may also be used on embedded hardware - * platforms. All time durations will be truncated to the OS tick frequency, - * typically 1 KHz. This means that a task or ISR that executes in less than - * 1 ms get an execution time of zero. - * - * PORT_Win32 - * "Accurate" timestamping based on the Windows performance counter. Note that - * this gives the host machine time. - * - * Officially supported hardware timer ports: - * - PORT_Atmel_AT91SAM7 - * - PORT_Atmel_UC3A0 - * - PORT_ARM_CortexM - * - PORT_Renesas_RX600 - * - PORT_Microchip_dsPIC_AND_PIC24 - * - * We also provide several "unofficial" hardware-specific ports. There have - * been developed by external contributors, and have not yet been verified - * by Percepio AB. Let us know if you have problems getting these to work. - * - * Unofficial hardware specific ports provided are: - * - PORT_TEXAS_INSTRUMENTS_TMS570 - * - PORT_TEXAS_INSTRUMENTS_MSP430 - * - PORT_MICROCHIP_PIC32 - * - PORT_XILINX_PPC405 - * - PORT_XILINX_PPC440 - * - PORT_XILINX_MICROBLAZE - * - PORT_NXP_LPC210X - * - *****************************************************************************/ - -#define PORT_NOT_SET -1 - -/*** Officially supported hardware timer ports *******************************/ -#define PORT_HWIndependent 0 -#define PORT_Win32 1 -#define PORT_Atmel_AT91SAM7 2 -#define PORT_Atmel_UC3A0 3 -#define PORT_ARM_CortexM 4 -#define PORT_Renesas_RX600 5 -#define PORT_Microchip_dsPIC_AND_PIC24 6 - -/*** Unofficial ports, provided by external developers, not yet verified *****/ -#define PORT_TEXAS_INSTRUMENTS_TMS570 7 -#define PORT_TEXAS_INSTRUMENTS_MSP430 8 -#define PORT_MICROCHIP_PIC32 9 -#define PORT_XILINX_PPC405 10 -#define PORT_XILINX_PPC440 11 -#define PORT_XILINX_MICROBLAZE 12 -#define PORT_NXP_LPC210X 13 - -/*** Select your port here! **************************************************/ -#define SELECTED_PORT PORT_Win32 -/*****************************************************************************/ - -#if (SELECTED_PORT == PORT_NOT_SET) -#error "You need to define SELECTED_PORT here!" -#endif - -/******************************************************************************* - * IRQ_PRIORITY_ORDER - * - * Macro which should be defined as an integer of 0 or 1. - * - * This should be 0 if lower IRQ priority values implies higher priority - * levels, such as on ARM Cortex M. If the opposite scheme is used, i.e., - * if higher IRQ priority values means higher priority, this should be 1. - * - * This setting is not critical. It is used only to sort and colorize the - * interrupts in priority order, in case you record interrupts using - * the vTraceStoreISRBegin and vTraceStoreISREnd routines. - * - * We provide this setting for some hardware architectures below: - * - ARM Cortex M: 0 (lower IRQ priority values are more significant) - * - Atmel AT91SAM7x: 1 (higher IRQ priority values are more significant) - * - Atmel AVR32: 1 (higher IRQ priority values are more significant) - * - Renesas RX600: 1 (higher IRQ priority values are more significant) - * - Microchip PIC24: 0 (lower IRQ priority values are more significant) - * - Microchip dsPIC: 0 (lower IRQ priority values are more significant) - * - TI TMS570: 0 (lower IRQ priority values are more significant) - * - Freescale HCS08: 0 (lower IRQ priority values are more significant) - * - Freescale HCS12: 0 (lower IRQ priority values are more significant) - * - PowerPC 405: 0 (lower IRQ priority values are more significant) - * - PowerPC 440: 0 (lower IRQ priority values are more significant) - * - Freescale ColdFire: 1 (higher IRQ priority values are more significant) - * - NXP LPC210x: 0 (lower IRQ priority values are more significant) - * - MicroBlaze: 0 (lower IRQ priority values are more significant) - * - * If your chip is not on the above list, and you perhaps know this detail by - * heart, please inform us by e-mail to support@percepio.com. - * - ****************************************************************************** - * - * HWTC Macros - * - * These four HWTC macros provides a hardware isolation layer representing a - * generic hardware timer/counter used for driving the operating system tick, - * such as the SysTick feature of ARM Cortex M3/M4, or the PIT of the Atmel - * AT91SAM7X. - * - * HWTC_COUNT: The current value of the counter. This is expected to be reset - * a each tick interrupt. Thus, when the tick handler starts, the counter has - * already wrapped. - * - * HWTC_COUNT_DIRECTION: Should be one of: - * - DIRECTION_INCREMENTING - for hardware timer/counters of incrementing type - * such as the PIT on Atmel AT91SAM7X. - * When the counter value reach HWTC_PERIOD, it is reset to zero and the - * interrupt is signaled. - * - DIRECTION_DECREMENTING - for hardware timer/counters of decrementing type - * such as the SysTick on ARM Cortex M3/M4 chips. - * When the counter value reach 0, it is reset to HWTC_PERIOD and the - * interrupt is signaled. - * - * HWTC_PERIOD: The number of increments or decrements of HWTC_COUNT between - * two tick interrupts. This should preferably be mapped to the reload - * register of the hardware timer, to make it more portable between chips in the - * same family. The macro should in most cases be (reload register + 1). - * - * HWTC_DIVISOR: If the timer frequency is very high, like on the Cortex M chips - * (where the SysTick runs at the core clock frequency), the "differential - * timestamping" used in the recorder will more frequently insert extra XTS - * events to store the timestamps, which increases the event buffer usage. - * In such cases, to reduce the number of XTS events and thereby get longer - * traces, you use HWTC_DIVISOR to scale down the timestamps and frequency. - * Assuming a OS tick rate of 1 KHz, it is suggested to keep the effective timer - * frequency below 65 MHz to avoid an excessive amount of XTS events. Thus, a - * Cortex M chip running at 72 MHZ should use a HWTC_DIVISOR of 2, while a - * faster chip require a higher HWTC_DIVISOR value. - * - * The HWTC macros and vTracePortGetTimeStamp is the main porting issue - * or the trace recorder library. Typically you should not need to change - * the code of vTracePortGetTimeStamp if using the HWTC macros. - * - ******************************************************************************/ - -#if (SELECTED_PORT == PORT_Win32) - - #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING - #define HWTC_COUNT (ulGetRunTimeCounterValue()) - #define HWTC_PERIOD 0 - #define HWTC_DIVISOR 1 - - #define IRQ_PRIORITY_ORDER 1 // Please update according to your hardware... - -#elif (SELECTED_PORT == PORT_HWIndependent) - - #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING - #define HWTC_COUNT 0 - #define HWTC_PERIOD 1 - #define HWTC_DIVISOR 1 - - #define IRQ_PRIORITY_ORDER 1 // Please update according to your hardware... - -#elif (SELECTED_PORT == PORT_Atmel_AT91SAM7) - - /* HWTC_PERIOD is hardcoded for AT91SAM7X256-EK Board (48 MHz) - A more generic solution is to get the period from pxPIT->PITC_PIMR */ - - #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING - #define HWTC_COUNT (AT91C_BASE_PITC->PITC_PIIR & 0xFFFFF) - #define HWTC_PERIOD 2995 - #define HWTC_DIVISOR 1 - - #define IRQ_PRIORITY_ORDER 1 // higher IRQ priority values are more significant - -#elif (SELECTED_PORT == PORT_Atmel_UC3A0) - - /* For Atmel AVR32 (AT32UC3A) */ - - #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING - #define HWTC_COUNT sysreg_read(AVR32_COUNT) - #define HWTC_PERIOD ( TRACE_CPU_CLOCK_HZ / TRACE_TICK_RATE_HZ ) - #define HWTC_DIVISOR 1 - - #define IRQ_PRIORITY_ORDER 1 // higher IRQ priority values are more significant - -#elif (SELECTED_PORT == PORT_ARM_CortexM) - - /* For all chips using ARM Cortex M cores */ - - #define HWTC_COUNT_DIRECTION DIRECTION_DECREMENTING - #define HWTC_COUNT (*((uint32_t*)0xE000E018)) - #define HWTC_PERIOD ((*(uint32_t*)0xE000E014) + 1) - #define HWTC_DIVISOR 2 - - #define IRQ_PRIORITY_ORDER 0 // lower IRQ priority values are more significant - -#elif (SELECTED_PORT == PORT_Renesas_RX600) - - #include "iodefine.h" - - #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING - #define HWTC_COUNT (CMT0.CMCNT) - #define HWTC_PERIOD ((((TRACE_PERIPHERAL_CLOCK_HZ/TRACE_TICK_RATE_HZ)-1)/8)) - #define HWTC_DIVISOR 1 - - #define IRQ_PRIORITY_ORDER 1 // higher IRQ priority values are more significant - -#elif (SELECTED_PORT == PORT_Microchip_dsPIC_AND_PIC24) - - /* For Microchip PIC24 and dsPIC (16 bit) */ - - /* Note: The trace library was originally designed for 32-bit MCUs, and is slower - than intended on 16-bit MCUs. Storing an event on a PIC24 takes about 70 µs. - In comparison, 32-bit MCUs are often 10-20 times faster. If recording overhead - becomes a problem on PIC24, use the filters to exclude less interesting tasks - or system calls. */ - - #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING - #define HWTC_COUNT (TMR1) - #define HWTC_PERIOD (PR1+1) - #define HWTC_DIVISOR 1 - - #define IRQ_PRIORITY_ORDER 0 // lower IRQ priority values are more significant - -#elif (SELECTED_PORT == PORT_NXP_LPC210X) - /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */ - - /* Tested with LPC2106, but should work with most LPC21XX chips. */ - - #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING - #define HWTC_COUNT *((uint32_t *)0xE0004008 ) - #define HWTC_PERIOD ( TRACE_CPU_CLOCK_HZ / TRACE_TICK_RATE_HZ ) - #define HWTC_DIVISOR 1 - - #define IRQ_PRIORITY_ORDER 0 // lower IRQ priority values are more significant - -#elif (SELECTED_PORT == PORT_TEXAS_INSTRUMENTS_TMS570) - /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */ - - #define RTIFRC0 *((uint32_t *)0xFFFFFC10) - #define RTICOMP0 *((uint32_t *)0xFFFFFC50) - #define RTIUDCP0 *((uint32_t *)0xFFFFFC54) - #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING - #define HWTC_COUNT (RTIFRC0 - (RTICOMP0 - RTIUDCP0)) - #define HWTC_PERIOD (RTIUDCP0) - #define HWTC_DIVISOR 1 - - #define IRQ_PRIORITY_ORDER 0 // lower IRQ priority values are more significant - -#elif (SELECTED_PORT == PORT_TEXAS_INSTRUMENTS_MSP430) - /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */ - - #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING - #define HWTC_COUNT (TA0R) - #define HWTC_PERIOD TRACE_CPU_CLOCKS_PER_TICK - #define HWTC_DIVISOR 1 - - #define IRQ_PRIORITY_ORDER 1 // higher IRQ priority values are more significant - -#elif (SELECTED_PORT == PORT_MICROCHIP_PIC32) - /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */ - - #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING - #define HWTC_COUNT (ReadTimer1()) /* Should be available in BSP */ - #define HWTC_PERIOD (ReadPeriod1()+1) /* Should be available in BSP */ - #define HWTC_DIVISOR 1 - - #define IRQ_PRIORITY_ORDER 0 // lower IRQ priority values are more significant - -#elif (SELECTED_PORT == PORT_XILINX_PPC405) - /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */ - - #define HWTC_COUNT_DIRECTION DIRECTION_DECREMENTING - #define HWTC_COUNT mfspr( 0x3db) - #define HWTC_PERIOD ( TRACE_CPU_CLOCK_HZ / TRACE_TICK_RATE_HZ ) - #define HWTC_DIVISOR 1 - - #define IRQ_PRIORITY_ORDER 0 // lower IRQ priority values are more significant - -#elif (SELECTED_PORT == PORT_XILINX_PPC440) - /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */ - - /* This should work with most PowerPC chips */ - - #define HWTC_COUNT_DIRECTION DIRECTION_DECREMENTING - #define HWTC_COUNT mfspr( 0x016 ) - #define HWTC_PERIOD ( TRACE_CPU_CLOCK_HZ / TRACE_TICK_RATE_HZ ) - #define HWTC_DIVISOR 1 - - #define IRQ_PRIORITY_ORDER 0 // lower IRQ priority values are more significant - -#elif (SELECTED_PORT == PORT_XILINX_MICROBLAZE) - /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */ - - /* This should work with most Microblaze configurations. - * It uses the AXI Timer 0 - the tick interrupt source. - * If an AXI Timer 0 peripheral is available on your hardware platform, no modifications are required. - */ - #include "xtmrctr_l.h" - - #define HWTC_COUNT_DIRECTION DIRECTION_DECREMENTING - #define HWTC_COUNT XTmrCtr_GetTimerCounterReg( XPAR_TMRCTR_0_BASEADDR, 0 ) - #define HWTC_PERIOD ( TRACE_CPU_CLOCK_HZ / TRACE_TICK_RATE_HZ ) - #define HWTC_DIVISOR 16 - - #define IRQ_PRIORITY_ORDER 0 // lower IRQ priority values are more significant - -#elif (SELECTED_PORT != PORT_NOT_SET) - - #error "SELECTED_PORT had unsupported value!" - #define SELECTED_PORT PORT_NOT_SET - -#endif - -#if (SELECTED_PORT != PORT_NOT_SET) - - #ifndef HWTC_COUNT_DIRECTION - #error "HWTC_COUNT_DIRECTION is not set!" - #endif - - #ifndef HWTC_COUNT - #error "HWTC_COUNT is not set!" - #endif - - #ifndef HWTC_PERIOD - #error "HWTC_PERIOD is not set!" - #endif - - #ifndef HWTC_DIVISOR - #error "HWTC_DIVISOR is not set!" - #endif - - #ifndef IRQ_PRIORITY_ORDER - #error "IRQ_PRIORITY_ORDER is not set!" - #elif (IRQ_PRIORITY_ORDER != 0) && (IRQ_PRIORITY_ORDER != 1) - #error "IRQ_PRIORITY_ORDER has bad value!" - #endif - - #if (HWTC_DIVISOR < 1) - #error "HWTC_DIVISOR must be a non-zero positive value!" - #endif - -#endif -/******************************************************************************* - * vTraceConsoleMessage - * - * A wrapper for your system-specific console "printf" console output function. - * This needs to be correctly defined to see status reports from the trace - * status monitor task (this is defined in trcUser.c). - ******************************************************************************/ -#if (SELECTED_PORT == PORT_Atmel_AT91SAM7) -/* Port specific includes */ -#include "console.h" -#endif - -#define vTraceConsoleMessage(x) - -/******************************************************************************* - * vTracePortGetTimeStamp - * - * Returns the current time based on the HWTC macros which provide a hardware - * isolation layer towards the hardware timer/counter. - * - * The HWTC macros and vTracePortGetTimeStamp is the main porting issue - * or the trace recorder library. Typically you should not need to change - * the code of vTracePortGetTimeStamp if using the HWTC macros. - * - ******************************************************************************/ -void vTracePortGetTimeStamp(uint32_t *puiTimestamp); - -/******************************************************************************* - * vTracePortEnd - * - * This function is called when the recorder is stopped due to full buffer. - * Mainly intended to show a message in the console. - * This is used by the Win32 port to store the trace to a file. The file path is - * set using vTracePortSetFileName. - ******************************************************************************/ -void vTracePortEnd(void); - -#if (INCLUDE_SAVE_TO_FILE == 1) - -/******************************************************************************* - * vTracePortSetOutFile - * - * Sets the filename/path used in vTracePortSave. - * This is set in a separate function, since the Win32 port calls vTracePortSave - * in vTracePortEnd if WIN32_PORT_SAVE_WHEN_STOPPED is set. - ******************************************************************************/ -void vTracePortSetOutFile(char* path); - -/****************************************************************************** - * vTracePortSave - * - * Saves the trace to a file on a target-side file system. The path is set in a - * separate function, vTracePortSetOutFile, since the Win32 port may call - * vTracePortSave in vTracePortEnd, if using WIN32_PORT_SAVE_WHEN_STOPPED. - ******************************************************************************/ -void vTracePortSave(void); - -#else - -#define vTraceConsoleMessage(x) -#define vTracePortSetOutFile(path) -#define vTracePortSave(void) - -#endif - -#endif diff --git a/FreeRTOS-Plus/Source/FreeRTOS-Plus-Trace/Include/trcBase.h b/FreeRTOS-Plus/Source/FreeRTOS-Plus-Trace/Include/trcBase.h index 31dad34e7..b3e522d51 100644 --- a/FreeRTOS-Plus/Source/FreeRTOS-Plus-Trace/Include/trcBase.h +++ b/FreeRTOS-Plus/Source/FreeRTOS-Plus-Trace/Include/trcBase.h @@ -519,8 +519,8 @@ RecorderDataPtr->ObjectPropertyTable.objbytes[uiIndexOfObject(handle, objectclas #define TRACE_CLEAR_EVENT_CODE_FLAG_ISEXCLUDED(eventCode) TRACE_CLEAR_FLAG_ISEXCLUDED(excludedEventCodes, eventCode) #define TRACE_GET_EVENT_CODE_FLAG_ISEXCLUDED(eventCode) TRACE_GET_FLAG_ISEXCLUDED(excludedEventCodes, eventCode) -#define TRACE_UPDATE_HEAP_USAGE_POSITIVE(change) {if (RecorderDataPtr != NULL) RecorderDataPtr->heapMemUsage += change;} -#define TRACE_UPDATE_HEAP_USAGE_NEGATIVE(change) {if (RecorderDataPtr != NULL) RecorderDataPtr->heapMemUsage -= change;} +#define TRACE_INCR_HEAP_USAGE(change) {if (RecorderDataPtr != NULL) RecorderDataPtr->heapMemUsage += change;} +#define TRACE_DECR_HEAP_USAGE(change) {if (RecorderDataPtr != NULL) RecorderDataPtr->heapMemUsage -= change;} /* DEBUG ASSERTS */ #if defined USE_TRACE_ASSERT && USE_TRACE_ASSERT != 0 diff --git a/FreeRTOS-Plus/Source/FreeRTOS-Plus-Trace/Include/trcKernelPort.h b/FreeRTOS-Plus/Source/FreeRTOS-Plus-Trace/Include/trcKernelPort.h index b08a1f13b..e87bce1bc 100644 --- a/FreeRTOS-Plus/Source/FreeRTOS-Plus-Trace/Include/trcKernelPort.h +++ b/FreeRTOS-Plus/Source/FreeRTOS-Plus-Trace/Include/trcKernelPort.h @@ -746,11 +746,11 @@ else \ extern void vTraceStoreMemMangEvent(uint32_t ecode, uint32_t address, uint32_t size); #undef traceMALLOC -#define traceMALLOC( pvAddress, uiSize ) {vTraceStoreMemMangEvent(MEM_MALLOC_SIZE, ( uint32_t ) pvAddress, uiSize); TRACE_UPDATE_HEAP_USAGE_POSITIVE(uiSize);} +#define traceMALLOC( pvAddress, uiSize ) {vTraceStoreMemMangEvent(MEM_MALLOC_SIZE, ( uint32_t ) pvAddress, uiSize); TRACE_INCR_HEAP_USAGE(uiSize);} #undef traceFREE -#define traceFREE( pvAddress, uiSize ) {vTraceStoreMemMangEvent(MEM_FREE_SIZE, ( uint32_t ) pvAddress, uiSize); TRACE_UPDATE_HEAP_USAGE_NEGATIVE(uiSize);} +#define traceFREE( pvAddress, uiSize ) {vTraceStoreMemMangEvent(MEM_FREE_SIZE, ( uint32_t ) pvAddress, uiSize); TRACE_DECR_HEAP_USAGE(uiSize);} #endif -- 2.39.5