Skip to contentSkip to conversation

Documentation: media: Refer to mbus code documentation from CSI-2 docs

PATCH Superseded Sakari Ailus 2 participants 6 messages May 19, 2020 Media (V4L/DVB)

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 Documentation: media: Refer to mbus code documentation from CSI-2 docs

The media bus codes to be used on serial busses are documented but there was no reference from CSI-2 documentation. Add that now.

---
 Documentation/driver-api/media/csi2.rst | 7 +++++++
 1 file changed, 7 insertions(+)
Documentation/driver-api/media/csi2.rst +7 -0
index da8b356389f0..1653a51d2a6e 100644
@@ -10,6 +10,13 @@ the host SoC. It is defined by the `MIPI alliance`_.
 
 .. _`MIPI alliance`: http://www.mipi.org/
 
+Media bus formats
+-----------------
+
+Always use the media bus pixel code that describes a parallel format that
+transfers a sample on a single clock cycle. See :ref:`v4l2-mbus-format` for more
+information.
+
 Transmitter drivers
 -------------------
 
Signature · 1 line
2.20.1
#1 lore raw
Quoted 13 lines · Sakari Ailus

The media bus codes to be used on serial busses are documented but there was no reference from CSI-2 documentation. Add that now.

---
 Documentation/driver-api/media/csi2.rst | 7 +++++++
 1 file changed, 7 insertions(+)
Documentation/driver-api/media/csi2.rst +0 -0
index da8b356389f0..1653a51d2a6e 100644

Documentation/driver-api/media/csi2.rst the host SoC. It is defined by the `MIPI alliance`_. · line 17

Quoted 8 lines
Documentation/driver-api/media/csi2.rst +5 -0
@@ -10,6 +10,13 @@ the host SoC. It is defined by the `MIPI alliance`_.
 
 .. _`MIPI alliance`: http://www.mipi.org/
 
+Media bus formats
+-----------------
+
+Always use the media bus pixel code that describes a parallel format that
+transfers a sample on a single clock cycle. See :ref:`v4l2-mbus-format` for more

How about: "transfers the pixel data as a single sample in one clock cycle"

Possibly with an example: "So use e.g. MEDIA_BUS_FMT_SBGGR10_1X10 instead of MEDIA_BUS_FMT_SBGGR10_2X8_PADHI_BE."

Regards,

Hans

Quoted 6 lines
Documentation/driver-api/media/csi2.rst +2 -0
+information.
+
 Transmitter drivers
 -------------------
 
#2 lore raw

Hi Hans,

Quoted 17 lines · Hans Verkuil
Quoted 16 lines · Sakari Ailus

The media bus codes to be used on serial busses are documented but there was no reference from CSI-2 documentation. Add that now.

---
 Documentation/driver-api/media/csi2.rst | 7 +++++++
 1 file changed, 7 insertions(+)
Documentation/driver-api/media/csi2.rst +0 -0
index da8b356389f0..1653a51d2a6e 100644
@@ -10,6 +10,13 @@ the host SoC. It is defined by the `MIPI alliance`_.
 
 .. _`MIPI alliance`: http://www.mipi.org/
 
Quoted 7 lines

Documentation/driver-api/media/csi2.rst the host SoC. It is defined by the `MIPI alliance`_. · line 17

Quoted 5 lines
Documentation/driver-api/media/csi2.rst +5 -0
+Media bus formats
+-----------------
+
+Always use the media bus pixel code that describes a parallel format that
+transfers a sample on a single clock cycle. See :ref:`v4l2-mbus-format` for more

How about: "transfers the pixel data as a single sample in one clock cycle"

The text is from mbus format documentation. Note that this might not be pixel data; it may be metadata as well.

Quoted 3 lines

Possibly with an example: "So use e.g. MEDIA_BUS_FMT_SBGGR10_1X10 instead of MEDIA_BUS_FMT_SBGGR10_2X8_PADHI_BE."

There's an example in mbus format documentation. I'm fine adding one here, too, but the purpose of this bit is to mainly refer to mbus format documentation. Mbus format documentation uses MEDIA_BUS_FMT_BGR888_1X24 and MEDIA_BUS_FMT_BGR888_3X8 as the example.

Signature · 3 lines
Kind regards,

Sakari Ailus
#3 lore raw
Quoted 28 lines · Sakari Ailus

Hi Hans,

Quoted 17 lines · Hans Verkuil
Quoted 16 lines · Sakari Ailus

The media bus codes to be used on serial busses are documented but there was no reference from CSI-2 documentation. Add that now.

---
 Documentation/driver-api/media/csi2.rst | 7 +++++++
 1 file changed, 7 insertions(+)
Documentation/driver-api/media/csi2.rst +0 -0
index da8b356389f0..1653a51d2a6e 100644
@@ -10,6 +10,13 @@ the host SoC. It is defined by the `MIPI alliance`_.
 
 .. _`MIPI alliance`: http://www.mipi.org/
 
Quoted 7 lines

Documentation/driver-api/media/csi2.rst the host SoC. It is defined by the `MIPI alliance`_. · line 17

Quoted 5 lines
Documentation/driver-api/media/csi2.rst +5 -0
+Media bus formats
+-----------------
+
+Always use the media bus pixel code that describes a parallel format that
+transfers a sample on a single clock cycle. See :ref:`v4l2-mbus-format` for more

How about: "transfers the pixel data as a single sample in one clock cycle"

Quoted 2 lines

The text is from mbus format documentation. Note that this might not be pixel data; it may be metadata as well.

My problem with 'a sample' is that all parallel media bus formats transfer 'a sample' in a single clock cycle. It is not clearly defined what 'a sample' is.

Either the text needs to be improved, or an example should be added here as well since an example clarifies what is meant.

Quoted 10 lines
Quoted 4 lines

Possibly with an example: "So use e.g. MEDIA_BUS_FMT_SBGGR10_1X10 instead of MEDIA_BUS_FMT_SBGGR10_2X8_PADHI_BE."

There's an example in mbus format documentation. I'm fine adding one here, too, but the purpose of this bit is to mainly refer to mbus format documentation. Mbus format documentation uses MEDIA_BUS_FMT_BGR888_1X24 and MEDIA_BUS_FMT_BGR888_3X8 as the example.

Ah, I see. But then the reference to v4l2-mbus-format is confusing, I'd change that to v4l2-mbus-pixelcode. That's where the example is.

Regards,

Hans

#4 lore raw
Quoted 43 lines · Hans Verkuil
Quoted 28 lines · Sakari Ailus

Hi Hans,

Quoted 17 lines · Hans Verkuil
Quoted 16 lines · Sakari Ailus

The media bus codes to be used on serial busses are documented but there was no reference from CSI-2 documentation. Add that now.

---
 Documentation/driver-api/media/csi2.rst | 7 +++++++
 1 file changed, 7 insertions(+)
Documentation/driver-api/media/csi2.rst +0 -0
index da8b356389f0..1653a51d2a6e 100644
@@ -10,6 +10,13 @@ the host SoC. It is defined by the `MIPI alliance`_.
 
 .. _`MIPI alliance`: http://www.mipi.org/
 
Quoted 7 lines

Documentation/driver-api/media/csi2.rst the host SoC. It is defined by the `MIPI alliance`_. · line 17

Quoted 5 lines
Documentation/driver-api/media/csi2.rst +5 -0
+Media bus formats
+-----------------
+
+Always use the media bus pixel code that describes a parallel format that
+transfers a sample on a single clock cycle. See :ref:`v4l2-mbus-format` for more

How about: "transfers the pixel data as a single sample in one clock cycle"

Quoted 2 lines

The text is from mbus format documentation. Note that this might not be pixel data; it may be metadata as well.

My problem with 'a sample' is that all parallel media bus formats transfer 'a sample' in a single clock cycle. It is not clearly defined what 'a sample' is.

Either the text needs to be improved, or an example should be added here as well since an example clarifies what is meant.

Quoted 5 lines
Quoted 4 lines

Possibly with an example: "So use e.g. MEDIA_BUS_FMT_SBGGR10_1X10 instead of MEDIA_BUS_FMT_SBGGR10_2X8_PADHI_BE."

Quoted 8 lines
Quoted 5 lines

There's an example in mbus format documentation. I'm fine adding one here, too, but the purpose of this bit is to mainly refer to mbus format documentation. Mbus format documentation uses MEDIA_BUS_FMT_BGR888_1X24 and MEDIA_BUS_FMT_BGR888_3X8 as the example.

Ah, I see. But then the reference to v4l2-mbus-format is confusing, I'd change that to v4l2-mbus-pixelcode. That's where the example is.

Ah, that's a better label indeed. I'll use that. With this, do you prefer having the example here as well?

Signature · 1 line
Sakari Ailus
#5 lore raw
Quoted 50 lines · Sakari Ailus
Quoted 49 lines · Hans Verkuil
Quoted 28 lines · Sakari Ailus

Hi Hans,

Quoted 17 lines · Hans Verkuil
Quoted 16 lines · Sakari Ailus

The media bus codes to be used on serial busses are documented but there was no reference from CSI-2 documentation. Add that now.

---
 Documentation/driver-api/media/csi2.rst | 7 +++++++
 1 file changed, 7 insertions(+)
Documentation/driver-api/media/csi2.rst +0 -0
index da8b356389f0..1653a51d2a6e 100644
@@ -10,6 +10,13 @@ the host SoC. It is defined by the `MIPI alliance`_.
 
 .. _`MIPI alliance`: http://www.mipi.org/
 
Quoted 7 lines

Documentation/driver-api/media/csi2.rst the host SoC. It is defined by the `MIPI alliance`_. · line 17

Quoted 5 lines
Documentation/driver-api/media/csi2.rst +5 -0
+Media bus formats
+-----------------
+
+Always use the media bus pixel code that describes a parallel format that
+transfers a sample on a single clock cycle. See :ref:`v4l2-mbus-format` for more

How about: "transfers the pixel data as a single sample in one clock cycle"

Quoted 2 lines

The text is from mbus format documentation. Note that this might not be pixel data; it may be metadata as well.

My problem with 'a sample' is that all parallel media bus formats transfer 'a sample' in a single clock cycle. It is not clearly defined what 'a sample' is.

Either the text needs to be improved, or an example should be added here as well since an example clarifies what is meant.

Quoted 10 lines
Quoted 4 lines

Possibly with an example: "So use e.g. MEDIA_BUS_FMT_SBGGR10_1X10 instead of MEDIA_BUS_FMT_SBGGR10_2X8_PADHI_BE."

There's an example in mbus format documentation. I'm fine adding one here, too, but the purpose of this bit is to mainly refer to mbus format documentation. Mbus format documentation uses MEDIA_BUS_FMT_BGR888_1X24 and MEDIA_BUS_FMT_BGR888_3X8 as the example.

Quoted 6 lines
Quoted 2 lines

Ah, I see. But then the reference to v4l2-mbus-format is confusing, I'd change that to v4l2-mbus-pixelcode. That's where the example is.

Ah, that's a better label indeed. I'll use that. With this, do you prefer having the example here as well?

Rather than duplicating text, perhaps it is better to just refer to the v4l2-mbus-pixelcode section:

+Media bus formats
+-----------------
+
+See :ref:v4l2-mbus-pixelcode for details on which media bus formats should +be used for CSI-2 interfaces.

Regards,

Hans