QDF_acd.h File Reference

Interface to the ACD decoding routines. More...

#include <LDT/BFU.h>

Typedefs
typedef struct _QDF_acdEvt	QDF_acdEvt
typedef struct _QDF_acdCtx	QDF_acdCtx
typedef struct _QDF_esbEvt	QDF_esbEvt
typedef struct _QDF_gemEvt	QDF_gemEvt
typedef struct _QFR_fileCtx	QFR_fileCtx
typedef struct _QSE_ctx	QSE_ctx
typedef struct _QDF_exc	QDF_exc
typedef struct _CDF_acdBdy	CDF_acdBdy
Functions
int	QDF_acdCtxSizeof (unsigned int level, void *prm)
	Returns the size, in bytes of the ACD decoding context needed to support the specified compression level.
QDF_acdCtx *	QDF_acdCtxConstruct (QDF_acdCtx *ctx, unsigned int level, void *prm, const QSE_ctx *qse)
	Constructs (initializes) the specified ACD decoding context structure.
int	QDF_acdCtxUpdate (QDF_acdCtx *ctx, QFR_fileCtx *qfr, const CDF_acdBdy *bdy)
	Updates the ACD context from the datagram contribution.
int	QDF_acdEvtSizeof (unsigned int level, void *prm)
	Returns the size, in bytes of QDF_acd event needed to support the specified compression level.
QDF_acdEvt *	QDF_acdEvtConstruct (QDF_acdEvt *evt, unsigned int level, void *prm, QDF_exc *exc, QDF_esbEvt *esb, QDF_gemEvt *gem)
	Constructs (initializes) the specified ACD event structure.
BFU	QDF_acdStdDecode (QDF_acdCtx *ctx, QDF_acdEvt *evt, const unsigned int *src, unsigned int max, BFU bfu)
	Decodes the ACD.
BFU	QDF_acdPedDecode (QDF_acdCtx *ctx, QDF_acdEvt *evt, const unsigned int *src, unsigned int max, BFU bfu)
	Decodes the ACD.

---

Detailed Description

Interface to the ACD decoding routines.

Author:

JJRussell - russell@slac.stanford.edu

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

---

Function Documentation

QDF_acdCtx* QDF_acdCtxConstruct	(	QDF_acdCtx *	ctx,
		unsigned int	level,
		void *	prm,
		const QSE_ctx *	qse
	)

Constructs (initializes) the specified ACD 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.
	prm	Additional configuation parameter, unused as of now
	qse	The generic datagram context

References _QDF_acdCtx::hdd, and _QDF_acdCtx::opts.

int QDF_acdCtxSizeof	(	unsigned int	level,
		void *	prm
	)

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

Returns:

The size, in bytes, of the ACD decoding context

Parameters:

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

int QDF_acdCtxUpdate	(	QDF_acdCtx *	ctx,
		QFR_fileCtx *	qfr,
		const CDF_acdBdy *	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 acdCtxPedsConstruct(), and _QDF_acdCtx::key.

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

Constructs (initializes) the specified ACD event structure.

Returns:

Pointer to the context structure to construct

Parameters:

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

References _QDF_acdStdEvt::aem, _QSE_aem::cable, _QDF_acdHdrEvt::esb, _QDF_acdHdrEvt::exc, _QDF_acdHdrEvt::gem, _QDF_acdPedEvt::hdr, _QDF_acdStdEvt::hdr, _QSE_aem_cableStatus::hdr_parity, _QDF_acdEvt::ped, _QSE_aem_cableStatus::pha_overrun, _QSE_aem_cableStatus::pha_parity, _QSE_aem_cableStatus::pha_underrun, QDF_gemEvtGemGet(), _QSE_aem::remaining, _QSE_aem_cableStatus::rsvd, _QSE_aem::rsvd, _QDF_acdEvt::std, and _QSE_aem_cableStatus::timeout.

int QDF_acdEvtSizeof	(	unsigned int	level,
		void *	prm
	)

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

Returns:

The size, in bytes, of the ACD event

Parameters:

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

BFU QDF_acdPedDecode	(	QDF_acdCtx *	ctx,
		QDF_acdEvt *	evt,
		const unsigned int *	src,
		const unsigned int	max,
		BFU	bfu
	)

Decodes the ACD.

Returns:

The updated bit position and current deblocked 32-bit buffer

Parameters:

	ctx	The compressed data decoding context
	evt	The ACD 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

This routine is a simple dispatcher, extracting the formatting style, then dispatching to the appropriate decoding routine.

References acd_ped_style_0(), acd_ped_style_1(), acd_ped_style_2(), and acd_ped_style_3().

BFU QDF_acdStdDecode	(	QDF_acdCtx *	ctx,
		QDF_acdEvt *	evt,
		const unsigned int *	src,
		const unsigned int	max,
		BFU	bfu
	)

Decodes the ACD.

Returns:

The updated bit position and current deblocked 32-bit buffer

Parameters:

	ctx	The compressed data decoding context
	evt	The ACD 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 acd_std_unpack(), and _QDF_acdEvt::std.