GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > CTDB / V5-5-0
Constituent: co1553_rt Tag: rad750
#include "CTDB/CTDB_msg.h"
#include "PBS/RW.h"
#include "PBS/TOC.h"
#include "PBS/LI.h"
#include "PBS/L.h"
#include "PBS/FPA.h"
Include dependency graph for CO1553_rt.h:
This graph shows which files directly or indirectly include this file:
Data Structures | |
| struct | _CO1553_RT_Cmd_Rx |
| struct | _CO1553_RT_Cmd_Tx |
| struct | _CO1553_RT_Diag |
| struct | _CO1553_RT_Pkt_Desc |
| struct | _CO1553_RT_Telem |
Telemtry Interface Functions | |
| unsigned int | CO1553_rtTelemSizeof (void) |
| Get the size of a telemetry interface descriptor. | |
| unsigned int | CO1553_rtTelemInit (CO1553_RT_Telem *telem, unsigned int msgCount, unsigned int queueSizeHigh, unsigned int queueSizeLow, unsigned int telemPktSize, unsigned int hkpPktSize, CO1553_RT_Hkp_Handler *hkpHandler, void *hkpArg) |
| Initialize a telemetry interface descriptor. | |
| unsigned int | CO1553_rtTelemExit (CO1553_RT_Telem *telem) |
| Destroy a telemetry interface descriptor. | |
| unsigned int | CO1553_rtTelemMsg (CO1553_RT_Telem *telem, unsigned int *devPtr, CO1553_RT_Mem_Copy *copyFunc, unsigned int wordSize, CO1553_RT_Diag *diag, RW_ctl *lock) |
| Process a 1553 message transmit for the telemetry interface. | |
| unsigned int | CO1553_rtTelemPktSend (CO1553_RT_Telem *telem, void *pkt, CO1553_RT_Pkt_Free *freeHandler, void *freeArg, CO1553_RT_Priority priority, const TOC *timeout) |
| Send a CCSDS telmetry packet to the 1553 telemtry interface. | |
| unsigned int | CO1553_rtTelemHkpSet (CO1553_RT_Telem *telem, CO1553_RT_Hkp_Handler *hkpHandler, void *hkpArg) |
| Change the HKP application callback. | |
| unsigned int | CO1553_rtTelemHkpGet (CO1553_RT_Telem *telem, CO1553_RT_Hkp_Handler **hkpHandler, void **hkpArg) |
| Get current HKP application callback information. | |
Command Receive Interface Functions | |
| unsigned int | CO1553_rtCmdRxSizeof (void) |
| Get the size of a command receive interface descriptor. | |
| unsigned int | CO1553_rtCmdRxInit (CO1553_RT_Cmd_Rx *cmd, unsigned int queueSize, unsigned int pktSize, unsigned int usrSize) |
| Initialize a command receive interface descriptor. | |
| unsigned int | CO1553_rtCmdRxExit (CO1553_RT_Cmd_Rx *cmd) |
| Destroy a command receive interface descriptor. | |
| unsigned int | CO1553_rtCmdRxMsg (CO1553_RT_Cmd_Rx *cmd, unsigned int devPtr, CO1553_RT_Mem_Copy *copyFunc, CO1553_RT_Diag *diag, RW_ctl *lock) |
| Process a 1553 message receive for the command receive interface. | |
| unsigned int | CO1553_rtCmdRxPktRecv (CO1553_RT_Cmd_Rx *cmd, void **pkt, const TOC *timeout) |
| Receive a CCSDS command packet from the 1553 command receive interface. | |
| unsigned int | CO1553_rtCmdRxPktFree (CO1553_RT_Cmd_Rx *cmd, void *pkt) |
| Free a CCSDS command receive packet buffer. | |
Command Transmit Interface Functions | |
| unsigned int | CO1553_rtCmdTxSizeof (void) |
| Get the size of a command transmit interface descriptor. | |
| unsigned int | CO1553_rtCmdTxInit (CO1553_RT_Cmd_Tx *cmd, unsigned int queueSize, unsigned int pktSize) |
| Initialize a command transmit interface descriptor. | |
| unsigned int | CO1553_rtCmdTxExit (CO1553_RT_Cmd_Tx *cmd) |
| Destroy a command transmit interface descriptor. | |
| unsigned int | CO1553_rtCmdTxMsg (CO1553_RT_Cmd_Tx *cmd, unsigned int devPtr, CO1553_RT_Mem_Copy *copyFunc, int wordSize, CO1553_RT_Diag *diag, RW_ctl *lock) |
| Process a 1553 message transmit for the command transmit interface. | |
| unsigned int | CO1553_rtCmdTxPktSend (CO1553_RT_Cmd_Tx *cmd, void *pkt, CO1553_RT_Pkt_Free *freeHandler, void *freeArg, const TOC *timeout) |
| Send a CCSDS command packet to the the 1553 command transmit interface. | |
Typedefs | |
| typedef enum _CO1553_RT_Priority | CO1553_RT_Priority |
| typedef _CO1553_RT_Diag | CO1553_RT_Diag |
| typedef void | CO1553_RT_Pkt_Free (void *pkt, void *arg) |
| typedef void | CO1553_RT_Mem_Copy (void *dest, void *src, unsigned int numWords) |
| typedef unsigned int | CO1553_RT_Hkp_Handler (void *buf, void *arg) |
| typedef _CO1553_RT_Pkt_Desc | CO1553_RT_Pkt_Desc |
| typedef _CO1553_RT_Telem | CO1553_RT_Telem |
| typedef _CO1553_RT_Cmd_Rx | CO1553_RT_Cmd_Rx |
| typedef _CO1553_RT_Cmd_Tx | CO1553_RT_Cmd_Tx |
Enumerations | |
| enum | _CO1553_RT_Priority { CO1553_RT_PRIORITY_LOW = 0, CO1553_RT_PRIORITY_HIGH = 1 } |
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.
|
|
A command receive interface descriptor. The command interface functions will take a pointer to an instance of this structure as a parameter. |
|
|
A command transmit interface descriptor. The command interface functions will take a pointer to an instance of this structure as a parameter. |
|
|
The typedef for _CO1553_RT_Diag. |
|
|
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 CO1553_RT_Hkp_Handler(void *buf, void *arg)
|
|
|
A device dependent 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_RT_Mem_Copy(void *dest, void *src, unsigned int numWords)
|
|
|
The typedef for _CO1553_RT_Pkt_Desc. |
|
|
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_RT_Pkt_Free(void *pkt, void *arg)
|
|
|
The typedef for _CO1553_RT_Priority. |
|
|
A telemtry interface descriptor. The telemtery interface functions will take a pointer to an instance of this structure as a parameter. |
|
|
Priority values for telemetry packets. |
|
|
Destroy a command receive interface descriptor. Release resources from a 1553 CCSDS command receive interface.
|
|
||||||||||||||||||||
|
Initialize a command receive interface descriptor. Initializes a 1553 CCSDS telecommand command packet receive interface for a remote terminal. The telecommand packet input queue is created.
|
|
||||||||||||||||||||||||
|
Process a 1553 message receive for the command receive interface. Announces to the 1553 command receive packet interface the reception of a 1553 command input message. This function is called by a 1553 controller driver when the next 1553 command message in a frame has been received by the 1553 device. The next 1553 command message is copied from the device memory and is delivered to the command input queue as a CCSDS telecommand packet.
|
|
||||||||||||
|
Free a CCSDS command receive packet buffer. Returns a borrowed CCSDS command packet buffer to the remote terminal command receive interface.
|
|
||||||||||||||||
|
Receive a CCSDS command packet from the 1553 command receive interface. Attempts to get the next available command packet from the remote terminal command packet input queue. The command packet receive interface places new packets on this queue as 1553 command input messages arrive on the bus. The packet buffer memory is loaned to the user. Call CO1553_rtCmdRxPktFree() to return the packet buffer to the remote terminal command interface.
|
|
|
Get the size of a command receive interface descriptor.
|
|
|
Destroy a command transmit interface descriptor. Release resources from a 1553 CCSDS command transmit interface.
|
|
||||||||||||||||
|
Initialize a command transmit interface descriptor. Initializes a 1553 CCSDS telecommand command packet transmit interface for a remote terminal. The telecommand packet output queue is created.
|
|
||||||||||||||||||||||||||||
|
Process a 1553 message transmit for the command transmit interface. Announces to the 1553 command transmit packet interface the transmission of a 1553 command output message. This function is called by a 1553 controller driver when the last 1553 telecommand output message in a frame has been sent by the 1553 device. The CCSDS telecommand output packet queue is checked for any new pending output packets. If a new packet is ready for transmission, the packet data is copied to the device memory and the command transmit transfer counter is updated. The packet message will be sent on the next bus schedule telecommand transmit slot.
|
|
||||||||||||||||||||||||
|
Send a CCSDS command packet to the the 1553 command transmit interface. Places a CCSDS command transmit packet on the remote terminal command output queue. The command transmit subaddress interface will remove packets from this queue and send them as fast as 1553 command transmit message bandwidth allows. The packet buffer memory remains allocated as long as the packet is on the output queue. After the packet has been transmitted, a user supplied callback freeHandler will be called to release the packet memory.
|
|
|
Get the size of a command transmit interface descriptor.
|
|
|
Destroy a telemetry interface descriptor. Release resources from a 1553 CCSDS telemetry interface.
|
|
||||||||||||||||
|
Get current HKP application callback information. Retrieves the HKP application callback function and arguments current values.
|
|
||||||||||||||||
|
Change the HKP application callback. Changes the HKP application callback function and arguments to new values. The old values, set either in CO1553_rtTelemInit() or in the last call to this function, are replaced.
|
|
||||||||||||||||||||||||||||||||||||
|
Initialize a telemetry interface descriptor. Initializes a 1553 CCSDS telemetry packet interface. The telemetry packet output queue is created.
|
|
||||||||||||||||||||||||||||
|
Process a 1553 message transmit for the telemetry interface. Announces to the 1553 telemetry packet interface the transmission of the last 1553 telemety message of a telemetry transfer block (GT_PDU). This function is called by a 1553 controller driver when the previous 1553 telemetry messages in a frame have been sent by the 1553 device. The CCSDS telemetry packet output queue is checked for any pending data. The function tries to fill a complete telemetry block with packets from the queue for transmission on the next frame.
|
Here is the call graph for this function:
|
||||||||||||||||||||||||||||
|
Send a CCSDS telmetry packet to the 1553 telemtry interface. Places a CCSDS telemetry packet on the remote terminal telemetry output queue. The telemetry packet state machine will remove packets from this queue and transmit them as fast as 1553 telemetry message bandwidth allows. The packet buffer memory remains allocated as long as the packet is on the output queue. After the packet has been transmitted, a user supplied callback freeHandler will be called to release the packet memory.
|
|
|
Get the size of a telemetry interface descriptor.
|
1.3.3