1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * drivers/media/i2c/smiapp/ccs.h 4 * 5 * Generic driver for MIPI CCS/SMIA/SMIA++ compliant camera sensors 6 * 7 * Copyright (C) 2020 Intel Corporation 8 * Copyright (C) 2010--2012 Nokia Corporation 9 * Contact: Sakari Ailus <sakari.ailus@linux.intel.com> 10 */ 11 12 #ifndef __CCS_H__ 13 #define __CCS_H__ 14 15 #include <linux/mutex.h> 16 #include <linux/regmap.h> 17 #include <media/v4l2-ctrls.h> 18 #include <media/v4l2-subdev.h> 19 20 #include "ccs-data.h" 21 #include "ccs-limits.h" 22 #include "ccs-quirk.h" 23 #include "ccs-regs.h" 24 #include "ccs-reg-access.h" 25 #include "../ccs-pll.h" 26 #include "smiapp-reg-defs.h" 27 28 /* 29 * Standard SMIA++ constants 30 */ 31 #define SMIA_VERSION_1 10 32 #define SMIAPP_VERSION_0_8 8 /* Draft 0.8 */ 33 #define SMIAPP_VERSION_0_9 9 /* Draft 0.9 */ 34 #define SMIAPP_VERSION_1 10 35 36 #define SMIAPP_PROFILE_0 0 37 #define SMIAPP_PROFILE_1 1 38 #define SMIAPP_PROFILE_2 2 39 40 #define SMIAPP_NVM_PAGE_SIZE 64 /* bytes */ 41 42 #define SMIAPP_RESET_DELAY_CLOCKS 2400 43 #define SMIAPP_RESET_DELAY(clk) \ 44 (1000 + (SMIAPP_RESET_DELAY_CLOCKS * 1000 \ 45 + (clk) / 1000 - 1) / ((clk) / 1000)) 46 #define CCS_RESET_DELAY_US 5000 47 #define CCS_RESET_TIMEOUT_US 1000000 48 49 #define CCS_COLOUR_COMPONENTS 4 50 51 #define CCS_DEFAULT_COMPRESSED_DT MIPI_CSI2_DT_USER_DEFINED(0) 52 53 #define SMIAPP_NAME "smiapp" 54 #define CCS_NAME "ccs" 55 56 #define CCS_DFL_I2C_ADDR (0x20 >> 1) /* Default I2C Address */ 57 #define CCS_ALT_I2C_ADDR (0x6e >> 1) /* Alternate I2C Address */ 58 59 #define CCS_LIM(sensor, limit) \ 60 ccs_get_limit(sensor, CCS_L_##limit, 0) 61 62 #define CCS_LIM_AT(sensor, limit, offset) \ 63 ccs_get_limit(sensor, CCS_L_##limit, CCS_L_##limit##_OFFSET(offset)) 64 65 struct ccs_flash_strobe_parms { 66 u8 mode; 67 u32 strobe_width_high_us; 68 u16 strobe_delay; 69 u16 stobe_start_point; 70 u8 trigger; 71 }; 72 73 struct ccs_hwconfig { 74 /* 75 * Change the cci address if i2c_addr_alt is set. 76 * Both default and alternate cci addr need to be present 77 */ 78 unsigned short i2c_addr_dfl; /* Default i2c addr */ 79 unsigned short i2c_addr_alt; /* Alternate i2c addr */ 80 81 u32 ext_clk; /* sensor external clk */ 82 83 unsigned int lanes; /* Number of CSI-2 lanes */ 84 u32 csi_signalling_mode; /* CCS_CSI_SIGNALLING_MODE_* */ 85 u64 *op_sys_clock; 86 87 struct ccs_flash_strobe_parms *strobe_setup; 88 }; 89 90 struct ccs_quirk; 91 92 #define CCS_MODULE_IDENT_FLAG_REV_LE (1 << 0) 93 94 struct ccs_module_ident { 95 u16 mipi_manufacturer_id; 96 u16 model_id; 97 u8 smia_manufacturer_id; 98 u8 revision_number_major; 99 100 u8 flags; 101 102 char *name; 103 const struct ccs_quirk *quirk; 104 }; 105 106 struct ccs_module_info { 107 u32 smia_manufacturer_id; 108 u32 mipi_manufacturer_id; 109 u32 model_id; 110 u32 revision_number; 111 112 u32 module_year; 113 u32 module_month; 114 u32 module_day; 115 116 u32 sensor_smia_manufacturer_id; 117 u32 sensor_mipi_manufacturer_id; 118 u32 sensor_model_id; 119 u32 sensor_revision_number; 120 u32 sensor_firmware_version; 121 122 u32 smia_version; 123 u32 smiapp_version; 124 u32 ccs_version; 125 126 char *name; 127 const struct ccs_quirk *quirk; 128 }; 129 130 #define CCS_IDENT_FQ(manufacturer, model, rev, fl, _name, _quirk) \ 131 { .smia_manufacturer_id = manufacturer, \ 132 .model_id = model, \ 133 .revision_number_major = rev, \ 134 .flags = fl, \ 135 .name = _name, \ 136 .quirk = _quirk, } 137 138 #define CCS_IDENT_LQ(manufacturer, model, rev, _name, _quirk) \ 139 { .smia_manufacturer_id = manufacturer, \ 140 .model_id = model, \ 141 .revision_number_major = rev, \ 142 .flags = CCS_MODULE_IDENT_FLAG_REV_LE, \ 143 .name = _name, \ 144 .quirk = _quirk, } 145 146 #define CCS_IDENT_L(manufacturer, model, rev, _name) \ 147 { .smia_manufacturer_id = manufacturer, \ 148 .model_id = model, \ 149 .revision_number_major = rev, \ 150 .flags = CCS_MODULE_IDENT_FLAG_REV_LE, \ 151 .name = _name, } 152 153 #define CCS_IDENT_Q(manufacturer, model, rev, _name, _quirk) \ 154 { .smia_manufacturer_id = manufacturer, \ 155 .model_id = model, \ 156 .revision_number_major = rev, \ 157 .flags = 0, \ 158 .name = _name, \ 159 .quirk = _quirk, } 160 161 #define CCS_IDENT(manufacturer, model, rev, _name) \ 162 { .smia_manufacturer_id = manufacturer, \ 163 .model_id = model, \ 164 .revision_number_major = rev, \ 165 .flags = 0, \ 166 .name = _name, } 167 168 struct ccs_csi_data_format { 169 u32 code; 170 u8 width; 171 u8 compressed; 172 u8 pixel_order; 173 }; 174 175 #define CCS_SUBDEVS 3 176 177 #define CCS_PA_PAD_SRC 0 178 #define CCS_PAD_SINK 0 179 #define CCS_PAD_SRC 1 180 #define CCS_PADS 2 181 182 #define CCS_STREAM_PIXEL 0 183 184 struct ccs_binning_subtype { 185 u8 horizontal:4; 186 u8 vertical:4; 187 } __packed; 188 189 struct ccs_subdev { 190 struct v4l2_subdev sd; 191 struct media_pad pads[CCS_PADS]; 192 unsigned short sink_pad; 193 unsigned short source_pad; 194 int npads; 195 struct ccs_sensor *sensor; 196 struct v4l2_ctrl_handler ctrl_handler; 197 }; 198 199 /* 200 * struct ccs_sensor - Main device structure 201 */ 202 struct ccs_sensor { 203 /* 204 * "mutex" is used to serialise access to all fields here 205 * except v4l2_ctrls at the end of the struct. "mutex" is also 206 * used to serialise access to file handle specific 207 * information. 208 */ 209 struct mutex mutex; 210 struct ccs_subdev ssds[CCS_SUBDEVS]; 211 u32 ssds_used; 212 struct ccs_subdev *src; 213 struct ccs_subdev *binner; 214 struct ccs_subdev *scaler; 215 struct ccs_subdev *pixel_array; 216 struct ccs_hwconfig hwcfg; 217 struct regulator_bulk_data *regulators; 218 struct clk *ext_clk; 219 struct gpio_desc *xshutdown; 220 struct gpio_desc *reset; 221 struct regmap *regmap; 222 void *ccs_limits; 223 u8 nbinning_subtypes; 224 struct ccs_binning_subtype binning_subtypes[CCS_LIM_BINNING_SUB_TYPE_MAX_N + 1]; 225 u64 mbus_frame_fmts; 226 const struct ccs_csi_data_format *csi_format; 227 const struct ccs_csi_data_format *internal_csi_format; 228 u64 default_mbus_frame_fmts; 229 int default_pixel_order; 230 struct ccs_data_container sdata, mdata; 231 232 u8 frame_skip; 233 u16 embedded_start; /* embedded data start line */ 234 u16 embedded_end; 235 u16 image_start; /* image data start line */ 236 u16 visible_pixel_start; /* start pixel of the visible image */ 237 238 u8 streaming; 239 bool dev_init_done; 240 bool handler_setup_needed; 241 u8 compressed_min_bpp; 242 243 struct ccs_module_info minfo; 244 245 struct ccs_pll pll; 246 247 /* Is a default format supported for a given BPP? */ 248 unsigned long *valid_link_freqs; 249 250 /* Pixel array controls */ 251 struct v4l2_ctrl *exposure; 252 struct v4l2_ctrl *hflip; 253 struct v4l2_ctrl *vflip; 254 struct v4l2_ctrl *vblank; 255 struct v4l2_ctrl *hblank; 256 struct v4l2_ctrl *pixel_rate_parray; 257 struct v4l2_ctrl *luminance_level; 258 /* src controls */ 259 struct v4l2_ctrl *link_freq; 260 struct v4l2_ctrl *pixel_rate_csi; 261 /* test pattern colour components */ 262 struct v4l2_ctrl *test_data[CCS_COLOUR_COMPONENTS]; 263 }; 264 265 #define to_ccs_subdev(_sd) \ 266 container_of(_sd, struct ccs_subdev, sd) 267 268 #define to_ccs_sensor(_sd) \ 269 (to_ccs_subdev(_sd)->sensor) 270 271 void ccs_replace_limit(struct ccs_sensor *sensor, 272 unsigned int limit, unsigned int offset, u32 val); 273 u32 ccs_get_limit(struct ccs_sensor *sensor, unsigned int limit, 274 unsigned int offset); 275 276 #endif /* __CCS_H__ */ 277