0082-media-admin-guide-Add-starfive_camss.rst-for-Starfiv.patch 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. From 949807343300a75b6e7c3e47463f817a7b6bc790 Mon Sep 17 00:00:00 2001
  2. From: Jack Zhu <[email protected]>
  3. Date: Fri, 12 May 2023 18:28:40 +0800
  4. Subject: [PATCH 082/122] media: admin-guide: Add starfive_camss.rst for
  5. Starfive Camera Subsystem
  6. Add starfive_camss.rst file that documents the Starfive Camera
  7. Subsystem driver which is used for handing image sensor data.
  8. Signed-off-by: Jack Zhu <[email protected]>
  9. ---
  10. .../admin-guide/media/starfive_camss.rst | 57 +++++++++++++++++++
  11. .../media/starfive_camss_graph.dot | 16 ++++++
  12. .../admin-guide/media/v4l-drivers.rst | 1 +
  13. 3 files changed, 74 insertions(+)
  14. create mode 100644 Documentation/admin-guide/media/starfive_camss.rst
  15. create mode 100644 Documentation/admin-guide/media/starfive_camss_graph.dot
  16. --- /dev/null
  17. +++ b/Documentation/admin-guide/media/starfive_camss.rst
  18. @@ -0,0 +1,57 @@
  19. +.. SPDX-License-Identifier: GPL-2.0
  20. +
  21. +.. include:: <isonum.txt>
  22. +
  23. +================================
  24. +Starfive Camera Subsystem driver
  25. +================================
  26. +
  27. +Introduction
  28. +------------
  29. +
  30. +This file documents the driver for the Starfive Camera Subsystem found on
  31. +Starfive JH7110 SoC. The driver is located under drivers/media/platform/
  32. +starfive.
  33. +
  34. +The driver implements V4L2, Media controller and v4l2_subdev interfaces.
  35. +Camera sensor using V4L2 subdev interface in the kernel is supported.
  36. +
  37. +The driver has been successfully used on the Gstreamer 1.18.5 with
  38. +v4l2src plugin.
  39. +
  40. +
  41. +Starfive Camera Subsystem hardware
  42. +----------------------------------
  43. +
  44. +The Starfive Camera Subsystem hardware consists of:
  45. +
  46. +- MIPI DPHY Receiver: receives mipi data from a MIPI camera sensor.
  47. +- MIPI CSIRx Controller: is responsible for handling and decoding CSI2 protocol
  48. + based camera sensor data stream.
  49. +- ISP: handles the image data streams from the MIPI CSIRx Controller.
  50. +- VIN(Video In): a top-level module, is responsible for controlling power
  51. + and clocks to other modules, dumps the input data to memory or transfers the
  52. + input data to ISP.
  53. +
  54. +
  55. +Topology
  56. +--------
  57. +
  58. +The media controller pipeline graph is as follows:
  59. +
  60. +.. _starfive_camss_graph:
  61. +
  62. +.. kernel-figure:: starfive_camss_graph.dot
  63. + :alt: starfive_camss_graph.dot
  64. + :align: center
  65. +
  66. +The driver has 2 video devices:
  67. +
  68. +- stf_vin0_wr_video0: capture device for images directly from the VIN module.
  69. +- stf_vin0_isp0_video1: capture device for images without scaling.
  70. +
  71. +The driver has 3 subdevices:
  72. +
  73. +- stf_isp0: is responsible for all the isp operations.
  74. +- stf_vin0_wr: used to dump RAW images to memory.
  75. +- stf_vin0_isp0: used to capture images for the stf_vin0_isp0_video1 device.
  76. --- /dev/null
  77. +++ b/Documentation/admin-guide/media/starfive_camss_graph.dot
  78. @@ -0,0 +1,16 @@
  79. +digraph board {
  80. + rankdir=TB
  81. + n00000001 [label="{{<port0> 0} | stf_isp0\n/dev/v4l-subdev0 | {<port1> 1}}", shape=Mrecord, style=filled, fillcolor=green]
  82. + n00000001:port1 -> n0000000d:port0
  83. + n00000004 [label="{{<port0> 0} | stf_vin0_wr\n/dev/v4l-subdev1 | {<port1> 1}}", shape=Mrecord, style=filled, fillcolor=green]
  84. + n00000004:port1 -> n00000007 [style=bold]
  85. + n00000007 [label="stf_vin0_wr_video0\n/dev/video0", shape=box, style=filled, fillcolor=yellow]
  86. + n0000000d [label="{{<port0> 0} | stf_vin0_isp0\n/dev/v4l-subdev2 | {<port1> 1}}", shape=Mrecord, style=filled, fillcolor=green]
  87. + n0000000d:port1 -> n00000010 [style=bold]
  88. + n00000010 [label="stf_vin0_isp0_video1\n/dev/video1", shape=box, style=filled, fillcolor=yellow]
  89. + n00000018 [label="{{<port0> 0} | cdns_csi2rx.19800000.csi-bridge\n | {<port1> 1 | <port2> 2 | <port3> 3 | <port4> 4}}", shape=Mrecord, style=filled, fillcolor=green]
  90. + n00000018:port1 -> n00000004:port0 [style=dashed]
  91. + n00000018:port1 -> n00000001:port0
  92. + n00000028 [label="{{} | imx219 6-0010\n | {<port0> 0}}", shape=Mrecord, style=filled, fillcolor=green]
  93. + n00000028:port0 -> n00000018:port0 [style=bold]
  94. +}
  95. --- a/Documentation/admin-guide/media/v4l-drivers.rst
  96. +++ b/Documentation/admin-guide/media/v4l-drivers.rst
  97. @@ -30,5 +30,6 @@ Video4Linux (V4L) driver-specific docume
  98. si470x
  99. si4713
  100. si476x
  101. + starfive_camss
  102. vimc
  103. vivid