/* * cycx_main.c Cyclades Cyclom 2X WAN Link Driver. Main module. * * Author: Arnaldo Carvalho de Melo * * Copyright: (c) 1998-2001 Arnaldo Carvalho de Melo * * Based on sdlamain.c by Gene Kozin & * Jaspreet Singh * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version * 2 of the License, or (at your option) any later version. * ============================================================================ * 2001/05/09 acme Fix MODULE_DESC for debug, .bss nitpicks, * some cleanups * 2000/07/13 acme remove useless #ifdef MODULE and crap * #if KERNEL_VERSION > blah * 2000/07/06 acme __exit at cyclomx_cleanup * 2000/04/02 acme dprintk and cycx_debug * module_init/module_exit * 2000/01/21 acme rename cyclomx_open to cyclomx_mod_inc_use_count * and cyclomx_close to cyclomx_mod_dec_use_count * 2000/01/08 acme cleanup * 1999/11/06 acme cycx_down back to life (it needs to be * called to iounmap the dpmbase) * 1999/08/09 acme removed references to enable_tx_int * use spinlocks instead of cli/sti in * cyclomx_set_state * 1999/05/19 acme works directly linked into the kernel * init_waitqueue_head for 2.3.* kernel * 1999/05/18 acme major cleanup (polling not needed), etc * 1998/08/28 acme minor cleanup (ioctls for firmware deleted) * queue_task activated * 1998/08/08 acme Initial version. */ #include /* OS configuration options */ #include /* offsetof(), etc. */ #include /* return codes */ #include /* inline memset(), etc. */ #include /* kmalloc(), kfree() */ #include /* printk(), and other useful stuff */ #include /* support for loadable modules */ #include /* request_region(), release_region() */ #include /* for kernel task queues */ #include /* WAN router definitions */ #include /* cyclomx common user API definitions */ #include /* kernel <-> user copy */ #include /* __init (when not using as a module) */ /* Debug */ unsigned int cycx_debug; MODULE_AUTHOR("Arnaldo Carvalho de Melo"); MODULE_DESCRIPTION("Cyclom 2X Sync Card Driver."); MODULE_LICENSE("GPL"); MODULE_PARM(cycx_debug, "i"); MODULE_PARM_DESC(cycx_debug, "cyclomx debug level"); /* Defines & Macros */ #define DRV_VERSION 0 /* version number */ #define DRV_RELEASE 10 /* release (minor version) number */ #define MAX_CARDS 1 /* max number of adapters */ #define CONFIG_CYCLOMX_CARDS 1 /* Function Prototypes */ /* WAN link driver entry points */ static int setup (wan_device_t *wandev, wandev_conf_t *conf); static int shutdown (wan_device_t *wandev); static int ioctl (wan_device_t *wandev, unsigned cmd, unsigned long arg); /* Miscellaneous functions */ static void cycx_isr (int irq, void *dev_id, struct pt_regs *regs); /* Global Data * Note: All data must be explicitly initialized!!! */ /* private data */ static char drvname[] = "cyclomx"; static char fullname[] = "CYCLOM 2X(tm) Sync Card Driver"; static char copyright[] = "(c) 1998-2001 Arnaldo Carvalho de Melo " ""; static int ncards = CONFIG_CYCLOMX_CARDS; static cycx_t *card_array; /* adapter data space */ /* Kernel Loadable Module Entry Points */ /* * Module 'insert' entry point. * o print announcement * o allocate adapter data space * o initialize static data * o register all cards with WAN router * o calibrate Cyclom 2X shared memory access delay. * * Return: 0 Ok * < 0 error. * Context: process */ int __init cyclomx_init (void) { int cnt, err = -ENOMEM; printk(KERN_INFO "%s v%u.%u %s\n", fullname, DRV_VERSION, DRV_RELEASE, copyright); /* Verify number of cards and allocate adapter data space */ ncards = min_t(int, ncards, MAX_CARDS); ncards = max_t(int, ncards, 1); card_array = kmalloc(sizeof(cycx_t) * ncards, GFP_KERNEL); if (!card_array) goto out; memset(card_array, 0, sizeof(cycx_t) * ncards); /* Register adapters with WAN router */ for (cnt = 0; cnt < ncards; ++cnt) { cycx_t *card = &card_array[cnt]; wan_device_t *wandev = &card->wandev; sprintf(card->devname, "%s%d", drvname, cnt + 1); wandev->magic = ROUTER_MAGIC; wandev->name = card->devname; wandev->private = card; wandev->setup = setup; wandev->shutdown = shutdown; wandev->ioctl = ioctl; err = register_wan_device(wandev); if (err) { printk(KERN_ERR "%s: %s registration failed with " "error %d!\n", drvname, card->devname, err); break; } } err = -ENODEV; if (!cnt) { kfree(card_array); goto out; } err = 0; ncards = cnt; /* adjust actual number of cards */ out: return err; } /* * Module 'remove' entry point. * o unregister all adapters from the WAN router * o release all remaining system resources */ static void __exit cyclomx_cleanup (void) { int i = 0; for (; i < ncards; ++i) { cycx_t *card = &card_array[i]; unregister_wan_device(card->devname); } kfree(card_array); } /* WAN Device Driver Entry Points */ /* * Setup/configure WAN link driver. * o check adapter state * o make sure firmware is present in configuration * o allocate interrupt vector * o setup Cyclom 2X hardware * o call appropriate routine to perform protocol-specific initialization * * This function is called when router handles ROUTER_SETUP IOCTL. The * configuration structure is in kernel memory (including extended data, if * any). */ static int setup (wan_device_t *wandev, wandev_conf_t *conf) { int err = -EFAULT; cycx_t *card; int irq; /* Sanity checks */ if (!wandev || !wandev->private || !conf) goto out; card = wandev->private; err = -EBUSY; if (wandev->state != WAN_UNCONFIGURED) goto out; err = -EINVAL; if (!conf->data_size || !conf->data) { printk(KERN_ERR "%s: firmware not found in configuration " "data!\n", wandev->name); goto out; } if (conf->irq <= 0) { printk(KERN_ERR "%s: can't configure without IRQ!\n", wandev->name); goto out; } /* Allocate IRQ */ irq = conf->irq == 2 ? 9 : conf->irq; /* IRQ2 -> IRQ9 */ if (request_irq(irq, cycx_isr, 0, wandev->name, card)) { printk(KERN_ERR "%s: can't reserve IRQ %d!\n", wandev->name, irq); goto out; } /* Configure hardware, load firmware, etc. */ memset(&card->hw, 0, sizeof(cycxhw_t)); card->hw.irq = irq; card->hw.dpmbase = conf->maddr; card->hw.dpmsize = CYCX_WINDOWSIZE; card->hw.fwid = CFID_X25_2X; card->lock = SPIN_LOCK_UNLOCKED; init_waitqueue_head(&card->wait_stats); err = cycx_setup(&card->hw, conf->data, conf->data_size); if (err) goto out_irq; /* Initialize WAN device data space */ wandev->irq = irq; wandev->dma = wandev->ioport = 0; wandev->maddr = card->hw.dpmbase; wandev->msize = card->hw.dpmsize; wandev->hw_opt[2] = 0; wandev->hw_opt[3] = card->hw.fwid; /* Protocol-specific initialization */ switch (card->hw.fwid) { #ifdef CONFIG_CYCLOMX_X25 case CFID_X25_2X: err = cyx_init(card, conf); break; #endif default: printk(KERN_ERR "%s: this firmware is not supported!\n", wandev->name); err = -EINVAL; } if (err) { cycx_down(&card->hw); goto out_irq; } err = 0; out: return err; out_irq: free_irq(irq, card); goto out; } /* * Shut down WAN link driver. * o shut down adapter hardware * o release system resources. * * This function is called by the router when device is being unregistered or * when it handles ROUTER_DOWN IOCTL. */ static int shutdown (wan_device_t *wandev) { int ret = -EFAULT; cycx_t *card; /* sanity checks */ if (!wandev || !wandev->private) goto out; ret = 0; if (wandev->state == WAN_UNCONFIGURED) goto out; card = wandev->private; wandev->state = WAN_UNCONFIGURED; cycx_down(&card->hw); printk(KERN_INFO "%s: irq %d being freed!\n", wandev->name, wandev->irq); free_irq(wandev->irq, card); out: return ret; } /* * Driver I/O control. * o verify arguments * o perform requested action * * This function is called when router handles one of the reserved user * IOCTLs. Note that 'arg' still points to user address space. * * no reserved ioctls for the cyclom 2x up to now */ static int ioctl (wan_device_t *wandev, unsigned cmd, unsigned long arg) { return -EINVAL; } /* Miscellaneous */ /* * Cyclom 2X Interrupt Service Routine. * o acknowledge Cyclom 2X hardware interrupt. * o call protocol-specific interrupt service routine, if any. */ static void cycx_isr (int irq, void *dev_id, struct pt_regs *regs) { cycx_t *card = (cycx_t *)dev_id; if (!card || card->wandev.state == WAN_UNCONFIGURED) goto out; if (card->in_isr) { printk(KERN_WARNING "%s: interrupt re-entrancy on IRQ %d!\n", card->devname, card->wandev.irq); goto out; } if (card->isr) card->isr(card); out: return; } /* * This routine is called by the protocol-specific modules when network * interface is being open. The only reason we need this, is because we * have to call MOD_INC_USE_COUNT, but cannot include 'module.h' where it's * defined more than once into the same kernel module. */ void cyclomx_mod_inc_use_count (cycx_t *card) { ++card->open_cnt; MOD_INC_USE_COUNT; } /* * This routine is called by the protocol-specific modules when network * interface is being closed. The only reason we need this, is because we * have to call MOD_DEC_USE_COUNT, but cannot include 'module.h' where it's * defined more than once into the same kernel module. */ void cyclomx_mod_dec_use_count (cycx_t *card) { --card->open_cnt; MOD_DEC_USE_COUNT; } /* Set WAN device state. */ void cyclomx_set_state (cycx_t *card, int state) { unsigned long flags; char *string_state = NULL; spin_lock_irqsave(&card->lock, flags); if (card->wandev.state != state) { switch (state) { case WAN_CONNECTED: string_state = "connected!"; break; case WAN_DISCONNECTED: string_state = "disconnected!"; break; } printk(KERN_INFO "%s: link %s\n", card->devname, string_state); card->wandev.state = state; } card->state_tick = jiffies; spin_unlock_irqrestore(&card->lock, flags); } module_init(cyclomx_init); module_exit(cyclomx_cleanup);