---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > VXW / V7-1-1

Constituent: vxw_flight     Tag: rad750

---

         

---

ppciPid.h File Reference

Datatypes and function prototypes for PowerPCI ASIC PID routines. More...

#include "vxWorks.h"

Include dependency graph for ppciPid.h:

This graph shows which files directly or indirectly include this file:

Defines
#define	DISABLE   0
#define	IN   1
#define	OUT   2
#define	IN_OUT   3
#define	IN_LEVEL   0
#define	IN_EDGE   1
#define	OUT_REG   0
#define	OUT_TIMER   1
Functions
STATUS	pidCnf (int pidNum, int type, int inSen, int outSrc)
	Configure a PID.
STATUS	pidSet (int pidNum, int value)
	Set the value of a PID.
STATUS	pidGet (int pidNum)
	Get the value of a PID.
STATUS	pidIntEnable (int pidNum)
	Enable a PID PPC interrupt.
STATUS	pidIntDisable (int pidNum)
	Disable a PID PPC interrupt.
STATUS	pidIntConnect (int pidNum, VOIDFUNCPTR isr, int parm)
	Connect to a PID interrupt.
STATUS	pidIntEmcEnable (int pidNum)
	Enable a PID EMC interrupt.
STATUS	pidIntEmcDisable (int pidNum)
	Disable a PID EMC interrupt.
STATUS	pidEdgeClear (int pidNum)
void	ppciPidInit (void)

---

Detailed Description

Datatypes and function prototypes for PowerPCI ASIC PID routines.

-------------------------------------------------------------------------

Description:

Datatypes and function prototypes for PowerPCI ASIC PID routines. See ppciPid.c for detailed descriptions of the functions.

Restrictions:

Change History:

Date Pgm Description -------- --- ------------------------------------------------------ 04/21/00 MJF Initial Release 01/03/01 DS BSP integration. 03/03/03 CH Update to allow pidSet before pidCnf, and to disable a a PID with pidCnf.

--------------------------------------------------------------------------

---

Define Documentation

#define DISABLE   0

PID configuration: disable PID, no in or out.

#define IN   1

PID configuration: input PID.

#define IN_EDGE   1

PID configuration: input PID as negative edge sensitive.

#define IN_LEVEL   0

PID configuration: input PID as active low level sensitive.

#define IN_OUT   3

PID configuration: input/output PID.

#define OUT   2

PID configuration: input/output PID.

#define OUT_REG   0

PID configuration: output PID will write to PID output reg.

#define OUT_TIMER   1

PID configuration: output PID will source TIMER clock.

---

Function Documentation

STATUS pidCnf (  int  pidNum, int  type, int  inSen, int  outSrc )

Configure a PID. This routine configures a PID. Input PIDs can be (active low) level sensitive or (negative) edge sensitive. Output PIDs can be sourced from either a timer or the PID output register. Parameters: pidNum  - The PID number (0-31). type  - Whether to configure the PID as DISABLE, IN, OUT or IN_OUT. inSen  - Input sensitivity: IN_LEVEL or IN_EDGE outSrc  - Output source: OUT_REG or OUT_TIMER. Returns: OK or ERROR

STATUS pidEdgeClear (  int  pidNum  )

This routine clears the latched bit in the input register indicating an input edge was detected. Parameters: pidNum  - The PID number (0-31). Returns: OK or ERROR

int pidGet (  int  pidNum  )

Get the value of a PID. This routine returns the value (0 or 1) of the specified PID. The PID must be configured as an input. Parameters: pidNum  - The PID number (0-31). Returns: 0 if the PID is not set, 1 if the pid is set, or -1 on error.

STATUS pidIntConnect (  int  pidNum, VOIDFUNCPTR  isr, int  parm )

Connect to a PID interrupt. This routine connects an interrupt service routine (ISR) to a PowerPCI bridge PID interrupt level. PID interrupts are enabled separate from this routine (by pidIntEnable). The interrupt level being connected should not be enabled when this routine is called. The specified ISR will get control with interrupts disabled. Parameters: pidNum  - The PPCI PID interrupt level (0-31). isr  - Pointer to the ISR. parm  - A user-defined parameter to pass to the ISR when the interrupt occurs. Returns: OK or ERROR

STATUS pidIntDisable (  int  pidNum  )

Disable a PID PPC interrupt. This routine disables the specified PID as an interrupt (to the processor). The PID must be configured as an input. Parameters: pidNum  - The PID number (0-31). Returns: OK or ERROR

STATUS pidIntEmcDisable (  int  pidNum  )

Disable a PID EMC interrupt. This routine disables the specified PID as an interrupt to the EMC. The PID must be configured as an input. Parameters: pidNum  - The PID number (26-31). Returns: OK or ERROR

STATUS pidIntEmcEnable (  int  pidNum  )

Enable a PID EMC interrupt. This routine enables the specified PID as an interrupt to the EMC. The PID must be configured as an input. Parameters: pidNum  - The PID number (26-31). Returns: OK or ERROR

STATUS pidIntEnable (  int  pidNum  )

Enable a PID PPC interrupt. This routine enables the specified PID as an interrupt (to the processor). The PID must be configured as an input. Parameters: pidNum  - The PID number (0-31). Returns: OK or ERROR

STATUS pidSet (  int  pidNum, int  value )

Set the value of a PID. This routine sets a PID to a specified value. The PID does not have to be configured as an output. Parameters: pidNum  - The PID number (0-31). value  - Value to which the PID is set (0 or 1). Returns: OK or ERROR

void ppciPidInit (  void   )

This init routine is called by ppciInit (from sysHwInit) during system boot. Interrupt routing resources are initialized.

---