elsa_cs.c
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:19k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /*======================================================================
  2.     An elsa_cs PCMCIA client driver
  3.     This driver is for the Elsa PCM ISDN Cards, i.e. the MicroLink
  4.     The contents of this file are subject to the Mozilla Public
  5.     License Version 1.1 (the "License"); you may not use this file
  6.     except in compliance with the License. You may obtain a copy of
  7.     the License at http://www.mozilla.org/MPL/
  8.     Software distributed under the License is distributed on an "AS
  9.     IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  10.     implied. See the License for the specific language governing
  11.     rights and limitations under the License.
  12.     The initial developer of the original code is David A. Hinds
  13.     <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
  14.     are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
  15.     Modifications from dummy_cs.c are Copyright (C) 1999-2001 Klaus
  16.     Lichtenwalder <Lichtenwalder@ACM.org>. All Rights Reserved.
  17.     Alternatively, the contents of this file may be used under the
  18.     terms of the GNU General Public License version 2 (the "GPL"), in
  19.     which case the provisions of the GPL are applicable instead of the
  20.     above.  If you wish to allow the use of your version of this file
  21.     only under the terms of the GPL and not to allow others to use
  22.     your version of this file under the MPL, indicate your decision
  23.     by deleting the provisions above and replace them with the notice
  24.     and other provisions required by the GPL.  If you do not delete
  25.     the provisions above, a recipient may use your version of this
  26.     file under either the MPL or the GPL.
  27. ======================================================================*/
  28. #include <linux/module.h>
  29. #include <linux/kernel.h>
  30. #include <linux/init.h>
  31. #include <linux/sched.h>
  32. #include <linux/ptrace.h>
  33. #include <linux/slab.h>
  34. #include <linux/string.h>
  35. #include <linux/timer.h>
  36. #include <linux/ioport.h>
  37. #include <asm/io.h>
  38. #include <asm/system.h>
  39. #include <pcmcia/version.h>
  40. #include <pcmcia/cs_types.h>
  41. #include <pcmcia/cs.h>
  42. #include <pcmcia/cistpl.h>
  43. #include <pcmcia/cisreg.h>
  44. #include <pcmcia/ds.h>
  45. #include <pcmcia/bus_ops.h>
  46. MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Elsa PCM cards");
  47. MODULE_AUTHOR("Klaus Lichtenwalder");
  48. MODULE_LICENSE("Dual MPL/GPL");
  49. /*
  50.    All the PCMCIA modules use PCMCIA_DEBUG to control debugging.  If
  51.    you do not define PCMCIA_DEBUG at all, all the debug code will be
  52.    left out.  If you compile with PCMCIA_DEBUG=0, the debug code will
  53.    be present but disabled -- but it can then be enabled for specific
  54.    modules at load time with a 'pc_debug=#' option to insmod.
  55. */
  56. #ifdef PCMCIA_DEBUG
  57. static int pc_debug = PCMCIA_DEBUG;
  58. MODULE_PARM(pc_debug, "i");
  59. #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
  60. static char *version =
  61. "elsa_cs.c $Revision: 1.1.4.1 $ $Date: 2001/11/20 14:19:35 $ (K.Lichtenwalder)";
  62. #else
  63. #define DEBUG(n, args...)
  64. #endif
  65. /*====================================================================*/
  66. /* Parameters that can be set with 'insmod' */
  67. /* Bit map of interrupts to choose from, the old way */
  68. /* This means pick from 15, 14, 12, 11, 10, 9, 7, 5, 4, 3 */
  69. static u_long irq_mask = 0xdeb8;
  70. /* Newer, simpler way of listing specific interrupts */
  71. static int irq_list[4] = { -1 };
  72. MODULE_PARM(irq_mask, "i");
  73. MODULE_PARM(irq_list, "1-4i");
  74. static int protocol = 2;        /* EURO-ISDN Default */
  75. MODULE_PARM(protocol, "i");
  76. extern int elsa_init_pcmcia(int, int, int*, int);
  77. /*====================================================================*/
  78. /*
  79.    The event() function is this driver's Card Services event handler.
  80.    It will be called by Card Services when an appropriate card status
  81.    event is received.  The config() and release() entry points are
  82.    used to configure or release a socket, in response to card insertion
  83.    and ejection events.  They are invoked from the elsa_cs event
  84.    handler.
  85. */
  86. static void elsa_cs_config(dev_link_t *link);
  87. static void elsa_cs_release(u_long arg);
  88. static int elsa_cs_event(event_t event, int priority,
  89.                           event_callback_args_t *args);
  90. /*
  91.    The attach() and detach() entry points are used to create and destroy
  92.    "instances" of the driver, where each instance represents everything
  93.    needed to manage one actual PCMCIA card.
  94. */
  95. static dev_link_t *elsa_cs_attach(void);
  96. static void elsa_cs_detach(dev_link_t *);
  97. /*
  98.    The dev_info variable is the "key" that is used to match up this
  99.    device driver with appropriate cards, through the card configuration
  100.    database.
  101. */
  102. static dev_info_t dev_info = "elsa_cs";
  103. /*
  104.    A linked list of "instances" of the elsa_cs device.  Each actual
  105.    PCMCIA card corresponds to one device instance, and is described
  106.    by one dev_link_t structure (defined in ds.h).
  107.    You may not want to use a linked list for this -- for example, the
  108.    memory card driver uses an array of dev_link_t pointers, where minor
  109.    device numbers are used to derive the corresponding array index.
  110. */
  111. static dev_link_t *dev_list = NULL;
  112. /*
  113.    A dev_link_t structure has fields for most things that are needed
  114.    to keep track of a socket, but there will usually be some device
  115.    specific information that also needs to be kept track of.  The
  116.    'priv' pointer in a dev_link_t structure can be used to point to
  117.    a device-specific private data structure, like this.
  118.    To simplify the data structure handling, we actually include the
  119.    dev_link_t structure in the device's private data structure.
  120.    A driver needs to provide a dev_node_t structure for each device
  121.    on a card.  In some cases, there is only one device per card (for
  122.    example, ethernet cards, modems).  In other cases, there may be
  123.    many actual or logical devices (SCSI adapters, memory cards with
  124.    multiple partitions).  The dev_node_t structures need to be kept
  125.    in a linked list starting at the 'dev' field of a dev_link_t
  126.    structure.  We allocate them in the card's private data structure,
  127.    because they generally shouldn't be allocated dynamically.
  128.    In this case, we also provide a flag to indicate if a device is
  129.    "stopped" due to a power management event, or card ejection.  The
  130.    device IO routines can use a flag like this to throttle IO to a
  131.    card that is not ready to accept it.
  132.    The bus_operations pointer is used on platforms for which we need
  133.    to use special socket-specific versions of normal IO primitives
  134.    (inb, outb, readb, writeb, etc) for card IO.
  135. */
  136. typedef struct local_info_t {
  137.     dev_link_t          link;
  138.     dev_node_t          node;
  139.     int                 busy;
  140.   struct bus_operations *bus;
  141. } local_info_t;
  142. /*====================================================================*/
  143. static void cs_error(client_handle_t handle, int func, int ret)
  144. {
  145.     error_info_t err = { func, ret};
  146.     CardServices(ReportError, handle, &err);
  147. }
  148. /*======================================================================
  149.     elsa_cs_attach() creates an "instance" of the driver, allocatingx
  150.     local data structures for one device.  The device is registered
  151.     with Card Services.
  152.     The dev_link structure is initialized, but we don't actually
  153.     configure the card at this point -- we wait until we receive a
  154.     card insertion event.
  155. ======================================================================*/
  156. static dev_link_t *elsa_cs_attach(void)
  157. {
  158.     client_reg_t client_reg;
  159.     dev_link_t *link;
  160.     local_info_t *local;
  161.     int ret, i;
  162.     void elsa_interrupt(int, void *, struct pt_regs *);
  163.     DEBUG(0, "elsa_cs_attach()n");
  164.     /* Allocate space for private device-specific data */
  165.     local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
  166.     if (!local) return NULL;
  167.     memset(local, 0, sizeof(local_info_t));
  168.     link = &local->link; link->priv = local;
  169.     /* Initialize the dev_link_t structure */
  170.     link->release.function = &elsa_cs_release;
  171.     link->release.data = (u_long)link;
  172.     /* Interrupt setup */
  173.     link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;
  174.     link->irq.IRQInfo1 = IRQ_INFO2_VALID|IRQ_LEVEL_ID|IRQ_SHARE_ID;
  175.     if (irq_list[0] == -1)
  176.         link->irq.IRQInfo2 = irq_mask;
  177.     else
  178.         for (i = 0; i < 4; i++)
  179.             link->irq.IRQInfo2 |= 1 << irq_list[i];
  180.     link->irq.Handler = NULL;
  181.     /*
  182.       General socket configuration defaults can go here.  In this
  183.       client, we assume very little, and rely on the CIS for almost
  184.       everything.  In most clients, many details (i.e., number, sizes,
  185.       and attributes of IO windows) are fixed by the nature of the
  186.       device, and can be hard-wired here.
  187.     */
  188.     link->io.NumPorts1 = 8;
  189.     link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
  190.     link->io.IOAddrLines = 3;
  191.     link->conf.Attributes = CONF_ENABLE_IRQ;
  192.     link->conf.Vcc = 50;
  193.     link->conf.IntType = INT_MEMORY_AND_IO;
  194.     /* Register with Card Services */
  195.     link->next = dev_list;
  196.     dev_list = link;
  197.     client_reg.dev_info = &dev_info;
  198.     client_reg.Attributes = INFO_IO_CLIENT | INFO_CARD_SHARE;
  199.     client_reg.EventMask =
  200.         CS_EVENT_CARD_INSERTION | CS_EVENT_CARD_REMOVAL |
  201.         CS_EVENT_RESET_PHYSICAL | CS_EVENT_CARD_RESET |
  202.         CS_EVENT_PM_SUSPEND | CS_EVENT_PM_RESUME;
  203.     client_reg.event_handler = &elsa_cs_event;
  204.     client_reg.Version = 0x0210;
  205.     client_reg.event_callback_args.client_data = link;
  206.     ret = CardServices(RegisterClient, &link->handle, &client_reg);
  207.     if (ret != CS_SUCCESS) {
  208.         cs_error(link->handle, RegisterClient, ret);
  209.         elsa_cs_detach(link);
  210.         return NULL;
  211.     }
  212.     return link;
  213. } /* elsa_cs_attach */
  214. /*======================================================================
  215.     This deletes a driver "instance".  The device is de-registered
  216.     with Card Services.  If it has been released, all local data
  217.     structures are freed.  Otherwise, the structures will be freed
  218.     when the device is released.
  219. ======================================================================*/
  220. static void elsa_cs_detach(dev_link_t *link)
  221. {
  222.     dev_link_t **linkp;
  223.     local_info_t *info = link->priv;
  224.     int ret;
  225.     DEBUG(0, "elsa_cs_detach(0x%p)n", link);
  226.     /* Locate device structure */
  227.     for (linkp = &dev_list; *linkp; linkp = &(*linkp)->next)
  228.         if (*linkp == link) break;
  229.     if (*linkp == NULL)
  230.         return;
  231.     del_timer(&link->release);
  232.     if (link->state & DEV_CONFIG)
  233.         elsa_cs_release((u_long)link);
  234.     /*
  235.        If the device is currently configured and active, we won't
  236.        actually delete it yet.  Instead, it is marked so that when
  237.        the release() function is called, that will trigger a proper
  238.        detach().
  239.     */
  240.     if (link->state & DEV_CONFIG) {
  241.       DEBUG(0, "elsa_cs: detach postponed, '%s' "
  242.                "still lockedn", link->dev->dev_name);
  243.         link->state |= DEV_STALE_LINK;
  244.         return;
  245.     }
  246.     /* Break the link with Card Services */
  247.     if (link->handle) {
  248.         ret = CardServices(DeregisterClient, link->handle);
  249. if (ret != CS_SUCCESS)
  250.     cs_error(link->handle, DeregisterClient, ret);
  251.     }
  252.     /* Unlink device structure and free it */
  253.     *linkp = link->next;
  254.     kfree(info);
  255. } /* elsa_cs_detach */
  256. /*======================================================================
  257.     elsa_cs_config() is scheduled to run after a CARD_INSERTION event
  258.     is received, to configure the PCMCIA socket, and to make the
  259.     device available to the system.
  260. ======================================================================*/
  261. static int get_tuple(int fn, client_handle_t handle, tuple_t *tuple,
  262.                      cisparse_t *parse)
  263. {
  264.     int i;
  265.     i = CardServices(fn, handle, tuple);
  266.     if (i != CS_SUCCESS) return i;
  267.     i = CardServices(GetTupleData, handle, tuple);
  268.     if (i != CS_SUCCESS) return i;
  269.     return CardServices(ParseTuple, handle, tuple, parse);
  270. }
  271. #define first_tuple(a, b, c) get_tuple(GetFirstTuple, a, b, c)
  272. #define next_tuple(a, b, c) get_tuple(GetNextTuple, a, b, c)
  273. static void elsa_cs_config(dev_link_t *link)
  274. {
  275.     client_handle_t handle;
  276.     tuple_t tuple;
  277.     cisparse_t parse;
  278.     local_info_t *dev;
  279.     int i, j, last_fn;
  280.     u_short buf[128];
  281.     cistpl_cftable_entry_t *cf = &parse.cftable_entry;
  282.     DEBUG(0, "elsa_config(0x%p)n", link);
  283.     handle = link->handle;
  284.     dev = link->priv;
  285.     /*
  286.        This reads the card's CONFIG tuple to find its configuration
  287.        registers.
  288.     */
  289.     tuple.DesiredTuple = CISTPL_CONFIG;
  290.     tuple.TupleData = (cisdata_t *)buf;
  291.     tuple.TupleDataMax = 255;
  292.     tuple.TupleOffset = 0;
  293.     tuple.Attributes = 0;
  294.     i = first_tuple(handle, &tuple, &parse);
  295.     if (i != CS_SUCCESS) {
  296.         last_fn = ParseTuple;
  297. goto cs_failed;
  298.     }
  299.     link->conf.ConfigBase = parse.config.base;
  300.     link->conf.Present = parse.config.rmask[0];
  301.     /* Configure card */
  302.     link->state |= DEV_CONFIG;
  303.     tuple.TupleData = (cisdata_t *)buf;
  304.     tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
  305.     tuple.Attributes = 0;
  306.     tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
  307.     i = first_tuple(handle, &tuple, &parse);
  308.     while (i == CS_SUCCESS) {
  309.         if ( (cf->io.nwin > 0) && cf->io.win[0].base) {
  310.             printk(KERN_INFO "(elsa_cs: looks like the 96 model)n");
  311.             link->conf.ConfigIndex = cf->index;
  312.             link->io.BasePort1 = cf->io.win[0].base;
  313.             i = CardServices(RequestIO, link->handle, &link->io);
  314.             if (i == CS_SUCCESS) break;
  315.         } else {
  316.           printk(KERN_INFO "(elsa_cs: looks like the 97 model)n");
  317.           link->conf.ConfigIndex = cf->index;
  318.           for (i = 0, j = 0x2f0; j > 0x100; j -= 0x10) {
  319.             link->io.BasePort1 = j;
  320.             i = CardServices(RequestIO, link->handle, &link->io);
  321.             if (i == CS_SUCCESS) break;
  322.           }
  323.           break;
  324.         }
  325.         i = next_tuple(handle, &tuple, &parse);
  326.     }
  327.     if (i != CS_SUCCESS) {
  328. last_fn = RequestIO;
  329. goto cs_failed;
  330.     }
  331.     i = CardServices(RequestIRQ, link->handle, &link->irq);
  332.     if (i != CS_SUCCESS) {
  333.         link->irq.AssignedIRQ = 0;
  334. last_fn = RequestIRQ;
  335.         goto cs_failed;
  336.     }
  337.     i = CardServices(RequestConfiguration, link->handle, &link->conf);
  338.     if (i != CS_SUCCESS) {
  339.       last_fn = RequestConfiguration;
  340.       goto cs_failed;
  341.     }
  342.     /* At this point, the dev_node_t structure(s) should be
  343.        initialized and arranged in a linked list at link->dev. *//*  */
  344.     sprintf(dev->node.dev_name, "elsa");
  345.     dev->node.major = dev->node.minor = 0x0;
  346.     link->dev = &dev->node;
  347.     /* Finally, report what we've done */
  348.     printk(KERN_INFO "%s: index 0x%02x: Vcc %d.%d",
  349.            dev->node.dev_name, link->conf.ConfigIndex,
  350.            link->conf.Vcc/10, link->conf.Vcc%10);
  351.     if (link->conf.Vpp1)
  352.         printk(", Vpp %d.%d", link->conf.Vpp1/10, link->conf.Vpp1%10);
  353.     if (link->conf.Attributes & CONF_ENABLE_IRQ)
  354.         printk(", irq %d", link->irq.AssignedIRQ);
  355.     if (link->io.NumPorts1)
  356.         printk(", io 0x%04x-0x%04x", link->io.BasePort1,
  357.                link->io.BasePort1+link->io.NumPorts1-1);
  358.     if (link->io.NumPorts2)
  359.         printk(" & 0x%04x-0x%04x", link->io.BasePort2,
  360.                link->io.BasePort2+link->io.NumPorts2-1);
  361.     printk("n");
  362.     link->state &= ~DEV_CONFIG_PENDING;
  363.     elsa_init_pcmcia(link->io.BasePort1, link->irq.AssignedIRQ,
  364.                      &(((local_info_t*)link->priv)->busy),
  365.                      protocol);
  366.     return;
  367. cs_failed:
  368.     cs_error(link->handle, last_fn, i);
  369.     elsa_cs_release((u_long)link);
  370. } /* elsa_cs_config */
  371. /*======================================================================
  372.     After a card is removed, elsa_cs_release() will unregister the net
  373.     device, and release the PCMCIA configuration.  If the device is
  374.     still open, this will be postponed until it is closed.
  375. ======================================================================*/
  376. static void elsa_cs_release(u_long arg)
  377. {
  378.     dev_link_t *link = (dev_link_t *)arg;
  379.     DEBUG(0, "elsa_cs_release(0x%p)n", link);
  380.     /*
  381.        If the device is currently in use, we won't release until it
  382.        is actually closed, because until then, we can't be sure that
  383.        no one will try to access the device or its data structures.
  384.     */
  385.     if (link->open) {
  386.         DEBUG(1, "elsa_cs: release postponed, '%s' "
  387.                    "still openn", link->dev->dev_name);
  388.         link->state |= DEV_STALE_CONFIG;
  389.         return;
  390.     }
  391.     /* Unlink the device chain */
  392.     link->dev = NULL;
  393.     /* Don't bother checking to see if these succeed or not */
  394.     if (link->win)
  395.         CardServices(ReleaseWindow, link->win);
  396.     CardServices(ReleaseConfiguration, link->handle);
  397.     CardServices(ReleaseIO, link->handle, &link->io);
  398.     CardServices(ReleaseIRQ, link->handle, &link->irq);
  399.     link->state &= ~DEV_CONFIG;
  400.     if (link->state & DEV_STALE_LINK)
  401.         elsa_cs_detach(link);
  402. } /* elsa_cs_release */
  403. /*======================================================================
  404.     The card status event handler.  Mostly, this schedules other
  405.     stuff to run after an event is received.  A CARD_REMOVAL event
  406.     also sets some flags to discourage the net drivers from trying
  407.     to talk to the card any more.
  408.     When a CARD_REMOVAL event is received, we immediately set a flag
  409.     to block future accesses to this device.  All the functions that
  410.     actually access the device should check this flag to make sure
  411.     the card is still present.
  412. ======================================================================*/
  413. static int elsa_cs_event(event_t event, int priority,
  414.                           event_callback_args_t *args)
  415. {
  416.     dev_link_t *link = args->client_data;
  417.     local_info_t *dev = link->priv;
  418.     DEBUG(1, "elsa_cs_event(%d)n", event);
  419.     switch (event) {
  420.     case CS_EVENT_CARD_REMOVAL:
  421.         link->state &= ~DEV_PRESENT;
  422.         if (link->state & DEV_CONFIG) {
  423.             ((local_info_t*)link->priv)->busy = 1;
  424.             mod_timer(&link->release, jiffies + HZ/20);
  425.         }
  426.         break;
  427.     case CS_EVENT_CARD_INSERTION:
  428.         link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
  429.         dev->bus = args->bus;
  430.         elsa_cs_config(link);
  431.         break;
  432.     case CS_EVENT_PM_SUSPEND:
  433.         link->state |= DEV_SUSPEND;
  434.         /* Fall through... */
  435.     case CS_EVENT_RESET_PHYSICAL:
  436.         /* Mark the device as stopped, to block IO until later */
  437.         dev->busy = 1;
  438.         if (link->state & DEV_CONFIG)
  439.             CardServices(ReleaseConfiguration, link->handle);
  440.         break;
  441.     case CS_EVENT_PM_RESUME:
  442.         link->state &= ~DEV_SUSPEND;
  443.         /* Fall through... */
  444.     case CS_EVENT_CARD_RESET:
  445.         if (link->state & DEV_CONFIG)
  446.             CardServices(RequestConfiguration, link->handle, &link->conf);
  447.         dev->busy = 0;
  448.         break;
  449.     }
  450.     return 0;
  451. } /* elsa_cs_event */
  452. /*====================================================================*/
  453. static int __init init_elsa_cs(void)
  454. {
  455.     servinfo_t serv;
  456.     DEBUG(0, "%sn", version);
  457.     CardServices(GetCardServicesInfo, &serv);
  458.     if (serv.Revision != CS_RELEASE_CODE) {
  459.         printk(KERN_NOTICE "elsa_cs: Card Services release "
  460.                "does not match!n");
  461.         return -1;
  462.     }
  463.     register_pccard_driver(&dev_info, &elsa_cs_attach, &elsa_cs_detach);
  464.     return 0;
  465. }
  466. static void __exit exit_elsa_cs(void)
  467. {
  468.     DEBUG(0, "elsa_cs: unloadingn");
  469.     unregister_pccard_driver(&dev_info);
  470.     while (dev_list != NULL)
  471.         elsa_cs_detach(dev_list);
  472. }
  473. module_init(init_elsa_cs);
  474. module_exit(exit_elsa_cs);