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 <kristen.c.accardi@intel.com>
34 #include <linux/init.h>
35 #include <linux/module.h>
36 #include <linux/moduleparam.h>
38 #include <linux/kernel.h>
39 #include <linux/pci.h>
40 #include <linux/pci-acpi.h>
41 #include <linux/pci_hotplug.h>
42 #include <linux/slab.h>
43 #include <linux/smp.h>
46 #define MY_NAME "acpiphp"
48 /* name size which is used for entries in pcihpfs */
49 #define SLOT_NAME_SIZE 21 /* {_SUN} */
52 bool acpiphp_disabled;
55 static struct acpiphp_attention_info *attention_info;
57 #define DRIVER_VERSION "0.5"
58 #define DRIVER_AUTHOR "Greg Kroah-Hartman <gregkh@us.ibm.com>, Takayoshi Kochi <t-kochi@bq.jp.nec.com>, Matthew Wilcox <willy@hp.com>"
59 #define DRIVER_DESC "ACPI Hot Plug PCI Controller Driver"
61 MODULE_AUTHOR(DRIVER_AUTHOR);
62 MODULE_DESCRIPTION(DRIVER_DESC);
63 MODULE_LICENSE("GPL");
64 MODULE_PARM_DESC(debug, "Debugging mode enabled or not");
65 MODULE_PARM_DESC(disable, "disable acpiphp driver");
66 module_param_named(debug, acpiphp_debug, bool, 0644);
67 module_param_named(disable, acpiphp_disabled, bool, 0444);
69 /* export the attention callback registration methods */
70 EXPORT_SYMBOL_GPL(acpiphp_register_attention);
71 EXPORT_SYMBOL_GPL(acpiphp_unregister_attention);
73 static int enable_slot (struct hotplug_slot *slot);
74 static int disable_slot (struct hotplug_slot *slot);
75 static int set_attention_status (struct hotplug_slot *slot, u8 value);
76 static int get_power_status (struct hotplug_slot *slot, u8 *value);
77 static int get_attention_status (struct hotplug_slot *slot, u8 *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 = {
82 .enable_slot = enable_slot,
83 .disable_slot = disable_slot,
84 .set_attention_status = set_attention_status,
85 .get_power_status = get_power_status,
86 .get_attention_status = get_attention_status,
87 .get_latch_status = get_latch_status,
88 .get_adapter_status = get_adapter_status,
92 * acpiphp_register_attention - set attention LED callback
93 * @info: must be completely filled with LED callbacks
95 * Description: This is used to register a hardware specific ACPI
96 * driver that manipulates the attention LED. All the fields in
99 int acpiphp_register_attention(struct acpiphp_attention_info *info)
101 int retval = -EINVAL;
103 if (info && info->owner && info->set_attn &&
104 info->get_attn && !attention_info) {
106 attention_info = info;
113 * acpiphp_unregister_attention - unset attention LED callback
114 * @info: must match the pointer used to register
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.
120 int acpiphp_unregister_attention(struct acpiphp_attention_info *info)
122 int retval = -EINVAL;
124 if (info && attention_info == info) {
125 attention_info = NULL;
133 * enable_slot - power on and enable a slot
134 * @hotplug_slot: slot to enable
136 * Actual tasks are done in acpiphp_enable_slot()
138 static int enable_slot(struct hotplug_slot *hotplug_slot)
140 struct slot *slot = hotplug_slot->private;
142 dbg("%s - physical_slot = %s\n", __func__, slot_name(slot));
144 /* enable the specified slot */
145 return acpiphp_enable_slot(slot->acpi_slot);
150 * disable_slot - disable and power off a slot
151 * @hotplug_slot: slot to disable
153 * Actual tasks are done in acpiphp_disable_slot()
155 static int disable_slot(struct hotplug_slot *hotplug_slot)
157 struct slot *slot = hotplug_slot->private;
160 dbg("%s - physical_slot = %s\n", __func__, slot_name(slot));
162 /* disable the specified slot */
163 retval = acpiphp_disable_slot(slot->acpi_slot);
165 retval = acpiphp_eject_slot(slot->acpi_slot);
171 * set_attention_status - set attention LED
172 * @hotplug_slot: slot to set attention LED on
173 * @status: value to set attention LED to (0 or 1)
175 * attention status LED, so we use a callback that
176 * was registered with us. This allows hardware specific
177 * ACPI implementations to blink the light for us.
179 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
181 int retval = -ENODEV;
183 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot_name(hotplug_slot));
185 if (attention_info && try_module_get(attention_info->owner)) {
186 retval = attention_info->set_attn(hotplug_slot, status);
187 module_put(attention_info->owner);
189 attention_info = NULL;
195 * get_power_status - get power status of a slot
196 * @hotplug_slot: slot to get status
197 * @value: pointer to store status
199 * Some platforms may not implement _STA method properly.
200 * In that case, the value returned may not be reliable.
202 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
204 struct slot *slot = hotplug_slot->private;
206 dbg("%s - physical_slot = %s\n", __func__, slot_name(slot));
208 *value = acpiphp_get_power_status(slot->acpi_slot);
215 * get_attention_status - get attention LED status
216 * @hotplug_slot: slot to get status from
217 * @value: returns with value of attention LED
219 * ACPI doesn't have known method to determine the state
220 * of the attention status LED, so we use a callback that
221 * was registered with us. This allows hardware specific
222 * ACPI implementations to determine its state.
224 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
226 int retval = -EINVAL;
228 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot_name(hotplug_slot));
230 if (attention_info && try_module_get(attention_info->owner)) {
231 retval = attention_info->get_attn(hotplug_slot, value);
232 module_put(attention_info->owner);
234 attention_info = NULL;
240 * get_latch_status - get latch status of a slot
241 * @hotplug_slot: slot to get status
242 * @value: pointer to store status
244 * ACPI doesn't provide any formal means to access latch status.
245 * Instead, we fake latch status from _STA.
247 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
249 struct slot *slot = hotplug_slot->private;
251 dbg("%s - physical_slot = %s\n", __func__, slot_name(slot));
253 *value = acpiphp_get_latch_status(slot->acpi_slot);
260 * get_adapter_status - get adapter status of a slot
261 * @hotplug_slot: slot to get status
262 * @value: pointer to store status
264 * ACPI doesn't provide any formal means to access adapter status.
265 * Instead, we fake adapter status from _STA.
267 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
269 struct slot *slot = hotplug_slot->private;
271 dbg("%s - physical_slot = %s\n", __func__, slot_name(slot));
273 *value = acpiphp_get_adapter_status(slot->acpi_slot);
279 * release_slot - free up the memory used by a slot
280 * @hotplug_slot: slot to free
282 static void release_slot(struct hotplug_slot *hotplug_slot)
284 struct slot *slot = hotplug_slot->private;
286 dbg("%s - physical_slot = %s\n", __func__, slot_name(slot));
288 kfree(slot->hotplug_slot);
292 /* callback routine to initialize 'struct slot' for each slot */
293 int acpiphp_register_hotplug_slot(struct acpiphp_slot *acpiphp_slot,
297 int retval = -ENOMEM;
298 char name[SLOT_NAME_SIZE];
300 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
304 slot->hotplug_slot = kzalloc(sizeof(*slot->hotplug_slot), GFP_KERNEL);
305 if (!slot->hotplug_slot)
308 slot->hotplug_slot->info = &slot->info;
310 slot->hotplug_slot->private = slot;
311 slot->hotplug_slot->release = &release_slot;
312 slot->hotplug_slot->ops = &acpi_hotplug_slot_ops;
314 slot->acpi_slot = acpiphp_slot;
315 slot->hotplug_slot->info->power_status = acpiphp_get_power_status(slot->acpi_slot);
316 slot->hotplug_slot->info->attention_status = 0;
317 slot->hotplug_slot->info->latch_status = acpiphp_get_latch_status(slot->acpi_slot);
318 slot->hotplug_slot->info->adapter_status = acpiphp_get_adapter_status(slot->acpi_slot);
320 acpiphp_slot->slot = slot;
322 snprintf(name, SLOT_NAME_SIZE, "%u", sun);
324 retval = pci_hp_register(slot->hotplug_slot,
325 acpiphp_slot->bridge->pci_bus,
326 acpiphp_slot->device,
328 if (retval == -EBUSY)
331 err("pci_hp_register failed with error %d\n", retval);
335 info("Slot [%s] registered\n", slot_name(slot));
339 kfree(slot->hotplug_slot);
347 void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *acpiphp_slot)
349 struct slot *slot = acpiphp_slot->slot;
352 info("Slot [%s] unregistered\n", slot_name(slot));
354 retval = pci_hp_deregister(slot->hotplug_slot);
356 err("pci_hp_deregister failed with error %d\n", retval);
360 void __init acpiphp_init(void)
362 info(DRIVER_DESC " version: " DRIVER_VERSION "%s\n",
363 acpiphp_disabled ? ", disabled by user; please report a bug"