rtems/rtems/timer.h

Go to the documentation of this file.

/*
 * COPYRIGHT (c) 1989-2011.
 * On-Line Applications Research Corporation (OAR).
 *
 * Copyright (c) 2009 embedded brains GmbH.
 *
 * The license and distribution terms for this file may be
 * found in the file LICENSE in this distribution or at
 * http://www.rtems.com/license/LICENSE.
 */

#ifndef _RTEMS_RTEMS_TIMER_H
#define _RTEMS_RTEMS_TIMER_H

#ifndef RTEMS_TIMER_EXTERN
#define RTEMS_TIMER_EXTERN extern
#endif

#ifdef __cplusplus
extern "C" {
#endif

#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>

typedef enum {
  TIMER_INTERVAL,

  TIMER_INTERVAL_ON_TASK,

  TIMER_TIME_OF_DAY,

  TIMER_TIME_OF_DAY_ON_TASK,

  TIMER_DORMANT
} Timer_Classes;

typedef void rtems_timer_service_routine;

typedef rtems_timer_service_routine ( *rtems_timer_service_routine_entry )(
                 rtems_id,
                 void *
             );

typedef struct {
  Objects_Control  Object;
  Watchdog_Control Ticker;
  Timer_Classes    the_class;
}   Timer_Control;

typedef struct Timer_server_Control Timer_server_Control;

typedef void (*Timer_server_Schedule_operation)(
  Timer_server_Control *timer_server,
  Timer_Control        *timer
);

typedef struct {
  Watchdog_Control System_watchdog;

  Chain_Control Chain;

  Watchdog_Interval volatile last_snapshot;
} Timer_server_Watchdogs;

struct Timer_server_Control {
  Thread_Control *thread;

  Timer_server_Schedule_operation schedule_operation;

  Timer_server_Watchdogs Interval_watchdogs;

  Timer_server_Watchdogs TOD_watchdogs;

  Chain_Control *volatile insert_chain;

  bool volatile active;
};

RTEMS_TIMER_EXTERN Timer_server_Control *volatile _Timer_server;

RTEMS_TIMER_EXTERN Objects_Information  _Timer_Information;

void _Timer_Manager_initialization(void);

rtems_status_code rtems_timer_create(
  rtems_name    name,
  rtems_id     *id
);

rtems_status_code rtems_timer_ident(
  rtems_name    name,
  rtems_id     *id
);

rtems_status_code rtems_timer_cancel(
  rtems_id   id
);

rtems_status_code rtems_timer_delete(
  rtems_id   id
);

rtems_status_code rtems_timer_fire_after(
  rtems_id                           id,
  rtems_interval                     ticks,
  rtems_timer_service_routine_entry  routine,
  void                              *user_data
);

rtems_status_code rtems_timer_server_fire_after(
  rtems_id                           id,
  rtems_interval                     ticks,
  rtems_timer_service_routine_entry  routine,
  void                              *user_data
);

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_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_status_code rtems_timer_reset(
  rtems_id   id
);

rtems_status_code rtems_timer_initiate_server(
  uint32_t             priority,
  uint32_t             stack_size,
  rtems_attribute      attribute_set
);

#define RTEMS_TIMER_SERVER_DEFAULT_PRIORITY (uint32_t) -1

typedef struct {
  Timer_Classes      the_class;
  Watchdog_Interval  initial;
  Watchdog_Interval  start_time;
  Watchdog_Interval  stop_time;
} rtems_timer_information;

rtems_status_code rtems_timer_get_information(
  rtems_id                 id,
  rtems_timer_information *the_info
);

#ifndef __RTEMS_APPLICATION__
#include <rtems/rtems/timer.inl>
#endif

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */