module ti.sysbios.timers.timer64.Timer

Timer Peripheral Manager

C synopsis
Individual elements
Configuration settings
Individual elements

This Timer module manages the timer64 peripheral available on many devices. It is supported on the ARM and c64x+ DSP targets. This module supports the timer in '32-bit chained' and '32-bit unchained' mode. In the '32-bit unchained' mode, specify the lower or upper half to be used. The physical timer being used will be taken out of reset, only when its specified to be the master. [ more ... ]

C synopsis target-domain sourced in ti/sysbios/timers/timer64/Timer.xdc

#include <ti/sysbios/timers/timer64/Timer.h>

Functions
Void	Timer_construct// Initialize a new instance object inside the provided structure(Timer_Struct structP, Int id, ITimer_FuncPtr tickFxn, const Timer_Params params, Error_Block *eb);
Timer_Handle	Timer_create// Allocate and initialize a new instance object and return its handle(Int id, ITimer_FuncPtr tickFxn, const Timer_Params params, Error_Block eb);
Void	Timer_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(Timer_Handle *handleP);
Void	Timer_destruct// Finalize the instance object inside the provided structure(Timer_Struct *structP);
Void	Timer_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(Timer_Params *params);
Void	Timer_reconfig// Used to modify static timer instances at runtime(Timer_Handle handle, Timer_FuncPtr tickFxn, Timer_Params timerParams, Error_Block eb);
Functions common to all ITimer modules
UInt32	Timer_getCount// Read timer counter register(Timer_Handle handle);
Void	Timer_getFreq// Return timer frequency in Hz(Timer_Handle handle, Types_FreqHz *freq);
ITimer_FuncPtr	Timer_getFunc// Get Timer function and arg(Timer_Handle handle, UArg *arg);
UInt	Timer_getNumTimers// Returns number of timer peripherals on the platform();
UInt32	Timer_getPeriod// Get timer period in timer counts(Timer_Handle handle);
ITimer_Status	Timer_getStatus// Returns timer status (free or in use)(UInt id);
Void	Timer_setFunc// Overwrite Timer function and arg(Timer_Handle handle, ITimer_FuncPtr fxn, UArg arg);
Void	Timer_setPeriod// Set timer period specified in timer counts(Timer_Handle handle, UInt32 period);
Bool	Timer_setPeriodMicroSecs// Set timer period specified in microseconds(Timer_Handle handle, UInt32 microsecs);
Void	Timer_start// Reload and start the timer(Timer_Handle handle);
Void	Timer_stop// Stop the timer(Timer_Handle handle);
Functions common to all target instances
	Timer_handle// Convert this instance structure pointer into an instance handle, Timer_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, Timer_Handle_label// The label associated with this instance object, Timer_Handle_name// The name of this instance object, Timer_Handle_upCast// unconditionally move one level up the inheritance hierarchy, Timer_Object_count// The number of statically-created instance objects, Timer_Object_first// The handle of the first dynamically-created instance object, or NULL, Timer_Object_get// The handle of the i-th statically-created instance object (array == NULL), Timer_Object_heap// The heap used to allocate dynamically-created instance objects, Timer_Object_next// The handle of the next dynamically-created instance object, or NULL, Timer_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	Timer_Module_getMask// Returns the diagnostics mask for this module, Timer_Module_hasMask// Test whether this module has a diagnostics mask, Timer_Module_heap// The heap from which this module allocates memory, Timer_Module_id// Get this module's unique id, Timer_Module_setMask// Set the diagnostics mask for this module, Timer_Module_startupDone// Test if this module has completed startup
Defines
#define	Timer_ANY// Const used to specify any timer (UInt)~0
#define	Timer_MAX_PERIOD// Max value of Timer period for PeriodType_COUNTS (UInt)0xffffffff
Typedefs
typedef struct	Timer_Control// Timer Control Register struct ...
typedef struct	Timer_EmuMgt// Timer Emulation Management Register struct ...
typedef Void	(*Timer_FuncPtr// Timer tick function prototype)(UArg);
typedef struct	Timer_GpioDatDir// Timer GPIO Data and Direction Management Register struct ...
typedef struct	Timer_GpioIntEn// Timer GPIO interrupt control and enable Management Register struct ...
typedef enum	Timer_Half// In 32-bit modes, used to specify which half of Timer to use ...
typedef Timer_Object *	Timer_Handle// Client reference to an instance object;
typedef struct	Timer_IntCtl// Timer interrupt control struct ...
typedef enum	Timer_Mode// The different modes of the Timer. These values match the TIMMODE bit fields of the Timer Global Control Register ...
typedef struct	Timer_Object// Opaque internal representation of an instance object Timer_Object;
typedef struct	Timer_Params// Instance config-params structure ...
typedef enum	Timer_PeriodType// Timer period units ...
typedef enum	Timer_RunMode// Timer Run Modes ...
typedef enum	Timer_StartMode// Timer Start Modes ...
typedef enum	Timer_Status// Timer Status ...
typedef struct	Timer_Struct// Opaque client structure large enough to hold an instance object Timer_Struct;
typedef struct	Timer_TimerSetting// Timer Settings ...
Constants
extern const Bits32	Timer_anyMask// Available mask to be used when select = Timer_ANY for timer id < 16. Set in xs file;
extern const Bits32	Timer_anyMaskHigh// Available mask to be used when select = Timer_ANY for timer id >= 16. Set in xs file;
extern const Assert_Id	Timer_A_notAvailable// Assert raised when static created timer is not available;
extern const Timer_Half	Timer_defaultHalf// The default 32-bit half of the timer to be used;
extern const Error_Id	Timer_E_cannotSupport// Error raised when period requested is not supported;
extern const Error_Id	Timer_E_invalidTimer// Error raised when timer id specified is not supported;
extern const Error_Id	Timer_E_notAvailable// Error raised when timer requested is in use;
extern const Timer_TimerSetting	Timer_timerSettings// Global Control configuration for each physical timer[];

DETAILS

For shared timers on a homogeneous multicore device (ie. c6472), each core can create the timer, but only one core will initialize the timer and take it out of reset. The core that does the initialization can be specified by the module configuration parameter timerSettings[].ownerCoreId in the *.cfg file. By default, Core 0 is the owner for all shared timers.

Note: Creating a timer with 'Timer.ANY' specified as the id will not return a shared timer on a homogeneous multicore device. To use a shared timer, specify the timer id explicitly when creating it. On these devices Timer.ANY specifies the local timer id. This allows a single image to run on multiple cores since each core will program a different local timer.

The following sample .cfg code sets core 1 to initialize a shared timer with id 4.

  var Timer = xdc.useModule('ti.sysbios.timers.timer64.Timer');

  // sets core 1 to init and release Timer 4.
  Timer.timerSettings[4].ownerCoreId = 1;

The following sample .cfg code sets core 0 to initialize a shared timer with id 4. It also configures the Clock module to use this timer. This allows multiple cores to share timer 4 for the Clock module's interrupt source.

  // sets core 0 to init and release Timer 4.
  var Timer = xdc.useModule('ti.sysbios.timers.timer64.Timer');
  Timer.timerSettings[4].ownerCoreId = 0;

  var Clock = xdc.useModule('ti.sysbios.knl.Clock');
  Clock.timerId = 4;

Calling Context

Function	Hwi	Swi	Task	Main	Startup
getNumTimers	Y	Y	Y	Y	N
getStatus	Y	Y	Y	Y	N
Params_init	Y	Y	Y	Y	N
construct	Y	Y	Y	Y	N
create	N	N	Y	Y	N
delete	N	N	Y	Y	N
destruct	Y	Y	Y	Y	N
getCount	Y	Y	Y	N	N
getFreq	Y	Y	Y	Y	N
getFunc	Y	Y	Y	Y	N
getPeriod	Y	Y	Y	Y	N
reconfig	Y	Y	Y	Y	N
setFunc	Y	Y	Y	Y	N
setPeriod	Y	Y	Y	Y	N
setPeriodMicroSecs	Y	Y	Y	Y	N
start	Y	Y	Y	N	N
stop	Y	Y	Y	N	N
Definitions: Hwi: API is callable from a Hwi thread. Swi: API is callable from a Swi thread. Task: API is callable from a Task thread. Main: API is callable during any of these phases: In your module startup after this module is started (e.g. Timer_Module_startupDone() returns TRUE). During xdc.runtime.Startup.lastFxns. During main(). During BIOS.startupFxns. Startup: API is callable during any of these phases: During xdc.runtime.Startup.firstFxns. In your module startup before this module is started (e.g. Timer_Module_startupDone() returns FALSE).

Timer Mapping Tables

The Timer module allows the user to use and configure the various timers that exist on a particular device. This is achieved by specifying a timer ID when calling ti.sysbios.hal.Timer.Timer_create. However, the timer ID specified may not always map to that timer; for example, specifying an ID value of 1 does not necessarily mean that this will map to "GPTimer1". These tables are provided to show which timers map to which timer IDs.

Timer Mapping Tables

const Timer_ANY