From c0d0138255b37f362bb8559342cc0ac7da59b1be Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Sun, 17 Jul 2016 20:44:13 -0300 Subject: [PATCH] [media] doc-rst: add soc-camera documentation Convert it to ReST format and add it at media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab --- Documentation/media/v4l-drivers/index.rst | 1 + Documentation/media/v4l-drivers/si476x.rst | 12 ++++-- .../media/v4l-drivers/soc-camera.rst | 41 +++++++++++-------- 3 files changed, 32 insertions(+), 22 deletions(-) diff --git a/Documentation/media/v4l-drivers/index.rst b/Documentation/media/v4l-drivers/index.rst index 3ff127195fd3..a982d73abcb6 100644 --- a/Documentation/media/v4l-drivers/index.rst +++ b/Documentation/media/v4l-drivers/index.rst @@ -38,4 +38,5 @@ License". si470x si4713 si476x + soc-camera zr364xx diff --git a/Documentation/media/v4l-drivers/si476x.rst b/Documentation/media/v4l-drivers/si476x.rst index 01a8d44425aa..d5c07bb7524d 100644 --- a/Documentation/media/v4l-drivers/si476x.rst +++ b/Documentation/media/v4l-drivers/si476x.rst @@ -1,9 +1,13 @@ -SI476x Driver Readme ------------------------------------------------- - Copyright (C) 2013 Andrey Smirnov +.. include:: + + +The SI476x Driver +================= + +Copyright |copy| 2013 Andrey Smirnov TODO for the driver ------------------------------- +------------------- - According to the SiLabs' datasheet it is possible to update the firmware of the radio chip in the run-time, thus bringing it to the diff --git a/Documentation/media/v4l-drivers/soc-camera.rst b/Documentation/media/v4l-drivers/soc-camera.rst index 84f41cf1f3e8..ba0c15dd092c 100644 --- a/Documentation/media/v4l-drivers/soc-camera.rst +++ b/Documentation/media/v4l-drivers/soc-camera.rst @@ -1,5 +1,7 @@ - Soc-Camera Subsystem - ==================== +The Soc-Camera Drivers +====================== + +Author: Guennadi Liakhovetski Terminology ----------- @@ -45,10 +47,14 @@ Camera host API A host camera driver is registered using the -soc_camera_host_register(struct soc_camera_host *); +.. code-block:: none + + soc_camera_host_register(struct soc_camera_host *); function. The host object can be initialized as follows: +.. code-block:: none + struct soc_camera_host *ici; ici->drv_name = DRV_NAME; ici->ops = &camera_host_ops; @@ -58,18 +64,20 @@ function. The host object can be initialized as follows: All camera host methods are passed in a struct soc_camera_host_ops: -static struct soc_camera_host_ops camera_host_ops = { - .owner = THIS_MODULE, - .add = camera_add_device, - .remove = camera_remove_device, - .set_fmt = camera_set_fmt_cap, - .try_fmt = camera_try_fmt_cap, - .init_videobuf2 = camera_init_videobuf2, - .poll = camera_poll, - .querycap = camera_querycap, - .set_bus_param = camera_set_bus_param, - /* The rest of host operations are optional */ -}; +.. code-block:: none + + static struct soc_camera_host_ops camera_host_ops = { + .owner = THIS_MODULE, + .add = camera_add_device, + .remove = camera_remove_device, + .set_fmt = camera_set_fmt_cap, + .try_fmt = camera_try_fmt_cap, + .init_videobuf2 = camera_init_videobuf2, + .poll = camera_poll, + .querycap = camera_querycap, + .set_bus_param = camera_set_bus_param, + /* The rest of host operations are optional */ + }; .add and .remove methods are called when a sensor is attached to or detached from the host. .set_bus_param is used to configure physical connection @@ -159,6 +167,3 @@ configure camera drivers to produce the FOURCC format, requested by the user, using the VIDIOC_S_FMT ioctl(). Apart from those standard format conversions, host drivers can also provide their own conversion rules by implementing a .get_formats and, if required, a .put_formats methods. - --- -Author: Guennadi Liakhovetski