aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2017-04-16 20:51:08 -0400
committerJonathan Corbet <corbet@lwn.net>2017-04-20 17:31:07 -0400
commit9b06f754133c6b22c9753586c3c2708bc509ff64 (patch)
tree30350a7191e4878dd17566741a4ca3d826b05ebb
parent8a6a285d61fd0d602859c945892927ef87d26895 (diff)
convert philips.txt to ReST and add to media docs
The philips.txt file were at the wrong place: it should be, instead, at Documentation/media. Move and convert it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-rw-r--r--Documentation/media/v4l-drivers/index.rst1
-rw-r--r--Documentation/media/v4l-drivers/philips.rst (renamed from drivers/media/usb/pwc/philips.txt)21
2 files changed, 16 insertions, 6 deletions
diff --git a/Documentation/media/v4l-drivers/index.rst b/Documentation/media/v4l-drivers/index.rst
index a606d1cdac13..90fe22a6414a 100644
--- a/Documentation/media/v4l-drivers/index.rst
+++ b/Documentation/media/v4l-drivers/index.rst
@@ -45,6 +45,7 @@ For more details see the file COPYING in the source distribution of Linux.
45 meye 45 meye
46 omap3isp 46 omap3isp
47 omap4_camera 47 omap4_camera
48 philips
48 pvrusb2 49 pvrusb2
49 pxa_camera 50 pxa_camera
50 radiotrack 51 radiotrack
diff --git a/drivers/media/usb/pwc/philips.txt b/Documentation/media/v4l-drivers/philips.rst
index d38dd791511e..620bcfea7af0 100644
--- a/drivers/media/usb/pwc/philips.txt
+++ b/Documentation/media/v4l-drivers/philips.rst
@@ -1,8 +1,12 @@
1Philips webcams (pwc driver)
2============================
3
1This file contains some additional information for the Philips and OEM webcams. 4This file contains some additional information for the Philips and OEM webcams.
2E-mail: webcam@smcc.demon.nl Last updated: 2004-01-19 5E-mail: webcam@smcc.demon.nl Last updated: 2004-01-19
3Site: http://www.smcc.demon.nl/webcam/ 6Site: http://www.smcc.demon.nl/webcam/
4 7
5As of this moment, the following cameras are supported: 8As of this moment, the following cameras are supported:
9
6 * Philips PCA645 10 * Philips PCA645
7 * Philips PCA646 11 * Philips PCA646
8 * Philips PCVC675 12 * Philips PCVC675
@@ -89,7 +93,8 @@ power_save
89compression (only useful with the plugin) 93compression (only useful with the plugin)
90 With this option you can control the compression factor that the camera 94 With this option you can control the compression factor that the camera
91 uses to squeeze the image through the USB bus. You can set the 95 uses to squeeze the image through the USB bus. You can set the
92 parameter between 0 and 3: 96 parameter between 0 and 3::
97
93 0 = prefer uncompressed images; if the requested mode is not available 98 0 = prefer uncompressed images; if the requested mode is not available
94 in an uncompressed format, the driver will silently switch to low 99 in an uncompressed format, the driver will silently switch to low
95 compression. 100 compression.
@@ -109,11 +114,11 @@ compression (only useful with the plugin)
109leds 114leds
110 This settings takes 2 integers, that define the on/off time for the LED 115 This settings takes 2 integers, that define the on/off time for the LED
111 (in milliseconds). One of the interesting things that you can do with 116 (in milliseconds). One of the interesting things that you can do with
112 this is let the LED blink while the camera is in use. This: 117 this is let the LED blink while the camera is in use. This::
113 118
114 leds=500,500 119 leds=500,500
115 120
116 will blink the LED once every second. But with: 121 will blink the LED once every second. But with::
117 122
118 leds=0,0 123 leds=0,0
119 124
@@ -141,7 +146,7 @@ dev_hint
141 A camera is specified by its type (the number from the camera model, 146 A camera is specified by its type (the number from the camera model,
142 like PCA645, PCVC750VC, etc) and optionally the serial number (visible 147 like PCA645, PCVC750VC, etc) and optionally the serial number (visible
143 in /proc/bus/usb/devices). A hint consists of a string with the following 148 in /proc/bus/usb/devices). A hint consists of a string with the following
144 format: 149 format::
145 150
146 [type[.serialnumber]:]node 151 [type[.serialnumber]:]node
147 152
@@ -150,7 +155,7 @@ dev_hint
150 would be rather pointless). The serialnumber is separated from the type 155 would be rather pointless). The serialnumber is separated from the type
151 by a '.'; the node number by a ':'. 156 by a '.'; the node number by a ':'.
152 157
153 This somewhat cryptic syntax is best explained by a few examples: 158 This somewhat cryptic syntax is best explained by a few examples::
154 159
155 dev_hint=3,5 The first detected cam gets assigned 160 dev_hint=3,5 The first detected cam gets assigned
156 /dev/video3, the second /dev/video5. Any 161 /dev/video3, the second /dev/video5. Any
@@ -170,6 +175,7 @@ dev_hint
170 through /dev/video6. 175 through /dev/video6.
171 176
172 Some points worth knowing: 177 Some points worth knowing:
178
173 - Serialnumbers are case sensitive and must be written full, including 179 - Serialnumbers are case sensitive and must be written full, including
174 leading zeroes (it's treated as a string). 180 leading zeroes (it's treated as a string).
175 - If a device node is already occupied, registration will fail and 181 - If a device node is already occupied, registration will fail and
@@ -189,8 +195,10 @@ trace
189 If you want to trace something, look up the bit value(s) in the table 195 If you want to trace something, look up the bit value(s) in the table
190 below, add the values together and supply that to the trace variable. 196 below, add the values together and supply that to the trace variable.
191 197
198 ====== ======= ================================================ =======
192 Value Value Description Default 199 Value Value Description Default
193 (dec) (hex) 200 (dec) (hex)
201 ====== ======= ================================================ =======
194 1 0x1 Module initialization; this will log messages On 202 1 0x1 Module initialization; this will log messages On
195 while loading and unloading the module 203 while loading and unloading the module
196 204
@@ -208,6 +216,7 @@ trace
208 64 0x40 Show viewport and image sizes Off 216 64 0x40 Show viewport and image sizes Off
209 217
210 128 0x80 PWCX debugging Off 218 128 0x80 PWCX debugging Off
219 ====== ======= ================================================ =======
211 220
212 For example, to trace the open() & read() functions, sum 8 + 4 = 12, 221 For example, to trace the open() & read() functions, sum 8 + 4 = 12,
213 so you would supply trace=12 during insmod or modprobe. If 222 so you would supply trace=12 during insmod or modprobe. If
@@ -216,7 +225,7 @@ trace
216 225
217 226
218 227
219Example: 228Example::
220 229
221 # modprobe pwc size=cif fps=15 power_save=1 230 # modprobe pwc size=cif fps=15 power_save=1
222 231