module ti.sysbios.family.msp430.Timer

MSP430 Timer Peripherals Manager

This module manages the timer peripherals available on MSP430 devices (see Timer Mapping Tables for supported device information). [ more ... ]
C synopsis target-domain sourced in ti/sysbios/family/msp430/Timer.xdc
#include <ti/sysbios/family/msp430/Timer.h>
Functions
Void
Void
Void
UInt 
Void
Void 
Functions common to all ITimer modules
UInt32 
Void 
UInt 
UInt32 
Void 
Void 
Bool 
Void 
Void 
Functions common to all target instances
Functions common to all target modules
Defines
#define
#define
Typedefs
typedef struct
typedef Void 
typedef Timer_Object *
typedef enum
typedef enum
typedef struct
typedef struct
typedef enum
typedef enum
typedef enum
typedef enum
typedef enum
typedef struct
Constants
extern const UInt 
extern const Error_Id 
extern const Error_Id 
extern const Error_Id 
extern const Error_Id 
extern const Bool 
 
DETAILS
This module manages the timer peripherals available on MSP430 devices (see Timer Mapping Tables for supported device information).
The Timer module supports the timer in 'one shot', 'continuous', and 'dynamic' modes.
In 'one shot' mode, a timer function will "fire" (run) when the timer period expires. In 'one shot' mode this will only happen once.
In 'continuous' mode, the specified timer function will "fire" every time the period expires, throughout the lifetime of the program.
In 'dynamic' mode, the specified timer function will "fire" every time the period expires. But the period of the timer can be changed dynamically, to correspond to the next tick interrupt needed from the timer. This mode is used by the SYS/BIOS Clock module for implementing dynamic tick suppression, to reduce the number of interrupts from the timer to the minimum required for currently scheduled timeouts.
NOTE: In the current implementation on MSP430 Timers cannot be created dynamically at runtime by the application. Timers must be created statically in the application configuration.

Calling Context

Function Hwi Swi Task Main Startup
getAvailMask Y Y Y Y N
getNumTimers Y Y Y Y N
getStatus Y Y Y Y N
Params_init N N N N N
construct N N N N N
create N N N N N
delete N N N N N
destruct N N N N 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 statically creating the Timer instance. A convention is used to assign logical IDs to physical timers. ID '0' corresponds to the first Timer_A peripheral (TA0). ID '1' is assigned to the next Timer_A (TA1), until there are no more Timer_A peripherals. Then the next ID is assigned to the first Timer_B peripheral (if present), and so on. These tables are provided to show which timers map to which timer IDs.

Timer Mapping Tables
 
const Timer_ANY

Const used to specify any timer

C synopsis target-domain
#define Timer_ANY (UInt)~0
 
 
const Timer_MAX_PERIOD

Max value of Timer period for PeriodType_COUNTS

C synopsis target-domain
#define Timer_MAX_PERIOD (UInt)0x0000ffff
 
 
enum Timer_ID

Input divider (ID) bit field values

C synopsis target-domain
typedef enum Timer_ID {
    Timer_ID_1,
    // /1
    Timer_ID_2,
    // /2
    Timer_ID_4,
    // /4
    Timer_ID_8
    // /8
} Timer_ID;
 
 
enum Timer_IDEX

Input Divider Expansion (IDEX) bit field values

C synopsis target-domain
typedef enum Timer_IDEX {
    Timer_IDEX_1,
    // /1
    Timer_IDEX_2,
    // /2
    Timer_IDEX_3,
    // /3
    Timer_IDEX_4,
    // /4
    Timer_IDEX_5,
    // /5
    Timer_IDEX_6,
    // /6
    Timer_IDEX_7,
    // /7
    Timer_IDEX_8
    // /8
} Timer_IDEX;
 
 
enum Timer_PeriodType

Timer period units

C synopsis target-domain
typedef enum Timer_PeriodType {
    Timer_PeriodType_MICROSECS,
    // period in microsecs
    Timer_PeriodType_COUNTS
    // period in counts
} Timer_PeriodType;
 
VALUES
PeriodType_MICROSECS — Period value is in microseconds.
PeriodType_COUNTS — Period value is in counts.
 
enum Timer_RunMode

Timer Run Modes

C synopsis target-domain
typedef enum Timer_RunMode {
    Timer_RunMode_CONTINUOUS,
    // periodic and continuous
    Timer_RunMode_ONESHOT,
    // one-shot
    Timer_RunMode_DYNAMIC
    // dynamically reprogrammed (available on subset of devices)
} Timer_RunMode;
 
VALUES
RunMode_CONTINUOUS — Timer is periodic and runs continuously.
RunMode_ONESHOT — Timer runs for a single period value and stops.
RunMode_DYNAMIC — Timer is dynamically reprogrammed for the next required tick. This mode is intended only for use by the Clock module when it is operating in TickMode_DYNAMIC; it is not applicable for user-created Timer instances.
 
enum Timer_Source

Lists of input clock sources for timers

C synopsis target-domain
typedef enum Timer_Source {
    Timer_Source_ACLK,
    // ACLK
    Timer_Source_SMCLK,
    // SMCLK
    Timer_Source_EXTERNAL,
    // External clock
    Timer_Source_EXTERNAL_INVERTED
    // Inverted external clock
} Timer_Source;
 
 
enum Timer_StartMode

Timer Start Modes

C synopsis target-domain
typedef enum Timer_StartMode {
    Timer_StartMode_AUTO,
    // timer starts automatically
    Timer_StartMode_USER
    // timer will be started by user
} Timer_StartMode;
 
VALUES
StartMode_AUTO — Statically created/constructed Timers will be started in BIOS_start(). Dynamically created Timers will start at create() time. This includes timers created before BIOS_start().
StartMode_USER — Timer will be started by the user using start().
 
enum Timer_Status

Timer Status

C synopsis target-domain
typedef enum Timer_Status {
    Timer_Status_INUSE,
    // timer in use
    Timer_Status_FREE
    // timer is free
} Timer_Status;
 
VALUES
Status_INUSE — Timer is in use. A timer is marked in use from the time it gets created to the time it gets deleted.
Status_FREE — Timer is free and can be acquired using create.
 
typedef Timer_FuncPtr

Timer tick function prototype

C synopsis target-domain
typedef Void (*Timer_FuncPtr)(UArg);
 
 
struct Timer_Control

Timer Configuration struct

C synopsis target-domain
typedef struct Timer_Control {
    UInt source;
    // 0x100=ACLK, 0x200=SMCLK, 0=EXT, 0x300=EXT_INVERT
} Timer_Control;
 
FIELDS
source — Timer clock source.
 
config Timer_E_cannotSupport  // module-wide

Error raised when requested period is not supported

C synopsis target-domain
extern const Error_Id Timer_E_cannotSupport;
 
 
config Timer_E_invalidTimer  // module-wide

Error raised when specified timer id is not supported

C synopsis target-domain
extern const Error_Id Timer_E_invalidTimer;
 
 
config Timer_E_notAvailable  // module-wide

Error raised when requested timer is in use

C synopsis target-domain
extern const Error_Id Timer_E_notAvailable;
 
 
config Timer_E_runtimeCreate  // module-wide

Error raised when dynamic Timer create is attempted

C synopsis target-domain
extern const Error_Id Timer_E_runtimeCreate;
 
 
config Timer_anyMask  // module-wide

Mask of available timers

C synopsis target-domain
extern const UInt Timer_anyMask;
 
DETAILS
This mask is used to identify the timers that can be used when Timer_create() is called with an id equal to Timer_ANY.
 
config Timer_keepAwake  // module-wide

Wakeup (enable) CPU when Timer ISR returns

C synopsis target-domain
extern const Bool Timer_keepAwake;
 
DETAILS
If set to true, all Timer instances keep the CPU awake upon return from interrupt.
 
Timer_getAvailMask()  // module-wide

Returns the availMask

C synopsis target-domain
UInt Timer_getAvailMask();
 
RETURNS
Mask of available timers
 
Timer_getNumTimers()  // module-wide

Returns number of timer peripherals on the platform

C synopsis target-domain
UInt Timer_getNumTimers();
 
RETURNS
Number of timer peripherals.
 
Timer_getStatus()  // module-wide

Returns timer status (free or in use)

C synopsis target-domain
ITimer_Status Timer_getStatus(UInt id);
 
RETURNS
timer status
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId Timer_Module_id();
// Get this module's unique id
 
Bool Timer_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle Timer_Module_heap();
// The heap from which this module allocates memory
 
Bool Timer_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 Timer_Module_getMask();
// Returns the diagnostics mask for this module
 
Void Timer_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types

C synopsis target-domain
typedef struct Timer_Object Timer_Object;
// Opaque internal representation of an instance object
 
typedef Timer_Object *Timer_Handle;
// Client reference to an instance object
 
typedef struct Timer_Struct Timer_Struct;
// Opaque client structure large enough to hold an instance object
 
Timer_Handle Timer_handle(Timer_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
Timer_Struct *Timer_struct(Timer_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters

C synopsis target-domain
typedef struct Timer_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
    UArg arg;
    // Argument for tick function
    Timer_Source clockSource;
    // Clock source input select. Default is ACLK
    UInt controlRegInit;
    // Control register configuration. Default source = ACLK
    Types_FreqHz extFreq;
    // Timer frequency
    Hwi_Params *hwiParams;
    // Hwi Params for Hwi Object. Default is null
    Timer_ID inputDivider;
    // Clock Input Divider (ID) select. Default is /1
    Timer_IDEX inputDividerExp;
    // Clock Input Divider Expansion (IDEX) select. Default is /1
    Bool nesting;
    // Enable nesting of other interrupts on top of this Timer's ISR?
    UInt32 period;
    // Period of a tick
    ITimer_PeriodType periodType;
    // Period type
    UInt prevThreshold;
    // Previous threshold count value
    ITimer_RunMode runMode;
    // Timer run mode
    ITimer_StartMode startMode;
    // Timer start mode
    Bool synchronous;
    // Selected clock source is synchronous to CPU clock? Default is false
} Timer_Params;
 
Void Timer_Params_init(Timer_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
 
config Timer_Params.arg  // instance

Argument for tick function

C synopsis target-domain
struct Timer_Params {
      ...
    UArg arg;
 
DETAILS
Default is null.
 
config Timer_Params.clockSource  // instance

Clock source input select. Default is ACLK

C synopsis target-domain
struct Timer_Params {
      ...
    Timer_Source clockSource;
 
 
config Timer_Params.controlRegInit  // instance

Control register configuration. Default source = ACLK

C synopsis target-domain
struct Timer_Params {
      ...
    UInt controlRegInit;
 
 
config Timer_Params.extFreq  // instance

Timer frequency

C synopsis target-domain
struct Timer_Params {
      ...
    Types_FreqHz extFreq;
 
DETAILS
This parameter is meaningfull only on platforms where the timer's input clock can be changed. If value is left at zero, then input clock to the timer clock is assumed.
This value is used to convert timer ticks to real time units; seconds, milliseconds, etc.
 
config Timer_Params.hwiParams  // instance

Hwi Params for Hwi Object. Default is null

C synopsis target-domain
struct Timer_Params {
      ...
    Hwi_Params *hwiParams;
 
 
config Timer_Params.inputDivider  // instance

Clock Input Divider (ID) select. Default is /1

C synopsis target-domain
struct Timer_Params {
      ...
    Timer_ID inputDivider;
 
 
config Timer_Params.inputDividerExp  // instance

Clock Input Divider Expansion (IDEX) select. Default is /1

C synopsis target-domain
struct Timer_Params {
      ...
    Timer_IDEX inputDividerExp;
 
 
config Timer_Params.nesting  // instance

Enable nesting of other interrupts on top of this Timer's ISR?

C synopsis target-domain
struct Timer_Params {
      ...
    Bool nesting;
 
 
config Timer_Params.period  // instance

Period of a tick

C synopsis target-domain
struct Timer_Params {
      ...
    UInt32 period;
 
DETAILS
The period can be specified in timer counts or microseconds and its default value is 0.
The implementation of ITimer will support a period of UInt32 timer counts and use pre-scalars if necessary.
 
config Timer_Params.periodType  // instance

Period type

C synopsis target-domain
struct Timer_Params {
      ...
    ITimer_PeriodType periodType;
 
DETAILS
Default is PeriodType_MICROSECS
 
config Timer_Params.prevThreshold  // instance

Previous threshold count value

C synopsis target-domain
struct Timer_Params {
      ...
    UInt prevThreshold;
 
 
config Timer_Params.runMode  // instance

Timer run mode

C synopsis target-domain
struct Timer_Params {
      ...
    ITimer_RunMode runMode;
 
DETAILS
Default is RunMode_CONTINUOUS.
 
config Timer_Params.startMode  // instance

Timer start mode

C synopsis target-domain
struct Timer_Params {
      ...
    ITimer_StartMode startMode;
 
DETAILS
Default is StartMode_AUTO.
 
config Timer_Params.synchronous  // instance

Selected clock source is synchronous to CPU clock? Default is false

C synopsis target-domain
struct Timer_Params {
      ...
    Bool synchronous;
 
Runtime Instance Creation

C synopsis target-domain
Timer_Handle Timer_create(Int id, ITimer_FuncPtr tickFxn, const Timer_Params *params, Error_Block *eb);
// Allocate and initialize a new instance object and return its handle
 
Void Timer_construct(Timer_Struct *structP, Int id, ITimer_FuncPtr tickFxn, const Timer_Params *params, Error_Block *eb);
// Initialize a new instance object inside the provided structure
ARGUMENTS
id — Timer id ranging from 0 to a platform specific value, or ANY
tickFxn — function that runs upon timer expiry.
params — per-instance config params, or NULL to select default values (target-domain only)
eb — active error-handling block, or NULL to select default policy (target-domain only)
DETAILS
Create could fail if timer peripheral is unavailable. To request any available timer use ANY as the id. TimerId's are logical ids. The family-specific implementations map the ids to physical peripherals.
Instance Deletion

C synopsis target-domain
Void Timer_delete(Timer_Handle *handleP);
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void Timer_destruct(Timer_Struct *structP);
// Finalize the instance object inside the provided structure
 
Timer_getCount()  // instance

Read timer counter register

C synopsis target-domain
UInt32 Timer_getCount(Timer_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created Timer instance object
RETURNS
timer counter value
 
Timer_getFreq()  // instance

Return timer frequency in Hz

C synopsis target-domain
Void Timer_getFreq(Timer_Handle handle, Types_FreqHz *freq);
 
ARGUMENTS
handle — handle of a previously-created Timer instance object
freq — frequency in Hz
DETAILS
This is the effective frequency of the clock incrementing the timer counter register after all scaling factors are taken into account. (including pre-scalars).
 
Timer_getFunc()  // instance

Get Timer function and arg

C synopsis target-domain
ITimer_FuncPtr Timer_getFunc(Timer_Handle handle, UArg *arg);
 
ARGUMENTS
handle — handle of a previously-created Timer instance object
arg — pointer for returning Timer's function argument
RETURNS
Timer's function
 
Timer_getPeriod()  // instance

Get timer period in timer counts

C synopsis target-domain
UInt32 Timer_getPeriod(Timer_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created Timer instance object
RETURNS
period in timer counts
 
Timer_reconfig()  // instance

Modify timer instances at runtime

C synopsis target-domain
Void Timer_reconfig(Timer_Handle handle, Timer_FuncPtr tickFxn, Timer_Params *timerParams, Error_Block *eb);
 
ARGUMENTS
handle — handle of a previously-created Timer instance object
timerParams — timer Params
tickFxn — function that runs when timer expires.
 
Timer_setFunc()  // instance

Overwrite Timer function and arg

C synopsis target-domain
Void Timer_setFunc(Timer_Handle handle, ITimer_FuncPtr fxn, UArg arg);
 
ARGUMENTS
handle — handle of a previously-created Timer instance object
fxn — pointer to function
arg — argument to function
DETAILS
Replaces a Timer object's tickFxn function originally provided in create.
 
Timer_setPeriod()  // instance

Set timer period specified in timer counts

C synopsis target-domain
Void Timer_setPeriod(Timer_Handle handle, UInt32 period);
 
ARGUMENTS
handle — handle of a previously-created Timer instance object
period — period in timer counts
DETAILS
Timer_setPeriod() invokes Timer_stop() prior to setting the period and leaves the timer in the stopped state.
To dynamically change the period of a timer you must protect against re-entrancy by disabling interrupts. Use the following call sequence to guarantee proper results:
  // disable interrupts if an interrupt could lead to
  // another call to Timer_start().
  key = Hwi_disable();
  Timer_setPeriod(period);
  Timer_start();
  Hwi_restore(key);
ITimer implementation must support UInt32 and use pre-scalars whenever necessary
SIDE EFFECTS
Calls Timer_stop(), and disables the timer's interrupt.
 
Timer_setPeriodMicroSecs()  // instance

Set timer period specified in microseconds

C synopsis target-domain
Bool Timer_setPeriodMicroSecs(Timer_Handle handle, UInt32 microsecs);
 
ARGUMENTS
handle — handle of a previously-created Timer instance object
period — period in microseconds
DETAILS
A best-effort method will be used to set the period register. There might be a slight rounding error based on resolution of timer period register. If the timer frequency cannot support the requested period, i.e. the timer period register cannot support the requested period, then this function returns false.
Timer_setPeriodMicroSecs() invokes Timer_stop() prior to setting the period and leaves the timer in the stopped state.
To dynamically change the period of a timer you must protect against re-entrancy by disabling interrupts. Use the following call sequence to guarantee proper results:
  // disable interrupts if an interrupt could lead to
  // another call to Timer_start().
  key = Hwi_disable();
  Timer_setPeriodMicroSecs(period);
  Timer_start();
  Hwi_restore(key);
 
Timer_start()  // instance

Reload and start the timer

C synopsis target-domain
Void Timer_start(Timer_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created Timer instance object
DETAILS
Thread safety must be observed when using the start and stop APIs to avoid possible miss- configuration of the timers and unintended behaviors. To protect against re-entrancy, surround the start/stop invocations with Hwi_disable() and Hwi_restore() calls:
  // disable interrupts if an interrupt could lead to
  // another call to Timer_start().
  key = Hwi_disable();
  Timer_stop();
  ...
  Timer_start();
  Hwi_restore(key);
SIDE EFFECTS
Enables the timer's interrupt.
 
Timer_stop()  // instance

Stop the timer

C synopsis target-domain
Void Timer_stop(Timer_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created Timer instance object
DETAILS
Thread safety must be observed when using the start and stop APIs to avoid possible miss- configuration of the timers and unintended behaviors. To protect against re-entrancy, surround the start/stop invocations with Hwi_disable() and Hwi_restore() calls:
  // disable interrupts if an interrupt could lead to
  // another call to Timer_start().
  key = Hwi_disable();
  Timer_stop();
  ...
  Timer_start();
  Hwi_restore(key);
SIDE EFFECTS
Disables the timer's interrupt.
Instance Convertors

C synopsis target-domain
ITimer_Handle Timer_Handle_upCast(Timer_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
Timer_Handle Timer_Handle_downCast(ITimer_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
Instance Built-Ins

C synopsis target-domain
Int Timer_Object_count();
// The number of statically-created instance objects
 
Timer_Handle Timer_Object_get(Timer_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
Timer_Handle Timer_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
Timer_Handle Timer_Object_next(Timer_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle Timer_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *Timer_Handle_label(Timer_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String Timer_Handle_name(Timer_Handle handle);
// The name of this instance object
 
Configuration settings sourced in ti/sysbios/family/msp430/Timer.xdc
var Timer = xdc.useModule('ti.sysbios.family.msp430.Timer');
module-wide constants & types
 
        const Timer.ID_1// /1;
        const Timer.ID_2// /2;
        const Timer.ID_4// /4;
        const Timer.ID_8// /8;
 
        const Timer.IDEX_1// /1;
        const Timer.IDEX_2// /2;
        const Timer.IDEX_3// /3;
        const Timer.IDEX_4// /4;
        const Timer.IDEX_5// /5;
        const Timer.IDEX_6// /6;
        const Timer.IDEX_7// /7;
        const Timer.IDEX_8// /8;
 
 
    values of type Timer.RunMode// Timer Run Modes
        const Timer.RunMode_ONESHOT// one-shot;
 
        const Timer.Source_ACLK// ACLK;
        const Timer.Source_SMCLK// SMCLK;
 
    values of type Timer.StartMode// Timer Start Modes
 
    values of type Timer.Status// Timer Status
        const Timer.Status_INUSE// timer in use;
        const Timer.Status_FREE// timer is free;
 
module-wide config parameters
        msg: "E_cannotSupport: Timer cannot support requested period %d"
    };
        msg: "E_invalidTimer: Invalid Timer Id %d"
    };
        msg: "E_notAvailable: Timer not available %d"
    };
        msg: "E_runtimeCreate: Runtime Timer create is not supported %d"
    };
 
per-instance config parameters
    var params = new Timer.Params// Instance config-params object;
        params.arg// Argument for tick function = UArg null;
        params.extFreq// Timer frequency = Types.FreqHz {
            lo: 0,
            hi: 0
        };
        params.period// Period of a tick = UInt32 0;
        params.prevThreshold// Previous threshold count value = UInt 0;
per-instance creation
    var inst = Timer.create// Create an instance-object(Int id, Void(*)(UArg) tickFxn, params);
 
 
const Timer.ANY

Const used to specify any timer

Configuration settings
const Timer.ANY = ~0;
 
C SYNOPSIS
 
const Timer.MAX_PERIOD

Max value of Timer period for PeriodType_COUNTS

Configuration settings
const Timer.MAX_PERIOD = 0x0000ffff;
 
C SYNOPSIS
 
enum Timer.ID

Input divider (ID) bit field values

Configuration settings
values of type Timer.ID
    const Timer.ID_1;
    // /1
    const Timer.ID_2;
    // /2
    const Timer.ID_4;
    // /4
    const Timer.ID_8;
    // /8
 
C SYNOPSIS
 
enum Timer.IDEX

Input Divider Expansion (IDEX) bit field values

Configuration settings
values of type Timer.IDEX
    const Timer.IDEX_1;
    // /1
    const Timer.IDEX_2;
    // /2
    const Timer.IDEX_3;
    // /3
    const Timer.IDEX_4;
    // /4
    const Timer.IDEX_5;
    // /5
    const Timer.IDEX_6;
    // /6
    const Timer.IDEX_7;
    // /7
    const Timer.IDEX_8;
    // /8
 
C SYNOPSIS
 
enum Timer.PeriodType

Timer period units

Configuration settings
values of type Timer.PeriodType
    const Timer.PeriodType_MICROSECS;
    // period in microsecs
    const Timer.PeriodType_COUNTS;
    // period in counts
 
VALUES
PeriodType_MICROSECS — Period value is in microseconds.
PeriodType_COUNTS — Period value is in counts.
C SYNOPSIS
 
enum Timer.RunMode

Timer Run Modes

Configuration settings
values of type Timer.RunMode
    const Timer.RunMode_CONTINUOUS;
    // periodic and continuous
    const Timer.RunMode_ONESHOT;
    // one-shot
    const Timer.RunMode_DYNAMIC;
    // dynamically reprogrammed (available on subset of devices)
 
VALUES
RunMode_CONTINUOUS — Timer is periodic and runs continuously.
RunMode_ONESHOT — Timer runs for a single period value and stops.
RunMode_DYNAMIC — Timer is dynamically reprogrammed for the next required tick. This mode is intended only for use by the Clock module when it is operating in TickMode_DYNAMIC; it is not applicable for user-created Timer instances.
C SYNOPSIS
 
enum Timer.Source

Lists of input clock sources for timers

Configuration settings
values of type Timer.Source
    const Timer.Source_ACLK;
    // ACLK
    const Timer.Source_SMCLK;
    // SMCLK
    const Timer.Source_EXTERNAL;
    // External clock
    const Timer.Source_EXTERNAL_INVERTED;
    // Inverted external clock
 
C SYNOPSIS
 
enum Timer.StartMode

Timer Start Modes

Configuration settings
values of type Timer.StartMode
    const Timer.StartMode_AUTO;
    // timer starts automatically
    const Timer.StartMode_USER;
    // timer will be started by user
 
VALUES
StartMode_AUTO — Statically created/constructed Timers will be started in BIOS_start(). Dynamically created Timers will start at create() time. This includes timers created before BIOS_start().
StartMode_USER — Timer will be started by the user using start().
C SYNOPSIS
 
enum Timer.Status

Timer Status

Configuration settings
values of type Timer.Status
    const Timer.Status_INUSE;
    // timer in use
    const Timer.Status_FREE;
    // timer is free
 
VALUES
Status_INUSE — Timer is in use. A timer is marked in use from the time it gets created to the time it gets deleted.
Status_FREE — Timer is free and can be acquired using create.
C SYNOPSIS
 
struct Timer.Control

Timer Configuration struct

Configuration settings
var obj = new Timer.Control;
 
    obj.source = UInt  ...
    // 0x100=ACLK, 0x200=SMCLK, 0=EXT, 0x300=EXT_INVERT
 
FIELDS
source — Timer clock source.
C SYNOPSIS
 
config Timer.E_cannotSupport  // module-wide

Error raised when requested period is not supported

Configuration settings
Timer.E_cannotSupport = Error.Desc {
    msg: "E_cannotSupport: Timer cannot support requested period %d"
};
 
C SYNOPSIS
 
config Timer.E_invalidTimer  // module-wide

Error raised when specified timer id is not supported

Configuration settings
Timer.E_invalidTimer = Error.Desc {
    msg: "E_invalidTimer: Invalid Timer Id %d"
};
 
C SYNOPSIS
 
config Timer.E_notAvailable  // module-wide

Error raised when requested timer is in use

Configuration settings
Timer.E_notAvailable = Error.Desc {
    msg: "E_notAvailable: Timer not available %d"
};
 
C SYNOPSIS
 
config Timer.E_runtimeCreate  // module-wide

Error raised when dynamic Timer create is attempted

Configuration settings
Timer.E_runtimeCreate = Error.Desc {
    msg: "E_runtimeCreate: Runtime Timer create is not supported %d"
};
 
C SYNOPSIS
 
config Timer.anyMask  // module-wide

Mask of available timers

Configuration settings
Timer.anyMask = UInt 0x7;
 
DETAILS
This mask is used to identify the timers that can be used when Timer_create() is called with an id equal to Timer_ANY.
C SYNOPSIS
 
config Timer.keepAwake  // module-wide

Wakeup (enable) CPU when Timer ISR returns

Configuration settings
Timer.keepAwake = Bool false;
 
DETAILS
If set to true, all Timer instances keep the CPU awake upon return from interrupt.
C SYNOPSIS
 
metaonly config Timer.common$  // module-wide

Common module configuration parameters

Configuration settings
Timer.common$ = Types.Common$ undefined;
 
DETAILS
All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.
Instance Config Parameters

Configuration settings
var params = new Timer.Params;
// Instance config-params object
    params.arg = UArg null;
    // Argument for tick function
    params.clockSource = Timer.Source Timer.Source_ACLK;
    // Clock source input select. Default is ACLK
    params.controlRegInit = UInt Timer.Source_ACLK;
    // Control register configuration. Default source = ACLK
    params.extFreq = Types.FreqHz {
    // Timer frequency
        lo: 0,
        hi: 0
    };
    params.hwiParams = Hwi.Params* null;
    // Hwi Params for Hwi Object. Default is null
    params.inputDivider = Timer.ID Timer.ID_1;
    // Clock Input Divider (ID) select. Default is /1
    params.inputDividerExp = Timer.IDEX Timer.IDEX_1;
    // Clock Input Divider Expansion (IDEX) select. Default is /1
    params.nesting = Bool false;
    // Enable nesting of other interrupts on top of this Timer's ISR?
    params.period = UInt32 0;
    // Period of a tick
    params.periodType = ITimer.PeriodType ITimer.PeriodType_MICROSECS;
    // Period type
    params.prevThreshold = UInt 0;
    // Previous threshold count value
    params.runMode = ITimer.RunMode ITimer.RunMode_CONTINUOUS;
    // Timer run mode
    params.startMode = ITimer.StartMode ITimer.StartMode_AUTO;
    // Timer start mode
    params.synchronous = Bool false;
    // Selected clock source is synchronous to CPU clock? Default is false
 
config Timer.Params.arg  // instance

Argument for tick function

Configuration settings
var params = new Timer.Params;
  ...
params.arg = UArg null;
 
DETAILS
Default is null.
C SYNOPSIS
 
config Timer.Params.clockSource  // instance

Clock source input select. Default is ACLK

Configuration settings
var params = new Timer.Params;
  ...
params.clockSource = Timer.Source Timer.Source_ACLK;
 
C SYNOPSIS
 
config Timer.Params.controlRegInit  // instance

Control register configuration. Default source = ACLK

Configuration settings
var params = new Timer.Params;
  ...
params.controlRegInit = UInt Timer.Source_ACLK;
 
C SYNOPSIS
 
config Timer.Params.extFreq  // instance

Timer frequency

Configuration settings
var params = new Timer.Params;
  ...
params.extFreq = Types.FreqHz {
    lo: 0,
    hi: 0
};
 
DETAILS
This parameter is meaningfull only on platforms where the timer's input clock can be changed. If value is left at zero, then input clock to the timer clock is assumed.
This value is used to convert timer ticks to real time units; seconds, milliseconds, etc.
C SYNOPSIS
 
config Timer.Params.hwiParams  // instance

Hwi Params for Hwi Object. Default is null

Configuration settings
var params = new Timer.Params;
  ...
params.hwiParams = Hwi.Params* null;
 
C SYNOPSIS
 
config Timer.Params.inputDivider  // instance

Clock Input Divider (ID) select. Default is /1

Configuration settings
var params = new Timer.Params;
  ...
params.inputDivider = Timer.ID Timer.ID_1;
 
C SYNOPSIS
 
config Timer.Params.inputDividerExp  // instance

Clock Input Divider Expansion (IDEX) select. Default is /1

Configuration settings
var params = new Timer.Params;
  ...
params.inputDividerExp = Timer.IDEX Timer.IDEX_1;
 
C SYNOPSIS
 
config Timer.Params.nesting  // instance

Enable nesting of other interrupts on top of this Timer's ISR?

Configuration settings
var params = new Timer.Params;
  ...
params.nesting = Bool false;
 
C SYNOPSIS
 
config Timer.Params.period  // instance

Period of a tick

Configuration settings
var params = new Timer.Params;
  ...
params.period = UInt32 0;
 
DETAILS
The period can be specified in timer counts or microseconds and its default value is 0.
The implementation of ITimer will support a period of UInt32 timer counts and use pre-scalars if necessary.
C SYNOPSIS
 
config Timer.Params.periodType  // instance

Period type

Configuration settings
var params = new Timer.Params;
  ...
 
DETAILS
Default is PeriodType_MICROSECS
C SYNOPSIS
 
config Timer.Params.prevThreshold  // instance

Previous threshold count value

Configuration settings
var params = new Timer.Params;
  ...
params.prevThreshold = UInt 0;
 
C SYNOPSIS
 
config Timer.Params.runMode  // instance

Timer run mode

Configuration settings
var params = new Timer.Params;
  ...
 
DETAILS
Default is RunMode_CONTINUOUS.
C SYNOPSIS
 
config Timer.Params.startMode  // instance

Timer start mode

Configuration settings
var params = new Timer.Params;
  ...
 
DETAILS
Default is StartMode_AUTO.
C SYNOPSIS
 
config Timer.Params.synchronous  // instance

Selected clock source is synchronous to CPU clock? Default is false

Configuration settings
var params = new Timer.Params;
  ...
params.synchronous = Bool false;
 
C SYNOPSIS
Static Instance Creation

Configuration settings
var params = new Timer.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = Timer.create(Int id, Void(*)(UArg) tickFxn, params);
// Create an instance-object
ARGUMENTS
id — Timer id ranging from 0 to a platform specific value, or ANY
tickFxn — function that runs upon timer expiry.
params — per-instance config params, or NULL to select default values (target-domain only)
eb — active error-handling block, or NULL to select default policy (target-domain only)
DETAILS
Create could fail if timer peripheral is unavailable. To request any available timer use ANY as the id. TimerId's are logical ids. The family-specific implementations map the ids to physical peripherals.
generated on Tue, 09 Oct 2018 20:57:41 GMT