drivers/media/video/m5mols/m5mols.h

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