QDF_tkr.h File Reference

Interface to the TKR decoding routines. More...

#include <LDT/BFU.h>

Typedefs
typedef struct _QDF_tkrCache	QDF_tkrCache
typedef struct _QDF_tkrEvt	QDF_tkrEvt
typedef struct _QDF_tkrCtx	QDF_tkrCtx
typedef struct _QDF_esbEvt	QDF_esbEvt
typedef struct _QDF_gemEvt	QDF_gemEvt
typedef struct _QDF_errEvt	QDF_errEvt
typedef struct _QSE_ctx	QSE_ctx
typedef struct _QDF_exc	QDF_exc
typedef struct _QFR_fileCtx	QFR_fileCtx
typedef struct _CDF_tkrBdy	CDF_tkrBdy
Functions
int	QDF_tkrCtxSizeof (unsigned int level, void *prm)
	Returns the size, in bytes of the TKR decoding context needed to support the specified compression level.
QDF_tkrCtx *	QDF_tkrCtxConstruct (QDF_tkrCtx *ctx, unsigned int level, QDF_tkrCache *cache, const QSE_ctx *qse)
	Constructs (initializes) the specified TKR decoding context structure.
int	QDF_tkrCtxUpdate (QDF_tkrCtx *tkr, QFR_fileCtx *qfr, const CDF_tkrBdy *bdy)
	Updates the ACD context from the datagram contribution.
int	QDF_tkrEvtSizeof (unsigned int level, void *prm)
	Returns the size, in bytes of QDF_tkr event needed to support the specified compression level.
QDF_tkrEvt *	QDF_tkrEvtConstruct (QDF_tkrEvt *evt, unsigned int level, void *prm, QDF_exc *exc, QDF_esbEvt *esb, QDF_gemEvt *gem, QDF_errEvt *err)
	Constructs (initializes) the specified TKR event structure.
BFU	QDF_tkrStdDecode (QDF_tkrCtx *ctx, QDF_tkrEvt *tkr, const unsigned int *src, unsigned int max, BFU bfu)
	Decodes the TKR.
BFU	QDF_tkrErrDecode (QDF_tkrCtx *ctx, QDF_tkrEvt *tkr, const unsigned int *src, unsigned int max, BFU bfu)
	Decodes the TKR error blocks.
BFU	QDF_tkrPedDecode (QDF_tkrCtx *ctx, QDF_tkrEvt *tkr, const unsigned int *src, unsigned int max, BFU bfu)
	Decodes the TKR.

---

Detailed Description

Interface to the TKR decoding routines.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QDF_tkr.h,v 1.5 2011/03/27 01:45:43 russell Exp $

---

Function Documentation

QDF_tkrCtx* QDF_tkrCtxConstruct	(	QDF_tkrCtx *	ctx,
		unsigned int	level,
		QDF_tkrCache *	cache,
		const QSE_ctx *	qse
	)

Constructs (initializes) the specified TKR decoding context structure.

Returns:

Pointer to the context structure to construct

Parameters:

	ctx	The context structure to construct.
	level	The maximum level of compression that will be supported.
	cache	The TKR caches
	qse	Pointer to the public/generic QSE context parameter

References _QDF_tkrCtx::cache, _QDF_tkrCtx::opts, _QDF_tkrCtx::splits, and splits_default_construct().

Referenced by QDF_temCtxConstruct().

int QDF_tkrCtxSizeof	(	unsigned int	level,
		void *	prm
	)

Returns the size, in bytes of the TKR decoding context needed to support the specified compression level.

Returns:

The size, in bytes, of the TKR decoding context

Parameters:

	level	The maximum level of compression that needs to be supported
	prm	Additional configuation parameter, unused as of now

Referenced by QDF_temCtxConstruct(), and QDF_temCtxSizeof().

int QDF_tkrCtxUpdate	(	QDF_tkrCtx *	ctx,
		QFR_fileCtx *	qfr,
		const CDF_tkrBdy *	bdy
	)

Updates the ACD context from the datagram contribution.

Return values:

	0,Success
	0x80000001,Pedestal	file error, not found
	0x80000002,Pedestal	file error, checksum does not match

Parameters:

	ctx	The context to update
	qfr	The file translation context
	bdy	The update information

References _QDF_tkrCtx::key, _QDF_tkrCtx::splits, splits_default_construct(), and tkrCtxCfgConstruct().

BFU QDF_tkrErrDecode	(	QDF_tkrCtx *	ctx,
		QDF_tkrEvt *	evt,
		const unsigned int *	src,
		const unsigned int	max,
		BFU	bfu
	)

Decodes the TKR error blocks.

Returns:

The updated bit position and current deblocked 32-bit buffer

Parameters:

	ctx	The TKR compressed data decoding context
	evt	The TKR event block to fill in
	src	The data source, i.e. the bit stream
	max	The maximum bit position
	bfu	The current bit position and temporary buffer

References _QDF_tkrEvt::err, _QDF_esbEvt::err_ids, _QDF_tkrEvt::errMap, _QDF_tkrEvt::errTwrs, _QDF_tkrEvt::esb, _QDF_tkrEvt::exc, _QDF_tkrEvt::map, QDF__excStatusCompose(), QDF_excDeclare(), QDF_EXCSUBSYSTEM_K_TKR_TEM, QDF_EXCTYPE_K_ERR, _QDF_tkrTwrErr::style, _QDF_errEvt::tems, _QDF_tkrTwrErr::timeout, tkr_err_unpack_to(), tkr_err_unpack_zcopy(), and _QDF_tkrTwrErr::zcopy.

Referenced by QDF_tkrStdDecode().

QDF_tkrEvt* QDF_tkrEvtConstruct	(	QDF_tkrEvt *	evt,
		unsigned int	level,
		void *	prm,
		QDF_exc *	exc,
		QDF_esbEvt *	esb,
		QDF_gemEvt *	gem,
		QDF_errEvt *	err
	)

Constructs (initializes) the specified TKR event structure.

Returns:

Pointer to the context structure to construct

Parameters:

	evt	The TKR event structure to construct.
	level	The maximum level of compression that will be supported.
	prm	Additional configuation parameter, unused as of now
	exc	Pointer to the global exception handling context
	esb	Pointer to the Event Summary Data for this event
	gem	Pointer to the GEM data for this event
	err	Pointer to the ERR data for this event

References _QDF_tkrEvt::err, _QDF_tkrEvt::esb, and _QDF_tkrEvt::exc.

Referenced by QDF_temEvtConstruct().

int QDF_tkrEvtSizeof	(	unsigned int	level,
		void *	prm
	)

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

Returns:

The size, in bytes, of the TKR event

Parameters:

	level	The maximum level of compression that needs to be supported
	prm	Additional configuation parameter, unused as of now

Referenced by QDF_temEvtConstruct(), and QDF_temEvtSizeof().

BFU QDF_tkrPedDecode	(	QDF_tkrCtx *	ctx,
		QDF_tkrEvt *	evt,
		const unsigned int *	src,
		const unsigned int	max,
		BFU	bfu
	)

Decodes the TKR.

Returns:

The updated bit position and current deblocked 32-bit buffer

Parameters:

	ctx	The TKR compressed data decoding context
	evt	The TKR event block to fill in
	src	The data source, i.e. the bit stream
	max	The maximum bit position
	bfu	The current bit position and temporary buffer

References _QDF_tkrEvt::errMap, _QDF_tkrEvt::map, and QDF_tkrStdDecode().

BFU QDF_tkrStdDecode	(	QDF_tkrCtx *	ctx,
		QDF_tkrEvt *	evt,
		const unsigned int *	src,
		const unsigned int	max,
		BFU	bfu
	)

Decodes the TKR.

Returns:

The updated bit position and current deblocked 32-bit buffer

Parameters:

	ctx	The TKR compressed data decoding context
	evt	The TKR event block to fill in
	src	The data source, i.e. the bit stream
	max	The maximum bit position
	bfu	The current bit position and temporary buffer

References _QDF_esbEvt::err_ids, _QDF_tkrEvt::errMap, _QDF_tkrEvt::esb, _QDF_tkrEvt::map, QDF_tkrErrDecode(), tkr_std_unpack_cnts(), tkr_std_unpack_cwidths(), tkr_std_unpack_hits(), tkr_std_unpack_lyr_maps(), tkr_std_unpack_tots(), and tkr_std_unpack_twr_maps().

Referenced by QDF_tkrPedDecode().