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