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