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