GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LCBD / V1-4-2

Constituent: lcbd     Tag: rad750


Interface   Data Structures   File List   Data Fields   Globals  

LCBD_pci.h File Reference

Definitions of the LCBD PCI access routines. More...

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


Defines

#define LCBD_OK   0
 Success return code, note that this is not an LCBD message code, but may be used as one.

Functions

void LCBD_pci_csr_write (const LCBD lcb, unsigned int val)
 writes 32-bit val into LCB CSR register
unsigned int LCBD_pci_csr_read (const LCBD lcb)
 read 32-bit CSR register
void LCBD_pci_irq_write (const LCBD lcb, unsigned int val)
 writes 32-bit val into LCB IRQ enable register
unsigned int LCBD_pci_irq_read (const LCBD lcb)
 read 32-bit IRQ enable register
void LCBD_pci_events_base_write (LCBD lcb, unsigned int val)
 writes 32-bit val into LCB EVENTS_BASE register
unsigned int LCBD_pci_events_base_read (const LCBD lcb)
 read 32-bit EVENTS_BASE register
void LCBD_pci_events_free_write (const LCBD lcb, unsigned int val)
 writes 32-bit val into LCB EVENTS_FREE register
unsigned int LCBD_pci_events_free_read (const LCBD lcb)
 read 32-bit EVENTS_FREE register
unsigned int LCBD_pci_resultq_read (const LCBD lcb)
 reads 32-bit result queue FIFO
unsigned int LCBD_pci_eventq_read (const LCBD lcb)
 reads 32-bit event queue FIFO
unsigned int LCBD_pci_requestq_read (const LCBD lcb)
 Read the LCB Export FIFO register.
void LCBD_pci_requestq_write (const LCBD lcb, unsigned int val)
 writes 32-bit val into LCB Export FIFO register
unsigned int LCBD_pci_fabric_select_read (const LCBD lcb)
 reads 32-bit fabric select register
void LCBD_pci_fabric_select_write (const LCBD lcb, unsigned int val)
 writes 32-bit val into fabric select register
unsigned int LCBD_pci_cfg_inWord (const LCBD lcb, int offset, unsigned short *word)
 Reads a 16-bit word from PCI Configuration space at the specificied byte offset.
unsigned int LCBD_pci_cfg_inLong (const LCBD lcb, int offset, unsigned int *word)
 Reads a 32-bit word from PCI Configuration space at the specificied byte offset.
unsigned int LCBD_pci_cfg_outWord (const LCBD lcb, int offset, unsigned short word)
 Writes word to PCI Configuration space at the specificied byte offset.
unsigned int LCBD_pci_cfg_outLong (const LCBD lcb, int offset, unsigned int word)
 Writes a 32-bit word to PCI Configuration space at the specificied byte offset.
unsigned int LCBD_pci_cfg_hdr_show (const LCBD lcb)
 Dumps the PCI Configuration Space to stdout.

Detailed Description

Definitions of the LCBD PCI access routines.

Author:
Curt Brune -- curt@slac.stanford.edu

JJRussell -- russell@slac.stanford.edu

  CVS $Id

These define the interface to the PCI registers. For the most these routines are useful only in a debugging and/or development environment. That is why they are broken off into a separate file.


Function Documentation

unsigned int LCBD_pci_cfg_hdr_show const LCBD  lcb  ) 
 

Dumps the PCI Configuration Space to stdout.

Parameters:
lcb Pointer to private LCBD structure
Returns:
LCBD_OK for success

unsigned int LCBD_pci_cfg_inLong const LCBD  lcb,
int  offset,
unsigned int *  word
 

Reads a 32-bit word from PCI Configuration space at the specificied byte offset.

Parameters:
lcb Pointer to private LCBD structure
offset Byte offset in PCI Configuration space
word Pointer to storage to hold configuration word
Returns:
OK for success
See also:
LCBD_pci_cfg_outLong()

unsigned int LCBD_pci_cfg_inWord const LCBD  lcb,
int  offset,
unsigned short *  word
 

Reads a 16-bit word from PCI Configuration space at the specificied byte offset.

Parameters:
lcb Pointer to private LCBD structure
offset Byte offset in PCI Configuration space
word Pointer to storage to hold configuration word
Returns:
OK for success
See also:
LCBD_pci_cfg_outWord()

unsigned int LCBD_pci_cfg_outLong const LCBD  lcb,
int  offset,
unsigned int  word
 

Writes a 32-bit word to PCI Configuration space at the specificied byte offset.

Parameters:
lcb Pointer to private LCBD structure
offset Byte offset in PCI Configuration space
word 32-bit value to write to configuration space
Returns:
OK for success
See also:
LCBD_pci_cfg_inLong()

unsigned int LCBD_pci_cfg_outWord const LCBD  lcb,
int  offset,
unsigned short  word
 

Writes word to PCI Configuration space at the specificied byte offset.

Parameters:
lcb Pointer to private LCBD structure
offset Byte offset in PCI Configuration space
word 16-bit value to write to configuration space
Returns:
OK for success
See also:
LCBD_pci_cfg_inWord()

unsigned int LCBD_pci_csr_read const LCBD  lcb  ) 
 

read 32-bit CSR register

Returns:
The value of the register
Parameters:
lcb Pointer to private LCBD structure
See also:
LCBD_pci_csr_write()

void LCBD_pci_csr_write const LCBD  lcb,
unsigned int  val
 

writes 32-bit val into LCB CSR register

Parameters:
lcb Pointer to private LCBD structure
val 32-bit value to load
See also:
LCBD_pci_csr_read()

unsigned int LCBD_pci_eventq_read const LCBD  lcb  ) 
 

reads 32-bit event queue FIFO

Returns:
The value of the read register
Parameters:
lcb Pointer to private LCBD structure

unsigned int LCBD_pci_events_base_read const LCBD  lcb  ) 
 

read 32-bit EVENTS_BASE register

Returns:
The read value of the register in PCI address space
Parameters:
lcb Pointer to private LCBD structure
See also:
LCBD_pci_events_base_write()

void LCBD_pci_events_base_write LCBD  lcb,
unsigned int  val
 

writes 32-bit val into LCB EVENTS_BASE register

Parameters:
lcb Pointer to private LCBD structure
val 32-bit value to load. This should be a CPU address suitably transformed to PCI address space.
See also:
LCBD_pci_events_base_read()

unsigned int LCBD_pci_events_free_read const LCBD  lcb  ) 
 

read 32-bit EVENTS_FREE register

Parameters:
lcb Pointer to private LCBD structure
Returns:
The value of the read register
See also:
LCBD_pci_events_free_write()

void LCBD_pci_events_free_write const LCBD  lcb,
unsigned int  val
 

writes 32-bit val into LCB EVENTS_FREE register

Parameters:
lcb Pointer to private LCBD structure
val 32-bit value to load
See also:
LCBD_pci_events_free_read()

unsigned int LCBD_pci_fabric_select_read const LCBD  lcb  ) 
 

reads 32-bit fabric select register

Returns:
The value of the read register
See also:
LCBD_pci_fabric_select_write
Parameters:
lcb Pointer to private LCBD structure
This register selects and records the state of which fabric (primary or redundant) is active.

void LCBD_pci_fabric_select_write const LCBD  lcb,
unsigned int  val
 

writes 32-bit val into fabric select register

Parameters:
lcb Pointer to private LCBD structure
val 32-bit value to load
See also:
LCBD_pci_fabric_select_read
This register selects and records the state of which fabric (primary or redundant) is active.

unsigned int LCBD_pci_irq_read const LCBD  lcb  ) 
 

read 32-bit IRQ enable register

Parameters:
lcb Pointer to private LCBD structure
Returns:
The read value
See also:
LCBD_pci_irq_write()

void LCBD_pci_irq_write const LCBD  lcb,
unsigned int  val
 

writes 32-bit val into LCB IRQ enable register

Parameters:
lcb Pointer to private LCBD structure
val 32-bit value to load
See also:
LCBD_pci_irq_read()

unsigned int LCBD_pci_requestq_read const LCBD  lcb  ) 
 

Read the LCB Export FIFO register.

Parameters:
lcb Pointer to private LCBD structure
See also:
LCBD_pci_requestq_write()

void LCBD_pci_requestq_write const LCBD  lcb,
unsigned int  val
 

writes 32-bit val into LCB Export FIFO register

Parameters:
lcb Pointer to private LCBD structure
val 32-bit value to load
See also:
LCBD_pci_resultq_read()

unsigned int LCBD_pci_resultq_read const LCBD  lcb  ) 
 

reads 32-bit result queue FIFO

Returns:
The value of the read register
Parameters:
lcb Pointer to private LCBD structure


Generated on Tue Nov 28 02:12:06 2006 by  doxygen 1.4.4