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