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