2 * ACPI PCI Hot Plug Controller Driver
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
13 * All rights reserved.
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.
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
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.
30 * Send feedback to <gregkh@us.ibm.com>,
31 * <t-kochi@bq.jp.nec.com>
35 #include <linux/init.h>
36 #include <linux/module.h>
37 #include <linux/moduleparam.h>
39 #include <linux/kernel.h>
40 #include <linux/pci.h>
41 #include <linux/slab.h>
42 #include <linux/smp.h>
43 #include <linux/smp_lock.h>
44 #include "pci_hotplug.h"
47 static LIST_HEAD(slot_list);
49 #define MY_NAME "acpiphp"
56 static struct acpiphp_attention_info *attention_info;
58 #define DRIVER_VERSION "0.5"
59 #define DRIVER_AUTHOR "Greg Kroah-Hartman <gregkh@us.ibm.com>, Takayoshi Kochi <t-kochi@bq.jp.nec.com>, Matthew Wilcox <willy@hp.com>"
60 #define DRIVER_DESC "ACPI Hot Plug PCI Controller Driver"
62 MODULE_AUTHOR(DRIVER_AUTHOR);
63 MODULE_DESCRIPTION(DRIVER_DESC);
64 MODULE_LICENSE("GPL");
65 MODULE_PARM_DESC(debug, "Debugging mode enabled or not");
66 module_param(debug, bool, 0644);
68 /* export the attention callback registration methods */
69 EXPORT_SYMBOL_GPL(acpiphp_register_attention);
70 EXPORT_SYMBOL_GPL(acpiphp_unregister_attention);
72 static int enable_slot (struct hotplug_slot *slot);
73 static int disable_slot (struct hotplug_slot *slot);
74 static int set_attention_status (struct hotplug_slot *slot, u8 value);
75 static int get_power_status (struct hotplug_slot *slot, u8 *value);
76 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
77 static int get_address (struct hotplug_slot *slot, u32 *value);
78 static int get_latch_status (struct hotplug_slot *slot, u8 *value);
79 static int get_adapter_status (struct hotplug_slot *slot, u8 *value);
81 static struct hotplug_slot_ops acpi_hotplug_slot_ops = {
83 .enable_slot = enable_slot,
84 .disable_slot = disable_slot,
85 .set_attention_status = set_attention_status,
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,
95 * acpiphp_register_attention - set attention LED callback
96 * @info: must be completely filled with LED callbacks
98 * Description: this is used to register a hardware specific ACPI
99 * driver that manipulates the attention LED. All the fields in
102 int acpiphp_register_attention(struct acpiphp_attention_info *info)
104 int retval = -EINVAL;
106 if (info && info->owner && info->set_attn &&
107 info->get_attn && !attention_info) {
109 attention_info = info;
116 * acpiphp_unregister_attention - unset attention LED callback
117 * @info: must match the pointer used to register
119 * Description: this is used to un-register a hardware specific acpi
120 * driver that manipulates the attention LED. The pointer to the
121 * info struct must be the same as the one used to set it.
123 int acpiphp_unregister_attention(struct acpiphp_attention_info *info)
125 int retval = -EINVAL;
127 if (info && attention_info == info) {
128 attention_info = NULL;
136 * enable_slot - power on and enable a slot
137 * @hotplug_slot: slot to enable
139 * Actual tasks are done in acpiphp_enable_slot()
142 static int enable_slot(struct hotplug_slot *hotplug_slot)
144 struct slot *slot = hotplug_slot->private;
146 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
148 /* enable the specified slot */
149 return acpiphp_enable_slot(slot->acpi_slot);
154 * disable_slot - disable and power off a slot
155 * @hotplug_slot: slot to disable
157 * Actual tasks are done in acpiphp_disable_slot()
160 static int disable_slot(struct hotplug_slot *hotplug_slot)
162 struct slot *slot = hotplug_slot->private;
164 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
166 /* disable the specified slot */
167 return acpiphp_disable_slot(slot->acpi_slot);
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)
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.
180 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
182 int retval = -ENODEV;
184 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
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);
190 attention_info = NULL;
196 * get_power_status - get power status of a slot
197 * @hotplug_slot: slot to get status
198 * @value: pointer to store status
200 * Some platforms may not implement _STA method properly.
201 * In that case, the value returned may not be reliable.
204 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
206 struct slot *slot = hotplug_slot->private;
208 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
210 *value = acpiphp_get_power_status(slot->acpi_slot);
217 * get_attention_status - get attention LED status
218 * @hotplug_slot: slot to get status from
219 * @value: returns with value of attention LED
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
226 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
228 int retval = -EINVAL;
230 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
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);
236 attention_info = NULL;
242 * get_latch_status - get latch status of a slot
243 * @hotplug_slot: slot to get status
244 * @value: pointer to store status
246 * ACPI doesn't provide any formal means to access latch status.
247 * Instead, we fake latch status from _STA
250 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
252 struct slot *slot = hotplug_slot->private;
254 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
256 *value = acpiphp_get_latch_status(slot->acpi_slot);
263 * get_adapter_status - get adapter status of a slot
264 * @hotplug_slot: slot to get status
265 * @value: pointer to store status
267 * ACPI doesn't provide any formal means to access adapter status.
268 * Instead, we fake adapter status from _STA
271 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
273 struct slot *slot = hotplug_slot->private;
275 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
277 *value = acpiphp_get_adapter_status(slot->acpi_slot);
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)
288 static int get_address(struct hotplug_slot *hotplug_slot, u32 *value)
290 struct slot *slot = hotplug_slot->private;
292 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
294 *value = acpiphp_get_address(slot->acpi_slot);
299 static int __init init_acpi(void)
303 /* initialize internal data structure etc. */
304 retval = acpiphp_glue_init();
306 /* read initial number of slots */
308 num_slots = acpiphp_get_num_slots();
318 * make_slot_name - make a slot name that appears in pcihpfs
319 * @slot: slot to name
322 static void make_slot_name(struct slot *slot)
324 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%u",
325 slot->acpi_slot->sun);
329 * release_slot - free up the memory used by a slot
330 * @hotplug_slot: slot to free
332 static void release_slot(struct hotplug_slot *hotplug_slot)
334 struct slot *slot = hotplug_slot->private;
336 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
338 kfree(slot->hotplug_slot->info);
339 kfree(slot->hotplug_slot->name);
340 kfree(slot->hotplug_slot);
345 * init_slots - initialize 'struct slot' structures for each slot
348 static int __init init_slots(void)
351 int retval = -ENOMEM;
354 for (i = 0; i < num_slots; ++i) {
355 slot = kmalloc(sizeof(struct slot), GFP_KERNEL);
358 memset(slot, 0, sizeof(struct slot));
360 slot->hotplug_slot = kmalloc(sizeof(struct hotplug_slot), GFP_KERNEL);
361 if (!slot->hotplug_slot)
363 memset(slot->hotplug_slot, 0, sizeof(struct hotplug_slot));
365 slot->hotplug_slot->info = kmalloc(sizeof(struct hotplug_slot_info), GFP_KERNEL);
366 if (!slot->hotplug_slot->info)
368 memset(slot->hotplug_slot->info, 0, sizeof(struct hotplug_slot_info));
370 slot->hotplug_slot->name = kmalloc(SLOT_NAME_SIZE, GFP_KERNEL);
371 if (!slot->hotplug_slot->name)
376 slot->hotplug_slot->private = slot;
377 slot->hotplug_slot->release = &release_slot;
378 slot->hotplug_slot->ops = &acpi_hotplug_slot_ops;
380 slot->acpi_slot = get_slot_from_id(i);
381 slot->hotplug_slot->info->power_status = acpiphp_get_power_status(slot->acpi_slot);
382 slot->hotplug_slot->info->attention_status = 0;
383 slot->hotplug_slot->info->latch_status = acpiphp_get_latch_status(slot->acpi_slot);
384 slot->hotplug_slot->info->adapter_status = acpiphp_get_adapter_status(slot->acpi_slot);
385 slot->hotplug_slot->info->max_bus_speed = PCI_SPEED_UNKNOWN;
386 slot->hotplug_slot->info->cur_bus_speed = PCI_SPEED_UNKNOWN;
388 make_slot_name(slot);
390 retval = pci_hp_register(slot->hotplug_slot);
392 err("pci_hp_register failed with error %d\n", retval);
396 /* add slot to our internal list */
397 list_add(&slot->slot_list, &slot_list);
398 info("Slot [%s] registered\n", slot->hotplug_slot->name);
403 kfree(slot->hotplug_slot->name);
405 kfree(slot->hotplug_slot->info);
407 kfree(slot->hotplug_slot);
415 static void __exit cleanup_slots (void)
417 struct list_head *tmp, *n;
420 list_for_each_safe (tmp, n, &slot_list) {
421 /* memory will be freed in release_slot callback */
422 slot = list_entry(tmp, struct slot, slot_list);
423 list_del(&slot->slot_list);
424 pci_hp_deregister(slot->hotplug_slot);
429 static int __init acpiphp_init(void)
433 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
435 acpiphp_debug = debug;
437 /* read all the ACPI info from the system */
438 retval = init_acpi();
446 static void __exit acpiphp_exit(void)
449 /* deallocate internal data structures etc. */
453 module_init(acpiphp_init);
454 module_exit(acpiphp_exit);