1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Media Bus API header
4 *
5 * Copyright (C) 2009, Guennadi Liakhovetski <g.liakhovetski@gmx.de>
6 */
7
8 #ifndef V4L2_MEDIABUS_H
9 #define V4L2_MEDIABUS_H
10
11 #include <linux/v4l2-mediabus.h>
12 #include <linux/bitops.h>
13
14 /*
15 * How to use the V4L2_MBUS_* flags:
16 * Flags are defined for each of the possible states and values of a media
17 * bus configuration parameter. One and only one bit of each group of flags
18 * shall be set by the users of the v4l2_subdev_pad_ops.get_mbus_config
19 * operation to ensure that no conflicting settings are specified when
20 * reporting the media bus configuration. For example, it is invalid to set or
21 * clear both the V4L2_MBUS_HSYNC_ACTIVE_HIGH and the
22 * V4L2_MBUS_HSYNC_ACTIVE_LOW flag at the same time. Instead either flag
23 * V4L2_MBUS_HSYNC_ACTIVE_HIGH or flag V4L2_MBUS_HSYNC_ACTIVE_LOW shall be set.
24 *
25 * TODO: replace the existing V4L2_MBUS_* flags with structures of fields
26 * to avoid conflicting settings.
27 *
28 * In example:
29 * #define V4L2_MBUS_HSYNC_ACTIVE_HIGH BIT(2)
30 * #define V4L2_MBUS_HSYNC_ACTIVE_LOW BIT(3)
31 * will be replaced by a field whose value reports the intended active state of
32 * the signal:
33 * unsigned int v4l2_mbus_hsync_active : 1;
34 */
35
36 /* Parallel flags */
37 /*
38 * The client runs in master or in slave mode. By "Master mode" an operation
39 * mode is meant, when the client (e.g., a camera sensor) is producing
40 * horizontal and vertical synchronisation. In "Slave mode" the host is
41 * providing these signals to the slave.
42 */
43 #define V4L2_MBUS_MASTER BIT(0)
44 #define V4L2_MBUS_SLAVE BIT(1)
45 /*
46 * Signal polarity flags
47 * Note: in BT.656 mode HSYNC, FIELD, and VSYNC are unused
48 * V4L2_MBUS_[HV]SYNC* flags should be also used for specifying
49 * configuration of hardware that uses [HV]REF signals
50 */
51 #define V4L2_MBUS_HSYNC_ACTIVE_HIGH BIT(2)
52 #define V4L2_MBUS_HSYNC_ACTIVE_LOW BIT(3)
53 #define V4L2_MBUS_VSYNC_ACTIVE_HIGH BIT(4)
54 #define V4L2_MBUS_VSYNC_ACTIVE_LOW BIT(5)
55 #define V4L2_MBUS_PCLK_SAMPLE_RISING BIT(6)
56 #define V4L2_MBUS_PCLK_SAMPLE_FALLING BIT(7)
57 #define V4L2_MBUS_PCLK_SAMPLE_DUALEDGE BIT(8)
58 #define V4L2_MBUS_DATA_ACTIVE_HIGH BIT(9)
59 #define V4L2_MBUS_DATA_ACTIVE_LOW BIT(10)
60 /* FIELD = 0/1 - Field1 (odd)/Field2 (even) */
61 #define V4L2_MBUS_FIELD_EVEN_HIGH BIT(11)
62 /* FIELD = 1/0 - Field1 (odd)/Field2 (even) */
63 #define V4L2_MBUS_FIELD_EVEN_LOW BIT(12)
64 /* Active state of Sync-on-green (SoG) signal, 0/1 for LOW/HIGH respectively. */
65 #define V4L2_MBUS_VIDEO_SOG_ACTIVE_HIGH BIT(13)
66 #define V4L2_MBUS_VIDEO_SOG_ACTIVE_LOW BIT(14)
67 #define V4L2_MBUS_DATA_ENABLE_HIGH BIT(15)
68 #define V4L2_MBUS_DATA_ENABLE_LOW BIT(16)
69
70 /* Serial flags */
71 /* Clock non-continuous mode support. */
72 #define V4L2_MBUS_CSI2_NONCONTINUOUS_CLOCK BIT(0)
73
74 #define V4L2_MBUS_CSI2_MAX_DATA_LANES 8
75
76 /**
77 * struct v4l2_mbus_config_mipi_csi2 - MIPI CSI-2 data bus configuration
78 * @flags: media bus (V4L2_MBUS_*) flags
79 * @data_lanes: an array of physical data lane indexes
80 * @clock_lane: physical lane index of the clock lane
81 * @num_data_lanes: number of data lanes
82 * @lane_polarities: polarity of the lanes. The order is the same of
83 * the physical lanes.
84 */
85 struct v4l2_mbus_config_mipi_csi2 {
86 unsigned int flags;
87 unsigned char data_lanes[V4L2_MBUS_CSI2_MAX_DATA_LANES];
88 unsigned char clock_lane;
89 unsigned char num_data_lanes;
90 bool lane_polarities[1 + V4L2_MBUS_CSI2_MAX_DATA_LANES];
91 };
92
93 /**
94 * struct v4l2_mbus_config_parallel - parallel data bus configuration
95 * @flags: media bus (V4L2_MBUS_*) flags
96 * @bus_width: bus width in bits
97 * @data_shift: data shift in bits
98 */
99 struct v4l2_mbus_config_parallel {
100 unsigned int flags;
101 unsigned char bus_width;
102 unsigned char data_shift;
103 };
104
105 /**
106 * struct v4l2_mbus_config_mipi_csi1 - CSI-1/CCP2 data bus configuration
107 * @clock_inv: polarity of clock/strobe signal
108 * false - not inverted, true - inverted
109 * @strobe: false - data/clock, true - data/strobe
110 * @lane_polarity: the polarities of the clock (index 0) and data lanes
111 * index (1)
112 * @data_lane: the number of the data lane
113 * @clock_lane: the number of the clock lane
114 */
115 struct v4l2_mbus_config_mipi_csi1 {
116 unsigned char clock_inv:1;
117 unsigned char strobe:1;
118 bool lane_polarity[2];
119 unsigned char data_lane;
120 unsigned char clock_lane;
121 };
122
123 /**
124 * enum v4l2_mbus_type - media bus type
125 * @V4L2_MBUS_UNKNOWN: unknown bus type, no V4L2 mediabus configuration
126 * @V4L2_MBUS_PARALLEL: parallel interface with hsync and vsync
127 * @V4L2_MBUS_BT656: parallel interface with embedded synchronisation, can
128 * also be used for BT.1120
129 * @V4L2_MBUS_CSI1: MIPI CSI-1 serial interface
130 * @V4L2_MBUS_CCP2: CCP2 (Compact Camera Port 2)
131 * @V4L2_MBUS_CSI2_DPHY: MIPI CSI-2 serial interface, with D-PHY
132 * @V4L2_MBUS_CSI2_CPHY: MIPI CSI-2 serial interface, with C-PHY
133 * @V4L2_MBUS_DPI: MIPI VIDEO DPI interface
134 * @V4L2_MBUS_INVALID: invalid bus type (keep as last)
135 */
136 enum v4l2_mbus_type {
137 V4L2_MBUS_UNKNOWN,
138 V4L2_MBUS_PARALLEL,
139 V4L2_MBUS_BT656,
140 V4L2_MBUS_CSI1,
141 V4L2_MBUS_CCP2,
142 V4L2_MBUS_CSI2_DPHY,
143 V4L2_MBUS_CSI2_CPHY,
144 V4L2_MBUS_DPI,
145 V4L2_MBUS_INVALID,
146 };
147
148 /**
149 * struct v4l2_mbus_config - media bus configuration
150 * @type: interface type
151 * @bus: bus configuration data structure
152 * @bus.parallel: embedded &struct v4l2_mbus_config_parallel.
153 * Used if the bus is parallel or BT.656.
154 * @bus.mipi_csi1: embedded &struct v4l2_mbus_config_mipi_csi1.
155 * Used if the bus is MIPI Alliance's Camera Serial
156 * Interface version 1 (MIPI CSI1) or Standard
157 * Mobile Imaging Architecture's Compact Camera Port 2
158 * (SMIA CCP2).
159 * @bus.mipi_csi2: embedded &struct v4l2_mbus_config_mipi_csi2.
160 * Used if the bus is MIPI Alliance's Camera Serial
161 * Interface version 2 (MIPI CSI2).
162 */
163 struct v4l2_mbus_config {
164 enum v4l2_mbus_type type;
165 union {
166 struct v4l2_mbus_config_parallel parallel;
167 struct v4l2_mbus_config_mipi_csi1 mipi_csi1;
168 struct v4l2_mbus_config_mipi_csi2 mipi_csi2;
169 } bus;
170 };
171
172 /**
173 * v4l2_fill_pix_format - Ancillary routine that fills a &struct
174 * v4l2_pix_format fields from a &struct v4l2_mbus_framefmt.
175 *
176 * @pix_fmt: pointer to &struct v4l2_pix_format to be filled
177 * @mbus_fmt: pointer to &struct v4l2_mbus_framefmt to be used as model
178 */
179 static inline void
180 v4l2_fill_pix_format(struct v4l2_pix_format *pix_fmt,
181 const struct v4l2_mbus_framefmt *mbus_fmt)
182 {
183 pix_fmt->width = mbus_fmt->width;
184 pix_fmt->height = mbus_fmt->height;
185 pix_fmt->field = mbus_fmt->field;
186 pix_fmt->colorspace = mbus_fmt->colorspace;
187 pix_fmt->ycbcr_enc = mbus_fmt->ycbcr_enc;
188 pix_fmt->quantization = mbus_fmt->quantization;
189 pix_fmt->xfer_func = mbus_fmt->xfer_func;
190 }
191
192 /**
193 * v4l2_fill_mbus_format - Ancillary routine that fills a &struct
194 * v4l2_mbus_framefmt from a &struct v4l2_pix_format and a
195 * data format code.
196 *
197 * @mbus_fmt: pointer to &struct v4l2_mbus_framefmt to be filled
198 * @pix_fmt: pointer to &struct v4l2_pix_format to be used as model
199 * @code: data format code (from &enum v4l2_mbus_pixelcode)
200 */
201 static inline void v4l2_fill_mbus_format(struct v4l2_mbus_framefmt *mbus_fmt,
202 const struct v4l2_pix_format *pix_fmt,
203 u32 code)
204 {
205 mbus_fmt->width = pix_fmt->width;
206 mbus_fmt->height = pix_fmt->height;
207 mbus_fmt->field = pix_fmt->field;
208 mbus_fmt->colorspace = pix_fmt->colorspace;
209 mbus_fmt->ycbcr_enc = pix_fmt->ycbcr_enc;
210 mbus_fmt->quantization = pix_fmt->quantization;
211 mbus_fmt->xfer_func = pix_fmt->xfer_func;
212 mbus_fmt->code = code;
213 }
214
215 /**
216 * v4l2_fill_pix_format_mplane - Ancillary routine that fills a &struct
217 * v4l2_pix_format_mplane fields from a media bus structure.
218 *
219 * @pix_mp_fmt: pointer to &struct v4l2_pix_format_mplane to be filled
220 * @mbus_fmt: pointer to &struct v4l2_mbus_framefmt to be used as model
221 */
222 static inline void
223 v4l2_fill_pix_format_mplane(struct v4l2_pix_format_mplane *pix_mp_fmt,
224 const struct v4l2_mbus_framefmt *mbus_fmt)
225 {
226 pix_mp_fmt->width = mbus_fmt->width;
227 pix_mp_fmt->height = mbus_fmt->height;
228 pix_mp_fmt->field = mbus_fmt->field;
229 pix_mp_fmt->colorspace = mbus_fmt->colorspace;
230 pix_mp_fmt->ycbcr_enc = mbus_fmt->ycbcr_enc;
231 pix_mp_fmt->quantization = mbus_fmt->quantization;
232 pix_mp_fmt->xfer_func = mbus_fmt->xfer_func;
233 }
234
235 /**
236 * v4l2_fill_mbus_format_mplane - Ancillary routine that fills a &struct
237 * v4l2_mbus_framefmt from a &struct v4l2_pix_format_mplane.
238 *
239 * @mbus_fmt: pointer to &struct v4l2_mbus_framefmt to be filled
240 * @pix_mp_fmt: pointer to &struct v4l2_pix_format_mplane to be used as model
241 */
242 static inline void
243 v4l2_fill_mbus_format_mplane(struct v4l2_mbus_framefmt *mbus_fmt,
244 const struct v4l2_pix_format_mplane *pix_mp_fmt)
245 {
246 mbus_fmt->width = pix_mp_fmt->width;
247 mbus_fmt->height = pix_mp_fmt->height;
248 mbus_fmt->field = pix_mp_fmt->field;
249 mbus_fmt->colorspace = pix_mp_fmt->colorspace;
250 mbus_fmt->ycbcr_enc = pix_mp_fmt->ycbcr_enc;
251 mbus_fmt->quantization = pix_mp_fmt->quantization;
252 mbus_fmt->xfer_func = pix_mp_fmt->xfer_func;
253 }
254
255 #endif
256
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.