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_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         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
  93                  __func__, slot_name(slot));
  94
  95         kfree(slot->hotplug_slot->info);
  96         kfree(slot->hotplug_slot);
  97         kfree(slot);
  98 }
  99
 100 static int init_slots(struct controller *ctrl)
 101 {
 102         struct slot *slot;
 103         struct hotplug_slot *hotplug_slot;
 104         struct hotplug_slot_info *info;
 105         char name[SLOT_NAME_SIZE];
 106         int retval = -ENOMEM;
 107         int i;
 108
 109         for (i = 0; i < ctrl->num_slots; i++) {
 110                 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
 111                 if (!slot)
 112                         goto error;
 113
 114                 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
 115                 if (!hotplug_slot)
 116                         goto error_slot;
 117                 slot->hotplug_slot = hotplug_slot;
 118
 119                 info = kzalloc(sizeof(*info), GFP_KERNEL);
 120                 if (!info)
 121                         goto error_hpslot;
 122                 hotplug_slot->info = info;
 123
 124                 slot->hp_slot = i;
 125                 slot->ctrl = ctrl;
 126                 slot->bus = ctrl->pci_dev->subordinate->number;
 127                 slot->device = ctrl->slot_device_offset + i;
 128                 slot->hpc_ops = ctrl->hpc_ops;
 129                 slot->number = ctrl->first_slot + (ctrl->slot_num_inc * i);
 130                 mutex_init(&slot->lock);
 131                 INIT_DELAYED_WORK(&slot->work, shpchp_queue_pushbutton_work);
 132
 133                 /* register this slot with the hotplug pci core */
 134                 hotplug_slot->private = slot;
 135                 hotplug_slot->release = &release_slot;
 136                 snprintf(name, SLOT_NAME_SIZE, "%d", slot->number);
 137                 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
 138
 139                 ctrl_dbg(ctrl, "Registering bus=%x dev=%x hp_slot=%x sun=%x "
 140                          "slot_device_offset=%x\n", slot->bus, slot->device,
 141                          slot->hp_slot, slot->number, ctrl->slot_device_offset);
 142                 retval = pci_hp_register(slot->hotplug_slot,
 143                                 ctrl->pci_dev->subordinate, slot->device, name);
 144                 if (retval) {
 145                         ctrl_err(ctrl, "pci_hp_register failed with error %d\n",
 146                                  retval);
 147                         goto error_info;
 148                 }
 149
 150                 get_power_status(hotplug_slot, &info->power_status);
 151                 get_attention_status(hotplug_slot, &info->attention_status);
 152                 get_latch_status(hotplug_slot, &info->latch_status);
 153                 get_adapter_status(hotplug_slot, &info->adapter_status);
 154
 155                 list_add(&slot->slot_list, &ctrl->slot_list);
 156         }
 157
 158         return 0;
 159 error_info:
 160         kfree(info);
 161 error_hpslot:
 162         kfree(hotplug_slot);
 163 error_slot:
 164         kfree(slot);
 165 error:
 166         return retval;
 167 }
 168
 169 void cleanup_slots(struct controller *ctrl)
 170 {
 171         struct list_head *tmp;
 172         struct list_head *next;
 173         struct slot *slot;
 174
 175         list_for_each_safe(tmp, next, &ctrl->slot_list) {
 176                 slot = list_entry(tmp, struct slot, slot_list);
 177                 list_del(&slot->slot_list);
 178                 cancel_delayed_work(&slot->work);
 179                 flush_scheduled_work();
 180                 flush_workqueue(shpchp_wq);
 181                 pci_hp_deregister(slot->hotplug_slot);
 182         }
 183 }
 184
 185 /*
 186  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 187  */
 188 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
 189 {
 190         struct slot *slot = get_slot(hotplug_slot);
 191
 192         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 193                  __func__, slot_name(slot));
 194
 195         hotplug_slot->info->attention_status = status;
 196         slot->hpc_ops->set_attention_status(slot, status);
 197
 198         return 0;
 199 }
 200
 201 static int enable_slot (struct hotplug_slot *hotplug_slot)
 202 {
 203         struct slot *slot = get_slot(hotplug_slot);
 204
 205         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 206                  __func__, slot_name(slot));
 207
 208         return shpchp_sysfs_enable_slot(slot);
 209 }
 210
 211 static int disable_slot (struct hotplug_slot *hotplug_slot)
 212 {
 213         struct slot *slot = get_slot(hotplug_slot);
 214
 215         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 216                  __func__, slot_name(slot));
 217
 218         return shpchp_sysfs_disable_slot(slot);
 219 }
 220
 221 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
 222 {
 223         struct slot *slot = get_slot(hotplug_slot);
 224         int retval;
 225
 226         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 227                  __func__, slot_name(slot));
 228
 229         retval = slot->hpc_ops->get_power_status(slot, value);
 230         if (retval < 0)
 231                 *value = hotplug_slot->info->power_status;
 232
 233         return 0;
 234 }
 235
 236 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
 237 {
 238         struct slot *slot = get_slot(hotplug_slot);
 239         int retval;
 240
 241         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 242                  __func__, slot_name(slot));
 243
 244         retval = slot->hpc_ops->get_attention_status(slot, value);
 245         if (retval < 0)
 246                 *value = hotplug_slot->info->attention_status;
 247
 248         return 0;
 249 }
 250
 251 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
 252 {
 253         struct slot *slot = get_slot(hotplug_slot);
 254         int retval;
 255
 256         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 257                  __func__, slot_name(slot));
 258
 259         retval = slot->hpc_ops->get_latch_status(slot, value);
 260         if (retval < 0)
 261                 *value = hotplug_slot->info->latch_status;
 262
 263         return 0;
 264 }
 265
 266 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
 267 {
 268         struct slot *slot = get_slot(hotplug_slot);
 269         int retval;
 270
 271         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 272                  __func__, slot_name(slot));
 273
 274         retval = slot->hpc_ops->get_adapter_status(slot, value);
 275         if (retval < 0)
 276                 *value = hotplug_slot->info->adapter_status;
 277
 278         return 0;
 279 }
 280
 281 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot,
 282                                 enum pci_bus_speed *value)
 283 {
 284         struct slot *slot = get_slot(hotplug_slot);
 285         int retval;
 286
 287         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 288                  __func__, slot_name(slot));
 289
 290         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 291         if (retval < 0)
 292                 *value = PCI_SPEED_UNKNOWN;
 293
 294         return 0;
 295 }
 296
 297 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 298 {
 299         struct slot *slot = get_slot(hotplug_slot);
 300         int retval;
 301
 302         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 303                  __func__, slot_name(slot));
 304
 305         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 306         if (retval < 0)
 307                 *value = PCI_SPEED_UNKNOWN;
 308
 309         return 0;
 310 }
 311
 312 static int is_shpc_capable(struct pci_dev *dev)
 313 {
 314         if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
 315                                                 PCI_DEVICE_ID_AMD_GOLAM_7450))
 316                 return 1;
 317         if (!pci_find_capability(dev, PCI_CAP_ID_SHPC))
 318                 return 0;
 319         if (get_hp_hw_control_from_firmware(dev))
 320                 return 0;
 321         return 1;
 322 }
 323
 324 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
 325 {
 326         int rc;
 327         struct controller *ctrl;
 328
 329         if (!is_shpc_capable(pdev))
 330                 return -ENODEV;
 331
 332         ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
 333         if (!ctrl) {
 334                 dev_err(&pdev->dev, "%s : out of memory\n", __func__);
 335                 goto err_out_none;
 336         }
 337         INIT_LIST_HEAD(&ctrl->slot_list);
 338
 339         rc = shpc_init(ctrl, pdev);
 340         if (rc) {
 341                 ctrl_dbg(ctrl, "controller initialization failed\n");
 342                 goto err_out_free_ctrl;
 343         }
 344
 345         pci_set_drvdata(pdev, ctrl);
 346
 347         /* Setup the slot information structures */
 348         rc = init_slots(ctrl);
 349         if (rc) {
 350                 ctrl_err(ctrl, "slot initialization failed\n");
 351                 goto err_out_release_ctlr;
 352         }
 353
 354         rc = shpchp_create_ctrl_files(ctrl);
 355         if (rc)
 356                 goto err_cleanup_slots;
 357
 358         return 0;
 359
 360 err_cleanup_slots:
 361         cleanup_slots(ctrl);
 362 err_out_release_ctlr:
 363         ctrl->hpc_ops->release_ctlr(ctrl);
 364 err_out_free_ctrl:
 365         kfree(ctrl);
 366 err_out_none:
 367         return -ENODEV;
 368 }
 369
 370 static void shpc_remove(struct pci_dev *dev)
 371 {
 372         struct controller *ctrl = pci_get_drvdata(dev);
 373
 374         shpchp_remove_ctrl_files(ctrl);
 375         ctrl->hpc_ops->release_ctlr(ctrl);
 376         kfree(ctrl);
 377 }
 378
 379 static struct pci_device_id shpcd_pci_tbl[] = {
 380         {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
 381         { /* end: all zeroes */ }
 382 };
 383 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
 384
 385 static struct pci_driver shpc_driver = {
 386         .name =         SHPC_MODULE_NAME,
 387         .id_table =     shpcd_pci_tbl,
 388         .probe =        shpc_probe,
 389         .remove =       shpc_remove,
 390 };
 391
 392 static int __init shpcd_init(void)
 393 {
 394         int retval = 0;
 395
 396         retval = pci_register_driver(&shpc_driver);
 397         dbg("%s: pci_register_driver = %d\n", __func__, retval);
 398         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 399         return retval;
 400 }
 401
 402 static void __exit shpcd_cleanup(void)
 403 {
 404         dbg("unload_shpchpd()\n");
 405         pci_unregister_driver(&shpc_driver);
 406         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 407 }
 408
 409 module_init(shpcd_init);
 410 module_exit(shpcd_cleanup);