drivers/misc/mediatek/imgsensor/src/mt8127/gc2355_mipi_raw/gc2355mipi_Sensor.h

   1 /* Copyright Statement:
   2  *
   3  * This software/firmware and related documentation ("MediaTek Software") are
   4  * protected under relevant copyright laws. The information contained herein
   5  * is confidential and proprietary to MediaTek Inc. and/or its licensors.
   6  * Without the prior written permission of MediaTek inc. and/or its licensors,
   7  * any reproduction, modification, use or disclosure of MediaTek Software,
   8  * and information contained herein, in whole or in part, shall be strictly prohibited.
   9  */
  10 /* MediaTek Inc. (C) 2010. All rights reserved.
  11  *
  12  * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
  13  * THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
  14  * RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO RECEIVER ON
  15  * AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
  16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
  18  * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
  19  * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
  20  * SUPPLIED WITH THE MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
  21  * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
  22  * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
  23  * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
  24  * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
  25  * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
  26  * CUMULATIVE LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
  27  * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
  28  * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
  29  * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
  30  */
  31
  32 /*****************************************************************************
  33 *  Copyright Statement:
  34 *  --------------------
  35 *  This software is protected by Copyright and the information contained
  36 *  herein is confidential. The software may not be copied and the information
  37 *  contained herein may not be used or disclosed except with the written
  38 *  permission of MediaTek Inc. (C) 2005
  39 *
  40 *  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
  41 *  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
  42 *  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
  43 *  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
  44 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
  45 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
  46 *  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
  47 *  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
  48 *  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
  49 *  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
  50 *  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
  51 *  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
  52 *
  53 *  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
  54 *  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
  55 *  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
  56 *  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
  57 *  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
  58 *
  59 *  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
  60 *  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
  61 *  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
  62 *  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
  63 *  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
  64 *
  65 *****************************************************************************/
  66 /*****************************************************************************
  67  *
  68  * Filename:
  69  * ---------
  70  *       sensor.c
  71  *
  72  * Project:
  73  * --------
  74  *       RAW
  75  *
  76  * Description:
  77  * ------------
  78  *       Source code of Sensor driver
  79  *
  80  *
  81  * Author:
  82  * -------
  83  *   Leo Lee
  84  *
  85  *============================================================================
  86  *             HISTORY
  87  *------------------------------------------------------------------------------
  88  * $Revision:$
  89  * $Modtime:$
  90  * $Log:$
  91  *
  92  * 03 01 2013
  93  * First release GC2355MIPI driver Version 1.0
  94  *
  95  *------------------------------------------------------------------------------
  96  *============================================================================
  97  ****************************************************************************/
  98
  99 #ifndef _GC2355MIPI_SENSOR_H
 100 #define _GC2355MIPI_SENSOR_H
 101
 102 #define GC2355MIPI_DEBUG
 103 #define GC2355MIPI_DRIVER_TRACE
 104 //#define GC2355MIPI_TEST_PATTEM
 105 //#define SENSORDB printk
 106 //#define SENSORDB(x,...)
 107
 108 #define GC2355MIPI_FACTORY_START_ADDR 0
 109 #define GC2355MIPI_ENGINEER_START_ADDR 10
 110
 111 typedef enum GC2355MIPI_group_enum
 112 {
 113   GC2355MIPI_PRE_GAIN = 0,
 114   GC2355MIPI_CMMCLK_CURRENT,
 115   GC2355MIPI_FRAME_RATE_LIMITATION,
 116   GC2355MIPI_REGISTER_EDITOR,
 117   GC2355MIPI_GROUP_TOTAL_NUMS
 118 } GC2355MIPI_FACTORY_GROUP_ENUM;
 119
 120 typedef enum GC2355MIPI_register_index
 121 {
 122   GC2355MIPI_SENSOR_BASEGAIN = GC2355MIPI_FACTORY_START_ADDR,
 123   GC2355MIPI_PRE_GAIN_R_INDEX,
 124   GC2355MIPI_PRE_GAIN_Gr_INDEX,
 125   GC2355MIPI_PRE_GAIN_Gb_INDEX,
 126   GC2355MIPI_PRE_GAIN_B_INDEX,
 127   GC2355MIPI_FACTORY_END_ADDR
 128 } GC2355MIPI_FACTORY_REGISTER_INDEX;
 129
 130 typedef enum GC2355MIPI_engineer_index
 131 {
 132   GC2355MIPI_CMMCLK_CURRENT_INDEX = GC2355MIPI_ENGINEER_START_ADDR,
 133   GC2355MIPI_ENGINEER_END
 134 } GC2355MIPI_FACTORY_ENGINEER_INDEX;
 135
 136 typedef struct _sensor_data_struct
 137 {
 138   SENSOR_REG_STRUCT reg[GC2355MIPI_ENGINEER_END];
 139   SENSOR_REG_STRUCT cct[GC2355MIPI_FACTORY_END_ADDR];
 140 } sensor_data_struct;
 141
 142 #define GC2355MIPI_PREVIEW_CLK                   42000000
 143 #define GC2355MIPI_CAPTURE_CLK                   42000000
 144
 145 #define GC2355MIPI_COLOR_FORMAT                    SENSOR_OUTPUT_FORMAT_RAW_B
 146
 147
 148 #define GC2355MIPI_MIN_ANALOG_GAIN                              1       /* 1x */
 149 #define GC2355MIPI_MAX_ANALOG_GAIN                              4       /* 2.8x */
 150
 151
 152 /* FRAME RATE UNIT */
 153 #define GC2355MIPI_FPS(x)                          (10 * (x))
 154
 155 /* SENSOR PIXEL/LINE NUMBERS IN ONE PERIOD */
 156 #define GC2355MIPI_FULL_PERIOD_PIXEL_NUMS          1680
 157 #define GC2355MIPI_FULL_PERIOD_LINE_NUMS           1250
 158
 159 #define GC2355MIPI_VIDEO_PERIOD_PIXEL_NUMS          1680
 160 #define GC2355MIPI_VIDEO_PERIOD_LINE_NUMS           1250
 161
 162 #define GC2355MIPI_PV_PERIOD_PIXEL_NUMS            1680
 163 #define GC2355MIPI_PV_PERIOD_LINE_NUMS             1250
 164
 165 /* SENSOR START/END POSITION */
 166 #define GC2355MIPI_FULL_X_START                    0
 167 #define GC2355MIPI_FULL_Y_START                    0
 168 #define GC2355MIPI_IMAGE_SENSOR_FULL_WIDTH         (1600 - 8)
 169 #define GC2355MIPI_IMAGE_SENSOR_FULL_HEIGHT        (1200 - 6)
 170
 171 #define GC2355MIPI_VIDEO_X_START                      0
 172 #define GC2355MIPI_VIDEO_Y_START                      0
 173 #define GC2355MIPI_IMAGE_SENSOR_VIDEO_WIDTH           (1600)
 174 #define GC2355MIPI_IMAGE_SENSOR_VIDEO_HEIGHT          (1200)
 175
 176 #define GC2355MIPI_PV_X_START                      0
 177 #define GC2355MIPI_PV_Y_START                      0
 178 #define GC2355MIPI_IMAGE_SENSOR_PV_WIDTH           (1600 - 8)
 179 #define GC2355MIPI_IMAGE_SENSOR_PV_HEIGHT          (1200 - 6)
 180
 181 /* SENSOR READ/WRITE ID */
 182 #define GC2355MIPI_WRITE_ID (0x78)
 183 #define GC2355MIPI_READ_ID  (0x79)
 184
 185 /* SENSOR ID */
 186
 187
 188 /* SENSOR PRIVATE STRUCT */
 189 typedef enum {
 190     SENSOR_MODE_INIT = 0,
 191     SENSOR_MODE_PREVIEW,
 192     SENSOR_MODE_VIDEO,
 193     SENSOR_MODE_CAPTURE
 194 } GC2355MIPI_SENSOR_MODE;
 195
 196 typedef enum{
 197         GC2355MIPI_IMAGE_NORMAL = 0,
 198         GC2355MIPI_IMAGE_H_MIRROR,
 199         GC2355MIPI_IMAGE_V_MIRROR,
 200         GC2355MIPI_IMAGE_HV_MIRROR
 201 }GC2355MIPI_IMAGE_MIRROR;
 202
 203 typedef struct GC2355MIPI_sensor_STRUCT
 204 {
 205         MSDK_SENSOR_CONFIG_STRUCT cfg_data;
 206         sensor_data_struct eng; /* engineer mode */
 207         MSDK_SENSOR_ENG_INFO_STRUCT eng_info;
 208         GC2355MIPI_SENSOR_MODE sensorMode;
 209         GC2355MIPI_IMAGE_MIRROR Mirror;
 210         kal_bool pv_mode;
 211         kal_bool video_mode;
 212         kal_bool NightMode;
 213         kal_uint16 normal_fps; /* video normal mode max fps */
 214         kal_uint16 night_fps; /* video night mode max fps */
 215         kal_uint16 FixedFps;
 216         kal_uint16 shutter;
 217         kal_uint16 gain;
 218         kal_uint32 pclk;
 219         kal_uint16 frame_height;
 220         kal_uint16 frame_height_BackUp;
 221         kal_uint16 line_length;
 222         kal_uint16 Prv_line_length;
 223 } GC2355MIPI_sensor_struct;
 224
 225 typedef enum GC2355MIPI_GainMode_Index
 226 {
 227         GC2355MIPI_Analogic_Gain = 0,
 228         GC2355MIPI_Digital_Gain
 229 }GC2355MIPI_GainMode_Index;
 230 //export functions
 231 UINT32 GC2355MIPIOpen(void);
 232 UINT32 GC2355MIPIControl(MSDK_SCENARIO_ID_ENUM ScenarioId, MSDK_SENSOR_EXPOSURE_WINDOW_STRUCT *pImageWindow, MSDK_SENSOR_CONFIG_STRUCT *pSensorConfigData);
 233 UINT32 GC2355MIPIFeatureControl(MSDK_SENSOR_FEATURE_ENUM FeatureId, UINT8 *pFeaturePara,UINT32 *pFeatureParaLen);
 234 UINT32 GC2355MIPIGetInfo(MSDK_SCENARIO_ID_ENUM ScenarioId, MSDK_SENSOR_INFO_STRUCT *pSensorInfo, MSDK_SENSOR_CONFIG_STRUCT *pSensorConfigData);
 235 UINT32 GC2355MIPIGetResolution(MSDK_SENSOR_RESOLUTION_INFO_STRUCT *pSensorResolution);
 236 UINT32 GC2355MIPIClose(void);
 237
 238 #define Sleep(ms) mdelay(ms)
 239
 240 #endif