CDX Runtime Time
Foreground time helpers; CM4 and CM7 clocks are not synchronized.
The runtime must poll at least once per 32-bit microsecond wrap (about 71 minutes) to extend time correctly. Deadline comparisons require intervals within the half-range limit. These APIs are not ISR-safe.
Contents
Functions
| Function | Description |
|---|---|
| CDX_ticks_now | Read the current wrapping microsecond tick counter. |
| CDX_microsec_32_now | Read the local microsecond counter modulo 2^32. |
| CDX_microsec_64_now | Read local microseconds with foreground-maintained wrap extension. |
| CDX_millisec_32_now | Read local milliseconds modulo 2^32. |
| CDX_millisec_32_from_ticks | Convert a recent past microsecond timestamp to local milliseconds. |
| CDX_microsec_deadline_remain | Calculate microseconds remaining to a local absolute deadline. |
| CDX_ticks_deadline_from_millisec | Form a nonzero CAN deadline relative to the current local ticks. |
Functions
CDX_ticks_now
Read the current wrapping microsecond tick counter.
1CDX_TICKS_32 CDX_ticks_now(void)Returns
Local ticks, or zero when no runtime clock is bound.
Parameters
- void
Location: cdx_time.h:56
CDX_microsec_32_now
Read the local microsecond counter modulo 2^32.
1CDX_MICROSEC_32 CDX_microsec_32_now(void)Returns
Local microseconds, or zero when no runtime clock is bound.
Parameters
- void
Location: cdx_time.h:61
CDX_microsec_64_now
Read local microseconds with foreground-maintained wrap extension.
1CDX_MICROSEC_64 CDX_microsec_64_now(void)Returns
Extended microsecond count, or zero when no runtime is bound.
Parameters
- void
Location: cdx_time.h:66
CDX_millisec_32_now
Read local milliseconds modulo 2^32.
1CDX_MILLISEC_32 CDX_millisec_32_now(void)Returns
Extended microseconds divided by 1000, truncated to 32 bits.
Parameters
- void
Location: cdx_time.h:71
CDX_millisec_32_from_ticks
Convert a recent past microsecond timestamp to local milliseconds.
1CDX_MILLISEC_32 CDX_millisec_32_from_ticks(CDX_TICKS_32 ticks)Returns
Timestamp in wrapping milliseconds, accounting for a recent tick wrap.
Parameters
- CDX_TICKS_32 ticks: Past local timestamp less than one microsecond-counter wrap old.
Location: cdx_time.h:77
CDX_microsec_deadline_remain
Calculate microseconds remaining to a local absolute deadline.
1CDX_MICROSEC_32 CDX_microsec_deadline_remain(CDX_MICROSEC_32 deadline)Returns
Remaining microseconds, or zero if due, expired or beyond half-range.
Note: This helper does not interpret zero as a disabled CAN deadline.
Parameters
- CDX_MICROSEC_32 deadline: Wrapping microsecond deadline within the half-range limit.
Location: cdx_time.h:84
CDX_ticks_deadline_from_millisec
Form a nonzero CAN deadline relative to the current local ticks.
1CDX_TICKS_32 CDX_ticks_deadline_from_millisec(CDX_MILLISEC_32 interval_ms)Returns
Absolute wrapping deadline; a computed zero is changed to one tick.
Note: Zero in CDX_CAN_TX_PARAMS means no deadline, so this result avoids zero.
Parameters
- CDX_MILLISEC_32 interval_ms: Milliseconds ahead; clamped to the half-range limit / 1000.
Location: cdx_time.h:91