From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.10]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 0457B1FDE22 for ; Mon, 3 Feb 2025 08:59:23 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=192.198.163.10 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738573167; cv=none; b=tuI87scujUR5MXQomai4HvVr1JF0OyOcQTXhICr3aXAwhjaySEXXELkjaLLduSYl+hFHBlgIKhUjzMRlxCMpGiQGRiZdoWN1SxsbE1x97+h+SRgnw6e950lP5fScrPHoLf7ueyY6r51LOTiEWkF97gAOvsjanLjSZ2HXrcjcfCE= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738573167; c=relaxed/simple; bh=BTxVCDr7efo2g2IfuPmAEX13Q9oDVjflYhKjA8VF3yA=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=EAgWRxuMbXtY1DdZYm4XQPjc9nfGUD6wkbBkbxBo34YFpEiPcRqUV/+6F13fSXeTVuQOePgkO5SV980vn6+uY3UOtTpaeyjy2nMpBG4ui85UNi4ftyR5Xhhl5WeUcCa4mT83YbYdaQEYdMD0h2OvrRBxeXw62REZtKRedXy71ZA= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linux.intel.com; spf=none smtp.mailfrom=linux.intel.com; dkim=pass (2048-bit key) header.d=intel.com header.i=@intel.com header.b=SbF3nuHt; arc=none smtp.client-ip=192.198.163.10 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linux.intel.com Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=linux.intel.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=intel.com header.i=@intel.com header.b="SbF3nuHt" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1738573164; x=1770109164; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=BTxVCDr7efo2g2IfuPmAEX13Q9oDVjflYhKjA8VF3yA=; b=SbF3nuHt154AQCjzQceagJMj8gBSfCTVHf4ExKRExv363zlzc1zJMRKP jSefvDOI38KBXXC5duak94DBVgTFF6mIHfTcCyaXt1etV6aPnXjuUpk4v BIZ6CUHPX42dmKj2DwttuAjENBH6t9EP6UqDgKKs48ZKeKTnJngPFKhrj VneMoM5QAEbL1T96u64Xb0pMz+2vOxcnWjx4BNb6R0cc8xDf0Mhkw16uU KsJ+xMcd5ibTfc25rhhwHfl/rbmfBw/h7Cn6q7saZcqAuyXuk1cq3jLJD zFs6EMKfvVth3DcxnfC/m9XQ/l04Q06wnrYC/hgO2A+aj5hg6lvy5Nmvi A==; X-CSE-ConnectionGUID: +j+FYjW1Stam14i9P4yNVA== X-CSE-MsgGUID: wj8/arvLS9KzQTof63TSYg== X-IronPort-AV: E=McAfee;i="6700,10204,11314"; a="50472622" X-IronPort-AV: E=Sophos;i="6.12,310,1728975600"; d="scan'208";a="50472622" Received: from fmviesa008.fm.intel.com ([10.60.135.148]) by fmvoesa104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Feb 2025 00:59:24 -0800 X-CSE-ConnectionGUID: sl67IcfURcqZKH5FFhSqwA== X-CSE-MsgGUID: Sa3EaIItSxaKcVqLEX8eLQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.13,255,1732608000"; d="scan'208";a="110382953" Received: from turnipsi.fi.intel.com (HELO kekkonen.fi.intel.com) ([10.237.72.44]) by fmviesa008-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Feb 2025 00:59:16 -0800 Received: from svinhufvud.intel.com (maa-artisokka.localdomain [192.168.240.50]) by kekkonen.fi.intel.com (Postfix) with ESMTP id 84B4C11FAB1; Mon, 3 Feb 2025 10:59:11 +0200 (EET) Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo From: Sakari Ailus To: linux-media@vger.kernel.org Cc: hverkuil@xs4all.nl, laurent.pinchart@ideasonboard.com, Prabhakar , Kate Hsuan , Alexander Shiyan , Mikhail Rudenko , Dave Stevenson , Tommaso Merciai , Umang Jain , Benjamin Mugnier , Sylvain Petinot , Christophe JAILLET , Julien Massot , Naushir Patuck , "Yan, Dongcheng" , "Cao, Bingbu" , "Qiu, Tian Shu" , "Wang, Hongju" , Stefan Klug , Mirela Rabulea , =?UTF-8?q?Andr=C3=A9=20Apitzsch?= , Heimir Thor Sverrisson , Kieran Bingham , Stanislaw Gruszka , Mehdi Djait , Ricardo Ribalda Delgado , Hans de Goede Subject: [RFC v5 04/15] media: Documentation: Add subdev configuration models, raw sensor model Date: Mon, 3 Feb 2025 10:58:42 +0200 Message-Id: <20250203085853.1361401-5-sakari.ailus@linux.intel.com> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250203085853.1361401-1-sakari.ailus@linux.intel.com> References: <20250203085853.1361401-1-sakari.ailus@linux.intel.com> Precedence: bulk X-Mailing-List: linux-media@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sub-device configuration models define what V4L2 API elements are available on a compliant sub-device and how do they behave. The patch also adds a model for common raw sensors. Signed-off-by: Sakari Ailus Reviewed-by: Tomi Valkeinen --- .../media/drivers/camera-sensor.rst | 4 + .../media/v4l/common-raw-sensor.dia | 441 ++++++++++++++++++ .../media/v4l/common-raw-sensor.svg | 134 ++++++ .../userspace-api/media/v4l/dev-subdev.rst | 2 + .../media/v4l/subdev-config-model.rst | 209 +++++++++ 5 files changed, 790 insertions(+) create mode 100644 Documentation/userspace-api/media/v4l/common-raw-sensor= .dia create mode 100644 Documentation/userspace-api/media/v4l/common-raw-sensor= .svg create mode 100644 Documentation/userspace-api/media/v4l/subdev-config-mod= el.rst diff --git a/Documentation/userspace-api/media/drivers/camera-sensor.rst b/= Documentation/userspace-api/media/drivers/camera-sensor.rst index bc55c861fb69..5bc4c79d230c 100644 --- a/Documentation/userspace-api/media/drivers/camera-sensor.rst +++ b/Documentation/userspace-api/media/drivers/camera-sensor.rst @@ -18,6 +18,8 @@ binning functionality. The sensor drivers belong to two d= istinct classes, freely configurable and register list-based drivers, depending on how the driver configures this functionality. =20 +Also see :ref:`media_subdev_config_model_common_raw_sensor`. + Freely configurable camera sensor drivers ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ =20 @@ -105,6 +107,8 @@ values programmed by the register sequences. The defaul= t values of these controls shall be 0 (disabled). Especially these controls shall not be inv= erted, independently of the sensor's mounting rotation. =20 +.. _media_using_camera_sensor_drivers_embedded_data: + Embedded data ------------- =20 diff --git a/Documentation/userspace-api/media/v4l/common-raw-sensor.dia b/= Documentation/userspace-api/media/v4l/common-raw-sensor.dia new file mode 100644 index 000000000000..aa927527eae3 --- /dev/null +++ b/Documentation/userspace-api/media/v4l/common-raw-sensor.dia @@ -0,0 +1,441 @@ + + + + + + + + + + + + + #A4# + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + #image data (1)# + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + #embedded data (2)# + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + #source pad (0)# + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Documentation/userspace-api/media/v4l/common-raw-sensor.svg b/= Documentation/userspace-api/media/v4l/common-raw-sensor.svg new file mode 100644 index 000000000000..1d6055da2519 --- /dev/null +++ b/Documentation/userspace-api/media/v4l/common-raw-sensor.svg @@ -0,0 +1,134 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Documentation/userspace-api/media/v4l/dev-subdev.rst b/Documen= tation/userspace-api/media/v4l/dev-subdev.rst index dcfcbd52490d..4d145bd3bd09 100644 --- a/Documentation/userspace-api/media/v4l/dev-subdev.rst +++ b/Documentation/userspace-api/media/v4l/dev-subdev.rst @@ -838,3 +838,5 @@ stream while it may be possible to enable and disable t= he embedded data stream. =20 The embedded data format does not need to be configured on the sensor's pa= ds as the format is dictated by the pixel data format in this case. + +.. include:: subdev-config-model.rst diff --git a/Documentation/userspace-api/media/v4l/subdev-config-model.rst = b/Documentation/userspace-api/media/v4l/subdev-config-model.rst new file mode 100644 index 000000000000..b0bd09772ceb --- /dev/null +++ b/Documentation/userspace-api/media/v4l/subdev-config-model.rst @@ -0,0 +1,209 @@ +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later + +.. _media_subdev_config_model: + +Sub-device configuration models +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D + +A sub-device configuration model specifies in detail what the user space c= an +expect from a sub-device in terms of V4L2 sub-device interface support, +semantics included. + +A sub-device may implement more than one configuration model at the same +time. The implemented configuration models can be obtained from the sub-de= vice's +``V4L2_CID_CONFIG_MODEL`` control. + +.. _media_subdev_config_model_common_raw_sensor: + +Common raw camera sensor model +------------------------------ + +The common raw camera sensor model defines a set of enumeration and +configuration interfaces (formats, selections etc.) that cover the vast ma= jority +of functionality of raw camera sensors. Not all of the interfaces are +necessarily offered by all drivers. + +A sub-device complies with the common raw sensor model if the +``V4L2_CONFIG_MODEL_COMMON_RAW`` bit is set in the ``V4L2_CID_CONFIG_MODEL= `` +control of the sub-device. + +The common raw camera sensor model is aligned with +:ref:`media_using_camera_sensor_drivers`. Please refer to that regarding a= spects +not specified here. + +Each camera sensor implementing the common raw sensor model exposes a sing= le +V4L2 sub-device. The sub-device contains a single source pad (0) and two o= r more +internal pads: an image data internal pad (1) and optionally an embedded d= ata +pad (2). Additionally, further internal pads may be supported for other +features, in which case they are documented separately for the given devic= e. + +This is shown in :ref:`media_subdev_config_model_common_raw_sensor_subdev`. + +.. _media_subdev_config_model_common_raw_sensor_subdev: + +.. kernel-figure:: common-raw-sensor.svg + :alt: common-raw-sensor.svg + :align: center + + **Common raw sensor sub-device** + +Routes +^^^^^^ + +A sub-device conforming to common raw camera sensor model implements the +following routes. + +.. flat-table:: Routes + :header-rows: 1 + + * - Sink pad/stream + - Source pad/stream + - Static (X/M(aybe)/-) + - Mandatory (X/-) + - Synopsis + * - 1/0 + - 0/0 + - X + - X + - Image data + * - 2/0 + - 0/1 + - M + - \- + - Embedded data + +Support for the embedded data stream is optional. Drivers supporting the +embedded data stream may allow disabling and enabling the route when the +streaming is disabled. + +Sensor pixel array size, cropping and binning +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The sensor's pixel array is divided into one or more areas. The areas arou= nd the +edge of the pixel array, usually one or more sides, may contain optical bl= ack +pixels, dummy pixels and other non-image pixels. The entire pixel array si= ze is +conveyed by the format on (pad, stream) pair 1/0. + +A rectangle within the pixel array contains the visible pixels. Capturing = the +non-visible pixels outside the visible pixel area may be supported by the +sensor. The visible pixel area corresponds to the ``V4L2_SEL_TGT_CROP_DEFA= ULT`` +selection target on (pad, stream) pair 1/0. + +Sensors can perform multiple operations that affect the output image size.= First +of these is the analogue crop. Analogue crop limits the area of the pixel = array +which the sensor will read, affecting sensor timing as well. The granulari= ty of +the analogue crop configuration varies greatly across sensors: some sensors +support only a few different analogue crop configurations whereas others m= ay +support anything divisible by a given number of pixels. The analogue crop +configuration corresponds the ``V4L2_SEL_TGT_CROP`` selection target on (p= ad, +stream) pair 1/0. The default analogue crop rectangle corresponds to the v= isible +pixel area. + +In the next step, binning is performed on the image data read from camera +sensor's pixel array, as determined by the analogue crop configuration. En= abling +binning will effectively result in an image smaller than the original by g= iven +binning factors horizontally and vertically. Typical values are 1/2 and 1/= 3 but +others may well be supported by the hardware as well. + +Sub-sampling follows binning. Sub-sampling, like binning, reduces the size= of +the image by including only a subset of samples read from the sensor's pix= el +matrix, typically every n'th pixel horizontally and vertically, taking the +sensor's colour pattern into account. Sub-sampling is generally configurab= le +separately horizontally and vertically. + +Binning and sub-sampling are configured using the ``V4L2_SEL_TGT_COMPOSE`` +rectangle, relative to the analogue crop rectangle, on (pad, stream) pair +1/0. The driver implementation determines how to configure binning and +sub-sampling to achieve the desired size. + +The digital crop operation takes place after binning and sub-sampling. It = is +configured by setting the ``V4L2_SEL_TGT_CROP`` rectangle on (pad, stream)= pair +0/0. The resulting image size is further output by the sensor. + +The sensor's output mbus code is configured by setting the format on the (= pad, +stream) pair 0/0. When setting the format, always use the same width and h= eight +as for the digital crop setting. + +Drivers may only support some of even none of these configurations, in whi= ch +case they do not expose the corresponding selection rectangles. If any sel= ection +targets are omitted, the further selection rectangle or format is instead +related to the previous implemented selection rectangle. For instance, if = the +sensor supports binning but not analogue crop, then the binning configurat= ion +(``V4L2_SEL_TGT_COMPOSE`` selection target) is done in relation to the vis= ible +pixel area (``V4L2_SEL_TGT_CROP_DEFAULT`` selection target). + +Also refer to :ref:`Selection targets `. + +.. flat-table:: Selection targets on pads + :header-rows: 1 + + * - Pad/Stream + - Selection target/format + - Mandatory (X/-) + - Modifiable (X/-) + - Synopsis + * - 1/0 + - Format + - X + - \- + - Image data format. The width and the height fields indicates the f= ull + size of the pixel array, including non-visible pixels. The media b= us + code of this format reflects the native pixel depth of the sensor. + * - 1/0 + - ``V4L2_SEL_TGT_CROP_DEFAULT`` + - X + - \ + - The visible pixel area. This rectangle is relative to the format o= n the + same (pad, stream). + * - 1/0 + - ``V4L2_SEL_TGT_CROP`` + - \- + - X + - Analogue crop. Analogue crop typically has a coarse granularity. T= his + rectangle is relative to the format on the same (pad, stream). + * - 1/0 + - ``V4L2_SEL_TGT_COMPOSE`` + - \- + - X + - Binning and sub-sampling. This rectangle is relative to the + ``V4L2_SEL_TGT_CROP`` rectangle on the same (pad, stream). The + combination of binning and sub-sampling is configured using this + selection target. + * - 2/0 + - Format + - X + - \- + - Embedded data format. + * - 0/0 + - ``V4L2_SEL_TGT_CROP`` + - \- + - X + - Digital crop. This rectangle is relative to the ``V4L2_SEL_TGT_COM= POSE`` + rectangle on (pad, stream) pair 1/0. + * - 0/0 + - Format + - X + - X + - Image data source format. Always assign the width and height field= s of + the format to the same values than for the ``V4L2_SEL_TGT_CROP`` + rectangle on (pad, stream) pair 0/0. The media bus code reflects t= he + pixel data output of the sensor. + * - 0/1 + - Format + - X + - \- + - Embedded data source format. + +Embedded data +^^^^^^^^^^^^^ + +The embedded data stream is produced by the sensor when the corresponding = route +is enabled. The embedded data route may also be immutable or not exist at = all, +in case the sensor (or the driver) does not support it. + +Generally the sensor embedded data width is determined by the width of the= image +data whereas the number of lines are constant for the embedded data. The u= ser +space may obtain the size of the embedded data once the image data size on= the +source pad has been configured. + +Also see :ref:`media_using_camera_sensor_drivers_embedded_data`. --=20 2.39.5