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);
101 static void make_slot_name(struct slot *slot)
103 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
104 slot->bus, slot->number);
107 static int init_slots(struct controller *ctrl)
110 struct hotplug_slot *hotplug_slot;
111 struct hotplug_slot_info *info;
112 int retval = -ENOMEM;
116 for (i = 0; i < ctrl->num_slots; i++) {
117 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
121 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
124 slot->hotplug_slot = hotplug_slot;
126 info = kzalloc(sizeof(*info), GFP_KERNEL);
129 hotplug_slot->info = info;
131 hotplug_slot->name = slot->name;
135 slot->bus = ctrl->slot_bus;
136 slot->device = ctrl->slot_device_offset + i;
137 slot->hpc_ops = ctrl->hpc_ops;
139 if (shpchprm_get_physical_slot_number(ctrl, &sun,
140 slot->bus, slot->device))
145 /* register this slot with the hotplug pci core */
146 hotplug_slot->private = slot;
147 hotplug_slot->release = &release_slot;
148 make_slot_name(slot);
149 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
151 get_power_status(hotplug_slot, &info->power_status);
152 get_attention_status(hotplug_slot, &info->attention_status);
153 get_latch_status(hotplug_slot, &info->latch_status);
154 get_adapter_status(hotplug_slot, &info->adapter_status);
156 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
157 "slot_device_offset=%x\n", slot->bus, slot->device,
158 slot->hp_slot, slot->number, ctrl->slot_device_offset);
159 retval = pci_hp_register(slot->hotplug_slot);
161 err("pci_hp_register failed with error %d\n", retval);
165 list_add(&slot->slot_list, &ctrl->slot_list);
179 static void cleanup_slots(struct controller *ctrl)
181 struct list_head *tmp;
182 struct list_head *next;
185 list_for_each_safe(tmp, next, &ctrl->slot_list) {
186 slot = list_entry(tmp, struct slot, slot_list);
187 list_del(&slot->slot_list);
188 pci_hp_deregister(slot->hotplug_slot);
192 static int get_ctlr_slot_config(struct controller *ctrl)
195 int first_device_num;
196 int physical_slot_num;
201 rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots,
202 &first_device_num, &physical_slot_num,
205 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n",
206 __FUNCTION__, ctrl->bus, ctrl->device);
210 ctrl->num_slots = num_ctlr_slots;
211 ctrl->slot_device_offset = first_device_num;
212 ctrl->first_slot = physical_slot_num;
213 ctrl->slot_num_inc = updown; /* either -1 or 1 */
215 dbg("%s: num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d "
216 "(%x:%x)\n", __FUNCTION__, num_ctlr_slots, first_device_num,
217 physical_slot_num, updown, ctrl->bus, ctrl->device);
223 * set_attention_status - Turns the Amber LED for a slot on, off or blink
225 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
227 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
229 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
231 hotplug_slot->info->attention_status = status;
232 slot->hpc_ops->set_attention_status(slot, status);
237 static int enable_slot (struct hotplug_slot *hotplug_slot)
239 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
241 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
243 return shpchp_enable_slot(slot);
246 static int disable_slot (struct hotplug_slot *hotplug_slot)
248 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
250 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
252 return shpchp_disable_slot(slot);
255 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
257 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
260 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
262 retval = slot->hpc_ops->get_power_status(slot, value);
264 *value = hotplug_slot->info->power_status;
269 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
271 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
274 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
276 retval = slot->hpc_ops->get_attention_status(slot, value);
278 *value = hotplug_slot->info->attention_status;
283 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
285 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
288 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
290 retval = slot->hpc_ops->get_latch_status(slot, value);
292 *value = hotplug_slot->info->latch_status;
297 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
299 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
302 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
304 retval = slot->hpc_ops->get_adapter_status(slot, value);
306 *value = hotplug_slot->info->adapter_status;
311 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
313 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
314 struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
316 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
318 *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
323 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
325 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
328 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
330 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
332 *value = PCI_SPEED_UNKNOWN;
337 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
339 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
342 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
344 retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
346 *value = PCI_SPEED_UNKNOWN;
351 static int is_shpc_capable(struct pci_dev *dev)
353 if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
354 PCI_DEVICE_ID_AMD_GOLAM_7450))
356 if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
362 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
365 struct controller *ctrl;
367 int first_device_num; /* first PCI device number */
368 int num_ctlr_slots; /* number of slots implemented */
370 if (!is_shpc_capable(pdev))
373 ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
375 err("%s : out of memory\n", __FUNCTION__);
378 INIT_LIST_HEAD(&ctrl->slot_list);
380 rc = shpc_init(ctrl, pdev);
382 dbg("%s: controller initialization failed\n",
384 goto err_out_free_ctrl;
387 pci_set_drvdata(pdev, ctrl);
389 ctrl->pci_bus = kmalloc(sizeof(*ctrl->pci_bus), GFP_KERNEL);
390 if (!ctrl->pci_bus) {
391 err("out of memory\n");
393 goto err_out_unmap_mmio_region;
396 memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
397 ctrl->bus = pdev->bus->number;
398 ctrl->slot_bus = pdev->subordinate->number;
399 ctrl->device = PCI_SLOT(pdev->devfn);
400 ctrl->function = PCI_FUNC(pdev->devfn);
402 dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n",
403 ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
406 * Save configuration headers for this and subordinate PCI buses
408 rc = get_ctlr_slot_config(ctrl);
410 err(msg_initialization_err, rc);
411 goto err_out_free_ctrl_bus;
413 first_device_num = ctrl->slot_device_offset;
414 num_ctlr_slots = ctrl->num_slots;
416 ctrl->add_support = 1;
418 /* Setup the slot information structures */
419 rc = init_slots(ctrl);
421 err(msg_initialization_err, 6);
422 goto err_out_free_ctrl_slot;
425 /* Now hpc_functions (slot->hpc_ops->functions) are ready */
426 t_slot = shpchp_find_slot(ctrl, first_device_num);
428 /* Check for operation bus speed */
429 rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
430 dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
432 if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
433 err(SHPC_MODULE_NAME ": Can't get current bus speed. "
434 "Set to 33MHz PCI.\n");
435 ctrl->speed = PCI_SPEED_33MHz;
438 /* Finish setting up the hot plug ctrl device */
439 ctrl->next_event = 0;
441 list_add(&ctrl->ctrl_list, &shpchp_ctrl_list);
443 shpchp_create_ctrl_files(ctrl);
447 err_out_free_ctrl_slot:
449 err_out_free_ctrl_bus:
450 kfree(ctrl->pci_bus);
451 err_out_unmap_mmio_region:
452 ctrl->hpc_ops->release_ctlr(ctrl);
459 static int shpc_start_thread(void)
463 dbg("Initialize + Start the notification/polling mechanism \n");
465 retval = shpchp_event_start_thread();
467 dbg("shpchp_event_start_thread() failed\n");
474 static void __exit unload_shpchpd(void)
476 struct list_head *tmp;
477 struct list_head *next;
478 struct controller *ctrl;
480 list_for_each_safe(tmp, next, &shpchp_ctrl_list) {
481 ctrl = list_entry(tmp, struct controller, ctrl_list);
482 shpchp_remove_ctrl_files(ctrl);
484 kfree (ctrl->pci_bus);
485 ctrl->hpc_ops->release_ctlr(ctrl);
489 /* Stop the notification mechanism */
490 shpchp_event_stop_thread();
494 static struct pci_device_id shpcd_pci_tbl[] = {
495 {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
496 { /* end: all zeroes */ }
498 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
500 static struct pci_driver shpc_driver = {
501 .name = SHPC_MODULE_NAME,
502 .id_table = shpcd_pci_tbl,
504 /* remove: shpc_remove_one, */
507 static int __init shpcd_init(void)
511 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
512 shpchp_poll_mode = 1;
515 retval = shpc_start_thread();
519 retval = pci_register_driver(&shpc_driver);
520 dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
521 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
525 shpchp_event_stop_thread();
530 static void __exit shpcd_cleanup(void)
532 dbg("unload_shpchpd()\n");
535 pci_unregister_driver(&shpc_driver);
537 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
540 module_init(shpcd_init);
541 module_exit(shpcd_cleanup);