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  *
  11  * All rights reserved.
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or (at
  16  * your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful, but
  19  * WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
  21  * NON INFRINGEMENT.  See the GNU General Public License for more
  22  * details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program; if not, write to the Free Software
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  27  *
  28  * Send feedback to <gregkh@us.ibm.com>,
  29  *                  <t-kochi@bq.jp.nec.com>
  30  *
  31  */
  32
  33 #include <linux/init.h>
  34 #include <linux/module.h>
  35
  36 #include <linux/kernel.h>
  37 #include <linux/pci.h>
  38 #include <linux/slab.h>
  39 #include <linux/smp.h>
  40 #include <linux/smp_lock.h>
  41 #include "pci_hotplug.h"
  42 #include "acpiphp.h"
  43
  44 static LIST_HEAD(slot_list);
  45
  46 #if !defined(CONFIG_HOTPLUG_PCI_ACPI_MODULE)
  47         #define MY_NAME "acpiphp"
  48 #else
  49         #define MY_NAME THIS_MODULE->name
  50 #endif
  51
  52 static int debug;
  53 int acpiphp_debug;
  54
  55 /* local variables */
  56 static int num_slots;
  57
  58 #define DRIVER_VERSION  "0.4"
  59 #define DRIVER_AUTHOR   "Greg Kroah-Hartman <gregkh@us.ibm.com>, Takayoshi Kochi <t-kochi@bq.jp.nec.com>"
  60 #define DRIVER_DESC     "ACPI Hot Plug PCI Controller Driver"
  61
  62 MODULE_AUTHOR(DRIVER_AUTHOR);
  63 MODULE_DESCRIPTION(DRIVER_DESC);
  64 MODULE_LICENSE("GPL");
  65 MODULE_PARM(debug, "i");
  66 MODULE_PARM_DESC(debug, "Debugging mode enabled or not");
  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 hardware_test        (struct hotplug_slot *slot, u32 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 static int get_max_bus_speed    (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value);
  78 static int get_cur_bus_speed    (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value);
  79
  80 static struct hotplug_slot_ops acpi_hotplug_slot_ops = {
  81         .owner                  = THIS_MODULE,
  82         .enable_slot            = enable_slot,
  83         .disable_slot           = disable_slot,
  84         .set_attention_status   = set_attention_status,
  85         .hardware_test          = hardware_test,
  86         .get_power_status       = get_power_status,
  87         .get_attention_status   = get_attention_status,
  88         .get_latch_status       = get_latch_status,
  89         .get_adapter_status     = get_adapter_status,
  90         .get_address            = get_address,
  91         .get_max_bus_speed      = get_max_bus_speed,
  92         .get_cur_bus_speed      = get_cur_bus_speed,
  93 };
  94
  95
  96 /* Inline functions to check the sanity of a pointer that is passed to us */
  97 static inline int slot_paranoia_check (struct slot *slot, const char *function)
  98 {
  99         if (!slot) {
 100                 dbg("%s - slot == NULL\n", function);
 101                 return -1;
 102         }
 103         if (slot->magic != SLOT_MAGIC) {
 104                 dbg("%s - bad magic number for slot\n", function);
 105                 return -1;
 106         }
 107         if (!slot->hotplug_slot) {
 108                 dbg("%s - slot->hotplug_slot == NULL!\n", function);
 109                 return -1;
 110         }
 111         return 0;
 112 }
 113
 114
 115 static inline struct slot *get_slot (struct hotplug_slot *hotplug_slot, const char *function)
 116 {
 117         struct slot *slot;
 118
 119         if (!hotplug_slot) {
 120                 dbg("%s - hotplug_slot == NULL\n", function);
 121                 return NULL;
 122         }
 123
 124         slot = (struct slot *)hotplug_slot->private;
 125         if (slot_paranoia_check(slot, function))
 126                 return NULL;
 127         return slot;
 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 = get_slot(hotplug_slot, __FUNCTION__);
 141         int retval = 0;
 142
 143         if (slot == NULL)
 144                 return -ENODEV;
 145
 146         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 147
 148         /* enable the specified slot */
 149         retval = acpiphp_enable_slot(slot->acpi_slot);
 150
 151         return retval;
 152 }
 153
 154
 155 /**
 156  * disable_slot - disable and power off a slot
 157  * @hotplug_slot: slot to disable
 158  *
 159  * Actual tasks are done in acpiphp_disable_slot()
 160  *
 161  */
 162 static int disable_slot (struct hotplug_slot *hotplug_slot)
 163 {
 164         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 165         int retval = 0;
 166
 167         if (slot == NULL)
 168                 return -ENODEV;
 169
 170         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 171
 172         /* disable the specified slot */
 173         retval = acpiphp_disable_slot(slot->acpi_slot);
 174
 175         return retval;
 176 }
 177
 178
 179 /**
 180  * set_attention_status - set attention LED
 181  *
 182  * TBD:
 183  * ACPI doesn't have known method to manipulate
 184  * attention status LED.
 185  *
 186  */
 187 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
 188 {
 189         int retval = 0;
 190
 191         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 192
 193         switch (status) {
 194                 case 0:
 195                         /* FIXME turn light off */
 196                         hotplug_slot->info->attention_status = 0;
 197                         break;
 198
 199                 case 1:
 200                 default:
 201                         /* FIXME turn light on */
 202                         hotplug_slot->info->attention_status = 1;
 203                         break;
 204         }
 205
 206         return retval;
 207 }
 208
 209
 210 /**
 211  * hardware_test - hardware test
 212  *
 213  * We have nothing to do for now...
 214  *
 215  */
 216 static int hardware_test (struct hotplug_slot *hotplug_slot, u32 value)
 217 {
 218         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 219         int retval = 0;
 220
 221         if (slot == NULL)
 222                 return -ENODEV;
 223
 224         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 225
 226         err("No hardware tests are defined for this driver\n");
 227         retval = -ENODEV;
 228
 229         return retval;
 230 }
 231
 232
 233 /**
 234  * get_power_status - get power status of a slot
 235  * @hotplug_slot: slot to get status
 236  * @value: pointer to store status
 237  *
 238  * Some platforms may not implement _STA method properly.
 239  * In that case, the value returned may not be reliable.
 240  *
 241  */
 242 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
 243 {
 244         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 245         int retval = 0;
 246
 247         if (slot == NULL)
 248                 return -ENODEV;
 249
 250         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 251
 252         *value = acpiphp_get_power_status(slot->acpi_slot);
 253
 254         return retval;
 255 }
 256
 257
 258 /**
 259  * get_attention_status - get attention LED status
 260  *
 261  * TBD:
 262  * ACPI doesn't provide any formal means to access attention LED status.
 263  *
 264  */
 265 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
 266 {
 267         int retval = 0;
 268
 269         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 270
 271         *value = hotplug_slot->info->attention_status;
 272
 273         return retval;
 274 }
 275
 276
 277 /**
 278  * get_latch_status - get latch status of a slot
 279  * @hotplug_slot: slot to get status
 280  * @value: pointer to store status
 281  *
 282  * ACPI doesn't provide any formal means to access latch status.
 283  * Instead, we fake latch status from _STA
 284  *
 285  */
 286 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
 287 {
 288         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 289         int retval = 0;
 290
 291         if (slot == NULL)
 292                 return -ENODEV;
 293
 294         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 295
 296         *value = acpiphp_get_latch_status(slot->acpi_slot);
 297
 298         return retval;
 299 }
 300
 301
 302 /**
 303  * get_adapter_status - get adapter status of a slot
 304  * @hotplug_slot: slot to get status
 305  * @value: pointer to store status
 306  *
 307  * ACPI doesn't provide any formal means to access adapter status.
 308  * Instead, we fake adapter status from _STA
 309  *
 310  */
 311 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
 312 {
 313         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 314         int retval = 0;
 315
 316         if (slot == NULL)
 317                 return -ENODEV;
 318
 319         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 320
 321         *value = acpiphp_get_adapter_status(slot->acpi_slot);
 322
 323         return retval;
 324 }
 325
 326
 327 /**
 328  * get_address - get pci address of a slot
 329  * @hotplug_slot: slot to get status
 330  * @busdev: pointer to struct pci_busdev (seg, bus, dev)
 331  *
 332  */
 333 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
 334 {
 335         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 336         int retval = 0;
 337
 338         if (slot == NULL)
 339                 return -ENODEV;
 340
 341         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 342
 343         *value = acpiphp_get_address(slot->acpi_slot);
 344
 345         return retval;
 346 }
 347
 348
 349 /* return dummy value because ACPI doesn't provide any method... */
 350 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 351 {
 352         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 353
 354         if (slot == NULL)
 355                 return -ENODEV;
 356
 357         *value = PCI_SPEED_UNKNOWN;
 358
 359         return 0;
 360 }
 361
 362
 363 /* return dummy value because ACPI doesn't provide any method... */
 364 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 365 {
 366         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 367
 368         if (slot == NULL)
 369                 return -ENODEV;
 370
 371         *value = PCI_SPEED_UNKNOWN;
 372
 373         return 0;
 374 }
 375
 376
 377 static int __init init_acpi (void)
 378 {
 379         int retval;
 380
 381         /* initialize internal data structure etc. */
 382         retval = acpiphp_glue_init();
 383
 384         /* read initial number of slots */
 385         if (!retval) {
 386                 num_slots = acpiphp_get_num_slots();
 387                 if (num_slots == 0)
 388                         retval = -ENODEV;
 389         }
 390
 391         return retval;
 392 }
 393
 394
 395 /**
 396  * make_slot_name - make a slot name that appears in pcihpfs
 397  * @slot: slot to name
 398  *
 399  */
 400 static void make_slot_name (struct slot *slot)
 401 {
 402         snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%u",
 403                  slot->acpi_slot->sun);
 404 }
 405
 406 /**
 407  * release_slot - free up the memory used by a slot
 408  * @hotplug_slot: slot to free
 409  */
 410 static void release_slot(struct hotplug_slot *hotplug_slot)
 411 {
 412         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 413
 414         if (slot == NULL)
 415                 return;
 416
 417         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 418
 419         kfree(slot->hotplug_slot->info);
 420         kfree(slot->hotplug_slot->name);
 421         kfree(slot->hotplug_slot);
 422         kfree(slot);
 423 }
 424
 425 /**
 426  * init_slots - initialize 'struct slot' structures for each slot
 427  *
 428  */
 429 static int __init init_slots (void)
 430 {
 431         struct slot *slot;
 432         int retval = 0;
 433         int i;
 434
 435         for (i = 0; i < num_slots; ++i) {
 436                 slot = kmalloc(sizeof(struct slot), GFP_KERNEL);
 437                 if (!slot)
 438                         return -ENOMEM;
 439                 memset(slot, 0, sizeof(struct slot));
 440
 441                 slot->hotplug_slot = kmalloc(sizeof(struct hotplug_slot), GFP_KERNEL);
 442                 if (!slot->hotplug_slot) {
 443                         kfree(slot);
 444                         return -ENOMEM;
 445                 }
 446                 memset(slot->hotplug_slot, 0, sizeof(struct hotplug_slot));
 447
 448                 slot->hotplug_slot->info = kmalloc(sizeof(struct hotplug_slot_info), GFP_KERNEL);
 449                 if (!slot->hotplug_slot->info) {
 450                         kfree(slot->hotplug_slot);
 451                         kfree(slot);
 452                         return -ENOMEM;
 453                 }
 454                 memset(slot->hotplug_slot->info, 0, sizeof(struct hotplug_slot_info));
 455
 456                 slot->hotplug_slot->name = kmalloc(SLOT_NAME_SIZE, GFP_KERNEL);
 457                 if (!slot->hotplug_slot->name) {
 458                         kfree(slot->hotplug_slot->info);
 459                         kfree(slot->hotplug_slot);
 460                         kfree(slot);
 461                         return -ENOMEM;
 462                 }
 463
 464                 slot->magic = SLOT_MAGIC;
 465                 slot->number = i;
 466
 467                 slot->hotplug_slot->private = slot;
 468                 slot->hotplug_slot->release = &release_slot;
 469                 slot->hotplug_slot->ops = &acpi_hotplug_slot_ops;
 470
 471                 slot->acpi_slot = get_slot_from_id(i);
 472                 slot->hotplug_slot->info->power_status = acpiphp_get_power_status(slot->acpi_slot);
 473                 slot->hotplug_slot->info->attention_status = acpiphp_get_attention_status(slot->acpi_slot);
 474                 slot->hotplug_slot->info->latch_status = acpiphp_get_latch_status(slot->acpi_slot);
 475                 slot->hotplug_slot->info->adapter_status = acpiphp_get_adapter_status(slot->acpi_slot);
 476
 477                 make_slot_name(slot);
 478
 479                 retval = pci_hp_register(slot->hotplug_slot);
 480                 if (retval) {
 481                         err("pci_hp_register failed with error %d\n", retval);
 482                         release_slot(slot->hotplug_slot);
 483                         return retval;
 484                 }
 485
 486                 /* add slot to our internal list */
 487                 list_add(&slot->slot_list, &slot_list);
 488                 info("Slot [%s] registered\n", slot->hotplug_slot->name);
 489         }
 490
 491         return retval;
 492 }
 493
 494
 495 static void __exit cleanup_slots (void)
 496 {
 497         struct list_head *tmp, *n;
 498         struct slot *slot;
 499
 500         list_for_each_safe (tmp, n, &slot_list) {
 501                 /* memory will be freed in release_slot callback */
 502                 slot = list_entry(tmp, struct slot, slot_list);
 503                 list_del(&slot->slot_list);
 504                 pci_hp_deregister(slot->hotplug_slot);
 505         }
 506
 507         return;
 508 }
 509
 510
 511 static int __init acpiphp_init(void)
 512 {
 513         int retval;
 514
 515         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 516
 517         acpiphp_debug = debug;
 518
 519         /* read all the ACPI info from the system */
 520         retval = init_acpi();
 521         if (retval)
 522                 return retval;
 523
 524         retval = init_slots();
 525         if (retval)
 526                 return retval;
 527
 528         return 0;
 529 }
 530
 531
 532 static void __exit acpiphp_exit(void)
 533 {
 534         cleanup_slots();
 535         /* deallocate internal data structures etc. */
 536         acpiphp_glue_exit();
 537 }
 538
 539 module_init(acpiphp_init);
 540 module_exit(acpiphp_exit);