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