CDFP.c File Reference

Generic compression routines. More...

#include <LSEP/LSEP_ids.h>
#include <CDFP.h>
#include <CDFP_def.h>
#include <LSE/CDF_esb.h>
#include <LSE/CDF_gem.h>
#include <LSE/CDF_acd.h>
#include <LSE/CDF_cal.h>
#include <LSE/CDF_tkr.h>
#include <LSE/CDF_dgn.h>
#include <LSE/CDF_err.h>
#include <LDT/HDE.h>
#include <PBI/PTR.h>
#include <string.h>

Defines
#define	RND8N(_n)   PTR_RND (_n, 8)
#define	RND8P(_p)   ((void *)(PTR_RND (_p, 8)))
Functions
static __inline unsigned int *	composeCtb (CDFP_ctxCtb *ctb, const CDFP_ctx *cdfp)
	Composes the CDF LSF contribution.
int	CDFP_cfg_sizeof (int level)
	Returns the size, in bytes, of the compression configuration needed to support the specified compression level.
int	CDFP_cfg_construct (CDFP_cfg *cfg, int level)
	Constructs (initializes) the compression configuration for the appropriate level.
int	CDFP_sizeof (int level, void *cfg)
	Returns the size, in bytes, of the compression structure needed to supprot the specified compression level.
int	CDFP_construct (CDFP_ctx *cdfp, int level, const CDFP_cfg *cfg, LSEW_dgmFw *dgmFw, LSEPW *lsepw)
	Constructs (initializes) the compression structure for the appropriate level.
unsigned int *	CDFP_begin_add (CDFP_ctx *cdfp, unsigned int *beg, unsigned int len32)
	Begin datagram callback routine.

---

Detailed Description

Generic compression routines.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: CDFP.c,v 1.5 2011/03/26 23:32:30 russell Exp $

---

Function Documentation

unsigned int* CDFP_begin_add	(	CDFP_ctx *	cdfp,
		unsigned int *	beg,
		unsigned int	len32
	)

Begin datagram callback routine.

Returns:

Pointer to the next write location

Parameters:

	cdfp	The Compressed Data Format handle
	beg	The output buffer
	len32	The amount of space, in 32-bit words, available in the output buffer

References _CDFP_ctxCtb::bdy, _CDFP_ctx::ctb, _CDFP_ctxBdy::gem, _CDFP_ctx::gem, and _CDFP_ctxCtb::hdr.

Referenced by beg8_add().

int CDFP_cfg_construct	(	CDFP_cfg *	cfg,
		int	level
	)

Constructs (initializes) the compression configuration for the appropriate level.

Returns:

Status

Parameters:

	cfg	The compression configuratin to initialize
	level	The maximum compression level that needs supporting

Warning:

It is assumed that the caller has used CDFP_cfg_sizeof to determine the amount of storage that is needed and, thus, has assured that the cfg structure is adequately sized.

References _CDFP_cfg::acd, _CDFP_cfg::cal, _CDFP_cfg::dgn, _CDFP_cfg::err, _CDFP_cfg::esb, _CDFP_cfg::gem, and _CDFP_cfg::tkr.

int CDFP_cfg_sizeof

(

int

level

)

Returns the size, in bytes, of the compression configuration needed to support the specified compression level.

Returns:

The size, in bytes, of the compression configuration

Parameters:

level

The maximum compression level to support

int CDFP_construct	(	CDFP_ctx *	cdfp,
		int	level,
		const CDFP_cfg *	cfg,
		LSEW_dgmFw *	dgmFw,
		LSEPW *	lsepw
	)

Constructs (initializes) the compression structure for the appropriate level.

Returns:

Status

Parameters:

	cdfp	The compression context to initialize
	level	The maximum compression level that needs supporting
	cfg	Target specific configuration parameter
	dgmFw	The datagram framework handle
	lsepw	The generic LSEPW services

Warning:

It is assumed that the called has used CDFP_sizeof to determine the amount of storage that is needed and, thus, has assured that the cmp structure is adequately sized.

References _CDFP_cfg::acd, _CDFP_ctx::acd, _CDFP_cfg::cal, _CDFP_ctx::cal, composeCtb(), _CDFP_ctx::ctb, _CDFP_cfg::dgn, _CDFP_ctx::dgn, _CDFP_cfg::err, _CDFP_ctx::err, _CDFP_cfg::esb, _CDFP_ctx::esb, _CDFP_cfg::gem, _CDFP_ctx::gem, _CDFP_ctx::lsepw, _CDFP_cfg::tkr, and _CDFP_ctx::tkr.

Referenced by LSEPW_evt0_construct().

int CDFP_sizeof	(	int	level,
		void *	cfg
	)

Returns the size, in bytes, of the compression structure needed to supprot the specified compression level.

Returns:

The size, in bytes, of the compression structure

Parameters:

	level	The maximum compression level to support
	cfg	Level specific configuration parameter

Referenced by LSEPW_evt0_sizeof().

static __inline unsigned int * composeCtb	(	CDFP_ctxCtb *	ctb,
		const CDFP_ctx *	cdfp
	)			[static]

Composes the CDF LSF contribution.

Returns:

Pointer to the next fill location

Parameters:

	ctb	The contribution to fill
	cdfp	The Compression Data Formatting Physics context

References _CDFP_ctxBdy::acd, _CDFP_ctx::acd, _CDFP_ctxCtb::bdy, _CDFP_ctxBdy::cal, _CDFP_ctx::cal, _CDFP_ctxBdy::gem, _CDFP_ctx::gem, _CDFP_ctxCtb::hdr, LSEP_CDF_K_VERSION, LSEP_ID_K_CDF, _CDFP_ctxBdy::tkr, and _CDFP_ctx::tkr.

Referenced by CDFP_construct().