[media] doc-rst: add soc-camera documentation
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Sun, 17 Jul 2016 23:44:13 +0000 (20:44 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 18 Jul 2016 01:51:25 +0000 (22:51 -0300)
Convert it to ReST format and add it at media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Documentation/media/v4l-drivers/index.rst
Documentation/media/v4l-drivers/si476x.rst
Documentation/media/v4l-drivers/soc-camera.rst

index 3ff127195fd3243d34be481fc9debe69af56ebca..a982d73abcb63e0cfc357eca965c8d0f305568e7 100644 (file)
@@ -38,4 +38,5 @@ License".
        si470x
        si4713
        si476x
+       soc-camera
        zr364xx
index 01a8d44425aa1c4b993fad750e4da0ca0c082420..d5c07bb7524d6c67cdb178c7a9dcda2377e85188 100644 (file)
@@ -1,9 +1,13 @@
-SI476x Driver Readme
-------------------------------------------------
-       Copyright (C) 2013 Andrey Smirnov <andrew.smirnov@gmail.com>
+.. include:: <isonum.txt>
+
+
+The SI476x Driver
+=================
+
+Copyright |copy| 2013 Andrey Smirnov <andrew.smirnov@gmail.com>
 
 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
index 84f41cf1f3e8a71548ac109f94bfb6026b0debac..ba0c15dd092cc7c758dddb7f2f6da808df48a2df 100644 (file)
@@ -1,5 +1,7 @@
-                       Soc-Camera Subsystem
-                       ====================
+The Soc-Camera Drivers
+======================
+
+Author: Guennadi Liakhovetski <g.liakhovetski@gmx.de>
 
 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 <g.liakhovetski@gmx.de>