source: svn/trunk/newcon3bcm2_21bu/magnum/commonutils/vdb/3548/A0/bvdb_priv.h

/***************************************************************************
 *     Copyright (c) 2003-2008, 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: bvdb_priv.h $
 * $brcm_Revision: Hydra_Software_Devel/2 $
 * $brcm_Date: 11/19/08 6:05p $
 *
 * Module Description:
 *   See Module Overview below.
 *
 * Revision History:
 *
 * $brcm_Log: /magnum/commonutils/vdb/3548/A0/bvdb_priv.h $
 * 
 * Hydra_Software_Devel/2   11/19/08 6:05p jessem
 * PR49427, PR49428, PR49429, PR49431, PR49432, PR49433, PR49434, PR49435,
 * PR49436, PR49437, PR49438, PR49440: Fixed strcpy and strcat Coverity
 * issues.
 * 
 * Hydra_Software_Devel/1   6/18/08 12:31p jessem
 * PR 43759: Initial version.
 *
 ***************************************************************************/
 
#ifndef __BVDB_PRIV_H__
#define __BVDB_PRIV_H__

#include "bvdb.h"
#include "blst_circleq.h"

#ifdef __cplusplus
extern "C" {
#endif

#if BDBG_DEBUG_BUILD
#define BVDB_P_GENERIC_GET_CONTEXT(handle, context, structname) \
do { \
        (context) = (handle); \
        BDBG_ASSERT(context); \
} while(0)
#else
#define BVDB_P_GENERIC_GET_CONTEXT(handle, context, structname) \
        (context) = (handle)
#endif

#define BVDB_P_GET_CONTEXT(handle, context) \
        BVDB_P_GENERIC_GET_CONTEXT(handle, context, BVDB_P_Context)
        
/* VDB list access */
#define BVDB_P_UsageMode_GetNextNode(pNode)   \
        BLST_CQ_NEXT(pNode, link)

#define BVDB_P_UsageMode_GetPrevNode(pNode)   \
        BLST_CQ_PREV(pNode, link)

/* helper macros */
#define BVDB_P_STRCPY(DSTR, SSTR) \
        strncpy(DSTR, SSTR, BVDB_MAX_STRLEN)

#define BVDB_P_STRCAT(DSTR, SSTR) \
        strncat(DSTR, SSTR, BVDB_MAX_STRLEN)
        
/***************************************************************************
 * BVDB_P_Context
 *      Head of the doubly-linked list
 ***************************************************************************/
typedef struct BVDB_P_Context   BVDB_P_Context;
BLST_CQ_HEAD(BVDB_P_Context, BVDB_UsageMode);

typedef enum
{
        BVDB_ModeType_eFull = 0,
        BVDB_ModeType_ePig,
        BVDB_ModeType_ePip,
        BVDB_ModeType_eVcr,
        BVDB_ModeType_eInvalid  
} BVDB_DispModeType;

/* Functions */
bool BVDB_P_IsSd
        (BVDB_SourceFormatSet       eSrcFmtSet );
        
bool BVDB_P_IsSourceProgressive
        ( BVDB_SourceFormatSet      eSrcFmt );

uint32_t BVDB_P_GetConfigId
        ( char                     *pcStr );

BVDB_DispModeType BVDB_P_GetVideoDisplayModeType
        ( BVDB_VideoDisplayMode    *pstVidDispMode );

BERR_Code BVDB_P_GetSourceFormatSetId
        ( BVDB_SourceFormatSet      eSrcFmt,
          char                     *pcId );

BERR_Code BVDB_P_CreateId
        ( BVDB_P_Context           *pVdb,
          BVDB_UsageMode           *pstUsageMode );

BERR_Code BVDB_P_CreateRts
        ( BVDB_UsageMode           *pstUsageMode,
          char                     *acRts );

void BVDB_P_GetSourceFormatSetStr
        ( BVDB_SourceFormatSet      eSrcFmt,
          char                     *pcStr );

void BVDB_P_GetDisplayStr
        ( BVDB_Display              eDisplay,
          char                     *pcStr );

void BVDB_P_GetWindowStr
        ( BVDB_Window               eWin,
          char                     *pcStr );

void BVDB_P_GetInputStr
        ( BVDB_Input                eInput,
          char                     *pcStr );

void BVDB_P_GetVideoDisplayModeStr
        ( BVDB_VideoDisplayMode    *pstVidDispMode,
          char                     *pcStr );

void BVDB_P_GetOsdStr
        ( BVDB_Osd                  eOsd,
          char                     *pcStr );

void BVDB_P_GetPixelFormatStr
        ( BVDB_PixelFormat          ePxlFormat,
          BVDB_State                eState,
          char                     *pcStr );

void BVDB_P_GetFieldStoreCntStr
        ( BVDB_DeinterlacerFieldStore           eFieldStore,
          char                                 *pcStr );

void BVDB_P_GetRtsSetStr
        ( BVDB_RtsSet               stRtsSet,
          char                     *pcStr );

void BVDB_P_GetStateStr
        ( BVDB_State                eState,
          char                     *pcStr );

void BVDB_P_GetSclCapBiasStr
        ( BVDB_ScalerCaptureBias  eBias,
          char                   *pcStr );

BERR_Code BVDB_P_ValidateId
        ( BVDB_P_Context           *pVdb,
          BVDB_UsageMode           *pstUsageMode );

BERR_Code BVDB_P_ValidateOsd
        (  BVDB_UsageMode          *pstUsageMode );

BERR_Code BVDB_P_Validate3dComb
        (  BVDB_UsageMode          *pstUsageMode );
        
BERR_Code BVDB_P_ValidateRtsSet
        ( BVDB_UsageMode           *pstUsageMode );

BERR_Code BVDB_P_ValidateOversample
        (  BVDB_UsageMode          *pstUsageMode );

BERR_Code BVDB_P_ValidateMnrBnr
        (  BVDB_UsageMode          *pstUsageMode );

BERR_Code BVDB_P_ValidateDcr
        (  BVDB_UsageMode          *pstUsageMode );

BERR_Code BVDB_P_ValidateAnr
        (  BVDB_UsageMode          *pstUsageMode );

BERR_Code BVDB_P_ValidateCapVfd
        (  BVDB_UsageMode          *pstUsageMode );

BERR_Code BVDB_P_ValidateMad
        (  BVDB_UsageMode          *pstUsageMode );

BERR_Code BVDB_P_ValidateVdbEntry
        ( BVDB_P_Context           *pVdb,
          BVDB_UsageMode           *pstUsageMode );

BERR_Code BVDB_P_ValidateVdb
        ( BVDB_P_Context           *pVdb );


#if 0
BERR_Code BVDB_P_ValidateSourceFormat
        BFMT_VideoFmt       eSourceFmt,
        BVDB_UsageMode     *pstUsageMode );
#endif

#ifdef __cplusplus
}
#endif

#endif /* __BVDB_PRIV_H__ */