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