CTDB_bc.h File Reference

1553 Bus Controller Interface More...

#include <CTDB/CTDB_msg.h>
#include <PBS/TOC.h>

Typedefs
typedef void	CTDB_BC_Pkt_Free (void *pkt, void *arg)
Functions
Control Functions
unsigned int	CTDB_bcSizeof (void)
	Get the size of a bus controller interface descriptor.
void *	CTDB_bcGet (void)
	Get a pointer to the bus controller interface static descriptor.
unsigned int	CTDB_bcExit (void *bc)
	Shutdown a 1553 bus controller interface.
unsigned int	CTDB_bcStart (void *bc)
	Start the bus controller listening for 1553 bus commands.
unsigned int	CTDB_bcStop (void *bc)
	Stop the bus controller listening for 1553 bus commands.
Packet Queue Functions
unsigned int	CTDB_bcPktTelemRecv (void *bc, void **pkt, const TOC *timeout)
	Receive a CCSDS telemetry packet.
unsigned int	CTDB_bcPktTelemFree (void *bc, void *pkt)
	Free a CCSDS telemtry packet.
unsigned int	CTDB_bcPktCmdTxRecv (void *bc, void **pkt, const TOC *timeout)
	Receive a CCSDS telecommand transmit packet.
unsigned int	CTDB_bcPktCmdTxFree (void *bc, void *pkt)
	Free a CCSDS telecommand transmit packet.
unsigned int	CTDB_bcPktCmdRxSend (void *bc, void *pkt, CTDB_BC_Pkt_Free *freeHandler, void *freeArg, const TOC *timeout)
	Send a CCSDS telecommand receive packet.

---

Detailed Description

1553 Bus Controller 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_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 CTDB_BC_Pkt_Free(void *pkt, void *arg)

Parameters:

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

---

Function Documentation

unsigned int CTDB_bcPktCmdTxRecv	(	void *	bc,
		void **	pkt,
		const TOC *	timeout
	)

Receive a CCSDS telecommand transmit packet.

Receive a CCSDS telecommand receive packet.

Referenced by bc_pkt_cmd_tx().