LIM_bulk.c File Reference

Handle messages to LIM's BULK queue. More...

#include <string.h>
#include <ITC/ITC_drvdefs.h>
#include <ITC/ITC_pubdefs.h>
#include <LIM/LIM_msgs.h>
#include <PBS/INT.ih>
#include <PBS/MBA.h>
#include <LIM_bulk.h>
#include <LIM_pkt_send.h>

Classes
struct	_LIM_Bulk
	State information for a BULK queue object. More...
Defines
#define	INT_FAKE_OK
	Acknowledge that we realize interrupts can't acually be disabled on host machines.
#define	LIM_BULK_VALID_KEY   (('L'<<24)+('B'<<16)+('L'<<8)+'K')
	Value that indicates the BULK queue object state is valid.
Functions
static unsigned int	lim_bulk_check (LIM_Bulk *object_p)
	Validate a BULK queue object pointer.
static void	lim_bulk_free (ITC_QueueItem *qitem_p, unsigned int status_in, void *parm_0, void *parm_1, void *parm_2, unsigned int tx)
	Free the BULK queue item.
unsigned int	LIM_bulk_new (LIM_Bulk **object_pp)
	Create and initialize a new BULK queue object.
unsigned int	LIM_bulk_delete (LIM_Bulk *object_p)
	Shutdown and delete a BULK queue object.
unsigned int	LIM_bulk_send (LIM_Bulk *object_p)
	Send a message to LIM's BULK queue.

---

Detailed Description

Handle messages to LIM's BULK queue.

**  CVS $Id: LIM_bulk.c,v 1.4 2011/03/29 21:20:28 apw Exp $
**  

---

Function Documentation

unsigned int lim_bulk_check

(

LIM_Bulk *

object_p

)

[static]

Validate a BULK queue object pointer.

Parameters:

object_p

Pointer to BULK queue object.

Returns:

MSG code.

References _LIM_Bulk::key, and LIM_BULK_VALID_KEY.

Referenced by LIM_bulk_delete(), lim_bulk_free(), and LIM_bulk_send().

unsigned int LIM_bulk_delete

(

LIM_Bulk *

object_p

)

Shutdown and delete a BULK queue object.

Parameters:

object_p

Pointer to object.

Returns:

MSG code.

References _LIM_Bulk::key, lim_bulk_check(), _LIM_Bulk::qitem_busy, and _LIM_Bulk::qitem_p.

Referenced by LIM_bulk_new(), and LIM_mode_delete().

void lim_bulk_free	(	ITC_QueueItem *	qitem_p,
		unsigned int	status_in,
		void *	parm_0,
		void *	parm_1,
		void *	parm_2,
		unsigned int	tx
	)			[static]

Free the BULK queue item.

Parameters:

	qitem_p	Pointer to queue item.
	status_in	Completion code.
	parm_0	Callback parameter 0 (pointer to BULK object).
	parm_1	Callback parameter 1 (unused).
	parm_2	Callback parameter 2 (unused).
	tx	Flag to indicate sender-side failure (unused).

Returns:

Nothing.

References lim_bulk_check(), _LIM_Bulk::qitem_busy, _LIM_Bulk::qitem_p, and _LIM_Bulk::qitem_send.

Referenced by LIM_bulk_new().

unsigned int LIM_bulk_new

(

LIM_Bulk **

object_pp

)

Create and initialize a new BULK queue object.

Parameters:

object_pp

Location to return pointer to new object.

Returns:

MSG code.

References _LIM_Bulk::key, LIM_bulk_delete(), lim_bulk_free(), LIM_BULK_VALID_KEY, _LIM_Bulk::qitem_busy, _LIM_Bulk::qitem_p, and _LIM_Bulk::qitem_send.

Referenced by LIM_mode_new().

unsigned int LIM_bulk_send

(

LIM_Bulk *

object_p

)

Send a message to LIM's BULK queue.

Parameters:

object_p

Pointer to object.

Returns:

MSG code.

References lim_bulk_check(), _LIM_Bulk::qitem_busy, _LIM_Bulk::qitem_p, and _LIM_Bulk::qitem_send.

Referenced by lim_arr_wut_handler(), LIM_gbm_int_pri_isr(), LIM_gbm_int_red_isr(), lim_sc_wut_handler(), and lim_too_wut_handler().