2 * Header for M-5MOLS 8M Pixel camera sensor with ISP
4 * Copyright (C) 2011 Samsung Electronics Co., Ltd.
5 * Author: HeungJun Kim <riverful.kim@samsung.com>
7 * Copyright (C) 2009 Samsung Electronics Co., Ltd.
8 * Author: Dongsoo Nathaniel Kim <dongsoo45.kim@samsung.com>
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.
19 #include <media/v4l2-subdev.h>
20 #include "m5mols_reg.h"
22 extern int m5mols_debug
;
25 M5MOLS_RESTYPE_MONITOR
,
26 M5MOLS_RESTYPE_CAPTURE
,
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
37 struct m5mols_resolution
{
39 enum m5mols_restype type
;
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
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
74 struct m5mols_capture
{
75 struct m5mols_exif exif
;
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
101 * The each value according to each scenemode is recommended in the documents.
103 struct m5mols_scenemode
{
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
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.
141 #define VERSION_STRING_SIZE 22
142 struct m5mols_version
{
149 u8 str
[VERSION_STRING_SIZE
];
154 * struct m5mols_info - M-5MOLS driver data structure
155 * @pdata: platform data
156 * @sd: v4l-subdev instance
158 * @ffmt: current fmt according to resolution type
159 * @res_type: current resolution type
160 * @irq_waitq: waitqueue for the capture
161 * @irq_done: set to 1 in the interrupt handler
162 * @handle: control handler
163 * @auto_exposure: auto/manual exposure control
164 * @exposure_bias: exposure compensation control
165 * @exposure: manual exposure control
166 * @metering: exposure metering control
167 * @auto_iso: auto/manual ISO sensitivity control
168 * @iso: manual ISO sensitivity control
169 * @auto_wb: auto white balance control
170 * @lock_3a: 3A lock control
171 * @colorfx: color effect control
172 * @saturation: saturation control
173 * @zoom: zoom control
174 * @wdr: wide dynamic range control
175 * @stabilization: image stabilization control
176 * @jpeg_quality: JPEG compression quality control
177 * @ver: information of the version
178 * @cap: the capture mode attributes
179 * @isp_ready: 1 when the ISP controller has completed booting
180 * @power: current sensor's power status
181 * @ctrl_sync: 1 when the control handler state is restored in H/W
182 * @resolution: register value for current resolution
183 * @mode: register value for current operation mode
184 * @set_power: optional power callback to the board code
187 const struct m5mols_platform_data
*pdata
;
188 struct v4l2_subdev sd
;
189 struct media_pad pad
;
190 struct v4l2_mbus_framefmt ffmt
[M5MOLS_RESTYPE_MAX
];
193 wait_queue_head_t irq_waitq
;
196 struct v4l2_ctrl_handler handle
;
198 /* exposure/exposure bias/auto exposure cluster */
199 struct v4l2_ctrl
*auto_exposure
;
200 struct v4l2_ctrl
*exposure_bias
;
201 struct v4l2_ctrl
*exposure
;
202 struct v4l2_ctrl
*metering
;
205 /* iso/auto iso cluster */
206 struct v4l2_ctrl
*auto_iso
;
207 struct v4l2_ctrl
*iso
;
209 struct v4l2_ctrl
*auto_wb
;
211 struct v4l2_ctrl
*lock_3a
;
212 struct v4l2_ctrl
*colorfx
;
213 struct v4l2_ctrl
*saturation
;
214 struct v4l2_ctrl
*zoom
;
215 struct v4l2_ctrl
*wdr
;
216 struct v4l2_ctrl
*stabilization
;
217 struct v4l2_ctrl
*jpeg_quality
;
219 struct m5mols_version ver
;
220 struct m5mols_capture cap
;
222 unsigned int isp_ready
:1;
223 unsigned int power
:1;
224 unsigned int ctrl_sync
:1;
229 int (*set_power
)(struct device
*dev
, int on
);
232 #define is_available_af(__info) (__info->ver.af)
233 #define is_code(__code, __type) (__code == m5mols_default_ffmt[__type].code)
234 #define is_manufacturer(__info, __manufacturer) \
235 (__info->ver.str[0] == __manufacturer[0] && \
236 __info->ver.str[1] == __manufacturer[1])
238 * I2C operation of the M-5MOLS
240 * The I2C read operation of the M-5MOLS requires 2 messages. The first
241 * message sends the information about the command, command category, and total
242 * message size. The second message is used to retrieve the data specifed in
245 * 1st message 2nd message
246 * +-------+---+----------+-----+-------+ +------+------+------+------+
247 * | size1 | R | category | cmd | size2 | | d[0] | d[1] | d[2] | d[3] |
248 * +-------+---+----------+-----+-------+ +------+------+------+------+
249 * - size1: message data size(5 in this case)
250 * - size2: desired buffer size of the 2nd message
251 * - d[0..3]: according to size2
253 * The I2C write operation needs just one message. The message includes
254 * category, command, total size, and desired data.
257 * +-------+---+----------+-----+------+------+------+------+
258 * | size1 | W | category | cmd | d[0] | d[1] | d[2] | d[3] |
259 * +-------+---+----------+-----+------+------+------+------+
260 * - d[0..3]: according to size1
262 int m5mols_read_u8(struct v4l2_subdev
*sd
, u32 reg_comb
, u8
*val
);
263 int m5mols_read_u16(struct v4l2_subdev
*sd
, u32 reg_comb
, u16
*val
);
264 int m5mols_read_u32(struct v4l2_subdev
*sd
, u32 reg_comb
, u32
*val
);
265 int m5mols_write(struct v4l2_subdev
*sd
, u32 reg_comb
, u32 val
);
267 int m5mols_busy_wait(struct v4l2_subdev
*sd
, u32 reg
, u32 value
, u32 mask
,
270 /* Mask value for busy waiting until M-5MOLS I2C interface is initialized */
271 #define M5MOLS_I2C_RDY_WAIT_FL (1 << 16)
272 /* ISP state transition timeout, in ms */
273 #define M5MOLS_MODE_CHANGE_TIMEOUT 200
274 #define M5MOLS_BUSY_WAIT_DEF_TIMEOUT 250
277 * Mode operation of the M-5MOLS
279 * Changing the mode of the M-5MOLS is needed right executing order.
280 * There are three modes(PARAMETER, MONITOR, CAPTURE) which can be changed
281 * by user. There are various categories associated with each mode.
283 * +============================================================+
284 * | mode | category |
285 * +============================================================+
286 * | FLASH | FLASH(only after Stand-by or Power-on) |
287 * | SYSTEM | SYSTEM(only after sensor arm-booting) |
288 * | PARAMETER | PARAMETER |
289 * | MONITOR | MONITOR(preview), Auto Focus, Face Detection |
290 * | CAPTURE | Single CAPTURE, Preview(recording) |
291 * +============================================================+
293 * The available executing order between each modes are as follows:
294 * PARAMETER <---> MONITOR <---> CAPTURE
296 int m5mols_set_mode(struct m5mols_info
*info
, u8 mode
);
298 int m5mols_enable_interrupt(struct v4l2_subdev
*sd
, u8 reg
);
299 int m5mols_wait_interrupt(struct v4l2_subdev
*sd
, u8 condition
, u32 timeout
);
300 int m5mols_restore_controls(struct m5mols_info
*info
);
301 int m5mols_start_capture(struct m5mols_info
*info
);
302 int m5mols_do_scenemode(struct m5mols_info
*info
, u8 mode
);
303 int m5mols_lock_3a(struct m5mols_info
*info
, bool lock
);
304 int m5mols_set_ctrl(struct v4l2_ctrl
*ctrl
);
305 int m5mols_init_controls(struct v4l2_subdev
*sd
);
307 /* The firmware function */
308 int m5mols_update_fw(struct v4l2_subdev
*sd
,
309 int (*set_power
)(struct m5mols_info
*, bool));
311 static inline struct m5mols_info
*to_m5mols(struct v4l2_subdev
*subdev
)
313 return container_of(subdev
, struct m5mols_info
, sd
);
316 static inline struct v4l2_subdev
*to_sd(struct v4l2_ctrl
*ctrl
)
318 struct m5mols_info
*info
= container_of(ctrl
->handler
,
319 struct m5mols_info
, handle
);
323 static inline void m5mols_set_ctrl_mode(struct v4l2_ctrl
*ctrl
,
326 ctrl
->priv
= (void *)mode
;
329 static inline unsigned int m5mols_get_ctrl_mode(struct v4l2_ctrl
*ctrl
)
331 return (unsigned int)ctrl
->priv
;
334 #endif /* M5MOLS_H */