1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Allied Vision Technologies GmbH Alvium camera driver
5 * Copyright (C) 2023 Tommaso Merciai
6 * Copyright (C) 2023 Martin Hecht
7 * Copyright (C) 2023 Avnet EMG GmbH
10 #ifndef ALVIUM_CSI2_H_
11 #define ALVIUM_CSI2_H_
13 #include <linux/kernel.h>
14 #include <linux/regulator/consumer.h>
15 #include <media/v4l2-cci.h>
16 #include <media/v4l2-common.h>
17 #include <media/v4l2-ctrls.h>
18 #include <media/v4l2-fwnode.h>
19 #include <media/v4l2-subdev.h>
21 #define REG_BCRM_V4L2 BIT(31)
23 #define REG_BCRM_V4L2_8BIT(n) (REG_BCRM_V4L2 | CCI_REG8(n))
24 #define REG_BCRM_V4L2_16BIT(n) (REG_BCRM_V4L2 | CCI_REG16(n))
25 #define REG_BCRM_V4L2_32BIT(n) (REG_BCRM_V4L2 | CCI_REG32(n))
26 #define REG_BCRM_V4L2_64BIT(n) (REG_BCRM_V4L2 | CCI_REG64(n))
28 /* Basic Control Register Map register offsets (BCRM) */
29 #define REG_BCRM_MINOR_VERSION_R CCI_REG16(0x0000)
30 #define REG_BCRM_MAJOR_VERSION_R CCI_REG16(0x0002)
31 #define REG_BCRM_REG_ADDR_R CCI_REG16(0x0014)
33 #define REG_BCRM_FEATURE_INQUIRY_R REG_BCRM_V4L2_64BIT(0x0008)
34 #define REG_BCRM_DEVICE_FW_SPEC_VERSION_R REG_BCRM_V4L2_8BIT(0x0010)
35 #define REG_BCRM_DEVICE_FW_MAJOR_VERSION_R REG_BCRM_V4L2_8BIT(0x0011)
36 #define REG_BCRM_DEVICE_FW_MINOR_VERSION_R REG_BCRM_V4L2_16BIT(0x0012)
37 #define REG_BCRM_DEVICE_FW_PATCH_VERSION_R REG_BCRM_V4L2_32BIT(0x0014)
38 #define REG_BCRM_WRITE_HANDSHAKE_RW REG_BCRM_V4L2_8BIT(0x0018)
40 /* Streaming Control Registers */
41 #define REG_BCRM_SUPPORTED_CSI2_LANE_COUNTS_R REG_BCRM_V4L2_8BIT(0x0040)
42 #define REG_BCRM_CSI2_LANE_COUNT_RW REG_BCRM_V4L2_8BIT(0x0044)
43 #define REG_BCRM_CSI2_CLOCK_MIN_R REG_BCRM_V4L2_32BIT(0x0048)
44 #define REG_BCRM_CSI2_CLOCK_MAX_R REG_BCRM_V4L2_32BIT(0x004c)
45 #define REG_BCRM_CSI2_CLOCK_RW REG_BCRM_V4L2_32BIT(0x0050)
46 #define REG_BCRM_BUFFER_SIZE_R REG_BCRM_V4L2_32BIT(0x0054)
48 #define REG_BCRM_IPU_X_MIN_W REG_BCRM_V4L2_32BIT(0x0058)
49 #define REG_BCRM_IPU_X_MAX_W REG_BCRM_V4L2_32BIT(0x005c)
50 #define REG_BCRM_IPU_X_INC_W REG_BCRM_V4L2_32BIT(0x0060)
51 #define REG_BCRM_IPU_Y_MIN_W REG_BCRM_V4L2_32BIT(0x0064)
52 #define REG_BCRM_IPU_Y_MAX_W REG_BCRM_V4L2_32BIT(0x0068)
53 #define REG_BCRM_IPU_Y_INC_W REG_BCRM_V4L2_32BIT(0x006c)
54 #define REG_BCRM_IPU_X_R REG_BCRM_V4L2_32BIT(0x0070)
55 #define REG_BCRM_IPU_Y_R REG_BCRM_V4L2_32BIT(0x0074)
57 #define REG_BCRM_PHY_RESET_RW REG_BCRM_V4L2_8BIT(0x0078)
58 #define REG_BCRM_LP2HS_DELAY_RW REG_BCRM_V4L2_32BIT(0x007c)
60 /* Acquisition Control Registers */
61 #define REG_BCRM_ACQUISITION_START_RW REG_BCRM_V4L2_8BIT(0x0080)
62 #define REG_BCRM_ACQUISITION_STOP_RW REG_BCRM_V4L2_8BIT(0x0084)
63 #define REG_BCRM_ACQUISITION_ABORT_RW REG_BCRM_V4L2_8BIT(0x0088)
64 #define REG_BCRM_ACQUISITION_STATUS_R REG_BCRM_V4L2_8BIT(0x008c)
65 #define REG_BCRM_ACQUISITION_FRAME_RATE_RW REG_BCRM_V4L2_64BIT(0x0090)
66 #define REG_BCRM_ACQUISITION_FRAME_RATE_MIN_R REG_BCRM_V4L2_64BIT(0x0098)
67 #define REG_BCRM_ACQUISITION_FRAME_RATE_MAX_R REG_BCRM_V4L2_64BIT(0x00a0)
68 #define REG_BCRM_ACQUISITION_FRAME_RATE_INC_R REG_BCRM_V4L2_64BIT(0x00a8)
69 #define REG_BCRM_ACQUISITION_FRAME_RATE_ENABLE_RW REG_BCRM_V4L2_8BIT(0x00b0)
71 #define REG_BCRM_FRAME_START_TRIGGER_MODE_RW REG_BCRM_V4L2_8BIT(0x00b4)
72 #define REG_BCRM_FRAME_START_TRIGGER_SOURCE_RW REG_BCRM_V4L2_8BIT(0x00b8)
73 #define REG_BCRM_FRAME_START_TRIGGER_ACTIVATION_RW REG_BCRM_V4L2_8BIT(0x00bc)
74 #define REG_BCRM_FRAME_START_TRIGGER_SOFTWARE_W REG_BCRM_V4L2_8BIT(0x00c0)
75 #define REG_BCRM_FRAME_START_TRIGGER_DELAY_RW REG_BCRM_V4L2_32BIT(0x00c4)
76 #define REG_BCRM_EXPOSURE_ACTIVE_LINE_MODE_RW REG_BCRM_V4L2_8BIT(0x00c8)
77 #define REG_BCRM_EXPOSURE_ACTIVE_LINE_SELECTOR_RW REG_BCRM_V4L2_8BIT(0x00cc)
78 #define REG_BCRM_LINE_CONFIGURATION_RW REG_BCRM_V4L2_32BIT(0x00d0)
80 #define REG_BCRM_IMG_WIDTH_RW REG_BCRM_V4L2_32BIT(0x0100)
81 #define REG_BCRM_IMG_WIDTH_MIN_R REG_BCRM_V4L2_32BIT(0x0104)
82 #define REG_BCRM_IMG_WIDTH_MAX_R REG_BCRM_V4L2_32BIT(0x0108)
83 #define REG_BCRM_IMG_WIDTH_INC_R REG_BCRM_V4L2_32BIT(0x010c)
85 #define REG_BCRM_IMG_HEIGHT_RW REG_BCRM_V4L2_32BIT(0x0110)
86 #define REG_BCRM_IMG_HEIGHT_MIN_R REG_BCRM_V4L2_32BIT(0x0114)
87 #define REG_BCRM_IMG_HEIGHT_MAX_R REG_BCRM_V4L2_32BIT(0x0118)
88 #define REG_BCRM_IMG_HEIGHT_INC_R REG_BCRM_V4L2_32BIT(0x011c)
90 #define REG_BCRM_IMG_OFFSET_X_RW REG_BCRM_V4L2_32BIT(0x0120)
91 #define REG_BCRM_IMG_OFFSET_X_MIN_R REG_BCRM_V4L2_32BIT(0x0124)
92 #define REG_BCRM_IMG_OFFSET_X_MAX_R REG_BCRM_V4L2_32BIT(0x0128)
93 #define REG_BCRM_IMG_OFFSET_X_INC_R REG_BCRM_V4L2_32BIT(0x012c)
95 #define REG_BCRM_IMG_OFFSET_Y_RW REG_BCRM_V4L2_32BIT(0x0130)
96 #define REG_BCRM_IMG_OFFSET_Y_MIN_R REG_BCRM_V4L2_32BIT(0x0134)
97 #define REG_BCRM_IMG_OFFSET_Y_MAX_R REG_BCRM_V4L2_32BIT(0x0138)
98 #define REG_BCRM_IMG_OFFSET_Y_INC_R REG_BCRM_V4L2_32BIT(0x013c)
100 #define REG_BCRM_IMG_MIPI_DATA_FORMAT_RW REG_BCRM_V4L2_32BIT(0x0140)
101 #define REG_BCRM_IMG_AVAILABLE_MIPI_DATA_FORMATS_R REG_BCRM_V4L2_64BIT(0x0148)
102 #define REG_BCRM_IMG_BAYER_PATTERN_INQUIRY_R REG_BCRM_V4L2_8BIT(0x0150)
103 #define REG_BCRM_IMG_BAYER_PATTERN_RW REG_BCRM_V4L2_8BIT(0x0154)
104 #define REG_BCRM_IMG_REVERSE_X_RW REG_BCRM_V4L2_8BIT(0x0158)
105 #define REG_BCRM_IMG_REVERSE_Y_RW REG_BCRM_V4L2_8BIT(0x015c)
107 #define REG_BCRM_SENSOR_WIDTH_R REG_BCRM_V4L2_32BIT(0x0160)
108 #define REG_BCRM_SENSOR_HEIGHT_R REG_BCRM_V4L2_32BIT(0x0164)
109 #define REG_BCRM_WIDTH_MAX_R REG_BCRM_V4L2_32BIT(0x0168)
110 #define REG_BCRM_HEIGHT_MAX_R REG_BCRM_V4L2_32BIT(0x016c)
112 #define REG_BCRM_EXPOSURE_TIME_RW REG_BCRM_V4L2_64BIT(0x0180)
113 #define REG_BCRM_EXPOSURE_TIME_MIN_R REG_BCRM_V4L2_64BIT(0x0188)
114 #define REG_BCRM_EXPOSURE_TIME_MAX_R REG_BCRM_V4L2_64BIT(0x0190)
115 #define REG_BCRM_EXPOSURE_TIME_INC_R REG_BCRM_V4L2_64BIT(0x0198)
116 #define REG_BCRM_EXPOSURE_AUTO_RW REG_BCRM_V4L2_8BIT(0x01a0)
118 #define REG_BCRM_INTENSITY_AUTO_PRECEDENCE_RW REG_BCRM_V4L2_8BIT(0x01a4)
119 #define REG_BCRM_INTENSITY_AUTO_PRECEDENCE_VALUE_RW REG_BCRM_V4L2_32BIT(0x01a8)
120 #define REG_BCRM_INTENSITY_AUTO_PRECEDENCE_MIN_R REG_BCRM_V4L2_32BIT(0x01ac)
121 #define REG_BCRM_INTENSITY_AUTO_PRECEDENCE_MAX_R REG_BCRM_V4L2_32BIT(0x01b0)
122 #define REG_BCRM_INTENSITY_AUTO_PRECEDENCE_INC_R REG_BCRM_V4L2_32BIT(0x01b4)
124 #define REG_BCRM_BLACK_LEVEL_RW REG_BCRM_V4L2_32BIT(0x01b8)
125 #define REG_BCRM_BLACK_LEVEL_MIN_R REG_BCRM_V4L2_32BIT(0x01bc)
126 #define REG_BCRM_BLACK_LEVEL_MAX_R REG_BCRM_V4L2_32BIT(0x01c0)
127 #define REG_BCRM_BLACK_LEVEL_INC_R REG_BCRM_V4L2_32BIT(0x01c4)
129 #define REG_BCRM_GAIN_RW REG_BCRM_V4L2_64BIT(0x01c8)
130 #define REG_BCRM_GAIN_MIN_R REG_BCRM_V4L2_64BIT(0x01d0)
131 #define REG_BCRM_GAIN_MAX_R REG_BCRM_V4L2_64BIT(0x01d8)
132 #define REG_BCRM_GAIN_INC_R REG_BCRM_V4L2_64BIT(0x01e0)
133 #define REG_BCRM_GAIN_AUTO_RW REG_BCRM_V4L2_8BIT(0x01e8)
135 #define REG_BCRM_GAMMA_RW REG_BCRM_V4L2_64BIT(0x01f0)
136 #define REG_BCRM_GAMMA_MIN_R REG_BCRM_V4L2_64BIT(0x01f8)
137 #define REG_BCRM_GAMMA_MAX_R REG_BCRM_V4L2_64BIT(0x0200)
138 #define REG_BCRM_GAMMA_INC_R REG_BCRM_V4L2_64BIT(0x0208)
140 #define REG_BCRM_CONTRAST_VALUE_RW REG_BCRM_V4L2_32BIT(0x0214)
141 #define REG_BCRM_CONTRAST_VALUE_MIN_R REG_BCRM_V4L2_32BIT(0x0218)
142 #define REG_BCRM_CONTRAST_VALUE_MAX_R REG_BCRM_V4L2_32BIT(0x021c)
143 #define REG_BCRM_CONTRAST_VALUE_INC_R REG_BCRM_V4L2_32BIT(0x0220)
145 #define REG_BCRM_SATURATION_RW REG_BCRM_V4L2_32BIT(0x0240)
146 #define REG_BCRM_SATURATION_MIN_R REG_BCRM_V4L2_32BIT(0x0244)
147 #define REG_BCRM_SATURATION_MAX_R REG_BCRM_V4L2_32BIT(0x0248)
148 #define REG_BCRM_SATURATION_INC_R REG_BCRM_V4L2_32BIT(0x024c)
150 #define REG_BCRM_HUE_RW REG_BCRM_V4L2_32BIT(0x0250)
151 #define REG_BCRM_HUE_MIN_R REG_BCRM_V4L2_32BIT(0x0254)
152 #define REG_BCRM_HUE_MAX_R REG_BCRM_V4L2_32BIT(0x0258)
153 #define REG_BCRM_HUE_INC_R REG_BCRM_V4L2_32BIT(0x025c)
155 #define REG_BCRM_ALL_BALANCE_RATIO_RW REG_BCRM_V4L2_64BIT(0x0260)
156 #define REG_BCRM_ALL_BALANCE_RATIO_MIN_R REG_BCRM_V4L2_64BIT(0x0268)
157 #define REG_BCRM_ALL_BALANCE_RATIO_MAX_R REG_BCRM_V4L2_64BIT(0x0270)
158 #define REG_BCRM_ALL_BALANCE_RATIO_INC_R REG_BCRM_V4L2_64BIT(0x0278)
160 #define REG_BCRM_RED_BALANCE_RATIO_RW REG_BCRM_V4L2_64BIT(0x0280)
161 #define REG_BCRM_RED_BALANCE_RATIO_MIN_R REG_BCRM_V4L2_64BIT(0x0288)
162 #define REG_BCRM_RED_BALANCE_RATIO_MAX_R REG_BCRM_V4L2_64BIT(0x0290)
163 #define REG_BCRM_RED_BALANCE_RATIO_INC_R REG_BCRM_V4L2_64BIT(0x0298)
165 #define REG_BCRM_GREEN_BALANCE_RATIO_RW REG_BCRM_V4L2_64BIT(0x02a0)
166 #define REG_BCRM_GREEN_BALANCE_RATIO_MIN_R REG_BCRM_V4L2_64BIT(0x02a8)
167 #define REG_BCRM_GREEN_BALANCE_RATIO_MAX_R REG_BCRM_V4L2_64BIT(0x02b0)
168 #define REG_BCRM_GREEN_BALANCE_RATIO_INC_R REG_BCRM_V4L2_64BIT(0x02b8)
170 #define REG_BCRM_BLUE_BALANCE_RATIO_RW REG_BCRM_V4L2_64BIT(0x02c0)
171 #define REG_BCRM_BLUE_BALANCE_RATIO_MIN_R REG_BCRM_V4L2_64BIT(0x02c8)
172 #define REG_BCRM_BLUE_BALANCE_RATIO_MAX_R REG_BCRM_V4L2_64BIT(0x02d0)
173 #define REG_BCRM_BLUE_BALANCE_RATIO_INC_R REG_BCRM_V4L2_64BIT(0x02d8)
175 #define REG_BCRM_WHITE_BALANCE_AUTO_RW REG_BCRM_V4L2_8BIT(0x02e0)
176 #define REG_BCRM_SHARPNESS_RW REG_BCRM_V4L2_32BIT(0x0300)
177 #define REG_BCRM_SHARPNESS_MIN_R REG_BCRM_V4L2_32BIT(0x0304)
178 #define REG_BCRM_SHARPNESS_MAX_R REG_BCRM_V4L2_32BIT(0x0308)
179 #define REG_BCRM_SHARPNESS_INC_R REG_BCRM_V4L2_32BIT(0x030c)
181 #define REG_BCRM_DEVICE_TEMPERATURE_R REG_BCRM_V4L2_32BIT(0x0310)
182 #define REG_BCRM_EXPOSURE_AUTO_MIN_RW REG_BCRM_V4L2_64BIT(0x0330)
183 #define REG_BCRM_EXPOSURE_AUTO_MAX_RW REG_BCRM_V4L2_64BIT(0x0338)
184 #define REG_BCRM_GAIN_AUTO_MIN_RW REG_BCRM_V4L2_64BIT(0x0340)
185 #define REG_BCRM_GAIN_AUTO_MAX_RW REG_BCRM_V4L2_64BIT(0x0348)
188 #define REG_BCRM_HEARTBEAT_RW CCI_REG8(0x021f)
190 /* GenCP Registers */
191 #define REG_GENCP_CHANGEMODE_W CCI_REG8(0x021c)
192 #define REG_GENCP_CURRENTMODE_R CCI_REG8(0x021d)
193 #define REG_GENCP_IN_HANDSHAKE_RW CCI_REG8(0x001c)
194 #define REG_GENCP_OUT_SIZE_W CCI_REG16(0x0020)
195 #define REG_GENCP_IN_SIZE_R CCI_REG16(0x0024)
198 #define REG_BCRM_HANDSHAKE_STATUS_MASK 0x01
199 #define REG_BCRM_HANDSHAKE_AVAILABLE_MASK 0x80
201 #define BCRM_HANDSHAKE_W_DONE_EN_BIT BIT(0)
203 #define ALVIUM_DEFAULT_FR_HZ 10
204 #define ALVIUM_DEFAULT_PIXEL_RATE_MHZ 148000000
206 #define ALVIUM_LP2HS_DELAY_MS 100
208 enum alvium_bcrm_mode {
214 enum alvium_mipi_fmt {
215 ALVIUM_FMT_UYVY8_2X8 = 0,
216 ALVIUM_FMT_UYVY8_1X16,
217 ALVIUM_FMT_YUYV8_1X16,
218 ALVIUM_FMT_YUYV8_2X8,
219 ALVIUM_FMT_YUYV10_1X20,
220 ALVIUM_FMT_RGB888_1X24,
221 ALVIUM_FMT_RBG888_1X24,
222 ALVIUM_FMT_BGR888_1X24,
223 ALVIUM_FMT_RGB888_3X8,
225 ALVIUM_FMT_SGRBG8_1X8,
226 ALVIUM_FMT_SRGGB8_1X8,
227 ALVIUM_FMT_SGBRG8_1X8,
228 ALVIUM_FMT_SBGGR8_1X8,
230 ALVIUM_FMT_SGRBG10_1X10,
231 ALVIUM_FMT_SRGGB10_1X10,
232 ALVIUM_FMT_SGBRG10_1X10,
233 ALVIUM_FMT_SBGGR10_1X10,
235 ALVIUM_FMT_SGRBG12_1X12,
236 ALVIUM_FMT_SRGGB12_1X12,
237 ALVIUM_FMT_SGBRG12_1X12,
238 ALVIUM_FMT_SBGGR12_1X12,
239 ALVIUM_FMT_SBGGR14_1X14,
240 ALVIUM_FMT_SGBRG14_1X14,
241 ALVIUM_FMT_SRGGB14_1X14,
242 ALVIUM_FMT_SGRBG14_1X14,
243 ALVIUM_NUM_SUPP_MIPI_DATA_FMT
246 enum alvium_av_bayer_bit {
247 ALVIUM_BIT_BAY_NONE = -1,
248 ALVIUM_BIT_BAY_MONO = 0,
253 ALVIUM_NUM_BAY_AV_BIT
256 enum alvium_av_mipi_bit {
257 ALVIUM_BIT_YUV420_8_LEG = 0,
259 ALVIUM_BIT_YUV420_10,
260 ALVIUM_BIT_YUV420_8_CSPS,
261 ALVIUM_BIT_YUV420_10_CSPS,
263 ALVIUM_BIT_YUV422_10,
276 ALVIUM_NUM_SUPP_MIPI_DATA_BIT
279 struct alvium_avail_feat {
302 struct alvium_avail_mipi_fmt {
307 u64 yuv420_10_csps:1;
325 struct alvium_avail_bayer {
335 struct v4l2_rect crop;
336 struct v4l2_mbus_framefmt fmt;
341 struct alvium_pixfmt {
352 struct alvium_ctrls {
353 struct v4l2_ctrl_handler handler;
354 struct v4l2_ctrl *pixel_rate;
355 struct v4l2_ctrl *link_freq;
356 struct v4l2_ctrl *auto_exp;
357 struct v4l2_ctrl *exposure;
358 struct v4l2_ctrl *auto_wb;
359 struct v4l2_ctrl *blue_balance;
360 struct v4l2_ctrl *red_balance;
361 struct v4l2_ctrl *auto_gain;
362 struct v4l2_ctrl *gain;
363 struct v4l2_ctrl *saturation;
364 struct v4l2_ctrl *hue;
365 struct v4l2_ctrl *contrast;
366 struct v4l2_ctrl *gamma;
367 struct v4l2_ctrl *sharpness;
368 struct v4l2_ctrl *hflip;
369 struct v4l2_ctrl *vflip;
373 struct i2c_client *i2c_client;
374 struct v4l2_subdev sd;
375 struct v4l2_fwnode_endpoint ep;
376 struct media_pad pad;
377 struct regmap *regmap;
379 struct regulator *reg_vcc;
383 struct alvium_avail_feat avail_ft;
384 u8 is_mipi_fmt_avail[ALVIUM_NUM_SUPP_MIPI_DATA_BIT];
385 u8 is_bay_avail[ALVIUM_NUM_BAY_AV_BIT];
444 struct alvium_mode mode;
449 struct alvium_ctrls ctrls;
453 struct alvium_pixfmt *alvium_csi2_fmt;
454 u8 alvium_csi2_fmt_n;
460 static inline struct alvium_dev *sd_to_alvium(struct v4l2_subdev *sd)
462 return container_of_const(sd, struct alvium_dev, sd);
465 static inline struct v4l2_subdev *ctrl_to_sd(struct v4l2_ctrl *ctrl)
467 return &container_of_const(ctrl->handler, struct alvium_dev,
470 #endif /* ALVIUM_CSI2_H_ */