SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/pci/hotplug/pciehp_core.c

   1 /*
   2  * PCI Express Hot Plug Controller Driver
   3  *
   4  * Copyright (C) 1995,2001 Compaq Computer Corporation
   5  * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
   6  * Copyright (C) 2001 IBM Corp.
   7  * Copyright (C) 2003-2004 Intel Corporation
   8  *
   9  * All rights reserved.
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or (at
  14  * your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful, but
  17  * WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
  19  * NON INFRINGEMENT.  See the GNU General Public License for more
  20  * details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  25  *
  26  * Send feedback to <greg@kroah.com>, <kristen.c.accardi@intel.com>
  27  *
  28  */
  29
  30 #include <linux/module.h>
  31 #include <linux/moduleparam.h>
  32 #include <linux/kernel.h>
  33 #include <linux/types.h>
  34 #include <linux/pci.h>
  35 #include "pciehp.h"
  36 #include <linux/interrupt.h>
  37
  38 /* Global variables */
  39 int pciehp_debug;
  40 int pciehp_poll_mode;
  41 int pciehp_poll_time;
  42 int pciehp_force;
  43 struct controller *pciehp_ctrl_list;
  44
  45 #define DRIVER_VERSION  "0.4"
  46 #define DRIVER_AUTHOR   "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
  47 #define DRIVER_DESC     "PCI Express Hot Plug Controller Driver"
  48
  49 MODULE_AUTHOR(DRIVER_AUTHOR);
  50 MODULE_DESCRIPTION(DRIVER_DESC);
  51 MODULE_LICENSE("GPL");
  52
  53 module_param(pciehp_debug, bool, 0644);
  54 module_param(pciehp_poll_mode, bool, 0644);
  55 module_param(pciehp_poll_time, int, 0644);
  56 module_param(pciehp_force, bool, 0644);
  57 MODULE_PARM_DESC(pciehp_debug, "Debugging mode enabled or not");
  58 MODULE_PARM_DESC(pciehp_poll_mode, "Using polling mechanism for hot-plug events or not");
  59 MODULE_PARM_DESC(pciehp_poll_time, "Polling mechanism frequency, in seconds");
  60 MODULE_PARM_DESC(pciehp_force, "Force pciehp, even if _OSC and OSHP are missing");
  61
  62 #define PCIE_MODULE_NAME "pciehp"
  63
  64 static int pcie_start_thread (void);
  65 static int set_attention_status (struct hotplug_slot *slot, u8 value);
  66 static int enable_slot          (struct hotplug_slot *slot);
  67 static int disable_slot         (struct hotplug_slot *slot);
  68 static int get_power_status     (struct hotplug_slot *slot, u8 *value);
  69 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
  70 static int get_latch_status     (struct hotplug_slot *slot, u8 *value);
  71 static int get_adapter_status   (struct hotplug_slot *slot, u8 *value);
  72 static int get_address          (struct hotplug_slot *slot, u32 *value);
  73 static int get_max_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
  74 static int get_cur_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
  75
  76 static struct hotplug_slot_ops pciehp_hotplug_slot_ops = {
  77         .owner =                THIS_MODULE,
  78         .set_attention_status = set_attention_status,
  79         .enable_slot =          enable_slot,
  80         .disable_slot =         disable_slot,
  81         .get_power_status =     get_power_status,
  82         .get_attention_status = get_attention_status,
  83         .get_latch_status =     get_latch_status,
  84         .get_adapter_status =   get_adapter_status,
  85         .get_address =          get_address,
  86         .get_max_bus_speed =    get_max_bus_speed,
  87         .get_cur_bus_speed =    get_cur_bus_speed,
  88 };
  89
  90 /**
  91  * release_slot - free up the memory used by a slot
  92  * @hotplug_slot: slot to free
  93  */
  94 static void release_slot(struct hotplug_slot *hotplug_slot)
  95 {
  96         struct slot *slot = hotplug_slot->private;
  97
  98         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
  99
 100         kfree(slot->hotplug_slot->info);
 101         kfree(slot->hotplug_slot);
 102         kfree(slot);
 103 }
 104
 105 static void make_slot_name(struct slot *slot)
 106 {
 107         snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
 108                  slot->bus, slot->number);
 109 }
 110
 111 static int init_slots(struct controller *ctrl)
 112 {
 113         struct slot *slot;
 114         struct hotplug_slot *hotplug_slot;
 115         struct hotplug_slot_info *info;
 116         int retval = -ENOMEM;
 117         int i;
 118
 119         for (i = 0; i < ctrl->num_slots; i++) {
 120                 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
 121                 if (!slot)
 122                         goto error;
 123
 124                 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
 125                 if (!hotplug_slot)
 126                         goto error_slot;
 127                 slot->hotplug_slot = hotplug_slot;
 128
 129                 info = kzalloc(sizeof(*info), GFP_KERNEL);
 130                 if (!info)
 131                         goto error_hpslot;
 132                 hotplug_slot->info = info;
 133
 134                 hotplug_slot->name = slot->name;
 135
 136                 slot->hp_slot = i;
 137                 slot->ctrl = ctrl;
 138                 slot->bus = ctrl->pci_dev->subordinate->number;
 139                 slot->device = ctrl->slot_device_offset + i;
 140                 slot->hpc_ops = ctrl->hpc_ops;
 141                 slot->number = ctrl->first_slot;
 142
 143                 /* register this slot with the hotplug pci core */
 144                 hotplug_slot->private = slot;
 145                 hotplug_slot->release = &release_slot;
 146                 make_slot_name(slot);
 147                 hotplug_slot->ops = &pciehp_hotplug_slot_ops;
 148
 149                 get_power_status(hotplug_slot, &info->power_status);
 150                 get_attention_status(hotplug_slot, &info->attention_status);
 151                 get_latch_status(hotplug_slot, &info->latch_status);
 152                 get_adapter_status(hotplug_slot, &info->adapter_status);
 153
 154                 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
 155                     "slot_device_offset=%x\n", slot->bus, slot->device,
 156                     slot->hp_slot, slot->number, ctrl->slot_device_offset);
 157                 retval = pci_hp_register(hotplug_slot);
 158                 if (retval) {
 159                         err ("pci_hp_register failed with error %d\n", retval);
 160                         goto error_info;
 161                 }
 162
 163                 slot->next = ctrl->slot;
 164                 ctrl->slot = slot;
 165         }
 166
 167         return 0;
 168 error_info:
 169         kfree(info);
 170 error_hpslot:
 171         kfree(hotplug_slot);
 172 error_slot:
 173         kfree(slot);
 174 error:
 175         return retval;
 176 }
 177
 178
 179 static int cleanup_slots (struct controller * ctrl)
 180 {
 181         struct slot *old_slot, *next_slot;
 182
 183         old_slot = ctrl->slot;
 184         ctrl->slot = NULL;
 185
 186         while (old_slot) {
 187                 next_slot = old_slot->next;
 188                 pci_hp_deregister (old_slot->hotplug_slot);
 189                 old_slot = next_slot;
 190         }
 191
 192
 193         return(0);
 194 }
 195
 196 static int get_ctlr_slot_config(struct controller *ctrl)
 197 {
 198         int num_ctlr_slots;             /* Not needed; PCI Express has 1 slot per port*/
 199         int first_device_num;           /* Not needed */
 200         int physical_slot_num;
 201         u8 ctrlcap;
 202         int rc;
 203
 204         rc = pcie_get_ctlr_slot_config(ctrl, &num_ctlr_slots, &first_device_num, &physical_slot_num, &ctrlcap);
 205         if (rc) {
 206                 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n", __FUNCTION__, ctrl->bus, ctrl->device);
 207                 return (-1);
 208         }
 209
 210         ctrl->num_slots = num_ctlr_slots;       /* PCI Express has 1 slot per port */
 211         ctrl->slot_device_offset = first_device_num;
 212         ctrl->first_slot = physical_slot_num;
 213         ctrl->ctrlcap = ctrlcap;
 214
 215         dbg("%s: bus(0x%x) num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) ctrlcap(%x) for b:d (%x:%x)\n",
 216                 __FUNCTION__, ctrl->slot_bus, num_ctlr_slots, first_device_num, physical_slot_num, ctrlcap,
 217                 ctrl->bus, ctrl->device);
 218
 219         return (0);
 220 }
 221
 222
 223 /*
 224  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 225  */
 226 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
 227 {
 228         struct slot *slot = hotplug_slot->private;
 229
 230         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 231
 232         hotplug_slot->info->attention_status = status;
 233
 234         if (ATTN_LED(slot->ctrl->ctrlcap))
 235                 slot->hpc_ops->set_attention_status(slot, status);
 236
 237         return 0;
 238 }
 239
 240
 241 static int enable_slot(struct hotplug_slot *hotplug_slot)
 242 {
 243         struct slot *slot = hotplug_slot->private;
 244
 245         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 246
 247         return pciehp_enable_slot(slot);
 248 }
 249
 250
 251 static int disable_slot(struct hotplug_slot *hotplug_slot)
 252 {
 253         struct slot *slot = hotplug_slot->private;
 254
 255         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 256
 257         return pciehp_disable_slot(slot);
 258 }
 259
 260 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
 261 {
 262         struct slot *slot = hotplug_slot->private;
 263         int retval;
 264
 265         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 266
 267         retval = slot->hpc_ops->get_power_status(slot, value);
 268         if (retval < 0)
 269                 *value = hotplug_slot->info->power_status;
 270
 271         return 0;
 272 }
 273
 274 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
 275 {
 276         struct slot *slot = hotplug_slot->private;
 277         int retval;
 278
 279         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 280
 281         retval = slot->hpc_ops->get_attention_status(slot, value);
 282         if (retval < 0)
 283                 *value = hotplug_slot->info->attention_status;
 284
 285         return 0;
 286 }
 287
 288 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
 289 {
 290         struct slot *slot = hotplug_slot->private;
 291         int retval;
 292
 293         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 294
 295         retval = slot->hpc_ops->get_latch_status(slot, value);
 296         if (retval < 0)
 297                 *value = hotplug_slot->info->latch_status;
 298
 299         return 0;
 300 }
 301
 302 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
 303 {
 304         struct slot *slot = hotplug_slot->private;
 305         int retval;
 306
 307         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 308
 309         retval = slot->hpc_ops->get_adapter_status(slot, value);
 310         if (retval < 0)
 311                 *value = hotplug_slot->info->adapter_status;
 312
 313         return 0;
 314 }
 315
 316 static int get_address(struct hotplug_slot *hotplug_slot, u32 *value)
 317 {
 318         struct slot *slot = hotplug_slot->private;
 319         struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
 320
 321         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 322
 323         *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
 324
 325         return 0;
 326 }
 327
 328 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 329 {
 330         struct slot *slot = hotplug_slot->private;
 331         int retval;
 332
 333         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 334
 335         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 336         if (retval < 0)
 337                 *value = PCI_SPEED_UNKNOWN;
 338
 339         return 0;
 340 }
 341
 342 static int get_cur_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 343 {
 344         struct slot *slot = hotplug_slot->private;
 345         int retval;
 346
 347         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 348
 349         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 350         if (retval < 0)
 351                 *value = PCI_SPEED_UNKNOWN;
 352
 353         return 0;
 354 }
 355
 356 static int pciehp_probe(struct pcie_device *dev, const struct pcie_port_service_id *id)
 357 {
 358         int rc;
 359         struct controller *ctrl;
 360         struct slot *t_slot;
 361         int first_device_num = 0 ;      /* first PCI device number supported by this PCIE */
 362         int num_ctlr_slots;             /* number of slots supported by this HPC */
 363         u8 value;
 364         struct pci_dev *pdev;
 365
 366         ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
 367         if (!ctrl) {
 368                 err("%s : out of memory\n", __FUNCTION__);
 369                 goto err_out_none;
 370         }
 371
 372         pdev = dev->port;
 373         ctrl->pci_dev = pdev;
 374
 375         rc = pcie_init(ctrl, dev);
 376         if (rc) {
 377                 dbg("%s: controller initialization failed\n", PCIE_MODULE_NAME);
 378                 goto err_out_free_ctrl;
 379         }
 380
 381         pci_set_drvdata(pdev, ctrl);
 382
 383         ctrl->pci_bus = kmalloc(sizeof(*ctrl->pci_bus), GFP_KERNEL);
 384         if (!ctrl->pci_bus) {
 385                 err("%s: out of memory\n", __FUNCTION__);
 386                 rc = -ENOMEM;
 387                 goto err_out_unmap_mmio_region;
 388         }
 389         memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
 390         ctrl->bus = pdev->bus->number;  /* ctrl bus */
 391         ctrl->slot_bus = pdev->subordinate->number;  /* bus controlled by this HPC */
 392
 393         ctrl->device = PCI_SLOT(pdev->devfn);
 394         ctrl->function = PCI_FUNC(pdev->devfn);
 395         dbg("%s: ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", __FUNCTION__,
 396                 ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
 397
 398         /*
 399          *      Save configuration headers for this and subordinate PCI buses
 400          */
 401
 402         rc = get_ctlr_slot_config(ctrl);
 403         if (rc) {
 404                 err(msg_initialization_err, rc);
 405                 goto err_out_free_ctrl_bus;
 406         }
 407         first_device_num = ctrl->slot_device_offset;
 408         num_ctlr_slots = ctrl->num_slots;
 409
 410         /* Setup the slot information structures */
 411         rc = init_slots(ctrl);
 412         if (rc) {
 413                 err(msg_initialization_err, 6);
 414                 goto err_out_free_ctrl_slot;
 415         }
 416
 417         t_slot = pciehp_find_slot(ctrl, first_device_num);
 418
 419         /*      Finish setting up the hot plug ctrl device */
 420         ctrl->next_event = 0;
 421
 422         if (!pciehp_ctrl_list) {
 423                 pciehp_ctrl_list = ctrl;
 424                 ctrl->next = NULL;
 425         } else {
 426                 ctrl->next = pciehp_ctrl_list;
 427                 pciehp_ctrl_list = ctrl;
 428         }
 429
 430         /* Wait for exclusive access to hardware */
 431         mutex_lock(&ctrl->ctrl_lock);
 432
 433         t_slot->hpc_ops->get_adapter_status(t_slot, &value); /* Check if slot is occupied */
 434
 435         if ((POWER_CTRL(ctrl->ctrlcap)) && !value) {
 436                 rc = t_slot->hpc_ops->power_off_slot(t_slot); /* Power off slot if not occupied*/
 437                 if (rc) {
 438                         /* Done with exclusive hardware access */
 439                         mutex_unlock(&ctrl->ctrl_lock);
 440                         goto err_out_free_ctrl_slot;
 441                 } else
 442                         /* Wait for the command to complete */
 443                         wait_for_ctrl_irq (ctrl);
 444         }
 445
 446         /* Done with exclusive hardware access */
 447         mutex_unlock(&ctrl->ctrl_lock);
 448
 449         return 0;
 450
 451 err_out_free_ctrl_slot:
 452         cleanup_slots(ctrl);
 453 err_out_free_ctrl_bus:
 454         kfree(ctrl->pci_bus);
 455 err_out_unmap_mmio_region:
 456         ctrl->hpc_ops->release_ctlr(ctrl);
 457 err_out_free_ctrl:
 458         kfree(ctrl);
 459 err_out_none:
 460         return -ENODEV;
 461 }
 462
 463
 464 static int pcie_start_thread(void)
 465 {
 466         int retval = 0;
 467
 468         dbg("Initialize + Start the notification/polling mechanism \n");
 469
 470         retval = pciehp_event_start_thread();
 471         if (retval) {
 472                 dbg("pciehp_event_start_thread() failed\n");
 473                 return retval;
 474         }
 475
 476         return retval;
 477 }
 478
 479 static void __exit unload_pciehpd(void)
 480 {
 481         struct controller *ctrl;
 482         struct controller *tctrl;
 483
 484         ctrl = pciehp_ctrl_list;
 485
 486         while (ctrl) {
 487                 cleanup_slots(ctrl);
 488
 489                 kfree (ctrl->pci_bus);
 490
 491                 ctrl->hpc_ops->release_ctlr(ctrl);
 492
 493                 tctrl = ctrl;
 494                 ctrl = ctrl->next;
 495
 496                 kfree(tctrl);
 497         }
 498
 499         /* Stop the notification mechanism */
 500         pciehp_event_stop_thread();
 501
 502 }
 503
 504 static void pciehp_remove (struct pcie_device *device)
 505 {
 506         /* XXX - Needs to be adapted to device driver model */
 507 }
 508
 509 #ifdef CONFIG_PM
 510 static int pciehp_suspend (struct pcie_device *dev, pm_message_t state)
 511 {
 512         printk("%s ENTRY\n", __FUNCTION__);
 513         return 0;
 514 }
 515
 516 static int pciehp_resume (struct pcie_device *dev)
 517 {
 518         printk("%s ENTRY\n", __FUNCTION__);
 519         return 0;
 520 }
 521 #endif
 522
 523 static struct pcie_port_service_id port_pci_ids[] = { {
 524         .vendor = PCI_ANY_ID,
 525         .device = PCI_ANY_ID,
 526         .port_type = PCIE_ANY_PORT,
 527         .service_type = PCIE_PORT_SERVICE_HP,
 528         .driver_data =  0,
 529         }, { /* end: all zeroes */ }
 530 };
 531 static const char device_name[] = "hpdriver";
 532
 533 static struct pcie_port_service_driver hpdriver_portdrv = {
 534         .name           = (char *)device_name,
 535         .id_table       = &port_pci_ids[0],
 536
 537         .probe          = pciehp_probe,
 538         .remove         = pciehp_remove,
 539
 540 #ifdef  CONFIG_PM
 541         .suspend        = pciehp_suspend,
 542         .resume         = pciehp_resume,
 543 #endif  /* PM */
 544 };
 545
 546 static int __init pcied_init(void)
 547 {
 548         int retval = 0;
 549
 550 #ifdef CONFIG_HOTPLUG_PCI_PCIE_POLL_EVENT_MODE
 551         pciehp_poll_mode = 1;
 552 #endif
 553
 554         retval = pcie_start_thread();
 555         if (retval)
 556                 goto error_hpc_init;
 557
 558         retval = pcie_port_service_register(&hpdriver_portdrv);
 559         dbg("pcie_port_service_register = %d\n", retval);
 560         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 561         if (retval)
 562                 dbg("%s: Failure to register service\n", __FUNCTION__);
 563
 564 error_hpc_init:
 565         if (retval) {
 566                 pciehp_event_stop_thread();
 567         };
 568
 569         return retval;
 570 }
 571
 572 static void __exit pcied_cleanup(void)
 573 {
 574         dbg("unload_pciehpd()\n");
 575         unload_pciehpd();
 576
 577         pcie_port_service_unregister(&hpdriver_portdrv);
 578
 579         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 580 }
 581
 582 module_init(pcied_init);
 583 module_exit(pcied_cleanup);