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                 list_add(&slot->slot_list, &ctrl->slot_list);
 164         }
 165
 166         return 0;
 167 error_info:
 168         kfree(info);
 169 error_hpslot:
 170         kfree(hotplug_slot);
 171 error_slot:
 172         kfree(slot);
 173 error:
 174         return retval;
 175 }
 176
 177 static void cleanup_slots(struct controller *ctrl)
 178 {
 179         struct list_head *tmp;
 180         struct list_head *next;
 181         struct slot *slot;
 182
 183         list_for_each_safe(tmp, next, &ctrl->slot_list) {
 184                 slot = list_entry(tmp, struct slot, slot_list);
 185                 list_del(&slot->slot_list);
 186                 pci_hp_deregister(slot->hotplug_slot);
 187         }
 188 }
 189
 190 static int get_ctlr_slot_config(struct controller *ctrl)
 191 {
 192         int num_ctlr_slots;             /* Not needed; PCI Express has 1 slot per port*/
 193         int first_device_num;           /* Not needed */
 194         int physical_slot_num;
 195         u8 ctrlcap;
 196         int rc;
 197
 198         rc = pcie_get_ctlr_slot_config(ctrl, &num_ctlr_slots, &first_device_num, &physical_slot_num, &ctrlcap);
 199         if (rc) {
 200                 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n", __FUNCTION__, ctrl->bus, ctrl->device);
 201                 return (-1);
 202         }
 203
 204         ctrl->num_slots = num_ctlr_slots;       /* PCI Express has 1 slot per port */
 205         ctrl->slot_device_offset = first_device_num;
 206         ctrl->first_slot = physical_slot_num;
 207         ctrl->ctrlcap = ctrlcap;
 208
 209         dbg("%s: bus(0x%x) num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) ctrlcap(%x) for b:d (%x:%x)\n",
 210                 __FUNCTION__, ctrl->slot_bus, num_ctlr_slots, first_device_num, physical_slot_num, ctrlcap,
 211                 ctrl->bus, ctrl->device);
 212
 213         return (0);
 214 }
 215
 216
 217 /*
 218  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 219  */
 220 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
 221 {
 222         struct slot *slot = hotplug_slot->private;
 223
 224         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 225
 226         hotplug_slot->info->attention_status = status;
 227
 228         if (ATTN_LED(slot->ctrl->ctrlcap))
 229                 slot->hpc_ops->set_attention_status(slot, status);
 230
 231         return 0;
 232 }
 233
 234
 235 static int enable_slot(struct hotplug_slot *hotplug_slot)
 236 {
 237         struct slot *slot = hotplug_slot->private;
 238
 239         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 240
 241         return pciehp_enable_slot(slot);
 242 }
 243
 244
 245 static int disable_slot(struct hotplug_slot *hotplug_slot)
 246 {
 247         struct slot *slot = hotplug_slot->private;
 248
 249         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 250
 251         return pciehp_disable_slot(slot);
 252 }
 253
 254 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
 255 {
 256         struct slot *slot = hotplug_slot->private;
 257         int retval;
 258
 259         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 260
 261         retval = slot->hpc_ops->get_power_status(slot, value);
 262         if (retval < 0)
 263                 *value = hotplug_slot->info->power_status;
 264
 265         return 0;
 266 }
 267
 268 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
 269 {
 270         struct slot *slot = hotplug_slot->private;
 271         int retval;
 272
 273         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 274
 275         retval = slot->hpc_ops->get_attention_status(slot, value);
 276         if (retval < 0)
 277                 *value = hotplug_slot->info->attention_status;
 278
 279         return 0;
 280 }
 281
 282 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
 283 {
 284         struct slot *slot = hotplug_slot->private;
 285         int retval;
 286
 287         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 288
 289         retval = slot->hpc_ops->get_latch_status(slot, value);
 290         if (retval < 0)
 291                 *value = hotplug_slot->info->latch_status;
 292
 293         return 0;
 294 }
 295
 296 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
 297 {
 298         struct slot *slot = hotplug_slot->private;
 299         int retval;
 300
 301         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 302
 303         retval = slot->hpc_ops->get_adapter_status(slot, value);
 304         if (retval < 0)
 305                 *value = hotplug_slot->info->adapter_status;
 306
 307         return 0;
 308 }
 309
 310 static int get_address(struct hotplug_slot *hotplug_slot, u32 *value)
 311 {
 312         struct slot *slot = hotplug_slot->private;
 313         struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
 314
 315         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 316
 317         *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
 318
 319         return 0;
 320 }
 321
 322 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 323 {
 324         struct slot *slot = hotplug_slot->private;
 325         int retval;
 326
 327         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 328
 329         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 330         if (retval < 0)
 331                 *value = PCI_SPEED_UNKNOWN;
 332
 333         return 0;
 334 }
 335
 336 static int get_cur_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 337 {
 338         struct slot *slot = hotplug_slot->private;
 339         int retval;
 340
 341         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 342
 343         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 344         if (retval < 0)
 345                 *value = PCI_SPEED_UNKNOWN;
 346
 347         return 0;
 348 }
 349
 350 static int pciehp_probe(struct pcie_device *dev, const struct pcie_port_service_id *id)
 351 {
 352         int rc;
 353         struct controller *ctrl;
 354         struct slot *t_slot;
 355         int first_device_num = 0 ;      /* first PCI device number supported by this PCIE */
 356         int num_ctlr_slots;             /* number of slots supported by this HPC */
 357         u8 value;
 358         struct pci_dev *pdev;
 359
 360         ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
 361         if (!ctrl) {
 362                 err("%s : out of memory\n", __FUNCTION__);
 363                 goto err_out_none;
 364         }
 365         INIT_LIST_HEAD(&ctrl->slot_list);
 366
 367         pdev = dev->port;
 368         ctrl->pci_dev = pdev;
 369
 370         rc = pcie_init(ctrl, dev);
 371         if (rc) {
 372                 dbg("%s: controller initialization failed\n", PCIE_MODULE_NAME);
 373                 goto err_out_free_ctrl;
 374         }
 375
 376         pci_set_drvdata(pdev, ctrl);
 377
 378         ctrl->pci_bus = kmalloc(sizeof(*ctrl->pci_bus), GFP_KERNEL);
 379         if (!ctrl->pci_bus) {
 380                 err("%s: out of memory\n", __FUNCTION__);
 381                 rc = -ENOMEM;
 382                 goto err_out_unmap_mmio_region;
 383         }
 384         memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
 385         ctrl->bus = pdev->bus->number;  /* ctrl bus */
 386         ctrl->slot_bus = pdev->subordinate->number;  /* bus controlled by this HPC */
 387
 388         ctrl->device = PCI_SLOT(pdev->devfn);
 389         ctrl->function = PCI_FUNC(pdev->devfn);
 390         dbg("%s: ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", __FUNCTION__,
 391                 ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
 392
 393         /*
 394          *      Save configuration headers for this and subordinate PCI buses
 395          */
 396
 397         rc = get_ctlr_slot_config(ctrl);
 398         if (rc) {
 399                 err(msg_initialization_err, rc);
 400                 goto err_out_free_ctrl_bus;
 401         }
 402         first_device_num = ctrl->slot_device_offset;
 403         num_ctlr_slots = ctrl->num_slots;
 404
 405         /* Setup the slot information structures */
 406         rc = init_slots(ctrl);
 407         if (rc) {
 408                 err(msg_initialization_err, 6);
 409                 goto err_out_free_ctrl_slot;
 410         }
 411
 412         t_slot = pciehp_find_slot(ctrl, first_device_num);
 413
 414         /*      Finish setting up the hot plug ctrl device */
 415         ctrl->next_event = 0;
 416
 417         if (!pciehp_ctrl_list) {
 418                 pciehp_ctrl_list = ctrl;
 419                 ctrl->next = NULL;
 420         } else {
 421                 ctrl->next = pciehp_ctrl_list;
 422                 pciehp_ctrl_list = ctrl;
 423         }
 424
 425         /* Wait for exclusive access to hardware */
 426         mutex_lock(&ctrl->ctrl_lock);
 427
 428         t_slot->hpc_ops->get_adapter_status(t_slot, &value); /* Check if slot is occupied */
 429
 430         if ((POWER_CTRL(ctrl->ctrlcap)) && !value) {
 431                 rc = t_slot->hpc_ops->power_off_slot(t_slot); /* Power off slot if not occupied*/
 432                 if (rc) {
 433                         /* Done with exclusive hardware access */
 434                         mutex_unlock(&ctrl->ctrl_lock);
 435                         goto err_out_free_ctrl_slot;
 436                 } else
 437                         /* Wait for the command to complete */
 438                         wait_for_ctrl_irq (ctrl);
 439         }
 440
 441         /* Done with exclusive hardware access */
 442         mutex_unlock(&ctrl->ctrl_lock);
 443
 444         return 0;
 445
 446 err_out_free_ctrl_slot:
 447         cleanup_slots(ctrl);
 448 err_out_free_ctrl_bus:
 449         kfree(ctrl->pci_bus);
 450 err_out_unmap_mmio_region:
 451         ctrl->hpc_ops->release_ctlr(ctrl);
 452 err_out_free_ctrl:
 453         kfree(ctrl);
 454 err_out_none:
 455         return -ENODEV;
 456 }
 457
 458
 459 static int pcie_start_thread(void)
 460 {
 461         int retval = 0;
 462
 463         dbg("Initialize + Start the notification/polling mechanism \n");
 464
 465         retval = pciehp_event_start_thread();
 466         if (retval) {
 467                 dbg("pciehp_event_start_thread() failed\n");
 468                 return retval;
 469         }
 470
 471         return retval;
 472 }
 473
 474 static void __exit unload_pciehpd(void)
 475 {
 476         struct controller *ctrl;
 477         struct controller *tctrl;
 478
 479         ctrl = pciehp_ctrl_list;
 480
 481         while (ctrl) {
 482                 cleanup_slots(ctrl);
 483
 484                 kfree (ctrl->pci_bus);
 485
 486                 ctrl->hpc_ops->release_ctlr(ctrl);
 487
 488                 tctrl = ctrl;
 489                 ctrl = ctrl->next;
 490
 491                 kfree(tctrl);
 492         }
 493
 494         /* Stop the notification mechanism */
 495         pciehp_event_stop_thread();
 496
 497 }
 498
 499 static void pciehp_remove (struct pcie_device *device)
 500 {
 501         /* XXX - Needs to be adapted to device driver model */
 502 }
 503
 504 #ifdef CONFIG_PM
 505 static int pciehp_suspend (struct pcie_device *dev, pm_message_t state)
 506 {
 507         printk("%s ENTRY\n", __FUNCTION__);
 508         return 0;
 509 }
 510
 511 static int pciehp_resume (struct pcie_device *dev)
 512 {
 513         printk("%s ENTRY\n", __FUNCTION__);
 514         return 0;
 515 }
 516 #endif
 517
 518 static struct pcie_port_service_id port_pci_ids[] = { {
 519         .vendor = PCI_ANY_ID,
 520         .device = PCI_ANY_ID,
 521         .port_type = PCIE_ANY_PORT,
 522         .service_type = PCIE_PORT_SERVICE_HP,
 523         .driver_data =  0,
 524         }, { /* end: all zeroes */ }
 525 };
 526 static const char device_name[] = "hpdriver";
 527
 528 static struct pcie_port_service_driver hpdriver_portdrv = {
 529         .name           = (char *)device_name,
 530         .id_table       = &port_pci_ids[0],
 531
 532         .probe          = pciehp_probe,
 533         .remove         = pciehp_remove,
 534
 535 #ifdef  CONFIG_PM
 536         .suspend        = pciehp_suspend,
 537         .resume         = pciehp_resume,
 538 #endif  /* PM */
 539 };
 540
 541 static int __init pcied_init(void)
 542 {
 543         int retval = 0;
 544
 545 #ifdef CONFIG_HOTPLUG_PCI_PCIE_POLL_EVENT_MODE
 546         pciehp_poll_mode = 1;
 547 #endif
 548
 549         retval = pcie_start_thread();
 550         if (retval)
 551                 goto error_hpc_init;
 552
 553         retval = pcie_port_service_register(&hpdriver_portdrv);
 554         dbg("pcie_port_service_register = %d\n", retval);
 555         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 556         if (retval)
 557                 dbg("%s: Failure to register service\n", __FUNCTION__);
 558
 559 error_hpc_init:
 560         if (retval) {
 561                 pciehp_event_stop_thread();
 562         };
 563
 564         return retval;
 565 }
 566
 567 static void __exit pcied_cleanup(void)
 568 {
 569         dbg("unload_pciehpd()\n");
 570         unload_pciehpd();
 571
 572         pcie_port_service_unregister(&hpdriver_portdrv);
 573
 574         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 575 }
 576
 577 module_init(pcied_init);
 578 module_exit(pcied_cleanup);