drivers/pnp/card.c

   1 /*
   2  * card.c - contains functions for managing groups of PnP devices
   3  *
   4  * Copyright 2002 Adam Belay <ambx1@neo.rr.com>
   5  */
   6
   7 #include <linux/module.h>
   8 #include <linux/ctype.h>
   9 #include <linux/slab.h>
  10 #include <linux/pnp.h>
  11 #include "base.h"
  12
  13 LIST_HEAD(pnp_cards);
  14 static LIST_HEAD(pnp_card_drivers);
  15
  16 static const struct pnp_card_device_id *match_card(struct pnp_card_driver *drv,
  17                                                    struct pnp_card *card)
  18 {
  19         const struct pnp_card_device_id *drv_id = drv->id_table;
  20
  21         while (*drv_id->id) {
  22                 if (compare_pnp_id(card->id, drv_id->id)) {
  23                         int i = 0;
  24
  25                         for (;;) {
  26                                 int found;
  27                                 struct pnp_dev *dev;
  28
  29                                 if (i == PNP_MAX_DEVICES ||
  30                                     !*drv_id->devs[i].id)
  31                                         return drv_id;
  32                                 found = 0;
  33                                 card_for_each_dev(card, dev) {
  34                                         if (compare_pnp_id(dev->id,
  35                                                    drv_id->devs[i].id)) {
  36                                                 found = 1;
  37                                                 break;
  38                                         }
  39                                 }
  40                                 if (!found)
  41                                         break;
  42                                 i++;
  43                         }
  44                 }
  45                 drv_id++;
  46         }
  47         return NULL;
  48 }
  49
  50 static void card_remove(struct pnp_dev *dev)
  51 {
  52         dev->card_link = NULL;
  53 }
  54
  55 static void card_remove_first(struct pnp_dev *dev)
  56 {
  57         struct pnp_card_driver *drv = to_pnp_card_driver(dev->driver);
  58
  59         if (!dev->card || !drv)
  60                 return;
  61         if (drv->remove)
  62                 drv->remove(dev->card_link);
  63         drv->link.remove = &card_remove;
  64         kfree(dev->card_link);
  65         card_remove(dev);
  66 }
  67
  68 static int card_probe(struct pnp_card *card, struct pnp_card_driver *drv)
  69 {
  70         const struct pnp_card_device_id *id;
  71         struct pnp_card_link *clink;
  72         struct pnp_dev *dev;
  73
  74         if (!drv->probe)
  75                 return 0;
  76         id = match_card(drv, card);
  77         if (!id)
  78                 return 0;
  79
  80         clink = pnp_alloc(sizeof(*clink));
  81         if (!clink)
  82                 return 0;
  83         clink->card = card;
  84         clink->driver = drv;
  85         clink->pm_state = PMSG_ON;
  86
  87         if (drv->probe(clink, id) >= 0)
  88                 return 1;
  89
  90         /* Recovery */
  91         card_for_each_dev(card, dev) {
  92                 if (dev->card_link == clink)
  93                         pnp_release_card_device(dev);
  94         }
  95         kfree(clink);
  96         return 0;
  97 }
  98
  99 /**
 100  * pnp_add_card_id - adds an EISA id to the specified card
 101  * @id: pointer to a pnp_id structure
 102  * @card: pointer to the desired card
 103  */
 104 struct pnp_id *pnp_add_card_id(struct pnp_card *card, char *id)
 105 {
 106         struct pnp_id *dev_id, *ptr;
 107
 108         dev_id = kzalloc(sizeof(struct pnp_id), GFP_KERNEL);
 109         if (!dev_id)
 110                 return NULL;
 111
 112         dev_id->id[0] = id[0];
 113         dev_id->id[1] = id[1];
 114         dev_id->id[2] = id[2];
 115         dev_id->id[3] = tolower(id[3]);
 116         dev_id->id[4] = tolower(id[4]);
 117         dev_id->id[5] = tolower(id[5]);
 118         dev_id->id[6] = tolower(id[6]);
 119         dev_id->id[7] = '\0';
 120
 121         dev_id->next = NULL;
 122         ptr = card->id;
 123         while (ptr && ptr->next)
 124                 ptr = ptr->next;
 125         if (ptr)
 126                 ptr->next = dev_id;
 127         else
 128                 card->id = dev_id;
 129
 130         return dev_id;
 131 }
 132
 133 static void pnp_free_card_ids(struct pnp_card *card)
 134 {
 135         struct pnp_id *id;
 136         struct pnp_id *next;
 137
 138         id = card->id;
 139         while (id) {
 140                 next = id->next;
 141                 kfree(id);
 142                 id = next;
 143         }
 144 }
 145
 146 static void pnp_release_card(struct device *dmdev)
 147 {
 148         struct pnp_card *card = to_pnp_card(dmdev);
 149
 150         pnp_free_card_ids(card);
 151         kfree(card);
 152 }
 153
 154 static ssize_t pnp_show_card_name(struct device *dmdev,
 155                                   struct device_attribute *attr, char *buf)
 156 {
 157         char *str = buf;
 158         struct pnp_card *card = to_pnp_card(dmdev);
 159
 160         str += sprintf(str, "%s\n", card->name);
 161         return (str - buf);
 162 }
 163
 164 static DEVICE_ATTR(name, S_IRUGO, pnp_show_card_name, NULL);
 165
 166 static ssize_t pnp_show_card_ids(struct device *dmdev,
 167                                  struct device_attribute *attr, char *buf)
 168 {
 169         char *str = buf;
 170         struct pnp_card *card = to_pnp_card(dmdev);
 171         struct pnp_id *pos = card->id;
 172
 173         while (pos) {
 174                 str += sprintf(str, "%s\n", pos->id);
 175                 pos = pos->next;
 176         }
 177         return (str - buf);
 178 }
 179
 180 static DEVICE_ATTR(card_id, S_IRUGO, pnp_show_card_ids, NULL);
 181
 182 static int pnp_interface_attach_card(struct pnp_card *card)
 183 {
 184         int rc = device_create_file(&card->dev, &dev_attr_name);
 185
 186         if (rc)
 187                 return rc;
 188
 189         rc = device_create_file(&card->dev, &dev_attr_card_id);
 190         if (rc)
 191                 goto err_name;
 192
 193         return 0;
 194
 195 err_name:
 196         device_remove_file(&card->dev, &dev_attr_name);
 197         return rc;
 198 }
 199
 200 /**
 201  * pnp_add_card - adds a PnP card to the PnP Layer
 202  * @card: pointer to the card to add
 203  */
 204 int pnp_add_card(struct pnp_card *card)
 205 {
 206         int error;
 207         struct list_head *pos, *temp;
 208
 209         sprintf(card->dev.bus_id, "%02x:%02x", card->protocol->number,
 210                 card->number);
 211         card->dev.parent = &card->protocol->dev;
 212         card->dev.bus = NULL;
 213         card->dev.release = &pnp_release_card;
 214         error = device_register(&card->dev);
 215         if (error) {
 216                 dev_err(&card->dev, "could not register (err=%d)\n", error);
 217                 return error;
 218         }
 219
 220         pnp_interface_attach_card(card);
 221         spin_lock(&pnp_lock);
 222         list_add_tail(&card->global_list, &pnp_cards);
 223         list_add_tail(&card->protocol_list, &card->protocol->cards);
 224         spin_unlock(&pnp_lock);
 225
 226         /* we wait until now to add devices in order to ensure the drivers
 227          * will be able to use all of the related devices on the card
 228          * without waiting an unreasonable length of time */
 229         list_for_each(pos, &card->devices) {
 230                 struct pnp_dev *dev = card_to_pnp_dev(pos);
 231                 __pnp_add_device(dev);
 232         }
 233
 234         /* match with card drivers */
 235         list_for_each_safe(pos, temp, &pnp_card_drivers) {
 236                 struct pnp_card_driver *drv =
 237                     list_entry(pos, struct pnp_card_driver,
 238                                global_list);
 239                 card_probe(card, drv);
 240         }
 241         return 0;
 242 }
 243
 244 /**
 245  * pnp_remove_card - removes a PnP card from the PnP Layer
 246  * @card: pointer to the card to remove
 247  */
 248 void pnp_remove_card(struct pnp_card *card)
 249 {
 250         struct list_head *pos, *temp;
 251
 252         device_unregister(&card->dev);
 253         spin_lock(&pnp_lock);
 254         list_del(&card->global_list);
 255         list_del(&card->protocol_list);
 256         spin_unlock(&pnp_lock);
 257         list_for_each_safe(pos, temp, &card->devices) {
 258                 struct pnp_dev *dev = card_to_pnp_dev(pos);
 259                 pnp_remove_card_device(dev);
 260         }
 261 }
 262
 263 /**
 264  * pnp_add_card_device - adds a device to the specified card
 265  * @card: pointer to the card to add to
 266  * @dev: pointer to the device to add
 267  */
 268 int pnp_add_card_device(struct pnp_card *card, struct pnp_dev *dev)
 269 {
 270         dev->dev.parent = &card->dev;
 271         dev->card_link = NULL;
 272         snprintf(dev->dev.bus_id, BUS_ID_SIZE, "%02x:%02x.%02x",
 273                  dev->protocol->number, card->number, dev->number);
 274         spin_lock(&pnp_lock);
 275         dev->card = card;
 276         list_add_tail(&dev->card_list, &card->devices);
 277         spin_unlock(&pnp_lock);
 278         return 0;
 279 }
 280
 281 /**
 282  * pnp_remove_card_device- removes a device from the specified card
 283  * @dev: pointer to the device to remove
 284  */
 285 void pnp_remove_card_device(struct pnp_dev *dev)
 286 {
 287         spin_lock(&pnp_lock);
 288         dev->card = NULL;
 289         list_del(&dev->card_list);
 290         spin_unlock(&pnp_lock);
 291         __pnp_remove_device(dev);
 292 }
 293
 294 /**
 295  * pnp_request_card_device - Searches for a PnP device under the specified card
 296  * @clink: pointer to the card link, cannot be NULL
 297  * @id: pointer to a PnP ID structure that explains the rules for finding the device
 298  * @from: Starting place to search from. If NULL it will start from the begining.
 299  */
 300 struct pnp_dev *pnp_request_card_device(struct pnp_card_link *clink,
 301                                         const char *id, struct pnp_dev *from)
 302 {
 303         struct list_head *pos;
 304         struct pnp_dev *dev;
 305         struct pnp_card_driver *drv;
 306         struct pnp_card *card;
 307
 308         if (!clink || !id)
 309                 return NULL;
 310
 311         card = clink->card;
 312         drv = clink->driver;
 313         if (!from) {
 314                 pos = card->devices.next;
 315         } else {
 316                 if (from->card != card)
 317                         return NULL;
 318                 pos = from->card_list.next;
 319         }
 320         while (pos != &card->devices) {
 321                 dev = card_to_pnp_dev(pos);
 322                 if ((!dev->card_link) && compare_pnp_id(dev->id, id))
 323                         goto found;
 324                 pos = pos->next;
 325         }
 326
 327         return NULL;
 328
 329 found:
 330         dev->card_link = clink;
 331         dev->dev.driver = &drv->link.driver;
 332         if (pnp_bus_type.probe(&dev->dev))
 333                 goto err_out;
 334         if (device_bind_driver(&dev->dev))
 335                 goto err_out;
 336
 337         return dev;
 338
 339 err_out:
 340         dev->dev.driver = NULL;
 341         dev->card_link = NULL;
 342         return NULL;
 343 }
 344
 345 /**
 346  * pnp_release_card_device - call this when the driver no longer needs the device
 347  * @dev: pointer to the PnP device stucture
 348  */
 349 void pnp_release_card_device(struct pnp_dev *dev)
 350 {
 351         struct pnp_card_driver *drv = dev->card_link->driver;
 352
 353         drv->link.remove = &card_remove;
 354         device_release_driver(&dev->dev);
 355         drv->link.remove = &card_remove_first;
 356 }
 357
 358 /*
 359  * suspend/resume callbacks
 360  */
 361 static int card_suspend(struct pnp_dev *dev, pm_message_t state)
 362 {
 363         struct pnp_card_link *link = dev->card_link;
 364
 365         if (link->pm_state.event == state.event)
 366                 return 0;
 367         link->pm_state = state;
 368         return link->driver->suspend(link, state);
 369 }
 370
 371 static int card_resume(struct pnp_dev *dev)
 372 {
 373         struct pnp_card_link *link = dev->card_link;
 374
 375         if (link->pm_state.event == PM_EVENT_ON)
 376                 return 0;
 377         link->pm_state = PMSG_ON;
 378         link->driver->resume(link);
 379         return 0;
 380 }
 381
 382 /**
 383  * pnp_register_card_driver - registers a PnP card driver with the PnP Layer
 384  * @drv: pointer to the driver to register
 385  */
 386 int pnp_register_card_driver(struct pnp_card_driver *drv)
 387 {
 388         int error;
 389         struct list_head *pos, *temp;
 390
 391         drv->link.name = drv->name;
 392         drv->link.id_table = NULL;      /* this will disable auto matching */
 393         drv->link.flags = drv->flags;
 394         drv->link.probe = NULL;
 395         drv->link.remove = &card_remove_first;
 396         drv->link.suspend = drv->suspend ? card_suspend : NULL;
 397         drv->link.resume = drv->resume ? card_resume : NULL;
 398
 399         error = pnp_register_driver(&drv->link);
 400         if (error < 0)
 401                 return error;
 402
 403         spin_lock(&pnp_lock);
 404         list_add_tail(&drv->global_list, &pnp_card_drivers);
 405         spin_unlock(&pnp_lock);
 406
 407         list_for_each_safe(pos, temp, &pnp_cards) {
 408                 struct pnp_card *card =
 409                     list_entry(pos, struct pnp_card, global_list);
 410                 card_probe(card, drv);
 411         }
 412         return 0;
 413 }
 414
 415 /**
 416  * pnp_unregister_card_driver - unregisters a PnP card driver from the PnP Layer
 417  * @drv: pointer to the driver to unregister
 418  */
 419 void pnp_unregister_card_driver(struct pnp_card_driver *drv)
 420 {
 421         spin_lock(&pnp_lock);
 422         list_del(&drv->global_list);
 423         spin_unlock(&pnp_lock);
 424         pnp_unregister_driver(&drv->link);
 425 }
 426
 427 EXPORT_SYMBOL(pnp_request_card_device);
 428 EXPORT_SYMBOL(pnp_release_card_device);
 429 EXPORT_SYMBOL(pnp_register_card_driver);
 430 EXPORT_SYMBOL(pnp_unregister_card_driver);