QDF_err.c File Reference

Generic sizeof and construct for decoding the ERR data when in the encoded in standard fashion. More...

#include <QSE/QDF_err.h>
#include <QSE/QDF_exc.h>
#include <QDF_esb_def.h>
#include <QDF_err_def.h>
#include <QDF_exc_def.h>
#include <PBI/FFS.ih>
#include <stdio.h>

Defines
#define	NULL   ((void *)0)
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 *ctx, QFR_fileCtx *qfr, CDF_errBdy const *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.
static __inline unsigned int	phase_construct (unsigned int tag)
	Constructs the phase word from the tag value.
static BFU	qdf_not_tov_decode (QDF_errTem *tem, QDF_errEvt *evt, unsigned int tag, unsigned int *ctids, int tid, unsigned int mask, BFU bfu, unsigned int const *src)
static BFU	qdf_tov_decode (QDF_errTem *tem, BFU bfu, unsigned int const *src)
	Decode TKR FIFO Overflow blocks.
BFU	QDF_errDecode (QDF_errCtx *ctx, QDF_errEvt *evt, unsigned int const *src, unsigned int max, BFU bfu)
	Decodes the ERR block.
BFU	QDF_errCDecode (QDF_errCtx *ctx, QDF_errEvt *evt, unsigned int const *src, unsigned int max, BFU bfu)
	Decodes the ERR block for Version 3 events.

---

Detailed Description

Generic sizeof and construct for decoding the ERR data when in the encoded in standard fashion.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QDF_err.c,v 1.4 2012/11/30 18:21:49 russell Exp $

---

Function Documentation

static __inline unsigned int phase_construct

(

unsigned int

tag

)

[static]

Constructs the phase word from the tag value.

Returns:

The value of the phase error word

Parameters:

tag

The low 2 bits of the event sequence number

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

Decodes the ERR block for Version 3 events.

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

The erroring events in Version 3 are dominated by TKR FIFO overflow blocks.

References _QDF_esw::bf, _QDF_errEvt::cal_map, _QDF_esbEvt::err_ids, _QDF_errEvt::esb, _QDF_esbEvt::esw, _QDF_errEvt::map, qdf_tov_decode(), _QDF_errEvt::tag, _QDF_errEvt::tems, and _QDF_errEvt::tkr_map.

QDF_esbCtx * 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_errEvt::cal_map, _QDF_esbEvt::err_ids, _QDF_errEvt::esb, _QDF_esbEvt::esw, _QDF_errEvt::map, _QDF_errEvt::tag, _QDF_errEvt::tems, and _QDF_errEvt::tkr_map.

QDF_esbCtx * 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().