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