Skip to contentSkip to conversation

Documentation: media: Document media bus codes to use on serial busses

PATCH In review Sakari Ailus 2 participants 3 messages May 19, 2020 Media (V4L/DVB)

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: media: Document media bus codes to use on serial busses

Document media bus codes on serial busses. The single sample per pixel variant is to be chosen from all the possible variants. While this has been the practice since the introduction of CSI-2 support, it never was written down. Do it now.

---
 Documentation/driver-api/media/csi2.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)
Documentation/driver-api/media/csi2.rst +10 -0
index da8b356389f0..af078ac927bd 100644
@@ -10,6 +10,16 @@ the host SoC. It is defined by the `MIPI alliance`_.
 
 .. _`MIPI alliance`: http://www.mipi.org/
 
+Media bus formats
+-----------------
+
+Always use single sample per pixel formats on the CSI-2 bus.
+
+No new media bus formats were created when the support for serial busses were
+added. To avoid using different media bus codes to describe the same format, the
+practice is to use a format that has a single sample per pixel on the parallel
+bus.
+
 Transmitter drivers
 -------------------
 
Signature · 1 line
2.20.1
#1 lore raw
Quoted 15 lines · Sakari Ailus

Document media bus codes on serial busses. The single sample per pixel variant is to be chosen from all the possible variants. While this has been the practice since the introduction of CSI-2 support, it never was written down. Do it now.

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

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

Quoted 9 lines
Documentation/driver-api/media/csi2.rst +6 -0
@@ -10,6 +10,16 @@ the host SoC. It is defined by the `MIPI alliance`_.
 
 .. _`MIPI alliance`: http://www.mipi.org/
 
+Media bus formats
+-----------------
+
+Always use single sample per pixel formats on the CSI-2 bus.
+
+No new media bus formats were created when the support for serial busses were

busses -> buses

(actually, both spellings are used in about equal measures in the kernel, but the official spelling is 'buses').

were -> was

(the support was added, 'support' is singular)

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

Quoted 3 lines
Documentation/driver-api/media/csi2.rst +3 -0
+added. To avoid using different media bus codes to describe the same format, the
+practice is to use a format that has a single sample per pixel on the parallel
+bus.

To be honest, I'm confused by this text. Probably because I don't know enough about CSI. I'm not really sure what you mean with 'single sample per pixel'.

Regards,

Hans

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

Hi Hans,

Thanks for the review.

Quoted 28 lines · Hans Verkuil
Quoted 15 lines · Sakari Ailus

Document media bus codes on serial busses. The single sample per pixel variant is to be chosen from all the possible variants. While this has been the practice since the introduction of CSI-2 support, it never was written down. Do it now.

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

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

Quoted 9 lines
Documentation/driver-api/media/csi2.rst +6 -0
@@ -10,6 +10,16 @@ the host SoC. It is defined by the `MIPI alliance`_.
 
 .. _`MIPI alliance`: http://www.mipi.org/
 
+Media bus formats
+-----------------
+
+Always use single sample per pixel formats on the CSI-2 bus.
+
+No new media bus formats were created when the support for serial busses were

busses -> buses

Quoted 2 lines

(actually, both spellings are used in about equal measures in the kernel, but the official spelling is 'buses').

I guess you mean "American"?

Quoted 4 lines

were -> was

(the support was added, 'support' is singular)

Agreed.

Quoted 7 lines

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

Quoted 4 lines
Documentation/driver-api/media/csi2.rst +3 -0
+added. To avoid using different media bus codes to describe the same format, the
+practice is to use a format that has a single sample per pixel on the parallel
+bus.

To be honest, I'm confused by this text. Probably because I don't know enough about CSI. I'm not really sure what you mean with 'single sample per pixel'.

Good catch.

I went to look into mbus format documentation to see how this was expressed there, only to find the subject is already covered. This need to be referred to from CSI-2 documentation though.

I'll send v2.

Signature · 3 lines
Regards,

Sakari Ailus