---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > IPBS / V0-0-1

Constituent: pbs     Tag: i845e

---

         

---

PBS.h.vx-xxx-xxx File Reference

PBS library, VXWORKS platform interface/macro implementation for PBS. More...

#include <taskLib.h>
#include <intLib.h>
#include "BootDiagnostics.h"

Include dependency graph for PBS.h.vx-xxx-xxx:

Defines
#define	PBS_TID()   intContext () ? 0 : taskIdSelf ()
	Returns the id of the current task.
#define	PBS_LOCK()   intLock ()
	On this supported platform, locks the interrupts up.
Typedefs
typedef enum _PBS_crashType	PBS_crashType
	Typedef for enum.
Enumerations
enum	_PBS_crashType {   PBS_CRASH_TYPE_VXWORKS = BOOT_START_VXW,   PBS_CRASH_TYPE_COLD = BOOT_START_COLD,   PBS_CRASH_TYPE_WATCHDOG = BOOT_START_WDOG,   PBS_CRASH_TYPE_PANIC = BOOT_START_PANIC,   PBS_CRASH_TYPE_EXCEPTION = BOOT_START_EXCEPTION,   PBS_CRASH_TYPE_COMMAND = BOOT_START_COMMAND }
	Enumerates all the reasons the system may be crashed. More...

---

Detailed Description

PBS library, VXWORKS platform interface/macro implementation for PBS.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: PBS.h.vx-xxx-xxx,v 1.1.1.1 2006/02/10 21:45:37 saxton Exp $

---

Define Documentation

#define PBS_LOCK (   )     intLock ()

On this supported platform, locks the interrupts up. Returns: A key used to unlock the interrupts This macro is meant to be used to stop activity prior to calling PBS_crash. PBS_lock is the first thing that PBS_crash does, so the user should call PBS_lock if and only if he feels that waiting till PBS_crash is called could cause problems. Warning: PBS_LOCK() is not meant to provide anything resembling locking interrupts on unsupported platforms. It is there simple as portability aid. No non-PPC code should depend on these routines to function correctly. The astute reader will notice that there is no PBS_UNLOCK. Since this functionality is only used when calling PBS_crash(), there is no need to for a PBS_UNLOCK().

#define PBS_TID (   )     intContext () ? 0 : taskIdSelf ()

Returns the id of the current task. Returns: ID of the current task, or 0 if at interrupt level This macro is meant to be used to fill the TID field of PBS_crashCtx.

---

Typedef Documentation

PBS_crashType

Typedef for enum. See also: _PBS_crashType The following codes are provide for compatibility reasons only PBS_CRASH_TYPE_COLD PBS_CRASH_TYPE_WATCHDOG PBS_CRASH_TYPE_EXCEPTION, if we are ambitious, could make this work The following codes are interesting in a MVxxxx environment PBS_CRASH_TYPE_VXWORKS, internally generated by VxWorks PBS_CRASH_TYPE_PANIC, generally from BUG_check PBS_CRACH_TYPE_COMMAND, generally by command request

---

Enumeration Type Documentation

enum _PBS_crashType

Enumerates all the reasons the system may be crashed. Enumerator: PBS_CRASH_TYPE_VXWORKS  Boot VxWorks start type, issued internally by VXWORKS, provided for reference, compatiability and testing reasons only PBS_CRASH_TYPE_COLD  Boot cold start boot type, being start by a cold reset provided for reference, compatiability and testing reasons only PBS_CRASH_TYPE_WATCHDOG  Boot watchdog start boot type, being started by a watchdog reset provided for reference, compatiability and testing reasons only PBS_CRASH_TYPE_PANIC  Boot panic start boot type, typically a software inconsistancy, generally issued as a result of a call to BUG_check PBS_CRASH_TYPE_EXCEPTION  Boot exception start boot type, being started as the result of an exception handler, provided for reference, compatiability and testing reasons only PBS_CRASH_TYPE_COMMAND  Boot commanded start boot type, being started as the result of an issued command

---