GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> CTDB / V5-5-6 > sumt_rt_sib / rad750
#include <CTDB/CTDB_rt.h>
#include <CTDB/SUMT_rt.h>
#include <PBS/TOC.h>
Functions | |
Control Functions | |
unsigned int | CTDB_rtSizeof (void) |
Get the size of a remote terminal interface descriptor. | |
void * | CTDB_rtGet (void) |
Get a pointer to the remote terminal interface static descriptor. | |
unsigned int | CTDB_rtExit (void *rt) |
Shutdown a 1553 remote terminal interface. | |
unsigned int | CTDB_rtStart (void *rt) |
Start the remote terminal listening for 1553 bus commands. | |
unsigned int | CTDB_rtStop (void *rt) |
Stop the remote terminal listening for 1553 bus commands. | |
unsigned int | CTDB_rtHkpSet (void *rt, CTDB_RT_Hkp_Handler *hkpHandler, void *hkpArg) |
Change the HKP application callback. | |
unsigned int | CTDB_rtHkpGet (void *rt, CTDB_RT_Hkp_Handler **hkpHandler, void **hkpArg) |
Get current HKP application callback information. | |
Packet Queue Functions | |
unsigned int | CTDB_rtPktTelemSend (void *rt, void *pkt, CTDB_RT_Pkt_Free *freeHandler, void *freeArg, CTDB_RT_Priority priority, const TOC *timeout) |
Send a CCSDS telemetry packet. | |
unsigned int | CTDB_rtPktCmdTxSend (void *rt, void *pkt, CTDB_RT_Pkt_Free *freeHandler, void *freeArg, const TOC *timeout) |
Send a CCSDS telecommand transmit packet. | |
unsigned int | CTDB_rtPktCmdRxRecv (void *rt, void **pkt, const TOC *timeout) |
Receive a CCSDS telecommand receive packet. | |
unsigned int | CTDB_rtPktCmdRxFree (void *rt, void *pkt) |
Free a CCSDS telecommand receive packet buffer. | |
Diagnostics Functions | |
unsigned int | CTDB_rtDiagGet (void *rt, CTDB_RT_Diag *diag) |
Read the diagnostics information. | |
unsigned int | CTDB_rtDiagClear (void *rt) |
Clear the diagnostics information. |
unsigned int CTDB_rtDiagClear | ( | void * | rt | ) |
Clear the diagnostics information.
Sets to zero the current diagnostics counter values.
rt | A device descriptor. |
References SUMT_rtDiagClear().
unsigned int CTDB_rtDiagGet | ( | void * | rt, | |
CTDB_RT_Diag * | diag | |||
) |
Read the diagnostics information.
Places the current diagnostics counter values into diag.
rt | A device descriptor. | |
diag | Contains diagnostics info upon return. |
References SUMT_rtDiagGet().
unsigned int CTDB_rtExit | ( | void * | rt | ) |
Shutdown a 1553 remote terminal interface.
Disconnects the remote terminal and releases system resources.
rt | A device descriptor. |
References SUMT_rtExit().
void * CTDB_rtGet | ( | void | ) |
Get a pointer to the remote terminal interface static descriptor.
Returns a pointer to a static instance of the interface descriptor. This pointer may be passed in as the first paramter to all of the other interface functions. The device-specific intialization function must be called before use.
References SUMT_rtGet().
unsigned int CTDB_rtHkpGet | ( | void * | rt, | |
CTDB_RT_Hkp_Handler ** | hkpHandler, | |||
void ** | hkpArg | |||
) |
Get current HKP application callback information.
Retrieves the HKP application callback function and arguments current values.
rt | A device descriptor. | |
hkpHandler | Stores the pointer to the application HKP function. | |
hkpArg | Stores user argument for hkpHandler. |
References SUMT_rtHkpGet().
unsigned int CTDB_rtHkpSet | ( | void * | rt, | |
CTDB_RT_Hkp_Handler * | hkpHandler, | |||
void * | hkpArg | |||
) |
Change the HKP application callback.
Changes the HKP application callback function and arguments to new values.
rt | A device descriptor. | |
hkpHandler | The synchronous callback to handle insertion of HKP telemety packets into the telemetry blocks. | |
hkpArg | A user argument for hkpHandler. |
References SUMT_rtHkpSet().
int CTDB_rtPktCmdRxFree | ( | void * | rt, | |
void * | pkt | |||
) |
Free a CCSDS telecommand receive packet buffer.
Returns a CCSDS telecommand input packet buffer to the interface.
rt | A device descriptor. | |
pkt | A pointer to the packet buffer to free. |
References SUMT_rtPktCmdRxFree().
int CTDB_rtPktCmdRxRecv | ( | void * | rt, | |
void ** | pkt, | |||
const TOC * | timeout | |||
) |
Receive a CCSDS telecommand 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.
rt | A device descriptor. | |
pkt | Holds a pointer to the telecommand packet. | |
timeout | The time to wait for a packet on the queue. This value is ignored for the simulator implementation. |
References SUMT_rtPktCmdRxRecv().
nt CTDB_rtPktCmdTxSend | ( | void * | rt, | |
void * | pkt, | |||
CTDB_RT_Pkt_Free * | freeHandler, | |||
void * | freeArg, | |||
const TOC * | timeout | |||
) |
Send a CCSDS telecommand transmit packet.
Places a CCSDS telecommand packet on the remote terminal output queue. The packet will be sent when bandwidth becomes available.
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. This value is ignored for the simulator implementation. |
References SUMT_rtPktCmdTxSend().
unsigned int CTDB_rtPktTelemSend | ( | void * | rt, | |
void * | pkt, | |||
CTDB_RT_Pkt_Free * | freeHandler, | |||
void * | freeArg, | |||
CTDB_RT_Priority | priority, | |||
const TOC * | timeout | |||
) |
Send a CCSDS telemetry packet.
Places a CCSDS telemetry packet on the remote terminal output queue. The packet will be sent when bandwidth becomes available.
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. This value is ignored for the simulator implementation. |
References SUMT_rtPktTelemSend().
unsigned int CTDB_rtSizeof | ( | void | ) |
Get the size of a remote terminal interface descriptor.
Returns the size of a remote terminal descriptor.
This function is obsolete. Use CTDB_rtGet() to provide an instance of the simulator descriptor instead.
References SUMT_rtSizeof().
unsigned int CTDB_rtStart | ( | void * | rt | ) |
Start the remote terminal listening for 1553 bus commands.
Starts the remote terminal listening on the 1553 bus for commands from the bus controller.
rt | A device descriptor. |
References SUMT_rtStart().
unsigned int CTDB_rtStop | ( | void * | rt | ) |
Stop the remote terminal listening for 1553 bus commands.
Stops the remote terminal from listening on the 1553 bus for commands from the bus controller.
rt | A device descriptor. |
References SUMT_rtStop().