doc-rst: Add Intel IPU3 documentation
Subsystems (4)
Sakari Ailus
maintainerRFC 1/1 doc-rst: Add Intel IPU3 documentation
From: Rajmohan Mani <[email protected]>
This patch adds the details about the IPU3 Imaging Unit driver (both CIO2 and IMGU).
---
Hi Laurent,
Here's the original documentation patch with my changes folded into it. The metadata format patch is needed before this one as it fixes the header path as well.
I'm sending it as RFC as it's not intended to be merged.
.../media/uapi/v4l/pixfmt-meta-intel-ipu3.rst | 2 +- Documentation/media/v4l-drivers/index.rst | 1 + Documentation/media/v4l-drivers/ipu3.rst | 369 +++++++++++++++++++++ drivers/staging/media/ipu3/TODO | 11 + 4 files changed, 382 insertions(+), 1 deletion(-) create mode 100644 Documentation/media/v4l-drivers/ipu3.rst
Documentation/media/uapi/v4l/pixfmt-meta-intel-ipu3.rst +1 -1
@@ -175,4 +175,4 @@ video node in ``V4L2_BUF_TYPE_META_CAPTURE`` format. Intel IPU3 ImgU uAPI data types =============================== -.. kernel-doc:: include/uapi/linux/intel-ipu3.h +.. kernel-doc:: drivers/staging/media/ipu3/include/intel-ipu3.h
Documentation/media/v4l-drivers/index.rst +1 -0
@@ -44,6 +44,7 @@ For more details see the file COPYING in the source distribution of Linux. davinci-vpbe fimc imx + ipu3 ivtv max2175 meye
Documentation/media/v4l-drivers/ipu3.rst new file +369 -0
369 lines not on this page · raw message
drivers/staging/media/ipu3/TODO +11 -0
@@ -21,3 +21,14 @@ staging directory. Further clarification on some ambiguities such as data type conversion of IEFD CU inputs. (Sakari) Move acronyms to doc-rst file. (Mauro) + +- Switch to yavta from v4l2n in driver docs. + +- Elaborate the functionality of different selection rectangles in driver + documentation. This may require driver changes as well. + +- More detailed documentation on calculating BDS, GCD etc. sizes needed. + +- Document different operation modes, and which buffer queues are relevant + in each mode. To process an image, which queues require a buffer an in + which ones is it optional?
Signature · 1 line
2.11.0
Hi Sakari,
Quoted 7 lines · On Thursday, 13 December 2018 13:45:43 EET Sakari Ailus wrote:
From: Rajmohan Mani <[email protected]>
This patch adds the details about the IPU3 Imaging Unit driver (both CIO2 and IMGU).
Signed-off-by Rajmohan Mani <[email protected]>Signed-off-by Sakari Ailus <[email protected]>
Quoted 8 lines
---
Hi Laurent,Here's the original documentation patch with my changes folded into it. The metadata format patch is needed before this one as it fixes the header path as well.
I'm sending it as RFC as it's not intended to be merged.
Thanks. I'll provide review comments below, as the original unsquashed patch was impossible to review properly.
Quoted 57 lines
.../media/uapi/v4l/pixfmt-meta-intel-ipu3.rst | 2 +- Documentation/media/v4l-drivers/index.rst | 1 + Documentation/media/v4l-drivers/ipu3.rst | 369 ++++++++++++++++++ drivers/staging/media/ipu3/TODO | 11 + 4 files changed, 382 insertions(+), 1 deletion(-) create mode 100644 Documentation/media/v4l-drivers/ipu3.rst(quoted diff) +0
-0
b/Documentation/media/uapi/v4l/pixfmt-meta-intel-ipu3.rstindex8cd30ffbf8b8b..dc871006b41a5100644Documentation/media/uapi/v4l/pixfmt-meta-intel-ipu3.rst +1
-1@@ -175,4 +175,4 @@ video node in ``V4L2_BUF_TYPE_META_CAPTURE`` format. Intel IPU3 ImgU uAPI data types =============================== -.. kernel-doc:: include/uapi/linux/intel-ipu3.h +.. kernel-doc:: drivers/staging/media/ipu3/include/intel-ipu3.h(quoted diff) +0
-0
b/Documentation/media/v4l-drivers/index.rstindex6cdd3bc982023..f28570ec9e427100644Documentation/media/v4l-drivers/index.rst +0
-0@@ -44,6 +44,7 @@ For more details see the file COPYING in the sourcedistribution of Linux. davinci-vpbe
Documentation/media/v4l-drivers/index.rst +1
-0fimc imx + ipu3 ivtv max2175 meye(quoted diff) +0
-0
b/Documentation/media/v4l-drivers/ipu3.rstnew file mode 100644 index 0000000000000..f89b51dafadd0Documentation/media/v4l-drivers/ipu3.rst new file +13
-0@@ -0,0 +1,369 @@ +.. include:: <isonum.txt> + +=============================================================== +Intel Image Processing Unit 3 (IPU3) Imaging Unit (ImgU) driver +=============================================================== + +Copyright |copy| 2018 Intel Corporation + +Introduction +============ + +This file documents the Intel IPU3 (3rd generation Image Processing Unit) +Imaging Unit drivers located under drivers/media/pci/intel/ipu3 (CIO2) aswell +as under
drivers/staging/media/ipu3(ImgU).Documentation/media/v4l-drivers/ipu3.rst new file +3
-0+ +The Intel IPU3 found in certain Kaby Lake (as well as certain Sky Lake) +platforms (U/Y processor lines) is made up of two parts namely the ImagingUnit +(ImgU) and the CIO2 device (MIPI CSI2 receiver).
Documentation/media/v4l-drivers/ipu3.rst new file +2
-0+ +The CIO2 device receives the raw Bayer data from the sensors and outputs
Quoted 2 lines
the +frames in a format that is specific to the IPU3 (for consumption by the IPU3 +ImgU). The CIO2 driver is available as
s/available as/available in/
Documentation/media/v4l-drivers/ipu3.rst line 26
Quoted 5 lines
drivers/media/pci/intel/ipu3/ipu3-cio2*+and is enabled through theCONFIG_VIDEO_IPU3_CIO2config option.Documentation/media/v4l-drivers/ipu3.rst new file +3
-0+ +The Imaging Unit (ImgU) is responsible for processing images captured +by the IPU3 CIO2 device. The ImgU driver sources can be found under
s/under/under the/ or s/under/in the/
Documentation/media/v4l-drivers/ipu3.rst line 32
Quoted 6 lines
Documentation/media/v4l-drivers/ipu3.rst new file +6
-0+drivers/staging/media/ipu3 directory. The driver is enabled through the +CONFIG_VIDEO_IPU3_IMGU config option. + +The two driver modules are named ipu3_csi2 and ipu3_imgu, respectively. + +The drivers has been tested on Kaby Lake platforms (U/Y processor lines).
s/has/have/
Quoted 10 lines
Documentation/media/v4l-drivers/ipu3.rst new file +2
-0+Both of the drivers implement V4L2, Media Controller and V4L2 sub-device +interfaces. The IPU3 CIO2 driver supports camera sensors connected to theCIO2 +MIPI CSI-2 interfaces through V4L2 sub-device sensor drivers.
Documentation/media/v4l-drivers/ipu3.rst new file +5
-0+ +CIO2 +==== + +The CIO2 is represented as a single V4L2 subdev, which provides a V4L2subdev +interface to the user space. There is a video node for each CSI-2 receiver, +with a single media controller interface for the entire device.
This first paragraph is redundant with the rest of the CIO2 documentation, I would just drop it.
Quoted 23 lines
+The CIO2 contains four independent capture channel, each with its own MIPI CSI-2 +receiver and DMA engine. Each channel is modelled as a V4L2 sub-device exposed +to userspace as a V4L2 sub-device node and has two pads:
Documentation/media/v4l-drivers/ipu3.rst new file +18
-0+ +.. tabularcolumns:: |p{0.8cm}|p{4.0cm}|p{4.0cm}| + +.. flat-table:: + + * - pad + - direction + - purpose + + * - 0 + - sink + - MIPI CSI-2 input, connected to the sensor subdev + + * - 1 + - source + - Raw video capture, connected to the V4L2 video interface + +The V4L2 video interfaces model the DMA engines. They are exposed touserspace +as V4L2 video device nodes.
Documentation/media/v4l-drivers/ipu3.rst
Quoted 5 lines
Documentation/media/v4l-drivers/ipu3.rst new file +5
-0+ +Capturing frames in raw Bayer format +------------------------------------ + +CIO2 MIPI CSI2 receiver is used to capture frames (in packed raw Bayer
s/CIO2/The CIO2/
Quoted 2 lines
format) +from the raw sensors connected to the CSI2 ports. The captured frames are used +as input to the ImgU driver.
I'd write this
"The CIO2 MIPI CSI2 receiver is used to capture fames from the raw sensors connected to the CSI2 ports. The frames are stored in a packed raw Bayer format specific to the IPU3, meant to be consumed by the IPU3 ImgU."
Quoted 8 lines
Documentation/media/v4l-drivers/ipu3.rst new file +2
-0+Image processing using IPU3 ImgU requires tools such as raw2pnm [#f1]_, and +yavta [#f2]_ due to the following unique requirements and / or featuresspecific +to IPU3.
+
+-- The IPU3 CSI2 receiver outputs the captured frames from the sensor in packed +raw Bayer format that is specific to IPU3.
+
+-- Multiple video nodes have to be operated simultaneously.
I wouldn't mention the ImgU at all here, this is the CIO2 section. I think you can move all of the above except the first paragraph to the ImgU section.
Quoted 1 line
+Let us take the example of ov5670 sensor connected to CSI2 port 0, for a
s/ov5670/an ov5670/
And I would also write OV5670 here and below (we usually use uppercase for chip names and lowercase for driver names).
Documentation/media/v4l-drivers/ipu3.rst
Quoted 3 lines
+2592x1944 image capture.
Documentation/media/v4l-drivers/ipu3.rst new file +2
-0+ +Using the media contorller APIs, the ov5670 sensor is configured to send
s/contorller/controller/
Quoted 1 line
+frames in packed raw Bayer format to IPU3 CSI2 receiver.
You probably want to format the code below as code from an .rst perspective.
Documentation/media/v4l-drivers/ipu3.rst line 99
Quoted 10 lines
Documentation/media/v4l-drivers/ipu3.rst new file +10
-0+# This example assumes /dev/media0 as the CIO2 media device + +export MDEV=/dev/media0 + +# and that ov5670 sensor is connected to i2c bus 10 with address 0x36 + +export SDEV=$(media-ctl -d $MDEV -e "ov5670 10-0036") + +# Establish the link for the media devices using media-ctl [#f3]_ +media-ctl -d $MDEV -l "ov5670:0 -> ipu3-csi2 0:0[1]"
Please test the code. This won't work.
Documentation/media/v4l-drivers/ipu3.rst line 106
Quoted 6 lines
Documentation/media/v4l-drivers/ipu3.rst new file +6
-0+# Set the format for the media devices +media-ctl -d $MDEV -V "ov5670:0 [fmt:SGRBG10/2592x1944]" + +media-ctl -d $MDEV -V "ipu3-csi2 0:0 [fmt:SGRBG10/2592x1944]" + +media-ctl -d $MDEV -V "ipu3-csi2 0:1 [fmt:SGRBG10/2592x1944]"
Neither will this.
Documentation/media/v4l-drivers/ipu3.rst line 117
Quoted 10 lines
Documentation/media/v4l-drivers/ipu3.rst new file +10
-0+Once the media pipeline is configured, desired sensor specific settings +(such as exposure and gain settings) can be set, using the yavta tool. + +e.g + +yavta -w 0x009e0903 444 $SDEV + +yavta -w 0x009e0913 1024 $SDEV + +yavta -w 0x009e0911 2046 $SDEV
Missing --no-query argument.
Documentation/media/v4l-drivers/ipu3.rst line 124
Quoted 7 lines
+Once the desired sensor settings are set, frame captures can be done as below.
Documentation/media/v4l-drivers/ipu3.rst new file +5
-0+ +e.g + +yavta --data-prefix -u -c10 -n5 -I -s2592x1944 --file=/tmp/frame-#.bin \ + -f IPU3_SGRBG10 $(media-ctl -d $MDEV -e "ipu3-cio2 0")
--data-prefix isn't needed. Neither is -u.
Documentation/media/v4l-drivers/ipu3.rst line 135
Quoted 10 lines
+With the above command, 10 frames are captured at 2592x1944 resolution, with +sGRBG10 format and output as
IPU3_SGRBG10format.Documentation/media/v4l-drivers/ipu3.rst new file +8
-0+ +The captured frames are available as /tmp/frame-#.bin files. + +ImgU +==== + +The ImgU is represented as two V4L2 subdevs, each of which provides a V4L2 +subdev interface to the user space.
This is redundant with the third paragraph and can be removed.
Quoted 3 lines
+Each V4L2 subdev represents a pipe, which can support a maximum of 2 streams. +This helps to support advanced camera features like Continuous View Finder (CVF) +and Snapshot During Video(SDV).
This is confusing. Can each pipe support two streams, or is it one stream per pipe for a total of two streams ? Assuming the latter, I'd simply drop the first sentence.
Documentation/media/v4l-drivers/ipu3.rst line 142
Quoted 2 lines
Documentation/media/v4l-drivers/ipu3.rst new file +2
-0+The ImgU contains two independent pipes, each modelled as a V4L2 sub-device +exposed to userspace as a V4L2 sub-device node.
I would move this paragraph above the previous one.
Quoted 1 line
+Each pipe has two sink pads and three source pads for the following
Maybe s/pipe/pipe subdev/
Quoted 27 lines
purpose:
Documentation/media/v4l-drivers/ipu3.rst new file +26
-0+ +.. tabularcolumns:: |p{0.8cm}|p{4.0cm}|p{4.0cm}| + +.. flat-table:: + + * - pad + - direction + - purpose + + * - 0 + - sink + - Input raw video stream + + * - 1 + - sink + - Processing parameters + + * - 2 + - source + - Output processed video stream + + * - 3 + - source + - Output viewfinder video stream + + * - 4
Documentation/media/v4l-drivers/ipu3.rst line 180
Quoted 10 lines
Documentation/media/v4l-drivers/ipu3.rst new file +10
-0+ - source + - 3A statistics + +Each pad is connected to a corresponding V4L2 video interface, exposed to +userspace as a V4L2 video device node. + +Device operation +---------------- + +With ImgU, once the input video node ("ipu3-imgu 0/1":0, in
s/With ImgU, once/Once/
s/0\/1/[01]/
Quoted 2 lines
+<entity>:<pad-number> format) is queued with buffer (in packed raw Bayer +format), ImgU starts processing the buffer and produces the video output in
s/ImgU/the ImgU/
Quoted 3 lines
YUV +format and statistics output on respective output nodes. The driver is expected +to have buffers ready for all of parameter, output and statistics nodes, when +input video node is queued with buffer.
I still think this isn't right, but it's a code issue, not a documentation issue.
Quoted 10 lines
Documentation/media/v4l-drivers/ipu3.rst new file +9
-0+At a minimum, all of input, main output, 3A statistics and viewfinder +video nodes should be enabled for IPU3 to start image processing. + +Each ImgU V4L2 subdev has the following set of video nodes. + +input, output and viewfinder video nodes +---------------------------------------- + +The frames (in packed raw Bayer format specific to the IPU3) received bythe +input video node is processed by the IPU3 Imaging Unit and are output
s/is processed/are processed/
s/Imaging Unit/ImgU/ (to be consistent)
Documentation/media/v4l-drivers/ipu3.rst line 200
Quoted 4 lines
to 2 video +nodes, with each targeting a different purpose (main output and viewfinder +output).
Documentation/media/v4l-drivers/ipu3.rst new file +2
-0+ +Details onand the Bayer format specific to the IPU3 can be found in
onand ?
Documentation/media/v4l-drivers/ipu3.rst
Quoted 3 lines
+:ref:
v4l2-pix-fmt-ipu3-sbggr10.Documentation/media/v4l-drivers/ipu3.rst new file +2
-0+ +The driver supports V4L2 Video Capture Interface as defined at
s/supports/supports the/
Does Intel have budget restrictions on definite articles ?
You should also mention the video output interface (for the input video node).
Quoted 9 lines
:ref:
devices. +Documentation/media/v4l-drivers/ipu3.rst new file +7
-0+Only the multi-planar API is supported. More details can be found at +:ref:`planar-apis`. + +Parameters video node +--------------------- + +The parameters video node receives the ImgU algorithm parameters that areused +to configure how the ImgU algorithms process the image.
Documentation/media/v4l-drivers/ipu3.rst line 220
Quoted 8 lines
Documentation/media/v4l-drivers/ipu3.rst new file +8
-0+ +Details on processing parameters specific to the IPU3 can be found in +:ref:`v4l2-meta-fmt-params`. + +3A statistics video node +------------------------ + +3A statistics video node is used by the ImgU driver to output the 3A (auto
s/^/The /
Documentation/media/v4l-drivers/ipu3.rst line 227
Quoted 7 lines
+focus, auto exposure and auto white balance) statistics for the frames that are +being processed by the ImgU to user space applications. User space applications +can use this statistics data to compute the desired algorithm parameters for +the ImgU.
Documentation/media/v4l-drivers/ipu3.rst new file +3
-0+ +Configuring the Intel IPU3 +==========================
This should be in the ImgU section, not at the same level, and renamed to mention the ImgU.
Quoted 1 line
+The IPU3 ImgU pipelines can be configured using the Media Controller,
s/Media Controller/Media Controller API/
Quoted 8 lines
defined at +:ref:
media_controller.Documentation/media/v4l-drivers/ipu3.rst new file +5
-0+ +Firmware binary selection +------------------------- + +The firmware binary is selected using the V4L2_CID_INTEL_IPU3_MODE,currently +defined in
drivers/staging/media/ipu3/include/intel-ipu3.h. "VIDEO" and "STILL" +modes are available.
As mentioned in another e-mail, I wouldn't talk about firmware here, just about modes.
Documentation/media/v4l-drivers/ipu3.rst line 242
Quoted 4 lines
Documentation/media/v4l-drivers/ipu3.rst new file +4
-0+Processing the image in raw Bayer format +---------------------------------------- + +Configuring ImgU V4L2 subdev for image processing
s/ImgU/the ImgU/
Documentation/media/v4l-drivers/ipu3.rst
Quoted 3 lines
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Documentation/media/v4l-drivers/ipu3.rst new file +2
-0+ +The ImgU V4L2 subdevs have to be configured with media controller APIs to
s/media controller APIs/the Media Controller API/
Documentation/media/v4l-drivers/ipu3.rst line 258
Quoted 13 lines
have +all the video nodes setup correctly.
Documentation/media/v4l-drivers/ipu3.rst new file +12
-0+ +Let us take "ipu3-imgu 0" subdev as an example. + +media-ctl -d $MDEV -r + +media-ctl -d $MDEV -l "ipu3-imgu 0 input":0 -> "ipu3-imgu 0":0[1] + +media-ctl -d $MDEV -l "ipu3-imgu 0":2 -> "ipu3-imgu 0 output":0[1] + +media-ctl -d $MDEV -l "ipu3-imgu 0":3 -> "ipu3-imgu 0 viewfinder":0[1] + +media-ctl -d $MDEV -l "ipu3-imgu 0":4 -> "ipu3-imgu 0 3a stat":0[1]
Invalid syntax as well :-)
Documentation/media/v4l-drivers/ipu3.rst line 264
Quoted 5 lines
+Also the pipe mode of the corresponding V4L2 subdev should be set as desired +(e.g 0 for video mode or 1 for still mode) through the control id
0x009819a1as +below.Documentation/media/v4l-drivers/ipu3.rst new file +2
-0+ +yavta -w "0x009819A1 1" /dev/v4l-subdev7
--no-query
Quoted 1 line
+RAW Bayer frames go through the following ImgU pipeline HW blocks to have
s/HW/hardware/
Quoted 1 line
the +processed image output to the DDR memory.
s/the DDR/system/
(or just drop "the DDR ")
Documentation/media/v4l-drivers/ipu3.rst line 270
Quoted 3 lines
Documentation/media/v4l-drivers/ipu3.rst new file +3
-0+ +RAW Bayer frame -> Input Feeder -> Bayer Down Scaling (BDS) -> Geometric +Distortion Correction (GDC) -> DDR
Same here, I'd rename DDR.
Quoted 2 lines
+The ImgU V4L2 subdev has to be configured with the supported resolutions in all +the above HW blocks, for a given input resolution.
s/HW/hardware/
Quoted 50 lines
+For a given supported resolution for an input frame, the Input Feeder, Bayer +Down Scaling and GDC blocks should be configured with the supported resolutions. +This information can be obtained by looking at the following IPU3 ImgU +configuration table.
Documentation/media/v4l-drivers/ipu3.rst new file +2
-0+ +https://chromium.googlesource.com/chromiumos/overlays/board-overlays/+/master +
Documentation/media/v4l-drivers/ipu3.rst new file +7
-0+Under baseboard-poppy/media-libs/cros-camera-hal-configs-poppy/files/gcss +directory, graph_settings_ov5670.xml can be used as an example. + +The following steps prepare the ImgU pipeline for the image processing. + +1. The ImgU V4L2 subdev data format should be set by using the +VIDIOC_SUBDEV_S_FMT on pad 0, using the GDC width and height obtainedabove. +
+2. The ImgU V4L2 subdev cropping should be set by using theDocumentation/media/v4l-drivers/ipu3.rst new file +5
-0+VIDIOC_SUBDEV_S_SELECTION on pad 0, with V4L2_SEL_TGT_CROP as the target, +using the input feeder height and width. + +3. The ImgU V4L2 subdev composing should be set by using the +VIDIOC_SUBDEV_S_SELECTION on pad 0, with V4L2_SEL_TGT_COMPOSE as thetarget, +using the BDS height and width.
Documentation/media/v4l-drivers/ipu3.rst new file +11
-0+ +For the ov5670 example, for an input frame with a resolution of 2592x1944 +(which is input to the ImgU subdev pad 0), the corresponding resolutions +for input feeder, BDS and GDC are 2592x1944, 2592x1944 and 2560x1920 +respectively. + +Once this is done, the received raw Bayer frames can be input to the ImgU +V4L2 subdev as below, using the open source application v4l2n [#f1]_. + +For an image captured with 2592x1944 [#f4]_ resolution, with desired output +resolution as 2560x1920 and viewfinder resolution as 2560x1920, thefollowing +v4l2n command can be used. This helps process the raw Bayer frames and produces +the desired results for the main output image and the viewfinder output, in NV12 +format.
Documentation/media/v4l-drivers/ipu3.rst new file +3
-0+ +v4l2n --pipe=4 --load=/tmp/frame-#.bin --open=/dev/video4 +--fmt=type:VIDEO_OUTPUT_MPLANE,width=2592,height=1944,pixelformat=0X47337069 +--reqbufs=type:VIDEO_OUTPUT_MPLANE,count:1 --pipe=1 --output=/tmp/frames.out +--open=/dev/video5
+--fmt=type:VIDEO_CAPTURE_MPLANE,width=2560,height=1920,pixelformat=NV12 +--reqbufs=type:VIDEO_CAPTURE_MPLANE,count:1 --pipe=2 --output=/tmp/frames.vf +--open=/dev/video6 +--fmt=type:VIDEO_CAPTURE_MPLANE,width=2560,height=1920,pixelformat=NV12 +--reqbufs=type:VIDEO_CAPTURE_MPLANE,count:1 --pipe=3 --open=/dev/video7 +--output=/tmp/frames.3A --fmt=type:META_CAPTURE,? +--reqbufs=count:1,type:META_CAPTURE --pipe=1,2,3,4 --stream=5Documentation/media/v4l-drivers/ipu3.rst new file +2
-0+ +where /dev/video4, /dev/video5, /dev/video6 and /dev/video7 devices point
Quoted 1 line
to +input, output, viewfinder and 3A statistics video nodes respectively.
All this clearly has to be rewritten, so I won't comment on it.
Quoted 12 lines
Documentation/media/v4l-drivers/ipu3.rst new file +12
-0+ +Converting the raw Bayer image into YUV domain +---------------------------------------------- + +The processed images after the above step, can be converted to YUV domain +as below. + +Main output frames +~~~~~~~~~~~~~~~~~~ + +raw2pnm -x2560 -y1920 -fNV12 /tmp/frames.out /tmp/frames.out.ppm +
Documentation/media/v4l-drivers/ipu3.rst line 347
Quoted 10 lines
Documentation/media/v4l-drivers/ipu3.rst new file +10
-0+where 2560x1920 is output resolution, NV12 is the video format, followed +by input frame and output PNM file. + +Viewfinder output frames +~~~~~~~~~~~~~~~~~~~~~~~~ + +raw2pnm -x2560 -y1920 -fNV12 /tmp/frames.vf /tmp/frames.vf.ppm + +where 2560x1920 is output resolution, NV12 is the video format, followed +by input frame and output PNM file.
This isn't very relevant to the driver, should it be dropped ? The title is also misleading, it could be interpreted as raw2pnm converting from Bayer to YUV. You may want to replace this by a single paragraph put in the appropriate place in the ImgU documentation to state that output frames are in YUV format (or even NV12 if that's the only supported format).
Documentation/media/v4l-drivers/ipu3.rst line 356
Quoted 8 lines
Documentation/media/v4l-drivers/ipu3.rst new file +8
-0+Example user space code for IPU3 +================================ + +User space code that configures and uses IPU3 is available here. + +https://chromium.googlesource.com/chromiumos/platform/arc-camera/+/master/ + +The source can be located under hal/intel directory.
How about appending hal/intel to the URL then ? :-)
Quoted 21 lines
Documentation/media/v4l-drivers/ipu3.rst new file +12
-0+References +========== + +.. [#f5] include/uapi/linux/intel-ipu3.h + +.. [#f1] https://github.com/intel/nvt + +.. [#f2] http://git.ideasonboard.org/yavta.git + +.. [#f3] http://git.ideasonboard.org/?p=media-ctl.git;a=summary + +.. [#f4] ImgU limitation requires an additional 16x16 for all inputresolutions diff --git a/drivers/staging/media/ipu3/TODO b/drivers/staging/media/ipu3/TODO index
922b885f10a70..905bbb190217b100644drivers/staging/media/ipu3/TODO +1
-0@@ -21,3 +21,14 @@ staging directory. Further clarification on some ambiguities such as data type conversion of IEFD CU inputs. (Sakari) Move acronyms to doc-rst file. (Mauro) +
drivers/staging/media/ipu3/TODO staging directory. · line 34
Quoted 10 lines
drivers/staging/media/ipu3/TODO +10
-0+- Switch to yavta from v4l2n in driver docs. + +- Elaborate the functionality of different selection rectangles in driver + documentation. This may require driver changes as well. + +- More detailed documentation on calculating BDS, GCD etc. sizes needed. + +- Document different operation modes, and which buffer queues are relevant + in each mode. To process an image, which queues require a buffer an in + which ones is it optional?
- Move the internal block diagram from the metadata format documentation to the ipu3 driver documentation.
Signature · 3 lines
Regards, Laurent Pinchart