GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > CTDB / V5-5-2

Constituent: sumt_rt_pmc1553     Tag: mv2304


Interface   Data Structures   File List   Data Fields   Globals  

SUMT_rt_pkt.c File Reference

Interface functions for SUMT remote terminal CCSDS packet queues. More...

#include "CTDB/SUMT_rt.h"
#include "CTDB/CO1553_rt.h"
#include "PBS/TOC.h"
#include "MSG/MSG_pubdefs.h"
#include "SUMT_rt_private.h"

Include dependency graph for SUMT_rt_pkt.c:


Functions

unsigned int SUMT_rtPktTelemSend (SUMT_RT *rt, void *pkt, SUMT_RT_Pkt_Free *freeHandler, void *freeArg, SUMT_RT_Priority priority, const TOC *timeout)
 Send a CCSDS telemetry packet.
unsigned int SUMT_rtPktCmdRxRecv (SUMT_RT *rt, void **pkt, const TOC *timeout)
 Receive an incomming CCSDS command receive packet.
unsigned int SUMT_rtPktCmdRxFree (SUMT_RT *rt, void *pkt)
 Free a CCSDS command receive packet.
unsigned int SUMT_rtPktCmdTxSend (SUMT_RT *rt, void *pkt, SUMT_RT_Pkt_Free *freeHandler, void *freeArg, const TOC *timeout)
 Send an outgoing CCSDS command transmit packet.

Detailed Description

Interface functions for SUMT remote terminal CCSDS packet queues.

Author:
D.L. Wood

Function Documentation

unsigned int SUMT_rtPktCmdRxFree SUMT_RT rt,
void *  pkt
 

Free a CCSDS command receive packet.

Returns a CCSDS telecommand input packet buffer to the driver. This function should be called for every command packet received from the function SUMT_rtPktCmdRxRecv().

Parameters:
rt A device descriptor.
pkt A pointer to the packet buffer to free.
Returns:
A CTDB MSG code.

unsigned int SUMT_rtPktCmdRxRecv SUMT_RT rt,
void **  pkt,
const TOC *  timeout
 

Receive an incomming CCSDS command receive packet.

Waits for a new CCSDS telecommand receive packet on the remote terminal input queue. The function will place a pointer to the new packet buffer in pkt. The user should return the packet buffer to the driver by calling SUMT_rtPktCmdRxFree().

Parameters:
rt A device descriptor.
pkt Holds a pointer to the telecommand packet.
timeout The time to wait for a packet on the queue.
Returns:
A CTDB MSG code.

unsigned int SUMT_rtPktCmdTxSend SUMT_RT rt,
void *  pkt,
SUMT_RT_Pkt_Free freeHandler,
void *  freeArg,
const TOC *  timeout
 

Send an outgoing CCSDS command transmit packet.

Places a CCSDS telecommand packet on the remote terminal output queue. The packet will be sent when bandwidth becomes available.

Parameters:
rt A device descriptor.
pkt A pointer to the packet to send. The packet buffer should start with a properly formatted CCSDS packet header.
freeHandler The function to be called after the packet has been sent.
freeArg A user argument to be passed to the freeHandler function.
timeout The time to wait for a packet on the queue.
Returns:
A CTDB MSG code.

unsigned int SUMT_rtPktTelemSend SUMT_RT rt,
void *  pkt,
SUMT_RT_Pkt_Free freeHandler,
void *  freeArg,
SUMT_RT_Priority  priority,
const TOC *  timeout
 

Send a CCSDS telemetry packet.

Places a CCSDS telemetry packet on one of the remote terminal output queues. The packet will be sent when bandwidth becomes available.

Parameters:
rt A device descriptor.
pkt A pointer to the packet to send. The packet buffer should start with a properly formatted CCSDS packet header.
freeHandler The function to be called after the packet has been sent.
freeArg A user argument to be passed to the freeHandler function.
priority The priority of the packet: SUMT_RT_PRIORITY_HIGH or SUMT_RT_PRIORITY_LOW.
timeout The time to wait for a packet on the queue.
Returns:
A CTDB MSG code.


Generated on Tue Oct 25 20:43:46 2005 by  doxygen 1.4.4