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