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

/***************************************************************************
 *     Copyright (c) 2003-2010, 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_remux.h $
 * $brcm_Revision: Hydra_Software_Devel/1 $
 * $brcm_Date: 10/25/10 2:09p $
 *
 * Porting interface code for the packet remultiplexor section of the
 * data transport core. 
 *
 * Revision History:
 *
 * $brcm_Log: /magnum/portinginterface/xpt/base2/bxpt_remux.h $
 * 
 * Hydra_Software_Devel/1   10/25/10 2:09p gmullen
 * SW7425-15: Moved srcs to base2 folder
 * 
 * Hydra_Software_Devel/2   10/25/10 9:12a gmullen
 * SW7425-15: Updated headers and added stub versions of C files
 * 
 * Hydra_Software_Devel/1   10/8/10 2:58p gmullen
 * SW7425-15: Added header files
 * 
 * Hydra_Software_Devel/18   7/29/10 1:59p gmullen
 * SW7420-904: Added RMX_NULL_PKT_THRESHOLD
 * 
 * Hydra_Software_Devel/17   4/23/10 8:54a gmullen
 * SW3556-1102: Added param to control NULL packet insertion
 * 
 * Hydra_Software_Devel/16   2/23/10 5:55p gmullen
 * SW3548-2790: Corrected comments.
 * 
 * Hydra_Software_Devel/15   2/18/10 9:35a gmullen
 * SW3548-2790: Added API for controlling PCR jitter adjust
 * 
 * Hydra_Software_Devel/14   6/17/09 6:46p gmullen
 * PR56110: Added support.xpt/7550/uif_image/a0
 * 
 * Hydra_Software_Devel/13   4/16/09 7:20p piyushg
 * PR53728: Each of the XC buffer clients (Remux, RAVE, and the Mesg
 * filters) would get a separate API to set
 * their input bitrates. That API would take a client handle and the ID of
 * the parser band. The XPT PI would
 * then walk backwards through the pipeline, increasing only the bitrates
 * for the XC and RS buffers that it
 * needs to.
 * 
 * Hydra_Software_Devel/12   4/7/09 5:26p piyushg
 * PR52986: Add support for 7635
 * Added directory element "7635".
 * 
 * Hydra_Software_Devel/11   3/26/09 6:11p gmullen
 * PR53579: Fixed BCHP mismatches between C and H files.
 * 
 * Hydra_Software_Devel/10   1/27/09 1:10p gmullen
 * PR51625: Added 7336 support
 * 
 * Hydra_Software_Devel/9   6/30/08 10:13a gmullen
 * PR44320: Enabled missing features in remux PI
 * 
 * Hydra_Software_Devel/8   3/26/08 11:24a gmullen
 * PR38954: Added 3548 support to XPT PI.
 * 
 * Hydra_Software_Devel/7   11/28/07 12:12p gmullen
 * PR36900: Added 7335 support
 * 
 * Hydra_Software_Devel/6   10/30/07 3:45p gmullen
 * PR35018: Fixed incorrect conditional compile directive in struct.
 * 
 * Hydra_Software_Devel/5   10/30/07 3:12p gmullen
 * PR35018: Added support for 7325
 * 
 * Hydra_Software_Devel/4   6/2/06 4:23p gmullen
 * PR21868: Added bitfields to BXPT_Remux_ChannelSettings struct.
 * 
 * Hydra_Software_Devel/3   3/28/06 9:06a gmullen
 * PR18998: Added SetAllPassMode
 * 
 * Hydra_Software_Devel/2   3/16/06 5:10p gmullen
 * PR18998: Added support for reading data from R-pipe (security related).
 * 
 * Hydra_Software_Devel/3   12/2/05 3:24p gmullen
 * PR15309: Saved updates for ccase server move
 * 
 * Hydra_Software_Devel/2   11/8/05 10:22a gmullen
 * PR15309: Updated.
 * 
 * Hydra_Software_Devel/1   5/13/05 1:27p gmullen
 * PR15309: First draft of XPT PI.
 * 
 *
 ***************************************************************************/

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

#ifndef BXPT_REMUX_H__
#define BXPT_REMUX_H__

#include "bxpt.h"
#include "bxpt_playback.h"

#ifdef __cplusplus
extern "C" {
#endif

/***************************************************************************
Summary:
Handle for accessing the remux API via a channel. Users should not directly
access the contents of the structure.
****************************************************************************/
typedef struct BXPT_P_RemuxHandle *BXPT_Remux_Handle;

/***************************************************************************
Summary:
Defines the two channels inside the remux block. 
****************************************************************************/
typedef enum BXPT_RemuxInput
{
        BXPT_RemuxInput_eA,
        BXPT_RemuxInput_eB
}
BXPT_RemuxInput;

/***************************************************************************
Summary:
Selects the clock source for the remux channel.
****************************************************************************/
typedef enum BXPT_RemuxClock
{
        BXPT_RemuxClock_e81Mhz                  = 0,    /* 81 MHz */
        BXPT_RemuxClock_e54Mhz                  = 1,    /* 54 MHz */
        BXPT_RemuxClock_e40_5Mhz                = 2,    /* 40.5 MHz */  
        BXPT_RemuxClock_e20_25Mhz               = 3,    /* 20.25 MHz */         
        BXPT_RemuxClock_e27Mhz_VCXO_A   = 4,    /* 27 MHz, from VCXO A */       
        BXPT_RemuxClock_eIb0                    = 8,    /* Input band 0 clock. */
        BXPT_RemuxClock_eIb1                    = 9,    /* Input band 1 clock. */
        BXPT_RemuxClock_eIb2                    = 10,   /* Input band 2 clock. */
        BXPT_RemuxClock_eIb3                    = 11,   /* Input band 3 clock. */
        BXPT_RemuxClock_eIb4                    = 12    /* Input band 4 clock. */
}
BXPT_RemuxClock;

/***************************************************************************
Summary:
Settings for the remux channels. These values can be passed in when the
channel is opened, and will be used as the new default settings.
****************************************************************************/
typedef struct BXPT_Remux_ChannelSettings
{
        BXPT_RemuxClock OutputClock;            /* Clock to be used to output the RMX serial data. */
          
        /* 
        ** Programmable delay output packets. This value is specified in 108MHz 
        ** clock ticks. Programming this field to 0 specifies no gap between output packets 
        */      
        unsigned int PacketDelayCount;
        
        /* Enable the remux Pause pin if present on the chip. */
        bool PauseEn;                           

        /* 
        ** Settings for the remux physical interface. From the Remux, it is possible
        ** to have both serial and parallel output enabled simultaneously. Top-level
        ** routing in the chip may not support that, however. 
        */      
        bool ParallelEn;                        /* Enable parallel output. */
        
        /* These settings are only used when parallel output is enabled */
        bool ParallelInvertClk;         /* Data will be output on falling edge if true */
        bool ParallelInvertSync;        /* Active low sync when true */

        /* Settings for serial output mode. */
        bool InvertClk;         /* Data will be output on falling edge if true */
        bool InvertSync;        /* Active low sync when true */
        bool ByteSync;          /* Sync is active for entire byte of a packet when true */

        /* Insert NULL packets in the output, when the selected output rate is
        ** higher than the input rate. By default, this is enabled (true).
        */
        bool InsertNullPackets;

    /* 
    ** When NULL packet insertion is enabled (above), the hardware will do so 
    ** after the number of clocks specified below have elapsed with further packets 
    ** from the input. This threshold is in 108MHz clock ticks. Default is 16 ticks. 
    */ 
    unsigned NullPacketInsertionThreshold;
}
BXPT_Remux_ChannelSettings;

/***************************************************************************
Summary:
Return the number of remux channels.

Description:
For the given transport core, return the number of remux channels that is
supported.

Returns:
    BERR_SUCCESS                - Retrieved address from hardware.
    BERR_INVALID_PARAMETER      - Bad input parameter
****************************************************************************/
BERR_Code BXPT_Remux_GetTotalChannels(
        BXPT_Handle hXpt,                       /* [in] Handle for this transport */
        unsigned int *TotalChannels             /* [out] The number of remux channels. */
        );      

/***************************************************************************
Summary:
Return the remux channel default settings.

Description:
Each remux channel has a set of default configuration values. This 
function retrieves these values and places them in a structure that can be
used to change the defaults when the remux channel is opened.

Returns:
    BERR_SUCCESS                - Retrieved remux defaults.
    BERR_INVALID_PARAMETER      - Bad input parameter
****************************************************************************/
BERR_Code BXPT_Remux_GetChannelDefaultSettings(
        BXPT_Handle hXpt,                       /* [in] Handle for this transport */
        unsigned int ChannelNo,                 /* [in] Which channel to get defaults from. */
        BXPT_Remux_ChannelSettings *ChannelSettings /* [out] The defaults */
        );      

/***************************************************************************
Summary:
Open a given remux channel.

Description:
Reset the given remux channel, configure it using the given defaults, then
return a handle to access that channel.

Returns:
    BERR_SUCCESS                - Remux channel opened.
    BERR_INVALID_PARAMETER      - Bad input parameter
****************************************************************************/
BERR_Code BXPT_Remux_OpenChannel(
        BXPT_Handle hXpt,                                               /* [in] Handle for this transport */
        BXPT_Remux_Handle *RemuxHandle,                 /* [out] Handle for opened remux channel */
        unsigned int ChannelNo,                                         /* [in] Which channel to open. */
        BXPT_Remux_ChannelSettings *ChannelSettings /* [in] The defaults to use */
        );      

/***************************************************************************
Summary:
Close a given remux channel.

Description:
Shutdown a given remux channel, disable any interrupts from it. 

Returns:
        void
****************************************************************************/
void BXPT_Remux_CloseChannel(
        BXPT_Remux_Handle RemuxHandle   /* [in] Handle for the channel to close*/
        );      

/***************************************************************************
Summary:
Start or stop the remultiplexing function.

Description:
Enable or disables remuxing on the given channel. The channel should be 
configured before calling this function.

Returns:
    BERR_SUCCESS                - Remuxing started or stopped successfully.
    BERR_INVALID_PARAMETER      - Bad input parameter
****************************************************************************/
BERR_Code BXPT_Remux_DoRemux( 
        BXPT_Remux_Handle RemuxHandle,  /* [in] Handle for the remux channel */
        bool Enable                             /* [in] Remux on if TRUE, or off if FALSE. */
        );

/***************************************************************************
Summary:
Include the given PID channel in the remux input.

Description:
Add a PID channel to the given remux. 

Returns:
    BERR_SUCCESS                - PID channel added successfully.
    BERR_INVALID_PARAMETER      - Bad input parameter
****************************************************************************/
BERR_Code BXPT_Remux_AddPidChannelToRemux( 
        BXPT_Remux_Handle RemuxHandle,  /* [in] Handle for the remux channel */
    BXPT_RemuxInput RemuxInput,                 /* [in] Which remux input */
        unsigned int PidChannelNum                      /* [in] Which PID channel. */
        );

/***************************************************************************
Summary:
Include the given PID channel in the remux input, using the R-Pipe feed.

Description:
Add a PID channel to the given remux. 

Returns:
    BERR_SUCCESS                - PID channel added successfully.
    BERR_INVALID_PARAMETER      - Bad input parameter
****************************************************************************/
BERR_Code BXPT_Remux_AddRPipePidChannelToRemux( 
        BXPT_Remux_Handle hRmx,                         /* [in] Handle for the remux channel */
        BXPT_RemuxInput RemuxInput,             /* [in] Which remux input */
        unsigned int PidChannelNum                      /* [in] Which PID channel. */
        );

/***************************************************************************
Summary:
Remove the given PID channel in the remux input.

Description:
Remove a PID channel from the given remux. The data carried on this PID 
channel will not be used in the remuxing. 

Returns:
    BERR_SUCCESS                - PID channel removed successfully.
    BERR_INVALID_PARAMETER      - Bad input parameter
****************************************************************************/
BERR_Code BXPT_Remux_RemovePidChannelFromRemux( 
        BXPT_Remux_Handle RemuxHandle,  /* [in] Handle for the remux channel */
        BXPT_RemuxInput RemuxInput,     /* [in] Which remux input */
        unsigned int PidChannelNum                      /* [in] Which PID channel. */
        );

/***************************************************************************
Summary:
Is the given PID channel enabled for remuxing?

Description:
Determines if a given PID channel is enabled for remuxing or not.

Returns:
    BERR_SUCCESS                - Got PID channel's status successfully.
    BERR_INVALID_PARAMETER      - Bad input parameter
****************************************************************************/
BERR_Code BXPT_Remux_GetPidChannel( 
        BXPT_Remux_Handle RemuxHandle,  /* [in] Handle for the remux channel */
        BXPT_RemuxInput RemuxInput,                     /* [in] Which remux input */
        unsigned int PidChannelNum,                     /* [in] Which PID channel. */
        bool *Enable                                            /* [out] Where to put channel status. */
        );

/***************************************************************************
Summary:
Removes all PID channels on the remux channel.

Description:
Removes all PID channels in the given block and remux channel from the 
remuxing session. 

Returns:
    BERR_SUCCESS                - PID channels removed uccessfully.
    BERR_INVALID_PARAMETER      - Bad input parameter
****************************************************************************/
BERR_Code BXPT_Remux_RemoveAllPidChannel( 
        BXPT_Remux_Handle RemuxHandle,  /* [in] Handle for the remux channel */
        BXPT_RemuxInput RemuxInput                      /* [in] Which remux input */
        );

/***************************************************************************
Summary:
Enable or disable the bypass mode for the remux.

Description:
Enables or disables the RMX bypass mode. In bypass mode, the selected data 
is output directly without any buffering, null packet insertion, pcr 
correction or packet substitution. Bypass mode must be used to output 
non-transport data such as PES or ES. In bypass mode, the output clock is 
gated off when there is no data to output.

Returns:
    BERR_SUCCESS                - All bypass mode successfully changed.
    BERR_INVALID_PARAMETER      - Bad input parameter
****************************************************************************/
BERR_Code BXPT_Remux_SetBypassMode( 
        BXPT_Remux_Handle hRmx,                 /* [in] Handle for the remux channel */
        bool Enable
        );

/***************************************************************************
Summary:
Add a fixed offset to the PCR values output from remux.
        
Description:
When enabled, FixedPcrOffset will be added to the PCR values in the output
stream, after PCR jitter adjustment has been done. 

Returns:
    BERR_SUCCESS                - Fixed offset has been set.
    BERR_INVALID_PARAMETER      - Bad input parameter
****************************************************************************/
BERR_Code BXPT_Remux_AddPcrOffset( 
        BXPT_Remux_Handle hRmx,         /* [in] Handle for the remux channel */
    bool AddOffsetEn,               /* [in] Enable/disable the PCR correction */
    uint32_t FixedPcrOffset                     /* [in] The PCR correction offset, if enabled */                
        );

/***************************************************************************
Summary:
Enable or disable PCR jitter adjustment in the remux. 
        
Description:
Controls PCR jitter adjustment for live or playback streams. The remux must
not be in bypass mode to use jitter adjustment. Timestamps must also be 
enabled in the playback (for such streams).

Returns:
        void
****************************************************************************/
void BXPT_Remux_SetPcrJitterAdj( 
        BXPT_Remux_Handle hRmx,         /* [in] Handle for the remux channel */
        bool ForPlayback,               /* [in] true = control adjustment for playback, false = control for live */
    bool EnableAdjust               /* [in] Enable/disable the PCR jitter adjust */
        );

#ifdef __cplusplus
}
#endif

#endif /* #ifndef BXPT_REMUX_H__ */

/* end of file */