i2c/ccs/ccs.h

0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * drivers/media/i2c/smiapp/ccs.h
0004  *
0005  * Generic driver for MIPI CCS/SMIA/SMIA++ compliant camera sensors
0006  *
0007  * Copyright (C) 2020 Intel Corporation
0008  * Copyright (C) 2010--2012 Nokia Corporation
0009  * Contact: Sakari Ailus <sakari.ailus@linux.intel.com>
0010  */
0011
0012 #ifndef __CCS_H__
0013 #define __CCS_H__
0014
0015 #include <linux/mutex.h>
0016 #include <media/v4l2-ctrls.h>
0017 #include <media/v4l2-subdev.h>
0018
0019 #include "ccs-data.h"
0020 #include "ccs-limits.h"
0021 #include "ccs-quirk.h"
0022 #include "ccs-regs.h"
0023 #include "ccs-reg-access.h"
0024 #include "../ccs-pll.h"
0025 #include "smiapp-reg-defs.h"
0026
0027 /*
0028  * Standard SMIA++ constants
0029  */
0030 #define SMIA_VERSION_1          10
0031 #define SMIAPP_VERSION_0_8      8 /* Draft 0.8 */
0032 #define SMIAPP_VERSION_0_9      9 /* Draft 0.9 */
0033 #define SMIAPP_VERSION_1        10
0034
0035 #define SMIAPP_PROFILE_0        0
0036 #define SMIAPP_PROFILE_1        1
0037 #define SMIAPP_PROFILE_2        2
0038
0039 #define SMIAPP_NVM_PAGE_SIZE        64  /* bytes */
0040
0041 #define SMIAPP_RESET_DELAY_CLOCKS   2400
0042 #define SMIAPP_RESET_DELAY(clk)             \
0043     (1000 + (SMIAPP_RESET_DELAY_CLOCKS * 1000   \
0044          + (clk) / 1000 - 1) / ((clk) / 1000))
0045
0046 #define CCS_COLOUR_COMPONENTS       4
0047
0048 #define SMIAPP_NAME         "smiapp"
0049 #define CCS_NAME            "ccs"
0050
0051 #define CCS_DFL_I2C_ADDR    (0x20 >> 1) /* Default I2C Address */
0052 #define CCS_ALT_I2C_ADDR    (0x6e >> 1) /* Alternate I2C Address */
0053
0054 #define CCS_LIM(sensor, limit) \
0055     ccs_get_limit(sensor, CCS_L_##limit, 0)
0056
0057 #define CCS_LIM_AT(sensor, limit, offset)   \
0058     ccs_get_limit(sensor, CCS_L_##limit, CCS_L_##limit##_OFFSET(offset))
0059
0060 /*
0061  * Sometimes due to board layout considerations the camera module can be
0062  * mounted rotated. The typical rotation used is 180 degrees which can be
0063  * corrected by giving a default H-FLIP and V-FLIP in the sensor readout.
0064  * FIXME: rotation also changes the bayer pattern.
0065  */
0066 enum ccs_module_board_orient {
0067     CCS_MODULE_BOARD_ORIENT_0 = 0,
0068     CCS_MODULE_BOARD_ORIENT_180,
0069 };
0070
0071 struct ccs_flash_strobe_parms {
0072     u8 mode;
0073     u32 strobe_width_high_us;
0074     u16 strobe_delay;
0075     u16 stobe_start_point;
0076     u8 trigger;
0077 };
0078
0079 struct ccs_hwconfig {
0080     /*
0081      * Change the cci address if i2c_addr_alt is set.
0082      * Both default and alternate cci addr need to be present
0083      */
0084     unsigned short i2c_addr_dfl;    /* Default i2c addr */
0085     unsigned short i2c_addr_alt;    /* Alternate i2c addr */
0086
0087     u32 ext_clk;            /* sensor external clk */
0088
0089     unsigned int lanes;     /* Number of CSI-2 lanes */
0090     u32 csi_signalling_mode;    /* CCS_CSI_SIGNALLING_MODE_* */
0091     u64 *op_sys_clock;
0092
0093     enum ccs_module_board_orient module_board_orient;
0094
0095     struct ccs_flash_strobe_parms *strobe_setup;
0096 };
0097
0098 struct ccs_quirk;
0099
0100 #define CCS_MODULE_IDENT_FLAG_REV_LE        (1 << 0)
0101
0102 struct ccs_module_ident {
0103     u16 mipi_manufacturer_id;
0104     u16 model_id;
0105     u8 smia_manufacturer_id;
0106     u8 revision_number_major;
0107
0108     u8 flags;
0109
0110     char *name;
0111     const struct ccs_quirk *quirk;
0112 };
0113
0114 struct ccs_module_info {
0115     u32 smia_manufacturer_id;
0116     u32 mipi_manufacturer_id;
0117     u32 model_id;
0118     u32 revision_number;
0119
0120     u32 module_year;
0121     u32 module_month;
0122     u32 module_day;
0123
0124     u32 sensor_smia_manufacturer_id;
0125     u32 sensor_mipi_manufacturer_id;
0126     u32 sensor_model_id;
0127     u32 sensor_revision_number;
0128     u32 sensor_firmware_version;
0129
0130     u32 smia_version;
0131     u32 smiapp_version;
0132     u32 ccs_version;
0133
0134     char *name;
0135     const struct ccs_quirk *quirk;
0136 };
0137
0138 #define CCS_IDENT_FQ(manufacturer, model, rev, fl, _name, _quirk)   \
0139     { .smia_manufacturer_id = manufacturer,             \
0140       .model_id = model,                        \
0141       .revision_number_major = rev,                 \
0142       .flags = fl,                          \
0143       .name = _name,                        \
0144       .quirk = _quirk, }
0145
0146 #define CCS_IDENT_LQ(manufacturer, model, rev, _name, _quirk)   \
0147     { .smia_manufacturer_id = manufacturer,             \
0148       .model_id = model,                        \
0149       .revision_number_major = rev,                 \
0150       .flags = CCS_MODULE_IDENT_FLAG_REV_LE,            \
0151       .name = _name,                        \
0152       .quirk = _quirk, }
0153
0154 #define CCS_IDENT_L(manufacturer, model, rev, _name)            \
0155     { .smia_manufacturer_id = manufacturer,             \
0156       .model_id = model,                        \
0157       .revision_number_major = rev,                 \
0158       .flags = CCS_MODULE_IDENT_FLAG_REV_LE,            \
0159       .name = _name, }
0160
0161 #define CCS_IDENT_Q(manufacturer, model, rev, _name, _quirk)        \
0162     { .smia_manufacturer_id = manufacturer,             \
0163       .model_id = model,                        \
0164       .revision_number_major = rev,                 \
0165       .flags = 0,                           \
0166       .name = _name,                        \
0167       .quirk = _quirk, }
0168
0169 #define CCS_IDENT(manufacturer, model, rev, _name)          \
0170     { .smia_manufacturer_id = manufacturer,             \
0171       .model_id = model,                        \
0172       .revision_number_major = rev,                 \
0173       .flags = 0,                           \
0174       .name = _name, }
0175
0176 struct ccs_csi_data_format {
0177     u32 code;
0178     u8 width;
0179     u8 compressed;
0180     u8 pixel_order;
0181 };
0182
0183 #define CCS_SUBDEVS         3
0184
0185 #define CCS_PA_PAD_SRC          0
0186 #define CCS_PAD_SINK            0
0187 #define CCS_PAD_SRC         1
0188 #define CCS_PADS            2
0189
0190 struct ccs_binning_subtype {
0191     u8 horizontal:4;
0192     u8 vertical:4;
0193 } __packed;
0194
0195 struct ccs_subdev {
0196     struct v4l2_subdev sd;
0197     struct media_pad pads[CCS_PADS];
0198     struct v4l2_rect sink_fmt;
0199     struct v4l2_rect crop[CCS_PADS];
0200     struct v4l2_rect compose; /* compose on sink */
0201     unsigned short sink_pad;
0202     unsigned short source_pad;
0203     int npads;
0204     struct ccs_sensor *sensor;
0205     struct v4l2_ctrl_handler ctrl_handler;
0206 };
0207
0208 /*
0209  * struct ccs_sensor - Main device structure
0210  */
0211 struct ccs_sensor {
0212     /*
0213      * "mutex" is used to serialise access to all fields here
0214      * except v4l2_ctrls at the end of the struct. "mutex" is also
0215      * used to serialise access to file handle specific
0216      * information.
0217      */
0218     struct mutex mutex;
0219     struct ccs_subdev ssds[CCS_SUBDEVS];
0220     u32 ssds_used;
0221     struct ccs_subdev *src;
0222     struct ccs_subdev *binner;
0223     struct ccs_subdev *scaler;
0224     struct ccs_subdev *pixel_array;
0225     struct ccs_hwconfig hwcfg;
0226     struct regulator_bulk_data *regulators;
0227     struct clk *ext_clk;
0228     struct gpio_desc *xshutdown;
0229     struct gpio_desc *reset;
0230     void *ccs_limits;
0231     u8 nbinning_subtypes;
0232     struct ccs_binning_subtype binning_subtypes[CCS_LIM_BINNING_SUB_TYPE_MAX_N + 1];
0233     u32 mbus_frame_fmts;
0234     const struct ccs_csi_data_format *csi_format;
0235     const struct ccs_csi_data_format *internal_csi_format;
0236     u32 default_mbus_frame_fmts;
0237     int default_pixel_order;
0238     struct ccs_data_container sdata, mdata;
0239
0240     u8 binning_horizontal;
0241     u8 binning_vertical;
0242
0243     u8 scale_m;
0244     u8 scaling_mode;
0245
0246     u8 hvflip_inv_mask; /* H/VFLIP inversion due to sensor orientation */
0247     u8 frame_skip;
0248     u16 embedded_start; /* embedded data start line */
0249     u16 embedded_end;
0250     u16 image_start; /* image data start line */
0251     u16 visible_pixel_start; /* start pixel of the visible image */
0252
0253     bool streaming;
0254     bool dev_init_done;
0255     u8 compressed_min_bpp;
0256
0257     struct ccs_module_info minfo;
0258
0259     struct ccs_pll pll;
0260
0261     /* Is a default format supported for a given BPP? */
0262     unsigned long *valid_link_freqs;
0263
0264     /* Pixel array controls */
0265     struct v4l2_ctrl *exposure;
0266     struct v4l2_ctrl *hflip;
0267     struct v4l2_ctrl *vflip;
0268     struct v4l2_ctrl *vblank;
0269     struct v4l2_ctrl *hblank;
0270     struct v4l2_ctrl *pixel_rate_parray;
0271     struct v4l2_ctrl *luminance_level;
0272     /* src controls */
0273     struct v4l2_ctrl *link_freq;
0274     struct v4l2_ctrl *pixel_rate_csi;
0275     /* test pattern colour components */
0276     struct v4l2_ctrl *test_data[CCS_COLOUR_COMPONENTS];
0277 };
0278
0279 #define to_ccs_subdev(_sd)              \
0280     container_of(_sd, struct ccs_subdev, sd)
0281
0282 #define to_ccs_sensor(_sd)  \
0283     (to_ccs_subdev(_sd)->sensor)
0284
0285 void ccs_replace_limit(struct ccs_sensor *sensor,
0286                unsigned int limit, unsigned int offset, u32 val);
0287 u32 ccs_get_limit(struct ccs_sensor *sensor, unsigned int limit,
0288           unsigned int offset);
0289
0290 #endif /* __CCS_H__ */