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_hotplug.h>
41 #include <linux/slab.h>
42 #include <linux/smp.h>
45 #define MY_NAME "acpiphp"
52 static struct acpiphp_attention_info *attention_info;
54 #define DRIVER_VERSION "0.5"
55 #define DRIVER_AUTHOR "Greg Kroah-Hartman <gregkh@us.ibm.com>, Takayoshi Kochi <t-kochi@bq.jp.nec.com>, Matthew Wilcox <willy@hp.com>"
56 #define DRIVER_DESC "ACPI Hot Plug PCI Controller Driver"
58 MODULE_AUTHOR(DRIVER_AUTHOR);
59 MODULE_DESCRIPTION(DRIVER_DESC);
60 MODULE_LICENSE("GPL");
61 MODULE_PARM_DESC(debug, "Debugging mode enabled or not");
62 module_param(debug, bool, 0644);
64 /* export the attention callback registration methods */
65 EXPORT_SYMBOL_GPL(acpiphp_register_attention);
66 EXPORT_SYMBOL_GPL(acpiphp_unregister_attention);
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 get_power_status (struct hotplug_slot *slot, u8 *value);
72 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
73 static int get_address (struct hotplug_slot *slot, u32 *value);
74 static int get_latch_status (struct hotplug_slot *slot, u8 *value);
75 static int get_adapter_status (struct hotplug_slot *slot, u8 *value);
77 static struct hotplug_slot_ops acpi_hotplug_slot_ops = {
79 .enable_slot = enable_slot,
80 .disable_slot = disable_slot,
81 .set_attention_status = set_attention_status,
82 .get_power_status = get_power_status,
83 .get_attention_status = get_attention_status,
84 .get_latch_status = get_latch_status,
85 .get_adapter_status = get_adapter_status,
86 .get_address = get_address,
91 * acpiphp_register_attention - set attention LED callback
92 * @info: must be completely filled with LED callbacks
94 * Description: this is used to register a hardware specific ACPI
95 * driver that manipulates the attention LED. All the fields in
98 int acpiphp_register_attention(struct acpiphp_attention_info *info)
100 int retval = -EINVAL;
102 if (info && info->owner && info->set_attn &&
103 info->get_attn && !attention_info) {
105 attention_info = info;
112 * acpiphp_unregister_attention - unset attention LED callback
113 * @info: must match the pointer used to register
115 * Description: this is used to un-register a hardware specific acpi
116 * driver that manipulates the attention LED. The pointer to the
117 * info struct must be the same as the one used to set it.
119 int acpiphp_unregister_attention(struct acpiphp_attention_info *info)
121 int retval = -EINVAL;
123 if (info && attention_info == info) {
124 attention_info = NULL;
132 * enable_slot - power on and enable a slot
133 * @hotplug_slot: slot to enable
135 * 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", __FUNCTION__, hotplug_slot->name);
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()
156 static int disable_slot(struct hotplug_slot *hotplug_slot)
158 struct slot *slot = hotplug_slot->private;
160 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
162 /* disable the specified slot */
163 return acpiphp_disable_slot(slot->acpi_slot);
168 * set_attention_status - set attention LED
169 * @hotplug_slot: slot to set attention LED on
170 * @status: value to set attention LED to (0 or 1)
172 * attention status LED, so we use a callback that
173 * was registered with us. This allows hardware specific
174 * ACPI implementations to blink the light for us.
176 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
178 int retval = -ENODEV;
180 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
182 if (attention_info && try_module_get(attention_info->owner)) {
183 retval = attention_info->set_attn(hotplug_slot, status);
184 module_put(attention_info->owner);
186 attention_info = NULL;
192 * get_power_status - get power status of a slot
193 * @hotplug_slot: slot to get status
194 * @value: pointer to store status
196 * Some platforms may not implement _STA method properly.
197 * In that case, the value returned may not be reliable.
200 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
202 struct slot *slot = hotplug_slot->private;
204 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
206 *value = acpiphp_get_power_status(slot->acpi_slot);
213 * get_attention_status - get attention LED status
214 * @hotplug_slot: slot to get status from
215 * @value: returns with value of attention LED
217 * ACPI doesn't have known method to determine the state
218 * of the attention status LED, so we use a callback that
219 * was registered with us. This allows hardware specific
220 * ACPI implementations to determine its state
222 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
224 int retval = -EINVAL;
226 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
228 if (attention_info && try_module_get(attention_info->owner)) {
229 retval = attention_info->get_attn(hotplug_slot, value);
230 module_put(attention_info->owner);
232 attention_info = NULL;
238 * get_latch_status - get latch status of a slot
239 * @hotplug_slot: slot to get status
240 * @value: pointer to store status
242 * ACPI doesn't provide any formal means to access latch status.
243 * Instead, we fake latch status from _STA
246 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
248 struct slot *slot = hotplug_slot->private;
250 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
252 *value = acpiphp_get_latch_status(slot->acpi_slot);
259 * get_adapter_status - get adapter status of a slot
260 * @hotplug_slot: slot to get status
261 * @value: pointer to store status
263 * ACPI doesn't provide any formal means to access adapter status.
264 * 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", __FUNCTION__, hotplug_slot->name);
273 *value = acpiphp_get_adapter_status(slot->acpi_slot);
280 * get_address - get pci address of a slot
281 * @hotplug_slot: slot to get status
282 * @value: pointer to struct pci_busdev (seg, bus, dev)
284 static int get_address(struct hotplug_slot *hotplug_slot, u32 *value)
286 struct slot *slot = hotplug_slot->private;
288 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
290 *value = acpiphp_get_address(slot->acpi_slot);
295 static int __init init_acpi(void)
299 /* initialize internal data structure etc. */
300 retval = acpiphp_glue_init();
302 /* read initial number of slots */
304 num_slots = acpiphp_get_num_slots();
305 if (num_slots == 0) {
315 * release_slot - free up the memory used by a slot
316 * @hotplug_slot: slot to free
318 static void release_slot(struct hotplug_slot *hotplug_slot)
320 struct slot *slot = hotplug_slot->private;
322 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
324 kfree(slot->hotplug_slot);
328 /* callback routine to initialize 'struct slot' for each slot */
329 int acpiphp_register_hotplug_slot(struct acpiphp_slot *acpiphp_slot)
332 int retval = -ENOMEM;
334 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
338 slot->hotplug_slot = kzalloc(sizeof(*slot->hotplug_slot), GFP_KERNEL);
339 if (!slot->hotplug_slot)
342 slot->hotplug_slot->info = &slot->info;
344 slot->hotplug_slot->name = slot->name;
346 slot->hotplug_slot->private = slot;
347 slot->hotplug_slot->release = &release_slot;
348 slot->hotplug_slot->ops = &acpi_hotplug_slot_ops;
350 slot->acpi_slot = acpiphp_slot;
351 slot->hotplug_slot->info->power_status = acpiphp_get_power_status(slot->acpi_slot);
352 slot->hotplug_slot->info->attention_status = 0;
353 slot->hotplug_slot->info->latch_status = acpiphp_get_latch_status(slot->acpi_slot);
354 slot->hotplug_slot->info->adapter_status = acpiphp_get_adapter_status(slot->acpi_slot);
355 slot->hotplug_slot->info->max_bus_speed = PCI_SPEED_UNKNOWN;
356 slot->hotplug_slot->info->cur_bus_speed = PCI_SPEED_UNKNOWN;
358 acpiphp_slot->slot = slot;
359 snprintf(slot->name, sizeof(slot->name), "%u", slot->acpi_slot->sun);
361 retval = pci_hp_register(slot->hotplug_slot);
363 err("pci_hp_register failed with error %d\n", retval);
367 info("Slot [%s] registered\n", slot->hotplug_slot->name);
371 kfree(slot->hotplug_slot);
379 void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *acpiphp_slot)
381 struct slot *slot = acpiphp_slot->slot;
384 info ("Slot [%s] unregistered\n", slot->hotplug_slot->name);
386 retval = pci_hp_deregister(slot->hotplug_slot);
388 err("pci_hp_deregister failed with error %d\n", retval);
392 static int __init acpiphp_init(void)
394 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
396 acpiphp_debug = debug;
398 /* read all the ACPI info from the system */
403 static void __exit acpiphp_exit(void)
405 /* deallocate internal data structures etc. */
409 module_init(acpiphp_init);
410 module_exit(acpiphp_exit);