TAU.h.vx-ppc750-xxx File Reference

Thermal Assist Unit, interface. More...

Typedefs
typedef void(	TAU_checkHandler )(void *ctx, TAU_reg t1, TAU_reg t2)
	Callback signature for the TAU thermal check handler.
Functions
int	TAU_initialize (int sitv)
	Initializes the TAU facility.
int	TAU_shutdown (void)
	Restores the original VxWorks routine.
TAU_isr *	TAU_connect (TAU_isr *isr)
	Connects the specified routine as the TAU interrupt handler.
int	TAU_restore (TAU_isr *isr)
	Restores the specified interrupt service routine as the current thermal exception handler.
int	TAU_read (void)
	Issues a synchronous read request.
int	TAU_aread (TAU_request *request)
	Perform an asynchronous read. This call should be matched with a TAU_await ().
int	TAU_qread (TAU_request *request)
	Ques a read of the temperature.
int	TAU_sread (TAU_request *request)
	Issues a synchronous read request.
int	TAU_await (TAU_request *request)
	Waits for the completion of the read request.

---

Detailed Description

Thermal Assist Unit, interface.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: TAU.h.vx-ppc750-xxx,v 1.1 2004/03/05 22:26:06 russell Exp $

SYNOPSIS

This defines the callable interface to the TAU routines. These provide a C interface the TAU registers and functionality.

See also the inlined versions of these routines in TAU.ih.

---

Function Documentation

int TAU_aread

(

TAU_request *

request

)

Perform an asynchronous read. This call should be matched with a TAU_await ().

Returns:

Status of the que operation, if 0, successfully queued

Parameters:

request

An un-initialized request structure

References adone(), _TAU_request::completion, _TAU_request::prm, _TAU_ctx::rd, _TAU_rdCtx::synch, and TAU_qread().

int TAU_await

(

TAU_request *

request

)

Waits for the completion of the read request.

Returns:

Status

Parameters:

request

The request being waited on

References _TAU_request::prm.

void TAU_connect

(

TAU_isr *

isr

)

Connects the specified routine as the TAU interrupt handler.

Returns:

The current interrupt service routine. The user should restore this routine when finished. NULL is returned on failure.

Parameters:

isr

The interrupt service routine to connect

Referenced by acquire().

void TAU_initialize

(

int

sitv

)

Initializes the TAU facility.

This is a one-time only initialization call. When finished with the facility, call TAU_shutdown ().

References _TAU_rdCtx::count, L__init(), _TAU_rdCtx::last, _TAU_rdCtx::mtx, MTX__create(), _TAU_ctx::org, _TAU_ctx::rd, _TAU_rdCtx::requests, save(), _TAU_rdCtx::sequence, _TAU_rdCtx::sitv, _TAU_rdCtx::synch, and TAU_K_INITIAL_GUESS.

Referenced by PBS_initialize2().

int TAU_qread

(

TAU_request *

request

)

Ques a read of the temperature.

Returns:

Status, indicating the success or failure of queing the read

Parameters:

request

A previously initialized read request. One should use the macro TAU_REQUEST_INIT to initialize this structure.

This routine calls back the completion routine buried in the request structure when the read is complete.

References acquire(), L__insert(), _TAU_request::node, _TAU_ctx::rd, and _TAU_rdCtx::requests.

Referenced by TAU_aread().

int TAU_read

(

void

)

Issues a synchronous read request.

Returns:

If > 0, the temperature, else, error

References TAU_sread(), and _TAU_request::temperature.

int TAU_restore

(

TAU_isr *

prvIsr

)

Restores the specified interrupt service routine as the current thermal exception handler.

Returns:

Status

prvIsr The interrupt service routine to restore

Referenced by restore().

void TAU_shutdown

(

void

)

Restores the original VxWorks routine.

This routine restores the original interrupt service handler

References L__destroy(), _TAU_rdCtx::mtx, MTX__destroy(), _TAU_ctx::org, _TAU_ctx::rd, _TAU_rdCtx::requests, restore(), and _TAU_rdCtx::synch.

Referenced by PBS_shutdown().

int TAU_sread

(

TAU_request *

request

)

Issues a synchronous read request.

Returns:

Status

Referenced by TAU_read().