GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > CTDB / V5-4-0

Constituent: vsbc_bc_test_sumt     Tag: mv2304

Interface   Data Structures   File List   Data Fields   Globals  

CO1553_bc.h File Reference

1553 Bus Controller Driver CCSDS Packet Interface Library. More...

#include "CTDB/CTDB_msg.h"
#include "PBS/TOC.h"
#include "PBS/FPA.h"
#include "PBS/LI.h"
#include "MSG/MSG_pubdefs.h"

Include dependency graph for CO1553_bc.h:

Include dependency graph

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

Included by dependency graph

Data Structures

struct  _CO1553_BC_Cmd_Rx
struct  _CO1553_BC_Cmd_Tx
struct  _CO1553_BC_Pkt_Desc
struct  _CO1553_BC_Telem

Telemetry Interface Functions

unsigned int CO1553_bcTelemSizeof (void)
 Get the size of a telemetry interface descriptor.

unsigned int CO1553_bcTelemInit (CO1553_BC_Telem *telem, unsigned int msgCount, unsigned int queueSize, unsigned int pktSize)
 Initialize a telemetry interface descriptor.

unsigned CO1553_bcTelemExit (CO1553_BC_Telem *telem)
 Destroy a telemetry interface descriptor.

unsigned int CO1553_bcTelemMsg (CO1553_BC_Telem *telem, unsigned short **devPtr, CO1553_BC_Mem_Copy *copyFunc)
 Process a 1553 message receive for the telemetry interface.

unsigned int CO1553_bcTelemPktRecv (CO1553_BC_Telem *telem, void **pkt, const TOC *timeout)
 Receive a CCSDS telemetry packet from the 1553 telemetry interface.

unsigned int CO1553_bcTelemPktFree (CO1553_BC_Telem *telem, void *pkt)
 Free a CCSDS telemetry packet buffer.


Command Receive Interface Functions

unsigned int CO1553_bcCmdRxSizeof (void)
unsigned int CO1553_bcCmdRxInit (CO1553_BC_Cmd_Rx *cmd, unsigned int queueSize, unsigned int pktSize)
 Initialize an command receive interface descriptor.

unsigned int CO1553_bcCmdRxExit (CO1553_BC_Cmd_Rx *cmd)
 Destroy an command receive interface descriptor.

unsigned int CO1553_bcCmdRxMsg (CO1553_BC_Cmd_Rx *cmd, unsigned short *devPtr, CO1553_BC_Mem_Copy *copyFunc)
 Process a 1553 message transmit for the command receive interface.

unsigned int CO1553_bcCmdRxPktSend (CO1553_BC_Cmd_Rx *cmd, void *pkt, CO1553_BC_Pkt_Free *freeHandler, void *freeArg, const TOC *timeout)
 Send a CCSDS command packet to the 1553 command receive interface.


Command Transmit Interface Functions

unsigned int CO1553_bcCmdTxSizeof (void)
unsigned int CO1553_bcCmdTxInit (CO1553_BC_Cmd_Tx *cmd, unsigned int queueSize, unsigned int pktSize)
 Initialize an command transmit interface descriptor.

unsigned int CO1553_bcCmdTxExit (CO1553_BC_Cmd_Tx *cmd)
 Destroy an command transmit interface descriptor.

unsigned int CO1553_bcCmdTxMsg (CO1553_BC_Cmd_Tx *cmd, unsigned short *devPtr, CO1553_BC_Mem_Copy *copyFunc)
 Process a 1553 message transmit for the command transmit interface.

unsigned int CO1553_bcCmdTxPktRecv (CO1553_BC_Cmd_Tx *cmd, void **pkt, const TOC *timeout)
 Receive a CCSDS command packet from the 1553 command transmit interface.

unsigned int CO1553_bcCmdTxPktFree (CO1553_BC_Cmd_Tx *cmd, void *pkt)
 Free a CCSDS command transmit packet buffer.


Typedefs

typedef void CO1553_BC_Pkt_Free (void *pkt, void *arg)
typedef void CO1553_BC_Mem_Copy (void *dest, void *src, unsigned int numWords)
typedef _CO1553_BC_Pkt_Desc CO1553_BC_Pkt_Desc
typedef _CO1553_BC_Telem CO1553_BC_Telem
typedef _CO1553_BC_Cmd_Rx CO1553_BC_Cmd_Rx
typedef _CO1553_BC_Cmd_Tx CO1553_BC_Cmd_Tx

Detailed Description

1553 Bus Controller Driver CCSDS Packet Interface Library.

Author:
D.L. Wood
This library contains functions for processing CCSDS packets as messages on the 1553 bus. Each subaddress can have one outstanding packet for either transmission or reception. For each subaddress, a packet queue, packet buffer, and packet state machine are maintained. The packet queues hold pending outgoing command packets for receive subaddresses and pending incomming telmetry packets for transmit subaddresses. The packet buffer holds the current packet for a subaddress while its fragments are being sent or received. The packet state machines implement the policy for fragmenting telemtry packets and re-assebling command packets. The packets are fragmented as a series of 1553 data messages.

The recognized subaddress types are shown below,

Subaddress Direction Description
Command Receive (CmdRx) Receive (BC->RT) Telecommand input
Command Transmit(CmdTx) Transmit (RT->BC) Telecommand output
Telemetry (Telem) Transmit (RT->BC) Low rate telemetry

The functions in this library are meant to be called by a 1553 device controller driver. Each subaddress state machine needs to be notified when the frame sync message occurs and when a data transfer message for that subaddress occurs. The controller driver provides pointers to device memory that the packet state machines use to copy 1553 messages in and out of the packet buffers.

Typedef Documentation

CO1553_BC_Cmd_Rx
 

A command receive interface descriptor. The command interface functions will take a pointer to an instance of this structure as a parameter.

CO1553_BC_Cmd_Tx
 

A command transmit interface descriptor. The command interface functions will take a pointer to an instance of this structure as a parameter.

CO1553_BC_Mem_Copy
 

A device independent message copy function. For efficiency, the packet state machines try to move packet fragments directly in and out of the 1553 device shared memory message buffers. This function is provided by the controller driver to access the device shared memory.

        void CO1553_BC_Mem_Copy(void *dest, void *src, unsigned int numWords)

Parameters:
dest The destination address of the copy.
src The source address of the copy.
numWords The number of 16-bit words to copy.

CO1553_BC_Pkt_Desc
 

The typedef for _CO1553_BC_Pkt_Desc.

CO1553_BC_Pkt_Free
 

The definition of a packet buffer memory free callback function. These callbacks are employeed when users are sending packets on a transmit queue. The packet memory is borrowed while the packet is on the queue. When the packet contents have been transmitted, the free handler is called with a user supplied argument.

        void CO1553_BC_Pkt_Free(void *pkt, void *arg)

Parameters:
pkt A pointer to the packet buffer to release.
arg The user defined argument.

CO1553_BC_Telem
 

A telemtry interface descriptor. The telemtery interface functions will take a pointer to an instance of this structure as a parameter.

Function Documentation

unsigned int CO1553_bcCmdRxSizeof (  void   ) 
 

Get the size of a command receive interface descriptor.

unsigned int CO1553_bcCmdTxSizeof (  void   ) 
 

Get the size of a command transmit interface descriptor.

Generated on Sun Jul 17 01:12:33 2005 by doxygen 1.3.3