[media] feature-removal: update V4L1 removal status
[linux-2.6.git] / Documentation / feature-removal-schedule.txt
1 The following is a list of files and features that are going to be
2 removed in the kernel source tree.  Every entry should contain what
3 exactly is going away, why it is happening, and who is going to be doing
4 the work.  When the feature is removed from the kernel, it should also
5 be removed from this file.
6
7 ---------------------------
8
9 What:   PRISM54
10 When:   2.6.34
11
12 Why:    prism54 FullMAC PCI / Cardbus devices used to be supported only by the
13         prism54 wireless driver. After Intersil stopped selling these
14         devices in preference for the newer more flexible SoftMAC devices
15         a SoftMAC device driver was required and prism54 did not support
16         them. The p54pci driver now exists and has been present in the kernel for
17         a while. This driver supports both SoftMAC devices and FullMAC devices.
18         The main difference between these devices was the amount of memory which
19         could be used for the firmware. The SoftMAC devices support a smaller
20         amount of memory. Because of this the SoftMAC firmware fits into FullMAC
21         devices's memory. p54pci supports not only PCI / Cardbus but also USB
22         and SPI. Since p54pci supports all devices prism54 supports
23         you will have a conflict. I'm not quite sure how distributions are
24         handling this conflict right now. prism54 was kept around due to
25         claims users may experience issues when using the SoftMAC driver.
26         Time has passed users have not reported issues. If you use prism54
27         and for whatever reason you cannot use p54pci please let us know!
28         E-mail us at: linux-wireless@vger.kernel.org
29
30         For more information see the p54 wiki page:
31
32         http://wireless.kernel.org/en/users/Drivers/p54
33
34 Who:    Luis R. Rodriguez <lrodriguez@atheros.com>
35
36 ---------------------------
37
38 What:   IRQF_SAMPLE_RANDOM
39 Check:  IRQF_SAMPLE_RANDOM
40 When:   July 2009
41
42 Why:    Many of IRQF_SAMPLE_RANDOM users are technically bogus as entropy
43         sources in the kernel's current entropy model. To resolve this, every
44         input point to the kernel's entropy pool needs to better document the
45         type of entropy source it actually is. This will be replaced with
46         additional add_*_randomness functions in drivers/char/random.c
47
48 Who:    Robin Getz <rgetz@blackfin.uclinux.org> & Matt Mackall <mpm@selenic.com>
49
50 ---------------------------
51
52 What:   Deprecated snapshot ioctls
53 When:   2.6.36
54
55 Why:    The ioctls in kernel/power/user.c were marked as deprecated long time
56         ago. Now they notify users about that so that they need to replace
57         their userspace. After some more time, remove them completely.
58
59 Who:    Jiri Slaby <jirislaby@gmail.com>
60
61 ---------------------------
62
63 What:   The ieee80211_regdom module parameter
64 When:   March 2010 / desktop catchup
65
66 Why:    This was inherited by the CONFIG_WIRELESS_OLD_REGULATORY code,
67         and currently serves as an option for users to define an
68         ISO / IEC 3166 alpha2 code for the country they are currently
69         present in. Although there are userspace API replacements for this
70         through nl80211 distributions haven't yet caught up with implementing
71         decent alternatives through standard GUIs. Although available as an
72         option through iw or wpa_supplicant its just a matter of time before
73         distributions pick up good GUI options for this. The ideal solution
74         would actually consist of intelligent designs which would do this for
75         the user automatically even when travelling through different countries.
76         Until then we leave this module parameter as a compromise.
77
78         When userspace improves with reasonable widely-available alternatives for
79         this we will no longer need this module parameter. This entry hopes that
80         by the super-futuristically looking date of "March 2010" we will have
81         such replacements widely available.
82
83 Who:    Luis R. Rodriguez <lrodriguez@atheros.com>
84
85 ---------------------------
86
87 What:   dev->power.power_state
88 When:   July 2007
89 Why:    Broken design for runtime control over driver power states, confusing
90         driver-internal runtime power management with:  mechanisms to support
91         system-wide sleep state transitions; event codes that distinguish
92         different phases of swsusp "sleep" transitions; and userspace policy
93         inputs.  This framework was never widely used, and most attempts to
94         use it were broken.  Drivers should instead be exposing domain-specific
95         interfaces either to kernel or to userspace.
96 Who:    Pavel Machek <pavel@ucw.cz>
97
98 ---------------------------
99
100 What:   Video4Linux API 1 ioctls and from Video devices.
101 When:   kernel 2.6.39
102 Files:  include/linux/videodev.h
103 Check:  include/linux/videodev.h
104 Why:    V4L1 AP1 was replaced by V4L2 API during migration from 2.4 to 2.6
105         series. The old API have lots of drawbacks and don't provide enough
106         means to work with all video and audio standards. The newer API is
107         already available on the main drivers and should be used instead.
108
109         The userspace libv4l1 library can convert V4L1 calls to V4L2. This
110         replaces the kernel V4L1 compatibility module which was removed in
111         2.6.38. The last V4L1 drivers will either be converted to V4L2 or
112         removed for 2.6.39 at which point the V4L1 API will cease to exist.
113 Who:    Mauro Carvalho Chehab <mchehab@infradead.org>
114
115 ---------------------------
116
117 What:   Video4Linux obsolete drivers using V4L1 API
118 When:   kernel 2.6.39
119 Files:  drivers/staging/se401/* drivers/staging/usbvideo/*
120 Check:  drivers/staging/se401/se401.c drivers/staging/usbvideo/usbvideo.c
121 Why:    There are some drivers still using V4L1 API, despite all efforts we've done
122         to migrate. Those drivers are for obsolete hardware that the old maintainer
123         didn't care (or not have the hardware anymore), and that no other developer
124         could find any hardware to buy. They probably have no practical usage today,
125         and people with such old hardware could probably keep using an older version
126         of the kernel. Those drivers will be moved to staging on 2.6.38 and, if nobody
127         cares enough to port and test them with V4L2 API, they'll be removed on 2.6.39.
128 Who:    Mauro Carvalho Chehab <mchehab@infradead.org>
129
130 ---------------------------
131
132 What:   sys_sysctl
133 When:   September 2010
134 Option: CONFIG_SYSCTL_SYSCALL
135 Why:    The same information is available in a more convenient from
136         /proc/sys, and none of the sysctl variables appear to be
137         important performance wise.
138
139         Binary sysctls are a long standing source of subtle kernel
140         bugs and security issues.
141
142         When I looked several months ago all I could find after
143         searching several distributions were 5 user space programs and
144         glibc (which falls back to /proc/sys) using this syscall.
145
146         The man page for sysctl(2) documents it as unusable for user
147         space programs.
148
149         sysctl(2) is not generally ABI compatible to a 32bit user
150         space application on a 64bit and a 32bit kernel.
151
152         For the last several months the policy has been no new binary
153         sysctls and no one has put forward an argument to use them.
154
155         Binary sysctls issues seem to keep happening appearing so
156         properly deprecating them (with a warning to user space) and a
157         2 year grace warning period will mean eventually we can kill
158         them and end the pain.
159
160         In the mean time individual binary sysctls can be dealt with
161         in a piecewise fashion.
162
163 Who:    Eric Biederman <ebiederm@xmission.com>
164
165 ---------------------------
166
167 What:   /proc/<pid>/oom_adj
168 When:   August 2012
169 Why:    /proc/<pid>/oom_adj allows userspace to influence the oom killer's
170         badness heuristic used to determine which task to kill when the kernel
171         is out of memory.
172
173         The badness heuristic has since been rewritten since the introduction of
174         this tunable such that its meaning is deprecated.  The value was
175         implemented as a bitshift on a score generated by the badness()
176         function that did not have any precise units of measure.  With the
177         rewrite, the score is given as a proportion of available memory to the
178         task allocating pages, so using a bitshift which grows the score
179         exponentially is, thus, impossible to tune with fine granularity.
180
181         A much more powerful interface, /proc/<pid>/oom_score_adj, was
182         introduced with the oom killer rewrite that allows users to increase or
183         decrease the badness() score linearly.  This interface will replace
184         /proc/<pid>/oom_adj.
185
186         A warning will be emitted to the kernel log if an application uses this
187         deprecated interface.  After it is printed once, future warnings will be
188         suppressed until the kernel is rebooted.
189
190 ---------------------------
191
192 What:   remove EXPORT_SYMBOL(kernel_thread)
193 When:   August 2006
194 Files:  arch/*/kernel/*_ksyms.c
195 Check:  kernel_thread
196 Why:    kernel_thread is a low-level implementation detail.  Drivers should
197         use the <linux/kthread.h> API instead which shields them from
198         implementation details and provides a higherlevel interface that
199         prevents bugs and code duplication
200 Who:    Christoph Hellwig <hch@lst.de>
201
202 ---------------------------
203
204 What:   Unused EXPORT_SYMBOL/EXPORT_SYMBOL_GPL exports
205         (temporary transition config option provided until then)
206         The transition config option will also be removed at the same time.
207 When:   before 2.6.19
208 Why:    Unused symbols are both increasing the size of the kernel binary
209         and are often a sign of "wrong API"
210 Who:    Arjan van de Ven <arjan@linux.intel.com>
211
212 ---------------------------
213
214 What:   PHYSDEVPATH, PHYSDEVBUS, PHYSDEVDRIVER in the uevent environment
215 When:   October 2008
216 Why:    The stacking of class devices makes these values misleading and
217         inconsistent.
218         Class devices should not carry any of these properties, and bus
219         devices have SUBSYTEM and DRIVER as a replacement.
220 Who:    Kay Sievers <kay.sievers@suse.de>
221
222 ---------------------------
223
224 What:   ACPI procfs interface
225 When:   July 2008
226 Why:    ACPI sysfs conversion should be finished by January 2008.
227         ACPI procfs interface will be removed in July 2008 so that
228         there is enough time for the user space to catch up.
229 Who:    Zhang Rui <rui.zhang@intel.com>
230
231 ---------------------------
232
233 What:   /proc/acpi/button
234 When:   August 2007
235 Why:    /proc/acpi/button has been replaced by events to the input layer
236         since 2.6.20.
237 Who:    Len Brown <len.brown@intel.com>
238
239 ---------------------------
240
241 What:   /proc/acpi/event
242 When:   February 2008
243 Why:    /proc/acpi/event has been replaced by events via the input layer
244         and netlink since 2.6.23.
245 Who:    Len Brown <len.brown@intel.com>
246
247 ---------------------------
248
249 What:   i386/x86_64 bzImage symlinks
250 When:   April 2010
251
252 Why:    The i386/x86_64 merge provides a symlink to the old bzImage
253         location so not yet updated user space tools, e.g. package
254         scripts, do not break.
255 Who:    Thomas Gleixner <tglx@linutronix.de>
256
257 ---------------------------
258
259 What:   GPIO autorequest on gpio_direction_{input,output}() in gpiolib
260 When:   February 2010
261 Why:    All callers should use explicit gpio_request()/gpio_free().
262         The autorequest mechanism in gpiolib was provided mostly as a
263         migration aid for legacy GPIO interfaces (for SOC based GPIOs).
264         Those users have now largely migrated.  Platforms implementing
265         the GPIO interfaces without using gpiolib will see no changes.
266 Who:    David Brownell <dbrownell@users.sourceforge.net>
267 ---------------------------
268
269 What:   b43 support for firmware revision < 410
270 When:   The schedule was July 2008, but it was decided that we are going to keep the
271         code as long as there are no major maintanance headaches.
272         So it _could_ be removed _any_ time now, if it conflicts with something new.
273 Why:    The support code for the old firmware hurts code readability/maintainability
274         and slightly hurts runtime performance. Bugfixes for the old firmware
275         are not provided by Broadcom anymore.
276 Who:    Michael Buesch <mb@bu3sch.de>
277
278 ---------------------------
279
280 What:   /sys/o2cb symlink
281 When:   January 2010
282 Why:    /sys/fs/o2cb is the proper location for this information - /sys/o2cb
283         exists as a symlink for backwards compatibility for old versions of
284         ocfs2-tools. 2 years should be sufficient time to phase in new versions
285         which know to look in /sys/fs/o2cb.
286 Who:    ocfs2-devel@oss.oracle.com
287
288 ---------------------------
289
290 What:   Ability for non root users to shm_get hugetlb pages based on mlock
291         resource limits
292 When:   2.6.31
293 Why:    Non root users need to be part of /proc/sys/vm/hugetlb_shm_group or
294         have CAP_IPC_LOCK to be able to allocate shm segments backed by
295         huge pages.  The mlock based rlimit check to allow shm hugetlb is
296         inconsistent with mmap based allocations.  Hence it is being
297         deprecated.
298 Who:    Ravikiran Thirumalai <kiran@scalex86.org>
299
300 ---------------------------
301
302 What:   CONFIG_THERMAL_HWMON
303 When:   January 2009
304 Why:    This option was introduced just to allow older lm-sensors userspace
305         to keep working over the upgrade to 2.6.26. At the scheduled time of
306         removal fixed lm-sensors (2.x or 3.x) should be readily available.
307 Who:    Rene Herman <rene.herman@gmail.com>
308
309 ---------------------------
310
311 What:   Code that is now under CONFIG_WIRELESS_EXT_SYSFS
312         (in net/core/net-sysfs.c)
313 When:   After the only user (hal) has seen a release with the patches
314         for enough time, probably some time in 2010.
315 Why:    Over 1K .text/.data size reduction, data is available in other
316         ways (ioctls)
317 Who:    Johannes Berg <johannes@sipsolutions.net>
318
319 ---------------------------
320
321 What:   sysfs ui for changing p4-clockmod parameters
322 When:   September 2009
323 Why:    See commits 129f8ae9b1b5be94517da76009ea956e89104ce8 and
324         e088e4c9cdb618675874becb91b2fd581ee707e6.
325         Removal is subject to fixing any remaining bugs in ACPI which may
326         cause the thermal throttling not to happen at the right time.
327 Who:    Dave Jones <davej@redhat.com>, Matthew Garrett <mjg@redhat.com>
328
329 -----------------------------
330
331 What:   __do_IRQ all in one fits nothing interrupt handler
332 When:   2.6.32
333 Why:    __do_IRQ was kept for easy migration to the type flow handlers.
334         More than two years of migration time is enough.
335 Who:    Thomas Gleixner <tglx@linutronix.de>
336
337 -----------------------------
338
339 What:   fakephp and associated sysfs files in /sys/bus/pci/slots/
340 When:   2011
341 Why:    In 2.6.27, the semantics of /sys/bus/pci/slots was redefined to
342         represent a machine's physical PCI slots. The change in semantics
343         had userspace implications, as the hotplug core no longer allowed
344         drivers to create multiple sysfs files per physical slot (required
345         for multi-function devices, e.g.). fakephp was seen as a developer's
346         tool only, and its interface changed. Too late, we learned that
347         there were some users of the fakephp interface.
348
349         In 2.6.30, the original fakephp interface was restored. At the same
350         time, the PCI core gained the ability that fakephp provided, namely
351         function-level hot-remove and hot-add.
352
353         Since the PCI core now provides the same functionality, exposed in:
354
355                 /sys/bus/pci/rescan
356                 /sys/bus/pci/devices/.../remove
357                 /sys/bus/pci/devices/.../rescan
358
359         there is no functional reason to maintain fakephp as well.
360
361         We will keep the existing module so that 'modprobe fakephp' will
362         present the old /sys/bus/pci/slots/... interface for compatibility,
363         but users are urged to migrate their applications to the API above.
364
365         After a reasonable transition period, we will remove the legacy
366         fakephp interface.
367 Who:    Alex Chiang <achiang@hp.com>
368
369 ---------------------------
370
371 What:   CONFIG_RFKILL_INPUT
372 When:   2.6.33
373 Why:    Should be implemented in userspace, policy daemon.
374 Who:    Johannes Berg <johannes@sipsolutions.net>
375
376 ----------------------------
377
378 What:   sound-slot/service-* module aliases and related clutters in
379         sound/sound_core.c
380 When:   August 2010
381 Why:    OSS sound_core grabs all legacy minors (0-255) of SOUND_MAJOR
382         (14) and requests modules using custom sound-slot/service-*
383         module aliases.  The only benefit of doing this is allowing
384         use of custom module aliases which might as well be considered
385         a bug at this point.  This preemptive claiming prevents
386         alternative OSS implementations.
387
388         Till the feature is removed, the kernel will be requesting
389         both sound-slot/service-* and the standard char-major-* module
390         aliases and allow turning off the pre-claiming selectively via
391         CONFIG_SOUND_OSS_CORE_PRECLAIM and soundcore.preclaim_oss
392         kernel parameter.
393
394         After the transition phase is complete, both the custom module
395         aliases and switches to disable it will go away.  This removal
396         will also allow making ALSA OSS emulation independent of
397         sound_core.  The dependency will be broken then too.
398 Who:    Tejun Heo <tj@kernel.org>
399
400 ----------------------------
401
402 What:   Support for lcd_switch and display_get in asus-laptop driver
403 When:   March 2010
404 Why:    These two features use non-standard interfaces. There are the
405         only features that really need multiple path to guess what's
406         the right method name on a specific laptop.
407
408         Removing them will allow to remove a lot of code an significantly
409         clean the drivers.
410
411         This will affect the backlight code which won't be able to know
412         if the backlight is on or off. The platform display file will also be
413         write only (like the one in eeepc-laptop).
414
415         This should'nt affect a lot of user because they usually know
416         when their display is on or off.
417
418 Who:    Corentin Chary <corentin.chary@gmail.com>
419
420 ----------------------------
421
422 What:   sysfs-class-rfkill state file
423 When:   Feb 2014
424 Files:  net/rfkill/core.c
425 Why:    Documented as obsolete since Feb 2010. This file is limited to 3
426         states while the rfkill drivers can have 4 states.
427 Who:    anybody or Florian Mickler <florian@mickler.org>
428
429 ----------------------------
430
431 What:   sysfs-class-rfkill claim file
432 When:   Feb 2012
433 Files:  net/rfkill/core.c
434 Why:    It is not possible to claim an rfkill driver since 2007. This is
435         Documented as obsolete since Feb 2010.
436 Who:    anybody or Florian Mickler <florian@mickler.org>
437
438 ----------------------------
439
440 What:   capifs
441 When:   February 2011
442 Files:  drivers/isdn/capi/capifs.*
443 Why:    udev fully replaces this special file system that only contains CAPI
444         NCCI TTY device nodes. User space (pppdcapiplugin) works without
445         noticing the difference.
446 Who:    Jan Kiszka <jan.kiszka@web.de>
447
448 ----------------------------
449
450 What:   KVM paravirt mmu host support
451 When:   January 2011
452 Why:    The paravirt mmu host support is slower than non-paravirt mmu, both
453         on newer and older hardware.  It is already not exposed to the guest,
454         and kept only for live migration purposes.
455 Who:    Avi Kivity <avi@redhat.com>
456
457 ----------------------------
458
459 What:   iwlwifi 50XX module parameters
460 When:   2.6.40
461 Why:    The "..50" modules parameters were used to configure 5000 series and
462         up devices; different set of module parameters also available for 4965
463         with same functionalities. Consolidate both set into single place
464         in drivers/net/wireless/iwlwifi/iwl-agn.c
465
466 Who:    Wey-Yi Guy <wey-yi.w.guy@intel.com>
467
468 ----------------------------
469
470 What:   iwl4965 alias support
471 When:   2.6.40
472 Why:    Internal alias support has been present in module-init-tools for some
473         time, the MODULE_ALIAS("iwl4965") boilerplate aliases can be removed
474         with no impact.
475
476 Who:    Wey-Yi Guy <wey-yi.w.guy@intel.com>
477
478 ---------------------------
479
480 What:   xt_NOTRACK
481 Files:  net/netfilter/xt_NOTRACK.c
482 When:   April 2011
483 Why:    Superseded by xt_CT
484 Who:    Netfilter developer team <netfilter-devel@vger.kernel.org>
485
486 ----------------------------
487
488 What:   IRQF_DISABLED
489 When:   2.6.36
490 Why:    The flag is a NOOP as we run interrupt handlers with interrupts disabled
491 Who:    Thomas Gleixner <tglx@linutronix.de>
492
493 ----------------------------
494
495 What:   The acpi_sleep=s4_nonvs command line option
496 When:   2.6.37
497 Files:  arch/x86/kernel/acpi/sleep.c
498 Why:    superseded by acpi_sleep=nonvs
499 Who:    Rafael J. Wysocki <rjw@sisk.pl>
500
501 ----------------------------
502
503 What:   PCI DMA unmap state API
504 When:   August 2012
505 Why:    PCI DMA unmap state API (include/linux/pci-dma.h) was replaced
506         with DMA unmap state API (DMA unmap state API can be used for
507         any bus).
508 Who:    FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
509
510 ----------------------------
511
512 What:   DMA_xxBIT_MASK macros
513 When:   Jun 2011
514 Why:    DMA_xxBIT_MASK macros were replaced with DMA_BIT_MASK() macros.
515 Who:    FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
516
517 ----------------------------
518
519 What:   namespace cgroup (ns_cgroup)
520 When:   2.6.38
521 Why:    The ns_cgroup leads to some problems:
522         * cgroup creation is out-of-control
523         * cgroup name can conflict when pids are looping
524         * it is not possible to have a single process handling
525         a lot of namespaces without falling in a exponential creation time
526         * we may want to create a namespace without creating a cgroup
527
528         The ns_cgroup is replaced by a compatibility flag 'clone_children',
529         where a newly created cgroup will copy the parent cgroup values.
530         The userspace has to manually create a cgroup and add a task to
531         the 'tasks' file.
532 Who:    Daniel Lezcano <daniel.lezcano@free.fr>
533
534 ----------------------------
535
536 What:   iwlwifi disable_hw_scan module parameters
537 When:   2.6.40
538 Why:    Hareware scan is the prefer method for iwlwifi devices for
539         scanning operation. Remove software scan support for all the
540         iwlwifi devices.
541
542 Who:    Wey-Yi Guy <wey-yi.w.guy@intel.com>
543
544 ----------------------------
545
546 What:   access to nfsd auth cache through sys_nfsservctl or '.' files
547         in the 'nfsd' filesystem.
548 When:   2.6.40
549 Why:    This is a legacy interface which have been replaced by a more
550         dynamic cache.  Continuing to maintain this interface is an
551         unnecessary burden.
552 Who:    NeilBrown <neilb@suse.de>
553
554 ----------------------------
555
556 What:   i2c_adapter.id
557 When:   June 2011
558 Why:    This field is deprecated. I2C device drivers shouldn't change their
559         behavior based on the underlying I2C adapter. Instead, the I2C
560         adapter driver should instantiate the I2C devices and provide the
561         needed platform-specific information.
562 Who:    Jean Delvare <khali@linux-fr.org>
563
564 ----------------------------