GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LCB / dev

Constituent: liox     Tag: mcp750


Interface   Data Structures   File List   Data Fields   Globals  

LIOX.h File Reference

Defines public aspects of the LIOX. More...

#include "PBI/Endianness.h"
#include "LCB/LCB.h"
#include "LCB/LIOX_msgs.h"
#include "MSG/MSG_pubdefs.h"

Include dependency graph for LIOX.h:

Include dependency graph

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

Included by dependency graph

Data Structures

struct  _BFLIOX_CSR
 map of the LATp backend CSR register More...

struct  _BFLIOX_FIFO_FAULTS
 map of the LATp backend CSR register More...

union  _LIOX_CSR
 union for 32-bit CSR register More...

union  _LIOX_FIFO_FAULTS
 union for 32-bit CSR register More...


Defines

#define LIOX_DEFAULT_TIMEOUT   ((unsigned int) ~0x0)
 Sentinel value meaning "use the default timeout value".

#define LIOX_INTERNAL_MASK   (0x1)
 Bit mask applied to LIOX opcode to determine if opcode results in a transmission.

#define LIOX_EVENT_MASK   (0x2)
 Bit mask applied to LIOX opcode to determine if opcode is for event fabric.

#define LIOX_RESPONSE_MASK   (0x4)
 Bit mask applied to LIOX opcode to determine if opcode results in a response.

#define LIOX_UNSOLICITED_MASK   (0x8)
 Bit mask applied to LIOX opcode to determine if opcode is an unsolicited command.


Typedefs

typedef _LIOX_ci LIOX_ci
 Typedef for struct _LIOX_ci.

typedef _LIOX_cl LIOX_cl
 Typedef for struct _LIOX_cl.

typedef _LIOX_ri LIOX_ri
 Typedef for union _LIOX_ri.

typedef _LIOX_rl LIOX_rl
 Typedef for struct _LIOX_rl.

typedef _LIOXLIOX
 Typedef for struct _LIOX.

typedef void * LIOX_cb_prm
 Typedef for opaque LIOX user callback parameter.

typedef int(* LIOX_rst_cb )(LIOX lh, unsigned int status, LIOX_cb_prm usrParm)
 User supplied callback routine for LIOX result processing.

typedef unsigned int(* LIOX_ri_cb )(LIOX lh, LIOX_ri *ri, LIOX_cb_prm usrParm)
 Typedef for function pointer to for-each result item processing routine.

typedef unsigned int(* LIOX_ci_cb )(LIOX lh, LIOX_ci *ci, LIOX_cb_prm usrParm)
 Typedef for function pointer to for-each command item processing routine.

typedef enum _LIOX_STATE LIOX_STATE
 Typdef for enum _LIOX_STATE.

typedef enum _LIOX_OPCODE LIOX_OPCODE
 Typdef for enum _LIOX_OPCODE.

typedef _LIOX_CSR LIOX_CSR
 typedef for union _LIOX_CSR

typedef _LIOX_FIFO_FAULTS LIOX_FIFO_FAULTS
 typedef for union _LIOX_FIFO_FAULTS


Enumerations

enum  _LIOX_STATE {
  LIOX_READY = 0,
  LIOX_PEND,
  LIOX_RECEIVED
}
 Enumeration of LIOX states. More...

enum  _LIOX_OPCODE {
  LIOX_OP_CMD = 0x0,
  LIOX_OP_MARKER = 0x1,
  LIOX_OP_EVENT = 0x2,
  LIOX_OP_LAT_RESET = 0x3,
  LIOX_OP_CMD_RSP = 0x4,
  LIOX_OP_CSR = 0x5,
  LIOX_OP_FIFO_FAULT = 0x7,
  LIOX_OP_UNSOL_CMD = 0xE
}
 Enumeration of LIOX opcodes. More...


Detailed Description

Defines public aspects of the LIOX.

Author:
Curt Brune -- curt@slac.stanford.edu
  CVS $Id: LIOX.h,v 1.12 2004/04/28 21:03:25 ebacho Exp $

The LIOX (LAT I/O Transaction) is a data structure that connects a LCB command list to a LCB result list. See chapter 4 of Mike Huffer's "LAT Communications Board -- Design Specification" for more details.


Typedef Documentation

LIOX_ci
 

Typedef for struct _LIOX_ci.

LIOX Command Item data structure

LIOX_cl
 

Typedef for struct _LIOX_cl.

LIOX Command List data structure

LIOX_ri
 

Typedef for union _LIOX_ri.

LIOX Result Item data structure

LIOX_rl
 

Typedef for struct _LIOX_rl.

LIOX Result List data structure


Enumeration Type Documentation

enum _LIOX_OPCODE
 

Enumeration of LIOX opcodes.

Enumeration values:
LIOX_OP_CMD  LIOX external command transmission (no response)
LIOX_OP_MARKER  LIOX interal opcode marker
LIOX_OP_EVENT  LIOX external event transmission (no response)
LIOX_OP_LAT_RESET  LIOX interal opcode LAT RESET
LIOX_OP_CMD_RSP  LIOX external command transmission with response
LIOX_OP_CSR  LIOX interal opcode write CSR
LIOX_OP_FIFO_FAULT  LIOX interal opcode write FIFO FAULT register
LIOX_OP_UNSOL_CMD  LIOX external unsolicited command

enum _LIOX_STATE
 

Enumeration of LIOX states.

Enumeration values:
LIOX_READY  LIOX Allocated, ready for transmission
LIOX_PEND  Transmission begun, waiting for result
LIOX_RECEIVED  Result receieved, transaction complete


Generated on Sat Oct 30 06:49:41 2004 by doxygen 1.3.3