RTEMS 4.8.0 On-Line Library

Rate Monotonic Manager RATE_MONOTONIC_GET_STATUS - Obtain status from a period

RTEMS C User's Guide

19.4.6: RATE_MONOTONIC_GET_STATUS - Obtain status from a period

CALLING SEQUENCE:

rtems_status_code rtems_rate_monotonic_get_status(
  rtems_id                            id,
  rtems_rate_monotonic_period_status *status
);

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 structure:

typedef struct {
  rtems_id                            owner;
  rtems_rate_monotonic_period_states  state;
  #ifdef RTEMS_ENABLE_NANOSECOND_RATE_MONOTONIC_STATISTICS
    struct timespec                   since_last_period;
  #else
    uint32_t                          ticks_since_last_period;
  #endif
  #ifdef RTEMS_ENABLE_NANOSECOND_CPU_USAGE_STATISTICS
    struct timespec                   executed_since_last_period;
  #else
    uint32_t                          ticks_executed_since_last_period;
  #endif
}  rtems_rate_monotonic_period_status;

A configure time option can be used to select whether the time information is given in ticks or seconds and nanoseconds. The default is seconds and nanoseconds. If the period's state is RATE_MONOTONIC_INACTIVE, both time values will be set to 0. Otherwise, both time values will contain time information since the last invocation of the rtems_rate_monotonic_period directive. More specifically, the (ticks_)since_last_period value contains the elapsed time which has occurred since the last invocation of the rtems_rate_monotonic_period directive and the (ticks_)executed_since_last_period contains 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 C User's Guide