[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 <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2016-07-17 20:44:13 -03:00
parent f1668f1d13
commit c0d0138255
3 changed files with 32 additions and 22 deletions

View file

@ -38,4 +38,5 @@ License".
si470x si470x
si4713 si4713
si476x si476x
soc-camera
zr364xx zr364xx

View file

@ -1,9 +1,13 @@
SI476x Driver Readme .. include:: <isonum.txt>
------------------------------------------------
Copyright (C) 2013 Andrey Smirnov <andrew.smirnov@gmail.com>
The SI476x Driver
=================
Copyright |copy| 2013 Andrey Smirnov <andrew.smirnov@gmail.com>
TODO for the driver TODO for the driver
------------------------------ -------------------
- According to the SiLabs' datasheet it is possible to update the - 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 firmware of the radio chip in the run-time, thus bringing it to the

View file

@ -1,5 +1,7 @@
Soc-Camera Subsystem The Soc-Camera Drivers
==================== ======================
Author: Guennadi Liakhovetski <g.liakhovetski@gmx.de>
Terminology Terminology
----------- -----------
@ -45,10 +47,14 @@ Camera host API
A host camera driver is registered using the 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: function. The host object can be initialized as follows:
.. code-block:: none
struct soc_camera_host *ici; struct soc_camera_host *ici;
ici->drv_name = DRV_NAME; ici->drv_name = DRV_NAME;
ici->ops = &camera_host_ops; ici->ops = &camera_host_ops;
@ -58,7 +64,9 @@ function. The host object can be initialized as follows:
All camera host methods are passed in a struct soc_camera_host_ops: All camera host methods are passed in a struct soc_camera_host_ops:
static struct soc_camera_host_ops camera_host_ops = { .. code-block:: none
static struct soc_camera_host_ops camera_host_ops = {
.owner = THIS_MODULE, .owner = THIS_MODULE,
.add = camera_add_device, .add = camera_add_device,
.remove = camera_remove_device, .remove = camera_remove_device,
@ -69,7 +77,7 @@ static struct soc_camera_host_ops camera_host_ops = {
.querycap = camera_querycap, .querycap = camera_querycap,
.set_bus_param = camera_set_bus_param, .set_bus_param = camera_set_bus_param,
/* The rest of host operations are optional */ /* The rest of host operations are optional */
}; };
.add and .remove methods are called when a sensor is attached to or detached .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 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, using the VIDIOC_S_FMT ioctl(). Apart from those standard format conversions,
host drivers can also provide their own conversion rules by implementing a host drivers can also provide their own conversion rules by implementing a
.get_formats and, if required, a .put_formats methods. .get_formats and, if required, a .put_formats methods.
--
Author: Guennadi Liakhovetski <g.liakhovetski@gmx.de>