IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


RTX_ID RTX_NewFineTimerCB ( const char *  tag,
RTX_TIMER_CALLBACK  proc,
long  period,
unsigned long  lParam 
)

A specified procedure proc will called based on a timer. The timer callback procedure executes in User mode unless the program's main() procedure's mode was designated for Supervisor mode execution.

The timer resolution is Real-Time Interrupt ticks, which can optionally be set for rates higher than the system's default 1000 Hz.

This API is the same as RTX_NewTimerCB() except for that the period parameter is in units of RTI ticks instead of strictly milliseconds, thereby offering the possiblity of finer timer resolution when the system has been configured for higher RTI rates.

Refer to the RTX_NewTimerCB() API documentation for more details about timer callbacks.

Parameters:
tag Up to 4 character name to give timer. Nil terminator is optional.
proc Vector to timer procedure.
period Timer period in RTI ticks. This value must be non-negative or this API will fail with error code zero.
lParam Optional 32 bit parameter to pass to timer callback procedure proc.
Returns:
Timer ID (handle) on success, else zero on failure.
See also:
RTX_NewTimerCB()     RTX_Remove_Timer()
Compatibility:
This API is not compatible with the SC1x, SC2x and SC1x3 C-library. The legacy function RTX_Fine_Timer() may be used when cross system source compatibility is required.
Since:
SC2x3 V1.00 - CLIB V1.00





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:37 2017 by Doxygen 1.6.1