RTEMS CPU Kit with SuperCore  4.10.99.0
Data Structures | Defines | Typedefs | Enumerations | Functions | Variables
rtems/rtems/timer.h File Reference
#include <rtems/score/object.h>
#include <rtems/score/watchdog.h>
#include <rtems/score/thread.h>
#include <rtems/score/chain.h>
#include <rtems/rtems/clock.h>
#include <rtems/rtems/attr.h>
#include <rtems/rtems/timer.inl>
Include dependency graph for timer.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  Timer_Control
 The following records define the control block used to manage each timer. More...
struct  Timer_server_Watchdogs
struct  Timer_server_Control
struct  rtems_timer_information
 This is the structure filled in by the timer get information service. More...

Defines

#define RTEMS_TIMER_EXTERN   extern
 Instantiate RTEMS Timer Data.
#define RTEMS_TIMER_SERVER_DEFAULT_PRIORITY   (uint32_t) -1
 This is the default value for the priority of the Timer Server.

Typedefs

typedef void rtems_timer_service_routine
 The following types define a pointer to a timer service routine.
typedef
rtems_timer_service_routine(* 
rtems_timer_service_routine_entry )(rtems_id, void *)
 This type defines the type used to manage and indirectly invoke Timer Service Routines (TSRs).
typedef struct Timer_server_Control Timer_server_Control
typedef void(* Timer_server_Schedule_operation )(Timer_server_Control *timer_server, Timer_Control *timer)
 Method used to schedule the insertion of task based timers.

Enumerations

enum  Timer_Classes {
  TIMER_INTERVAL, TIMER_INTERVAL_ON_TASK, TIMER_TIME_OF_DAY, TIMER_TIME_OF_DAY_ON_TASK,
  TIMER_DORMANT
}
 The following enumerated type details the classes to which a timer may belong. More...

Functions

void _Timer_Manager_initialization (void)
 Timer Manager Initialization.
rtems_status_code rtems_timer_create (rtems_name name, rtems_id *id)
 RTEMS Create Timer.
rtems_status_code rtems_timer_ident (rtems_name name, rtems_id *id)
 RTEMS Timer Name to Id.
rtems_status_code rtems_timer_cancel (rtems_id id)
 rtems_timer_cancel
rtems_status_code rtems_timer_delete (rtems_id id)
 RTEMS Delete Timer.
rtems_status_code rtems_timer_fire_after (rtems_id id, rtems_interval ticks, rtems_timer_service_routine_entry routine, void *user_data)
 RTEMS Timer Fire After.
rtems_status_code rtems_timer_server_fire_after (rtems_id id, rtems_interval ticks, rtems_timer_service_routine_entry routine, void *user_data)
 RTEMS Timer Server Fire After.
rtems_status_code rtems_timer_fire_when (rtems_id id, rtems_time_of_day *wall_time, rtems_timer_service_routine_entry routine, void *user_data)
 RTEMS Timer Fire When.
rtems_status_code rtems_timer_server_fire_when (rtems_id id, rtems_time_of_day *wall_time, rtems_timer_service_routine_entry routine, void *user_data)
 RTEMS Timer Server Fire When Directive.
rtems_status_code rtems_timer_reset (rtems_id id)
 RTEMS Timer Reset.
rtems_status_code rtems_timer_initiate_server (uint32_t priority, uint32_t stack_size, rtems_attribute attribute_set)
 rtems_timer_initiate_server
rtems_status_code rtems_timer_get_information (rtems_id id, rtems_timer_information *the_info)
 RTEMS Get Timer Information.

Variables

RTEMS_TIMER_EXTERN
Timer_server_Control *volatile 
_Timer_server
 Pointer to default timer server control block.
RTEMS_TIMER_EXTERN
Objects_Information 
_Timer_Information
 The following defines the information control block used to manage this class of objects.

Detailed Description


Define Documentation

#define RTEMS_TIMER_EXTERN   extern

Instantiate RTEMS Timer Data.

This constant is defined to extern most of the time when using this header file. However by defining it to nothing, the data declared in this header file can be instantiated. This is done in a single per manager file.