WUT_tmr.h File Reference

WakeUp Timer, WUT timer entry definition. More...

#include <PBS/Q_pubdefs.h>
#include <PBS/WUT_cb.h>
#include <PBS/WUT.h>
#include <PBS/TOV.h>

Classes
struct	_WUT_tmr
	WakeUp Timer Entry. More...
Typedefs
typedef struct _WUT_tmr	WUT_tmr
	Typedef to struct _WUT_tmr.

---

Detailed Description

WakeUp Timer, WUT timer entry definition.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: WUT_tmr.h,v 1.3 2011/03/24 23:05:44 apw Exp $

SYNOPSIS

This defines the structure of a WUT timer entry. Only rarely should a user need to include this file, if, for example, the user wishes to declare an instance of a WUT timer entry. In general, it is better to allocate an instence using WUT_create(). This is more modular, hiding the implementation of a WUT timer entry.

---

Typedef Documentation

WUT_tmr

Typedef to struct _WUT_tmr.

Defines a WakeUp Timer Entry. WakeUp Timer Entry contain the context necessary to que and service a timer interrupt. They are place on the timer queue by WUT_start and WUT_restart. They are removed by the timer ISR, WUT_sys_handler, or by WUT_cancel.

Note that the state information must be marked volatile. It is the one piece of user accessible information that can spontaneously be altered by a different thread of execution.

Warning:

User's outside of PBS should treat this structure definition like C++ private data. It is here only to allow the user to declare a WUT timer entry. The user should only manipulate the members of this data structure through the approved interface routines.

The FPA routines guarantee that they will use no more than 2 4-byte words. Therefore it is safe to place the FPA managment links at the end of the packet. This storage is used only when the packet is on the FPA freelist. The only location that is to be avoided is the state field.