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