FreeRTOS-Plus/FreeRTOS-Plus-Trace/Configuration - template/trcPort.h - third_party/github/FreeRTOS/FreeRTOS-Kernel - Git at Google

 /*******************************************************************************
  * FreeRTOS+Trace v2.2.3 Recorder Library
  * Percepio AB, www.percepio.se
  *
  * trcPort.h
  *
  * Contains together with trcPort.c all 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.
  *
  * FreeRTOS+Trace is available as Free Edition and in two premium editions.
  * You may use the premium features during 30 days for evaluation.
  * Download FreeRTOS+Trace at http://www.percepio.se/index.php?page=downloads
  *
  * Copyright Percepio AB, 2012.
  * www.percepio.se
  ******************************************************************************/

 #ifndef TRCPORT_H
 #define TRCPORT_H

 #include "trcBase.h"

 /* If FreeRTOS Win32 port */
 #ifdef WIN32

    #undef _WIN32_WINNT
    #define _WIN32_WINNT 0x0600

    /* Standard includes. */
    #include <stdio.h>
    #include <windows.h>
    #include <direct.h>

 /*******************************************************************************
  * 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. Note that this gives suboptimal display in FreeRTOS+Trace. 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 exection
  * time of zero. They are however still visible in FreeRTOS+Trace.
  *
  * PORT_Win32
  * "Accurate" timestamping based on the Windows permance counter. Note that
  * this gives the host machine time, not the simulated FreeRTOS time (tick
  * count). The timing of the Win32 FreeRTOS build is not real-time, since it
  * depends on the scheduling and tick rate of Windows, which is very slow.
  *
  * Officially supported hardware specific ports included are:
  * - PORT_Atmel_AT91SAM7
  * - PORT_ARM_CortexM
  * - PORT_Renesas_RX600
  *
  * 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.
  *
  * Unoffical hardware specific ports provided are:
  * - PORT_TEXAS_INSTRUMENTS_TMS570
  * - PORT_TEXAS_INSTRUMENTS_MSP430
  * - PORT_MICROCHIP_PIC32
  * - PORT_MICROCHIP_dsPIC_AND_PIC24
  * - PORT_XILINX_PPC405
  * - PORT_XILINX_PPC440
  *
  ******************************************************************************/

 #define PORT_NOT_SET                          -1

 /* Officially supported ports */
 #define PORT_HWIndependent                     0
 #define PORT_Win32                             1
 #define PORT_Atmel_AT91SAM7                    2
 #define PORT_ARM_CortexM                       3
 #define PORT_Renesas_RX600                     4

 /* Unofficial ports, provided by external developers and not yet verified */
 #define PORT_TEXAS_INSTRUMENTS_TMS570          5
 #define PORT_TEXAS_INSTRUMENTS_MSP430          6
 #define PORT_MICROCHIP_PIC32                   7
 #define PORT_MICROCHIP_dsPIC_AND_PIC24         8
 #define PORT_XILINX_PPC405                     9
 #define PORT_XILINX_PPC440                    10

 /*** Select your port here! **************************************************/
 #define SELECTED_PORT PORT_NOT_SET
 /*****************************************************************************/

 /*******************************************************************************
  * 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)
  * - Renesas RX62N:     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 (ARM Cortex R4F): 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)
  * - Freescale ColdFire:   1  (higher 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.se.
  ******************************************************************************/
 #define IRQ_PRIORITY_ORDER 0

 /*******************************************************************************
  * HWTC macros
  *
  * These four 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 a 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 uiTracePortGetTimeStamp is the main porting issue
  * or the trace recorder library. Typically you should not need to change
  * the code of uiTracePortGetTimeStamp if using the HWTC macros.
  *
  * OFFER FROM PERCEPIO:
  * For silicon companies and non-corporate FreeRTOS users (researchers, students,
  * hobbyists or early-phase startups) we have an attractive offer:
  * Provide a hardware timer port and get a FREE single-user licence for
  * FreeRTOS+Trace Professional Edition. Read more about this offer at
  * www.percepio.se or contact us directly at support@percepio.se.
  *
  ******************************************************************************/

 #if (SELECTED_PORT == PORT_Win32)

     #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING
     #define HWTC_COUNT (ulGetRunTimeCounterValue())
     #define HWTC_PERIOD 0
     #define HWTC_DIVISOR 1

 #elif (SELECTED_PORT == PORT_HWIndependent)

     #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING
     #define HWTC_COUNT 0
     #define HWTC_PERIOD 1
     #define HWTC_DIVISOR 1

 #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

 #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

 #elif (SELECTED_PORT == PORT_Renesas_RX600)

     #include "iodefine.h"

     #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING
     #define HWTC_COUNT (CMT0.CMCNT)
     #define HWTC_PERIOD ((((configPERIPHERAL_CLOCK_HZ/configTICK_RATE_HZ)-1)/8))
     #define HWTC_DIVISOR 1

 #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

 #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 configCPU_CLOCKS_PER_TICK
     #define HWTC_DIVISOR 1

 #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

 #elif (SELECTED_PORT == PORT_MICROCHIP_dsPIC_AND_PIC24)
     /* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */

     #define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING
     #define HWTC_COUNT (PR1)
     #define HWTC_PERIOD ((configCPU_CLOCK_HZ/portTIMER_PRESCALE)/configTICK_RATE_HZ)
     #define HWTC_DIVISOR 1

 #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 ( configCPU_CLOCK_HZ / configTICK_RATE_HZ )
     #define HWTC_DIVISOR 1

 #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 ( configCPU_CLOCK_HZ / configTICK_RATE_HZ )
     #define HWTC_DIVISOR 1

 #else
 #error "SELECTED_PORT is not set, or had unsupported value!"
 #endif

 #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!"
 #endif

 #if (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

 /*******************************************************************************
  * 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).
  ******************************************************************************/
 #define vTraceConsoleMessage(x)

 /*******************************************************************************
  * uiTracePortGetTimeStamp
  *
  * Returns the current time based on the HWTC macros which provide a hardware
  * isolation layer towards the hardware timer/counter.
  *
  * The HWTC macros and uiTracePortGetTimeStamp is the main porting issue
  * or the trace recorder library. Typically you should not need to change
  * the code of uiTracePortGetTimeStamp if using the HWTC macros.
  *
  * OFFER FROM PERCEPIO:
  * For silicon companies and non-corporate FreeRTOS users (researchers,
  * students, hobbyists or early-phase startups) we have an attractive offer:
  * Provide a hardware timer port and get a FREE single-user licence for
  * FreeRTOS+Trace Professional Edition. Read more about this offer at
  * www.percepio.se or contact us directly at support@percepio.se.
  ******************************************************************************/
 uint32_t uiTracePortGetTimeStamp(void);

 /*******************************************************************************
  * 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);

 #endif

 #endif
	/*******************************************************************************
	* FreeRTOS+Trace v2.2.3 Recorder Library
	* Percepio AB, www.percepio.se
	*
	* trcPort.h
	*
	* Contains together with trcPort.c all 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.
	*
	* FreeRTOS+Trace is available as Free Edition and in two premium editions.
	* You may use the premium features during 30 days for evaluation.
	* Download FreeRTOS+Trace at http://www.percepio.se/index.php?page=downloads
	*
	* Copyright Percepio AB, 2012.
	* www.percepio.se
	******************************************************************************/

	#ifndef TRCPORT_H
	#define TRCPORT_H

	#include "trcBase.h"

	/* If FreeRTOS Win32 port */
	#ifdef WIN32

	#undef _WIN32_WINNT
	#define _WIN32_WINNT 0x0600

	/* Standard includes. */
	#include <stdio.h>
	#include <windows.h>
	#include <direct.h>

	/*******************************************************************************
	* 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. Note that this gives suboptimal display in FreeRTOS+Trace. 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 exection
	* time of zero. They are however still visible in FreeRTOS+Trace.
	*
	* PORT_Win32
	* "Accurate" timestamping based on the Windows permance counter. Note that
	* this gives the host machine time, not the simulated FreeRTOS time (tick
	* count). The timing of the Win32 FreeRTOS build is not real-time, since it
	* depends on the scheduling and tick rate of Windows, which is very slow.
	*
	* Officially supported hardware specific ports included are:
	* - PORT_Atmel_AT91SAM7
	* - PORT_ARM_CortexM
	* - PORT_Renesas_RX600
	*
	* 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.
	*
	* Unoffical hardware specific ports provided are:
	* - PORT_TEXAS_INSTRUMENTS_TMS570
	* - PORT_TEXAS_INSTRUMENTS_MSP430
	* - PORT_MICROCHIP_PIC32
	* - PORT_MICROCHIP_dsPIC_AND_PIC24
	* - PORT_XILINX_PPC405
	* - PORT_XILINX_PPC440
	*
	******************************************************************************/

	#define PORT_NOT_SET -1

	/* Officially supported ports */
	#define PORT_HWIndependent 0
	#define PORT_Win32 1
	#define PORT_Atmel_AT91SAM7 2
	#define PORT_ARM_CortexM 3
	#define PORT_Renesas_RX600 4

	/* Unofficial ports, provided by external developers and not yet verified */
	#define PORT_TEXAS_INSTRUMENTS_TMS570 5
	#define PORT_TEXAS_INSTRUMENTS_MSP430 6
	#define PORT_MICROCHIP_PIC32 7
	#define PORT_MICROCHIP_dsPIC_AND_PIC24 8
	#define PORT_XILINX_PPC405 9
	#define PORT_XILINX_PPC440 10

	/* Select your port here! ************************************************/
	#define SELECTED_PORT PORT_NOT_SET
	/*****************************************************************************/

	/*******************************************************************************
	* 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)
	* - Renesas RX62N: 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 (ARM Cortex R4F): 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)
	* - Freescale ColdFire: 1 (higher 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.se.
	******************************************************************************/
	#define IRQ_PRIORITY_ORDER 0

	/*******************************************************************************
	* HWTC macros
	*
	* These four 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 a 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 uiTracePortGetTimeStamp is the main porting issue
	* or the trace recorder library. Typically you should not need to change
	* the code of uiTracePortGetTimeStamp if using the HWTC macros.
	*
	* OFFER FROM PERCEPIO:
	* For silicon companies and non-corporate FreeRTOS users (researchers, students,
	* hobbyists or early-phase startups) we have an attractive offer:
	* Provide a hardware timer port and get a FREE single-user licence for
	* FreeRTOS+Trace Professional Edition. Read more about this offer at
	* www.percepio.se or contact us directly at support@percepio.se.
	*
	******************************************************************************/

	#if (SELECTED_PORT == PORT_Win32)

	#define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING
	#define HWTC_COUNT (ulGetRunTimeCounterValue())
	#define HWTC_PERIOD 0
	#define HWTC_DIVISOR 1

	#elif (SELECTED_PORT == PORT_HWIndependent)

	#define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING
	#define HWTC_COUNT 0
	#define HWTC_PERIOD 1
	#define HWTC_DIVISOR 1

	#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

	#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

	#elif (SELECTED_PORT == PORT_Renesas_RX600)

	#include "iodefine.h"

	#define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING
	#define HWTC_COUNT (CMT0.CMCNT)
	#define HWTC_PERIOD ((((configPERIPHERAL_CLOCK_HZ/configTICK_RATE_HZ)-1)/8))
	#define HWTC_DIVISOR 1

	#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

	#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 configCPU_CLOCKS_PER_TICK
	#define HWTC_DIVISOR 1

	#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

	#elif (SELECTED_PORT == PORT_MICROCHIP_dsPIC_AND_PIC24)
	/* UNOFFICIAL PORT - NOT YET VERIFIED BY PERCEPIO */

	#define HWTC_COUNT_DIRECTION DIRECTION_INCREMENTING
	#define HWTC_COUNT (PR1)
	#define HWTC_PERIOD ((configCPU_CLOCK_HZ/portTIMER_PRESCALE)/configTICK_RATE_HZ)
	#define HWTC_DIVISOR 1

	#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 ( configCPU_CLOCK_HZ / configTICK_RATE_HZ )
	#define HWTC_DIVISOR 1

	#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 ( configCPU_CLOCK_HZ / configTICK_RATE_HZ )
	#define HWTC_DIVISOR 1

	#else
	#error "SELECTED_PORT is not set, or had unsupported value!"
	#endif

	#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!"
	#endif

	#if (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

	/*******************************************************************************
	* 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).
	******************************************************************************/
	#define vTraceConsoleMessage(x)

	/*******************************************************************************
	* uiTracePortGetTimeStamp
	*
	* Returns the current time based on the HWTC macros which provide a hardware
	* isolation layer towards the hardware timer/counter.
	*
	* The HWTC macros and uiTracePortGetTimeStamp is the main porting issue
	* or the trace recorder library. Typically you should not need to change
	* the code of uiTracePortGetTimeStamp if using the HWTC macros.
	*
	* OFFER FROM PERCEPIO:
	* For silicon companies and non-corporate FreeRTOS users (researchers,
	* students, hobbyists or early-phase startups) we have an attractive offer:
	* Provide a hardware timer port and get a FREE single-user licence for
	* FreeRTOS+Trace Professional Edition. Read more about this offer at
	* www.percepio.se or contact us directly at support@percepio.se.
	******************************************************************************/
	uint32_t uiTracePortGetTimeStamp(void);

	/*******************************************************************************
	* 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);

	#endif

	#endif