drivers/pci/hotplug/acpiphp_core.c

   1 /*
   2  * ACPI PCI 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) 2002 Hiroshi Aono (h-aono@ap.jp.nec.com)
   8  * Copyright (C) 2002,2003 Takayoshi Kochi (t-kochi@bq.jp.nec.com)
   9  * Copyright (C) 2002,2003 NEC Corporation
  10  * Copyright (C) 2003-2005 Matthew Wilcox (matthew.wilcox@hp.com)
  11  * Copyright (C) 2003-2005 Hewlett Packard
  12  *
  13  * All rights reserved.
  14  *
  15  * This program is free software; you can redistribute it and/or modify
  16  * it under the terms of the GNU General Public License as published by
  17  * the Free Software Foundation; either version 2 of the License, or (at
  18  * your option) any later version.
  19  *
  20  * This program is distributed in the hope that it will be useful, but
  21  * WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
  23  * NON INFRINGEMENT.  See the GNU General Public License for more
  24  * details.
  25  *
  26  * You should have received a copy of the GNU General Public License
  27  * along with this program; if not, write to the Free Software
  28  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  29  *
  30  * Send feedback to <kristen.c.accardi@intel.com>
  31  *
  32  */
  33
  34 #include <linux/init.h>
  35 #include <linux/module.h>
  36 #include <linux/moduleparam.h>
  37
  38 #include <linux/kernel.h>
  39 #include <linux/pci.h>
  40 #include <linux/pci-acpi.h>
  41 #include <linux/pci_hotplug.h>
  42 #include <linux/slab.h>
  43 #include <linux/smp.h>
  44 #include "acpiphp.h"
  45
  46 #define MY_NAME "acpiphp"
  47
  48 /* name size which is used for entries in pcihpfs */
  49 #define SLOT_NAME_SIZE  21              /* {_SUN} */
  50
  51 bool acpiphp_debug;
  52 bool acpiphp_disabled;
  53
  54 /* local variables */
  55 static struct acpiphp_attention_info *attention_info;
  56
  57 #define DRIVER_VERSION  "0.5"
  58 #define DRIVER_AUTHOR   "Greg Kroah-Hartman <gregkh@us.ibm.com>, Takayoshi Kochi <t-kochi@bq.jp.nec.com>, Matthew Wilcox <willy@hp.com>"
  59 #define DRIVER_DESC     "ACPI Hot Plug PCI Controller Driver"
  60
  61 MODULE_AUTHOR(DRIVER_AUTHOR);
  62 MODULE_DESCRIPTION(DRIVER_DESC);
  63 MODULE_LICENSE("GPL");
  64 MODULE_PARM_DESC(debug, "Debugging mode enabled or not");
  65 MODULE_PARM_DESC(disable, "disable acpiphp driver");
  66 module_param_named(debug, acpiphp_debug, bool, 0644);
  67 module_param_named(disable, acpiphp_disabled, bool, 0444);
  68
  69 /* export the attention callback registration methods */
  70 EXPORT_SYMBOL_GPL(acpiphp_register_attention);
  71 EXPORT_SYMBOL_GPL(acpiphp_unregister_attention);
  72
  73 static int enable_slot          (struct hotplug_slot *slot);
  74 static int disable_slot         (struct hotplug_slot *slot);
  75 static int set_attention_status (struct hotplug_slot *slot, u8 value);
  76 static int get_power_status     (struct hotplug_slot *slot, u8 *value);
  77 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
  78 static int get_latch_status     (struct hotplug_slot *slot, u8 *value);
  79 static int get_adapter_status   (struct hotplug_slot *slot, u8 *value);
  80
  81 static struct hotplug_slot_ops acpi_hotplug_slot_ops = {
  82         .enable_slot            = enable_slot,
  83         .disable_slot           = disable_slot,
  84         .set_attention_status   = set_attention_status,
  85         .get_power_status       = get_power_status,
  86         .get_attention_status   = get_attention_status,
  87         .get_latch_status       = get_latch_status,
  88         .get_adapter_status     = get_adapter_status,
  89 };
  90
  91 /**
  92  * acpiphp_register_attention - set attention LED callback
  93  * @info: must be completely filled with LED callbacks
  94  *
  95  * Description: This is used to register a hardware specific ACPI
  96  * driver that manipulates the attention LED.  All the fields in
  97  * info must be set.
  98  */
  99 int acpiphp_register_attention(struct acpiphp_attention_info *info)
 100 {
 101         int retval = -EINVAL;
 102
 103         if (info && info->owner && info->set_attn &&
 104                         info->get_attn && !attention_info) {
 105                 retval = 0;
 106                 attention_info = info;
 107         }
 108         return retval;
 109 }
 110
 111
 112 /**
 113  * acpiphp_unregister_attention - unset attention LED callback
 114  * @info: must match the pointer used to register
 115  *
 116  * Description: This is used to un-register a hardware specific acpi
 117  * driver that manipulates the attention LED.  The pointer to the
 118  * info struct must be the same as the one used to set it.
 119  */
 120 int acpiphp_unregister_attention(struct acpiphp_attention_info *info)
 121 {
 122         int retval = -EINVAL;
 123
 124         if (info && attention_info == info) {
 125                 attention_info = NULL;
 126                 retval = 0;
 127         }
 128         return retval;
 129 }
 130
 131
 132 /**
 133  * enable_slot - power on and enable a slot
 134  * @hotplug_slot: slot to enable
 135  *
 136  * Actual tasks are done in acpiphp_enable_slot()
 137  */
 138 static int enable_slot(struct hotplug_slot *hotplug_slot)
 139 {
 140         struct slot *slot = hotplug_slot->private;
 141
 142         dbg("%s - physical_slot = %s\n", __func__, slot_name(slot));
 143
 144         /* enable the specified slot */
 145         return acpiphp_enable_slot(slot->acpi_slot);
 146 }
 147
 148
 149 /**
 150  * disable_slot - disable and power off a slot
 151  * @hotplug_slot: slot to disable
 152  *
 153  * Actual tasks are done in acpiphp_disable_slot()
 154  */
 155 static int disable_slot(struct hotplug_slot *hotplug_slot)
 156 {
 157         struct slot *slot = hotplug_slot->private;
 158
 159         dbg("%s - physical_slot = %s\n", __func__, slot_name(slot));
 160
 161         /* disable the specified slot */
 162         return acpiphp_disable_and_eject_slot(slot->acpi_slot);
 163 }
 164
 165
 166 /**
 167  * set_attention_status - set attention LED
 168  * @hotplug_slot: slot to set attention LED on
 169  * @status: value to set attention LED to (0 or 1)
 170  *
 171  * attention status LED, so we use a callback that
 172  * was registered with us.  This allows hardware specific
 173  * ACPI implementations to blink the light for us.
 174  */
 175  static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
 176  {
 177         int retval = -ENODEV;
 178
 179         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot_name(hotplug_slot));
 180
 181         if (attention_info && try_module_get(attention_info->owner)) {
 182                 retval = attention_info->set_attn(hotplug_slot, status);
 183                 module_put(attention_info->owner);
 184         } else
 185                 attention_info = NULL;
 186         return retval;
 187  }
 188
 189
 190 /**
 191  * get_power_status - get power status of a slot
 192  * @hotplug_slot: slot to get status
 193  * @value: pointer to store status
 194  *
 195  * Some platforms may not implement _STA method properly.
 196  * In that case, the value returned may not be reliable.
 197  */
 198 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
 199 {
 200         struct slot *slot = hotplug_slot->private;
 201
 202         dbg("%s - physical_slot = %s\n", __func__, slot_name(slot));
 203
 204         *value = acpiphp_get_power_status(slot->acpi_slot);
 205
 206         return 0;
 207 }
 208
 209
 210 /**
 211  * get_attention_status - get attention LED status
 212  * @hotplug_slot: slot to get status from
 213  * @value: returns with value of attention LED
 214  *
 215  * ACPI doesn't have known method to determine the state
 216  * of the attention status LED, so we use a callback that
 217  * was registered with us.  This allows hardware specific
 218  * ACPI implementations to determine its state.
 219  */
 220 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
 221 {
 222         int retval = -EINVAL;
 223
 224         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot_name(hotplug_slot));
 225
 226         if (attention_info && try_module_get(attention_info->owner)) {
 227                 retval = attention_info->get_attn(hotplug_slot, value);
 228                 module_put(attention_info->owner);
 229         } else
 230                 attention_info = NULL;
 231         return retval;
 232 }
 233
 234
 235 /**
 236  * get_latch_status - get latch status of a slot
 237  * @hotplug_slot: slot to get status
 238  * @value: pointer to store status
 239  *
 240  * ACPI doesn't provide any formal means to access latch status.
 241  * Instead, we fake latch status from _STA.
 242  */
 243 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
 244 {
 245         struct slot *slot = hotplug_slot->private;
 246
 247         dbg("%s - physical_slot = %s\n", __func__, slot_name(slot));
 248
 249         *value = acpiphp_get_latch_status(slot->acpi_slot);
 250
 251         return 0;
 252 }
 253
 254
 255 /**
 256  * get_adapter_status - get adapter status of a slot
 257  * @hotplug_slot: slot to get status
 258  * @value: pointer to store status
 259  *
 260  * ACPI doesn't provide any formal means to access adapter status.
 261  * Instead, we fake adapter status from _STA.
 262  */
 263 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
 264 {
 265         struct slot *slot = hotplug_slot->private;
 266
 267         dbg("%s - physical_slot = %s\n", __func__, slot_name(slot));
 268
 269         *value = acpiphp_get_adapter_status(slot->acpi_slot);
 270
 271         return 0;
 272 }
 273
 274 /**
 275  * release_slot - free up the memory used by a slot
 276  * @hotplug_slot: slot to free
 277  */
 278 static void release_slot(struct hotplug_slot *hotplug_slot)
 279 {
 280         struct slot *slot = hotplug_slot->private;
 281
 282         dbg("%s - physical_slot = %s\n", __func__, slot_name(slot));
 283
 284         kfree(slot->hotplug_slot);
 285         kfree(slot);
 286 }
 287
 288 /* callback routine to initialize 'struct slot' for each slot */
 289 int acpiphp_register_hotplug_slot(struct acpiphp_slot *acpiphp_slot,
 290                                   unsigned int sun)
 291 {
 292         struct slot *slot;
 293         int retval = -ENOMEM;
 294         char name[SLOT_NAME_SIZE];
 295
 296         slot = kzalloc(sizeof(*slot), GFP_KERNEL);
 297         if (!slot)
 298                 goto error;
 299
 300         slot->hotplug_slot = kzalloc(sizeof(*slot->hotplug_slot), GFP_KERNEL);
 301         if (!slot->hotplug_slot)
 302                 goto error_slot;
 303
 304         slot->hotplug_slot->info = &slot->info;
 305
 306         slot->hotplug_slot->private = slot;
 307         slot->hotplug_slot->release = &release_slot;
 308         slot->hotplug_slot->ops = &acpi_hotplug_slot_ops;
 309
 310         slot->acpi_slot = acpiphp_slot;
 311         slot->hotplug_slot->info->power_status = acpiphp_get_power_status(slot->acpi_slot);
 312         slot->hotplug_slot->info->attention_status = 0;
 313         slot->hotplug_slot->info->latch_status = acpiphp_get_latch_status(slot->acpi_slot);
 314         slot->hotplug_slot->info->adapter_status = acpiphp_get_adapter_status(slot->acpi_slot);
 315
 316         acpiphp_slot->slot = slot;
 317         slot->sun = sun;
 318         snprintf(name, SLOT_NAME_SIZE, "%u", sun);
 319
 320         retval = pci_hp_register(slot->hotplug_slot, acpiphp_slot->bus,
 321                                  acpiphp_slot->device, name);
 322         if (retval == -EBUSY)
 323                 goto error_hpslot;
 324         if (retval) {
 325                 err("pci_hp_register failed with error %d\n", retval);
 326                 goto error_hpslot;
 327         }
 328
 329         info("Slot [%s] registered\n", slot_name(slot));
 330
 331         return 0;
 332 error_hpslot:
 333         kfree(slot->hotplug_slot);
 334 error_slot:
 335         kfree(slot);
 336 error:
 337         return retval;
 338 }
 339
 340
 341 void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *acpiphp_slot)
 342 {
 343         struct slot *slot = acpiphp_slot->slot;
 344         int retval = 0;
 345
 346         info("Slot [%s] unregistered\n", slot_name(slot));
 347
 348         retval = pci_hp_deregister(slot->hotplug_slot);
 349         if (retval)
 350                 err("pci_hp_deregister failed with error %d\n", retval);
 351 }
 352
 353
 354 void __init acpiphp_init(void)
 355 {
 356         info(DRIVER_DESC " version: " DRIVER_VERSION "%s\n",
 357                 acpiphp_disabled ? ", disabled by user; please report a bug"
 358                                  : "");
 359 }