sii9031.h

Sigma SMP8634 Mrua v. 2.8.2.0

/*
 *
 * Copyright (c) 2001-2007 Sigma Designs, Inc. 
 * All Rights Reserved. Proprietary and Confidential.
 *
 */

/**
  @file   SiI9031.h
  @brief  Interface to access the SiI9031 HDMI capture chip
  
  @author Christian Wolff, Sean.Sekwon.Choi
  @date   2007-07-16
*/

#ifndef __SII9031_H__
#define __SII9031_H__

struct cap_SiI9031_instance;

RMstatus cap_SiI9031_open(
	struct RUA *pRUA, 
	struct cap_SiI9031_instance **ppSiI9031, 
	RMuint32 I2CModuleID, 
	struct EMhwlibI2CDeviceParameter *pI2CDevice);
	
RMstatus cap_SiI9031_close(
	struct cap_SiI9031_instance *pSiI9031);

/* tri-state all outputs and power down chip */
RMstatus cap_SiI9031_tristate(
	struct cap_SiI9031_instance *pSiI9031);

/* detect video format from the line and pixel counter in the SiI9031 */
RMstatus cap_SiI9031_measure_video_format(
	struct cap_SiI9031_instance *pSiI9031, 
	RMuint32 *pVIC, // VIC of the detected mode
	RMbool *UseStandard, // TRUE: valid information in pTVStandard, FALSE: valid info only in pTVFormat
	enum EMhwlibTVStandard *pTVStandard, 
	struct EMhwlibTVFormatDigital *pTVFormat, 
	RMuint32 *pAspX, RMuint32 *pAspY);

/* get current audio channel status from SiI9031 */
RMstatus cap_SiI9031_get_audio_channel_status(
	struct cap_SiI9031_instance *pSiI9031, 
	RMuint8 ch_stat[5]);

/* get current audio clock divider values N/CTS from SiI9031 */
RMstatus cap_SiI9031_get_audio_n_cts(
	struct cap_SiI9031_instance *pSiI9031, 
	RMuint32 *pN, 
	RMuint32 *pCTS, 
	RMuint32 *pApproxSamplingRate);

/* set cable equalisation value to compensate for cable length, 0..15 */
RMstatus cap_SiI9031_set_cable_comp(
	struct cap_SiI9031_instance *pSiI9031, 
	RMuint32 cable_eq);

/* TRUE: upsample 4:2:2 to 4:4:4, FALSE: pass through 4:4:4 */
RMstatus cap_SiI9031_set_422_to_444_upsampling(
	struct cap_SiI9031_instance *pSiI9031, 
	RMbool upsampling);

/* select a blanking color which will result in "black" for the current input color space */
RMstatus cap_SiI9031_set_blanking_color(
	struct cap_SiI9031_instance *pSiI9031, 
	enum EMhwlibColorSpace InputColorSpace);

/* set the pixel repetition value announced in the AVI info frame. This reduces the pixel clock and all horizontal timing values accordingly. */
RMstatus cap_SiI9031_apply_pixelrep(
	struct cap_SiI9031_instance *pSiI9031, 
	RMuint32 pixel_rep);

/* initialize the audio clock and data outputs of the SiI9031 */
RMstatus cap_SiI9031_init_audio_clock(
	struct cap_SiI9031_instance *pSiI9031, 
	RMbool enable, 
	RMuint32 mclk_f);

/* translate info frame type to offset of SiI9031 receive area */
RMstatus cap_SiI9031_get_info_frame_offset(
	struct cap_SiI9031_instance *pSiI9031, 
	RMuint8 type, 
	RMuint8 *pOffset);

/* read the info frame from the specified offset of the SiI9031 */
RMstatus cap_SiI9031_read_info_frame(
	struct cap_SiI9031_instance *pSiI9031, 
	RMuint8 offset, 
	RMuint8 *header, 
	RMuint8 *data, 
	RMuint32 size, 
	RMbool honor_checksum);

/* select which packet type should be parsed into the register area specified by the offset */
RMstatus cap_SiI9031_set_info_frame_receive_type(
	struct cap_SiI9031_instance *pSiI9031, 
	RMuint8 offset, 
	RMuint8 type);

RMstatus cap_SiI9031_detect_mode(
	struct cap_SiI9031_instance *pSiI9031, 
	enum cap_hdmi_mode *pHDMIMode);

RMstatus cap_SiI9031_set_mode(
	struct cap_SiI9031_instance *pSiI9031, 
	enum cap_hdmi_mode hdmi_mode);

RMstatus cap_SiI9031_init_capture(
	struct cap_SiI9031_instance *pSiI9031, 
	RMuint32 input,  // 0 or 1
	RMbool intr_debug);  // enable verbouse interrupt reporting

/* Returns RM_OK if an interrupt is pending on the SiI9031 */
RMstatus cap_SiI9031_check_int(
	struct cap_SiI9031_instance *pSiI9031);

RMstatus cap_SiI9031_handle_int(
	struct cap_SiI9031_instance *pSiI9031, 
	struct cap_update *pUpdate, 
	struct cap_hdmi_update *pHDMIUpdate);

#endif // __SII9031_H__