2 * Standard 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) 2003-2004 Intel Corporation
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or (at
14 * your option) any later version.
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
19 * NON INFRINGEMENT. See the GNU General Public License for more
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 * Send feedback to <greg@kroah.com>, <kristen.c.accardi@intel.com>
30 #include <linux/module.h>
31 #include <linux/moduleparam.h>
32 #include <linux/kernel.h>
33 #include <linux/types.h>
34 #include <linux/pci.h>
35 #include <linux/workqueue.h>
38 /* Global variables */
42 int shpchp_slot_with_bus;
43 struct workqueue_struct *shpchp_wq;
45 #define DRIVER_VERSION "0.4"
46 #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
47 #define DRIVER_DESC "Standard Hot Plug PCI Controller Driver"
49 MODULE_AUTHOR(DRIVER_AUTHOR);
50 MODULE_DESCRIPTION(DRIVER_DESC);
51 MODULE_LICENSE("GPL");
53 module_param(shpchp_debug, bool, 0644);
54 module_param(shpchp_poll_mode, bool, 0644);
55 module_param(shpchp_poll_time, int, 0644);
56 module_param(shpchp_slot_with_bus, bool, 0644);
57 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
58 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
59 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
60 MODULE_PARM_DESC(shpchp_slot_with_bus, "Use bus number in the slot name");
62 #define SHPC_MODULE_NAME "shpchp"
64 static int set_attention_status (struct hotplug_slot *slot, u8 value);
65 static int enable_slot (struct hotplug_slot *slot);
66 static int disable_slot (struct hotplug_slot *slot);
67 static int get_power_status (struct hotplug_slot *slot, u8 *value);
68 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
69 static int get_latch_status (struct hotplug_slot *slot, u8 *value);
70 static int get_adapter_status (struct hotplug_slot *slot, u8 *value);
71 static int get_address (struct hotplug_slot *slot, u32 *value);
72 static int get_max_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
73 static int get_cur_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
75 static struct hotplug_slot_ops shpchp_hotplug_slot_ops = {
77 .set_attention_status = set_attention_status,
78 .enable_slot = enable_slot,
79 .disable_slot = disable_slot,
80 .get_power_status = get_power_status,
81 .get_attention_status = get_attention_status,
82 .get_latch_status = get_latch_status,
83 .get_adapter_status = get_adapter_status,
84 .get_address = get_address,
85 .get_max_bus_speed = get_max_bus_speed,
86 .get_cur_bus_speed = get_cur_bus_speed,
90 * release_slot - free up the memory used by a slot
91 * @hotplug_slot: slot to free
93 static void release_slot(struct hotplug_slot *hotplug_slot)
95 struct slot *slot = hotplug_slot->private;
97 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
99 kfree(slot->hotplug_slot->info);
100 kfree(slot->hotplug_slot);
104 static void make_slot_name(struct slot *slot)
106 if (shpchp_slot_with_bus)
107 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
108 slot->bus, slot->number);
110 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%d",
114 static int init_slots(struct controller *ctrl)
117 struct hotplug_slot *hotplug_slot;
118 struct hotplug_slot_info *info;
119 int retval = -ENOMEM;
122 for (i = 0; i < ctrl->num_slots; i++) {
123 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
127 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
130 slot->hotplug_slot = hotplug_slot;
132 info = kzalloc(sizeof(*info), GFP_KERNEL);
135 hotplug_slot->info = info;
137 hotplug_slot->name = slot->name;
141 slot->bus = ctrl->pci_dev->subordinate->number;
142 slot->device = ctrl->slot_device_offset + i;
143 slot->hpc_ops = ctrl->hpc_ops;
144 slot->number = ctrl->first_slot + (ctrl->slot_num_inc * i);
145 mutex_init(&slot->lock);
146 INIT_DELAYED_WORK(&slot->work, shpchp_queue_pushbutton_work);
148 /* register this slot with the hotplug pci core */
149 hotplug_slot->private = slot;
150 hotplug_slot->release = &release_slot;
151 make_slot_name(slot);
152 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
154 get_power_status(hotplug_slot, &info->power_status);
155 get_attention_status(hotplug_slot, &info->attention_status);
156 get_latch_status(hotplug_slot, &info->latch_status);
157 get_adapter_status(hotplug_slot, &info->adapter_status);
159 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
160 "slot_device_offset=%x\n", slot->bus, slot->device,
161 slot->hp_slot, slot->number, ctrl->slot_device_offset);
162 retval = pci_hp_register(slot->hotplug_slot);
164 err("pci_hp_register failed with error %d\n", retval);
168 list_add(&slot->slot_list, &ctrl->slot_list);
182 void cleanup_slots(struct controller *ctrl)
184 struct list_head *tmp;
185 struct list_head *next;
188 list_for_each_safe(tmp, next, &ctrl->slot_list) {
189 slot = list_entry(tmp, struct slot, slot_list);
190 list_del(&slot->slot_list);
191 cancel_delayed_work(&slot->work);
192 flush_scheduled_work();
193 flush_workqueue(shpchp_wq);
194 pci_hp_deregister(slot->hotplug_slot);
199 * set_attention_status - Turns the Amber LED for a slot on, off or blink
201 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
203 struct slot *slot = get_slot(hotplug_slot);
205 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
207 hotplug_slot->info->attention_status = status;
208 slot->hpc_ops->set_attention_status(slot, status);
213 static int enable_slot (struct hotplug_slot *hotplug_slot)
215 struct slot *slot = get_slot(hotplug_slot);
217 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
219 return shpchp_sysfs_enable_slot(slot);
222 static int disable_slot (struct hotplug_slot *hotplug_slot)
224 struct slot *slot = get_slot(hotplug_slot);
226 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
228 return shpchp_sysfs_disable_slot(slot);
231 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
233 struct slot *slot = get_slot(hotplug_slot);
236 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
238 retval = slot->hpc_ops->get_power_status(slot, value);
240 *value = hotplug_slot->info->power_status;
245 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
247 struct slot *slot = get_slot(hotplug_slot);
250 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
252 retval = slot->hpc_ops->get_attention_status(slot, value);
254 *value = hotplug_slot->info->attention_status;
259 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
261 struct slot *slot = get_slot(hotplug_slot);
264 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
266 retval = slot->hpc_ops->get_latch_status(slot, value);
268 *value = hotplug_slot->info->latch_status;
273 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
275 struct slot *slot = get_slot(hotplug_slot);
278 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
280 retval = slot->hpc_ops->get_adapter_status(slot, value);
282 *value = hotplug_slot->info->adapter_status;
287 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
289 struct slot *slot = get_slot(hotplug_slot);
290 struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
292 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
294 *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
299 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
301 struct slot *slot = get_slot(hotplug_slot);
304 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
306 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
308 *value = PCI_SPEED_UNKNOWN;
313 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
315 struct slot *slot = get_slot(hotplug_slot);
318 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
320 retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
322 *value = PCI_SPEED_UNKNOWN;
327 static int is_shpc_capable(struct pci_dev *dev)
329 if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
330 PCI_DEVICE_ID_AMD_GOLAM_7450))
332 if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
338 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
341 struct controller *ctrl;
343 if (!is_shpc_capable(pdev))
346 ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
348 err("%s : out of memory\n", __func__);
351 INIT_LIST_HEAD(&ctrl->slot_list);
353 rc = shpc_init(ctrl, pdev);
355 dbg("%s: controller initialization failed\n",
357 goto err_out_free_ctrl;
360 pci_set_drvdata(pdev, ctrl);
362 /* Setup the slot information structures */
363 rc = init_slots(ctrl);
365 err("%s: slot initialization failed\n", SHPC_MODULE_NAME);
366 goto err_out_release_ctlr;
369 rc = shpchp_create_ctrl_files(ctrl);
371 goto err_cleanup_slots;
377 err_out_release_ctlr:
378 ctrl->hpc_ops->release_ctlr(ctrl);
385 static void shpc_remove(struct pci_dev *dev)
387 struct controller *ctrl = pci_get_drvdata(dev);
389 shpchp_remove_ctrl_files(ctrl);
390 ctrl->hpc_ops->release_ctlr(ctrl);
394 static struct pci_device_id shpcd_pci_tbl[] = {
395 {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
396 { /* end: all zeroes */ }
398 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
400 static struct pci_driver shpc_driver = {
401 .name = SHPC_MODULE_NAME,
402 .id_table = shpcd_pci_tbl,
404 .remove = shpc_remove,
407 static int __init shpcd_init(void)
411 retval = pci_register_driver(&shpc_driver);
412 dbg("%s: pci_register_driver = %d\n", __func__, retval);
413 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
417 static void __exit shpcd_cleanup(void)
419 dbg("unload_shpchpd()\n");
420 pci_unregister_driver(&shpc_driver);
421 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
424 module_init(shpcd_init);
425 module_exit(shpcd_cleanup);