QDF_err.h File Reference

Interface to the ERR record decoding routines. More...

#include <LDT/BFU.h>

Typedefs
typedef struct _QDF_errCache	QDF_errCache
typedef struct _QDF_errEvt	QDF_errEvt
typedef struct _QDF_errCtx	QDF_errCtx
typedef struct _QDF_esbEvt	QDF_esbEvt
typedef struct _QDF_gemEvt	QDF_gemEvt
typedef struct _QSE_ctx	QSE_ctx
typedef struct _QDF_exc	QDF_exc
typedef struct _QFR_fileCtx	QFR_fileCtx
typedef struct _CDF_errBdy	CDF_errBdy
Functions
int	QDF_errCtxSizeof (unsigned int level, void *prm)
	Returns the size, in bytes of the ERR decoding context needed to support the specified compression level.
QDF_errCtx *	QDF_errCtxConstruct (QDF_errCtx *ctx, unsigned int level, QDF_errCache *cache, const QSE_ctx *qse)
	Constructs (initializes) the specified ERR decoding context structure.
int	QDF_errCtxUpdate (QDF_errCtx *err, QFR_fileCtx *qfr, const CDF_errBdy *bdy)
	Updates the ERR context from the datagram contribution.
int	QDF_errEvtSizeof (unsigned int level, void *prm)
	Returns the size, in bytes of QDF_err event needed to support the specified compression level.
QDF_errEvt *	QDF_errEvtConstruct (QDF_errEvt *evt, unsigned int level, void *prm, QDF_exc *exc, QDF_esbEvt *esb, QDF_gemEvt *gem)
	Constructs (initializes) the specified ERR event structure.
BFU	QDF_errDecode (QDF_errCtx *ctx, QDF_errEvt *err, const unsigned int *src, unsigned int max, BFU bfu)
	Decodes the ERR block.
BFU	QDF_errPedDecode (QDF_errCtx *ctx, QDF_errEvt *err, const unsigned int *src, unsigned int max, BFU bfu)

---

Detailed Description

Interface to the ERR record decoding routines.

Author:

JJRussell - russell@slac.stanford.edu

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

---

Function Documentation

QDF_errCtx* QDF_errCtxConstruct	(	QDF_errCtx *	ctx,
		unsigned int	level,
		QDF_errCache *	cache,
		const QSE_ctx *	qse
	)

Constructs (initializes) the specified ERR 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 ERR caches
	qse	Pointer to the public/generic QSE context parameter

Referenced by QDF_temCtxConstruct().

int QDF_errCtxSizeof	(	unsigned int	level,
		void *	prm
	)

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

Returns:

The size, in bytes, of the ERR 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_errCtxUpdate	(	QDF_errCtx *	ctx,
		QFR_fileCtx *	qfr,
		CDF_errBdy const *	bdy
	)

Updates the ERR context from the datagram contribution.

Return values:

0,Success

Parameters:

	ctx	The context to update
	qfr	The file translation context
	bdy	The update information, currently none

BFU QDF_errDecode	(	QDF_errCtx *	ctx,
		QDF_errEvt *	evt,
		unsigned int const *	src,
		unsigned int	max,
		BFU	bfu
	)

Decodes the ERR block.

Returns:

The updated bit position and current deblocked 32-bit buffer

Parameters:

	ctx	The compressed data decoding context
	evt	The ERR 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_esw::bf, _QDF_errTemRepackAll::buga, _QDF_errTemRepackAll::bugb, _QDF_errEvt::cal_map, _QDF_errTemRepackAll::copy, _QDF_esbEvt::err_ids, _QDF_errEvt::esb, _QDF_esbEvt::esw, _QDF_errEvt::exc, _QDF_errTemRepackAll::hdr, _QDF_errTemRepackBugB::hdr, _QDF_errTemRepackBugA::hdr, _QDF_errEvt::map, _QDF_errTemRepackCopy::n16, _QDF_errTemTkr::pe, _QDF_errTemHeader::phase, phase_construct(), _QDF_errTemRepackCopy::pos, _QDF_errTem::prm, QDF__excStatusCompose(), qdf_err_tem_repack_bugA(), qdf_err_tem_repack_bugB(), qdf_err_tem_repack_copy(), QDF_excDeclare(), QDF_EXCSUBSYSTEM_K_TKR_TEM, QDF_EXCTYPE_K_ERR, _QDF_errTem::repack, _QDF_errTemRepackCopy::src, _QDF_errTemHeader::summary, _QDF_errEvt::tag, _QDF_errEvt::tems, _QDF_errTemHeader::timeout, _QDF_errTemRepackBugA::tkr, _QDF_errEvt::tkr_map, and _QDF_errTemTkr::towd.

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

Constructs (initializes) the specified ERR event structure.

Returns:

Pointer to the context structure to construct

Parameters:

	evt	The ERR 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

References _QDF_errEvt::esb, and _QDF_errEvt::exc.

Referenced by QDF_temEvtConstruct().

int QDF_errEvtSizeof	(	unsigned int	level,
		void *	prm
	)

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

Returns:

The size, in bytes, of the ERR 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().