const TimerNull_ANY |
|
Const used to specify any timer
#define TimerNull_ANY (UInt)~0
enum TimerNull_PeriodType |
|
Timer period units
typedef enum TimerNull_PeriodType {
TimerNull_PeriodType_MICROSECS,
// period in microsecs
TimerNull_PeriodType_COUNTS
// period in counts
} TimerNull_PeriodType;
VALUES
PeriodType_MICROSECS
Period value is in microseconds.
PeriodType_COUNTS
Period value is in counts.
enum TimerNull_RunMode |
|
Timer Run Modes
typedef enum TimerNull_RunMode {
TimerNull_RunMode_CONTINUOUS,
// periodic and continuous
TimerNull_RunMode_ONESHOT,
// one-shot
TimerNull_RunMode_DYNAMIC
// dynamically reprogrammed (available on subset of devices)
} TimerNull_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.
enum TimerNull_StartMode |
|
Timer Start Modes
typedef enum TimerNull_StartMode {
TimerNull_StartMode_AUTO,
// timer starts automatically
TimerNull_StartMode_USER
// timer will be started by user
} TimerNull_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 TimerNull_Status |
|
Timer Status
typedef enum TimerNull_Status {
TimerNull_Status_INUSE,
// timer in use
TimerNull_Status_FREE
// timer is free
} TimerNull_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 TimerNull_FuncPtr |
|
Timer tick function prototype
typedef Void (*TimerNull_FuncPtr)(UArg);
TimerNull_getNumTimers() // module-wide |
|
Returns number of timer peripherals on the platform
UInt TimerNull_getNumTimers();
RETURNS
Number of timer peripherals.
TimerNull_getStatus() // module-wide |
|
Returns timer status (free or in use)
RETURNS
timer status
Module-Wide Built-Ins |
|
// Get this module's unique id
Bool TimerNull_Module_startupDone();
// Test if this module has completed startup
// The heap from which this module allocates memory
Bool TimerNull_Module_hasMask();
// Test whether this module has a diagnostics mask
Bits16 TimerNull_Module_getMask();
// Returns the diagnostics mask for this module
Void TimerNull_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types |
|
typedef struct TimerNull_Object TimerNull_Object;
// Opaque internal representation of an instance object
// Client reference to an instance object
typedef struct TimerNull_Struct TimerNull_Struct;
// Opaque client structure large enough to hold an instance object
// Convert this instance structure pointer into an instance handle
// Convert this instance handle into an instance structure pointer
Instance Config Parameters |
|
typedef struct TimerNull_Params {
// Instance config-params structure
// Common per-instance configs
UArg arg;
// Argument for tick function
// Timer frequency
UInt32 period;
// Period of a tick
// Period type
// Timer run mode
// Timer start mode
} TimerNull_Params;
// Initialize this config-params structure with supplier-specified defaults before instance creation
config TimerNull_arg // instance |
|
Argument for tick function
DETAILS
Default is null.
config TimerNull_extFreq // instance |
|
Timer frequency
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 TimerNull_period // instance |
|
Period of a tick
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 TimerNull_periodType // instance |
|
Period type
DETAILS
Default is PeriodType_MICROSECS
config TimerNull_runMode // instance |
|
Timer run mode
DETAILS
config TimerNull_startMode // instance |
|
Timer start mode
DETAILS
Instance Creation |
|
// Allocate and initialize a new instance object and return its handle
// 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 |
|
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
// Finalize the instance object inside the provided structure
TimerNull_getCount() // instance |
|
Read timer counter register
ARGUMENTS
handle
handle of a previously-created TimerNull instance object
RETURNS
timer counter value
TimerNull_getFreq() // instance |
|
Return timer frequency in Hz
ARGUMENTS
handle
handle of a previously-created TimerNull 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).
TimerNull_getFunc() // instance |
|
Get Timer function and arg
ARGUMENTS
handle
handle of a previously-created TimerNull instance object
arg
pointer for returning Timer's function argument
RETURNS
Timer's function
TimerNull_getPeriod() // instance |
|
Get timer period in timer counts
ARGUMENTS
handle
handle of a previously-created TimerNull instance object
RETURNS
period in timer counts
TimerNull_setFunc() // instance |
|
Overwrite Timer function and arg
ARGUMENTS
handle
handle of a previously-created TimerNull instance object
fxn
pointer to function
arg
argument to function
DETAILS
Replaces a Timer object's tickFxn function originally
provided in
create.
TimerNull_setPeriod() // instance |
|
Set timer period specified in timer counts
ARGUMENTS
handle
handle of a previously-created TimerNull 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.
TimerNull_setPeriodMicroSecs() // instance |
|
Set timer period specified in microseconds
ARGUMENTS
handle
handle of a previously-created TimerNull 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);
TimerNull_start() // instance |
|
Reload and start the timer
ARGUMENTS
handle
handle of a previously-created TimerNull 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.
TimerNull_stop() // instance |
|
Stop the timer
ARGUMENTS
handle
handle of a previously-created TimerNull 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 |
|
// unconditionally move one level up the inheritance hierarchy
// conditionally move one level down the inheritance hierarchy; NULL upon failure
Instance Built-Ins |
|
Int TimerNull_Object_count();
// The number of statically-created instance objects
// The handle of the i-th statically-created instance object (array == NULL)
// The handle of the first dynamically-created instance object, or NULL
// The handle of the next dynamically-created instance object, or NULL
// The heap used to allocate dynamically-created instance objects
// The label associated with this instance object
// The name of this instance object
const TimerNull.ANY |
|
Const used to specify any timer
const TimerNull.ANY = ~0;
C SYNOPSIS
enum TimerNull.PeriodType |
|
Timer period units
values of type TimerNull.PeriodType
const TimerNull.PeriodType_MICROSECS;
// period in microsecs
const TimerNull.PeriodType_COUNTS;
// period in counts
VALUES
PeriodType_MICROSECS
Period value is in microseconds.
PeriodType_COUNTS
Period value is in counts.
C SYNOPSIS
enum TimerNull.RunMode |
|
Timer Run Modes
values of type TimerNull.RunMode
const TimerNull.RunMode_CONTINUOUS;
// periodic and continuous
const TimerNull.RunMode_ONESHOT;
// one-shot
const TimerNull.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.
C SYNOPSIS
enum TimerNull.StartMode |
|
Timer Start Modes
values of type TimerNull.StartMode
const TimerNull.StartMode_AUTO;
// timer starts automatically
const TimerNull.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 TimerNull.Status |
|
Timer Status
values of type TimerNull.Status
const TimerNull.Status_INUSE;
// timer in use
const TimerNull.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
metaonly config TimerNull.common$ // module-wide |
|
Common module configuration parameters
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 |
|
var params = new TimerNull.Params;
// Instance config-params object
params.arg = UArg null;
// Argument for tick function
// Timer frequency
lo: 0,
hi: 0
};
params.period = UInt32 0;
// Period of a tick
// Period type
// Timer run mode
// Timer start mode
config TimerNull.arg // instance |
|
Argument for tick function
var params = new TimerNull.Params;
...
params.arg = UArg null;
DETAILS
Default is null.
C SYNOPSIS
config TimerNull.extFreq // instance |
|
Timer frequency
var params = new TimerNull.Params;
...
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 TimerNull.period // instance |
|
Period of a tick
var params = new TimerNull.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 TimerNull.periodType // instance |
|
Period type
var params = new TimerNull.Params;
...
DETAILS
Default is PeriodType_MICROSECS
C SYNOPSIS
config TimerNull.runMode // instance |
|
Timer run mode
var params = new TimerNull.Params;
...
DETAILS
C SYNOPSIS
config TimerNull.startMode // instance |
|
Timer start mode
var params = new TimerNull.Params;
...
DETAILS
C SYNOPSIS
Instance Creation |
|
var params =
new TimerNull.
Params;
// Allocate instance config-params
params.config = ...
// Assign individual configs
var inst = TimerNull.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.