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 <linux/workqueue.h>
  36 #include "shpchp.h"
  37
  38 /* Global variables */
  39 int shpchp_debug;
  40 int shpchp_poll_mode;
  41 int shpchp_poll_time;
  42 struct workqueue_struct *shpchp_wq;
  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     "Standard Hot Plug PCI Controller Driver"
  47
  48 MODULE_AUTHOR(DRIVER_AUTHOR);
  49 MODULE_DESCRIPTION(DRIVER_DESC);
  50 MODULE_LICENSE("GPL");
  51
  52 module_param(shpchp_debug, bool, 0644);
  53 module_param(shpchp_poll_mode, bool, 0644);
  54 module_param(shpchp_poll_time, int, 0644);
  55 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
  56 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
  57 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
  58
  59 #define SHPC_MODULE_NAME "shpchp"
  60
  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_address          (struct hotplug_slot *slot, u32 *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 shpchp_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_address =          get_address,
  82         .get_max_bus_speed =    get_max_bus_speed,
  83         .get_cur_bus_speed =    get_cur_bus_speed,
  84 };
  85
  86 /**
  87  * release_slot - free up the memory used by a slot
  88  * @hotplug_slot: slot to free
  89  */
  90 static void release_slot(struct hotplug_slot *hotplug_slot)
  91 {
  92         struct slot *slot = hotplug_slot->private;
  93
  94         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
  95
  96         kfree(slot->hotplug_slot->info);
  97         kfree(slot->hotplug_slot);
  98         kfree(slot);
  99 }
 100
 101 static void make_slot_name(struct slot *slot)
 102 {
 103         snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
 104                  slot->bus, slot->number);
 105 }
 106
 107
 108
 109
 110 static int
 111 shpchprm_get_physical_slot_number(struct controller *ctrl, u32 *sun,
 112                                 u8 busnum, u8 devnum)
 113 {
 114         int offset = devnum - ctrl->slot_device_offset;
 115
 116         dbg("%s: ctrl->slot_num_inc %d, offset %d\n", __FUNCTION__,
 117                         ctrl->slot_num_inc, offset);
 118         *sun = (u8) (ctrl->first_slot + ctrl->slot_num_inc *offset);
 119         return 0;
 120 }
 121
 122
 123
 124 static int init_slots(struct controller *ctrl)
 125 {
 126         struct slot *slot;
 127         struct hotplug_slot *hotplug_slot;
 128         struct hotplug_slot_info *info;
 129         int retval = -ENOMEM;
 130         int i;
 131         u32 sun;
 132
 133         for (i = 0; i < ctrl->num_slots; i++) {
 134                 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
 135                 if (!slot)
 136                         goto error;
 137
 138                 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
 139                 if (!hotplug_slot)
 140                         goto error_slot;
 141                 slot->hotplug_slot = hotplug_slot;
 142
 143                 info = kzalloc(sizeof(*info), GFP_KERNEL);
 144                 if (!info)
 145                         goto error_hpslot;
 146                 hotplug_slot->info = info;
 147
 148                 hotplug_slot->name = slot->name;
 149
 150                 slot->hp_slot = i;
 151                 slot->ctrl = ctrl;
 152                 slot->bus = ctrl->slot_bus;
 153                 slot->device = ctrl->slot_device_offset + i;
 154                 slot->hpc_ops = ctrl->hpc_ops;
 155                 mutex_init(&slot->lock);
 156
 157                 if (shpchprm_get_physical_slot_number(ctrl, &sun,
 158                                                       slot->bus, slot->device))
 159                         goto error_info;
 160
 161                 slot->number = sun;
 162                 INIT_WORK(&slot->work, queue_pushbutton_work, slot);
 163
 164                 /* register this slot with the hotplug pci core */
 165                 hotplug_slot->private = slot;
 166                 hotplug_slot->release = &release_slot;
 167                 make_slot_name(slot);
 168                 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
 169
 170                 get_power_status(hotplug_slot, &info->power_status);
 171                 get_attention_status(hotplug_slot, &info->attention_status);
 172                 get_latch_status(hotplug_slot, &info->latch_status);
 173                 get_adapter_status(hotplug_slot, &info->adapter_status);
 174
 175                 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
 176                     "slot_device_offset=%x\n", slot->bus, slot->device,
 177                     slot->hp_slot, slot->number, ctrl->slot_device_offset);
 178                 retval = pci_hp_register(slot->hotplug_slot);
 179                 if (retval) {
 180                         err("pci_hp_register failed with error %d\n", retval);
 181                         goto error_info;
 182                 }
 183
 184                 list_add(&slot->slot_list, &ctrl->slot_list);
 185         }
 186
 187         return 0;
 188 error_info:
 189         kfree(info);
 190 error_hpslot:
 191         kfree(hotplug_slot);
 192 error_slot:
 193         kfree(slot);
 194 error:
 195         return retval;
 196 }
 197
 198 void cleanup_slots(struct controller *ctrl)
 199 {
 200         struct list_head *tmp;
 201         struct list_head *next;
 202         struct slot *slot;
 203
 204         list_for_each_safe(tmp, next, &ctrl->slot_list) {
 205                 slot = list_entry(tmp, struct slot, slot_list);
 206                 list_del(&slot->slot_list);
 207                 cancel_delayed_work(&slot->work);
 208                 flush_scheduled_work();
 209                 flush_workqueue(shpchp_wq);
 210                 pci_hp_deregister(slot->hotplug_slot);
 211         }
 212 }
 213
 214 static int get_ctlr_slot_config(struct controller *ctrl)
 215 {
 216         int num_ctlr_slots;
 217         int first_device_num;
 218         int physical_slot_num;
 219         int updown;
 220         int rc;
 221         int flags;
 222
 223         rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots,
 224                                        &first_device_num, &physical_slot_num,
 225                                        &updown, &flags);
 226         if (rc) {
 227                 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n",
 228                     __FUNCTION__, ctrl->bus, ctrl->device);
 229                 return -1;
 230         }
 231
 232         ctrl->num_slots = num_ctlr_slots;
 233         ctrl->slot_device_offset = first_device_num;
 234         ctrl->first_slot = physical_slot_num;
 235         ctrl->slot_num_inc = updown;            /* either -1 or 1 */
 236
 237         dbg("%s: num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d "
 238             "(%x:%x)\n", __FUNCTION__, num_ctlr_slots, first_device_num,
 239             physical_slot_num, updown, ctrl->bus, ctrl->device);
 240
 241         return 0;
 242 }
 243
 244 /*
 245  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 246  */
 247 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
 248 {
 249         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 250
 251         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 252
 253         hotplug_slot->info->attention_status = status;
 254         slot->hpc_ops->set_attention_status(slot, status);
 255
 256         return 0;
 257 }
 258
 259 static int enable_slot (struct hotplug_slot *hotplug_slot)
 260 {
 261         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 262
 263         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 264
 265         return shpchp_sysfs_enable_slot(slot);
 266 }
 267
 268 static int disable_slot (struct hotplug_slot *hotplug_slot)
 269 {
 270         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 271
 272         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 273
 274         return shpchp_sysfs_disable_slot(slot);
 275 }
 276
 277 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
 278 {
 279         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 280         int retval;
 281
 282         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 283
 284         retval = slot->hpc_ops->get_power_status(slot, value);
 285         if (retval < 0)
 286                 *value = hotplug_slot->info->power_status;
 287
 288         return 0;
 289 }
 290
 291 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
 292 {
 293         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 294         int retval;
 295
 296         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 297
 298         retval = slot->hpc_ops->get_attention_status(slot, value);
 299         if (retval < 0)
 300                 *value = hotplug_slot->info->attention_status;
 301
 302         return 0;
 303 }
 304
 305 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
 306 {
 307         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 308         int retval;
 309
 310         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 311
 312         retval = slot->hpc_ops->get_latch_status(slot, value);
 313         if (retval < 0)
 314                 *value = hotplug_slot->info->latch_status;
 315
 316         return 0;
 317 }
 318
 319 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
 320 {
 321         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 322         int retval;
 323
 324         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 325
 326         retval = slot->hpc_ops->get_adapter_status(slot, value);
 327         if (retval < 0)
 328                 *value = hotplug_slot->info->adapter_status;
 329
 330         return 0;
 331 }
 332
 333 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
 334 {
 335         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 336         struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
 337
 338         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 339
 340         *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
 341
 342         return 0;
 343 }
 344
 345 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 346 {
 347         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 348         int retval;
 349
 350         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 351
 352         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 353         if (retval < 0)
 354                 *value = PCI_SPEED_UNKNOWN;
 355
 356         return 0;
 357 }
 358
 359 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 360 {
 361         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 362         int retval;
 363
 364         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 365
 366         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 367         if (retval < 0)
 368                 *value = PCI_SPEED_UNKNOWN;
 369
 370         return 0;
 371 }
 372
 373 static int is_shpc_capable(struct pci_dev *dev)
 374 {
 375        if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
 376                                PCI_DEVICE_ID_AMD_GOLAM_7450))
 377                return 1;
 378        if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
 379                return 1;
 380
 381        return 0;
 382 }
 383
 384 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
 385 {
 386         int rc;
 387         struct controller *ctrl;
 388         struct slot *t_slot;
 389         int first_device_num;   /* first PCI device number */
 390         int num_ctlr_slots;     /* number of slots implemented */
 391
 392         if (!is_shpc_capable(pdev))
 393                 return -ENODEV;
 394
 395         ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
 396         if (!ctrl) {
 397                 err("%s : out of memory\n", __FUNCTION__);
 398                 goto err_out_none;
 399         }
 400         INIT_LIST_HEAD(&ctrl->slot_list);
 401
 402         rc = shpc_init(ctrl, pdev);
 403         if (rc) {
 404                 dbg("%s: controller initialization failed\n",
 405                     SHPC_MODULE_NAME);
 406                 goto err_out_free_ctrl;
 407         }
 408
 409         pci_set_drvdata(pdev, ctrl);
 410
 411         ctrl->bus = pdev->bus->number;
 412         ctrl->slot_bus = pdev->subordinate->number;
 413         ctrl->device = PCI_SLOT(pdev->devfn);
 414         ctrl->function = PCI_FUNC(pdev->devfn);
 415
 416         dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n",
 417             ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
 418
 419         /*
 420          * Save configuration headers for this and subordinate PCI buses
 421          */
 422         rc = get_ctlr_slot_config(ctrl);
 423         if (rc) {
 424                 err(msg_initialization_err, rc);
 425                 goto err_out_release_ctlr;
 426         }
 427         first_device_num = ctrl->slot_device_offset;
 428         num_ctlr_slots = ctrl->num_slots;
 429
 430         ctrl->add_support = 1;
 431
 432         /* Setup the slot information structures */
 433         rc = init_slots(ctrl);
 434         if (rc) {
 435                 err(msg_initialization_err, 6);
 436                 goto err_out_release_ctlr;
 437         }
 438
 439         /* Now hpc_functions (slot->hpc_ops->functions) are ready  */
 440         t_slot = shpchp_find_slot(ctrl, first_device_num);
 441
 442         /* Check for operation bus speed */
 443         rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
 444         dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
 445
 446         if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
 447                 err(SHPC_MODULE_NAME ": Can't get current bus speed. "
 448                     "Set to 33MHz PCI.\n");
 449                 ctrl->speed = PCI_SPEED_33MHz;
 450         }
 451
 452         rc = shpchp_create_ctrl_files(ctrl);
 453         if (rc)
 454                 goto err_cleanup_slots;
 455
 456         return 0;
 457
 458 err_cleanup_slots:
 459         cleanup_slots(ctrl);
 460 err_out_release_ctlr:
 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 static void shpc_remove(struct pci_dev *dev)
 469 {
 470         struct controller *ctrl = pci_get_drvdata(dev);
 471
 472         shpchp_remove_ctrl_files(ctrl);
 473         ctrl->hpc_ops->release_ctlr(ctrl);
 474         kfree(ctrl);
 475 }
 476
 477 static struct pci_device_id shpcd_pci_tbl[] = {
 478         {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
 479         { /* end: all zeroes */ }
 480 };
 481 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
 482
 483 static struct pci_driver shpc_driver = {
 484         .name =         SHPC_MODULE_NAME,
 485         .id_table =     shpcd_pci_tbl,
 486         .probe =        shpc_probe,
 487         .remove =       shpc_remove,
 488 };
 489
 490 static int __init shpcd_init(void)
 491 {
 492         int retval = 0;
 493
 494 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
 495         shpchp_poll_mode = 1;
 496 #endif
 497
 498         retval = pci_register_driver(&shpc_driver);
 499         dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
 500         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 501         return retval;
 502 }
 503
 504 static void __exit shpcd_cleanup(void)
 505 {
 506         dbg("unload_shpchpd()\n");
 507         pci_unregister_driver(&shpc_driver);
 508         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 509 }
 510
 511 module_init(shpcd_init);
 512 module_exit(shpcd_cleanup);