drivers/pcmcia/ds.c

   1 /*
   2  * ds.c -- 16-bit PCMCIA core support
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * The initial developer of the original code is David A. Hinds
   9  * <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
  10  * are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
  11  *
  12  * (C) 1999             David A. Hinds
  13  * (C) 2003 - 2006      Dominik Brodowski
  14  */
  15
  16 #include <linux/kernel.h>
  17 #include <linux/module.h>
  18 #include <linux/init.h>
  19 #include <linux/errno.h>
  20 #include <linux/list.h>
  21 #include <linux/delay.h>
  22 #include <linux/workqueue.h>
  23 #include <linux/crc32.h>
  24 #include <linux/firmware.h>
  25 #include <linux/kref.h>
  26
  27 #define IN_CARD_SERVICES
  28 #include <pcmcia/cs_types.h>
  29 #include <pcmcia/cs.h>
  30 #include <pcmcia/cistpl.h>
  31 #include <pcmcia/ds.h>
  32 #include <pcmcia/ss.h>
  33
  34 #include "cs_internal.h"
  35 #include "ds_internal.h"
  36
  37 /*====================================================================*/
  38
  39 /* Module parameters */
  40
  41 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
  42 MODULE_DESCRIPTION("PCMCIA Driver Services");
  43 MODULE_LICENSE("GPL");
  44
  45 #ifdef DEBUG
  46 int ds_pc_debug;
  47
  48 module_param_named(pc_debug, ds_pc_debug, int, 0644);
  49
  50 #define ds_dbg(lvl, fmt, arg...) do {                           \
  51         if (ds_pc_debug > (lvl))                                        \
  52                 printk(KERN_DEBUG "ds: " fmt , ## arg);         \
  53 } while (0)
  54 #else
  55 #define ds_dbg(lvl, fmt, arg...) do { } while (0)
  56 #endif
  57
  58 spinlock_t pcmcia_dev_list_lock;
  59
  60 /*====================================================================*/
  61
  62 /* code which was in cs.c before */
  63
  64 /* String tables for error messages */
  65
  66 typedef struct lookup_t {
  67     int key;
  68     char *msg;
  69 } lookup_t;
  70
  71 static const lookup_t error_table[] = {
  72     { CS_SUCCESS,               "Operation succeeded" },
  73     { CS_BAD_ADAPTER,           "Bad adapter" },
  74     { CS_BAD_ATTRIBUTE,         "Bad attribute", },
  75     { CS_BAD_BASE,              "Bad base address" },
  76     { CS_BAD_EDC,               "Bad EDC" },
  77     { CS_BAD_IRQ,               "Bad IRQ" },
  78     { CS_BAD_OFFSET,            "Bad offset" },
  79     { CS_BAD_PAGE,              "Bad page number" },
  80     { CS_READ_FAILURE,          "Read failure" },
  81     { CS_BAD_SIZE,              "Bad size" },
  82     { CS_BAD_SOCKET,            "Bad socket" },
  83     { CS_BAD_TYPE,              "Bad type" },
  84     { CS_BAD_VCC,               "Bad Vcc" },
  85     { CS_BAD_VPP,               "Bad Vpp" },
  86     { CS_BAD_WINDOW,            "Bad window" },
  87     { CS_WRITE_FAILURE,         "Write failure" },
  88     { CS_NO_CARD,               "No card present" },
  89     { CS_UNSUPPORTED_FUNCTION,  "Usupported function" },
  90     { CS_UNSUPPORTED_MODE,      "Unsupported mode" },
  91     { CS_BAD_SPEED,             "Bad speed" },
  92     { CS_BUSY,                  "Resource busy" },
  93     { CS_GENERAL_FAILURE,       "General failure" },
  94     { CS_WRITE_PROTECTED,       "Write protected" },
  95     { CS_BAD_ARG_LENGTH,        "Bad argument length" },
  96     { CS_BAD_ARGS,              "Bad arguments" },
  97     { CS_CONFIGURATION_LOCKED,  "Configuration locked" },
  98     { CS_IN_USE,                "Resource in use" },
  99     { CS_NO_MORE_ITEMS,         "No more items" },
 100     { CS_OUT_OF_RESOURCE,       "Out of resource" },
 101     { CS_BAD_HANDLE,            "Bad handle" },
 102     { CS_BAD_TUPLE,             "Bad CIS tuple" }
 103 };
 104
 105
 106 static const lookup_t service_table[] = {
 107     { AccessConfigurationRegister,      "AccessConfigurationRegister" },
 108     { AddSocketServices,                "AddSocketServices" },
 109     { AdjustResourceInfo,               "AdjustResourceInfo" },
 110     { CheckEraseQueue,                  "CheckEraseQueue" },
 111     { CloseMemory,                      "CloseMemory" },
 112     { DeregisterClient,                 "DeregisterClient" },
 113     { DeregisterEraseQueue,             "DeregisterEraseQueue" },
 114     { GetCardServicesInfo,              "GetCardServicesInfo" },
 115     { GetClientInfo,                    "GetClientInfo" },
 116     { GetConfigurationInfo,             "GetConfigurationInfo" },
 117     { GetEventMask,                     "GetEventMask" },
 118     { GetFirstClient,                   "GetFirstClient" },
 119     { GetFirstRegion,                   "GetFirstRegion" },
 120     { GetFirstTuple,                    "GetFirstTuple" },
 121     { GetNextClient,                    "GetNextClient" },
 122     { GetNextRegion,                    "GetNextRegion" },
 123     { GetNextTuple,                     "GetNextTuple" },
 124     { GetStatus,                        "GetStatus" },
 125     { GetTupleData,                     "GetTupleData" },
 126     { MapMemPage,                       "MapMemPage" },
 127     { ModifyConfiguration,              "ModifyConfiguration" },
 128     { ModifyWindow,                     "ModifyWindow" },
 129     { OpenMemory,                       "OpenMemory" },
 130     { ParseTuple,                       "ParseTuple" },
 131     { ReadMemory,                       "ReadMemory" },
 132     { RegisterClient,                   "RegisterClient" },
 133     { RegisterEraseQueue,               "RegisterEraseQueue" },
 134     { RegisterMTD,                      "RegisterMTD" },
 135     { ReleaseConfiguration,             "ReleaseConfiguration" },
 136     { ReleaseIO,                        "ReleaseIO" },
 137     { ReleaseIRQ,                       "ReleaseIRQ" },
 138     { ReleaseWindow,                    "ReleaseWindow" },
 139     { RequestConfiguration,             "RequestConfiguration" },
 140     { RequestIO,                        "RequestIO" },
 141     { RequestIRQ,                       "RequestIRQ" },
 142     { RequestSocketMask,                "RequestSocketMask" },
 143     { RequestWindow,                    "RequestWindow" },
 144     { ResetCard,                        "ResetCard" },
 145     { SetEventMask,                     "SetEventMask" },
 146     { ValidateCIS,                      "ValidateCIS" },
 147     { WriteMemory,                      "WriteMemory" },
 148     { BindDevice,                       "BindDevice" },
 149     { BindMTD,                          "BindMTD" },
 150     { ReportError,                      "ReportError" },
 151     { SuspendCard,                      "SuspendCard" },
 152     { ResumeCard,                       "ResumeCard" },
 153     { EjectCard,                        "EjectCard" },
 154     { InsertCard,                       "InsertCard" },
 155     { ReplaceCIS,                       "ReplaceCIS" }
 156 };
 157
 158
 159 static int pcmcia_report_error(struct pcmcia_device *p_dev, error_info_t *err)
 160 {
 161         int i;
 162         char *serv;
 163
 164         if (!p_dev)
 165                 printk(KERN_NOTICE);
 166         else
 167                 printk(KERN_NOTICE "%s: ", p_dev->dev.bus_id);
 168
 169         for (i = 0; i < ARRAY_SIZE(service_table); i++)
 170                 if (service_table[i].key == err->func)
 171                         break;
 172         if (i < ARRAY_SIZE(service_table))
 173                 serv = service_table[i].msg;
 174         else
 175                 serv = "Unknown service number";
 176
 177         for (i = 0; i < ARRAY_SIZE(error_table); i++)
 178                 if (error_table[i].key == err->retcode)
 179                         break;
 180         if (i < ARRAY_SIZE(error_table))
 181                 printk("%s: %s\n", serv, error_table[i].msg);
 182         else
 183                 printk("%s: Unknown error code %#x\n", serv, err->retcode);
 184
 185         return CS_SUCCESS;
 186 } /* report_error */
 187
 188 /* end of code which was in cs.c before */
 189
 190 /*======================================================================*/
 191
 192 void cs_error(struct pcmcia_device *p_dev, int func, int ret)
 193 {
 194         error_info_t err = { func, ret };
 195         pcmcia_report_error(p_dev, &err);
 196 }
 197 EXPORT_SYMBOL(cs_error);
 198
 199
 200 static void pcmcia_check_driver(struct pcmcia_driver *p_drv)
 201 {
 202         struct pcmcia_device_id *did = p_drv->id_table;
 203         unsigned int i;
 204         u32 hash;
 205
 206         if (!p_drv->probe || !p_drv->remove)
 207                 printk(KERN_DEBUG "pcmcia: %s lacks a requisite callback "
 208                        "function\n", p_drv->drv.name);
 209
 210         while (did && did->match_flags) {
 211                 for (i=0; i<4; i++) {
 212                         if (!did->prod_id[i])
 213                                 continue;
 214
 215                         hash = crc32(0, did->prod_id[i], strlen(did->prod_id[i]));
 216                         if (hash == did->prod_id_hash[i])
 217                                 continue;
 218
 219                         printk(KERN_DEBUG "pcmcia: %s: invalid hash for "
 220                                "product string \"%s\": is 0x%x, should "
 221                                "be 0x%x\n", p_drv->drv.name, did->prod_id[i],
 222                                did->prod_id_hash[i], hash);
 223                         printk(KERN_DEBUG "pcmcia: see "
 224                                 "Documentation/pcmcia/devicetable.txt for "
 225                                 "details\n");
 226                 }
 227                 did++;
 228         }
 229
 230         return;
 231 }
 232
 233
 234 #ifdef CONFIG_PCMCIA_LOAD_CIS
 235
 236 /**
 237  * pcmcia_load_firmware - load CIS from userspace if device-provided is broken
 238  * @dev - the pcmcia device which needs a CIS override
 239  * @filename - requested filename in /lib/firmware/cis/
 240  *
 241  * This uses the in-kernel firmware loading mechanism to use a "fake CIS" if
 242  * the one provided by the card is broken. The firmware files reside in
 243  * /lib/firmware/cis/ in userspace.
 244  */
 245 static int pcmcia_load_firmware(struct pcmcia_device *dev, char * filename)
 246 {
 247         struct pcmcia_socket *s = dev->socket;
 248         const struct firmware *fw;
 249         char path[20];
 250         int ret=-ENOMEM;
 251         cisdump_t *cis;
 252
 253         if (!filename)
 254                 return -EINVAL;
 255
 256         ds_dbg(1, "trying to load firmware %s\n", filename);
 257
 258         if (strlen(filename) > 14)
 259                 return -EINVAL;
 260
 261         snprintf(path, 20, "%s", filename);
 262
 263         if (request_firmware(&fw, path, &dev->dev) == 0) {
 264                 if (fw->size >= CISTPL_MAX_CIS_SIZE)
 265                         goto release;
 266
 267                 cis = kzalloc(sizeof(cisdump_t), GFP_KERNEL);
 268                 if (!cis)
 269                         goto release;
 270
 271                 cis->Length = fw->size + 1;
 272                 memcpy(cis->Data, fw->data, fw->size);
 273
 274                 if (!pcmcia_replace_cis(s, cis))
 275                         ret = 0;
 276         }
 277  release:
 278         release_firmware(fw);
 279
 280         return (ret);
 281 }
 282
 283 #else /* !CONFIG_PCMCIA_LOAD_CIS */
 284
 285 static inline int pcmcia_load_firmware(struct pcmcia_device *dev, char * filename)
 286 {
 287         return -ENODEV;
 288 }
 289
 290 #endif
 291
 292
 293 /*======================================================================*/
 294
 295
 296 /**
 297  * pcmcia_register_driver - register a PCMCIA driver with the bus core
 298  *
 299  * Registers a PCMCIA driver with the PCMCIA bus core.
 300  */
 301 static int pcmcia_device_probe(struct device *dev);
 302 static int pcmcia_device_remove(struct device * dev);
 303
 304 int pcmcia_register_driver(struct pcmcia_driver *driver)
 305 {
 306         if (!driver)
 307                 return -EINVAL;
 308
 309         pcmcia_check_driver(driver);
 310
 311         /* initialize common fields */
 312         driver->drv.bus = &pcmcia_bus_type;
 313         driver->drv.owner = driver->owner;
 314
 315         return driver_register(&driver->drv);
 316 }
 317 EXPORT_SYMBOL(pcmcia_register_driver);
 318
 319 /**
 320  * pcmcia_unregister_driver - unregister a PCMCIA driver with the bus core
 321  */
 322 void pcmcia_unregister_driver(struct pcmcia_driver *driver)
 323 {
 324         driver_unregister(&driver->drv);
 325 }
 326 EXPORT_SYMBOL(pcmcia_unregister_driver);
 327
 328
 329 /* pcmcia_device handling */
 330
 331 struct pcmcia_device * pcmcia_get_dev(struct pcmcia_device *p_dev)
 332 {
 333         struct device *tmp_dev;
 334         tmp_dev = get_device(&p_dev->dev);
 335         if (!tmp_dev)
 336                 return NULL;
 337         return to_pcmcia_dev(tmp_dev);
 338 }
 339
 340 void pcmcia_put_dev(struct pcmcia_device *p_dev)
 341 {
 342         if (p_dev)
 343                 put_device(&p_dev->dev);
 344 }
 345
 346 static void pcmcia_release_function(struct kref *ref)
 347 {
 348         struct config_t *c = container_of(ref, struct config_t, ref);
 349         kfree(c);
 350 }
 351
 352 static void pcmcia_release_dev(struct device *dev)
 353 {
 354         struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
 355         ds_dbg(1, "releasing dev %p\n", p_dev);
 356         pcmcia_put_socket(p_dev->socket);
 357         kfree(p_dev->devname);
 358         kref_put(&p_dev->function_config->ref, pcmcia_release_function);
 359         kfree(p_dev);
 360 }
 361
 362 static void pcmcia_add_pseudo_device(struct pcmcia_socket *s)
 363 {
 364         if (!s->pcmcia_state.device_add_pending) {
 365                 s->pcmcia_state.device_add_pending = 1;
 366                 schedule_work(&s->device_add);
 367         }
 368         return;
 369 }
 370
 371 static int pcmcia_device_probe(struct device * dev)
 372 {
 373         struct pcmcia_device *p_dev;
 374         struct pcmcia_driver *p_drv;
 375         struct pcmcia_device_id *did;
 376         struct pcmcia_socket *s;
 377         int ret = 0;
 378
 379         dev = get_device(dev);
 380         if (!dev)
 381                 return -ENODEV;
 382
 383         p_dev = to_pcmcia_dev(dev);
 384         p_drv = to_pcmcia_drv(dev->driver);
 385         s = p_dev->socket;
 386
 387         if ((!p_drv->probe) || (!p_dev->function_config) ||
 388             (!try_module_get(p_drv->owner))) {
 389                 ret = -EINVAL;
 390                 goto put_dev;
 391         }
 392
 393         ret = p_drv->probe(p_dev);
 394         if (ret)
 395                 goto put_module;
 396
 397         /* handle pseudo multifunction devices:
 398          * there are at most two pseudo multifunction devices.
 399          * if we're matching against the first, schedule a
 400          * call which will then check whether there are two
 401          * pseudo devices, and if not, add the second one.
 402          */
 403         did = (struct pcmcia_device_id *) p_dev->dev.driver_data;
 404         if (did && (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) &&
 405             (p_dev->socket->device_count == 1) && (p_dev->device_no == 0))
 406                 pcmcia_add_pseudo_device(p_dev->socket);
 407
 408  put_module:
 409         if (ret)
 410                 module_put(p_drv->owner);
 411  put_dev:
 412         if (ret)
 413                 put_device(dev);
 414         return (ret);
 415 }
 416
 417
 418 static int pcmcia_device_remove(struct device * dev)
 419 {
 420         struct pcmcia_device *p_dev;
 421         struct pcmcia_driver *p_drv;
 422         int i;
 423
 424         /* detach the "instance" */
 425         p_dev = to_pcmcia_dev(dev);
 426         p_drv = to_pcmcia_drv(dev->driver);
 427         if (!p_drv)
 428                 return 0;
 429
 430         if (p_drv->remove)
 431                 p_drv->remove(p_dev);
 432
 433         /* check for proper unloading */
 434         if (p_dev->_irq || p_dev->_io || p_dev->_locked)
 435                 printk(KERN_INFO "pcmcia: driver %s did not release config properly\n",
 436                        p_drv->drv.name);
 437
 438         for (i = 0; i < MAX_WIN; i++)
 439                 if (p_dev->_win & CLIENT_WIN_REQ(i))
 440                         printk(KERN_INFO "pcmcia: driver %s did not release windows properly\n",
 441                                p_drv->drv.name);
 442
 443         /* references from pcmcia_probe_device */
 444         pcmcia_put_dev(p_dev);
 445         module_put(p_drv->owner);
 446
 447         return 0;
 448 }
 449
 450
 451 /*
 452  * Removes a PCMCIA card from the device tree and socket list.
 453  */
 454 static void pcmcia_card_remove(struct pcmcia_socket *s)
 455 {
 456         struct pcmcia_device    *p_dev;
 457         unsigned long           flags;
 458
 459         ds_dbg(2, "unbind_request(%d)\n", s->sock);
 460
 461         s->device_count = 0;
 462
 463         for (;;) {
 464                 /* unregister all pcmcia_devices registered with this socket*/
 465                 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
 466                 if (list_empty(&s->devices_list)) {
 467                         spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
 468                         return;
 469                 }
 470                 p_dev = list_entry((&s->devices_list)->next, struct pcmcia_device, socket_device_list);
 471                 list_del(&p_dev->socket_device_list);
 472                 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
 473
 474                 device_unregister(&p_dev->dev);
 475         }
 476
 477         return;
 478 } /* unbind_request */
 479
 480
 481 /*
 482  * pcmcia_device_query -- determine information about a pcmcia device
 483  */
 484 static int pcmcia_device_query(struct pcmcia_device *p_dev)
 485 {
 486         cistpl_manfid_t manf_id;
 487         cistpl_funcid_t func_id;
 488         cistpl_vers_1_t *vers1;
 489         unsigned int i;
 490
 491         vers1 = kmalloc(sizeof(*vers1), GFP_KERNEL);
 492         if (!vers1)
 493                 return -ENOMEM;
 494
 495         if (!pccard_read_tuple(p_dev->socket, p_dev->func,
 496                                CISTPL_MANFID, &manf_id)) {
 497                 p_dev->manf_id = manf_id.manf;
 498                 p_dev->card_id = manf_id.card;
 499                 p_dev->has_manf_id = 1;
 500                 p_dev->has_card_id = 1;
 501         }
 502
 503         if (!pccard_read_tuple(p_dev->socket, p_dev->func,
 504                                CISTPL_FUNCID, &func_id)) {
 505                 p_dev->func_id = func_id.func;
 506                 p_dev->has_func_id = 1;
 507         } else {
 508                 /* rule of thumb: cards with no FUNCID, but with
 509                  * common memory device geometry information, are
 510                  * probably memory cards (from pcmcia-cs) */
 511                 cistpl_device_geo_t *devgeo;
 512
 513                 devgeo = kmalloc(sizeof(*devgeo), GFP_KERNEL);
 514                 if (!devgeo) {
 515                         kfree(vers1);
 516                         return -ENOMEM;
 517                 }
 518                 if (!pccard_read_tuple(p_dev->socket, p_dev->func,
 519                                       CISTPL_DEVICE_GEO, devgeo)) {
 520                         ds_dbg(0, "mem device geometry probably means "
 521                                "FUNCID_MEMORY\n");
 522                         p_dev->func_id = CISTPL_FUNCID_MEMORY;
 523                         p_dev->has_func_id = 1;
 524                 }
 525                 kfree(devgeo);
 526         }
 527
 528         if (!pccard_read_tuple(p_dev->socket, p_dev->func, CISTPL_VERS_1,
 529                                vers1)) {
 530                 for (i=0; i < vers1->ns; i++) {
 531                         char *tmp;
 532                         unsigned int length;
 533
 534                         tmp = vers1->str + vers1->ofs[i];
 535
 536                         length = strlen(tmp) + 1;
 537                         if ((length < 2) || (length > 255))
 538                                 continue;
 539
 540                         p_dev->prod_id[i] = kmalloc(sizeof(char) * length,
 541                                                     GFP_KERNEL);
 542                         if (!p_dev->prod_id[i])
 543                                 continue;
 544
 545                         p_dev->prod_id[i] = strncpy(p_dev->prod_id[i],
 546                                                     tmp, length);
 547                 }
 548         }
 549
 550         kfree(vers1);
 551         return 0;
 552 }
 553
 554
 555 /* device_add_lock is needed to avoid double registration by cardmgr and kernel.
 556  * Serializes pcmcia_device_add; will most likely be removed in future.
 557  *
 558  * While it has the caveat that adding new PCMCIA devices inside(!) device_register()
 559  * won't work, this doesn't matter much at the moment: the driver core doesn't
 560  * support it either.
 561  */
 562 static DEFINE_MUTEX(device_add_lock);
 563
 564 struct pcmcia_device * pcmcia_device_add(struct pcmcia_socket *s, unsigned int function)
 565 {
 566         struct pcmcia_device *p_dev, *tmp_dev;
 567         unsigned long flags;
 568         int bus_id_len;
 569
 570         s = pcmcia_get_socket(s);
 571         if (!s)
 572                 return NULL;
 573
 574         mutex_lock(&device_add_lock);
 575
 576         /* max of 2 devices per card */
 577         if (s->device_count == 2)
 578                 goto err_put;
 579
 580         p_dev = kzalloc(sizeof(struct pcmcia_device), GFP_KERNEL);
 581         if (!p_dev)
 582                 goto err_put;
 583
 584         p_dev->socket = s;
 585         p_dev->device_no = (s->device_count++);
 586         p_dev->func   = function;
 587         if (s->functions <= function)
 588                 s->functions = function + 1;
 589
 590         p_dev->dev.bus = &pcmcia_bus_type;
 591         p_dev->dev.parent = s->dev.dev;
 592         p_dev->dev.release = pcmcia_release_dev;
 593         bus_id_len = sprintf (p_dev->dev.bus_id, "%d.%d", p_dev->socket->sock, p_dev->device_no);
 594
 595         p_dev->devname = kmalloc(6 + bus_id_len + 1, GFP_KERNEL);
 596         if (!p_dev->devname)
 597                 goto err_free;
 598         sprintf (p_dev->devname, "pcmcia%s", p_dev->dev.bus_id);
 599
 600         /* compat */
 601         spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
 602
 603         /*
 604          * p_dev->function_config must be the same for all card functions.
 605          * Note that this is serialized by the device_add_lock, so that
 606          * only one such struct will be created.
 607          */
 608         list_for_each_entry(tmp_dev, &s->devices_list, socket_device_list)
 609                 if (p_dev->func == tmp_dev->func) {
 610                         p_dev->function_config = tmp_dev->function_config;
 611                         kref_get(&p_dev->function_config->ref);
 612                 }
 613
 614         /* Add to the list in pcmcia_bus_socket */
 615         list_add_tail(&p_dev->socket_device_list, &s->devices_list);
 616
 617         spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
 618
 619         if (!p_dev->function_config) {
 620                 p_dev->function_config = kzalloc(sizeof(struct config_t),
 621                                                  GFP_KERNEL);
 622                 if (!p_dev->function_config)
 623                         goto err_unreg;
 624                 kref_init(&p_dev->function_config->ref);
 625         }
 626
 627         printk(KERN_NOTICE "pcmcia: registering new device %s\n",
 628                p_dev->devname);
 629
 630         pcmcia_device_query(p_dev);
 631
 632         if (device_register(&p_dev->dev))
 633                 goto err_unreg;
 634
 635         mutex_unlock(&device_add_lock);
 636
 637         return p_dev;
 638
 639  err_unreg:
 640         spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
 641         list_del(&p_dev->socket_device_list);
 642         spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
 643
 644  err_free:
 645         kfree(p_dev->devname);
 646         kfree(p_dev);
 647         s->device_count--;
 648  err_put:
 649         mutex_unlock(&device_add_lock);
 650         pcmcia_put_socket(s);
 651
 652         return NULL;
 653 }
 654
 655
 656 static int pcmcia_card_add(struct pcmcia_socket *s)
 657 {
 658         cisinfo_t cisinfo;
 659         cistpl_longlink_mfc_t mfc;
 660         unsigned int no_funcs, i;
 661         int ret = 0;
 662
 663         if (!(s->resource_setup_done))
 664                 return -EAGAIN; /* try again, but later... */
 665
 666         if (pcmcia_validate_mem(s))
 667                 return -EAGAIN; /* try again, but later... */
 668
 669         ret = pccard_validate_cis(s, BIND_FN_ALL, &cisinfo);
 670         if (ret || !cisinfo.Chains) {
 671                 ds_dbg(0, "invalid CIS or invalid resources\n");
 672                 return -ENODEV;
 673         }
 674
 675         if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC, &mfc))
 676                 no_funcs = mfc.nfn;
 677         else
 678                 no_funcs = 1;
 679
 680         for (i=0; i < no_funcs; i++)
 681                 pcmcia_device_add(s, i);
 682
 683         return (ret);
 684 }
 685
 686
 687 static void pcmcia_delayed_add_pseudo_device(void *data)
 688 {
 689         struct pcmcia_socket *s = data;
 690         pcmcia_device_add(s, 0);
 691         s->pcmcia_state.device_add_pending = 0;
 692 }
 693
 694 static int pcmcia_requery(struct device *dev, void * _data)
 695 {
 696         struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
 697         if (!p_dev->dev.driver)
 698                 pcmcia_device_query(p_dev);
 699
 700         return 0;
 701 }
 702
 703 static void pcmcia_bus_rescan(struct pcmcia_socket *skt)
 704 {
 705         int no_devices=0;
 706         unsigned long flags;
 707
 708         /* must be called with skt_mutex held */
 709         spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
 710         if (list_empty(&skt->devices_list))
 711                 no_devices=1;
 712         spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
 713
 714         /* if no devices were added for this socket yet because of
 715          * missing resource information or other trouble, we need to
 716          * do this now. */
 717         if (no_devices) {
 718                 int ret = pcmcia_card_add(skt);
 719                 if (ret)
 720                         return;
 721         }
 722
 723         /* some device information might have changed because of a CIS
 724          * update or because we can finally read it correctly... so
 725          * determine it again, overwriting old values if necessary. */
 726         bus_for_each_dev(&pcmcia_bus_type, NULL, NULL, pcmcia_requery);
 727
 728         /* we re-scan all devices, not just the ones connected to this
 729          * socket. This does not matter, though. */
 730         bus_rescan_devices(&pcmcia_bus_type);
 731 }
 732
 733 static inline int pcmcia_devmatch(struct pcmcia_device *dev,
 734                                   struct pcmcia_device_id *did)
 735 {
 736         if (did->match_flags & PCMCIA_DEV_ID_MATCH_MANF_ID) {
 737                 if ((!dev->has_manf_id) || (dev->manf_id != did->manf_id))
 738                         return 0;
 739         }
 740
 741         if (did->match_flags & PCMCIA_DEV_ID_MATCH_CARD_ID) {
 742                 if ((!dev->has_card_id) || (dev->card_id != did->card_id))
 743                         return 0;
 744         }
 745
 746         if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNCTION) {
 747                 if (dev->func != did->function)
 748                         return 0;
 749         }
 750
 751         if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID1) {
 752                 if (!dev->prod_id[0])
 753                         return 0;
 754                 if (strcmp(did->prod_id[0], dev->prod_id[0]))
 755                         return 0;
 756         }
 757
 758         if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID2) {
 759                 if (!dev->prod_id[1])
 760                         return 0;
 761                 if (strcmp(did->prod_id[1], dev->prod_id[1]))
 762                         return 0;
 763         }
 764
 765         if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID3) {
 766                 if (!dev->prod_id[2])
 767                         return 0;
 768                 if (strcmp(did->prod_id[2], dev->prod_id[2]))
 769                         return 0;
 770         }
 771
 772         if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID4) {
 773                 if (!dev->prod_id[3])
 774                         return 0;
 775                 if (strcmp(did->prod_id[3], dev->prod_id[3]))
 776                         return 0;
 777         }
 778
 779         if (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) {
 780                 if (dev->device_no != did->device_no)
 781                         return 0;
 782         }
 783
 784         if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNC_ID) {
 785                 if ((!dev->has_func_id) || (dev->func_id != did->func_id))
 786                         return 0;
 787
 788                 /* if this is a pseudo-multi-function device,
 789                  * we need explicit matches */
 790                 if (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO)
 791                         return 0;
 792                 if (dev->device_no)
 793                         return 0;
 794
 795                 /* also, FUNC_ID matching needs to be activated by userspace
 796                  * after it has re-checked that there is no possible module
 797                  * with a prod_id/manf_id/card_id match.
 798                  */
 799                 if (!dev->allow_func_id_match)
 800                         return 0;
 801         }
 802
 803         if (did->match_flags & PCMCIA_DEV_ID_MATCH_FAKE_CIS) {
 804                 if (!dev->socket->fake_cis)
 805                         pcmcia_load_firmware(dev, did->cisfile);
 806
 807                 if (!dev->socket->fake_cis)
 808                         return 0;
 809         }
 810
 811         if (did->match_flags & PCMCIA_DEV_ID_MATCH_ANONYMOUS) {
 812                 int i;
 813                 for (i=0; i<4; i++)
 814                         if (dev->prod_id[i])
 815                                 return 0;
 816                 if (dev->has_manf_id || dev->has_card_id || dev->has_func_id)
 817                         return 0;
 818         }
 819
 820         dev->dev.driver_data = (void *) did;
 821
 822         return 1;
 823 }
 824
 825
 826 static int pcmcia_bus_match(struct device * dev, struct device_driver * drv) {
 827         struct pcmcia_device * p_dev = to_pcmcia_dev(dev);
 828         struct pcmcia_driver * p_drv = to_pcmcia_drv(drv);
 829         struct pcmcia_device_id *did = p_drv->id_table;
 830
 831 #ifdef CONFIG_PCMCIA_IOCTL
 832         /* matching by cardmgr */
 833         if (p_dev->cardmgr == p_drv)
 834                 return 1;
 835 #endif
 836
 837         while (did && did->match_flags) {
 838                 if (pcmcia_devmatch(p_dev, did))
 839                         return 1;
 840                 did++;
 841         }
 842
 843         return 0;
 844 }
 845
 846 #ifdef CONFIG_HOTPLUG
 847
 848 static int pcmcia_bus_uevent(struct device *dev, char **envp, int num_envp,
 849                              char *buffer, int buffer_size)
 850 {
 851         struct pcmcia_device *p_dev;
 852         int i, length = 0;
 853         u32 hash[4] = { 0, 0, 0, 0};
 854
 855         if (!dev)
 856                 return -ENODEV;
 857
 858         p_dev = to_pcmcia_dev(dev);
 859
 860         /* calculate hashes */
 861         for (i=0; i<4; i++) {
 862                 if (!p_dev->prod_id[i])
 863                         continue;
 864                 hash[i] = crc32(0, p_dev->prod_id[i], strlen(p_dev->prod_id[i]));
 865         }
 866
 867         i = 0;
 868
 869         if (add_uevent_var(envp, num_envp, &i,
 870                            buffer, buffer_size, &length,
 871                            "SOCKET_NO=%u",
 872                            p_dev->socket->sock))
 873                 return -ENOMEM;
 874
 875         if (add_uevent_var(envp, num_envp, &i,
 876                            buffer, buffer_size, &length,
 877                            "DEVICE_NO=%02X",
 878                            p_dev->device_no))
 879                 return -ENOMEM;
 880
 881         if (add_uevent_var(envp, num_envp, &i,
 882                            buffer, buffer_size, &length,
 883                            "MODALIAS=pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
 884                            "pa%08Xpb%08Xpc%08Xpd%08X",
 885                            p_dev->has_manf_id ? p_dev->manf_id : 0,
 886                            p_dev->has_card_id ? p_dev->card_id : 0,
 887                            p_dev->has_func_id ? p_dev->func_id : 0,
 888                            p_dev->func,
 889                            p_dev->device_no,
 890                            hash[0],
 891                            hash[1],
 892                            hash[2],
 893                            hash[3]))
 894                 return -ENOMEM;
 895
 896         envp[i] = NULL;
 897
 898         return 0;
 899 }
 900
 901 #else
 902
 903 static int pcmcia_bus_uevent(struct device *dev, char **envp, int num_envp,
 904                               char *buffer, int buffer_size)
 905 {
 906         return -ENODEV;
 907 }
 908
 909 #endif
 910
 911 /************************ per-device sysfs output ***************************/
 912
 913 #define pcmcia_device_attr(field, test, format)                         \
 914 static ssize_t field##_show (struct device *dev, struct device_attribute *attr, char *buf)              \
 915 {                                                                       \
 916         struct pcmcia_device *p_dev = to_pcmcia_dev(dev);               \
 917         return p_dev->test ? sprintf (buf, format, p_dev->field) : -ENODEV; \
 918 }
 919
 920 #define pcmcia_device_stringattr(name, field)                                   \
 921 static ssize_t name##_show (struct device *dev, struct device_attribute *attr, char *buf)               \
 922 {                                                                       \
 923         struct pcmcia_device *p_dev = to_pcmcia_dev(dev);               \
 924         return p_dev->field ? sprintf (buf, "%s\n", p_dev->field) : -ENODEV; \
 925 }
 926
 927 pcmcia_device_attr(func, socket, "0x%02x\n");
 928 pcmcia_device_attr(func_id, has_func_id, "0x%02x\n");
 929 pcmcia_device_attr(manf_id, has_manf_id, "0x%04x\n");
 930 pcmcia_device_attr(card_id, has_card_id, "0x%04x\n");
 931 pcmcia_device_stringattr(prod_id1, prod_id[0]);
 932 pcmcia_device_stringattr(prod_id2, prod_id[1]);
 933 pcmcia_device_stringattr(prod_id3, prod_id[2]);
 934 pcmcia_device_stringattr(prod_id4, prod_id[3]);
 935
 936
 937 static ssize_t pcmcia_show_pm_state(struct device *dev, struct device_attribute *attr, char *buf)
 938 {
 939         struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
 940
 941         if (p_dev->suspended)
 942                 return sprintf(buf, "off\n");
 943         else
 944                 return sprintf(buf, "on\n");
 945 }
 946
 947 static ssize_t pcmcia_store_pm_state(struct device *dev, struct device_attribute *attr,
 948                                      const char *buf, size_t count)
 949 {
 950         struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
 951         int ret = 0;
 952
 953         if (!count)
 954                 return -EINVAL;
 955
 956         if ((!p_dev->suspended) && !strncmp(buf, "off", 3))
 957                 ret = dpm_runtime_suspend(dev, PMSG_SUSPEND);
 958         else if (p_dev->suspended && !strncmp(buf, "on", 2))
 959                 dpm_runtime_resume(dev);
 960
 961         return ret ? ret : count;
 962 }
 963
 964
 965 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
 966 {
 967         struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
 968         int i;
 969         u32 hash[4] = { 0, 0, 0, 0};
 970
 971         /* calculate hashes */
 972         for (i=0; i<4; i++) {
 973                 if (!p_dev->prod_id[i])
 974                         continue;
 975                 hash[i] = crc32(0,p_dev->prod_id[i],strlen(p_dev->prod_id[i]));
 976         }
 977         return sprintf(buf, "pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
 978                                 "pa%08Xpb%08Xpc%08Xpd%08X\n",
 979                                 p_dev->has_manf_id ? p_dev->manf_id : 0,
 980                                 p_dev->has_card_id ? p_dev->card_id : 0,
 981                                 p_dev->has_func_id ? p_dev->func_id : 0,
 982                                 p_dev->func, p_dev->device_no,
 983                                 hash[0], hash[1], hash[2], hash[3]);
 984 }
 985
 986 static ssize_t pcmcia_store_allow_func_id_match(struct device *dev,
 987                 struct device_attribute *attr, const char *buf, size_t count)
 988 {
 989         struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
 990
 991         if (!count)
 992                 return -EINVAL;
 993
 994         mutex_lock(&p_dev->socket->skt_mutex);
 995         p_dev->allow_func_id_match = 1;
 996         mutex_unlock(&p_dev->socket->skt_mutex);
 997
 998         bus_rescan_devices(&pcmcia_bus_type);
 999
1000         return count;
1001 }
1002
1003 static struct device_attribute pcmcia_dev_attrs[] = {
1004         __ATTR(function, 0444, func_show, NULL),
1005         __ATTR(pm_state, 0644, pcmcia_show_pm_state, pcmcia_store_pm_state),
1006         __ATTR_RO(func_id),
1007         __ATTR_RO(manf_id),
1008         __ATTR_RO(card_id),
1009         __ATTR_RO(prod_id1),
1010         __ATTR_RO(prod_id2),
1011         __ATTR_RO(prod_id3),
1012         __ATTR_RO(prod_id4),
1013         __ATTR_RO(modalias),
1014         __ATTR(allow_func_id_match, 0200, NULL, pcmcia_store_allow_func_id_match),
1015         __ATTR_NULL,
1016 };
1017
1018 /* PM support, also needed for reset */
1019
1020 static int pcmcia_dev_suspend(struct device * dev, pm_message_t state)
1021 {
1022         struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1023         struct pcmcia_driver *p_drv = NULL;
1024         int ret = 0;
1025
1026         if (dev->driver)
1027                 p_drv = to_pcmcia_drv(dev->driver);
1028
1029         if (!p_drv)
1030                 goto out;
1031
1032         if (p_drv->suspend) {
1033                 ret = p_drv->suspend(p_dev);
1034                 if (ret)
1035                         goto out;
1036         }
1037
1038         if (p_dev->device_no == p_dev->func)
1039                 pcmcia_release_configuration(p_dev);
1040
1041  out:
1042         if (!ret)
1043                 p_dev->suspended = 1;
1044         return ret;
1045 }
1046
1047
1048 static int pcmcia_dev_resume(struct device * dev)
1049 {
1050         struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1051         struct pcmcia_driver *p_drv = NULL;
1052         int ret = 0;
1053
1054         if (dev->driver)
1055                 p_drv = to_pcmcia_drv(dev->driver);
1056
1057         if (!p_drv)
1058                 goto out;
1059
1060         if (p_dev->device_no == p_dev->func) {
1061                 ret = pcmcia_request_configuration(p_dev, &p_dev->conf);
1062                 if (ret)
1063                         goto out;
1064         }
1065
1066         if (p_drv->resume)
1067                 ret = p_drv->resume(p_dev);
1068
1069  out:
1070         if (!ret)
1071                 p_dev->suspended = 0;
1072         return ret;
1073 }
1074
1075
1076 static int pcmcia_bus_suspend_callback(struct device *dev, void * _data)
1077 {
1078         struct pcmcia_socket *skt = _data;
1079         struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1080
1081         if (p_dev->socket != skt)
1082                 return 0;
1083
1084         return dpm_runtime_suspend(dev, PMSG_SUSPEND);
1085 }
1086
1087 static int pcmcia_bus_resume_callback(struct device *dev, void * _data)
1088 {
1089         struct pcmcia_socket *skt = _data;
1090         struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1091
1092         if (p_dev->socket != skt)
1093                 return 0;
1094
1095         dpm_runtime_resume(dev);
1096
1097         return 0;
1098 }
1099
1100 static int pcmcia_bus_resume(struct pcmcia_socket *skt)
1101 {
1102         bus_for_each_dev(&pcmcia_bus_type, NULL, skt, pcmcia_bus_resume_callback);
1103         return 0;
1104 }
1105
1106 static int pcmcia_bus_suspend(struct pcmcia_socket *skt)
1107 {
1108         if (bus_for_each_dev(&pcmcia_bus_type, NULL, skt,
1109                              pcmcia_bus_suspend_callback)) {
1110                 pcmcia_bus_resume(skt);
1111                 return -EIO;
1112         }
1113         return 0;
1114 }
1115
1116
1117 /*======================================================================
1118
1119     The card status event handler.
1120
1121 ======================================================================*/
1122
1123 /* Normally, the event is passed to individual drivers after
1124  * informing userspace. Only for CS_EVENT_CARD_REMOVAL this
1125  * is inversed to maintain historic compatibility.
1126  */
1127
1128 static int ds_event(struct pcmcia_socket *skt, event_t event, int priority)
1129 {
1130         struct pcmcia_socket *s = pcmcia_get_socket(skt);
1131
1132         ds_dbg(1, "ds_event(0x%06x, %d, 0x%p)\n",
1133                event, priority, skt);
1134
1135         switch (event) {
1136         case CS_EVENT_CARD_REMOVAL:
1137                 s->pcmcia_state.present = 0;
1138                 pcmcia_card_remove(skt);
1139                 handle_event(skt, event);
1140                 break;
1141
1142         case CS_EVENT_CARD_INSERTION:
1143                 s->pcmcia_state.present = 1;
1144                 pcmcia_card_add(skt);
1145                 handle_event(skt, event);
1146                 break;
1147
1148         case CS_EVENT_EJECTION_REQUEST:
1149                 break;
1150
1151         case CS_EVENT_PM_SUSPEND:
1152         case CS_EVENT_PM_RESUME:
1153         case CS_EVENT_RESET_PHYSICAL:
1154         case CS_EVENT_CARD_RESET:
1155         default:
1156                 handle_event(skt, event);
1157                 break;
1158     }
1159
1160     pcmcia_put_socket(s);
1161
1162     return 0;
1163 } /* ds_event */
1164
1165
1166 static struct pcmcia_callback pcmcia_bus_callback = {
1167         .owner = THIS_MODULE,
1168         .event = ds_event,
1169         .requery = pcmcia_bus_rescan,
1170         .suspend = pcmcia_bus_suspend,
1171         .resume = pcmcia_bus_resume,
1172 };
1173
1174 static int __devinit pcmcia_bus_add_socket(struct class_device *class_dev,
1175                                            struct class_interface *class_intf)
1176 {
1177         struct pcmcia_socket *socket = class_get_devdata(class_dev);
1178         int ret;
1179
1180         socket = pcmcia_get_socket(socket);
1181         if (!socket) {
1182                 printk(KERN_ERR "PCMCIA obtaining reference to socket %p failed\n", socket);
1183                 return -ENODEV;
1184         }
1185
1186         /*
1187          * Ugly. But we want to wait for the socket threads to have started up.
1188          * We really should let the drivers themselves drive some of this..
1189          */
1190         msleep(250);
1191
1192 #ifdef CONFIG_PCMCIA_IOCTL
1193         init_waitqueue_head(&socket->queue);
1194 #endif
1195         INIT_LIST_HEAD(&socket->devices_list);
1196         INIT_WORK(&socket->device_add, pcmcia_delayed_add_pseudo_device, socket);
1197         memset(&socket->pcmcia_state, 0, sizeof(u8));
1198         socket->device_count = 0;
1199
1200         ret = pccard_register_pcmcia(socket, &pcmcia_bus_callback);
1201         if (ret) {
1202                 printk(KERN_ERR "PCMCIA registration PCCard core failed for socket %p\n", socket);
1203                 pcmcia_put_socket(socket);
1204                 return (ret);
1205         }
1206
1207         return 0;
1208 }
1209
1210 static void pcmcia_bus_remove_socket(struct class_device *class_dev,
1211                                      struct class_interface *class_intf)
1212 {
1213         struct pcmcia_socket *socket = class_get_devdata(class_dev);
1214
1215         if (!socket)
1216                 return;
1217
1218         socket->pcmcia_state.dead = 1;
1219         pccard_register_pcmcia(socket, NULL);
1220
1221         pcmcia_put_socket(socket);
1222
1223         return;
1224 }
1225
1226
1227 /* the pcmcia_bus_interface is used to handle pcmcia socket devices */
1228 static struct class_interface pcmcia_bus_interface = {
1229         .class = &pcmcia_socket_class,
1230         .add = &pcmcia_bus_add_socket,
1231         .remove = &pcmcia_bus_remove_socket,
1232 };
1233
1234
1235 struct bus_type pcmcia_bus_type = {
1236         .name = "pcmcia",
1237         .uevent = pcmcia_bus_uevent,
1238         .match = pcmcia_bus_match,
1239         .dev_attrs = pcmcia_dev_attrs,
1240         .probe = pcmcia_device_probe,
1241         .remove = pcmcia_device_remove,
1242         .suspend = pcmcia_dev_suspend,
1243         .resume = pcmcia_dev_resume,
1244 };
1245
1246
1247 static int __init init_pcmcia_bus(void)
1248 {
1249         spin_lock_init(&pcmcia_dev_list_lock);
1250
1251         bus_register(&pcmcia_bus_type);
1252         class_interface_register(&pcmcia_bus_interface);
1253
1254         pcmcia_setup_ioctl();
1255
1256         return 0;
1257 }
1258 fs_initcall(init_pcmcia_bus); /* one level after subsys_initcall so that
1259                                * pcmcia_socket_class is already registered */
1260
1261
1262 static void __exit exit_pcmcia_bus(void)
1263 {
1264         pcmcia_cleanup_ioctl();
1265
1266         class_interface_unregister(&pcmcia_bus_interface);
1267
1268         bus_unregister(&pcmcia_bus_type);
1269 }
1270 module_exit(exit_pcmcia_bus);
1271
1272
1273 MODULE_ALIAS("ds");