Merge branches 'sh/serial-rework' and 'sh/oprofile'
[pandora-kernel.git] / Documentation / pcmcia / driver-changes.txt
1 This file details changes in 2.6 which affect PCMCIA card driver authors:
2
3 * New configuration loop helper (as of 2.6.28)
4    By calling pcmcia_loop_config(), a driver can iterate over all available
5    configuration options. During a driver's probe() phase, one doesn't need
6    to use pcmcia_get_{first,next}_tuple, pcmcia_get_tuple_data and
7    pcmcia_parse_tuple directly in most if not all cases.
8
9 * New release helper (as of 2.6.17)
10    Instead of calling pcmcia_release_{configuration,io,irq,win}, all that's
11    necessary now is calling pcmcia_disable_device. As there is no valid
12    reason left to call pcmcia_release_io and pcmcia_release_irq, the
13    exports for them were removed.
14
15 * Unify detach and REMOVAL event code, as well as attach and INSERTION
16   code (as of 2.6.16)
17        void (*remove)          (struct pcmcia_device *dev);
18        int (*probe)            (struct pcmcia_device *dev);
19
20 * Move suspend, resume and reset out of event handler (as of 2.6.16)
21        int (*suspend)          (struct pcmcia_device *dev);
22        int (*resume)           (struct pcmcia_device *dev);
23   should be initialized in struct pcmcia_driver, and handle
24   (SUSPEND == RESET_PHYSICAL) and (RESUME == CARD_RESET) events
25
26 * event handler initialization in struct pcmcia_driver (as of 2.6.13)
27    The event handler is notified of all events, and must be initialized
28    as the event() callback in the driver's struct pcmcia_driver.
29
30 * pcmcia/version.h should not be used (as of 2.6.13)
31    This file will be removed eventually.
32
33 * in-kernel device<->driver matching (as of 2.6.13)
34    PCMCIA devices and their correct drivers can now be matched in
35    kernelspace. See 'devicetable.txt' for details.
36
37 * Device model integration (as of 2.6.11)
38    A struct pcmcia_device is registered with the device model core,
39    and can be used (e.g. for SET_NETDEV_DEV) by using
40    handle_to_dev(client_handle_t * handle).
41
42 * Convert internal I/O port addresses to unsigned int (as of 2.6.11)
43    ioaddr_t should be replaced by unsigned int in PCMCIA card drivers.
44
45 * irq_mask and irq_list parameters (as of 2.6.11)
46    The irq_mask and irq_list parameters should no longer be used in
47    PCMCIA card drivers. Instead, it is the job of the PCMCIA core to
48    determine which IRQ should be used. Therefore, link->irq.IRQInfo2
49    is ignored.
50
51 * client->PendingEvents is gone (as of 2.6.11)
52    client->PendingEvents is no longer available.
53
54 * client->Attributes are gone (as of 2.6.11)
55    client->Attributes is unused, therefore it is removed from all
56    PCMCIA card drivers
57
58 * core functions no longer available (as of 2.6.11)
59    The following functions have been removed from the kernel source
60    because they are unused by all in-kernel drivers, and no external
61    driver was reported to rely on them:
62         pcmcia_get_first_region()
63         pcmcia_get_next_region()
64         pcmcia_modify_window()
65         pcmcia_set_event_mask()
66         pcmcia_get_first_window()
67         pcmcia_get_next_window()
68
69 * device list iteration upon module removal (as of 2.6.10)
70    It is no longer necessary to iterate on the driver's internal
71    client list and call the ->detach() function upon module removal.
72
73 * Resource management. (as of 2.6.8)
74    Although the PCMCIA subsystem will allocate resources for cards,
75    it no longer marks these resources busy. This means that driver
76    authors are now responsible for claiming your resources as per
77    other drivers in Linux. You should use request_region() to mark
78    your IO regions in-use, and request_mem_region() to mark your
79    memory regions in-use. The name argument should be a pointer to
80    your driver name. Eg, for pcnet_cs, name should point to the
81    string "pcnet_cs".
82
83 * CardServices is gone
84   CardServices() in 2.4 is just a big switch statement to call various
85   services.  In 2.6, all of those entry points are exported and called
86   directly (except for pcmcia_report_error(), just use cs_error() instead).
87
88 * struct pcmcia_driver
89   You need to use struct pcmcia_driver and pcmcia_{un,}register_driver
90   instead of {un,}register_pccard_driver