1 files changed, 292 insertions, 0 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h
new file mode 100644
index 0000000000..f6ccb5f4a1
--- /dev/null
+++ b/cpukit/rtems/include/rtems/rtems/timer.h
@@ -0,0 +1,292 @@
+/*  timer.h
+ *
+ *  This include file contains all the constants, structures, and
+ *  prototypes associated with the Timer Manager.  This manager provides
+ *  facilities to configure, initiate, cancel, and delete timers which will
+ *  fire at specified intervals of time.
+ *
+ *  Directives provided are:
+ *
+ *     + create a timer
+ *     + get an ID of a timer
+ *     + delete a timer
+ *     + set a timer to fire after a number of ticks have passed
+ *     + set a timer to fire when a specified date and time has been reached
+ *     + reset a timer
+ *     + cancel a time
+ *
+ *  COPYRIGHT (c) 1989, 1990, 1991, 1992, 1993, 1994.
+ *  On-Line Applications Research Corporation (OAR).
+ *  All rights assigned to U.S. Government, 1994.
+ *
+ *  This material may be reproduced by or for the U.S. Government pursuant
+ *  to the copyright license under the clause at DFARS 252.227-7013.  This
+ *  notice must appear in all copies of this file and its derivatives.
+ *
+ *  $Id$
+ */
+
+#ifndef __RTEMS_TIMER_h
+#define __RTEMS_TIMER_h
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <rtems/object.h>
+#include <rtems/tod.h>
+#include <rtems/watchdog.h>
+
+/*
+ *  The following enumerated type details the classes to which a timer
+ *  may belong.
+ */
+
+typedef enum {
+  TIMER_INTERVAL,
+  TIMER_TIME_OF_DAY,
+  TIMER_DORMANT
+} Timer_Classes;
+
+/*
+ *  The following defines the type of a Timer Service Routine.
+ */
+
+typedef rtems_timer_service_routine_entry Timer_Service;
+
+/*
+ *  The following defines the information control block used to manage
+ *  this class of objects.
+ */
+
+EXTERN Objects_Information  _Timer_Information;
+
+/*
+ *  The following records define the control block used to manage
+ *  each timer.
+ */
+
+typedef struct {
+  Objects_Control  Object;
+  Watchdog_Control Ticker;
+  Timer_Classes    the_class;
+}   Timer_Control;
+
+/*
+ *  _Timer_Manager_initialization
+ *
+ *  DESCRIPTION:
+ *
+ *  This routine performs the initialization necessary for this manager.
+ */
+
+void _Timer_Manager_initialization(
+  unsigned32 maximum_timers
+);
+
+/*
+ *  rtems_timer_create
+ *
+ *  DESCRIPTION:
+ *
+ *  This routine implements the rtems_timer_create directive.  The
+ *  timer will have the name name.  It returns the id of the
+ *  created timer in ID.
+ */
+
+rtems_status_code rtems_timer_create(
+  Objects_Name  name,
+  Objects_Id   *id
+);
+
+/*
+ *  rtems_timer_ident
+ *
+ *  DESCRIPTION:
+ *
+ *  This routine implements the rtems_timer_ident directive.
+ *  This directive returns the timer ID associated with name.
+ *  If more than one timer is named name, then the timer
+ *  to which the ID belongs is arbitrary.
+ */
+
+rtems_status_code rtems_timer_ident(
+  Objects_Name  name,
+  Objects_Id   *id
+);
+
+/*
+ *  rtems_timer_cancel
+ *
+ *  DESCRIPTION:
+ *
+ *  This routine implements the rtems_timer_cancel directive.  It is used
+ *  to stop the timer associated with ID from firing.
+ */
+
+rtems_status_code rtems_timer_cancel(
+  Objects_Id id
+);
+
+/*
+ *  rtems_timer_delete
+ *
+ *  DESCRIPTION:
+ *
+ *  This routine implements the rtems_timer_delete directive.  The
+ *  timer indicated by ID is deleted.
+ */
+
+rtems_status_code rtems_timer_delete(
+  Objects_Id id
+);
+
+/*
+ *  rtems_timer_fire_after
+ *
+ *  DESCRIPTION:
+ *
+ *  This routine implements the rtems_timer_fire_after directive.  It
+ *  initiates the timer associated with ID to fire in ticks clock
+ *  ticks.  When the timer fires, the routine will be invoked.
+ */
+
+rtems_status_code rtems_timer_fire_after(
+  Objects_Id         id,
+  rtems_interval  ticks,
+  Timer_Service      routine,
+  void              *user_data
+);
+
+/*
+ *  rtems_timer_fire_when
+ *
+ *  DESCRIPTION:
+ *
+ *  This routine implements the rtems_timer_fire_when directive.  It
+ *  initiates the timer associated with ID to fire at wall_time
+ *  When the timer fires, the routine will be invoked.
+ */
+
+rtems_status_code rtems_timer_fire_when(
+  Objects_Id         id,
+  rtems_time_of_day       *wall_time,
+  Timer_Service      routine,
+  void              *user_data
+);
+
+/*
+ *  rtems_timer_reset
+ *
+ *  DESCRIPTION:
+ *
+ *  This routine implements the rtems_timer_reset directive.  It is used
+ *  to reinitialize the interval timer associated with ID just as if
+ *  rtems_timer_fire_after were re-invoked with the same arguments that
+ *  were used to initiate this timer.
+ */
+
+rtems_status_code rtems_timer_reset(
+  Objects_Id id
+);
+
+/*
+ *  _Timer_Allocate
+ *
+ *  DESCRIPTION:
+ *
+ *  This function allocates a timer control block from
+ *  the inactive chain of free timer control blocks.
+ */
+
+STATIC INLINE Timer_Control *_Timer_Allocate( void );
+
+/*
+ *  _Timer_Free
+ *
+ *  DESCRIPTION:
+ *
+ *  This routine frees a timer control block to the
+ *  inactive chain of free timer control blocks.
+ */
+
+STATIC INLINE void _Timer_Free (
+  Timer_Control *the_timer
+);
+
+/*
+ *  _Timer_Get
+ *
+ *  DESCRIPTION:
+ *
+ *  This function maps timer IDs to timer control blocks.
+ *  If ID corresponds to a local timer, then it returns
+ *  the timer control pointer which maps to ID and location
+ *  is set to OBJECTS_LOCAL.  Otherwise, location is set
+ *  to OBJECTS_ERROR and the returned value is undefined.
+ */
+
+STATIC INLINE Timer_Control *_Timer_Get (
+  Objects_Id         id,
+  Objects_Locations *location
+);
+
+/*
+ *  _Timer_Is_interval_class
+ *
+ *  DESCRIPTION:
+ *
+ *  This function returns TRUE if the class is that of an INTERVAL
+ *  timer, and FALSE otherwise.
+ */
+
+STATIC INLINE boolean _Timer_Is_interval_class (
+  Timer_Classes the_class
+);
+
+/*
+ *  _Timer_Is_time_of_day_class
+ *
+ *  DESCRIPTION:
+ *
+ *  This function returns TRUE if the class is that of an INTERVAL
+ *  timer, and FALSE otherwise.
+ */
+
+STATIC INLINE boolean _Timer_Is_timer_of_day_class (
+  Timer_Classes the_class
+);
+
+/*
+ *  _Timer_Is_dormant_class
+ *
+ *  DESCRIPTION:
+ *
+ *  This function returns TRUE if the class is that of a DORMANT
+ *  timer, and FALSE otherwise.
+ */
+
+STATIC INLINE boolean _Timer_Is_dormant_class (
+  Timer_Classes the_class
+);
+
+/*
+ *  _Timer_Is_null
+ *
+ *  DESCRIPTION:
+ *
+ *  This function returns TRUE if the_timer is NULL and FALSE otherwise.
+ */
+
+STATIC INLINE boolean _Timer_Is_null (
+  Timer_Control *the_timer
+);
+
+#include <rtems/timer.inl>
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
+/* end of include file */