drivers/pci/hotplug/shpchp_core.c

   1 /*
   2  * Standard 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/config.h>
  31 #include <linux/module.h>
  32 #include <linux/moduleparam.h>
  33 #include <linux/kernel.h>
  34 #include <linux/types.h>
  35 #include <linux/proc_fs.h>
  36 #include <linux/slab.h>
  37 #include <linux/workqueue.h>
  38 #include <linux/pci.h>
  39 #include <linux/init.h>
  40 #include <asm/uaccess.h>
  41 #include "shpchp.h"
  42
  43 /* Global variables */
  44 int shpchp_debug;
  45 int shpchp_poll_mode;
  46 int shpchp_poll_time;
  47 struct controller *shpchp_ctrl_list;    /* = NULL */
  48 struct pci_func *shpchp_slot_list[256];
  49
  50 #define DRIVER_VERSION  "0.4"
  51 #define DRIVER_AUTHOR   "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
  52 #define DRIVER_DESC     "Standard Hot Plug PCI Controller Driver"
  53
  54 MODULE_AUTHOR(DRIVER_AUTHOR);
  55 MODULE_DESCRIPTION(DRIVER_DESC);
  56 MODULE_LICENSE("GPL");
  57
  58 module_param(shpchp_debug, bool, 0644);
  59 module_param(shpchp_poll_mode, bool, 0644);
  60 module_param(shpchp_poll_time, int, 0644);
  61 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
  62 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
  63 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
  64
  65 #define SHPC_MODULE_NAME "shpchp"
  66
  67 static int shpc_start_thread (void);
  68 static int set_attention_status (struct hotplug_slot *slot, u8 value);
  69 static int enable_slot          (struct hotplug_slot *slot);
  70 static int disable_slot         (struct hotplug_slot *slot);
  71 static int get_power_status     (struct hotplug_slot *slot, u8 *value);
  72 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
  73 static int get_latch_status     (struct hotplug_slot *slot, u8 *value);
  74 static int get_adapter_status   (struct hotplug_slot *slot, u8 *value);
  75 static int get_max_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
  76 static int get_cur_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
  77
  78 static struct hotplug_slot_ops shpchp_hotplug_slot_ops = {
  79         .owner =                THIS_MODULE,
  80         .set_attention_status = set_attention_status,
  81         .enable_slot =          enable_slot,
  82         .disable_slot =         disable_slot,
  83         .get_power_status =     get_power_status,
  84         .get_attention_status = get_attention_status,
  85         .get_latch_status =     get_latch_status,
  86         .get_adapter_status =   get_adapter_status,
  87         .get_max_bus_speed =    get_max_bus_speed,
  88         .get_cur_bus_speed =    get_cur_bus_speed,
  89 };
  90
  91 /**
  92  * release_slot - free up the memory used by a slot
  93  * @hotplug_slot: slot to free
  94  */
  95 static void release_slot(struct hotplug_slot *hotplug_slot)
  96 {
  97         struct slot *slot = hotplug_slot->private;
  98
  99         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 100
 101         kfree(slot->hotplug_slot->info);
 102         kfree(slot->hotplug_slot->name);
 103         kfree(slot->hotplug_slot);
 104         kfree(slot);
 105 }
 106
 107 static int init_slots(struct controller *ctrl)
 108 {
 109         struct slot *new_slot;
 110         u8 number_of_slots;
 111         u8 slot_device;
 112         u32 slot_number, sun;
 113         int result = -ENOMEM;
 114
 115         dbg("%s\n",__FUNCTION__);
 116
 117         number_of_slots = ctrl->num_slots;
 118         slot_device = ctrl->slot_device_offset;
 119         slot_number = ctrl->first_slot;
 120
 121         while (number_of_slots) {
 122                 new_slot = (struct slot *) kmalloc(sizeof(struct slot), GFP_KERNEL);
 123                 if (!new_slot)
 124                         goto error;
 125
 126                 memset(new_slot, 0, sizeof(struct slot));
 127                 new_slot->hotplug_slot = kmalloc (sizeof (struct hotplug_slot), GFP_KERNEL);
 128                 if (!new_slot->hotplug_slot)
 129                         goto error_slot;
 130                 memset(new_slot->hotplug_slot, 0, sizeof (struct hotplug_slot));
 131
 132                 new_slot->hotplug_slot->info = kmalloc (sizeof (struct hotplug_slot_info), GFP_KERNEL);
 133                 if (!new_slot->hotplug_slot->info)
 134                         goto error_hpslot;
 135                 memset(new_slot->hotplug_slot->info, 0, sizeof (struct hotplug_slot_info));
 136                 new_slot->hotplug_slot->name = kmalloc (SLOT_NAME_SIZE, GFP_KERNEL);
 137                 if (!new_slot->hotplug_slot->name)
 138                         goto error_info;
 139
 140                 new_slot->magic = SLOT_MAGIC;
 141                 new_slot->ctrl = ctrl;
 142                 new_slot->bus = ctrl->slot_bus;
 143                 new_slot->device = slot_device;
 144                 new_slot->hpc_ops = ctrl->hpc_ops;
 145
 146                 if (shpchprm_get_physical_slot_number(ctrl, &sun,
 147                                         new_slot->bus, new_slot->device))
 148                         goto error_name;
 149
 150                 new_slot->number = sun;
 151                 new_slot->hp_slot = slot_device - ctrl->slot_device_offset;
 152
 153                 /* register this slot with the hotplug pci core */
 154                 new_slot->hotplug_slot->private = new_slot;
 155                 new_slot->hotplug_slot->release = &release_slot;
 156                 make_slot_name(new_slot->hotplug_slot->name, SLOT_NAME_SIZE, new_slot);
 157                 new_slot->hotplug_slot->ops = &shpchp_hotplug_slot_ops;
 158
 159                 new_slot->hpc_ops->get_power_status(new_slot, &(new_slot->hotplug_slot->info->power_status));
 160                 new_slot->hpc_ops->get_attention_status(new_slot, &(new_slot->hotplug_slot->info->attention_status));
 161                 new_slot->hpc_ops->get_latch_status(new_slot, &(new_slot->hotplug_slot->info->latch_status));
 162                 new_slot->hpc_ops->get_adapter_status(new_slot, &(new_slot->hotplug_slot->info->adapter_status));
 163
 164                 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x slot_device_offset=%x\n", new_slot->bus,
 165                         new_slot->device, new_slot->hp_slot, new_slot->number, ctrl->slot_device_offset);
 166                 result = pci_hp_register (new_slot->hotplug_slot);
 167                 if (result) {
 168                         err ("pci_hp_register failed with error %d\n", result);
 169                         goto error_name;
 170                 }
 171
 172                 new_slot->next = ctrl->slot;
 173                 ctrl->slot = new_slot;
 174
 175                 number_of_slots--;
 176                 slot_device++;
 177                 slot_number += ctrl->slot_num_inc;
 178         }
 179
 180         return 0;
 181
 182 error_name:
 183         kfree(new_slot->hotplug_slot->name);
 184 error_info:
 185         kfree(new_slot->hotplug_slot->info);
 186 error_hpslot:
 187         kfree(new_slot->hotplug_slot);
 188 error_slot:
 189         kfree(new_slot);
 190 error:
 191         return result;
 192 }
 193
 194 static void cleanup_slots(struct controller *ctrl)
 195 {
 196         struct slot *old_slot, *next_slot;
 197
 198         old_slot = ctrl->slot;
 199         ctrl->slot = NULL;
 200
 201         while (old_slot) {
 202                 next_slot = old_slot->next;
 203                 pci_hp_deregister(old_slot->hotplug_slot);
 204                 old_slot = next_slot;
 205         }
 206 }
 207
 208 static int get_ctlr_slot_config(struct controller *ctrl)
 209 {
 210         int num_ctlr_slots;
 211         int first_device_num;
 212         int physical_slot_num;
 213         int updown;
 214         int rc;
 215         int flags;
 216
 217         rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots, &first_device_num, &physical_slot_num, &updown, &flags);
 218         if (rc) {
 219                 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n", __FUNCTION__, ctrl->bus, ctrl->device);
 220                 return -1;
 221         }
 222
 223         ctrl->num_slots = num_ctlr_slots;
 224         ctrl->slot_device_offset = first_device_num;
 225         ctrl->first_slot = physical_slot_num;
 226         ctrl->slot_num_inc = updown;            /* either -1 or 1 */
 227
 228         dbg("%s: num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d (%x:%x)\n",
 229                 __FUNCTION__, num_ctlr_slots, first_device_num, physical_slot_num, updown, ctrl->bus, ctrl->device);
 230
 231         return 0;
 232 }
 233
 234
 235 /*
 236  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 237  */
 238 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
 239 {
 240         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 241
 242         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 243
 244         hotplug_slot->info->attention_status = status;
 245         slot->hpc_ops->set_attention_status(slot, status);
 246
 247         return 0;
 248 }
 249
 250
 251 static int enable_slot (struct hotplug_slot *hotplug_slot)
 252 {
 253         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 254
 255         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 256
 257         return shpchp_enable_slot(slot);
 258 }
 259
 260
 261 static int disable_slot (struct hotplug_slot *hotplug_slot)
 262 {
 263         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 264
 265         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 266
 267         return shpchp_disable_slot(slot);
 268 }
 269
 270 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
 271 {
 272         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 273         int retval;
 274
 275         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 276
 277         retval = slot->hpc_ops->get_power_status(slot, value);
 278         if (retval < 0)
 279                 *value = hotplug_slot->info->power_status;
 280
 281         return 0;
 282 }
 283
 284 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
 285 {
 286         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 287         int retval;
 288
 289         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 290
 291         retval = slot->hpc_ops->get_attention_status(slot, value);
 292         if (retval < 0)
 293                 *value = hotplug_slot->info->attention_status;
 294
 295         return 0;
 296 }
 297
 298 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
 299 {
 300         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 301         int retval;
 302
 303         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 304
 305         retval = slot->hpc_ops->get_latch_status(slot, value);
 306         if (retval < 0)
 307                 *value = hotplug_slot->info->latch_status;
 308
 309         return 0;
 310 }
 311
 312 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
 313 {
 314         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 315         int retval;
 316
 317         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 318
 319         retval = slot->hpc_ops->get_adapter_status(slot, value);
 320         if (retval < 0)
 321                 *value = hotplug_slot->info->adapter_status;
 322
 323         return 0;
 324 }
 325
 326 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 327 {
 328         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 329         int retval;
 330
 331         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 332
 333         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 334         if (retval < 0)
 335                 *value = PCI_SPEED_UNKNOWN;
 336
 337         return 0;
 338 }
 339
 340 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 341 {
 342         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 343         int retval;
 344
 345         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 346
 347         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 348         if (retval < 0)
 349                 *value = PCI_SPEED_UNKNOWN;
 350
 351         return 0;
 352 }
 353
 354 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
 355 {
 356         int rc;
 357         struct controller *ctrl;
 358         struct slot *t_slot;
 359         int first_device_num;   /* first PCI device number supported by this SHPC */
 360         int num_ctlr_slots;     /* number of slots supported by this SHPC */
 361
 362         ctrl = (struct controller *) kmalloc(sizeof(struct controller), GFP_KERNEL);
 363         if (!ctrl) {
 364                 err("%s : out of memory\n", __FUNCTION__);
 365                 goto err_out_none;
 366         }
 367         memset(ctrl, 0, sizeof(struct controller));
 368
 369         dbg("DRV_thread pid = %d\n", current->pid);
 370
 371         rc = shpc_init(ctrl, pdev,
 372                         (php_intr_callback_t) shpchp_handle_attention_button,
 373                         (php_intr_callback_t) shpchp_handle_switch_change,
 374                         (php_intr_callback_t) shpchp_handle_presence_change,
 375                         (php_intr_callback_t) shpchp_handle_power_fault);
 376         if (rc) {
 377                 dbg("%s: controller initialization failed\n", SHPC_MODULE_NAME);
 378                 goto err_out_free_ctrl;
 379         }
 380
 381         dbg("%s: controller initialization success\n", __FUNCTION__);
 382         ctrl->pci_dev = pdev;  /* pci_dev of the P2P bridge */
 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("out of memory\n");
 389                 rc = -ENOMEM;
 390                 goto err_out_unmap_mmio_region;
 391         }
 392
 393         memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
 394         ctrl->bus = pdev->bus->number;
 395         ctrl->slot_bus = pdev->subordinate->number;
 396
 397         ctrl->device = PCI_SLOT(pdev->devfn);
 398         ctrl->function = PCI_FUNC(pdev->devfn);
 399         dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
 400
 401         /*
 402          *      Save configuration headers for this and subordinate PCI buses
 403          */
 404
 405         rc = get_ctlr_slot_config(ctrl);
 406         if (rc) {
 407                 err(msg_initialization_err, rc);
 408                 goto err_out_free_ctrl_bus;
 409         }
 410         first_device_num = ctrl->slot_device_offset;
 411         num_ctlr_slots = ctrl->num_slots;
 412
 413         /* Store PCI Config Space for all devices on this bus */
 414         rc = shpchp_save_config(ctrl, ctrl->slot_bus, num_ctlr_slots, first_device_num);
 415         if (rc) {
 416                 err("%s: unable to save PCI configuration data, error %d\n", __FUNCTION__, rc);
 417                 goto err_out_free_ctrl_bus;
 418         }
 419
 420         ctrl->add_support = 1;
 421
 422         /* Setup the slot information structures */
 423         rc = init_slots(ctrl);
 424         if (rc) {
 425                 err(msg_initialization_err, 6);
 426                 goto err_out_free_ctrl_slot;
 427         }
 428
 429         /* Now hpc_functions (slot->hpc_ops->functions) are ready  */
 430         t_slot = shpchp_find_slot(ctrl, first_device_num);
 431
 432         /* Check for operation bus speed */
 433         rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
 434         dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
 435
 436         if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
 437                 err(SHPC_MODULE_NAME ": Can't get current bus speed. Set to 33MHz PCI.\n");
 438                 ctrl->speed = PCI_SPEED_33MHz;
 439         }
 440
 441         /* Finish setting up the hot plug ctrl device */
 442         ctrl->next_event = 0;
 443
 444         if (!shpchp_ctrl_list) {
 445                 shpchp_ctrl_list = ctrl;
 446                 ctrl->next = NULL;
 447         } else {
 448                 ctrl->next = shpchp_ctrl_list;
 449                 shpchp_ctrl_list = ctrl;
 450         }
 451
 452         shpchp_create_ctrl_files(ctrl);
 453
 454         return 0;
 455
 456 err_out_free_ctrl_slot:
 457         cleanup_slots(ctrl);
 458 err_out_free_ctrl_bus:
 459         kfree(ctrl->pci_bus);
 460 err_out_unmap_mmio_region:
 461         ctrl->hpc_ops->release_ctlr(ctrl);
 462 err_out_free_ctrl:
 463         kfree(ctrl);
 464 err_out_none:
 465         return -ENODEV;
 466 }
 467
 468
 469 static int shpc_start_thread(void)
 470 {
 471         int loop;
 472         int retval = 0;
 473
 474         dbg("Initialize + Start the notification/polling mechanism \n");
 475
 476         retval = shpchp_event_start_thread();
 477         if (retval) {
 478                 dbg("shpchp_event_start_thread() failed\n");
 479                 return retval;
 480         }
 481
 482         dbg("Initialize slot lists\n");
 483         /* One slot list for each bus in the system */
 484         for (loop = 0; loop < 256; loop++) {
 485                 shpchp_slot_list[loop] = NULL;
 486         }
 487
 488         return retval;
 489 }
 490
 491 static void __exit unload_shpchpd(void)
 492 {
 493         struct pci_func *next;
 494         struct pci_func *TempSlot;
 495         int loop;
 496         struct controller *ctrl;
 497         struct controller *tctrl;
 498
 499         ctrl = shpchp_ctrl_list;
 500
 501         while (ctrl) {
 502                 cleanup_slots(ctrl);
 503
 504                 kfree (ctrl->pci_bus);
 505
 506                 dbg("%s: calling release_ctlr\n", __FUNCTION__);
 507                 ctrl->hpc_ops->release_ctlr(ctrl);
 508
 509                 tctrl = ctrl;
 510                 ctrl = ctrl->next;
 511
 512                 kfree(tctrl);
 513         }
 514
 515         for (loop = 0; loop < 256; loop++) {
 516                 next = shpchp_slot_list[loop];
 517                 while (next != NULL) {
 518                         TempSlot = next;
 519                         next = next->next;
 520                         kfree(TempSlot);
 521                 }
 522         }
 523
 524         /* Stop the notification mechanism */
 525         shpchp_event_stop_thread();
 526
 527 }
 528
 529
 530 static struct pci_device_id shpcd_pci_tbl[] = {
 531         {
 532         .class =        ((PCI_CLASS_BRIDGE_PCI << 8) | 0x00),
 533         .class_mask =   ~0,
 534         .vendor =       PCI_ANY_ID,
 535         .device =       PCI_ANY_ID,
 536         .subvendor =    PCI_ANY_ID,
 537         .subdevice =    PCI_ANY_ID,
 538         },
 539
 540         { /* end: all zeroes */ }
 541 };
 542
 543 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
 544
 545
 546
 547 static struct pci_driver shpc_driver = {
 548         .name =         SHPC_MODULE_NAME,
 549         .id_table =     shpcd_pci_tbl,
 550         .probe =        shpc_probe,
 551         /* remove:      shpc_remove_one, */
 552 };
 553
 554
 555
 556 static int __init shpcd_init(void)
 557 {
 558         int retval = 0;
 559
 560 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
 561         shpchp_poll_mode = 1;
 562 #endif
 563
 564         retval = shpc_start_thread();
 565         if (retval)
 566                 goto error_hpc_init;
 567
 568         retval = pci_register_driver(&shpc_driver);
 569         dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
 570         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 571
 572 error_hpc_init:
 573         if (retval) {
 574                 shpchp_event_stop_thread();
 575         }
 576         return retval;
 577 }
 578
 579 static void __exit shpcd_cleanup(void)
 580 {
 581         dbg("unload_shpchpd()\n");
 582         unload_shpchpd();
 583
 584         dbg("pci_unregister_driver\n");
 585         pci_unregister_driver(&shpc_driver);
 586
 587         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 588 }
 589
 590 module_init(shpcd_init);
 591 module_exit(shpcd_cleanup);