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