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