csl_tcp2aux.h

Dm6455 driver,magbe useful to you!

 *   @n This function returns the OP bit value (1) indicating whether the TCP was 
 *		programmed to transfer output parameters in shared processing mode. 
 *		The output parameters are only valid when operating in standalone mode.
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim
		if (TCP2_getOutParmErr ()){
		...
		} 
     @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_getOutParmErr (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPERR, TCP2_TCPERR_OP);
}
 
/** ============================================================================
 *   @n@b TCP2_getMaxMinErr 
 *
 *   @b Description
 *   @n This function returns the MAXMINITER bit value indicating whether the 
 *		TCP was programmed with the minimum iterations value greater than the 
 *		maximum iterations.
 *		0 = no error, 1 = min_iter > max_iter
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim
		if (TCP2_getMaxMinErr ()){
		...
		} 
     @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_getMaxMinErr (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPERR, TCP2_TCPERR_MAXMINITER);
}
 
/** ============================================================================
 *   @n@b TCP2_getNumIt 
 *
 *   @b Description
 *   @n This function returns the number of decoded iterations of the TCP in 
 *      standalone processing mode. This function reads the output parameters 
 *      register. Alternatively, the EDMA can be used to transfer the output 
 *      parameters following the hard decisions (recommended).
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim
        Uint32  numIter;
        
		numIter = TCP2_getNumIt ();
        
     @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_getNumIt (
	void
) 
{
	return CSL_FEXT (tcp2CfgRegs->TCPOUT0, TCP2_TCPOUT0_FINAL_ITER);
}

/** ============================================================================
 *   @n@b TCP2_getSnrM1 
 *
 *   @b Description
 *   @n This function returns the 1st moment of SNR calculation. This function 
 *      reads the output parameters register. Alternatively, the EDMA can be 
 *      used to transfer the output parameters following the hard decisions 
 *      (recommended).
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim

		Uint32 snrM1;

		snrM1 = TCP2_getSnrM1 ();
     @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_getSnrM1 (
	void
) 
{
	return CSL_FEXT (tcp2CfgRegs->TCPOUT0, TCP2_TCPOUT0_SNR_M1);
}

/** ============================================================================
 *   @n@b TCP2_getSnrM2 
 *
 *   @b Description
 *   @n This function returns the 2nd moment of SNR calculation. This function 
 *      reads the output parameters register. Alternatively, the EDMA can be 
 *      used to transfer the output parameters following the hard decisions 
 *      (recommended).
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim

		Uint32 snrM2;

		snrM2 = TCP2_getSnrM2 ();
     @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_getSnrM2 (
	void
) 
{
	return CSL_FEXT (tcp2CfgRegs->TCPOUT1, TCP2_TCPOUT1_SNR_M2);
}

/** ============================================================================
 *   @n@b TCP2_getMap
 *
 *   @b Description
 *   @n This function returns the active MAP of the TCP.
 *		0 - MAP 0 is active
 *		1 - MAP 1 is active
 *      This function reads the output parameters register. Alternatively, 
 *      the EDMA can be used to transfer the output parameters following the 
 *      hard decisions (recommended).
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim
		Uint32 activeMap;

		activeMap = TCP2_getMap ();
        
     @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_getMap (
	void
) 
{
	return CSL_FEXT (tcp2CfgRegs->TCPOUT1, TCP2_TCPOUT1_ACTIVE_MAP);
}

/** ============================================================================
 *   @n@b TCP2_getMap0Err
 *
 *   @b Description
 *   @n This function returns the number of re-encode errors for MAP 0.
 *      This function reads the output parameters register. Alternatively, 
 *      the EDMA can be used to transfer the output parameters following the 
 *      hard decisions (recommended).
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim
		Uint32 map0Err;

		map0Err = TCP2_getMap0Err ();
        
     @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_getMap0Err (
	void
) 
{
	return CSL_FEXT (tcp2CfgRegs->TCPOUT2, TCP2_TCPOUT2_CNT_RE_MAP0);
}

/** ============================================================================
 *   @n@b TCP2_getMap1Err
 *
 *   @b Description
 *   @n This function returns the number of re-encode errors for MAP 1.
 *      This function reads the output parameters register. Alternatively, 
 *      the EDMA can be used to transfer the output parameters following the 
 *      hard decisions (recommended).
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim
		Uint32 map1Err;

		map1Err = TCP2_getMap1Err ();
        
     @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_getMap1Err (
	void
) 
{
	return CSL_FEXT (tcp2CfgRegs->TCPOUT2, TCP2_TCPOUT2_CNT_RE_MAP1);
}

/** ============================================================================
 *   @n@b TCP2_statRun 
 *
 *   @b Description
 *   @n This function returns a boolean status indicating whether the TCP MAP 
 *		decoder is in state 0 or state 1-8 (running or not).
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim
		while (!TCP2_statRun());
     @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statRun (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_DEC_BUSY);
}
 
/** ============================================================================
 *   @n@b TCP2_statError 
 *
 *   @b Description
 *   @n This function returns the ERR bit value indicating whether any TCP 
 *		error has occurred.
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim
		if (TCP2_statError ()){
		...
		}
	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statError (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_ERR);
}
 
/** ============================================================================
 *   @n@b TCP2_statWaitIc 
 *
 *   @b Description
 *   @n This function returns the WIC bit status indicating whether the TCP 
 *		is waiting to receive new IC values.
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim
		if (TCP2_statWaitIc ()){
		...
		}
	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statWaitIc (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_WIC);
}
 
/** ============================================================================
 *   @n@b TCP2_statWaitInter 
 *
 *   @b Description
 *   @n This function returns the WINT status indicating whether the TCP is 
 *		waiting to receive interleaver table data.
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim
		if (TCP2_statWaitInter ()){
		...
		}
	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statWaitInter (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_WINT);
}
 
/** ============================================================================
 *   @n@b TCP2_statWaitSysPar 
 *
 *   @b Description
 *   @n This function returns the WSP bit status indicating whether the TCP 
 *		is waiting to receive systematic and parity data.
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim
		if (TCP2_statWaitSysPar ()){
		...
		}
	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statWaitSysPar (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_WSP);
}
 
/** ============================================================================
 *   @n@b TCP2_statWaitApriori 
 *
 *   @b Description
 *   @n This function returns the WAP bit status indicating whether the TCP is 
 *		waiting to receive apriori data.
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim
		if (TCP2_statWaitApriori ()){
		...
		}
	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statWaitApriori (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_WAP);
}
 
/** ============================================================================
 *   @n@b TCP2_statWaitExt 
 *
 *   @b Description
 *   @n This function returns the REXT bit status indicating whether the TCP 
 *		is waiting for extrinsic data to be read.
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim
		if (TCP2_statWaitExt ()){
		...
		}
	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statWaitExt (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_REXT);
}
 
/** ============================================================================
 *   @n@b TCP2_statWaitHardDec 
 *
 *   @b Description
 *   @n This function returns the RHD bit status indicating whether the TCP 
 *		is waiting for the hard decisions data to be read.
 *
 *   @b Arguments
 *	 @n	None
 *
 *   <b> Return Value </b>  Uint32
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n None
 *
 *   @b Example
 *   @verbatim
		if (TCP2_statWaitHardDec ()){
		...
		}
	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statWaitHardDec (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_RHD);
}

/** ============================================================================
 *   @n@b TCP2_statWaitOutParm 
 *
 *   @b Description
 *   @n This function returns the ROP bit status indicating whether the TCP 
 *		is waiting for the output parameters to be read.
 *
 *   @b Arguments
 *	 @n	None