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>
37 /* Global variables */
41 LIST_HEAD(shpchp_ctrl_list);
43 #define DRIVER_VERSION "0.4"
44 #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
45 #define DRIVER_DESC "Standard Hot Plug PCI Controller Driver"
47 MODULE_AUTHOR(DRIVER_AUTHOR);
48 MODULE_DESCRIPTION(DRIVER_DESC);
49 MODULE_LICENSE("GPL");
51 module_param(shpchp_debug, bool, 0644);
52 module_param(shpchp_poll_mode, bool, 0644);
53 module_param(shpchp_poll_time, int, 0644);
54 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
55 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
56 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
58 #define SHPC_MODULE_NAME "shpchp"
60 static int shpc_start_thread (void);
61 static int set_attention_status (struct hotplug_slot *slot, u8 value);
62 static int enable_slot (struct hotplug_slot *slot);
63 static int disable_slot (struct hotplug_slot *slot);
64 static int get_power_status (struct hotplug_slot *slot, u8 *value);
65 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
66 static int get_latch_status (struct hotplug_slot *slot, u8 *value);
67 static int get_adapter_status (struct hotplug_slot *slot, u8 *value);
68 static int get_address (struct hotplug_slot *slot, u32 *value);
69 static int get_max_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
70 static int get_cur_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
72 static struct hotplug_slot_ops shpchp_hotplug_slot_ops = {
74 .set_attention_status = set_attention_status,
75 .enable_slot = enable_slot,
76 .disable_slot = disable_slot,
77 .get_power_status = get_power_status,
78 .get_attention_status = get_attention_status,
79 .get_latch_status = get_latch_status,
80 .get_adapter_status = get_adapter_status,
81 .get_address = get_address,
82 .get_max_bus_speed = get_max_bus_speed,
83 .get_cur_bus_speed = get_cur_bus_speed,
87 * release_slot - free up the memory used by a slot
88 * @hotplug_slot: slot to free
90 static void release_slot(struct hotplug_slot *hotplug_slot)
92 struct slot *slot = hotplug_slot->private;
94 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
96 kfree(slot->hotplug_slot->info);
97 kfree(slot->hotplug_slot->name);
98 kfree(slot->hotplug_slot);
102 #define SLOT_NAME_SIZE 10
103 static void make_slot_name(struct slot *slot)
105 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
106 slot->bus, slot->number);
109 static int init_slots(struct controller *ctrl)
112 struct hotplug_slot *hotplug_slot;
113 struct hotplug_slot_info *info;
115 int retval = -ENOMEM;
119 for (i = 0; i < ctrl->num_slots; i++) {
120 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
124 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
127 slot->hotplug_slot = hotplug_slot;
129 info = kzalloc(sizeof(*info), GFP_KERNEL);
132 hotplug_slot->info = info;
134 name = kmalloc(SLOT_NAME_SIZE, GFP_KERNEL);
137 hotplug_slot->name = name;
141 slot->bus = ctrl->slot_bus;
142 slot->device = ctrl->slot_device_offset + i;
143 slot->hpc_ops = ctrl->hpc_ops;
145 if (shpchprm_get_physical_slot_number(ctrl, &sun,
146 slot->bus, slot->device))
151 /* register this slot with the hotplug pci core */
152 hotplug_slot->private = slot;
153 hotplug_slot->release = &release_slot;
154 make_slot_name(slot);
155 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
157 get_power_status(hotplug_slot, &info->power_status);
158 get_attention_status(hotplug_slot, &info->attention_status);
159 get_latch_status(hotplug_slot, &info->latch_status);
160 get_adapter_status(hotplug_slot, &info->adapter_status);
162 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
163 "slot_device_offset=%x\n", slot->bus, slot->device,
164 slot->hp_slot, slot->number, ctrl->slot_device_offset);
165 retval = pci_hp_register(slot->hotplug_slot);
167 err("pci_hp_register failed with error %d\n", retval);
171 list_add(&slot->slot_list, &ctrl->slot_list);
187 static void cleanup_slots(struct controller *ctrl)
189 struct list_head *tmp;
190 struct list_head *next;
193 list_for_each_safe(tmp, next, &ctrl->slot_list) {
194 slot = list_entry(tmp, struct slot, slot_list);
195 list_del(&slot->slot_list);
196 pci_hp_deregister(slot->hotplug_slot);
200 static int get_ctlr_slot_config(struct controller *ctrl)
203 int first_device_num;
204 int physical_slot_num;
209 rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots,
210 &first_device_num, &physical_slot_num,
213 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n",
214 __FUNCTION__, ctrl->bus, ctrl->device);
218 ctrl->num_slots = num_ctlr_slots;
219 ctrl->slot_device_offset = first_device_num;
220 ctrl->first_slot = physical_slot_num;
221 ctrl->slot_num_inc = updown; /* either -1 or 1 */
223 dbg("%s: num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d "
224 "(%x:%x)\n", __FUNCTION__, num_ctlr_slots, first_device_num,
225 physical_slot_num, updown, ctrl->bus, ctrl->device);
231 * set_attention_status - Turns the Amber LED for a slot on, off or blink
233 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
235 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
237 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
239 hotplug_slot->info->attention_status = status;
240 slot->hpc_ops->set_attention_status(slot, status);
245 static int enable_slot (struct hotplug_slot *hotplug_slot)
247 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
249 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
251 return shpchp_enable_slot(slot);
254 static int disable_slot (struct hotplug_slot *hotplug_slot)
256 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
258 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
260 return shpchp_disable_slot(slot);
263 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
265 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
268 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
270 retval = slot->hpc_ops->get_power_status(slot, value);
272 *value = hotplug_slot->info->power_status;
277 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
279 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
282 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
284 retval = slot->hpc_ops->get_attention_status(slot, value);
286 *value = hotplug_slot->info->attention_status;
291 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
293 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
296 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
298 retval = slot->hpc_ops->get_latch_status(slot, value);
300 *value = hotplug_slot->info->latch_status;
305 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
307 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
310 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
312 retval = slot->hpc_ops->get_adapter_status(slot, value);
314 *value = hotplug_slot->info->adapter_status;
319 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
321 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
322 struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
324 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
326 *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
331 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
333 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
336 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
338 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
340 *value = PCI_SPEED_UNKNOWN;
345 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
347 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
350 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
352 retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
354 *value = PCI_SPEED_UNKNOWN;
359 static int is_shpc_capable(struct pci_dev *dev)
361 if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
362 PCI_DEVICE_ID_AMD_GOLAM_7450))
364 if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
370 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
373 struct controller *ctrl;
375 int first_device_num; /* first PCI device number */
376 int num_ctlr_slots; /* number of slots implemented */
378 if (!is_shpc_capable(pdev))
381 ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
383 err("%s : out of memory\n", __FUNCTION__);
386 INIT_LIST_HEAD(&ctrl->slot_list);
388 rc = shpc_init(ctrl, pdev);
390 dbg("%s: controller initialization failed\n",
392 goto err_out_free_ctrl;
395 pci_set_drvdata(pdev, ctrl);
397 ctrl->pci_bus = kmalloc(sizeof(*ctrl->pci_bus), GFP_KERNEL);
398 if (!ctrl->pci_bus) {
399 err("out of memory\n");
401 goto err_out_unmap_mmio_region;
404 memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
405 ctrl->bus = pdev->bus->number;
406 ctrl->slot_bus = pdev->subordinate->number;
407 ctrl->device = PCI_SLOT(pdev->devfn);
408 ctrl->function = PCI_FUNC(pdev->devfn);
410 dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n",
411 ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
414 * Save configuration headers for this and subordinate PCI buses
416 rc = get_ctlr_slot_config(ctrl);
418 err(msg_initialization_err, rc);
419 goto err_out_free_ctrl_bus;
421 first_device_num = ctrl->slot_device_offset;
422 num_ctlr_slots = ctrl->num_slots;
424 ctrl->add_support = 1;
426 /* Setup the slot information structures */
427 rc = init_slots(ctrl);
429 err(msg_initialization_err, 6);
430 goto err_out_free_ctrl_slot;
433 /* Now hpc_functions (slot->hpc_ops->functions) are ready */
434 t_slot = shpchp_find_slot(ctrl, first_device_num);
436 /* Check for operation bus speed */
437 rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
438 dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
440 if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
441 err(SHPC_MODULE_NAME ": Can't get current bus speed. "
442 "Set to 33MHz PCI.\n");
443 ctrl->speed = PCI_SPEED_33MHz;
446 /* Finish setting up the hot plug ctrl device */
447 ctrl->next_event = 0;
449 list_add(&ctrl->ctrl_list, &shpchp_ctrl_list);
451 shpchp_create_ctrl_files(ctrl);
455 err_out_free_ctrl_slot:
457 err_out_free_ctrl_bus:
458 kfree(ctrl->pci_bus);
459 err_out_unmap_mmio_region:
460 ctrl->hpc_ops->release_ctlr(ctrl);
467 static int shpc_start_thread(void)
471 dbg("Initialize + Start the notification/polling mechanism \n");
473 retval = shpchp_event_start_thread();
475 dbg("shpchp_event_start_thread() failed\n");
482 static void __exit unload_shpchpd(void)
484 struct list_head *tmp;
485 struct list_head *next;
486 struct controller *ctrl;
488 list_for_each_safe(tmp, next, &shpchp_ctrl_list) {
489 ctrl = list_entry(tmp, struct controller, ctrl_list);
490 shpchp_remove_ctrl_files(ctrl);
492 kfree (ctrl->pci_bus);
493 ctrl->hpc_ops->release_ctlr(ctrl);
497 /* Stop the notification mechanism */
498 shpchp_event_stop_thread();
502 static struct pci_device_id shpcd_pci_tbl[] = {
503 {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
504 { /* end: all zeroes */ }
506 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
508 static struct pci_driver shpc_driver = {
509 .name = SHPC_MODULE_NAME,
510 .id_table = shpcd_pci_tbl,
512 /* remove: shpc_remove_one, */
515 static int __init shpcd_init(void)
519 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
520 shpchp_poll_mode = 1;
523 retval = shpc_start_thread();
527 retval = pci_register_driver(&shpc_driver);
528 dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
529 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
533 shpchp_event_stop_thread();
538 static void __exit shpcd_cleanup(void)
540 dbg("unload_shpchpd()\n");
543 pci_unregister_driver(&shpc_driver);
545 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
548 module_init(shpcd_init);
549 module_exit(shpcd_cleanup);