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 static 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_max_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
72 static int get_cur_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
74 static struct hotplug_slot_ops shpchp_hotplug_slot_ops = {
76 .set_attention_status = set_attention_status,
77 .enable_slot = enable_slot,
78 .disable_slot = disable_slot,
79 .get_power_status = get_power_status,
80 .get_attention_status = get_attention_status,
81 .get_latch_status = get_latch_status,
82 .get_adapter_status = get_adapter_status,
83 .get_max_bus_speed = get_max_bus_speed,
84 .get_cur_bus_speed = get_cur_bus_speed,
88 * release_slot - free up the memory used by a slot
89 * @hotplug_slot: slot to free
91 static void release_slot(struct hotplug_slot *hotplug_slot)
93 struct slot *slot = hotplug_slot->private;
95 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
97 kfree(slot->hotplug_slot->info);
98 kfree(slot->hotplug_slot);
102 static void make_slot_name(struct slot *slot)
104 if (shpchp_slot_with_bus)
105 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
106 slot->bus, slot->number);
108 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%d",
112 static int init_slots(struct controller *ctrl)
115 struct hotplug_slot *hotplug_slot;
116 struct hotplug_slot_info *info;
117 int retval = -ENOMEM;
120 for (i = 0; i < ctrl->num_slots; i++) {
121 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
125 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
128 slot->hotplug_slot = hotplug_slot;
130 info = kzalloc(sizeof(*info), GFP_KERNEL);
133 hotplug_slot->info = info;
135 hotplug_slot->name = slot->name;
139 slot->bus = ctrl->pci_dev->subordinate->number;
140 slot->device = ctrl->slot_device_offset + i;
141 slot->hpc_ops = ctrl->hpc_ops;
142 slot->number = ctrl->first_slot + (ctrl->slot_num_inc * i);
143 mutex_init(&slot->lock);
144 INIT_DELAYED_WORK(&slot->work, shpchp_queue_pushbutton_work);
146 /* register this slot with the hotplug pci core */
147 hotplug_slot->private = slot;
148 hotplug_slot->release = &release_slot;
149 make_slot_name(slot);
150 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
152 get_power_status(hotplug_slot, &info->power_status);
153 get_attention_status(hotplug_slot, &info->attention_status);
154 get_latch_status(hotplug_slot, &info->latch_status);
155 get_adapter_status(hotplug_slot, &info->adapter_status);
157 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
158 "slot_device_offset=%x\n", slot->bus, slot->device,
159 slot->hp_slot, slot->number, ctrl->slot_device_offset);
160 retval = pci_hp_register(slot->hotplug_slot,
161 ctrl->pci_dev->subordinate, slot->device);
163 err("pci_hp_register failed with error %d\n", retval);
164 if (retval == -EEXIST)
165 err("Failed to register slot because of name "
166 "collision. Try \'shpchp_slot_with_bus\' "
171 list_add(&slot->slot_list, &ctrl->slot_list);
185 void cleanup_slots(struct controller *ctrl)
187 struct list_head *tmp;
188 struct list_head *next;
191 list_for_each_safe(tmp, next, &ctrl->slot_list) {
192 slot = list_entry(tmp, struct slot, slot_list);
193 list_del(&slot->slot_list);
194 cancel_delayed_work(&slot->work);
195 flush_scheduled_work();
196 flush_workqueue(shpchp_wq);
197 pci_hp_deregister(slot->hotplug_slot);
202 * set_attention_status - Turns the Amber LED for a slot on, off or blink
204 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
206 struct slot *slot = get_slot(hotplug_slot);
208 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
210 hotplug_slot->info->attention_status = status;
211 slot->hpc_ops->set_attention_status(slot, status);
216 static int enable_slot (struct hotplug_slot *hotplug_slot)
218 struct slot *slot = get_slot(hotplug_slot);
220 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
222 return shpchp_sysfs_enable_slot(slot);
225 static int disable_slot (struct hotplug_slot *hotplug_slot)
227 struct slot *slot = get_slot(hotplug_slot);
229 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
231 return shpchp_sysfs_disable_slot(slot);
234 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
236 struct slot *slot = get_slot(hotplug_slot);
239 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
241 retval = slot->hpc_ops->get_power_status(slot, value);
243 *value = hotplug_slot->info->power_status;
248 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
250 struct slot *slot = get_slot(hotplug_slot);
253 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
255 retval = slot->hpc_ops->get_attention_status(slot, value);
257 *value = hotplug_slot->info->attention_status;
262 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
264 struct slot *slot = get_slot(hotplug_slot);
267 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
269 retval = slot->hpc_ops->get_latch_status(slot, value);
271 *value = hotplug_slot->info->latch_status;
276 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
278 struct slot *slot = get_slot(hotplug_slot);
281 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
283 retval = slot->hpc_ops->get_adapter_status(slot, value);
285 *value = hotplug_slot->info->adapter_status;
290 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot,
291 enum pci_bus_speed *value)
293 struct slot *slot = get_slot(hotplug_slot);
296 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
298 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
300 *value = PCI_SPEED_UNKNOWN;
305 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
307 struct slot *slot = get_slot(hotplug_slot);
310 dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
312 retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
314 *value = PCI_SPEED_UNKNOWN;
319 static int is_shpc_capable(struct pci_dev *dev)
321 if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
322 PCI_DEVICE_ID_AMD_GOLAM_7450))
324 if (!pci_find_capability(dev, PCI_CAP_ID_SHPC))
326 if (get_hp_hw_control_from_firmware(dev))
331 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
334 struct controller *ctrl;
336 if (!is_shpc_capable(pdev))
339 ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
341 err("%s : out of memory\n", __func__);
344 INIT_LIST_HEAD(&ctrl->slot_list);
346 rc = shpc_init(ctrl, pdev);
348 dbg("%s: controller initialization failed\n",
350 goto err_out_free_ctrl;
353 pci_set_drvdata(pdev, ctrl);
355 /* Setup the slot information structures */
356 rc = init_slots(ctrl);
358 err("%s: slot initialization failed\n", SHPC_MODULE_NAME);
359 goto err_out_release_ctlr;
362 rc = shpchp_create_ctrl_files(ctrl);
364 goto err_cleanup_slots;
370 err_out_release_ctlr:
371 ctrl->hpc_ops->release_ctlr(ctrl);
378 static void shpc_remove(struct pci_dev *dev)
380 struct controller *ctrl = pci_get_drvdata(dev);
382 shpchp_remove_ctrl_files(ctrl);
383 ctrl->hpc_ops->release_ctlr(ctrl);
387 static struct pci_device_id shpcd_pci_tbl[] = {
388 {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
389 { /* end: all zeroes */ }
391 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
393 static struct pci_driver shpc_driver = {
394 .name = SHPC_MODULE_NAME,
395 .id_table = shpcd_pci_tbl,
397 .remove = shpc_remove,
400 static int __init shpcd_init(void)
404 retval = pci_register_driver(&shpc_driver);
405 dbg("%s: pci_register_driver = %d\n", __func__, retval);
406 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
410 static void __exit shpcd_cleanup(void)
412 dbg("unload_shpchpd()\n");
413 pci_unregister_driver(&shpc_driver);
414 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
417 module_init(shpcd_init);
418 module_exit(shpcd_cleanup);