image_sensor_ov7660.h

ov7670

/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*****************************************************************************
 *
 * Filename:
 * ---------
 *   image_sensor.h
 *
 * Project:
 * --------
 *   MT6219
 *
 * Description:
 * ------------
 *   CMOS sensor header file
 *
 * Author:
 * -------
 * -------
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 *
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================
 ****************************************************************************/
#ifndef _IMAGE_SENSOR_OV7660_H
#define _IMAGE_SENSOR_OV7660_H

	#include "isp_if.h"
    #include "sensor_struct.h"
	
	//------------------------Engineer mode---------------------------------
    #define OV7660_FACTORY_START_ADDR 70    //For old frame
	
	typedef enum OV7660_group_enum {
	   OV7660_AWB_GAIN=0,
	   OV7660_PRE_GAIN,
	   OV7660_SENSOR_DBLC,
	   OV7660_GAMMA_ENABLE,
	   OV7660_CMMCLK_CURRENT,
	   OV7660_FRAME_RATE_LIMITATION,
	   OV7660_REGISTER_EDITOR,
	   OV7660_GROUP_TOTAL_NUMS
	} OV7660_FACTORY_CCT_GROUP_ENUM;
	
	typedef enum OV7660_register_index {
	   OV7660_AWB_GAIN_R_INDEX=OV7660_FACTORY_START_ADDR,
	   OV7660_AWB_GAIN_B_INDEX,
	   OV7660_SENSOR_DBLC_INDEX,
	   OV7660_GAMMA_ENABLE_INDEX,
	   OV7660_CMMCLK_CURRENT_INDEX,	   
	   OV7660_FACTORY_END_ADDR
	} OV7660_FACTORY_REGISTER_INDEX;
	
	typedef enum OV7660_cct_register_index {
	   OV7660_GLOBAL_GAIN_INDEX=0,
	   OV7660_PRE_GAIN_R_INDEX,
	   OV7660_PRE_GAIN_B_INDEX,
	   OV7660_CCT_END_ADDR
	} OV7660_CCT_REGISTER_INDEX;


	// API FOR ENGINEER FACTORY MODE
	void  OV7660_get_sensor_group_count(kal_int32* sensor_count_ptr);
	void  OV7660_get_sensor_group_info(kal_uint16 group_idx, kal_int8* group_name_ptr, kal_int32* item_count_ptr);
	void  OV7660_get_sensor_item_info(kal_uint16 group_idx,kal_uint16 item_idx, ENG_sensor_info* info_ptr);
	kal_bool OV7660_set_sensor_item_info(kal_uint16 group_idx, kal_uint16 item_idx, kal_int32 item_value);
	
	//------------------------Engineer mode---------------------------------
	
	
	// write camera_para to sensor register 
	void OV7660_camera_para_to_sensor(void);
	// update camera_para from sensor register 
	void OV7660_sensor_to_camera_para(void);
	// config sensor callback function 
	void OV7660_image_sensor_func_config(void);
	// Compact Image Sensor Module Power ON/OFF
	void cis_module_power_on(kal_bool on);
	
    kal_uint32 OV7660_detect_sensor_id(void);
    void OV7660_get_sensor_prefix_name(kal_char* buf);
    void OV7660_cct_global_variable_init(void);
    kal_uint16 OV7660_get_max_exposure_lines(void);
    void OV7660_set_max_exposure_lines(kal_uint32 shutter_lines);
    kal_uint16 OV7660_get_min_exposure_lines(void);
    void  OV7660_dispatch_camera_info(void);
    kal_uint32 OV7660_get_valid_camera_type(void);          

#if (!(defined(DRV_ISP_6238_SERIES) ||defined(DRV_ISP_6235_SERIES) ))	
    typedef struct {
       sensor_reg_struct    reg[OV7660_FACTORY_END_ADDR];
       sensor_reg_struct    cct[OV7660_CCT_END_ADDR];
    } sensor_data_struct;
#endif	

	/* MAXIMUM EXPLOSURE LINES USED BY AE */
	extern kal_uint16 OV7660_MAX_EXPOSURE_LINES;
	extern kal_uint8  OV7660_MIN_EXPOSURE_LINES;
	/* AE CONTROL CRITERION */
	extern kal_uint8  OV7660_AE_AWB_CAL_PERIOD;
	extern kal_uint8  OV7660_AE_GAIN_DELAY_PERIOD;
	extern kal_uint8  OV7660_AE_SHUTTER_DELAY_PERIOD;

	/* DEFINITION USED BY CCT */
	extern SensorInfo	OV7660_g_CCT_MainSensor;
	extern kal_uint8	OV7660_g_CCT_FirstGrabColor;

	/* CAMERA PREVIEW FRAME RATE DEFINITION */
	#define CAM_PREVIEW_15FPS
//	#define CAM_PREVIEW_22FPS
//	#define CAM_PREVIEW_30FPS

	#define SYSTEM_CLK                           (52*1000*1000)
	/* PIXEL CLOCK USED BY BANDING FILTER CACULATION*/
#if defined(CAM_PREVIEW_15FPS)
	#define OV7660_PIXEL_CLK							         (SYSTEM_CLK/8)		// 52/8 MHz
#elif defined(CAM_PREVIEW_22FPS)
   #define OV7660_PIXEL_CLK							         (SYSTEM_CLK/6)		// 52/6 MHz
#elif defined(CAM_PREVIEW_30FPS)
   #define OV7660_PIXEL_CLK 						      	(SYSTEM_CLK/4)		// 52/4 MHz
#endif

	/* MAX/MIN FRAME RATE (FRAMES PER SEC.) */
	#define OV7660_MAX_FRAME_RATE								15		// Limitation for MPEG4 Encode Only
	#define OV7660_MIN_FRAME_RATE								12

	/* LINE NUMBERS IN MAX_FRAME_RATE */
	#define OV7660_MIN_LINES_PER_FRAME						((SYSTEM_CLK/8/MAX_FRAME_RATE)/VGA_PERIOD_PIXEL_NUMS)

	/* SENSOR GLOBAL GAIN AT NIGHT MODE */
	#define OV7660_SENSOR_NIGHT_MODE_GAIN					0x08	// Please refer to OV7660 Implementation Guide for suitable value.

	/* SENSOR PIXEL/LINE NUMBERS IN ONE PERIOD */
	#define OV7660_VGA_PERIOD_PIXEL_NUMS						784
	#define OV7660_VGA_PERIOD_LINE_NUMS						510

	/* SENSOR EXPOSURE LINE LIMITATION */
	#define OV7660_VGA_EXPOSURE_LIMITATION					508
	
	/* 1M RESOLUTION SIZE */
	#define IMAGE_SENSOR_1M_WIDTH					1280
	#define IMAGE_SENSOR_1M_HEIGHT					960

	/* SENSOR VGA SIZE */
	#define IMAGE_SENSOR_VGA_WIDTH					640
	#define IMAGE_SENSOR_VGA_HEIGHT					480

    //Wonder, because OV7660 is not qualified in 38, so here only test
    #define OV7660_IMAGE_SENSOR_FULL_WIDTH          (640 - 6)
    #define OV7660_IMAGE_SENSOR_FULL_HEIGHT         (480 - 8)
    

	/* SETUP TIME NEED TO BE INSERTED */
	#define OV7660_IMAGE_SENSOR_VGA_INSERTED_PIXELS		46
	#define OV7660_IMAGE_SENSOR_VGA_INSERTED_LINES			11
	
	/* SENSOR READ/WRITE ID */
	#define OV7660_WRITE_ID								0x42
	#define OV7660_READ_ID								0x43
	

	#define OV7660_SENSOR_I2C_DELAY							0x20

	#define I2C_START_TRANSMISSION \
	{ \
		volatile kal_uint32 j; \
		SET_SCCB_CLK_OUTPUT; \
		SET_SCCB_DATA_OUTPUT; \
		SET_SCCB_CLK_HIGH; \
		SET_SCCB_DATA_HIGH; \
		for(j=0;j<OV7660_SENSOR_I2C_DELAY;j++);\
		SET_SCCB_DATA_LOW; \
		for(j=0;j<OV7660_SENSOR_I2C_DELAY;j++);\
		SET_SCCB_CLK_LOW; \
	}
	
	#define I2C_STOP_TRANSMISSION \
	{ \
		volatile kal_uint32 j; \
		SET_SCCB_CLK_OUTPUT; \
		SET_SCCB_DATA_OUTPUT; \
		SET_SCCB_CLK_LOW; \
		SET_SCCB_DATA_LOW; \
		for(j=0;j<OV7660_SENSOR_I2C_DELAY;j++);\
		SET_SCCB_CLK_HIGH; \
		for(j=0;j<OV7660_SENSOR_I2C_DELAY;j++);\
		SET_SCCB_DATA_HIGH; \
	}

#endif /* _IMAGE_SENSOR_H */