1.. SPDX-License-Identifier: GPL-2.0
2
3.. include:: <isonum.txt>
4
5Vaio Picturebook Motion Eye Camera Driver
6=========================================
7
8Copyright |copy| 2001-2004 Stelian Pop <stelian@popies.net>
9
10Copyright |copy| 2001-2002 Alcôve <www.alcove.com>
11
12Copyright |copy| 2000 Andrew Tridgell <tridge@samba.org>
13
14This driver enable the use of video4linux compatible applications with the
15Motion Eye camera. This driver requires the "Sony Laptop Extras" driver (which
16can be found in the "Misc devices" section of the kernel configuration utility)
17to be compiled and installed (using its "camera=1" parameter).
18
19It can do at maximum 30 fps @ 320x240 or 15 fps @ 640x480.
20
21Grabbing is supported in packed YUV colorspace only.
22
23MJPEG hardware grabbing is supported via a private API (see below).
24
25Hardware supported
26------------------
27
28This driver supports the 'second' version of the MotionEye camera :)
29
30The first version was connected directly on the video bus of the Neomagic
31video card and is unsupported.
32
33The second one, made by Kawasaki Steel is fully supported by this
34driver (PCI vendor/device is 0x136b/0xff01)
35
36The third one, present in recent (more or less last year) Picturebooks
37(C1M* models), is not supported. The manufacturer has given the specs
38to the developers under a NDA (which allows the development of a GPL
39driver however), but things are not moving very fast (see
40http://r-engine.sourceforge.net/) (PCI vendor/device is 0x10cf/0x2011).
41
42There is a forth model connected on the USB bus in TR1* Vaio laptops.
43This camera is not supported at all by the current driver, in fact
44little information if any is available for this camera
45(USB vendor/device is 0x054c/0x0107).
46
47Driver options
48--------------
49
50Several options can be passed to the meye driver using the standard
51module argument syntax (<param>=<value> when passing the option to the
52module or meye.<param>=<value> on the kernel boot line when meye is
53statically linked into the kernel). Those options are:
54
55.. code-block:: none
56
57	gbuffers:	number of capture buffers, default is 2 (32 max)
58
59	gbufsize:	size of each capture buffer, default is 614400
60
61	video_nr:	video device to register (0 = /dev/video0, etc)
62
63Module use
64----------
65
66In order to automatically load the meye module on use, you can put those lines
67in your /etc/modprobe.d/meye.conf file:
68
69.. code-block:: none
70
71	alias char-major-81 videodev
72	alias char-major-81-0 meye
73	options meye gbuffers=32
74
75Usage:
76------
77
78.. code-block:: none
79
80	xawtv >= 3.49 (<http://bytesex.org/xawtv/>)
81		for display and uncompressed video capture:
82
83			xawtv -c /dev/video0 -geometry 640x480
84				or
85			xawtv -c /dev/video0 -geometry 320x240
86
87	motioneye (<http://popies.net/meye/>)
88		for getting ppm or jpg snapshots, mjpeg video
89
90Bugs / Todo
91-----------
92
93- 'motioneye' still uses the meye private v4l1 API extensions.
94