drivers/pci/hotplug/acpiphp_ibm.c

   1 /*
   2  * ACPI PCI Hot Plug IBM Extension
   3  *
   4  * Copyright (C) 2004 Vernon Mauery <vernux@us.ibm.com>
   5  * Copyright (C) 2004 IBM Corp.
   6  *
   7  * All rights reserved.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or (at
  12  * your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
  17  * NON INFRINGEMENT.  See the GNU General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23  *
  24  * Send feedback to <vernux@us.ibm.com>
  25  *
  26  */
  27
  28 #include <linux/init.h>
  29 #include <linux/module.h>
  30 #include <linux/kernel.h>
  31 #include <acpi/acpi_bus.h>
  32 #include <linux/sysfs.h>
  33 #include <linux/kobject.h>
  34 #include <asm/uaccess.h>
  35 #include <linux/moduleparam.h>
  36
  37 #include "acpiphp.h"
  38
  39 #define DRIVER_VERSION  "1.0.1"
  40 #define DRIVER_AUTHOR   "Irene Zubarev <zubarev@us.ibm.com>, Vernon Mauery <vernux@us.ibm.com>"
  41 #define DRIVER_DESC     "ACPI Hot Plug PCI Controller Driver IBM extension"
  42
  43 static int debug;
  44
  45 MODULE_AUTHOR(DRIVER_AUTHOR);
  46 MODULE_DESCRIPTION(DRIVER_DESC);
  47 MODULE_LICENSE("GPL");
  48 MODULE_VERSION(DRIVER_VERSION);
  49 module_param(debug, bool, 0644);
  50 MODULE_PARM_DESC(debug, " Debugging mode enabled or not");
  51 #define MY_NAME "acpiphp_ibm"
  52
  53 #undef dbg
  54 #define dbg(format, arg...)                             \
  55 do {                                                    \
  56         if (debug)                                      \
  57                 printk(KERN_DEBUG "%s: " format,        \
  58                                 MY_NAME , ## arg);      \
  59 } while (0)
  60
  61 #define FOUND_APCI 0x61504349
  62 /* these are the names for the IBM ACPI pseudo-device */
  63 #define IBM_HARDWARE_ID1 "IBM37D0"
  64 #define IBM_HARDWARE_ID2 "IBM37D4"
  65
  66 #define hpslot_to_sun(A) (((struct slot *)((A)->private))->acpi_slot->sun)
  67
  68 /* union apci_descriptor - allows access to the
  69  * various device descriptors that are embedded in the
  70  * aPCI table
  71  */
  72 union apci_descriptor {
  73         struct {
  74                 char sig[4];
  75                 u8   len;
  76         } header;
  77         struct {
  78                 u8  type;
  79                 u8  len;
  80                 u16 slot_id;
  81                 u8  bus_id;
  82                 u8  dev_num;
  83                 u8  slot_num;
  84                 u8  slot_attr[2];
  85                 u8  attn;
  86                 u8  status[2];
  87                 u8  sun;
  88                 u8  res[3];
  89         } slot;
  90         struct {
  91                 u8 type;
  92                 u8 len;
  93         } generic;
  94 };
  95
  96 /* struct notification - keeps info about the device
  97  * that cause the ACPI notification event
  98  */
  99 struct notification {
 100         struct acpi_device *device;
 101         u8                  event;
 102 };
 103
 104 static int ibm_set_attention_status(struct hotplug_slot *slot, u8 status);
 105 static int ibm_get_attention_status(struct hotplug_slot *slot, u8 *status);
 106 static void ibm_handle_events(acpi_handle handle, u32 event, void *context);
 107 static int ibm_get_table_from_acpi(char **bufp);
 108 static ssize_t ibm_read_apci_table(struct kobject *kobj,
 109                 char *buffer, loff_t pos, size_t size);
 110 static acpi_status __init ibm_find_acpi_device(acpi_handle handle,
 111                 u32 lvl, void *context, void **rv);
 112 static int __init ibm_acpiphp_init(void);
 113 static void __exit ibm_acpiphp_exit(void);
 114
 115 static acpi_handle ibm_acpi_handle;
 116 static struct notification ibm_note;
 117 static struct bin_attribute ibm_apci_table_attr = {
 118             .attr = {
 119                     .name = "apci_table",
 120                     .mode = S_IRUGO,
 121             },
 122             .read = ibm_read_apci_table,
 123             .write = NULL,
 124 };
 125 static struct acpiphp_attention_info ibm_attention_info =
 126 {
 127         .set_attn = ibm_set_attention_status,
 128         .get_attn = ibm_get_attention_status,
 129         .owner = THIS_MODULE,
 130 };
 131
 132 /**
 133  * ibm_slot_from_id - workaround for bad ibm hardware
 134  * @id: the slot number that linux refers to the slot by
 135  *
 136  * Description: this method returns the aCPI slot descriptor
 137  * corresponding to the Linux slot number.  This descriptor
 138  * has info about the aPCI slot id and attention status.
 139  * This descriptor must be freed using kfree when done.
 140  **/
 141 static union apci_descriptor *ibm_slot_from_id(int id)
 142 {
 143         int ind = 0, size;
 144         union apci_descriptor *ret = NULL, *des;
 145         char *table;
 146
 147         size = ibm_get_table_from_acpi(&table);
 148         des = (union apci_descriptor *)table;
 149         if (memcmp(des->header.sig, "aPCI", 4) != 0)
 150                 goto ibm_slot_done;
 151
 152         des = (union apci_descriptor *)&table[ind += des->header.len];
 153         while (ind < size && (des->generic.type != 0x82 ||
 154                         des->slot.slot_num != id)) {
 155                 des = (union apci_descriptor *)&table[ind += des->generic.len];
 156         }
 157
 158         if (ind < size && des->slot.slot_num == id)
 159                 ret = des;
 160
 161 ibm_slot_done:
 162         if (ret) {
 163                 ret = kmalloc(sizeof(union apci_descriptor), GFP_KERNEL);
 164                 memcpy(ret, des, sizeof(union apci_descriptor));
 165         }
 166         kfree(table);
 167         return ret;
 168 }
 169
 170 /**
 171  * ibm_set_attention_status - callback method to set the attention LED
 172  * @slot: the hotplug_slot to work with
 173  * @status: what to set the LED to (0 or 1)
 174  *
 175  * Description: this method is registered with the acpiphp module as a
 176  * callback to do the device specific task of setting the LED status
 177  **/
 178 static int ibm_set_attention_status(struct hotplug_slot *slot, u8 status)
 179 {
 180         union acpi_object args[2];
 181         struct acpi_object_list params = { .pointer = args, .count = 2 };
 182         acpi_status stat;
 183         unsigned long rc;
 184         union apci_descriptor *ibm_slot;
 185
 186         ibm_slot = ibm_slot_from_id(hpslot_to_sun(slot));
 187
 188         dbg("%s: set slot %d (%d) attention status to %d\n", __FUNCTION__,
 189                         ibm_slot->slot.slot_num, ibm_slot->slot.slot_id,
 190                         (status ? 1 : 0));
 191
 192         args[0].type = ACPI_TYPE_INTEGER;
 193         args[0].integer.value = ibm_slot->slot.slot_id;
 194         args[1].type = ACPI_TYPE_INTEGER;
 195         args[1].integer.value = (status) ? 1 : 0;
 196
 197         kfree(ibm_slot);
 198
 199         stat = acpi_evaluate_integer(ibm_acpi_handle, "APLS", &params, &rc);
 200         if (ACPI_FAILURE(stat)) {
 201                 err("APLS evaluation failed:  0x%08x\n", stat);
 202                 return -ENODEV;
 203         } else if (!rc) {
 204                 err("APLS method failed:  0x%08lx\n", rc);
 205                 return -ERANGE;
 206         }
 207         return 0;
 208 }
 209
 210 /**
 211  * ibm_get_attention_status - callback method to get attention LED status
 212  * @slot: the hotplug_slot to work with
 213  * @status: returns what the LED is set to (0 or 1)
 214  *
 215  * Description: this method is registered with the acpiphp module as a
 216  * callback to do the device specific task of getting the LED status
 217  *
 218  * Because there is no direct method of getting the LED status directly
 219  * from an ACPI call, we read the aPCI table and parse out our
 220  * slot descriptor to read the status from that.
 221  **/
 222 static int ibm_get_attention_status(struct hotplug_slot *slot, u8 *status)
 223 {
 224         union apci_descriptor *ibm_slot;
 225
 226         ibm_slot = ibm_slot_from_id(hpslot_to_sun(slot));
 227
 228         if (ibm_slot->slot.attn & 0xa0 || ibm_slot->slot.status[1] & 0x08)
 229                 *status = 1;
 230         else
 231                 *status = 0;
 232
 233         dbg("%s: get slot %d (%d) attention status is %d\n", __FUNCTION__,
 234                         ibm_slot->slot.slot_num, ibm_slot->slot.slot_id,
 235                         *status);
 236
 237         kfree(ibm_slot);
 238         return 0;
 239 }
 240
 241 /**
 242  * ibm_handle_events - listens for ACPI events for the IBM37D0 device
 243  * @handle: an ACPI handle to the device that caused the event
 244  * @event: the event info (device specific)
 245  * @context: passed context (our notification struct)
 246  *
 247  * Description: this method is registered as a callback with the ACPI
 248  * subsystem it is called when this device has an event to notify the OS of
 249  *
 250  * The events actually come from the device as two events that get
 251  * synthesized into one event with data by this function.  The event
 252  * ID comes first and then the slot number that caused it.  We report
 253  * this as one event to the OS.
 254  *
 255  * From section 5.6.2.2 of the ACPI 2.0 spec, I understand that the OSPM will
 256  * only re-enable the interrupt that causes this event AFTER this method
 257  * has returned, thereby enforcing serial access for the notification struct.
 258  **/
 259 static void ibm_handle_events(acpi_handle handle, u32 event, void *context)
 260 {
 261         u8 detail = event & 0x0f;
 262         u8 subevent = event & 0xf0;
 263         struct notification *note = context;
 264
 265         dbg("%s: Received notification %02x\n", __FUNCTION__, event);
 266
 267         if (subevent == 0x80) {
 268                 dbg("%s: generationg bus event\n", __FUNCTION__);
 269                 acpi_bus_generate_event(note->device, note->event, detail);
 270         } else
 271                 note->event = event;
 272 }
 273
 274 /**
 275  * ibm_get_table_from_acpi - reads the APLS buffer from ACPI
 276  * @bufp: address to pointer to allocate for the table
 277  *
 278  * Description: this method reads the APLS buffer in from ACPI and
 279  * stores the "stripped" table into a single buffer
 280  * it allocates and passes the address back in bufp
 281  *
 282  * If NULL is passed in as buffer, this method only calculates
 283  * the size of the table and returns that without filling
 284  * in the buffer
 285  *
 286  * returns < 0 on error or the size of the table on success
 287  **/
 288 static int ibm_get_table_from_acpi(char **bufp)
 289 {
 290         union acpi_object *package;
 291         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
 292         acpi_status status;
 293         char *lbuf = NULL;
 294         int i, size = -EIO;
 295
 296         status = acpi_evaluate_object(ibm_acpi_handle, "APCI", NULL, &buffer);
 297         if (ACPI_FAILURE(status)) {
 298                 err("%s:  APCI evaluation failed\n", __FUNCTION__);
 299                 return -ENODEV;
 300         }
 301
 302         package = (union acpi_object *) buffer.pointer;
 303         if (!(package) ||
 304                         (package->type != ACPI_TYPE_PACKAGE) ||
 305                         !(package->package.elements)) {
 306                 err("%s:  Invalid APCI object\n", __FUNCTION__);
 307                 goto read_table_done;
 308         }
 309
 310         for(size = 0, i = 0; i < package->package.count; i++) {
 311                 if (package->package.elements[i].type != ACPI_TYPE_BUFFER) {
 312                         err("%s:  Invalid APCI element %d\n", __FUNCTION__, i);
 313                         goto read_table_done;
 314                 }
 315                 size += package->package.elements[i].buffer.length;
 316         }
 317
 318         if (bufp == NULL)
 319                 goto read_table_done;
 320
 321         lbuf = kzalloc(size, GFP_KERNEL);
 322         dbg("%s: element count: %i, ASL table size: %i, &table = 0x%p\n",
 323                         __FUNCTION__, package->package.count, size, lbuf);
 324
 325         if (lbuf) {
 326                 *bufp = lbuf;
 327         } else {
 328                 size = -ENOMEM;
 329                 goto read_table_done;
 330         }
 331
 332         size = 0;
 333         for (i=0; i<package->package.count; i++) {
 334                 memcpy(&lbuf[size],
 335                                 package->package.elements[i].buffer.pointer,
 336                                 package->package.elements[i].buffer.length);
 337                 size += package->package.elements[i].buffer.length;
 338         }
 339
 340 read_table_done:
 341         kfree(buffer.pointer);
 342         return size;
 343 }
 344
 345 /**
 346  * ibm_read_apci_table - callback for the sysfs apci_table file
 347  * @kobj: the kobject this binary attribute is a part of
 348  * @buffer: the kernel space buffer to fill
 349  * @pos: the offset into the file
 350  * @size: the number of bytes requested
 351  *
 352  * Description: gets registered with sysfs as the reader callback
 353  * to be executed when /sys/bus/pci/slots/apci_table gets read
 354  *
 355  * Since we don't get notified on open and close for this file,
 356  * things get really tricky here...
 357  * our solution is to only allow reading the table in all at once
 358  **/
 359 static ssize_t ibm_read_apci_table(struct kobject *kobj,
 360                 char *buffer, loff_t pos, size_t size)
 361 {
 362         int bytes_read = -EINVAL;
 363         char *table = NULL;
 364
 365         dbg("%s: pos = %d, size = %zd\n", __FUNCTION__, (int)pos, size);
 366
 367         if (pos == 0) {
 368                 bytes_read = ibm_get_table_from_acpi(&table);
 369                 if (bytes_read > 0 && bytes_read <= size)
 370                         memcpy(buffer, table, bytes_read);
 371                 kfree(table);
 372         }
 373         return bytes_read;
 374 }
 375
 376 /**
 377  * ibm_find_acpi_device - callback to find our ACPI device
 378  * @handle: the ACPI handle of the device we are inspecting
 379  * @lvl: depth into the namespace tree
 380  * @context: a pointer to our handle to fill when we find the device
 381  * @rv: a return value to fill if desired
 382  *
 383  * Description: used as a callback when calling acpi_walk_namespace
 384  * to find our device.  When this method returns non-zero
 385  * acpi_walk_namespace quits its search and returns our value
 386  **/
 387 static acpi_status __init ibm_find_acpi_device(acpi_handle handle,
 388                 u32 lvl, void *context, void **rv)
 389 {
 390         acpi_handle *phandle = (acpi_handle *)context;
 391         acpi_status status;
 392         struct acpi_device_info info;
 393         struct acpi_buffer info_buffer = {
 394                 .length = sizeof(struct acpi_device_info),
 395                 .pointer = &info,
 396         };
 397
 398         status = acpi_get_object_info(handle, &info_buffer);
 399         if (ACPI_FAILURE(status)) {
 400                 err("%s:  Failed to get device information", __FUNCTION__);
 401                 return 0;
 402         }
 403         info.hardware_id.value[sizeof(info.hardware_id.value) - 1] = '\0';
 404
 405         if (info.current_status && (info.valid & ACPI_VALID_HID) &&
 406                         (!strcmp(info.hardware_id.value, IBM_HARDWARE_ID1) ||
 407                         !strcmp(info.hardware_id.value, IBM_HARDWARE_ID2))) {
 408                 dbg("found hardware: %s, handle: %p\n", info.hardware_id.value,
 409                                 handle);
 410                 *phandle = handle;
 411                 /* returning non-zero causes the search to stop
 412                  * and returns this value to the caller of
 413                  * acpi_walk_namespace, but it also causes some warnings
 414                  * in the acpi debug code to print...
 415                  */
 416                 return FOUND_APCI;
 417         }
 418         return 0;
 419 }
 420
 421 static int __init ibm_acpiphp_init(void)
 422 {
 423         int retval = 0;
 424         acpi_status status;
 425         struct acpi_device *device;
 426         struct kobject *sysdir = &pci_hotplug_slots_subsys.kobj;
 427
 428         dbg("%s\n", __FUNCTION__);
 429
 430         if (acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
 431                         ACPI_UINT32_MAX, ibm_find_acpi_device,
 432                         &ibm_acpi_handle, NULL) != FOUND_APCI) {
 433                 err("%s: acpi_walk_namespace failed\n", __FUNCTION__);
 434                 retval = -ENODEV;
 435                 goto init_return;
 436         }
 437         dbg("%s: found IBM aPCI device\n", __FUNCTION__);
 438         if (acpi_bus_get_device(ibm_acpi_handle, &device)) {
 439                 err("%s: acpi_bus_get_device failed\n", __FUNCTION__);
 440                 retval = -ENODEV;
 441                 goto init_return;
 442         }
 443         if (acpiphp_register_attention(&ibm_attention_info)) {
 444                 retval = -ENODEV;
 445                 goto init_return;
 446         }
 447
 448         ibm_note.device = device;
 449         status = acpi_install_notify_handler(ibm_acpi_handle,
 450                         ACPI_DEVICE_NOTIFY, ibm_handle_events,
 451                         &ibm_note);
 452         if (ACPI_FAILURE(status)) {
 453                 err("%s: Failed to register notification handler\n",
 454                                 __FUNCTION__);
 455                 retval = -EBUSY;
 456                 goto init_cleanup;
 457         }
 458
 459         ibm_apci_table_attr.size = ibm_get_table_from_acpi(NULL);
 460         retval = sysfs_create_bin_file(sysdir, &ibm_apci_table_attr);
 461
 462         return retval;
 463
 464 init_cleanup:
 465         acpiphp_unregister_attention(&ibm_attention_info);
 466 init_return:
 467         return retval;
 468 }
 469
 470 static void __exit ibm_acpiphp_exit(void)
 471 {
 472         acpi_status status;
 473         struct kobject *sysdir = &pci_hotplug_slots_subsys.kobj;
 474
 475         dbg("%s\n", __FUNCTION__);
 476
 477         if (acpiphp_unregister_attention(&ibm_attention_info))
 478                 err("%s: attention info deregistration failed", __FUNCTION__);
 479
 480         status = acpi_remove_notify_handler(
 481                            ibm_acpi_handle,
 482                            ACPI_DEVICE_NOTIFY,
 483                            ibm_handle_events);
 484         if (ACPI_FAILURE(status))
 485                 err("%s: Notification handler removal failed\n", __FUNCTION__);
 486         /* remove the /sys entries */
 487         sysfs_remove_bin_file(sysdir, &ibm_apci_table_attr);
 488 }
 489
 490 module_init(ibm_acpiphp_init);
 491 module_exit(ibm_acpiphp_exit);