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