2  * Standard Hot Plug Controller Driver
 
   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
 
  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.
 
  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
 
  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.
 
  26  * Send feedback to <greg@kroah.com>, <kristen.c.accardi@intel.com>
 
  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>
 
  37 /* Global variables */
 
  41 struct controller *shpchp_ctrl_list;    /* = NULL */
 
  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"
 
  47 MODULE_AUTHOR(DRIVER_AUTHOR);
 
  48 MODULE_DESCRIPTION(DRIVER_DESC);
 
  49 MODULE_LICENSE("GPL");
 
  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");
 
  58 #define SHPC_MODULE_NAME "shpchp"
 
  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);
 
  71 static struct hotplug_slot_ops shpchp_hotplug_slot_ops = {
 
  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,
 
  85  * release_slot - free up the memory used by a slot
 
  86  * @hotplug_slot: slot to free
 
  88 static void release_slot(struct hotplug_slot *hotplug_slot)
 
  90         struct slot *slot = hotplug_slot->private;
 
  92         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 
  94         kfree(slot->hotplug_slot->info);
 
  95         kfree(slot->hotplug_slot->name);
 
  96         kfree(slot->hotplug_slot);
 
 100 static int init_slots(struct controller *ctrl)
 
 102         struct slot *new_slot;
 
 105         u32 slot_number, sun;
 
 106         int result = -ENOMEM;
 
 108         number_of_slots = ctrl->num_slots;
 
 109         slot_device = ctrl->slot_device_offset;
 
 110         slot_number = ctrl->first_slot;
 
 112         while (number_of_slots) {
 
 113                 new_slot = (struct slot *) kmalloc(sizeof(struct slot), GFP_KERNEL);
 
 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)
 
 121                 memset(new_slot->hotplug_slot, 0, sizeof (struct hotplug_slot));
 
 123                 new_slot->hotplug_slot->info = kmalloc (sizeof (struct hotplug_slot_info), GFP_KERNEL);
 
 124                 if (!new_slot->hotplug_slot->info)
 
 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)
 
 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;
 
 137                 if (shpchprm_get_physical_slot_number(ctrl, &sun,
 
 138                                         new_slot->bus, new_slot->device))
 
 141                 new_slot->number = sun;
 
 142                 new_slot->hp_slot = slot_device - ctrl->slot_device_offset;
 
 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;
 
 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));
 
 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);
 
 159                         err ("pci_hp_register failed with error %d\n", result);
 
 163                 new_slot->next = ctrl->slot;
 
 164                 ctrl->slot = new_slot;
 
 168                 slot_number += ctrl->slot_num_inc;
 
 174         kfree(new_slot->hotplug_slot->name);
 
 176         kfree(new_slot->hotplug_slot->info);
 
 178         kfree(new_slot->hotplug_slot);
 
 185 static void cleanup_slots(struct controller *ctrl)
 
 187         struct slot *old_slot, *next_slot;
 
 189         old_slot = ctrl->slot;
 
 193                 next_slot = old_slot->next;
 
 194                 pci_hp_deregister(old_slot->hotplug_slot);
 
 195                 old_slot = next_slot;
 
 199 static int get_ctlr_slot_config(struct controller *ctrl)
 
 202         int first_device_num;
 
 203         int physical_slot_num;
 
 208         rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots, &first_device_num, &physical_slot_num, &updown, &flags);
 
 210                 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n", __FUNCTION__, ctrl->bus, ctrl->device);
 
 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 */
 
 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);
 
 227  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 
 229 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
 
 231         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 
 233         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 
 235         hotplug_slot->info->attention_status = status;
 
 236         slot->hpc_ops->set_attention_status(slot, status);
 
 242 static int enable_slot (struct hotplug_slot *hotplug_slot)
 
 244         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 
 246         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 
 248         return shpchp_enable_slot(slot);
 
 252 static int disable_slot (struct hotplug_slot *hotplug_slot)
 
 254         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 
 256         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 
 258         return shpchp_disable_slot(slot);
 
 261 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
 
 263         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 
 266         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 
 268         retval = slot->hpc_ops->get_power_status(slot, value);
 
 270                 *value = hotplug_slot->info->power_status;
 
 275 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
 
 277         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 
 280         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 
 282         retval = slot->hpc_ops->get_attention_status(slot, value);
 
 284                 *value = hotplug_slot->info->attention_status;
 
 289 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
 
 291         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 
 294         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 
 296         retval = slot->hpc_ops->get_latch_status(slot, value);
 
 298                 *value = hotplug_slot->info->latch_status;
 
 303 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
 
 305         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 
 308         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 
 310         retval = slot->hpc_ops->get_adapter_status(slot, value);
 
 312                 *value = hotplug_slot->info->adapter_status;
 
 317 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 
 319         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 
 322         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 
 324         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 
 326                 *value = PCI_SPEED_UNKNOWN;
 
 331 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 
 333         struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
 
 336         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 
 338         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 
 340                 *value = PCI_SPEED_UNKNOWN;
 
 345 static int is_shpc_capable(struct pci_dev *dev)
 
 347        if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
 
 348                                PCI_DEVICE_ID_AMD_GOLAM_7450))
 
 350        if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
 
 356 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
 
 359         struct controller *ctrl;
 
 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 */
 
 364         if (!is_shpc_capable(pdev))
 
 367         ctrl = (struct controller *) kmalloc(sizeof(struct controller), GFP_KERNEL);
 
 369                 err("%s : out of memory\n", __FUNCTION__);
 
 372         memset(ctrl, 0, sizeof(struct controller));
 
 374         rc = shpc_init(ctrl, pdev);
 
 376                 dbg("%s: controller initialization failed\n", SHPC_MODULE_NAME);
 
 377                 goto err_out_free_ctrl;
 
 380         ctrl->pci_dev = pdev;  /* pci_dev of the P2P bridge */
 
 382         pci_set_drvdata(pdev, ctrl);
 
 384         ctrl->pci_bus = kmalloc (sizeof (*ctrl->pci_bus), GFP_KERNEL);
 
 385         if (!ctrl->pci_bus) {
 
 386                 err("out of memory\n");
 
 388                 goto err_out_unmap_mmio_region;
 
 391         memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
 
 392         ctrl->bus = pdev->bus->number;
 
 393         ctrl->slot_bus = pdev->subordinate->number;
 
 395         ctrl->device = PCI_SLOT(pdev->devfn);
 
 396         ctrl->function = PCI_FUNC(pdev->devfn);
 
 397         dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
 
 400          *      Save configuration headers for this and subordinate PCI buses
 
 403         rc = get_ctlr_slot_config(ctrl);
 
 405                 err(msg_initialization_err, rc);
 
 406                 goto err_out_free_ctrl_bus;
 
 408         first_device_num = ctrl->slot_device_offset;
 
 409         num_ctlr_slots = ctrl->num_slots;
 
 411         ctrl->add_support = 1;
 
 413         /* Setup the slot information structures */
 
 414         rc = init_slots(ctrl);
 
 416                 err(msg_initialization_err, 6);
 
 417                 goto err_out_free_ctrl_slot;
 
 420         /* Now hpc_functions (slot->hpc_ops->functions) are ready  */
 
 421         t_slot = shpchp_find_slot(ctrl, first_device_num);
 
 423         /* Check for operation bus speed */
 
 424         rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
 
 425         dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
 
 427         if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
 
 428                 err(SHPC_MODULE_NAME ": Can't get current bus speed. Set to 33MHz PCI.\n");
 
 429                 ctrl->speed = PCI_SPEED_33MHz;
 
 432         /* Finish setting up the hot plug ctrl device */
 
 433         ctrl->next_event = 0;
 
 435         if (!shpchp_ctrl_list) {
 
 436                 shpchp_ctrl_list = ctrl;
 
 439                 ctrl->next = shpchp_ctrl_list;
 
 440                 shpchp_ctrl_list = ctrl;
 
 443         shpchp_create_ctrl_files(ctrl);
 
 447 err_out_free_ctrl_slot:
 
 449 err_out_free_ctrl_bus:
 
 450         kfree(ctrl->pci_bus);
 
 451 err_out_unmap_mmio_region:
 
 452         ctrl->hpc_ops->release_ctlr(ctrl);
 
 460 static int shpc_start_thread(void)
 
 464         dbg("Initialize + Start the notification/polling mechanism \n");
 
 466         retval = shpchp_event_start_thread();
 
 468                 dbg("shpchp_event_start_thread() failed\n");
 
 475 static void __exit unload_shpchpd(void)
 
 477         struct controller *ctrl;
 
 478         struct controller *tctrl;
 
 480         ctrl = shpchp_ctrl_list;
 
 483                 shpchp_remove_ctrl_files(ctrl);
 
 486                 kfree (ctrl->pci_bus);
 
 487                 ctrl->hpc_ops->release_ctlr(ctrl);
 
 495         /* Stop the notification mechanism */
 
 496         shpchp_event_stop_thread();
 
 501 static struct pci_device_id shpcd_pci_tbl[] = {
 
 503         .class =        ((PCI_CLASS_BRIDGE_PCI << 8) | 0x00),
 
 505         .vendor =       PCI_ANY_ID,
 
 506         .device =       PCI_ANY_ID,
 
 507         .subvendor =    PCI_ANY_ID,
 
 508         .subdevice =    PCI_ANY_ID,
 
 511         { /* end: all zeroes */ }
 
 514 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
 
 518 static struct pci_driver shpc_driver = {
 
 519         .name =         SHPC_MODULE_NAME,
 
 520         .id_table =     shpcd_pci_tbl,
 
 522         /* remove:      shpc_remove_one, */
 
 527 static int __init shpcd_init(void)
 
 531 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
 
 532         shpchp_poll_mode = 1;
 
 535         retval = shpc_start_thread();
 
 539         retval = pci_register_driver(&shpc_driver);
 
 540         dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
 
 541         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 
 545                 shpchp_event_stop_thread();
 
 550 static void __exit shpcd_cleanup(void)
 
 552         dbg("unload_shpchpd()\n");
 
 555         pci_unregister_driver(&shpc_driver);
 
 557         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 
 560 module_init(shpcd_init);
 
 561 module_exit(shpcd_cleanup);