mbox series

[0/2] Small link frequency and pixel rate documentation improvements

Message ID 20201013142751.26228-1-sakari.ailus@linux.intel.com
Headers show
Series Small link frequency and pixel rate documentation improvements | expand

Message

Sakari Ailus Oct. 13, 2020, 2:27 p.m. UTC 
Hi all,

This small set improve documentation on required controls for parallel and
CSI-2 camera sensor drivers.

Sakari Ailus (2):
  Documentation: v4l: Fix language
  Documentation: v4l: Document required controls on camera sensors

 Documentation/driver-api/media/camera-sensor.rst | 13 +++++++++++++
 Documentation/driver-api/media/csi2.rst          |  7 +++----
 2 files changed, 16 insertions(+), 4 deletions(-)

Comments

Laurent Pinchart Oct. 13, 2020, 8:40 p.m. UTC | #1 
Hi Sakari,

Thank you for the patch.

On Tue, Oct 13, 2020 at 05:27:50PM +0300, Sakari Ailus wrote:
> Remove extra "is" from sentence explaining V4L2_CID_PIXEL_RATE may be used

> to tell the pixel rate used by a transmitter driver. Also call

> V4L2_CID_PIXEL_RATE a control.

> 

> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>


Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>


> ---

>  Documentation/driver-api/media/csi2.rst | 7 +++----

>  1 file changed, 3 insertions(+), 4 deletions(-)

> 

> diff --git a/Documentation/driver-api/media/csi2.rst b/Documentation/driver-api/media/csi2.rst

> index e1b838014906..e3bbc6baf0f0 100644

> --- a/Documentation/driver-api/media/csi2.rst

> +++ b/Documentation/driver-api/media/csi2.rst

> @@ -28,10 +28,9 @@ interface elements must be present on the sub-device represents the

>  CSI-2 transmitter.

>  

>  The V4L2_CID_LINK_FREQ control is used to tell the receiver driver the

> -frequency (and not the symbol rate) of the link. The

> -V4L2_CID_PIXEL_RATE is may be used by the receiver to obtain the pixel

> -rate the transmitter uses. The

> -:c:type:`v4l2_subdev_video_ops`->s_stream() callback provides an

> +frequency (and not the symbol rate) of the link. The V4L2_CID_PIXEL_RATE

> +control may be used by the receiver to obtain the pixel rate the transmitter

> +uses. The :c:type:`v4l2_subdev_video_ops`->s_stream() callback provides an

>  ability to start and stop the stream.

>  

>  The value of the V4L2_CID_PIXEL_RATE is calculated as follows::


-- 
Regards,

Laurent Pinchart