m5mols.h revision 5565a2ad47cdd8e697a28137bd8379455667bc1c
1/* 2 * Header for M-5MOLS 8M Pixel camera sensor with ISP 3 * 4 * Copyright (C) 2011 Samsung Electronics Co., Ltd. 5 * Author: HeungJun Kim <riverful.kim@samsung.com> 6 * 7 * Copyright (C) 2009 Samsung Electronics Co., Ltd. 8 * Author: Dongsoo Nathaniel Kim <dongsoo45.kim@samsung.com> 9 * 10 * This program is free software; you can redistribute it and/or modify 11 * it under the terms of the GNU General Public License as published by 12 * the Free Software Foundation; either version 2 of the License, or 13 * (at your option) any later version. 14 */ 15 16#ifndef M5MOLS_H 17#define M5MOLS_H 18 19#include <media/v4l2-subdev.h> 20#include "m5mols_reg.h" 21 22extern int m5mols_debug; 23 24enum m5mols_restype { 25 M5MOLS_RESTYPE_MONITOR, 26 M5MOLS_RESTYPE_CAPTURE, 27 M5MOLS_RESTYPE_MAX, 28}; 29 30/** 31 * struct m5mols_resolution - structure for the resolution 32 * @type: resolution type according to the pixel code 33 * @width: width of the resolution 34 * @height: height of the resolution 35 * @reg: resolution preset register value 36 */ 37struct m5mols_resolution { 38 u8 reg; 39 enum m5mols_restype type; 40 u16 width; 41 u16 height; 42}; 43 44/** 45 * struct m5mols_exif - structure for the EXIF information of M-5MOLS 46 * @exposure_time: exposure time register value 47 * @shutter_speed: speed of the shutter register value 48 * @aperture: aperture register value 49 * @exposure_bias: it calls also EV bias 50 * @iso_speed: ISO register value 51 * @flash: status register value of the flash 52 * @sdr: status register value of the Subject Distance Range 53 * @qval: not written exact meaning in document 54 */ 55struct m5mols_exif { 56 u32 exposure_time; 57 u32 shutter_speed; 58 u32 aperture; 59 u32 brightness; 60 u32 exposure_bias; 61 u16 iso_speed; 62 u16 flash; 63 u16 sdr; 64 u16 qval; 65}; 66 67/** 68 * struct m5mols_capture - Structure for the capture capability 69 * @exif: EXIF information 70 * @main: size in bytes of the main image 71 * @thumb: size in bytes of the thumb image, if it was accompanied 72 * @total: total size in bytes of the produced image 73 */ 74struct m5mols_capture { 75 struct m5mols_exif exif; 76 u32 main; 77 u32 thumb; 78 u32 total; 79}; 80 81/** 82 * struct m5mols_scenemode - structure for the scenemode capability 83 * @metering: metering light register value 84 * @ev_bias: EV bias register value 85 * @wb_mode: mode which means the WhiteBalance is Auto or Manual 86 * @wb_preset: whitebalance preset register value in the Manual mode 87 * @chroma_en: register value whether the Chroma capability is enabled or not 88 * @chroma_lvl: chroma's level register value 89 * @edge_en: register value Whether the Edge capability is enabled or not 90 * @edge_lvl: edge's level register value 91 * @af_range: Auto Focus's range 92 * @fd_mode: Face Detection mode 93 * @mcc: Multi-axis Color Conversion which means emotion color 94 * @light: status of the Light 95 * @flash: status of the Flash 96 * @tone: Tone color which means Contrast 97 * @iso: ISO register value 98 * @capt_mode: Mode of the Image Stabilization while the camera capturing 99 * @wdr: Wide Dynamic Range register value 100 * 101 * The each value according to each scenemode is recommended in the documents. 102 */ 103struct m5mols_scenemode { 104 u8 metering; 105 u8 ev_bias; 106 u8 wb_mode; 107 u8 wb_preset; 108 u8 chroma_en; 109 u8 chroma_lvl; 110 u8 edge_en; 111 u8 edge_lvl; 112 u8 af_range; 113 u8 fd_mode; 114 u8 mcc; 115 u8 light; 116 u8 flash; 117 u8 tone; 118 u8 iso; 119 u8 capt_mode; 120 u8 wdr; 121}; 122 123/** 124 * struct m5mols_version - firmware version information 125 * @customer: customer information 126 * @project: version of project information according to customer 127 * @fw: firmware revision 128 * @hw: hardware revision 129 * @param: version of the parameter 130 * @awb: Auto WhiteBalance algorithm version 131 * @str: information about manufacturer and packaging vendor 132 * @af: Auto Focus version 133 * 134 * The register offset starts the customer version at 0x0, and it ends 135 * the awb version at 0x09. The customer, project information occupies 1 bytes 136 * each. And also the fw, hw, param, awb each requires 2 bytes. The str is 137 * unique string associated with firmware's version. It includes information 138 * about manufacturer and the vendor of the sensor's packaging. The least 139 * significant 2 bytes of the string indicate packaging manufacturer. 140 */ 141#define VERSION_STRING_SIZE 22 142struct m5mols_version { 143 u8 customer; 144 u8 project; 145 u16 fw; 146 u16 hw; 147 u16 param; 148 u16 awb; 149 u8 str[VERSION_STRING_SIZE]; 150 u8 af; 151}; 152 153/** 154 * struct m5mols_info - M-5MOLS driver data structure 155 * @pdata: platform data 156 * @sd: v4l-subdev instance 157 * @pad: media pad 158 * @irq_waitq: waitqueue for the capture 159 * @irq_done: set to 1 in the interrupt handler 160 * @handle: control handler 161 * @auto_exposure: auto/manual exposure control 162 * @exposure_bias: exposure compensation control 163 * @exposure: manual exposure control 164 * @metering: exposure metering control 165 * @auto_iso: auto/manual ISO sensitivity control 166 * @iso: manual ISO sensitivity control 167 * @auto_wb: auto white balance control 168 * @lock_3a: 3A lock control 169 * @colorfx: color effect control 170 * @saturation: saturation control 171 * @zoom: zoom control 172 * @wdr: wide dynamic range control 173 * @stabilization: image stabilization control 174 * @jpeg_quality: JPEG compression quality control 175 * @set_power: optional power callback to the board code 176 * @lock: mutex protecting the structure fields below 177 * @ffmt: current fmt according to resolution type 178 * @res_type: current resolution type 179 * @ver: information of the version 180 * @cap: the capture mode attributes 181 * @isp_ready: 1 when the ISP controller has completed booting 182 * @power: current sensor's power status 183 * @ctrl_sync: 1 when the control handler state is restored in H/W 184 * @resolution: register value for current resolution 185 * @mode: register value for current operation mode 186 */ 187struct m5mols_info { 188 const struct m5mols_platform_data *pdata; 189 struct v4l2_subdev sd; 190 struct media_pad pad; 191 192 wait_queue_head_t irq_waitq; 193 atomic_t irq_done; 194 195 struct v4l2_ctrl_handler handle; 196 struct { 197 /* exposure/exposure bias/auto exposure cluster */ 198 struct v4l2_ctrl *auto_exposure; 199 struct v4l2_ctrl *exposure_bias; 200 struct v4l2_ctrl *exposure; 201 struct v4l2_ctrl *metering; 202 }; 203 struct { 204 /* iso/auto iso cluster */ 205 struct v4l2_ctrl *auto_iso; 206 struct v4l2_ctrl *iso; 207 }; 208 struct v4l2_ctrl *auto_wb; 209 210 struct v4l2_ctrl *lock_3a; 211 struct v4l2_ctrl *colorfx; 212 struct v4l2_ctrl *saturation; 213 struct v4l2_ctrl *zoom; 214 struct v4l2_ctrl *wdr; 215 struct v4l2_ctrl *stabilization; 216 struct v4l2_ctrl *jpeg_quality; 217 218 int (*set_power)(struct device *dev, int on); 219 220 struct mutex lock; 221 222 struct v4l2_mbus_framefmt ffmt[M5MOLS_RESTYPE_MAX]; 223 int res_type; 224 225 struct m5mols_version ver; 226 struct m5mols_capture cap; 227 228 unsigned int isp_ready:1; 229 unsigned int power:1; 230 unsigned int ctrl_sync:1; 231 232 u8 resolution; 233 u8 mode; 234}; 235 236#define is_available_af(__info) (__info->ver.af) 237#define is_code(__code, __type) (__code == m5mols_default_ffmt[__type].code) 238#define is_manufacturer(__info, __manufacturer) \ 239 (__info->ver.str[0] == __manufacturer[0] && \ 240 __info->ver.str[1] == __manufacturer[1]) 241/* 242 * I2C operation of the M-5MOLS 243 * 244 * The I2C read operation of the M-5MOLS requires 2 messages. The first 245 * message sends the information about the command, command category, and total 246 * message size. The second message is used to retrieve the data specifed in 247 * the first message 248 * 249 * 1st message 2nd message 250 * +-------+---+----------+-----+-------+ +------+------+------+------+ 251 * | size1 | R | category | cmd | size2 | | d[0] | d[1] | d[2] | d[3] | 252 * +-------+---+----------+-----+-------+ +------+------+------+------+ 253 * - size1: message data size(5 in this case) 254 * - size2: desired buffer size of the 2nd message 255 * - d[0..3]: according to size2 256 * 257 * The I2C write operation needs just one message. The message includes 258 * category, command, total size, and desired data. 259 * 260 * 1st message 261 * +-------+---+----------+-----+------+------+------+------+ 262 * | size1 | W | category | cmd | d[0] | d[1] | d[2] | d[3] | 263 * +-------+---+----------+-----+------+------+------+------+ 264 * - d[0..3]: according to size1 265 */ 266int m5mols_read_u8(struct v4l2_subdev *sd, u32 reg_comb, u8 *val); 267int m5mols_read_u16(struct v4l2_subdev *sd, u32 reg_comb, u16 *val); 268int m5mols_read_u32(struct v4l2_subdev *sd, u32 reg_comb, u32 *val); 269int m5mols_write(struct v4l2_subdev *sd, u32 reg_comb, u32 val); 270 271int m5mols_busy_wait(struct v4l2_subdev *sd, u32 reg, u32 value, u32 mask, 272 int timeout); 273 274/* Mask value for busy waiting until M-5MOLS I2C interface is initialized */ 275#define M5MOLS_I2C_RDY_WAIT_FL (1 << 16) 276/* ISP state transition timeout, in ms */ 277#define M5MOLS_MODE_CHANGE_TIMEOUT 200 278#define M5MOLS_BUSY_WAIT_DEF_TIMEOUT 250 279 280/* 281 * Mode operation of the M-5MOLS 282 * 283 * Changing the mode of the M-5MOLS is needed right executing order. 284 * There are three modes(PARAMETER, MONITOR, CAPTURE) which can be changed 285 * by user. There are various categories associated with each mode. 286 * 287 * +============================================================+ 288 * | mode | category | 289 * +============================================================+ 290 * | FLASH | FLASH(only after Stand-by or Power-on) | 291 * | SYSTEM | SYSTEM(only after sensor arm-booting) | 292 * | PARAMETER | PARAMETER | 293 * | MONITOR | MONITOR(preview), Auto Focus, Face Detection | 294 * | CAPTURE | Single CAPTURE, Preview(recording) | 295 * +============================================================+ 296 * 297 * The available executing order between each modes are as follows: 298 * PARAMETER <---> MONITOR <---> CAPTURE 299 */ 300int m5mols_set_mode(struct m5mols_info *info, u8 mode); 301 302int m5mols_enable_interrupt(struct v4l2_subdev *sd, u8 reg); 303int m5mols_wait_interrupt(struct v4l2_subdev *sd, u8 condition, u32 timeout); 304int m5mols_restore_controls(struct m5mols_info *info); 305int m5mols_start_capture(struct m5mols_info *info); 306int m5mols_do_scenemode(struct m5mols_info *info, u8 mode); 307int m5mols_lock_3a(struct m5mols_info *info, bool lock); 308int m5mols_set_ctrl(struct v4l2_ctrl *ctrl); 309int m5mols_init_controls(struct v4l2_subdev *sd); 310 311/* The firmware function */ 312int m5mols_update_fw(struct v4l2_subdev *sd, 313 int (*set_power)(struct m5mols_info *, bool)); 314 315static inline struct m5mols_info *to_m5mols(struct v4l2_subdev *subdev) 316{ 317 return container_of(subdev, struct m5mols_info, sd); 318} 319 320static inline struct v4l2_subdev *to_sd(struct v4l2_ctrl *ctrl) 321{ 322 struct m5mols_info *info = container_of(ctrl->handler, 323 struct m5mols_info, handle); 324 return &info->sd; 325} 326 327static inline void m5mols_set_ctrl_mode(struct v4l2_ctrl *ctrl, 328 unsigned int mode) 329{ 330 ctrl->priv = (void *)(uintptr_t)mode; 331} 332 333static inline unsigned int m5mols_get_ctrl_mode(struct v4l2_ctrl *ctrl) 334{ 335 return (unsigned int)(uintptr_t)ctrl->priv; 336} 337 338#endif /* M5MOLS_H */ 339