2 * ACPI PCI Hot Plug IBM Extension
4 * Copyright (C) 2004 Vernon Mauery <vernux@us.ibm.com>
5 * Copyright (C) 2004 IBM Corp.
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.
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
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.
24 * Send feedback to <vernux@us.ibm.com>
28 #include <linux/init.h>
29 #include <linux/slab.h>
30 #include <linux/module.h>
31 #include <linux/kernel.h>
32 #include <acpi/acpi_bus.h>
33 #include <linux/sysfs.h>
34 #include <linux/kobject.h>
35 #include <asm/uaccess.h>
36 #include <linux/moduleparam.h>
37 #include <linux/pci.h>
42 #define DRIVER_VERSION "1.0.1"
43 #define DRIVER_AUTHOR "Irene Zubarev <zubarev@us.ibm.com>, Vernon Mauery <vernux@us.ibm.com>"
44 #define DRIVER_DESC "ACPI Hot Plug PCI Controller Driver IBM extension"
48 MODULE_AUTHOR(DRIVER_AUTHOR
);
49 MODULE_DESCRIPTION(DRIVER_DESC
);
50 MODULE_LICENSE("GPL");
51 MODULE_VERSION(DRIVER_VERSION
);
52 module_param(debug
, bool, 0644);
53 MODULE_PARM_DESC(debug
, " Debugging mode enabled or not");
54 #define MY_NAME "acpiphp_ibm"
57 #define dbg(format, arg...) \
60 printk(KERN_DEBUG "%s: " format, \
64 #define FOUND_APCI 0x61504349
65 /* these are the names for the IBM ACPI pseudo-device */
66 #define IBM_HARDWARE_ID1 "IBM37D0"
67 #define IBM_HARDWARE_ID2 "IBM37D4"
69 #define hpslot_to_sun(A) (((struct slot *)((A)->private))->acpi_slot->sun)
71 /* union apci_descriptor - allows access to the
72 * various device descriptors that are embedded in the
75 union apci_descriptor
{
99 /* struct notification - keeps info about the device
100 * that cause the ACPI notification event
102 struct notification
{
103 struct acpi_device
*device
;
107 static int ibm_set_attention_status(struct hotplug_slot
*slot
, u8 status
);
108 static int ibm_get_attention_status(struct hotplug_slot
*slot
, u8
*status
);
109 static void ibm_handle_events(acpi_handle handle
, u32 event
, void *context
);
110 static int ibm_get_table_from_acpi(char **bufp
);
111 static ssize_t
ibm_read_apci_table(struct file
*filp
, struct kobject
*kobj
,
112 struct bin_attribute
*bin_attr
,
113 char *buffer
, loff_t pos
, size_t size
);
114 static acpi_status __init
ibm_find_acpi_device(acpi_handle handle
,
115 u32 lvl
, void *context
, void **rv
);
116 static int __init
ibm_acpiphp_init(void);
117 static void __exit
ibm_acpiphp_exit(void);
119 static acpi_handle ibm_acpi_handle
;
120 static struct notification ibm_note
;
121 static struct bin_attribute ibm_apci_table_attr
= {
123 .name
= "apci_table",
126 .read
= ibm_read_apci_table
,
129 static struct acpiphp_attention_info ibm_attention_info
=
131 .set_attn
= ibm_set_attention_status
,
132 .get_attn
= ibm_get_attention_status
,
133 .owner
= THIS_MODULE
,
136 static union apci_descriptor
*ibm_slot_from_id(int id
)
139 union apci_descriptor
*ret
= NULL
, *des
;
142 size
= ibm_get_table_from_acpi(&table
);
143 des
= (union apci_descriptor
*)table
;
144 if (memcmp(des
->header
.sig
, "aPCI", 4) != 0)
147 des
= (union apci_descriptor
*)&table
[ind
+= des
->header
.len
];
148 while (ind
< size
&& (des
->generic
.type
!= 0x82 ||
149 des
->slot
.slot_num
!= id
)) {
150 des
= (union apci_descriptor
*)&table
[ind
+= des
->generic
.len
];
153 if (ind
< size
&& des
->slot
.slot_num
== id
)
158 ret
= kmalloc(sizeof(union apci_descriptor
), GFP_KERNEL
);
159 memcpy(ret
, des
, sizeof(union apci_descriptor
));
166 * ibm_set_attention_status - callback method to set the attention LED
167 * @slot: the hotplug_slot to work with
168 * @status: what to set the LED to (0 or 1)
170 * Description: This method is registered with the acpiphp module as a
171 * callback to do the device specific task of setting the LED status.
173 static int ibm_set_attention_status(struct hotplug_slot
*slot
, u8 status
)
175 union acpi_object args
[2];
176 struct acpi_object_list params
= { .pointer
= args
, .count
= 2 };
178 unsigned long long rc
;
179 union apci_descriptor
*ibm_slot
;
181 ibm_slot
= ibm_slot_from_id(hpslot_to_sun(slot
));
183 dbg("%s: set slot %d (%d) attention status to %d\n", __func__
,
184 ibm_slot
->slot
.slot_num
, ibm_slot
->slot
.slot_id
,
187 args
[0].type
= ACPI_TYPE_INTEGER
;
188 args
[0].integer
.value
= ibm_slot
->slot
.slot_id
;
189 args
[1].type
= ACPI_TYPE_INTEGER
;
190 args
[1].integer
.value
= (status
) ? 1 : 0;
194 stat
= acpi_evaluate_integer(ibm_acpi_handle
, "APLS", ¶ms
, &rc
);
195 if (ACPI_FAILURE(stat
)) {
196 err("APLS evaluation failed: 0x%08x\n", stat
);
199 err("APLS method failed: 0x%08llx\n", rc
);
206 * ibm_get_attention_status - callback method to get attention LED status
207 * @slot: the hotplug_slot to work with
208 * @status: returns what the LED is set to (0 or 1)
210 * Description: This method is registered with the acpiphp module as a
211 * callback to do the device specific task of getting the LED status.
213 * Because there is no direct method of getting the LED status directly
214 * from an ACPI call, we read the aPCI table and parse out our
215 * slot descriptor to read the status from that.
217 static int ibm_get_attention_status(struct hotplug_slot
*slot
, u8
*status
)
219 union apci_descriptor
*ibm_slot
;
221 ibm_slot
= ibm_slot_from_id(hpslot_to_sun(slot
));
223 if (ibm_slot
->slot
.attn
& 0xa0 || ibm_slot
->slot
.status
[1] & 0x08)
228 dbg("%s: get slot %d (%d) attention status is %d\n", __func__
,
229 ibm_slot
->slot
.slot_num
, ibm_slot
->slot
.slot_id
,
237 * ibm_handle_events - listens for ACPI events for the IBM37D0 device
238 * @handle: an ACPI handle to the device that caused the event
239 * @event: the event info (device specific)
240 * @context: passed context (our notification struct)
242 * Description: This method is registered as a callback with the ACPI
243 * subsystem it is called when this device has an event to notify the OS of.
245 * The events actually come from the device as two events that get
246 * synthesized into one event with data by this function. The event
247 * ID comes first and then the slot number that caused it. We report
248 * this as one event to the OS.
250 * From section 5.6.2.2 of the ACPI 2.0 spec, I understand that the OSPM will
251 * only re-enable the interrupt that causes this event AFTER this method
252 * has returned, thereby enforcing serial access for the notification struct.
254 static void ibm_handle_events(acpi_handle handle
, u32 event
, void *context
)
256 u8 detail
= event
& 0x0f;
257 u8 subevent
= event
& 0xf0;
258 struct notification
*note
= context
;
260 dbg("%s: Received notification %02x\n", __func__
, event
);
262 if (subevent
== 0x80) {
263 dbg("%s: generationg bus event\n", __func__
);
264 acpi_bus_generate_proc_event(note
->device
, note
->event
, detail
);
265 acpi_bus_generate_netlink_event(note
->device
->pnp
.device_class
,
266 dev_name(¬e
->device
->dev
),
267 note
->event
, detail
);
273 * ibm_get_table_from_acpi - reads the APLS buffer from ACPI
274 * @bufp: address to pointer to allocate for the table
276 * Description: This method reads the APLS buffer in from ACPI and
277 * stores the "stripped" table into a single buffer
278 * it allocates and passes the address back in bufp.
280 * If NULL is passed in as buffer, this method only calculates
281 * the size of the table and returns that without filling
284 * Returns < 0 on error or the size of the table on success.
286 static int ibm_get_table_from_acpi(char **bufp
)
288 union acpi_object
*package
;
289 struct acpi_buffer buffer
= { ACPI_ALLOCATE_BUFFER
, NULL
};
294 status
= acpi_evaluate_object(ibm_acpi_handle
, "APCI", NULL
, &buffer
);
295 if (ACPI_FAILURE(status
)) {
296 err("%s: APCI evaluation failed\n", __func__
);
300 package
= (union acpi_object
*) buffer
.pointer
;
302 (package
->type
!= ACPI_TYPE_PACKAGE
) ||
303 !(package
->package
.elements
)) {
304 err("%s: Invalid APCI object\n", __func__
);
305 goto read_table_done
;
308 for(size
= 0, i
= 0; i
< package
->package
.count
; i
++) {
309 if (package
->package
.elements
[i
].type
!= ACPI_TYPE_BUFFER
) {
310 err("%s: Invalid APCI element %d\n", __func__
, i
);
311 goto read_table_done
;
313 size
+= package
->package
.elements
[i
].buffer
.length
;
317 goto read_table_done
;
319 lbuf
= kzalloc(size
, GFP_KERNEL
);
320 dbg("%s: element count: %i, ASL table size: %i, &table = 0x%p\n",
321 __func__
, package
->package
.count
, size
, lbuf
);
327 goto read_table_done
;
331 for (i
=0; i
<package
->package
.count
; i
++) {
333 package
->package
.elements
[i
].buffer
.pointer
,
334 package
->package
.elements
[i
].buffer
.length
);
335 size
+= package
->package
.elements
[i
].buffer
.length
;
339 kfree(buffer
.pointer
);
344 * ibm_read_apci_table - callback for the sysfs apci_table file
345 * @filp: the open sysfs file
346 * @kobj: the kobject this binary attribute is a part of
347 * @bin_attr: struct bin_attribute for this file
348 * @buffer: the kernel space buffer to fill
349 * @pos: the offset into the file
350 * @size: the number of bytes requested
352 * Description: Gets registered with sysfs as the reader callback
353 * to be executed when /sys/bus/pci/slots/apci_table gets read.
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.
359 static ssize_t
ibm_read_apci_table(struct file
*filp
, struct kobject
*kobj
,
360 struct bin_attribute
*bin_attr
,
361 char *buffer
, loff_t pos
, size_t size
)
363 int bytes_read
= -EINVAL
;
366 dbg("%s: pos = %d, size = %zd\n", __func__
, (int)pos
, size
);
369 bytes_read
= ibm_get_table_from_acpi(&table
);
370 if (bytes_read
> 0 && bytes_read
<= size
)
371 memcpy(buffer
, table
, bytes_read
);
378 * ibm_find_acpi_device - callback to find our ACPI device
379 * @handle: the ACPI handle of the device we are inspecting
380 * @lvl: depth into the namespace tree
381 * @context: a pointer to our handle to fill when we find the device
382 * @rv: a return value to fill if desired
384 * Description: Used as a callback when calling acpi_walk_namespace
385 * to find our device. When this method returns non-zero
386 * acpi_walk_namespace quits its search and returns our value.
388 static acpi_status __init
ibm_find_acpi_device(acpi_handle handle
,
389 u32 lvl
, void *context
, void **rv
)
391 acpi_handle
*phandle
= (acpi_handle
*)context
;
393 struct acpi_device_info
*info
;
396 status
= acpi_get_object_info(handle
, &info
);
397 if (ACPI_FAILURE(status
)) {
398 err("%s: Failed to get device information status=0x%x\n",
403 if (info
->current_status
&& (info
->valid
& ACPI_VALID_HID
) &&
404 (!strcmp(info
->hardware_id
.string
, IBM_HARDWARE_ID1
) ||
405 !strcmp(info
->hardware_id
.string
, IBM_HARDWARE_ID2
))) {
406 dbg("found hardware: %s, handle: %p\n",
407 info
->hardware_id
.string
, handle
);
409 /* returning non-zero causes the search to stop
410 * and returns this value to the caller of
411 * acpi_walk_namespace, but it also causes some warnings
412 * in the acpi debug code to print...
420 static int __init
ibm_acpiphp_init(void)
424 struct acpi_device
*device
;
425 struct kobject
*sysdir
= &pci_slots_kset
->kobj
;
427 dbg("%s\n", __func__
);
429 if (acpi_walk_namespace(ACPI_TYPE_DEVICE
, ACPI_ROOT_OBJECT
,
430 ACPI_UINT32_MAX
, ibm_find_acpi_device
, NULL
,
431 &ibm_acpi_handle
, NULL
) != FOUND_APCI
) {
432 err("%s: acpi_walk_namespace failed\n", __func__
);
436 dbg("%s: found IBM aPCI device\n", __func__
);
437 if (acpi_bus_get_device(ibm_acpi_handle
, &device
)) {
438 err("%s: acpi_bus_get_device failed\n", __func__
);
442 if (acpiphp_register_attention(&ibm_attention_info
)) {
447 ibm_note
.device
= device
;
448 status
= acpi_install_notify_handler(ibm_acpi_handle
,
449 ACPI_DEVICE_NOTIFY
, ibm_handle_events
,
451 if (ACPI_FAILURE(status
)) {
452 err("%s: Failed to register notification handler\n",
458 ibm_apci_table_attr
.size
= ibm_get_table_from_acpi(NULL
);
459 retval
= sysfs_create_bin_file(sysdir
, &ibm_apci_table_attr
);
464 acpiphp_unregister_attention(&ibm_attention_info
);
469 static void __exit
ibm_acpiphp_exit(void)
472 struct kobject
*sysdir
= &pci_slots_kset
->kobj
;
474 dbg("%s\n", __func__
);
476 if (acpiphp_unregister_attention(&ibm_attention_info
))
477 err("%s: attention info deregistration failed", __func__
);
479 status
= acpi_remove_notify_handler(
483 if (ACPI_FAILURE(status
))
484 err("%s: Notification handler removal failed\n", __func__
);
485 /* remove the /sys entries */
486 sysfs_remove_bin_file(sysdir
, &ibm_apci_table_attr
);
489 module_init(ibm_acpiphp_init
);
490 module_exit(ibm_acpiphp_exit
);