csl_tcp2aux.h

Dm6455 driver,magbe useful to you!

 *
 *   <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_statWaitOutParm ()){
		...
		}
	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statWaitOutParm (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_ROP);
}

/** ============================================================================
 *   @n@b TCP2_statEmuHalt 
 *
 *   @b Description
 *   @n This function returns the emuhalt bit status indicating whether the 
 *		TCP is halted due to emulation.
 *
 *   @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_statEmuHalt ()){
		...
		}
	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statEmuHalt (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_EMUHALT);
}

/** ============================================================================
 *   @n@b TCP2_statActMap 
 *
 *   @b Description
 *   @n This function returns the active_map bit status indicating whether 
 *		the TCP MAP 0 is active (0) or the TCP MAP 1 is active (1).
 *
 *   @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_statActMap ();
	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statActMap (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_ACTIVE_MAP);
}

/** ============================================================================
 *   @n@b TCP2_statActState 
 *
 *   @b Description
 *   @n This function returns the active_state bit status indicating the 
 *		active TCP MAP decoder state.
 *
 *   @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 activeState;
		.....
		activeState = TCP2_statActState ();
	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statActState (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_ACTIVE_STATE);
}

/** ============================================================================
 *   @n@b TCP2_statActIter
 *
 *   @b Description
 *   @n This function returns the active_iter bit status indicating the 
 *		active TCP iteration.
 *
 *   @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 activeIter;
		.....
		activeIter = TCP2_statActIter ();
	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statActIter (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_ACTIVE_ITER);
}

/** ============================================================================
 *   @n@b TCP2_statSnr
 *
 *   @b Description
 *   @n This function returns the snr_exceed bits, indicating whether the 
 *		TCP MAP 0 or MAP 1 passed the SNR criteria in a particular iteration.
 *		0 - All fail
 *		1 - MAP 1 failed
 *		2 - MAP 0 failed
 *		3 - All passed
 *
 *   @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 snrExceed;
		.....
		snrExceed = TCP2_statSnr ();
	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statSnr (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_SNR_EXCEED);
}

/** ============================================================================
 *   @n@b TCP2_statCrc
 *
 *   @b Description
 *   @n This function returns the crc_pass bit boolean status indicating whether 
 *		the TCP passed CRC check.
 *
 *   @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_statCrc ()){
		...
		} 
	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statCrc (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_CRC_PASS);
}

/** ============================================================================
 *   @n@b TCP2_statTcpState 
 *
 *   @b Description
 *   @n This function returns the state of the TCP state machine for 
 *		the standalone mode or shared processing 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
			Uint32 tcpState;
			....
			tcpState = TCP2_statTcpState ();

	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_statTcpState (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPSTAT, TCP2_TCPSTAT_TCP_STATE);
}

/** ============================================================================
 *   @n@b TCP2_getExecStatus
 *
 *   @b Description
 *   @n This function returns the TCPSTAT register value.
 *
 *   @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 tcpStatus;

		tcpStatus = TCP2_getExecStatus ();
        
     @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_getExecStatus (
	void
) 
{
	return (tcp2Regs->TCPSTAT);
}
 
/** ============================================================================
 *   @n@b TCP2_getExtEndian 
 *
 *   @b Description
 *   @n This function returns the value programmed into the TCP_END register 
 *		for the extrinsics data indicating whether the data is in its native 
 *		8-bit format ('1') or consists of values packed in little endian format 
 *		into 32-bit words ('0'). This should always be '0' for little endian 
 *		operation.
 *
 *   @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_getExtEndian ()){
		...
		} 

	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_getExtEndian (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPEND, TCP2_TCPEND_ENDIAN_EXTR);
}

/** ============================================================================
 *   @n@b TCP2_getInterEndian 
 *
 *   @b Description
 *   @n Returns the value programmed into the TCP_END register for the 
 *		interleaver table data indicating whether the data is in its native 
 *		8-bit format ('1') or consists of values packed in little endian format 
 *		into 32-bit words ('0'). This should always be '0' for little endian 
 *		operation.
 *
 *   @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_getInterEndian ()){
		...
		} 

	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_getInterEndian (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPEND, TCP2_TCPEND_ENDIAN_INTR);
}

/** ============================================================================
 *   @n@b TCP2_getSlpzvss 
 *
 *   @b Description
 *   @n This function gets the configuration of the internal control of 
 *		the slpzvss.
 *
 *   @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_getSlpzvss ()){
		...
		} 

	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_getSlpzvss (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPEND, TCP2_TCPEND_SLPZVSS_EN);
}

/** ============================================================================
 *   @n@b TCP2_getSlpzvdd 
 *
 *   @b Description
 *   @n This function gets the configuration of the internal control of 
 *		the slpzvdd.
 *
 *   @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_getSlpzvdd ()){
		...
		} 

	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE Uint32 TCP2_getSlpzvdd (
	void
) 
{
	return CSL_FEXT (tcp2Regs->TCPEND, TCP2_TCPEND_SLPZVDD_EN);
}

/** ============================================================================
 *   @n@b TCP2_setExtEndian 
 *
 *   @b Description
 *   @n This function programs TCP to view the format of the extrinsics data 
 *		as either native 8-bit format ('1') or values packed into 32-bit words 
 * 		in little endian format ('0'). This should always be '0' for little 
 *		endian operation.
 *
 *   @b Arguments
     @verbatim
           endianMode      Endian setting for extrinsics data
     @endverbatim
 *
 *   <b> Return Value </b> 
 *	 @n	 None	
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *	 @n	TCPEND register bit for the extrinsics data is configured in the 
 *		mode passed. 
 *
 *   @b Modifies
 *   @n TCPEND register
 *
 *   @b Example
 *   @verbatim
		TCP2_setExtEndian (1);  

	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE void TCP2_setExtEndian (
    Uint32    endianMode	
) 
{
	CSL_FINS (tcp2Regs->TCPEND, TCP2_TCPEND_ENDIAN_EXTR, endianMode);

	return;
}

/** ============================================================================
 *   @n@b TCP2_setInterEndian
 *
 *   @b Description
 *   @n This function programs TCP to view the format of the interleaver data 
 *		as either native 8-bit format ('1') or values packed into 32-bit words 
 * 		in little endian format ('0'). This should always be '0' for little 
 *		endian operation.
 *
 *   @b Arguments
     @verbatim
            endianMode       Endian setting for interleaver data
     @endverbatim
 *
 *   <b> Return Value </b> 
 *	 @n	 None	
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *	 @n	TCPEND register bit for the interleaver data is configured in the 
 *		mode passed. 
 *
 *   @b Modifies
 *   @n TCPEND register
 *
 *   @b Example
 *   @verbatim
		TCP2_setInterEndian (1);
         

	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE void TCP2_setInterEndian (
    Uint32    endianMode	
) 
{
	CSL_FINS (tcp2Regs->TCPEND, TCP2_TCPEND_ENDIAN_INTR, endianMode);

	return;
}

/** ============================================================================
 *   @n@b TCP2_setNativeEndian 
 *
 *   @b Description
 *   @n This function programs the TCP to view the format of all data as 
 *		native 8/16 bit format. This should only be used when running in 
 *		big endian mode.
 *
 *   @b Arguments
 *	 @n	None	
 *
 *   <b> Return Value </b> 
 *	 @n	 None	
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *	 @n	TCPEND register configured to native mode for all data. 
 *
 *   @b Modifies
 *   @n TCPEND register
 *
 *   @b Example
 *   @verbatim
		TCP2_setNativeEndian ();

	 @endverbatim
 * =============================================================================
 */
CSL_IDEF_INLINE void TCP2_setNativeEndian (
	void	
) 
{
	CSL_FINST (tcp2Regs->TCPEND, TCP2_TCPEND_ENDIAN_INTR, NATIVE16);
	CSL_FINST (tcp2Regs->TCPEND, TCP2_TCPEND_ENDIAN_EXTR, NATIVE8);

	return;
}

/** ============================================================================