451 lines · c
1/* SPDX-License-Identifier: GPL-2.0-only */2/*3 * Samsung LSI S5C73M3 8M pixel camera driver4 *5 * Copyright (C) 2012, Samsung Electronics, Co., Ltd.6 * Sylwester Nawrocki <s.nawrocki@samsung.com>7 * Andrzej Hajda <a.hajda@samsung.com>8 */9#ifndef S5C73M3_H_10#define S5C73M3_H_11 12#include <linux/clk.h>13#include <linux/kernel.h>14#include <linux/regulator/consumer.h>15#include <linux/gpio/consumer.h>16#include <media/v4l2-common.h>17#include <media/v4l2-ctrls.h>18#include <media/v4l2-subdev.h>19 20#define DRIVER_NAME "S5C73M3"21 22#define S5C73M3_ISP_FMT MEDIA_BUS_FMT_VYUY8_2X823#define S5C73M3_JPEG_FMT MEDIA_BUS_FMT_S5C_UYVY_JPEG_1X824 25/* Subdevs pad index definitions */26enum s5c73m3_pads {27 S5C73M3_ISP_PAD,28 S5C73M3_JPEG_PAD,29 S5C73M3_NUM_PADS30};31 32enum s5c73m3_oif_pads {33 OIF_ISP_PAD,34 OIF_JPEG_PAD,35 OIF_SOURCE_PAD,36 OIF_NUM_PADS37};38 39#define S5C73M3_SENSOR_FW_LEN 640#define S5C73M3_SENSOR_TYPE_LEN 1241 42#define S5C73M3_REG(_addrh, _addrl) (((_addrh) << 16) | _addrl)43 44#define AHB_MSB_ADDR_PTR 0xfcfc45#define REG_CMDWR_ADDRH 0x005046#define REG_CMDWR_ADDRL 0x005447#define REG_CMDRD_ADDRH 0x005848#define REG_CMDRD_ADDRL 0x005c49#define REG_CMDBUF_ADDR 0x0f1450 51#define REG_I2C_SEQ_STATUS S5C73M3_REG(0x0009, 0x59A6)52#define SEQ_END_PLL (1<<0x0)53#define SEQ_END_SENSOR (1<<0x1)54#define SEQ_END_GPIO (1<<0x2)55#define SEQ_END_FROM (1<<0x3)56#define SEQ_END_STABLE_AE_AWB (1<<0x4)57#define SEQ_END_READY_I2C_CMD (1<<0x5)58 59#define REG_I2C_STATUS S5C73M3_REG(0x0009, 0x599E)60#define I2C_STATUS_CIS_I2C (1<<0x0)61#define I2C_STATUS_AF_INIT (1<<0x1)62#define I2C_STATUS_CAL_DATA (1<<0x2)63#define I2C_STATUS_FRAME_COUNT (1<<0x3)64#define I2C_STATUS_FROM_INIT (1<<0x4)65#define I2C_STATUS_I2C_CIS_STREAM_OFF (1<<0x5)66#define I2C_STATUS_I2C_N_CMD_OVER (1<<0x6)67#define I2C_STATUS_I2C_N_CMD_MISMATCH (1<<0x7)68#define I2C_STATUS_CHECK_BIN_CRC (1<<0x8)69#define I2C_STATUS_EXCEPTION (1<<0x9)70#define I2C_STATUS_INIF_INIT_STATE (0x8)71 72#define REG_STATUS S5C73M3_REG(0x0009, 0x5080)73#define REG_STATUS_BOOT_SUB_MAIN_ENTER 0xff0174#define REG_STATUS_BOOT_SRAM_TIMING_OK 0xff0275#define REG_STATUS_BOOT_INTERRUPTS_EN 0xff0376#define REG_STATUS_BOOT_R_PLL_DONE 0xff0477#define REG_STATUS_BOOT_R_PLL_LOCKTIME_DONE 0xff0578#define REG_STATUS_BOOT_DELAY_COUNT_DONE 0xff0679#define REG_STATUS_BOOT_I_PLL_DONE 0xff0780#define REG_STATUS_BOOT_I_PLL_LOCKTIME_DONE 0xff0881#define REG_STATUS_BOOT_PLL_INIT_OK 0xff0982#define REG_STATUS_BOOT_SENSOR_INIT_OK 0xff0a83#define REG_STATUS_BOOT_GPIO_SETTING_OK 0xff0b84#define REG_STATUS_BOOT_READ_CAL_DATA_OK 0xff0c85#define REG_STATUS_BOOT_STABLE_AE_AWB_OK 0xff0d86#define REG_STATUS_ISP_COMMAND_COMPLETED 0xffff87#define REG_STATUS_EXCEPTION_OCCURED 0xdead88 89#define COMM_RESULT_OFFSET S5C73M3_REG(0x0009, 0x5000)90 91#define COMM_IMG_OUTPUT 0x090292#define COMM_IMG_OUTPUT_HDR 0x000893#define COMM_IMG_OUTPUT_YUV 0x000994#define COMM_IMG_OUTPUT_INTERLEAVED 0x000d95 96#define COMM_STILL_PRE_FLASH 0x0a0097#define COMM_STILL_PRE_FLASH_FIRE 0x000098#define COMM_STILL_PRE_FLASH_NON_FIRED 0x000099#define COMM_STILL_PRE_FLASH_FIRED 0x0001100 101#define COMM_STILL_MAIN_FLASH 0x0a02102#define COMM_STILL_MAIN_FLASH_CANCEL 0x0001103#define COMM_STILL_MAIN_FLASH_FIRE 0x0002104 105#define COMM_ZOOM_STEP 0x0b00106 107#define COMM_IMAGE_EFFECT 0x0b0a108#define COMM_IMAGE_EFFECT_NONE 0x0001109#define COMM_IMAGE_EFFECT_NEGATIVE 0x0002110#define COMM_IMAGE_EFFECT_AQUA 0x0003111#define COMM_IMAGE_EFFECT_SEPIA 0x0004112#define COMM_IMAGE_EFFECT_MONO 0x0005113 114#define COMM_IMAGE_QUALITY 0x0b0c115#define COMM_IMAGE_QUALITY_SUPERFINE 0x0000116#define COMM_IMAGE_QUALITY_FINE 0x0001117#define COMM_IMAGE_QUALITY_NORMAL 0x0002118 119#define COMM_FLASH_MODE 0x0b0e120#define COMM_FLASH_MODE_OFF 0x0000121#define COMM_FLASH_MODE_ON 0x0001122#define COMM_FLASH_MODE_AUTO 0x0002123 124#define COMM_FLASH_STATUS 0x0b80125#define COMM_FLASH_STATUS_OFF 0x0001126#define COMM_FLASH_STATUS_ON 0x0002127#define COMM_FLASH_STATUS_AUTO 0x0003128 129#define COMM_FLASH_TORCH 0x0b12130#define COMM_FLASH_TORCH_OFF 0x0000131#define COMM_FLASH_TORCH_ON 0x0001132 133#define COMM_AE_NEEDS_FLASH 0x0cba134#define COMM_AE_NEEDS_FLASH_OFF 0x0000135#define COMM_AE_NEEDS_FLASH_ON 0x0001136 137#define COMM_CHG_MODE 0x0b10138#define COMM_CHG_MODE_NEW 0x8000139#define COMM_CHG_MODE_SUBSAMPLING_HALF 0x2000140#define COMM_CHG_MODE_SUBSAMPLING_QUARTER 0x4000141 142#define COMM_CHG_MODE_YUV_320_240 0x0001143#define COMM_CHG_MODE_YUV_640_480 0x0002144#define COMM_CHG_MODE_YUV_880_720 0x0003145#define COMM_CHG_MODE_YUV_960_720 0x0004146#define COMM_CHG_MODE_YUV_1184_666 0x0005147#define COMM_CHG_MODE_YUV_1280_720 0x0006148#define COMM_CHG_MODE_YUV_1536_864 0x0007149#define COMM_CHG_MODE_YUV_1600_1200 0x0008150#define COMM_CHG_MODE_YUV_1632_1224 0x0009151#define COMM_CHG_MODE_YUV_1920_1080 0x000a152#define COMM_CHG_MODE_YUV_1920_1440 0x000b153#define COMM_CHG_MODE_YUV_2304_1296 0x000c154#define COMM_CHG_MODE_YUV_3264_2448 0x000d155#define COMM_CHG_MODE_YUV_352_288 0x000e156#define COMM_CHG_MODE_YUV_1008_672 0x000f157 158#define COMM_CHG_MODE_JPEG_640_480 0x0010159#define COMM_CHG_MODE_JPEG_800_450 0x0020160#define COMM_CHG_MODE_JPEG_800_600 0x0030161#define COMM_CHG_MODE_JPEG_1280_720 0x0040162#define COMM_CHG_MODE_JPEG_1280_960 0x0050163#define COMM_CHG_MODE_JPEG_1600_900 0x0060164#define COMM_CHG_MODE_JPEG_1600_1200 0x0070165#define COMM_CHG_MODE_JPEG_2048_1152 0x0080166#define COMM_CHG_MODE_JPEG_2048_1536 0x0090167#define COMM_CHG_MODE_JPEG_2560_1440 0x00a0168#define COMM_CHG_MODE_JPEG_2560_1920 0x00b0169#define COMM_CHG_MODE_JPEG_3264_2176 0x00c0170#define COMM_CHG_MODE_JPEG_1024_768 0x00d0171#define COMM_CHG_MODE_JPEG_3264_1836 0x00e0172#define COMM_CHG_MODE_JPEG_3264_2448 0x00f0173 174#define COMM_AF_CON 0x0e00175#define COMM_AF_CON_STOP 0x0000176#define COMM_AF_CON_SCAN 0x0001 /* Full Search */177#define COMM_AF_CON_START 0x0002 /* Fast Search */178 179#define COMM_AF_CAL 0x0e06180#define COMM_AF_TOUCH_AF 0x0e0a181 182#define REG_AF_STATUS S5C73M3_REG(0x0009, 0x5e80)183#define REG_CAF_STATUS_FIND_SEARCH_DIR 0x0001184#define REG_CAF_STATUS_FOCUSING 0x0002185#define REG_CAF_STATUS_FOCUSED 0x0003186#define REG_CAF_STATUS_UNFOCUSED 0x0004187#define REG_AF_STATUS_INVALID 0x0010188#define REG_AF_STATUS_FOCUSING 0x0020189#define REG_AF_STATUS_FOCUSED 0x0030190#define REG_AF_STATUS_UNFOCUSED 0x0040191 192#define REG_AF_TOUCH_POSITION S5C73M3_REG(0x0009, 0x5e8e)193#define COMM_AF_FACE_ZOOM 0x0e10194 195#define COMM_AF_MODE 0x0e02196#define COMM_AF_MODE_NORMAL 0x0000197#define COMM_AF_MODE_MACRO 0x0001198#define COMM_AF_MODE_MOVIE_CAF_START 0x0002199#define COMM_AF_MODE_MOVIE_CAF_STOP 0x0003200#define COMM_AF_MODE_PREVIEW_CAF_START 0x0004201#define COMM_AF_MODE_PREVIEW_CAF_STOP 0x0005202 203#define COMM_AF_SOFTLANDING 0x0e16204#define COMM_AF_SOFTLANDING_ON 0x0000205#define COMM_AF_SOFTLANDING_RES_COMPLETE 0x0001206 207#define COMM_FACE_DET 0x0e0c208#define COMM_FACE_DET_OFF 0x0000209#define COMM_FACE_DET_ON 0x0001210 211#define COMM_FACE_DET_OSD 0x0e0e212#define COMM_FACE_DET_OSD_OFF 0x0000213#define COMM_FACE_DET_OSD_ON 0x0001214 215#define COMM_AE_CON 0x0c00216#define COMM_AE_STOP 0x0000 /* lock */217#define COMM_AE_START 0x0001 /* unlock */218 219#define COMM_ISO 0x0c02220#define COMM_ISO_AUTO 0x0000221#define COMM_ISO_100 0x0001222#define COMM_ISO_200 0x0002223#define COMM_ISO_400 0x0003224#define COMM_ISO_800 0x0004225#define COMM_ISO_SPORTS 0x0005226#define COMM_ISO_NIGHT 0x0006227#define COMM_ISO_INDOOR 0x0007228 229/* 0x00000 (-2.0 EV)...0x0008 (2.0 EV), 0.5EV step */230#define COMM_EV 0x0c04231 232#define COMM_METERING 0x0c06233#define COMM_METERING_CENTER 0x0000234#define COMM_METERING_SPOT 0x0001235#define COMM_METERING_AVERAGE 0x0002236#define COMM_METERING_SMART 0x0003237 238#define COMM_WDR 0x0c08239#define COMM_WDR_OFF 0x0000240#define COMM_WDR_ON 0x0001241 242#define COMM_FLICKER_MODE 0x0c12243#define COMM_FLICKER_NONE 0x0000244#define COMM_FLICKER_MANUAL_50HZ 0x0001245#define COMM_FLICKER_MANUAL_60HZ 0x0002246#define COMM_FLICKER_AUTO 0x0003247#define COMM_FLICKER_AUTO_50HZ 0x0004248#define COMM_FLICKER_AUTO_60HZ 0x0005249 250#define COMM_FRAME_RATE 0x0c1e251#define COMM_FRAME_RATE_AUTO_SET 0x0000252#define COMM_FRAME_RATE_FIXED_30FPS 0x0002253#define COMM_FRAME_RATE_FIXED_20FPS 0x0003254#define COMM_FRAME_RATE_FIXED_15FPS 0x0004255#define COMM_FRAME_RATE_FIXED_60FPS 0x0007256#define COMM_FRAME_RATE_FIXED_120FPS 0x0008257#define COMM_FRAME_RATE_FIXED_7FPS 0x0009258#define COMM_FRAME_RATE_FIXED_10FPS 0x000a259#define COMM_FRAME_RATE_FIXED_90FPS 0x000b260#define COMM_FRAME_RATE_ANTI_SHAKE 0x0013261 262/* 0x0000...0x0004 -> sharpness: 0, 1, 2, -1, -2 */263#define COMM_SHARPNESS 0x0c14264 265/* 0x0000...0x0004 -> saturation: 0, 1, 2, -1, -2 */266#define COMM_SATURATION 0x0c16267 268/* 0x0000...0x0004 -> contrast: 0, 1, 2, -1, -2 */269#define COMM_CONTRAST 0x0c18270 271#define COMM_SCENE_MODE 0x0c1a272#define COMM_SCENE_MODE_NONE 0x0000273#define COMM_SCENE_MODE_PORTRAIT 0x0001274#define COMM_SCENE_MODE_LANDSCAPE 0x0002275#define COMM_SCENE_MODE_SPORTS 0x0003276#define COMM_SCENE_MODE_INDOOR 0x0004277#define COMM_SCENE_MODE_BEACH 0x0005278#define COMM_SCENE_MODE_SUNSET 0x0006279#define COMM_SCENE_MODE_DAWN 0x0007280#define COMM_SCENE_MODE_FALL 0x0008281#define COMM_SCENE_MODE_NIGHT 0x0009282#define COMM_SCENE_MODE_AGAINST_LIGHT 0x000a283#define COMM_SCENE_MODE_FIRE 0x000b284#define COMM_SCENE_MODE_TEXT 0x000c285#define COMM_SCENE_MODE_CANDLE 0x000d286 287#define COMM_AE_AUTO_BRACKET 0x0b14288#define COMM_AE_AUTO_BRAKET_EV05 0x0080289#define COMM_AE_AUTO_BRAKET_EV10 0x0100290#define COMM_AE_AUTO_BRAKET_EV15 0x0180291#define COMM_AE_AUTO_BRAKET_EV20 0x0200292 293#define COMM_SENSOR_STREAMING 0x090a294#define COMM_SENSOR_STREAMING_OFF 0x0000295#define COMM_SENSOR_STREAMING_ON 0x0001296 297#define COMM_AWB_MODE 0x0d02298#define COMM_AWB_MODE_INCANDESCENT 0x0000299#define COMM_AWB_MODE_FLUORESCENT1 0x0001300#define COMM_AWB_MODE_FLUORESCENT2 0x0002301#define COMM_AWB_MODE_DAYLIGHT 0x0003302#define COMM_AWB_MODE_CLOUDY 0x0004303#define COMM_AWB_MODE_AUTO 0x0005304 305#define COMM_AWB_CON 0x0d00306#define COMM_AWB_STOP 0x0000 /* lock */307#define COMM_AWB_START 0x0001 /* unlock */308 309#define COMM_FW_UPDATE 0x0906310#define COMM_FW_UPDATE_NOT_READY 0x0000311#define COMM_FW_UPDATE_SUCCESS 0x0005312#define COMM_FW_UPDATE_FAIL 0x0007313#define COMM_FW_UPDATE_BUSY 0xffff314 315 316#define S5C73M3_MAX_SUPPLIES 6317#define S5C73M3_DEFAULT_MCLK_FREQ 24000000U318 319struct s5c73m3_ctrls {320 struct v4l2_ctrl_handler handler;321 struct {322 /* exposure/exposure bias cluster */323 struct v4l2_ctrl *auto_exposure;324 struct v4l2_ctrl *exposure_bias;325 struct v4l2_ctrl *exposure_metering;326 };327 struct {328 /* iso/auto iso cluster */329 struct v4l2_ctrl *auto_iso;330 struct v4l2_ctrl *iso;331 };332 struct v4l2_ctrl *auto_wb;333 struct {334 /* continuous auto focus/auto focus cluster */335 struct v4l2_ctrl *focus_auto;336 struct v4l2_ctrl *af_start;337 struct v4l2_ctrl *af_stop;338 struct v4l2_ctrl *af_status;339 struct v4l2_ctrl *af_distance;340 };341 342 struct v4l2_ctrl *aaa_lock;343 struct v4l2_ctrl *colorfx;344 struct v4l2_ctrl *contrast;345 struct v4l2_ctrl *saturation;346 struct v4l2_ctrl *sharpness;347 struct v4l2_ctrl *zoom;348 struct v4l2_ctrl *wdr;349 struct v4l2_ctrl *stabilization;350 struct v4l2_ctrl *jpeg_quality;351 struct v4l2_ctrl *scene_mode;352};353 354enum s5c73m3_resolution_types {355 RES_ISP,356 RES_JPEG,357};358 359struct s5c73m3_interval {360 u16 fps_reg;361 struct v4l2_fract interval;362 /* Maximum rectangle for the interval */363 struct v4l2_frmsize_discrete size;364};365 366struct s5c73m3 {367 struct v4l2_subdev sensor_sd;368 struct media_pad sensor_pads[S5C73M3_NUM_PADS];369 370 struct v4l2_subdev oif_sd;371 struct media_pad oif_pads[OIF_NUM_PADS];372 373 struct spi_driver spidrv;374 struct spi_device *spi_dev;375 struct i2c_client *i2c_client;376 u32 i2c_write_address;377 u32 i2c_read_address;378 379 struct regulator_bulk_data supplies[S5C73M3_MAX_SUPPLIES];380 struct gpio_desc *stby;381 struct gpio_desc *reset;382 383 struct clk *clock;384 385 /* External master clock frequency */386 u32 mclk_frequency;387 /* Video bus type - MIPI-CSI2/parallel */388 enum v4l2_mbus_type bus_type;389 390 const struct s5c73m3_frame_size *sensor_pix_size[2];391 const struct s5c73m3_frame_size *oif_pix_size[2];392 u32 mbus_code;393 394 const struct s5c73m3_interval *fiv;395 396 struct v4l2_mbus_frame_desc frame_desc;397 /* protects the struct members below */398 struct mutex lock;399 400 struct s5c73m3_ctrls ctrls;401 402 u8 streaming:1;403 u8 apply_fmt:1;404 u8 apply_fiv:1;405 u8 isp_ready:1;406 407 short power;408 409 char sensor_fw[S5C73M3_SENSOR_FW_LEN + 2];410 char sensor_type[S5C73M3_SENSOR_TYPE_LEN + 2];411 char fw_file_version[2];412 unsigned int fw_size;413};414 415struct s5c73m3_frame_size {416 u32 width;417 u32 height;418 u8 reg_val;419};420 421extern int s5c73m3_dbg;422 423int s5c73m3_register_spi_driver(struct s5c73m3 *state);424void s5c73m3_unregister_spi_driver(struct s5c73m3 *state);425int s5c73m3_spi_write(struct s5c73m3 *state, const void *addr,426 const unsigned int len, const unsigned int tx_size);427int s5c73m3_spi_read(struct s5c73m3 *state, void *addr,428 const unsigned int len, const unsigned int tx_size);429 430int s5c73m3_read(struct s5c73m3 *state, u32 addr, u16 *data);431int s5c73m3_write(struct s5c73m3 *state, u32 addr, u16 data);432int s5c73m3_isp_command(struct s5c73m3 *state, u16 command, u16 data);433int s5c73m3_init_controls(struct s5c73m3 *state);434 435static inline struct v4l2_subdev *ctrl_to_sensor_sd(struct v4l2_ctrl *ctrl)436{437 return &container_of(ctrl->handler, struct s5c73m3,438 ctrls.handler)->sensor_sd;439}440 441static inline struct s5c73m3 *sensor_sd_to_s5c73m3(struct v4l2_subdev *sd)442{443 return container_of(sd, struct s5c73m3, sensor_sd);444}445 446static inline struct s5c73m3 *oif_sd_to_s5c73m3(struct v4l2_subdev *sd)447{448 return container_of(sd, struct s5c73m3, oif_sd);449}450#endif /* S5C73M3_H_ */451