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_hotplug.h>
  41 #include <linux/slab.h>
  42 #include <linux/smp.h>
  43 #include "acpiphp.h"
  44
  45 #define MY_NAME "acpiphp"
  46
  47 static int debug;
  48 int acpiphp_debug;
  49
  50 /* local variables */
  51 static int num_slots;
  52 static struct acpiphp_attention_info *attention_info;
  53
  54 #define DRIVER_VERSION  "0.5"
  55 #define DRIVER_AUTHOR   "Greg Kroah-Hartman <gregkh@us.ibm.com>, Takayoshi Kochi <t-kochi@bq.jp.nec.com>, Matthew Wilcox <willy@hp.com>"
  56 #define DRIVER_DESC     "ACPI Hot Plug PCI Controller Driver"
  57
  58 MODULE_AUTHOR(DRIVER_AUTHOR);
  59 MODULE_DESCRIPTION(DRIVER_DESC);
  60 MODULE_LICENSE("GPL");
  61 MODULE_PARM_DESC(debug, "Debugging mode enabled or not");
  62 module_param(debug, bool, 0644);
  63
  64 /* export the attention callback registration methods */
  65 EXPORT_SYMBOL_GPL(acpiphp_register_attention);
  66 EXPORT_SYMBOL_GPL(acpiphp_unregister_attention);
  67
  68 static int enable_slot          (struct hotplug_slot *slot);
  69 static int disable_slot         (struct hotplug_slot *slot);
  70 static int set_attention_status (struct hotplug_slot *slot, u8 value);
  71 static int get_power_status     (struct hotplug_slot *slot, u8 *value);
  72 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
  73 static int get_address          (struct hotplug_slot *slot, u32 *value);
  74 static int get_latch_status     (struct hotplug_slot *slot, u8 *value);
  75 static int get_adapter_status   (struct hotplug_slot *slot, u8 *value);
  76
  77 static struct hotplug_slot_ops acpi_hotplug_slot_ops = {
  78         .owner                  = THIS_MODULE,
  79         .enable_slot            = enable_slot,
  80         .disable_slot           = disable_slot,
  81         .set_attention_status   = set_attention_status,
  82         .get_power_status       = get_power_status,
  83         .get_attention_status   = get_attention_status,
  84         .get_latch_status       = get_latch_status,
  85         .get_adapter_status     = get_adapter_status,
  86         .get_address            = get_address,
  87 };
  88
  89
  90 /**
  91  * acpiphp_register_attention - set attention LED callback
  92  * @info: must be completely filled with LED callbacks
  93  *
  94  * Description: this is used to register a hardware specific ACPI
  95  * driver that manipulates the attention LED.  All the fields in
  96  * info must be set.
  97  **/
  98 int acpiphp_register_attention(struct acpiphp_attention_info *info)
  99 {
 100         int retval = -EINVAL;
 101
 102         if (info && info->owner && info->set_attn &&
 103                         info->get_attn && !attention_info) {
 104                 retval = 0;
 105                 attention_info = info;
 106         }
 107         return retval;
 108 }
 109
 110
 111 /**
 112  * acpiphp_unregister_attention - unset attention LED callback
 113  * @info: must match the pointer used to register
 114  *
 115  * Description: this is used to un-register a hardware specific acpi
 116  * driver that manipulates the attention LED.  The pointer to the
 117  * info struct must be the same as the one used to set it.
 118  **/
 119 int acpiphp_unregister_attention(struct acpiphp_attention_info *info)
 120 {
 121         int retval = -EINVAL;
 122
 123         if (info && attention_info == info) {
 124                 attention_info = NULL;
 125                 retval = 0;
 126         }
 127         return retval;
 128 }
 129
 130
 131 /**
 132  * enable_slot - power on and enable a slot
 133  * @hotplug_slot: slot to enable
 134  *
 135  * Actual tasks are done in acpiphp_enable_slot()
 136  *
 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", __FUNCTION__, hotplug_slot->name);
 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  */
 156 static int disable_slot(struct hotplug_slot *hotplug_slot)
 157 {
 158         struct slot *slot = hotplug_slot->private;
 159         int retval;
 160
 161         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 162
 163         /* disable the specified slot */
 164         retval = acpiphp_disable_slot(slot->acpi_slot);
 165         if (!retval)
 166                 retval = acpiphp_eject_slot(slot->acpi_slot);
 167         return retval;
 168 }
 169
 170
 171  /**
 172   * set_attention_status - set attention LED
 173  * @hotplug_slot: slot to set attention LED on
 174  * @status: value to set attention LED to (0 or 1)
 175  *
 176  * attention status LED, so we use a callback that
 177  * was registered with us.  This allows hardware specific
 178  * ACPI implementations to blink the light for us.
 179  **/
 180  static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
 181  {
 182         int retval = -ENODEV;
 183
 184         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 185
 186         if (attention_info && try_module_get(attention_info->owner)) {
 187                 retval = attention_info->set_attn(hotplug_slot, status);
 188                 module_put(attention_info->owner);
 189         } else
 190                 attention_info = NULL;
 191         return retval;
 192  }
 193
 194
 195 /**
 196  * get_power_status - get power status of a slot
 197  * @hotplug_slot: slot to get status
 198  * @value: pointer to store status
 199  *
 200  * Some platforms may not implement _STA method properly.
 201  * In that case, the value returned may not be reliable.
 202  *
 203  */
 204 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
 205 {
 206         struct slot *slot = hotplug_slot->private;
 207
 208         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 209
 210         *value = acpiphp_get_power_status(slot->acpi_slot);
 211
 212         return 0;
 213 }
 214
 215
 216  /**
 217  * get_attention_status - get attention LED status
 218  * @hotplug_slot: slot to get status from
 219  * @value: returns with value of attention LED
 220  *
 221  * ACPI doesn't have known method to determine the state
 222  * of the attention status LED, so we use a callback that
 223  * was registered with us.  This allows hardware specific
 224  * ACPI implementations to determine its state
 225  **/
 226 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
 227 {
 228         int retval = -EINVAL;
 229
 230         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 231
 232         if (attention_info && try_module_get(attention_info->owner)) {
 233                 retval = attention_info->get_attn(hotplug_slot, value);
 234                 module_put(attention_info->owner);
 235         } else
 236                 attention_info = NULL;
 237         return retval;
 238 }
 239
 240
 241 /**
 242  * get_latch_status - get latch status of a slot
 243  * @hotplug_slot: slot to get status
 244  * @value: pointer to store status
 245  *
 246  * ACPI doesn't provide any formal means to access latch status.
 247  * Instead, we fake latch status from _STA
 248  *
 249  */
 250 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
 251 {
 252         struct slot *slot = hotplug_slot->private;
 253
 254         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 255
 256         *value = acpiphp_get_latch_status(slot->acpi_slot);
 257
 258         return 0;
 259 }
 260
 261
 262 /**
 263  * get_adapter_status - get adapter status of a slot
 264  * @hotplug_slot: slot to get status
 265  * @value: pointer to store status
 266  *
 267  * ACPI doesn't provide any formal means to access adapter status.
 268  * Instead, we fake adapter status from _STA
 269  *
 270  */
 271 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
 272 {
 273         struct slot *slot = hotplug_slot->private;
 274
 275         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 276
 277         *value = acpiphp_get_adapter_status(slot->acpi_slot);
 278
 279         return 0;
 280 }
 281
 282
 283 /**
 284  * get_address - get pci address of a slot
 285  * @hotplug_slot: slot to get status
 286  * @value: pointer to struct pci_busdev (seg, bus, dev)
 287  */
 288 static int get_address(struct hotplug_slot *hotplug_slot, u32 *value)
 289 {
 290         struct slot *slot = hotplug_slot->private;
 291
 292         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 293
 294         *value = acpiphp_get_address(slot->acpi_slot);
 295
 296         return 0;
 297 }
 298
 299 static int __init init_acpi(void)
 300 {
 301         int retval;
 302
 303         /* initialize internal data structure etc. */
 304         retval = acpiphp_glue_init();
 305
 306         /* read initial number of slots */
 307         if (!retval) {
 308                 num_slots = acpiphp_get_num_slots();
 309                 if (num_slots == 0) {
 310                         acpiphp_glue_exit();
 311                         retval = -ENODEV;
 312                 }
 313         }
 314
 315         return retval;
 316 }
 317
 318 /**
 319  * release_slot - free up the memory used by a slot
 320  * @hotplug_slot: slot to free
 321  */
 322 static void release_slot(struct hotplug_slot *hotplug_slot)
 323 {
 324         struct slot *slot = hotplug_slot->private;
 325
 326         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 327
 328         kfree(slot->hotplug_slot);
 329         kfree(slot);
 330 }
 331
 332 /* callback routine to initialize 'struct slot' for each slot */
 333 int acpiphp_register_hotplug_slot(struct acpiphp_slot *acpiphp_slot)
 334 {
 335         struct slot *slot;
 336         int retval = -ENOMEM;
 337
 338         slot = kzalloc(sizeof(*slot), GFP_KERNEL);
 339         if (!slot)
 340                 goto error;
 341
 342         slot->hotplug_slot = kzalloc(sizeof(*slot->hotplug_slot), GFP_KERNEL);
 343         if (!slot->hotplug_slot)
 344                 goto error_slot;
 345
 346         slot->hotplug_slot->info = &slot->info;
 347
 348         slot->hotplug_slot->name = slot->name;
 349
 350         slot->hotplug_slot->private = slot;
 351         slot->hotplug_slot->release = &release_slot;
 352         slot->hotplug_slot->ops = &acpi_hotplug_slot_ops;
 353
 354         slot->acpi_slot = acpiphp_slot;
 355         slot->hotplug_slot->info->power_status = acpiphp_get_power_status(slot->acpi_slot);
 356         slot->hotplug_slot->info->attention_status = 0;
 357         slot->hotplug_slot->info->latch_status = acpiphp_get_latch_status(slot->acpi_slot);
 358         slot->hotplug_slot->info->adapter_status = acpiphp_get_adapter_status(slot->acpi_slot);
 359         slot->hotplug_slot->info->max_bus_speed = PCI_SPEED_UNKNOWN;
 360         slot->hotplug_slot->info->cur_bus_speed = PCI_SPEED_UNKNOWN;
 361
 362         acpiphp_slot->slot = slot;
 363         snprintf(slot->name, sizeof(slot->name), "%u", slot->acpi_slot->sun);
 364
 365         retval = pci_hp_register(slot->hotplug_slot);
 366         if (retval) {
 367                 err("pci_hp_register failed with error %d\n", retval);
 368                 goto error_hpslot;
 369         }
 370
 371         info("Slot [%s] registered\n", slot->hotplug_slot->name);
 372
 373         return 0;
 374 error_hpslot:
 375         kfree(slot->hotplug_slot);
 376 error_slot:
 377         kfree(slot);
 378 error:
 379         return retval;
 380 }
 381
 382
 383 void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *acpiphp_slot)
 384 {
 385         struct slot *slot = acpiphp_slot->slot;
 386         int retval = 0;
 387
 388         info ("Slot [%s] unregistered\n", slot->hotplug_slot->name);
 389
 390         retval = pci_hp_deregister(slot->hotplug_slot);
 391         if (retval)
 392                 err("pci_hp_deregister failed with error %d\n", retval);
 393 }
 394
 395
 396 static int __init acpiphp_init(void)
 397 {
 398         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 399
 400         acpiphp_debug = debug;
 401
 402         /* read all the ACPI info from the system */
 403         return init_acpi();
 404 }
 405
 406
 407 static void __exit acpiphp_exit(void)
 408 {
 409         /* deallocate internal data structures etc. */
 410         acpiphp_glue_exit();
 411 }
 412
 413 module_init(acpiphp_init);
 414 module_exit(acpiphp_exit);