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_DATA_ACTIVE_HIGH BIT(8) 58 #define V4L2_MBUS_DATA_ACTIVE_LOW BIT(9) 59 /* FIELD = 0/1 - Field1 (odd)/Field2 (even) */ 60 #define V4L2_MBUS_FIELD_EVEN_HIGH BIT(10) 61 /* FIELD = 1/0 - Field1 (odd)/Field2 (even) */ 62 #define V4L2_MBUS_FIELD_EVEN_LOW BIT(11) 63 /* Active state of Sync-on-green (SoG) signal, 0/1 for LOW/HIGH respectively. */ 64 #define V4L2_MBUS_VIDEO_SOG_ACTIVE_HIGH BIT(12) 65 #define V4L2_MBUS_VIDEO_SOG_ACTIVE_LOW BIT(13) 66 #define V4L2_MBUS_DATA_ENABLE_HIGH BIT(14) 67 #define V4L2_MBUS_DATA_ENABLE_LOW BIT(15) 68 69 /* Serial flags */ 70 /* Clock non-continuous mode support. */ 71 #define V4L2_MBUS_CSI2_NONCONTINUOUS_CLOCK BIT(0) 72 73 #define V4L2_MBUS_CSI2_MAX_DATA_LANES 8 74 75 /** 76 * struct v4l2_mbus_config_mipi_csi2 - MIPI CSI-2 data bus configuration 77 * @flags: media bus (V4L2_MBUS_*) flags 78 * @data_lanes: an array of physical data lane indexes 79 * @clock_lane: physical lane index of the clock lane 80 * @num_data_lanes: number of data lanes 81 * @lane_polarities: polarity of the lanes. The order is the same of 82 * the physical lanes. 83 */ 84 struct v4l2_mbus_config_mipi_csi2 { 85 unsigned int flags; 86 unsigned char data_lanes[V4L2_MBUS_CSI2_MAX_DATA_LANES]; 87 unsigned char clock_lane; 88 unsigned char num_data_lanes; 89 bool lane_polarities[1 + V4L2_MBUS_CSI2_MAX_DATA_LANES]; 90 }; 91 92 /** 93 * struct v4l2_mbus_config_parallel - parallel data bus configuration 94 * @flags: media bus (V4L2_MBUS_*) flags 95 * @bus_width: bus width in bits 96 * @data_shift: data shift in bits 97 */ 98 struct v4l2_mbus_config_parallel { 99 unsigned int flags; 100 unsigned char bus_width; 101 unsigned char data_shift; 102 }; 103 104 /** 105 * struct v4l2_mbus_config_mipi_csi1 - CSI-1/CCP2 data bus configuration 106 * @clock_inv: polarity of clock/strobe signal 107 * false - not inverted, true - inverted 108 * @strobe: false - data/clock, true - data/strobe 109 * @lane_polarity: the polarities of the clock (index 0) and data lanes 110 * index (1) 111 * @data_lane: the number of the data lane 112 * @clock_lane: the number of the clock lane 113 */ 114 struct v4l2_mbus_config_mipi_csi1 { 115 unsigned char clock_inv:1; 116 unsigned char strobe:1; 117 bool lane_polarity[2]; 118 unsigned char data_lane; 119 unsigned char clock_lane; 120 }; 121 122 /** 123 * enum v4l2_mbus_type - media bus type 124 * @V4L2_MBUS_UNKNOWN: unknown bus type, no V4L2 mediabus configuration 125 * @V4L2_MBUS_PARALLEL: parallel interface with hsync and vsync 126 * @V4L2_MBUS_BT656: parallel interface with embedded synchronisation, can 127 * also be used for BT.1120 128 * @V4L2_MBUS_CSI1: MIPI CSI-1 serial interface 129 * @V4L2_MBUS_CCP2: CCP2 (Compact Camera Port 2) 130 * @V4L2_MBUS_CSI2_DPHY: MIPI CSI-2 serial interface, with D-PHY 131 * @V4L2_MBUS_CSI2_CPHY: MIPI CSI-2 serial interface, with C-PHY 132 * @V4L2_MBUS_INVALID: invalid bus type (keep as last) 133 */ 134 enum v4l2_mbus_type { 135 V4L2_MBUS_UNKNOWN, 136 V4L2_MBUS_PARALLEL, 137 V4L2_MBUS_BT656, 138 V4L2_MBUS_CSI1, 139 V4L2_MBUS_CCP2, 140 V4L2_MBUS_CSI2_DPHY, 141 V4L2_MBUS_CSI2_CPHY, 142 V4L2_MBUS_INVALID, 143 }; 144 145 /** 146 * struct v4l2_mbus_config - media bus configuration 147 * @type: interface type 148 * @bus: bus configuration data structure 149 * @bus.parallel: embedded &struct v4l2_mbus_config_parallel. 150 * Used if the bus is parallel or BT.656. 151 * @bus.mipi_csi1: embedded &struct v4l2_mbus_config_mipi_csi1. 152 * Used if the bus is MIPI Alliance's Camera Serial 153 * Interface version 1 (MIPI CSI1) or Standard 154 * Mobile Imaging Architecture's Compact Camera Port 2 155 * (SMIA CCP2). 156 * @bus.mipi_csi2: embedded &struct v4l2_mbus_config_mipi_csi2. 157 * Used if the bus is MIPI Alliance's Camera Serial 158 * Interface version 2 (MIPI CSI2). 159 */ 160 struct v4l2_mbus_config { 161 enum v4l2_mbus_type type; 162 union { 163 struct v4l2_mbus_config_parallel parallel; 164 struct v4l2_mbus_config_mipi_csi1 mipi_csi1; 165 struct v4l2_mbus_config_mipi_csi2 mipi_csi2; 166 } bus; 167 }; 168 169 /** 170 * v4l2_fill_pix_format - Ancillary routine that fills a &struct 171 * v4l2_pix_format fields from a &struct v4l2_mbus_framefmt. 172 * 173 * @pix_fmt: pointer to &struct v4l2_pix_format to be filled 174 * @mbus_fmt: pointer to &struct v4l2_mbus_framefmt to be used as model 175 */ 176 static inline void 177 v4l2_fill_pix_format(struct v4l2_pix_format *pix_fmt, 178 const struct v4l2_mbus_framefmt *mbus_fmt) 179 { 180 pix_fmt->width = mbus_fmt->width; 181 pix_fmt->height = mbus_fmt->height; 182 pix_fmt->field = mbus_fmt->field; 183 pix_fmt->colorspace = mbus_fmt->colorspace; 184 pix_fmt->ycbcr_enc = mbus_fmt->ycbcr_enc; 185 pix_fmt->quantization = mbus_fmt->quantization; 186 pix_fmt->xfer_func = mbus_fmt->xfer_func; 187 } 188 189 /** 190 * v4l2_fill_mbus_format - Ancillary routine that fills a &struct 191 * v4l2_mbus_framefmt from a &struct v4l2_pix_format and a 192 * data format code. 193 * 194 * @mbus_fmt: pointer to &struct v4l2_mbus_framefmt to be filled 195 * @pix_fmt: pointer to &struct v4l2_pix_format to be used as model 196 * @code: data format code (from &enum v4l2_mbus_pixelcode) 197 */ 198 static inline void v4l2_fill_mbus_format(struct v4l2_mbus_framefmt *mbus_fmt, 199 const struct v4l2_pix_format *pix_fmt, 200 u32 code) 201 { 202 mbus_fmt->width = pix_fmt->width; 203 mbus_fmt->height = pix_fmt->height; 204 mbus_fmt->field = pix_fmt->field; 205 mbus_fmt->colorspace = pix_fmt->colorspace; 206 mbus_fmt->ycbcr_enc = pix_fmt->ycbcr_enc; 207 mbus_fmt->quantization = pix_fmt->quantization; 208 mbus_fmt->xfer_func = pix_fmt->xfer_func; 209 mbus_fmt->code = code; 210 } 211 212 /** 213 * v4l2_fill_pix_format_mplane - Ancillary routine that fills a &struct 214 * v4l2_pix_format_mplane fields from a media bus structure. 215 * 216 * @pix_mp_fmt: pointer to &struct v4l2_pix_format_mplane to be filled 217 * @mbus_fmt: pointer to &struct v4l2_mbus_framefmt to be used as model 218 */ 219 static inline void 220 v4l2_fill_pix_format_mplane(struct v4l2_pix_format_mplane *pix_mp_fmt, 221 const struct v4l2_mbus_framefmt *mbus_fmt) 222 { 223 pix_mp_fmt->width = mbus_fmt->width; 224 pix_mp_fmt->height = mbus_fmt->height; 225 pix_mp_fmt->field = mbus_fmt->field; 226 pix_mp_fmt->colorspace = mbus_fmt->colorspace; 227 pix_mp_fmt->ycbcr_enc = mbus_fmt->ycbcr_enc; 228 pix_mp_fmt->quantization = mbus_fmt->quantization; 229 pix_mp_fmt->xfer_func = mbus_fmt->xfer_func; 230 } 231 232 /** 233 * v4l2_fill_mbus_format_mplane - Ancillary routine that fills a &struct 234 * v4l2_mbus_framefmt from a &struct v4l2_pix_format_mplane. 235 * 236 * @mbus_fmt: pointer to &struct v4l2_mbus_framefmt to be filled 237 * @pix_mp_fmt: pointer to &struct v4l2_pix_format_mplane to be used as model 238 */ 239 static inline void 240 v4l2_fill_mbus_format_mplane(struct v4l2_mbus_framefmt *mbus_fmt, 241 const struct v4l2_pix_format_mplane *pix_mp_fmt) 242 { 243 mbus_fmt->width = pix_mp_fmt->width; 244 mbus_fmt->height = pix_mp_fmt->height; 245 mbus_fmt->field = pix_mp_fmt->field; 246 mbus_fmt->colorspace = pix_mp_fmt->colorspace; 247 mbus_fmt->ycbcr_enc = pix_mp_fmt->ycbcr_enc; 248 mbus_fmt->quantization = pix_mp_fmt->quantization; 249 mbus_fmt->xfer_func = pix_mp_fmt->xfer_func; 250 } 251 252 #endif 253