MSOP_TICK_2(D2psm)

MSOP_TICK_2 -- enable or disable second heartbeat clock tick interrupt

Synopsis

   void pfxtick_2(ms_time_t tick_period)

Description

MSOP_TICK_2 enables or disables the second heartbeat clock tick interrupt. The second heartbeat clock is useful for statistical profiling and other applications where it is important to avoid artifacts from code sequences correlated to heartbeat processing.

A non-zero argument specifies the tick period for secondary tick events. If the actual or emulated clock 2 is not already running, it should be started after MSOP_TICK_2 is called. The PSM must then post MS_EVENT_TICK_2 events by calling os_post_events(D3psm) once per tick on every CPU, with the specified period.

When MSOP_TICK_2 is called with a zero argument, clock 2 ticks are disabled. Once MSOP_TICK_2 returns, MS_EVENT_TICK_2 events should not be posted on any CPU. The PSM should start again in this state, until the first call to MSOP_TICK_2 with a non-zero argument.

MSOP_TICK_2 affects all CPUs, not just the one on which it is called.

If the hardware supports it, delivery of the ticks should be staggered so that CPUs do not all run their tick handlers at the same time. If the hardware supports it, clock 2 ticks should be delivered independently of clock 1 ticks.

Arguments

tick_period: the tick period of clock 2

Return values

None.

Usage

Hardware applicability

All.

Version applicability

psm: 2

References

os_post_events(D3psm)