drivers/net/wireless/atmel_cs.c

   1 /*** -*- linux-c -*- **********************************************************
   2
   3      Driver for Atmel at76c502 at76c504 and at76c506 wireless cards.
   4
   5         Copyright 2000-2001 ATMEL Corporation.
   6         Copyright 2003 Simon Kelley.
   7
   8     This code was developed from version 2.1.1 of the Atmel drivers,
   9     released by Atmel corp. under the GPL in December 2002. It also
  10     includes code from the Linux aironet drivers (C) Benjamin Reed,
  11     and the Linux PCMCIA package, (C) David Hinds.
  12
  13     For all queries about this code, please contact the current author,
  14     Simon Kelley <simon@thekelleys.org.uk> and not Atmel Corporation.
  15
  16     This program is free software; you can redistribute it and/or modify
  17     it under the terms of the GNU General Public License as published by
  18     the Free Software Foundation; either version 2 of the License, or
  19     (at your option) any later version.
  20
  21     This software is distributed in the hope that it will be useful,
  22     but WITHOUT ANY WARRANTY; without even the implied warranty of
  23     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24     GNU General Public License for more details.
  25
  26     You should have received a copy of the GNU General Public License
  27     along with Atmel wireless lan drivers; if not, write to the Free Software
  28     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  29
  30 ******************************************************************************/
  31
  32 #ifdef __IN_PCMCIA_PACKAGE__
  33 #include <pcmcia/k_compat.h>
  34 #endif
  35 #include <linux/init.h>
  36 #include <linux/kernel.h>
  37 #include <linux/module.h>
  38 #include <linux/ptrace.h>
  39 #include <linux/slab.h>
  40 #include <linux/string.h>
  41 #include <linux/netdevice.h>
  42 #include <linux/moduleparam.h>
  43 #include <linux/device.h>
  44
  45 #include <pcmcia/cs_types.h>
  46 #include <pcmcia/cs.h>
  47 #include <pcmcia/cistpl.h>
  48 #include <pcmcia/cisreg.h>
  49 #include <pcmcia/ds.h>
  50 #include <pcmcia/ciscode.h>
  51
  52 #include <asm/io.h>
  53 #include <asm/system.h>
  54 #include <linux/wireless.h>
  55
  56 #include "atmel.h"
  57
  58
  59 /*====================================================================*/
  60
  61 MODULE_AUTHOR("Simon Kelley");
  62 MODULE_DESCRIPTION("Support for Atmel at76c50x 802.11 wireless ethernet cards.");
  63 MODULE_LICENSE("GPL");
  64 MODULE_SUPPORTED_DEVICE("Atmel at76c50x PCMCIA cards");
  65
  66 /*====================================================================*/
  67
  68 /*
  69    The event() function is this driver's Card Services event handler.
  70    It will be called by Card Services when an appropriate card status
  71    event is received.  The config() and release() entry points are
  72    used to configure or release a socket, in response to card
  73    insertion and ejection events.  They are invoked from the atmel_cs
  74    event handler.
  75 */
  76
  77 static int atmel_config(struct pcmcia_device *link);
  78 static void atmel_release(struct pcmcia_device *link);
  79
  80 /*
  81    The attach() and detach() entry points are used to create and destroy
  82    "instances" of the driver, where each instance represents everything
  83    needed to manage one actual PCMCIA card.
  84 */
  85
  86 static void atmel_detach(struct pcmcia_device *p_dev);
  87
  88 typedef struct local_info_t {
  89         struct net_device *eth_dev;
  90 } local_info_t;
  91
  92 /*======================================================================
  93
  94   atmel_attach() creates an "instance" of the driver, allocating
  95   local data structures for one device.  The device is registered
  96   with Card Services.
  97
  98   The dev_link structure is initialized, but we don't actually
  99   configure the card at this point -- we wait until we receive a
 100   card insertion event.
 101
 102   ======================================================================*/
 103
 104 static int atmel_probe(struct pcmcia_device *p_dev)
 105 {
 106         local_info_t *local;
 107
 108         dev_dbg(&p_dev->dev, "atmel_attach()\n");
 109
 110         /*
 111           General socket configuration defaults can go here.  In this
 112           client, we assume very little, and rely on the CIS for almost
 113           everything.  In most clients, many details (i.e., number, sizes,
 114           and attributes of IO windows) are fixed by the nature of the
 115           device, and can be hard-wired here.
 116         */
 117         p_dev->conf.Attributes = 0;
 118         p_dev->conf.IntType = INT_MEMORY_AND_IO;
 119
 120         /* Allocate space for private device-specific data */
 121         local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
 122         if (!local) {
 123                 printk(KERN_ERR "atmel_cs: no memory for new device\n");
 124                 return -ENOMEM;
 125         }
 126         p_dev->priv = local;
 127
 128         return atmel_config(p_dev);
 129 } /* atmel_attach */
 130
 131 /*======================================================================
 132
 133   This deletes a driver "instance".  The device is de-registered
 134   with Card Services.  If it has been released, all local data
 135   structures are freed.  Otherwise, the structures will be freed
 136   when the device is released.
 137
 138   ======================================================================*/
 139
 140 static void atmel_detach(struct pcmcia_device *link)
 141 {
 142         dev_dbg(&link->dev, "atmel_detach\n");
 143
 144         atmel_release(link);
 145
 146         kfree(link->priv);
 147 }
 148
 149 /*======================================================================
 150
 151   atmel_config() is scheduled to run after a CARD_INSERTION event
 152   is received, to configure the PCMCIA socket, and to make the
 153   device available to the system.
 154
 155   ======================================================================*/
 156
 157 /* Call-back function to interrogate PCMCIA-specific information
 158    about the current existance of the card */
 159 static int card_present(void *arg)
 160 {
 161         struct pcmcia_device *link = (struct pcmcia_device *)arg;
 162
 163         if (pcmcia_dev_present(link))
 164                 return 1;
 165
 166         return 0;
 167 }
 168
 169 static int atmel_config_check(struct pcmcia_device *p_dev,
 170                               cistpl_cftable_entry_t *cfg,
 171                               cistpl_cftable_entry_t *dflt,
 172                               unsigned int vcc,
 173                               void *priv_data)
 174 {
 175         if (cfg->index == 0)
 176                 return -ENODEV;
 177
 178         /* Does this card need audio output? */
 179         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
 180                 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
 181                 p_dev->conf.Status = CCSR_AUDIO_ENA;
 182         }
 183
 184         /* Use power settings for Vcc and Vpp if present */
 185         /*  Note that the CIS values need to be rescaled */
 186         if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
 187                 p_dev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
 188         else if (dflt->vpp1.present & (1<<CISTPL_POWER_VNOM))
 189                 p_dev->conf.Vpp = dflt->vpp1.param[CISTPL_POWER_VNOM]/10000;
 190
 191         p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
 192
 193         /* IO window settings */
 194         p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
 195         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
 196                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
 197                 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 198                 if (!(io->flags & CISTPL_IO_8BIT))
 199                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
 200                 if (!(io->flags & CISTPL_IO_16BIT))
 201                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 202                 p_dev->io.BasePort1 = io->win[0].base;
 203                 p_dev->io.NumPorts1 = io->win[0].len;
 204                 if (io->nwin > 1) {
 205                         p_dev->io.Attributes2 = p_dev->io.Attributes1;
 206                         p_dev->io.BasePort2 = io->win[1].base;
 207                         p_dev->io.NumPorts2 = io->win[1].len;
 208                 }
 209         }
 210
 211         /* This reserves IO space but doesn't actually enable it */
 212         return pcmcia_request_io(p_dev, &p_dev->io);
 213 }
 214
 215 static int atmel_config(struct pcmcia_device *link)
 216 {
 217         local_info_t *dev;
 218         int ret;
 219         struct pcmcia_device_id *did;
 220
 221         dev = link->priv;
 222         did = dev_get_drvdata(&link->dev);
 223
 224         dev_dbg(&link->dev, "atmel_config\n");
 225
 226         /*
 227           In this loop, we scan the CIS for configuration table entries,
 228           each of which describes a valid card configuration, including
 229           voltage, IO window, memory window, and interrupt settings.
 230
 231           We make no assumptions about the card to be configured: we use
 232           just the information available in the CIS.  In an ideal world,
 233           this would work for any PCMCIA card, but it requires a complete
 234           and accurate CIS.  In practice, a driver usually "knows" most of
 235           these things without consulting the CIS, and most client drivers
 236           will only use the CIS to fill in implementation-defined details.
 237         */
 238         if (pcmcia_loop_config(link, atmel_config_check, NULL))
 239                 goto failed;
 240
 241         if (!link->irq) {
 242                 dev_err(&link->dev, "atmel: cannot assign IRQ: check that CONFIG_ISA is set in kernel config.");
 243                 goto failed;
 244         }
 245
 246         /*
 247           This actually configures the PCMCIA socket -- setting up
 248           the I/O windows and the interrupt mapping, and putting the
 249           card and host interface into "Memory and IO" mode.
 250         */
 251         ret = pcmcia_request_configuration(link, &link->conf);
 252         if (ret)
 253                 goto failed;
 254
 255         ((local_info_t*)link->priv)->eth_dev =
 256                 init_atmel_card(link->irq,
 257                                 link->io.BasePort1,
 258                                 did ? did->driver_info : ATMEL_FW_TYPE_NONE,
 259                                 &link->dev,
 260                                 card_present,
 261                                 link);
 262         if (!((local_info_t*)link->priv)->eth_dev)
 263                         goto failed;
 264
 265
 266         return 0;
 267
 268  failed:
 269         atmel_release(link);
 270         return -ENODEV;
 271 }
 272
 273 /*======================================================================
 274
 275   After a card is removed, atmel_release() will unregister the
 276   device, and release the PCMCIA configuration.  If the device is
 277   still open, this will be postponed until it is closed.
 278
 279   ======================================================================*/
 280
 281 static void atmel_release(struct pcmcia_device *link)
 282 {
 283         struct net_device *dev = ((local_info_t*)link->priv)->eth_dev;
 284
 285         dev_dbg(&link->dev, "atmel_release\n");
 286
 287         if (dev)
 288                 stop_atmel_card(dev);
 289         ((local_info_t*)link->priv)->eth_dev = NULL;
 290
 291         pcmcia_disable_device(link);
 292 }
 293
 294 static int atmel_suspend(struct pcmcia_device *link)
 295 {
 296         local_info_t *local = link->priv;
 297
 298         netif_device_detach(local->eth_dev);
 299
 300         return 0;
 301 }
 302
 303 static int atmel_resume(struct pcmcia_device *link)
 304 {
 305         local_info_t *local = link->priv;
 306
 307         atmel_open(local->eth_dev);
 308         netif_device_attach(local->eth_dev);
 309
 310         return 0;
 311 }
 312
 313 /*====================================================================*/
 314 /* We use the driver_info field to store the correct firmware type for a card. */
 315
 316 #define PCMCIA_DEVICE_MANF_CARD_INFO(manf, card, info) { \
 317         .match_flags = PCMCIA_DEV_ID_MATCH_MANF_ID| \
 318                         PCMCIA_DEV_ID_MATCH_CARD_ID, \
 319         .manf_id = (manf), \
 320         .card_id = (card), \
 321         .driver_info = (kernel_ulong_t)(info), }
 322
 323 #define PCMCIA_DEVICE_PROD_ID12_INFO(v1, v2, vh1, vh2, info) { \
 324         .match_flags = PCMCIA_DEV_ID_MATCH_PROD_ID1| \
 325                         PCMCIA_DEV_ID_MATCH_PROD_ID2, \
 326         .prod_id = { (v1), (v2), NULL, NULL }, \
 327         .prod_id_hash = { (vh1), (vh2), 0, 0 }, \
 328         .driver_info = (kernel_ulong_t)(info), }
 329
 330 static struct pcmcia_device_id atmel_ids[] = {
 331         PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0620, ATMEL_FW_TYPE_502_3COM),
 332         PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0696, ATMEL_FW_TYPE_502_3COM),
 333         PCMCIA_DEVICE_MANF_CARD_INFO(0x01bf, 0x3302, ATMEL_FW_TYPE_502E),
 334         PCMCIA_DEVICE_MANF_CARD_INFO(0xd601, 0x0007, ATMEL_FW_TYPE_502),
 335         PCMCIA_DEVICE_PROD_ID12_INFO("11WAVE", "11WP611AL-E", 0x9eb2da1f, 0xc9a0d3f9, ATMEL_FW_TYPE_502E),
 336         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR", 0xabda4164, 0x41b37e1f, ATMEL_FW_TYPE_502),
 337         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_D", 0xabda4164, 0x3675d704, ATMEL_FW_TYPE_502D),
 338         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_E", 0xabda4164, 0x4172e792, ATMEL_FW_TYPE_502E),
 339         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504_R", 0xabda4164, 0x917f3d72, ATMEL_FW_TYPE_504_2958),
 340         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504", 0xabda4164, 0x5040670a, ATMEL_FW_TYPE_504),
 341         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504A", 0xabda4164, 0xe15ed87f, ATMEL_FW_TYPE_504A_2958),
 342         PCMCIA_DEVICE_PROD_ID12_INFO("BT", "Voyager 1020 Laptop Adapter", 0xae49b86a, 0x1e957cd5, ATMEL_FW_TYPE_502),
 343         PCMCIA_DEVICE_PROD_ID12_INFO("CNet", "CNWLC 11Mbps Wireless PC Card V-5", 0xbc477dde, 0x502fae6b, ATMEL_FW_TYPE_502E),
 344         PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN PC Card", 0x5b878724, 0x122f1df6, ATMEL_FW_TYPE_502),
 345         PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN Card S", 0x5b878724, 0x5fba533a, ATMEL_FW_TYPE_504_2958),
 346         PCMCIA_DEVICE_PROD_ID12_INFO("OEM", "11Mbps Wireless LAN PC Card V-3", 0xfea54c90, 0x1c5b0f68, ATMEL_FW_TYPE_502),
 347         PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W", 0xc4f8b18b, 0x30f38774, ATMEL_FW_TYPE_502D),
 348         PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W-V2", 0xc4f8b18b, 0x172d1377, ATMEL_FW_TYPE_502),
 349         PCMCIA_DEVICE_PROD_ID12_INFO("Wireless", "PC_CARD", 0xa407ecdd, 0x119f6314, ATMEL_FW_TYPE_502D),
 350         PCMCIA_DEVICE_PROD_ID12_INFO("WLAN", "802.11b PC CARD", 0x575c516c, 0xb1f6dbc4, ATMEL_FW_TYPE_502D),
 351         PCMCIA_DEVICE_PROD_ID12_INFO("LG", "LW2100N", 0xb474d43a, 0x6b1fec94, ATMEL_FW_TYPE_502E),
 352         PCMCIA_DEVICE_NULL
 353 };
 354
 355 MODULE_DEVICE_TABLE(pcmcia, atmel_ids);
 356
 357 static struct pcmcia_driver atmel_driver = {
 358         .owner          = THIS_MODULE,
 359         .drv            = {
 360                 .name   = "atmel_cs",
 361         },
 362         .probe          = atmel_probe,
 363         .remove         = atmel_detach,
 364         .id_table       = atmel_ids,
 365         .suspend        = atmel_suspend,
 366         .resume         = atmel_resume,
 367 };
 368
 369 static int atmel_cs_init(void)
 370 {
 371         return pcmcia_register_driver(&atmel_driver);
 372 }
 373
 374 static void atmel_cs_cleanup(void)
 375 {
 376         pcmcia_unregister_driver(&atmel_driver);
 377 }
 378
 379 /*
 380     This program is free software; you can redistribute it and/or
 381     modify it under the terms of the GNU General Public License
 382     as published by the Free Software Foundation; either version 2
 383     of the License, or (at your option) any later version.
 384
 385     This program is distributed in the hope that it will be useful,
 386     but WITHOUT ANY WARRANTY; without even the implied warranty of
 387     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 388     GNU General Public License for more details.
 389
 390     In addition:
 391
 392     Redistribution and use in source and binary forms, with or without
 393     modification, are permitted provided that the following conditions
 394     are met:
 395
 396     1. Redistributions of source code must retain the above copyright
 397        notice, this list of conditions and the following disclaimer.
 398     2. Redistributions in binary form must reproduce the above copyright
 399        notice, this list of conditions and the following disclaimer in the
 400        documentation and/or other materials provided with the distribution.
 401     3. The name of the author may not be used to endorse or promote
 402        products derived from this software without specific prior written
 403        permission.
 404
 405     THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 406     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 407     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 408     ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
 409     INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 410     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 411     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 412     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 413     STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 414     IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 415     POSSIBILITY OF SUCH DAMAGE.
 416 */
 417
 418 module_init(atmel_cs_init);
 419 module_exit(atmel_cs_cleanup);