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 LIST_HEAD(shpchp_ctrl_list);
  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_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 static int init_slots(struct controller *ctrl)
 108 {
 109         struct slot *slot;
 110         struct hotplug_slot *hotplug_slot;
 111         struct hotplug_slot_info *info;
 112         int retval = -ENOMEM;
 113         int i;
 114         u32 sun;
 115
 116         for (i = 0; i < ctrl->num_slots; i++) {
 117                 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
 118                 if (!slot)
 119                         goto error;
 120
 121                 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
 122                 if (!hotplug_slot)
 123                         goto error_slot;
 124                 slot->hotplug_slot = hotplug_slot;
 125
 126                 info = kzalloc(sizeof(*info), GFP_KERNEL);
 127                 if (!info)
 128                         goto error_hpslot;
 129                 hotplug_slot->info = info;
 130
 131                 hotplug_slot->name = slot->name;
 132
 133                 slot->hp_slot = i;
 134                 slot->ctrl = ctrl;
 135                 slot->bus = ctrl->slot_bus;
 136                 slot->device = ctrl->slot_device_offset + i;
 137                 slot->hpc_ops = ctrl->hpc_ops;
 138
 139                 if (shpchprm_get_physical_slot_number(ctrl, &sun,
 140                                                       slot->bus, slot->device))
 141                         goto error_info;
 142
 143                 slot->number = sun;
 144
 145                 /* register this slot with the hotplug pci core */
 146                 hotplug_slot->private = slot;
 147                 hotplug_slot->release = &release_slot;
 148                 make_slot_name(slot);
 149                 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
 150
 151                 get_power_status(hotplug_slot, &info->power_status);
 152                 get_attention_status(hotplug_slot, &info->attention_status);
 153                 get_latch_status(hotplug_slot, &info->latch_status);
 154                 get_adapter_status(hotplug_slot, &info->adapter_status);
 155
 156                 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
 157                     "slot_device_offset=%x\n", slot->bus, slot->device,
 158                     slot->hp_slot, slot->number, ctrl->slot_device_offset);
 159                 retval = pci_hp_register(slot->hotplug_slot);
 160                 if (retval) {
 161                         err("pci_hp_register failed with error %d\n", retval);
 162                         goto error_info;
 163                 }
 164
 165                 list_add(&slot->slot_list, &ctrl->slot_list);
 166         }
 167
 168         return 0;
 169 error_info:
 170         kfree(info);
 171 error_hpslot:
 172         kfree(hotplug_slot);
 173 error_slot:
 174         kfree(slot);
 175 error:
 176         return retval;
 177 }
 178
 179 static void cleanup_slots(struct controller *ctrl)
 180 {
 181         struct list_head *tmp;
 182         struct list_head *next;
 183         struct slot *slot;
 184
 185         list_for_each_safe(tmp, next, &ctrl->slot_list) {
 186                 slot = list_entry(tmp, struct slot, slot_list);
 187                 list_del(&slot->slot_list);
 188                 pci_hp_deregister(slot->hotplug_slot);
 189         }
 190 }
 191
 192 static int get_ctlr_slot_config(struct controller *ctrl)
 193 {
 194         int num_ctlr_slots;
 195         int first_device_num;
 196         int physical_slot_num;
 197         int updown;
 198         int rc;
 199         int flags;
 200
 201         rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots,
 202                                        &first_device_num, &physical_slot_num,
 203                                        &updown, &flags);
 204         if (rc) {
 205                 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n",
 206                     __FUNCTION__, ctrl->bus, ctrl->device);
 207                 return -1;
 208         }
 209
 210         ctrl->num_slots = num_ctlr_slots;
 211         ctrl->slot_device_offset = first_device_num;
 212         ctrl->first_slot = physical_slot_num;
 213         ctrl->slot_num_inc = updown;            /* either -1 or 1 */
 214
 215         dbg("%s: num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d "
 216             "(%x:%x)\n", __FUNCTION__, num_ctlr_slots, first_device_num,
 217             physical_slot_num, updown, ctrl->bus, ctrl->device);
 218
 219         return 0;
 220 }
 221
 222 /*
 223  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 224  */
 225 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
 226 {
 227         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 228
 229         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 230
 231         hotplug_slot->info->attention_status = status;
 232         slot->hpc_ops->set_attention_status(slot, status);
 233
 234         return 0;
 235 }
 236
 237 static int enable_slot (struct hotplug_slot *hotplug_slot)
 238 {
 239         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 240
 241         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 242
 243         return shpchp_enable_slot(slot);
 244 }
 245
 246 static int disable_slot (struct hotplug_slot *hotplug_slot)
 247 {
 248         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 249
 250         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 251
 252         return shpchp_disable_slot(slot);
 253 }
 254
 255 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
 256 {
 257         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 258         int retval;
 259
 260         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 261
 262         retval = slot->hpc_ops->get_power_status(slot, value);
 263         if (retval < 0)
 264                 *value = hotplug_slot->info->power_status;
 265
 266         return 0;
 267 }
 268
 269 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
 270 {
 271         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 272         int retval;
 273
 274         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 275
 276         retval = slot->hpc_ops->get_attention_status(slot, value);
 277         if (retval < 0)
 278                 *value = hotplug_slot->info->attention_status;
 279
 280         return 0;
 281 }
 282
 283 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
 284 {
 285         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 286         int retval;
 287
 288         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 289
 290         retval = slot->hpc_ops->get_latch_status(slot, value);
 291         if (retval < 0)
 292                 *value = hotplug_slot->info->latch_status;
 293
 294         return 0;
 295 }
 296
 297 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
 298 {
 299         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 300         int retval;
 301
 302         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 303
 304         retval = slot->hpc_ops->get_adapter_status(slot, value);
 305         if (retval < 0)
 306                 *value = hotplug_slot->info->adapter_status;
 307
 308         return 0;
 309 }
 310
 311 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
 312 {
 313         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 314         struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
 315
 316         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 317
 318         *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
 319
 320         return 0;
 321 }
 322
 323 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 324 {
 325         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 326         int retval;
 327
 328         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 329
 330         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 331         if (retval < 0)
 332                 *value = PCI_SPEED_UNKNOWN;
 333
 334         return 0;
 335 }
 336
 337 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 338 {
 339         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 340         int retval;
 341
 342         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 343
 344         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 345         if (retval < 0)
 346                 *value = PCI_SPEED_UNKNOWN;
 347
 348         return 0;
 349 }
 350
 351 static int is_shpc_capable(struct pci_dev *dev)
 352 {
 353        if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
 354                                PCI_DEVICE_ID_AMD_GOLAM_7450))
 355                return 1;
 356        if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
 357                return 1;
 358
 359        return 0;
 360 }
 361
 362 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
 363 {
 364         int rc;
 365         struct controller *ctrl;
 366         struct slot *t_slot;
 367         int first_device_num;   /* first PCI device number */
 368         int num_ctlr_slots;     /* number of slots implemented */
 369
 370         if (!is_shpc_capable(pdev))
 371                 return -ENODEV;
 372
 373         ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
 374         if (!ctrl) {
 375                 err("%s : out of memory\n", __FUNCTION__);
 376                 goto err_out_none;
 377         }
 378         INIT_LIST_HEAD(&ctrl->slot_list);
 379
 380         rc = shpc_init(ctrl, pdev);
 381         if (rc) {
 382                 dbg("%s: controller initialization failed\n",
 383                     SHPC_MODULE_NAME);
 384                 goto err_out_free_ctrl;
 385         }
 386
 387         pci_set_drvdata(pdev, ctrl);
 388
 389         ctrl->bus = pdev->bus->number;
 390         ctrl->slot_bus = pdev->subordinate->number;
 391         ctrl->device = PCI_SLOT(pdev->devfn);
 392         ctrl->function = PCI_FUNC(pdev->devfn);
 393
 394         dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n",
 395             ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
 396
 397         /*
 398          * Save configuration headers for this and subordinate PCI buses
 399          */
 400         rc = get_ctlr_slot_config(ctrl);
 401         if (rc) {
 402                 err(msg_initialization_err, rc);
 403                 goto err_out_unmap_mmio_region;
 404         }
 405         first_device_num = ctrl->slot_device_offset;
 406         num_ctlr_slots = ctrl->num_slots;
 407
 408         ctrl->add_support = 1;
 409
 410         /* Setup the slot information structures */
 411         rc = init_slots(ctrl);
 412         if (rc) {
 413                 err(msg_initialization_err, 6);
 414                 goto err_out_free_ctrl_slot;
 415         }
 416
 417         /* Now hpc_functions (slot->hpc_ops->functions) are ready  */
 418         t_slot = shpchp_find_slot(ctrl, first_device_num);
 419
 420         /* Check for operation bus speed */
 421         rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
 422         dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
 423
 424         if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
 425                 err(SHPC_MODULE_NAME ": Can't get current bus speed. "
 426                     "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         list_add(&ctrl->ctrl_list, &shpchp_ctrl_list);
 434
 435         shpchp_create_ctrl_files(ctrl);
 436
 437         return 0;
 438
 439 err_out_free_ctrl_slot:
 440         cleanup_slots(ctrl);
 441 err_out_unmap_mmio_region:
 442         ctrl->hpc_ops->release_ctlr(ctrl);
 443 err_out_free_ctrl:
 444         kfree(ctrl);
 445 err_out_none:
 446         return -ENODEV;
 447 }
 448
 449 static int shpc_start_thread(void)
 450 {
 451         int retval = 0;
 452
 453         dbg("Initialize + Start the notification/polling mechanism \n");
 454
 455         retval = shpchp_event_start_thread();
 456         if (retval) {
 457                 dbg("shpchp_event_start_thread() failed\n");
 458                 return retval;
 459         }
 460
 461         return retval;
 462 }
 463
 464 static void __exit unload_shpchpd(void)
 465 {
 466         struct list_head *tmp;
 467         struct list_head *next;
 468         struct controller *ctrl;
 469
 470         list_for_each_safe(tmp, next, &shpchp_ctrl_list) {
 471                 ctrl = list_entry(tmp, struct controller, ctrl_list);
 472                 shpchp_remove_ctrl_files(ctrl);
 473                 cleanup_slots(ctrl);
 474                 ctrl->hpc_ops->release_ctlr(ctrl);
 475                 kfree(ctrl);
 476         }
 477
 478         /* Stop the notification mechanism */
 479         shpchp_event_stop_thread();
 480
 481 }
 482
 483 static struct pci_device_id shpcd_pci_tbl[] = {
 484         {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
 485         { /* end: all zeroes */ }
 486 };
 487 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
 488
 489 static struct pci_driver shpc_driver = {
 490         .name =         SHPC_MODULE_NAME,
 491         .id_table =     shpcd_pci_tbl,
 492         .probe =        shpc_probe,
 493         /* remove:      shpc_remove_one, */
 494 };
 495
 496 static int __init shpcd_init(void)
 497 {
 498         int retval = 0;
 499
 500 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
 501         shpchp_poll_mode = 1;
 502 #endif
 503
 504         retval = shpc_start_thread();
 505         if (retval)
 506                 goto error_hpc_init;
 507
 508         retval = pci_register_driver(&shpc_driver);
 509         dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
 510         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 511
 512 error_hpc_init:
 513         if (retval) {
 514                 shpchp_event_stop_thread();
 515         }
 516         return retval;
 517 }
 518
 519 static void __exit shpcd_cleanup(void)
 520 {
 521         dbg("unload_shpchpd()\n");
 522         unload_shpchpd();
 523
 524         pci_unregister_driver(&shpc_driver);
 525
 526         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 527 }
 528
 529 module_init(shpcd_init);
 530 module_exit(shpcd_cleanup);