Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[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:   CONFIG_WIRELESS_OLD_REGULATORY - old static regulatory information
88 When:   March 2010 / desktop catchup
89
90 Why:    The old regulatory infrastructure has been replaced with a new one
91         which does not require statically defined regulatory domains. We do
92         not want to keep static regulatory domains in the kernel due to the
93         the dynamic nature of regulatory law and localization. We kept around
94         the old static definitions for the regulatory domains of:
95
96                 * US
97                 * JP
98                 * EU
99
100         and used by default the US when CONFIG_WIRELESS_OLD_REGULATORY was
101         set. We will remove this option once the standard Linux desktop catches
102         up with the new userspace APIs we have implemented.
103
104 Who:    Luis R. Rodriguez <lrodriguez@atheros.com>
105
106 ---------------------------
107
108 What:   dev->power.power_state
109 When:   July 2007
110 Why:    Broken design for runtime control over driver power states, confusing
111         driver-internal runtime power management with:  mechanisms to support
112         system-wide sleep state transitions; event codes that distinguish
113         different phases of swsusp "sleep" transitions; and userspace policy
114         inputs.  This framework was never widely used, and most attempts to
115         use it were broken.  Drivers should instead be exposing domain-specific
116         interfaces either to kernel or to userspace.
117 Who:    Pavel Machek <pavel@suse.cz>
118
119 ---------------------------
120
121 What:   Video4Linux API 1 ioctls and from Video devices.
122 When:   July 2009
123 Files:  include/linux/videodev.h
124 Check:  include/linux/videodev.h
125 Why:    V4L1 AP1 was replaced by V4L2 API during migration from 2.4 to 2.6
126         series. The old API have lots of drawbacks and don't provide enough
127         means to work with all video and audio standards. The newer API is
128         already available on the main drivers and should be used instead.
129         Newer drivers should use v4l_compat_translate_ioctl function to handle
130         old calls, replacing to newer ones.
131         Decoder iocts are using internally to allow video drivers to
132         communicate with video decoders. This should also be improved to allow
133         V4L2 calls being translated into compatible internal ioctls.
134         Compatibility ioctls will be provided, for a while, via 
135         v4l1-compat module. 
136 Who:    Mauro Carvalho Chehab <mchehab@infradead.org>
137
138 ---------------------------
139
140 What:   PCMCIA control ioctl (needed for pcmcia-cs [cardmgr, cardctl])
141 When:   November 2005
142 Files:  drivers/pcmcia/: pcmcia_ioctl.c
143 Why:    With the 16-bit PCMCIA subsystem now behaving (almost) like a
144         normal hotpluggable bus, and with it using the default kernel
145         infrastructure (hotplug, driver core, sysfs) keeping the PCMCIA
146         control ioctl needed by cardmgr and cardctl from pcmcia-cs is
147         unnecessary, and makes further cleanups and integration of the
148         PCMCIA subsystem into the Linux kernel device driver model more
149         difficult. The features provided by cardmgr and cardctl are either
150         handled by the kernel itself now or are available in the new
151         pcmciautils package available at
152         http://kernel.org/pub/linux/utils/kernel/pcmcia/
153 Who:    Dominik Brodowski <linux@brodo.de>
154
155 ---------------------------
156
157 What:   sys_sysctl
158 When:   September 2010
159 Option: CONFIG_SYSCTL_SYSCALL
160 Why:    The same information is available in a more convenient from
161         /proc/sys, and none of the sysctl variables appear to be
162         important performance wise.
163
164         Binary sysctls are a long standing source of subtle kernel
165         bugs and security issues.
166
167         When I looked several months ago all I could find after
168         searching several distributions were 5 user space programs and
169         glibc (which falls back to /proc/sys) using this syscall.
170
171         The man page for sysctl(2) documents it as unusable for user
172         space programs.
173
174         sysctl(2) is not generally ABI compatible to a 32bit user
175         space application on a 64bit and a 32bit kernel.
176
177         For the last several months the policy has been no new binary
178         sysctls and no one has put forward an argument to use them.
179
180         Binary sysctls issues seem to keep happening appearing so
181         properly deprecating them (with a warning to user space) and a
182         2 year grace warning period will mean eventually we can kill
183         them and end the pain.
184
185         In the mean time individual binary sysctls can be dealt with
186         in a piecewise fashion.
187
188 Who:    Eric Biederman <ebiederm@xmission.com>
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 (Why):
260         - xt_recent: the old ipt_recent proc dir
261           (superseded by /proc/net/xt_recent)
262
263 When:   January 2009 or Linux 2.7.0, whichever comes first
264 Why:    Superseded by newer revisions or modules
265 Who:    Jan Engelhardt <jengelh@computergmbh.de>
266
267 ---------------------------
268
269 What:   GPIO autorequest on gpio_direction_{input,output}() in gpiolib
270 When:   February 2010
271 Why:    All callers should use explicit gpio_request()/gpio_free().
272         The autorequest mechanism in gpiolib was provided mostly as a
273         migration aid for legacy GPIO interfaces (for SOC based GPIOs).
274         Those users have now largely migrated.  Platforms implementing
275         the GPIO interfaces without using gpiolib will see no changes.
276 Who:    David Brownell <dbrownell@users.sourceforge.net>
277 ---------------------------
278
279 What:   b43 support for firmware revision < 410
280 When:   The schedule was July 2008, but it was decided that we are going to keep the
281         code as long as there are no major maintanance headaches.
282         So it _could_ be removed _any_ time now, if it conflicts with something new.
283 Why:    The support code for the old firmware hurts code readability/maintainability
284         and slightly hurts runtime performance. Bugfixes for the old firmware
285         are not provided by Broadcom anymore.
286 Who:    Michael Buesch <mb@bu3sch.de>
287
288 ---------------------------
289
290 What:   /sys/o2cb symlink
291 When:   January 2010
292 Why:    /sys/fs/o2cb is the proper location for this information - /sys/o2cb
293         exists as a symlink for backwards compatibility for old versions of
294         ocfs2-tools. 2 years should be sufficient time to phase in new versions
295         which know to look in /sys/fs/o2cb.
296 Who:    ocfs2-devel@oss.oracle.com
297
298 ---------------------------
299
300 What:   Ability for non root users to shm_get hugetlb pages based on mlock
301         resource limits
302 When:   2.6.31
303 Why:    Non root users need to be part of /proc/sys/vm/hugetlb_shm_group or
304         have CAP_IPC_LOCK to be able to allocate shm segments backed by
305         huge pages.  The mlock based rlimit check to allow shm hugetlb is
306         inconsistent with mmap based allocations.  Hence it is being
307         deprecated.
308 Who:    Ravikiran Thirumalai <kiran@scalex86.org>
309
310 ---------------------------
311
312 What:   CONFIG_THERMAL_HWMON
313 When:   January 2009
314 Why:    This option was introduced just to allow older lm-sensors userspace
315         to keep working over the upgrade to 2.6.26. At the scheduled time of
316         removal fixed lm-sensors (2.x or 3.x) should be readily available.
317 Who:    Rene Herman <rene.herman@gmail.com>
318
319 ---------------------------
320
321 What:   Code that is now under CONFIG_WIRELESS_EXT_SYSFS
322         (in net/core/net-sysfs.c)
323 When:   After the only user (hal) has seen a release with the patches
324         for enough time, probably some time in 2010.
325 Why:    Over 1K .text/.data size reduction, data is available in other
326         ways (ioctls)
327 Who:    Johannes Berg <johannes@sipsolutions.net>
328
329 ---------------------------
330
331 What: CONFIG_NF_CT_ACCT
332 When: 2.6.29
333 Why:  Accounting can now be enabled/disabled without kernel recompilation.
334       Currently used only to set a default value for a feature that is also
335       controlled by a kernel/module/sysfs/sysctl parameter.
336 Who:  Krzysztof Piotr Oledzki <ole@ans.pl>
337
338 ---------------------------
339
340 What:   sysfs ui for changing p4-clockmod parameters
341 When:   September 2009
342 Why:    See commits 129f8ae9b1b5be94517da76009ea956e89104ce8 and
343         e088e4c9cdb618675874becb91b2fd581ee707e6.
344         Removal is subject to fixing any remaining bugs in ACPI which may
345         cause the thermal throttling not to happen at the right time.
346 Who:    Dave Jones <davej@redhat.com>, Matthew Garrett <mjg@redhat.com>
347
348 -----------------------------
349
350 What:   __do_IRQ all in one fits nothing interrupt handler
351 When:   2.6.32
352 Why:    __do_IRQ was kept for easy migration to the type flow handlers.
353         More than two years of migration time is enough.
354 Who:    Thomas Gleixner <tglx@linutronix.de>
355
356 -----------------------------
357
358 What:   fakephp and associated sysfs files in /sys/bus/pci/slots/
359 When:   2011
360 Why:    In 2.6.27, the semantics of /sys/bus/pci/slots was redefined to
361         represent a machine's physical PCI slots. The change in semantics
362         had userspace implications, as the hotplug core no longer allowed
363         drivers to create multiple sysfs files per physical slot (required
364         for multi-function devices, e.g.). fakephp was seen as a developer's
365         tool only, and its interface changed. Too late, we learned that
366         there were some users of the fakephp interface.
367
368         In 2.6.30, the original fakephp interface was restored. At the same
369         time, the PCI core gained the ability that fakephp provided, namely
370         function-level hot-remove and hot-add.
371
372         Since the PCI core now provides the same functionality, exposed in:
373
374                 /sys/bus/pci/rescan
375                 /sys/bus/pci/devices/.../remove
376                 /sys/bus/pci/devices/.../rescan
377
378         there is no functional reason to maintain fakephp as well.
379
380         We will keep the existing module so that 'modprobe fakephp' will
381         present the old /sys/bus/pci/slots/... interface for compatibility,
382         but users are urged to migrate their applications to the API above.
383
384         After a reasonable transition period, we will remove the legacy
385         fakephp interface.
386 Who:    Alex Chiang <achiang@hp.com>
387
388 ---------------------------
389
390 What:   CONFIG_RFKILL_INPUT
391 When:   2.6.33
392 Why:    Should be implemented in userspace, policy daemon.
393 Who:    Johannes Berg <johannes@sipsolutions.net>
394
395 ---------------------------
396
397 What:   CONFIG_INOTIFY
398 When:   2.6.33
399 Why:    last user (audit) will be converted to the newer more generic
400         and more easily maintained fsnotify subsystem
401 Who:    Eric Paris <eparis@redhat.com>
402
403 ----------------------------
404
405 What:   lock_policy_rwsem_* and unlock_policy_rwsem_* will not be
406         exported interface anymore.
407 When:   2.6.33
408 Why:    cpu_policy_rwsem has a new cleaner definition making it local to
409         cpufreq core and contained inside cpufreq.c. Other dependent
410         drivers should not use it in order to safely avoid lockdep issues.
411 Who:    Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
412
413 ----------------------------
414
415 What:   sound-slot/service-* module aliases and related clutters in
416         sound/sound_core.c
417 When:   August 2010
418 Why:    OSS sound_core grabs all legacy minors (0-255) of SOUND_MAJOR
419         (14) and requests modules using custom sound-slot/service-*
420         module aliases.  The only benefit of doing this is allowing
421         use of custom module aliases which might as well be considered
422         a bug at this point.  This preemptive claiming prevents
423         alternative OSS implementations.
424
425         Till the feature is removed, the kernel will be requesting
426         both sound-slot/service-* and the standard char-major-* module
427         aliases and allow turning off the pre-claiming selectively via
428         CONFIG_SOUND_OSS_CORE_PRECLAIM and soundcore.preclaim_oss
429         kernel parameter.
430
431         After the transition phase is complete, both the custom module
432         aliases and switches to disable it will go away.  This removal
433         will also allow making ALSA OSS emulation independent of
434         sound_core.  The dependency will be broken then too.
435 Who:    Tejun Heo <tj@kernel.org>
436
437 ----------------------------
438
439 What:   Support for VMware's guest paravirtuliazation technique [VMI] will be
440         dropped.
441 When:   2.6.37 or earlier.
442 Why:    With the recent innovations in CPU hardware acceleration technologies
443         from Intel and AMD, VMware ran a few experiments to compare these
444         techniques to guest paravirtualization technique on VMware's platform.
445         These hardware assisted virtualization techniques have outperformed the
446         performance benefits provided by VMI in most of the workloads. VMware
447         expects that these hardware features will be ubiquitous in a couple of
448         years, as a result, VMware has started a phased retirement of this
449         feature from the hypervisor. We will be removing this feature from the
450         Kernel too. Right now we are targeting 2.6.37 but can retire earlier if
451         technical reasons (read opportunity to remove major chunk of pvops)
452         arise.
453
454         Please note that VMI has always been an optimization and non-VMI kernels
455         still work fine on VMware's platform.
456         Latest versions of VMware's product which support VMI are,
457         Workstation 7.0 and VSphere 4.0 on ESX side, future maintainence
458         releases for these products will continue supporting VMI.
459
460         For more details about VMI retirement take a look at this,
461         http://blogs.vmware.com/guestosguide/2009/09/vmi-retirement.html
462
463 Who:    Alok N Kataria <akataria@vmware.com>
464
465 ----------------------------
466
467 What:   adt7473 hardware monitoring driver
468 When:   February 2010
469 Why:    Obsoleted by the adt7475 driver.
470 Who:    Jean Delvare <khali@linux-fr.org>
471
472 ---------------------------
473 What:   Support for lcd_switch and display_get in asus-laptop driver
474 When:   March 2010
475 Why:    These two features use non-standard interfaces. There are the
476         only features that really need multiple path to guess what's
477         the right method name on a specific laptop.
478
479         Removing them will allow to remove a lot of code an significantly
480         clean the drivers.
481
482         This will affect the backlight code which won't be able to know
483         if the backlight is on or off. The platform display file will also be
484         write only (like the one in eeepc-laptop).
485
486         This should'nt affect a lot of user because they usually know
487         when their display is on or off.
488
489 Who:    Corentin Chary <corentin.chary@gmail.com>
490
491 ----------------------------
492
493 What:   usbvideo quickcam_messenger driver
494 When:   2.6.35
495 Files:  drivers/media/video/usbvideo/quickcam_messenger.[ch]
496 Why:    obsolete v4l1 driver replaced by gspca_stv06xx
497 Who:    Hans de Goede <hdegoede@redhat.com>
498
499 ----------------------------
500
501 What:   ov511 v4l1 driver
502 When:   2.6.35
503 Files:  drivers/media/video/ov511.[ch]
504 Why:    obsolete v4l1 driver replaced by gspca_ov519
505 Who:    Hans de Goede <hdegoede@redhat.com>
506
507 ----------------------------
508
509 What:   w9968cf v4l1 driver
510 When:   2.6.35
511 Files:  drivers/media/video/w9968cf*.[ch]
512 Why:    obsolete v4l1 driver replaced by gspca_ov519
513 Who:    Hans de Goede <hdegoede@redhat.com>
514
515 ----------------------------
516
517 What:   ovcamchip sensor framework
518 When:   2.6.35
519 Files:  drivers/media/video/ovcamchip/*
520 Why:    Only used by obsoleted v4l1 drivers
521 Who:    Hans de Goede <hdegoede@redhat.com>
522
523 ----------------------------
524
525 What:   stv680 v4l1 driver
526 When:   2.6.35
527 Files:  drivers/media/video/stv680.[ch]
528 Why:    obsolete v4l1 driver replaced by gspca_stv0680
529 Who:    Hans de Goede <hdegoede@redhat.com>
530
531 ----------------------------
532
533 What:   zc0301 v4l driver
534 When:   2.6.35
535 Files:  drivers/media/video/zc0301/*
536 Why:    Duplicate functionality with the gspca_zc3xx driver, zc0301 only
537         supports 2 USB-ID's (because it only supports a limited set of
538         sensors) wich are also supported by the gspca_zc3xx driver
539         (which supports 53 USB-ID's in total)
540 Who:    Hans de Goede <hdegoede@redhat.com>
541
542 ----------------------------
543
544 What:   corgikbd, spitzkbd, tosakbd driver
545 When:   2.6.35
546 Files:  drivers/input/keyboard/{corgi,spitz,tosa}kbd.c
547 Why:    We now have a generic GPIO based matrix keyboard driver that
548         are fully capable of handling all the keys on these devices.
549         The original drivers manipulate the GPIO registers directly
550         and so are difficult to maintain.
551 Who:    Eric Miao <eric.y.miao@gmail.com>
552
553 ----------------------------
554
555 What:   corgi_ssp and corgi_ts driver
556 When:   2.6.35
557 Files:  arch/arm/mach-pxa/corgi_ssp.c, drivers/input/touchscreen/corgi_ts.c
558 Why:    The corgi touchscreen is now deprecated in favour of the generic
559         ads7846.c driver. The noise reduction technique used in corgi_ts.c,
560         that's to wait till vsync before ADC sampling, is also integrated into
561         ads7846 driver now. Provided that the original driver is not generic
562         and is difficult to maintain, it will be removed later.
563 Who:    Eric Miao <eric.y.miao@gmail.com>