ratemon.h File Reference

This header file defines the Rate-Monotonic Manager API. More...

#include <stdint.h>
#include <sys/_timespec.h>
#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>
#include <rtems/score/watchdogticks.h>

Go to the source code of this file.

Data Structures
struct	rtems_rate_monotonic_period_statistics
	This structure provides the statistics of a period. More...
struct	rtems_rate_monotonic_period_status
	This structure provides the detailed status of a period. More...

Macros
#define	RTEMS_PERIOD_STATUS   WATCHDOG_NO_TIMEOUT
	This constant is the interval passed to the rtems_rate_monotonic_period() directive to obtain status information.

Enumerations
enum	rtems_rate_monotonic_period_states { RATE_MONOTONIC_INACTIVE , RATE_MONOTONIC_ACTIVE , RATE_MONOTONIC_EXPIRED }
	This enumeration defines the states in which a period may be. More...

Functions
rtems_status_code	rtems_rate_monotonic_create (rtems_name name, rtems_id *id)
	Creates a period.
rtems_status_code	rtems_rate_monotonic_ident (rtems_name name, rtems_id *id)
	Identifies a period by the object name.
rtems_status_code	rtems_rate_monotonic_cancel (rtems_id id)
	Cancels the period.
rtems_status_code	rtems_rate_monotonic_delete (rtems_id id)
	Deletes the period.
rtems_status_code	rtems_rate_monotonic_period (rtems_id id, rtems_interval length)
	Concludes the current period and start the next period, or gets the period status.
rtems_status_code	rtems_rate_monotonic_get_status (rtems_id id, rtems_rate_monotonic_period_status *status)
	Gets the detailed status of the period.
rtems_status_code	rtems_rate_monotonic_get_statistics (rtems_id id, rtems_rate_monotonic_period_statistics *status)
	Gets the statistics of the period.
rtems_status_code	rtems_rate_monotonic_reset_statistics (rtems_id id)
	Resets the statistics of the period.
void	rtems_rate_monotonic_reset_all_statistics (void)
	Resets the statistics of all periods.
void	rtems_rate_monotonic_report_statistics (void)
	Reports the period statistics using the printk() printer.
void	rtems_rate_monotonic_report_statistics_with_plugin (const struct rtems_printer *printer)
	Reports the period statistics using the printer plugin.

Detailed Description

This header file defines the Rate-Monotonic Manager API.