1TODO
2====
3
41. Items which MUST be fixed before the driver can be moved out of staging:
5
6* Remove/disable private IOCTLs
7
8* Remove/disable custom v4l2-ctrls
9
10* Remove custom sysfs files created by atomisp_drvfs.c
11
12* Remove unnecessary/unwanted module parameters
13
14* Remove abuse of priv field in various v4l2 userspace API structs
15
16* Without a 3A library the capture behaviour is not very good. To take a good
17  picture, the exposure/gain needs to be tuned using v4l2-ctl on the sensor
18  subdev. To fix this, support for the atomisp needs to be added to libcamera.
19
20  This MUST be done before moving the driver out of staging so that we can
21  still make changes to e.g. the mediactl topology if necessary for
22  libcamera integration. Since this would be a userspace API break, this
23  means that at least proof-of-concept libcamera integration needs to be
24  ready before moving the driver out of staging.
25
26
272. Items which SHOULD also be fixed eventually:
28
29* The driver is intended to drive the PCI exposed versions of the device.
30  It will not detect those devices enumerated via ACPI as a field of the
31  i915 GPU driver (only a problem on BYT).
32
33  There are some patches adding i915 GPU support floating at the Yocto's
34  Aero repository (so far, untested upstream).
35
36* Ensure that the driver will pass v4l2-compliance tests
37
38* Fix not all v4l2 apps working, e.g. cheese does not work
39
40* The atomisp code still has a lot of cruft which needs cleaning up
41
42
43Testing
44=======
45
46Since libcamera support is not available yet, the easiest way to test for
47now is using v4l2-ctl to select the input and gstreamer for streaming.
48
49To select the input run:
50
51v4l2-ctl -i <input>
52
53Where <input> is 0 (front cam) or 1 (back cam).
54
55The simplest gstreamer pipeline for testing running the sensor
56at its max resolution is:
57
58gst-launch-1.0 v4l2src ! videoconvert ! xvimagesink sync=false
59
60To select e.g 640x480 as resolution use:
61
62gst-launch-1.0 v4l2src ! video/x-raw,format=YV12,width=640,height=480 ! \
63               videoconvert ! xvimagesink sync=false
64
65And to show fps use:
66
67gst-launch-1.0 v4l2src ! video/x-raw,format=YV12,width=640,height=480 ! \
68               videoconvert ! fpsdisplaysink video-sink=xvimagesink sync=false
69
70Often the image will be over / under exposed. This can be fixed by using
71v4l2-ctl on the sensor subdev to tweak the exposure ctrl; or by using a GUI
72app for v4l2-controls which also supports subdev such as the Fedora patched
73gtk-v4l tool.
74