Based on kernel version 6.11. Page generated on 2024-09-24 08:21 EST.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 | # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2 --- $id: http://devicetree.org/schemas/media/video-interface-devices.yaml# $schema: http://devicetree.org/meta-schemas/core.yaml# title: Common Properties for Video Receiver and Transmitter Devices maintainers: - Jacopo Mondi <jacopo@jmondi.org> - Sakari Ailus <sakari.ailus@linux.intel.com> properties: flash-leds: $ref: /schemas/types.yaml#/definitions/phandle-array description: An array of phandles, each referring to a flash LED, a sub-node of the LED driver device node. lens-focus: $ref: /schemas/types.yaml#/definitions/phandle description: A phandle to the node of the focus lens controller. rotation: $ref: /schemas/types.yaml#/definitions/uint32 enum: [ 0, 90, 180, 270 ] description: | The camera rotation is expressed as the angular difference in degrees between two reference systems, one relative to the camera module, and one defined on the external world scene to be captured when projected on the image sensor pixel array. A camera sensor has a 2-dimensional reference system 'Rc' defined by its pixel array read-out order. The origin is set to the first pixel being read out, the X-axis points along the column read-out direction towards the last columns, and the Y-axis along the row read-out direction towards the last row. A typical example for a sensor with a 2592x1944 pixel array matrix observed from the front is: 2591 X-axis 0 <------------------------+ 0 .......... ... ..........! .......... ... ..........! Y-axis ... ! .......... ... ..........! .......... ... ..........! 1943 V The external world scene reference system 'Rs' is a 2-dimensional reference system on the focal plane of the camera module. The origin is placed on the top-left corner of the visible scene, the X-axis points towards the right, and the Y-axis points towards the bottom of the scene. The top, bottom, left and right directions are intentionally not defined and depend on the environment in which the camera is used. A typical example of a (very common) picture of a shark swimming from left to right, as seen from the camera, is: 0 X-axis 0 +-------------------------------------> ! ! ! ! |\____)\___ ! ) _____ __`< ! |/ )/ ! ! ! V Y-axis with the reference system 'Rs' placed on the camera focal plane: ¸.·˙! ¸.·˙ ! _ ¸.·˙ ! +-/ \-+¸.·˙ ! | (o) | ! Camera focal plane +-----+˙·.¸ ! ˙·.¸ ! ˙·.¸ ! ˙·.¸! When projected on the sensor's pixel array, the image and the associated reference system 'Rs' are typically (but not always) inverted, due to the camera module's lens optical inversion effect. Assuming the above represented scene of the swimming shark, the lens inversion projects the scene and its reference system onto the sensor pixel array, seen from the front of the camera sensor, as follows: Y-axis ^ ! ! ! ! |\_____)\__ ! ) ____ ___.< ! |/ )/ ! ! ! 0 +-------------------------------------> 0 X-axis Note the shark being upside-down. The resulting projected reference system is named 'Rp'. The camera rotation property is then defined as the angular difference in the counter-clockwise direction between the camera reference system 'Rc' and the projected scene reference system 'Rp'. It is expressed in degrees as a number in the range [0, 360[. Examples 0 degrees camera rotation: Y-Rp ^ Y-Rc ! ^ ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! 0 +-------------------------------------> ! 0 X-Rp 0 +-------------------------------------> 0 X-Rc X-Rc 0 <------------------------------------+ 0 X-Rp 0 ! <------------------------------------+ 0 ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! V ! Y-Rc V Y-Rp 90 degrees camera rotation: 0 Y-Rc 0 +--------------------> ! Y-Rp ! ^ ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! 0 +-------------------------------------> ! 0 X-Rp ! ! ! ! V X-Rc 180 degrees camera rotation: 0 <------------------------------------+ 0 X-Rc ! Y-Rp ! ^ ! ! ! ! ! ! ! ! ! ! ! ! ! ! V ! Y-Rc 0 +-------------------------------------> 0 X-Rp 270 degrees camera rotation: 0 Y-Rc 0 +--------------------> ! 0 ! <-----------------------------------+ 0 ! X-Rp ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! V ! Y-Rp ! ! ! ! V X-Rc Example one - Webcam A camera module installed on the user facing part of a laptop screen casing used for video calls. The captured images are meant to be displayed in landscape mode (width > height) on the laptop screen. The camera is typically mounted upside-down to compensate the lens optical inversion effect: Y-Rp Y-Rc ^ ^ ! ! ! ! ! |\_____)\__ ! ! ) ____ ___.< ! ! |/ )/ ! ! ! ! ! ! ! 0 +-------------------------------------> ! 0 X-Rp 0 +-------------------------------------> 0 X-Rc The two reference systems are aligned, the resulting camera rotation is 0 degrees, no rotation correction needs to be applied to the resulting image once captured to memory buffers to correctly display it to users: +--------------------------------------+ ! ! ! ! ! ! ! |\____)\___ ! ! ) _____ __`< ! ! |/ )/ ! ! ! ! ! ! ! +--------------------------------------+ If the camera sensor is not mounted upside-down to compensate for the lens optical inversion, the two reference systems will not be aligned, with 'Rp' being rotated 180 degrees relatively to 'Rc': X-Rc 0 <------------------------------------+ 0 ! Y-Rp ! ^ ! ! ! ! |\_____)\__ ! ! ) ____ ___.< ! ! |/ )/ ! ! ! ! ! ! V ! Y-Rc 0 +-------------------------------------> 0 X-Rp The image once captured to memory will then be rotated by 180 degrees: +--------------------------------------+ ! ! ! ! ! ! ! __/(_____/| ! ! >.___ ____ ( ! ! \( \| ! ! ! ! ! ! ! +--------------------------------------+ A software rotation correction of 180 degrees should be applied to correctly display the image: +--------------------------------------+ ! ! ! ! ! ! ! |\____)\___ ! ! ) _____ __`< ! ! |/ )/ ! ! ! ! ! ! ! +--------------------------------------+ Example two - Phone camera A camera installed on the back side of a mobile device facing away from the user. The captured images are meant to be displayed in portrait mode (height > width) to match the device screen orientation and the device usage orientation used when taking the picture. The camera sensor is typically mounted with its pixel array longer side aligned to the device longer side, upside-down mounted to compensate for the lens optical inversion effect: 0 Y-Rc 0 +--------------------> ! Y-Rp ! ^ ! ! ! ! ! ! ! ! |\_____)\__ ! ! ) ____ ___.< ! ! |/ )/ ! ! ! ! ! ! ! 0 +-------------------------------------> ! 0 X-Rp ! ! ! ! V X-Rc The two reference systems are not aligned and the 'Rp' reference system is rotated by 90 degrees in the counter-clockwise direction relatively to the 'Rc' reference system. The image once captured to memory will be rotated: +-------------------------------------+ | _ _ | | \ / | | | | | | | | | | | > | | < | | | | | | | . | | V | +-------------------------------------+ A correction of 90 degrees in counter-clockwise direction has to be applied to correctly display the image in portrait mode on the device screen: +--------------------+ | | | | | | | | | | | | | |\____)\___ | | ) _____ __`< | | |/ )/ | | | | | | | | | | | +--------------------+ orientation: description: The orientation of a device (typically an image sensor or a flash LED) describing its mounting position relative to the usage orientation of the system where the device is installed on. $ref: /schemas/types.yaml#/definitions/uint32 enum: # Front. The device is mounted on the front facing side of the system. For # mobile devices such as smartphones, tablets and laptops the front side # is the user facing side. - 0 # Back. The device is mounted on the back side of the system, which is # defined as the opposite side of the front facing one. - 1 # External. The device is not attached directly to the system but is # attached in a way that allows it to move freely. - 2 additionalProperties: true ... |