diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-17 19:44:13 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-17 21:51:25 -0400 |
commit | c0d0138255b37f362bb8559342cc0ac7da59b1be (patch) | |
tree | c10489e443480c1e4094c1b27b484b601adcaf40 | |
parent | f1668f1d132ad08e3cccd10f34cfbe8434ffe81d (diff) |
[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>
-rw-r--r-- | Documentation/media/v4l-drivers/index.rst | 1 | ||||
-rw-r--r-- | Documentation/media/v4l-drivers/si476x.rst | 12 | ||||
-rw-r--r-- | Documentation/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". | |||
38 | si470x | 38 | si470x |
39 | si4713 | 39 | si4713 |
40 | si476x | 40 | si476x |
41 | soc-camera | ||
41 | zr364xx | 42 | 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 @@ | |||
1 | SI476x Driver Readme | 1 | .. include:: <isonum.txt> |
2 | ------------------------------------------------ | 2 | |
3 | Copyright (C) 2013 Andrey Smirnov <andrew.smirnov@gmail.com> | 3 | |
4 | The SI476x Driver | ||
5 | ================= | ||
6 | |||
7 | Copyright |copy| 2013 Andrey Smirnov <andrew.smirnov@gmail.com> | ||
4 | 8 | ||
5 | TODO for the driver | 9 | TODO for the driver |
6 | ------------------------------ | 10 | ------------------- |
7 | 11 | ||
8 | - According to the SiLabs' datasheet it is possible to update the | 12 | - According to the SiLabs' datasheet it is possible to update the |
9 | firmware of the radio chip in the run-time, thus bringing it to the | 13 | 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 @@ | |||
1 | Soc-Camera Subsystem | 1 | The Soc-Camera Drivers |
2 | ==================== | 2 | ====================== |
3 | |||
4 | Author: Guennadi Liakhovetski <g.liakhovetski@gmx.de> | ||
3 | 5 | ||
4 | Terminology | 6 | Terminology |
5 | ----------- | 7 | ----------- |
@@ -45,10 +47,14 @@ Camera host API | |||
45 | 47 | ||
46 | A host camera driver is registered using the | 48 | A host camera driver is registered using the |
47 | 49 | ||
48 | soc_camera_host_register(struct soc_camera_host *); | 50 | .. code-block:: none |
51 | |||
52 | soc_camera_host_register(struct soc_camera_host *); | ||
49 | 53 | ||
50 | function. The host object can be initialized as follows: | 54 | function. The host object can be initialized as follows: |
51 | 55 | ||
56 | .. code-block:: none | ||
57 | |||
52 | struct soc_camera_host *ici; | 58 | struct soc_camera_host *ici; |
53 | ici->drv_name = DRV_NAME; | 59 | ici->drv_name = DRV_NAME; |
54 | ici->ops = &camera_host_ops; | 60 | ici->ops = &camera_host_ops; |
@@ -58,18 +64,20 @@ function. The host object can be initialized as follows: | |||
58 | 64 | ||
59 | All camera host methods are passed in a struct soc_camera_host_ops: | 65 | All camera host methods are passed in a struct soc_camera_host_ops: |
60 | 66 | ||
61 | static struct soc_camera_host_ops camera_host_ops = { | 67 | .. code-block:: none |
62 | .owner = THIS_MODULE, | 68 | |
63 | .add = camera_add_device, | 69 | static struct soc_camera_host_ops camera_host_ops = { |
64 | .remove = camera_remove_device, | 70 | .owner = THIS_MODULE, |
65 | .set_fmt = camera_set_fmt_cap, | 71 | .add = camera_add_device, |
66 | .try_fmt = camera_try_fmt_cap, | 72 | .remove = camera_remove_device, |
67 | .init_videobuf2 = camera_init_videobuf2, | 73 | .set_fmt = camera_set_fmt_cap, |
68 | .poll = camera_poll, | 74 | .try_fmt = camera_try_fmt_cap, |
69 | .querycap = camera_querycap, | 75 | .init_videobuf2 = camera_init_videobuf2, |
70 | .set_bus_param = camera_set_bus_param, | 76 | .poll = camera_poll, |
71 | /* The rest of host operations are optional */ | 77 | .querycap = camera_querycap, |
72 | }; | 78 | .set_bus_param = camera_set_bus_param, |
79 | /* The rest of host operations are optional */ | ||
80 | }; | ||
73 | 81 | ||
74 | .add and .remove methods are called when a sensor is attached to or detached | 82 | .add and .remove methods are called when a sensor is attached to or detached |
75 | from the host. .set_bus_param is used to configure physical connection | 83 | 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, | |||
159 | using the VIDIOC_S_FMT ioctl(). Apart from those standard format conversions, | 167 | using the VIDIOC_S_FMT ioctl(). Apart from those standard format conversions, |
160 | host drivers can also provide their own conversion rules by implementing a | 168 | host drivers can also provide their own conversion rules by implementing a |
161 | .get_formats and, if required, a .put_formats methods. | 169 | .get_formats and, if required, a .put_formats methods. |
162 | |||
163 | -- | ||
164 | Author: Guennadi Liakhovetski <g.liakhovetski@gmx.de> | ||