RTEMS 4.7.0 On-Line Library

Rate Monotonic Manager RATE_MONOTONIC_GET_STATUS - Obtain status information on period

RTEMS Ada User's Guide

19.4.6: RATE_MONOTONIC_GET_STATUS - Obtain status information on period

CALLING SEQUENCE:

procedure Rate_Monotonic_Get_Status (
   ID      : in     RTEMS.ID;
   Status  :    out RTEMS.Rate_Monotonic_Period_Status;
   Result  :    out RTEMS.Status_Codes
);

DIRECTIVE STATUS CODES:

RTEMS.SUCCESSFUL - period initiated successfully
RTEMS.INVALID_ID - invalid rate monotonic period id
RTEMS.INVALID_ADDRESS - invalid address of status

DESCRIPTION:

This directive returns status information associated with the rate monotonic period id in the following data record:

type Rate_Monotonic_Period_Status is
   begin
      State                    : RTEMS.Rate_Monotonic_Period_States;
      Ticks_Since_Last_Period  : RTEMS.Unsigned32;
      Ticks_Executed_Since_Last_Period : RTEMS.Unsigned32;
   end record;

If the period's state is RATE_MONOTONIC_INACTIVE, both ticks_since_last_period and ticks_executed_since_last_period will be set to 0. Otherwise, ticks_since_last_period will contain the number of clock ticks which have occurred since the last invocation of the rtems.rate_monotonic_period directive. Also in this case, the ticks_executed_since_last_period will indicate how much processor time the owning task has consumed since the invocation of the rtems.rate_monotonic_period directive.

NOTES:

This directive will not cause the running task to be preempted.

RTEMS Ada User's Guide