---

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

Constituent: ctdb_com_test_intr     Tag: rad750

---

         

---

CTDB_rt.h File Reference

1553 Remote Terminal Interface More...

#include "CTDB/CTDB_msg.h"
#include "PBS/TOC.h"

Include dependency graph for CTDB_rt.h:

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

Data Structures
struct	_CTDB_RT_Diag
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.
Typedefs
typedef enum _CTDB_RT_Priority	CTDB_RT_Priority
typedef void	CTDB_RT_Pkt_Free (void *pkt, void *arg)
typedef unsigned int	CTDB_RT_Hkp_Handler (void *buf, void *arg)
typedef _CTDB_RT_Diag	CTDB_RT_Diag
Enumerations
enum	_CTDB_RT_Priority {   CTDB_RT_PRIORITY_LOW = 0,   CTDB_RT_PRIORITY_HIGH = 1 }

---

Detailed Description

1553 Remote Terminal Interface

Author:

D.L. Wood

This library contains functions that serve as wrappers for the various LAT 1553 implementations. Allows higher level code to be implementation independent, except for the initialization functions. Also note that the actual hardware drivers can return device specific error codes. These specific error codes are not covered by this interface.

---

Typedef Documentation

CTDB_RT_Diag

The typedef for _CTDB_RT_Diag.

CTDB_RT_Hkp_Handler

The format of the real-time housekeeping remote terminal callback. The user provides this function so that the HKP data packet may be inserted into the 1553 frame. The user should copy the HKP packet, with properly formatted CCSDS header, into the buf memory. unsigned int SUMT_RT_Hkp_Handler(void *buf, void *arg) Parameters: buf  A driver buffer to accept the HKP packet contents. arg  A user supplied argument. Returns: CTDB_SUCCESS if successful; other code if HKP packet not inserted.

CTDB_RT_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 CTDB_RT_Pkt_Free(void *pkt, void *arg) Parameters: pkt  A pointer to the packet buffer to release. arg  The user defined argument.

CTDB_RT_Priority

The typedef for _CTDB_RT_Priority.

---

Enumeration Type Documentation

enum _CTDB_RT_Priority

Values to indicate packet priority. Enumerator: CTDB_RT_PRIORITY_LOW  A priority value to indicate low priority. CTDB_RT_PRIORITY_HIGH  A priority value to indicate high priority.

---