FILE_upl_private.h File Reference

Private definitions for file upload state machine. More...

#include <PBS/RW.h>
#include <MSG/MSG_pubdefs.h>

Classes
struct	_FILE_Upl
Defines
#define	FILE_UPL_MSG(_status, _param)   _msg_report((_status), 0, 1, (_param))
#define	FILE_UPL_LOCK()   RW_lock(&upl->info_lock)
#define	FILE_UPL_UNLOCK(_key)   RW_unlock(&upl->info_lock, (_key))
#define	FILE_UPL_CLEAR   0x55

---

Detailed Description

Private definitions for file upload state machine.

Author:

D.L. Wood

---

Define Documentation

#define FILE_UPL_CLEAR   0x55

The data pattern written to the file upload buffer when reset.

Referenced by FILE_uplReset().

 

#define FILE_UPL_LOCK

(

)

RW_lock(&upl->info_lock)

Configuration-dependent lock macro for information protetion. For boot configuration, a no-op. For application configuration, calls RW_lock().

Referenced by FILE_uplCommit(), FILE_uplData(), FILE_uplInfo(), FILE_uplReset(), FILE_uplSetError(), FILE_uplStart(), and FILE_uplVerify().

#define FILE_UPL_MSG	(	_status,
		_param		)	_msg_report((_status), 0, 1, (_param))

Configuration-dependent message signaller. For boot configuration, a no-op. For application configuration, calls _msg_report().

Parameters:

	_status	The variable holding the status code.
	_param	The MSG specific parameter value.

Referenced by FILE_uplCancel(), FILE_uplCommit(), FILE_uplData(), FILE_uplError(), FILE_uplExit(), FILE_uplInfo(), FILE_uplInit(), FILE_uplPkt(), FILE_uplReset(), FILE_uplSetError(), FILE_uplStart(), and FILE_uplVerify().

#define FILE_UPL_UNLOCK

(

_key

)

RW_unlock(&upl->info_lock, (_key))

Configuration-dependent unlock macro for information protetion. For boot configuration, a no-op. For application configuration, calls RW_unlock().

Parameters:

_key

The key obtained from FILE_UPL_LOCK().

Referenced by FILE_uplCommit(), FILE_uplData(), FILE_uplInfo(), FILE_uplReset(), FILE_uplSetError(), FILE_uplStart(), and FILE_uplVerify().