#ifndef CAMSENSOR_OV9650_H
#define CAMSENSOR_OV9650_H

/*============================================================================

                 Camera Interface Device Driver Source File for 
                    Omnivision OV9650 1.3 Mega Pixel CCD sensor

   DESCRIPTION
     This file contains the definitions needed for the camera interface
     device driver.

   Copyright (c) 2005 by QUALCOMM, Incorporated.  All Rights Reserved.
============================================================================*/

/*============================================================================

                      EDIT HISTORY FOR FILE

 This section contains comments describing changes made to this file.
 Notice that changes are listed in reverse chronological order.

 $Header: //depot/asic/msm6550/drivers/camsensor/camsensor_ov9650.h#4 $ $DateTime: 2006/01/17 14:34:20 $ $Author: jnygren $

 when      who    what, where, why
 --------  -----  ----------------------------------------------------------
 05/04/05  dle    CAMSENSOR is now free of VFE.
 04/12/05  uy     Basic color tuning.
 26/01/05  dsegal initial release..


============================================================================*/

/*============================================================================
                        INCLUDE FILES
============================================================================*/

#include "camsensor.h"
#include "camctrl.h"

/*============================================================================
                        CONSTANT DEFINITIONS
============================================================================*/

/*============================================================================
                        DATA DECLARATIONS
============================================================================*/

/*============================================================================
                          MACRO DEFINITIONS
============================================================================*/


/*============================================================================
                          EXPORTED FUNCTIONS
============================================================================*/

/*===========================================================================

FUNCTION      CAMSENSOR_OV9650_INIT

DESCRIPTION
              Initialize the camera sensor;

DEPENDENCIES
  None

RETURN VALUE
  if successful
    TRUE
  else
    FALSE

SIDE EFFECTS
  None

===========================================================================*/

boolean camsensor_ov9650_init(camsensor_function_table_type *camsensor_function_table_ptr,
                              camctrl_tbl_type              *camctrl_tbl_ptr);


/*===========================================================================

FUNCTION      CAMSENSOR_OV9650_START

DESCRIPTION
              Initialize the camsensor parameters.

DEPENDENCIES
  None

RETURN VALUE
  if successful
    TRUE
  else
    FALSE

SIDE EFFECTS
  None

===========================================================================*/

boolean camsensor_ov9650_start(camsensor_static_params_type *camsensor_params);


/*===========================================================================

FUNCTION      CAMSENSOR_OV9650_SNAPSHOT_CONFIG

DESCRIPTION
              Configure the camera sensor for snapshot 

DEPENDENCIES
  None

RETURN VALUE
  TRUE if successful
  FALSE otherwise

SIDE EFFECTS
  None

===========================================================================*/

boolean camsensor_ov9650_snapshot_config
(
  camsensor_static_params_type  *camsensor_params /* Other config params */
);

/*===========================================================================

FUNCTION      CAMSENSOR_OV9650_RAW_SNAPSHOT_CONFIG

DESCRIPTION
              Configure the camera sensor and the camera interface

DEPENDENCIES
  None

RETURN VALUE
  TRUE if successful
  FALSE otherwise

SIDE EFFECTS
  None

===========================================================================*/

boolean camsensor_ov9650_raw_snapshot_config
(
   camsensor_static_params_type  *camsensor_params /* Other config params */
);

/*===========================================================================

FUNCTION      CAMSENSOR_OV9650_VIDEO_CONFIG

DESCRIPTION
              Configure the camera sensor and the camera interface

DEPENDENCIES
  None

RETURN VALUE
  TRUE if successful
  FALSE otherwise

SIDE EFFECTS
  None

===========================================================================*/

boolean camsensor_ov9650_video_config
(
  camsensor_static_params_type  *camsensor_params /* Other config params */
);


/*===========================================================================

FUNCTION      CAMSENSOR_OV9650_POWER_UP

DESCRIPTION
              Power up the sensor.

DEPENDENCIES
  None

RETURN VALUE
  None

SIDE EFFECTS
  None

===========================================================================*/

void camsensor_ov9650_power_up(void);


/*===========================================================================

FUNCTION      CAMSENSOR_OV9650_POWER_DOWN

DESCRIPTION
              Power down the sensor.

DEPENDENCIES
  None

RETURN VALUE
  None

SIDE EFFECTS
  None

===========================================================================*/

void camsensor_ov9650_power_down(void);


/*===========================================================================

FUNCTION      CAMSENSOR_OV9650_WRITE_EXPOSURE_GAIN

DESCRIPTION   Update exposure gain on sensor

DEPENDENCIES
  None

INPUT
  uint16 gain       - value for new gain param
  uint32 line_count - num lines in whole gain table
  
RETURN VALUE
  camera_ret_code_type
  CAMERA_SUCCESS - if no error comes back from I2C
  CAMERA_FAILED  - if I2C reported an error

SIDE EFFECTS
  None

===========================================================================*/
camera_ret_code_type camsensor_ov9650_write_exposure_gain(uint16 gain, uint32 line_count);


/*===========================================================================

FUNCTION      CAMSENSOR_OV9650_MOVE_FOCUS

DESCRIPTION
  Move focus either near or toward infinity the number of steps
  specified.

DEPENDENCIES
  None

INPUT
  camsensor_move_focus_enum_type: either of the two following
    CAMSENSOR_MOVE_FOCUS_NEAR - moves to the near end for closer objects
    CAMSENSOR_MOVE_FOCUS_FAR  - moves to the far end for more distant objects

  int32 num_steps - num steps to move focal motor

RETURN VALUE
  camera_ret_code_type:
    CAMERA_SUCCESS             - if no error comes back from I2C
    CAMERA_FOCUS_SENSOR_FAILED - if I2C reported an error

SIDE EFFECTS
  None

===========================================================================*/
camera_ret_code_type camsensor_ov9650_move_focus(camsensor_move_focus_enum_type  direction,
                                                 int32                           num_steps);


/*===========================================================================

FUNCTION      CAMSENSOR_OV9650_SET_DEFAULT_FOCUS

DESCRIPTION
  Move focus to location best suited to any subject: at the nearest 
  point where infinity is still in focus.
  specified.

DEPENDENCIES
  None

RETURN VALUE
  camera_ret_code_type
  CAMERA_SUCCESS - if no error comes back from I2C
  CAMERA_FOCUS_SENSOR_FAILED  - if I2C reported an error

SIDE EFFECTS
  None

===========================================================================*/
camera_ret_code_type camsensor_ov9650_set_default_focus(void);


#endif /* CAMSENSOR_OV9650_H */