source: svn/trunk/newcon3bcm2_21bu/magnum/portinginterface/xpt/7552/bxpt_mpod.h

/***************************************************************************
 *     Copyright (c) 2003-2011, Broadcom Corporation
 *     All Rights Reserved
 *     Confidential Property of Broadcom Corporation
 *
 *  THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED SOFTWARE LICENSE
 *  AGREEMENT  BETWEEN THE USER AND BROADCOM.  YOU HAVE NO RIGHT TO USE OR
 *  EXPLOIT THIS MATERIAL EXCEPT SUBJECT TO THE TERMS OF SUCH AN AGREEMENT.
 *
 * $brcm_Workfile: bxpt_mpod.h $
 * $brcm_Revision: Hydra_Software_Devel/3 $
 * $brcm_Date: 12/12/11 2:03p $
 *
 * Porting interface code for the MultiPod section of the
 * data transport core. 
 *
 * Revision History:
 *
 * $brcm_Log: /magnum/portinginterface/xpt/base2/bxpt_mpod.h $
 * 
 * Hydra_Software_Devel/3   12/12/11 2:03p gmullen
 * SW7425-1940: Force output clock rate to 27 MHz when in M-Card mode
 * 
 * Hydra_Software_Devel/2   8/22/11 5:45p gmullen
 * SW7231-319: Merged to Hydra branch
 * 
 * Hydra_Software_Devel/SW7231-319/2   8/18/11 11:26a gmullen
 * SW7231-319: Fixed compilation error
 * 
 * Hydra_Software_Devel/SW7231-319/1   8/16/11 2:15p gmullen
 * SW7231-319: Initial support for B0
 * 
 * Hydra_Software_Devel/1   10/25/10 2:09p gmullen
 * SW7425-15: Moved srcs to base2 folder
 * 
 * Hydra_Software_Devel/1   10/8/10 2:57p gmullen
 * SW7425-15: Added header files
 * 
 * Hydra_Software_Devel/18   9/7/10 3:28p gmullen
 * SW7420-1044: Merged to Hydra_Software_Devel
 * 
 * Hydra_Software_Devel/SW7420-1044/1   9/7/10 3:20p gmullen
 * SW7420-1044: Added BXPT_Mpod_RouteToMpodPidFiltered()
 * 
 * Hydra_Software_Devel/17   6/17/09 6:46p gmullen
 * PR56110: Added support.xpt/7550/uif_image/a0
 * 
 * Hydra_Software_Devel/16   4/7/09 5:25p piyushg
 * PR52986: Add support for 7635
 * Added directory element "7635".
 * 
 * Hydra_Software_Devel/15   1/27/09 1:09p gmullen
 * PR51625: Added 7336 support
 * 
 * Hydra_Software_Devel/14   11/26/08 4:14p gmullen
 * PR47755: Added support for 7420.
 * 
 * Hydra_Software_Devel/13   9/12/08 2:21p gmullen
 * PR46659: Added 3556/3548 B0 support
 * 
 * Hydra_Software_Devel/12   7/7/08 11:32a gmullen
 * PR44486: Added support to control Pod2Chip MCLK select.
 * 
 * Hydra_Software_Devel/11   5/21/08 6:20p gmullen
 * PR42923: Added support for S-Card mode. Updated comments for PbBand.
 * 
 * Hydra_Software_Devel/10   5/21/08 3:38p jrubio
 * PR42353: add 7325/7335 support to mpod
 * 
 * Hydra_Software_Devel/9   4/10/08 5:33p gmullen
 * PR41241: Added support for cardbus.
 * 
 * Hydra_Software_Devel/8   3/26/08 11:24a gmullen
 * PR38954: Added 3548 support to XPT PI.
 * 
 * Hydra_Software_Devel/7   2/14/07 1:10p gmullen
 * PR27642: Added support for 7405.
 * 
 * Hydra_Software_Devel/6   2/6/07 7:05p gmullen
 * PR26217: Added B0 support.
 * 
 * Hydra_Software_Devel/5   1/18/07 4:55p katrep
 * PR27188: Enabled Parallel MPOD support for 7403
 * 
 * Hydra_Software_Devel/4   11/2/06 8:40a gmullen
 * PR23189: Added 3563 support.
 * 
 * Hydra_Software_Devel/3   4/12/06 10:15a gmullen
 * PR20631: Added parallel IO support
 * 
 * Hydra_Software_Devel/2   3/31/06 4:12p gmullen
 * PR 15309: To use MPOD, parser band must be in all-pass mode.
 * 
 * Hydra_Software_Devel/1   5/13/05 1:27p gmullen
 * PR15309: First draft of XPT PI.
 * 
 ***************************************************************************/

/*= Module Overview *********************************************************
Overview

To follow later

Sample Code

To follow later
***************************************************************************/

#ifndef BXPT_MPOD_H__
#define BXPT_MPOD_H__

#include "bxpt.h"

#ifdef __cplusplus
extern "C" {
#endif

/***************************************************************************
Summary:
Enumeration of all the output clock rates. 
****************************************************************************/
typedef enum BXPT_Mpod_OutputClockRate
{
    BXPT_Mpod_OutputClockRate_e81,              /* 81 MHz */
    BXPT_Mpod_OutputClockRate_e54,              /* 54 MHz */
    BXPT_Mpod_OutputClockRate_e40_50,           /* 40.5 MHz */
    BXPT_Mpod_OutputClockRate_e20_25,           /* 20.25 MHz */
    BXPT_Mpod_OutputClockRate_e27,              /* 27 MHz */
    BXPT_Mpod_OutputClockRate_ePll,              /* PLL clock */
    BXPT_Mpod_OutputClockRate_e108,              /* 108 MHz clock */

    BXPT_Mpod_OutputClockRate_eIb0 = 0x8,        /* Input band 0 clock */
    BXPT_Mpod_OutputClockRate_eIb1,              /* Input band 1 clock */
    BXPT_Mpod_OutputClockRate_eIb2,              /* Input band 2 clock */
    BXPT_Mpod_OutputClockRate_eIb3,              /* Input band 3 clock */
    BXPT_Mpod_OutputClockRate_eIb4,              /* Input band 4 clock */
    BXPT_Mpod_OutputClockRate_eIb5,              /* Input band 5 clock */
    BXPT_Mpod_OutputClockRate_eIb6,              /* Input band 6 clock */
    BXPT_Mpod_OutputClockRate_eIb7,              /* Input band 7 clock */
    BXPT_Mpod_OutputClockRate_eIb8,              /* Input band 8 clock */

    BXPT_Mpod_OutputClockRate_eMax              /* End of the enum list */
}
BXPT_Mpod_OutputClockRate;

/***************************************************************************
Summary 
Output clock rate divider.
****************************************************************************/
typedef enum BXPT_Mpod_OutputClockDivider
{
    BXPT_Mpod_OutputClockDivider_eNone,  /* No divider */
    BXPT_Mpod_OutputClockDivider_e12,    /* Divide clock by 12 */
    BXPT_Mpod_OutputClockDivider_e9,     /* Divide clock by 9 */
    BXPT_Mpod_OutputClockDivider_e8,     /* Divide clock by 8 */
    BXPT_Mpod_OutputClockDivider_e4,     /* Divide clock by 4 */
    BXPT_Mpod_OutputClockDivider_eMax
}
BXPT_Mpod_OutputClockDivider;

/***************************************************************************
Summary:
Configuration settings to used during BXPT_Mpod_Init(). 
****************************************************************************/
typedef struct BXPT_Mpod_Config
{   
    /* Ouput Interface Formatter Control */
    unsigned char ByteSync;
    unsigned char ClkNrun;
    unsigned char InvertClk;
    unsigned char NshiftClk;
    unsigned char OutputInvertSync;

    /* Input Interface Formatter Control */
    unsigned char InputInvertSync;

    /* S-Mode is enabled when true, M-Mode when false */
    bool SmodeEn;   

    /* 
    ** Value inserted into the Host_reserved field of the 12-byte 
    ** pre-header when HostRsvdEn is true. 
    */
    unsigned int    HostRsvd; 
    bool HostRsvdEn;

    /* Output clock delay, in 9.26 nS steps */
    unsigned int    ClkDelay;   

    /* Invert the VALID and CLK signals. S-Mode only. */
    bool OutputInvertValid;
    bool InputInvertValid;
    bool InputInvertClk;

    /* 
    ** Parser band used for data that originates in the S-Pod. This is
    ** interpreted as an playback parser band number if PbBand is true. Otherwise,
    ** the data is identified as an input band parser. Note that BandEn
    ** must be true to enable BandNo and PbBand. This value should be programmed 
    ** if the single stream transport does not originate from either the chip's 
    ** InBand or Playback paths but, instead originates from the S-Card itself.  
    ** In this case, an unused InBand or Playback parser path would have to be 
    ** chosen for downstream PID parsing of the incoming single transport stream 
    ** from the S-Card (S-Mode only).
    */
    unsigned char BandNo;
    bool PbBand;
    bool BandEn;

    /* 
    ** Replace the timestamp received from the interface with a new
    ** internally generated one.
    */
    bool TimestampInsertEn;

    /* Loopback mode, for tests only. */
    bool Loopback;

    /* Support for the parallel interface.  */
        bool ParallelEn;

    /* Output interface clock rate or source */
    BXPT_Mpod_OutputClockRate OutputClockRate;
    BXPT_Mpod_OutputClockDivider OutputClockDivider;

    /* Delay between packets on the output interface. Specified in clocks. */
    unsigned OutputPacketDelayCount;
}
BXPT_Mpod_Config;

/***************************************************************************
Summary:
Get the default config for the MultiPod interface.

Description:
Copy the default settings for the MultiPod registers into the Config 
structure, which is then used in a subsequent call to BXPT_Mpod_Init(). The
user can customize the default values as needed before calling BXPT_Mpod_Init().

Returns:
    void

See Also:
BXPT_Mpod_Init
****************************************************************************/
void BXPT_Mpod_GetDefaultConfig(
    BXPT_Handle hXpt,                           /* [in] Handle for this transport */
    BXPT_Mpod_Config *Config
    );  

/***************************************************************************
Summary:
Initialize the MultiPod interface.

Description:
The initial configuration of the MultiPod interface is loaded, then the interface
is enabled. Custom configuration is supported by setting the members of the
BXPT_Mpod_Config struct. After initializing the interface, parser data can
be sent through the interface by calling BXPT_Mpod_RouteToMpod().

Returns:
    BERR_SUCCESS                - MultiPod interface initialized.

See Also:
BXPT_Mpod_Shutdown, BXPT_Mpod_RouteToMpod
****************************************************************************/
BERR_Code BXPT_Mpod_Init(
    BXPT_Handle hXpt,                           /* [in] Handle for this transport */
    const BXPT_Mpod_Config *Config
    );  

/***************************************************************************
Summary:
Shutdown the MultiPod interface.

Description:
All parser bands are configured to bypass the MultiPod interface, after which 
the interface is disabled. 

Returns:
    BERR_SUCCESS                - MultiPod interface shutdown.

See Also:
BXPT_Mpod_Init
****************************************************************************/
BERR_Code BXPT_Mpod_Shutdown(
    BXPT_Handle hXpt                            /* [in] Handle for this transport */
    );  

/***************************************************************************
Summary:
Get PODRES field from the incoming MultiPod headers.

Description:
Get the value of the PODRES field in the last MultiPod header received.

Returns:
    unsigned int                - The PODRES field retrieved.
****************************************************************************/
unsigned int BXPT_Mpod_GetPodRes(
    BXPT_Handle hXpt                /* [in] Handle for this transport */
    );

/***************************************************************************
Summary:
Send all PIDS on a parser band out the MPOD interface.

Description:
Data for the selected parser is routed throught the MultiPod interface. 

Returns:
    BERR_SUCCESS                - Parser data routed to interface.
    BERR_INVALID_PARAMETER      - Bad parser parameter

See Also:
BXPT_Mpod_Init, BXPT_Mpod_AllPass
****************************************************************************/
BERR_Code BXPT_Mpod_RouteToMpod(
    BXPT_Handle hXpt,           /* [in] Handle for this instance of transport. */
    BXPT_ParserType ParserType, /* [in] Playback or front-end parser */
    unsigned ParserNum,         /* [in] Which parser to get data from */
    bool Enable                 /* [in] Route data to the MPOD interface if true */
    );

/***************************************************************************
Summary:
Send PID-filtered data out the MPOD interface.

Description:
Data for the selected parser is routed throught the MultiPod interface. 
Only data on enabled PID channels mapped to the parser will be sent.

Returns:
    BERR_SUCCESS                - Parser data routed to interface.
    BERR_INVALID_PARAMETER      - Bad parser parameter

See Also:
BXPT_Mpod_Init, BXPT_Mpod_AllPass
****************************************************************************/
BERR_Code BXPT_Mpod_RouteToMpodPidFiltered(
    BXPT_Handle hXpt,           /* [in] Handle for this instance of transport. */
    BXPT_ParserType ParserType, /* [in] Playback or front-end parser */
    unsigned ParserNum,         /* [in] Which parser to get data from */
    bool MpodPidFilter,         /* [in] enable pid filtering prior to the MCARD */
    bool ContinuityCountCheck,  /* [in] enable CC checking after the MCARD */
    bool Enable                 /* [in] Route data to the MPOD interface if true */
    );

/***************************************************************************
Summary:
Send all parser band data out the MPOD interface.

Description:
For routing data to the MultiPod, the PID channel assignments are ignored.
All data arriving at the given parser band is routed to the interface. 

Returns:
    BERR_SUCCESS                - All data routed to interface.
    BERR_INVALID_PARAMETER      - Bad parser parameter

See Also:
BXPT_Mpod_Init, BXPT_Mpod_RouteToMpod
****************************************************************************/
BERR_Code BXPT_Mpod_AllPass(
    BXPT_Handle hXpt,           /* [in] Handle for this instance of transport. */
    BXPT_ParserType ParserType, /* [in] Playback or front-end parser */
    unsigned ParserNum,         /* [in] Which parser to get data from */
    bool Enable                 /* [in] All pass mode enabled if true, disabled if false */
    );

#ifdef __cplusplus
}
#endif

#endif /* #ifndef BXPT_MPOD_H__ */

/* end of file */