GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> LHK / dev > lhk / mv2304
#include <CTDB/CTDB_rt.h>
Defines | |
#define | LHK_L_PRM_HDRSIZ (6) |
#define | LHK_L_TLM_HDRSIZ (14) |
#define | LHK_L_TLM_PKTSIZ (116) |
Typedefs | |
typedef enum _LHK_PacketStatus | LHK_PacketStatus |
Typedef for enum _LHK_PacketStatus. | |
typedef LHK_PacketStatus | LHK_cb_Capture (void *prm, unsigned int abas, unsigned int aidx, unsigned int seq, unsigned char *out) |
Signature for an LHK routine to capture a packet. | |
Enumerations | |
enum | _LHK_PacketStatus { LHK_PKT_TIMEOUT = CTDB_TIMEOUT, LHK_PKT_SUCCESS = CTDB_SUCCESS } |
Enumeration of states to be returned by a packet capture routine. More... | |
Functions | |
unsigned int | LHK_definePacket (unsigned int aidx, LHK_cb_Capture rtn, void *hsk, void *dia) |
Define a packet table entry. | |
unsigned int | LHK_diagnosticRequest (unsigned int apid, unsigned int count, unsigned int delta) |
Cancel a diagnostic packet request. | |
unsigned int | LHK_initialize (void) |
Initialize the LHK system. | |
unsigned int | LHK_start (void) |
Start the LHK task. | |
void | LHK_scheduleGet (unsigned int *fil, unsigned int *ins) |
Identify the schedule file in use. |
CVS $Id: LHK_pubdefs.h,v 1.6 2011/03/29 01:45:00 apw Exp $
enum _LHK_PacketStatus |
unsigned int LHK_definePacket | ( | unsigned int | aidx, | |
LHK_cb_Capture | rtn, | |||
void * | hsk, | |||
void * | dia | |||
) |
Define a packet table entry.
aidx | (in) Index in APID packet table | |
rtn | (in) Routine to capture the APID data | |
hsk | (in) User parameter to use when capturing housekeeping | |
dia | (in) User parameter to use when capturing diagnostic |
LHK_BADAIDX | Invalid APID index | |
LHK_NULLRTN | Capture routine defined as NULL | |
LHK_SUCCESS | Success |
References _LHK_Packet::dia, _LHK_Packet::hsk, LHK_packet, and _LHK_Packet::rtn.
Referenced by LHK_diagnosticInitialize().
unsigned int LHK_diagnosticRequest | ( | unsigned int | aidx, | |
unsigned int | count, | |||
unsigned int | delta | |||
) |
Cancel a diagnostic packet request.
aidx | (in) Diagnostic packet APID index (repeat, index) | |
count | (in) Number of packets to send (zero implies "forever") | |
delta | (in) Interval between packets (milliseconds) |
LHK_BADAIDX | Invalid APID index | |
LHK_DIAGTIME | Must specify a repetition time (unless count is zero) | |
LHK_SUCCESS | Success |
References _LHK_Blip::aidx, _LHK_Control::dpa, forkBlip(), _LHK_Control::fqi, _LHK_Blip::frk, and LHK_lcb.
unsigned int LHK_initialize | ( | void | ) |
Initialize the LHK system.
LHK_initialize() builds up the resources to run the LHK system.
References LHK_CTL_BROKEN, LHK_CTL_INITIALIZED, LHK_CTL_UNINITIALIZED, LHK_diagnosticInitialize(), LHK_scheduleInitialize(), LHK_taskInitialize(), _LHK_Control::mtx, _LHK_Control::rwi, and _LHK_Control::state.
void LHK_scheduleGet | ( | unsigned int * | fil, | |
unsigned int * | ins | |||
) |
Identify the schedule file in use.
fil | (in) File ID | |
ins | (in) CDM instance ID |
References _LHK_ScheduleTable::cdm, _LHK_ScheduleTable::fil, LHK_lcb, _LHK_Control::table, and _LHK_Control::tused.
unsigned int LHK_start | ( | void | ) |
Start the LHK task.
LHK_CTDBCBFL | Cannot locate the CTDB device | |
LHK_CTDBMISS | Cannot redefine the CTSB housekeeping callback | |
LHK_STARTTSK | Cannot start the task | |
LHK_SUCCESS | Success |
References _LHK_Control::itc, LHK_ctdbCallback(), LHK_CTL_BROKEN, LHK_CTL_INITIALIZED, LHK_CTL_STARTING, LHK_CTL_UNINITIALIZED, _LHK_Control::mtx, _LHK_Control::save_cb_prm, _LHK_Control::save_cb_rtn, _LHK_Control::state, and taskStartOnce().