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 = kmalloc(sizeof(struct slot), GFP_KERNEL);
123 memset(slot, 0, sizeof(struct slot));
125 hotplug_slot = kmalloc(sizeof(struct hotplug_slot),
129 memset(hotplug_slot, 0, sizeof(struct hotplug_slot));
130 slot->hotplug_slot = hotplug_slot;
132 info = kmalloc(sizeof(struct hotplug_slot_info), GFP_KERNEL);
135 memset(info, 0, sizeof (struct hotplug_slot_info));
136 hotplug_slot->info = info;
138 name = kmalloc(SLOT_NAME_SIZE, GFP_KERNEL);
141 hotplug_slot->name = name;
144 slot->magic = SLOT_MAGIC;
146 slot->bus = ctrl->slot_bus;
147 slot->device = ctrl->slot_device_offset + i;
148 slot->hpc_ops = ctrl->hpc_ops;
150 if (shpchprm_get_physical_slot_number(ctrl, &sun,
151 slot->bus, slot->device))
156 /* register this slot with the hotplug pci core */
157 hotplug_slot->private = slot;
158 hotplug_slot->release = &release_slot;
159 make_slot_name(slot);
160 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
162 get_power_status(hotplug_slot, &info->power_status);
163 get_attention_status(hotplug_slot, &info->attention_status);
164 get_latch_status(hotplug_slot, &info->latch_status);
165 get_adapter_status(hotplug_slot, &info->adapter_status);
167 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
168 "slot_device_offset=%x\n", slot->bus, slot->device,
169 slot->hp_slot, slot->number, ctrl->slot_device_offset);
170 retval = pci_hp_register(slot->hotplug_slot);
172 err("pci_hp_register failed with error %d\n", retval);
176 list_add(&slot->slot_list, &ctrl->slot_list);
192 static void cleanup_slots(struct controller *ctrl)
194 struct list_head *tmp;
195 struct list_head *next;
198 list_for_each_safe(tmp, next, &ctrl->slot_list) {
199 slot = list_entry(tmp, struct slot, slot_list);
200 list_del(&slot->slot_list);
201 pci_hp_deregister(slot->hotplug_slot);
205 static int get_ctlr_slot_config(struct controller *ctrl)
208 int first_device_num;
209 int physical_slot_num;
214 rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots,
215 &first_device_num, &physical_slot_num,
218 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n",
219 __FUNCTION__, ctrl->bus, ctrl->device);
223 ctrl->num_slots = num_ctlr_slots;
224 ctrl->slot_device_offset = first_device_num;
225 ctrl->first_slot = physical_slot_num;
226 ctrl->slot_num_inc = updown; /* either -1 or 1 */
228 dbg("%s: num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d "
229 "(%x:%x)\n", __FUNCTION__, num_ctlr_slots, first_device_num,
230 physical_slot_num, updown, ctrl->bus, ctrl->device);
236 * set_attention_status - Turns the Amber LED for a slot on, off or blink
238 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
240 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
242 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
244 hotplug_slot->info->attention_status = status;
245 slot->hpc_ops->set_attention_status(slot, status);
250 static int enable_slot (struct hotplug_slot *hotplug_slot)
252 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
254 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
256 return shpchp_enable_slot(slot);
259 static int disable_slot (struct hotplug_slot *hotplug_slot)
261 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
263 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
265 return shpchp_disable_slot(slot);
268 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
270 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
273 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
275 retval = slot->hpc_ops->get_power_status(slot, value);
277 *value = hotplug_slot->info->power_status;
282 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
284 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
287 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
289 retval = slot->hpc_ops->get_attention_status(slot, value);
291 *value = hotplug_slot->info->attention_status;
296 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
298 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
301 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
303 retval = slot->hpc_ops->get_latch_status(slot, value);
305 *value = hotplug_slot->info->latch_status;
310 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
312 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
315 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
317 retval = slot->hpc_ops->get_adapter_status(slot, value);
319 *value = hotplug_slot->info->adapter_status;
324 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
326 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
327 struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
329 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
331 *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
336 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
338 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
341 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
343 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
345 *value = PCI_SPEED_UNKNOWN;
350 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
352 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
355 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
357 retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
359 *value = PCI_SPEED_UNKNOWN;
364 static int is_shpc_capable(struct pci_dev *dev)
366 if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
367 PCI_DEVICE_ID_AMD_GOLAM_7450))
369 if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
375 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
378 struct controller *ctrl;
380 int first_device_num; /* first PCI device number */
381 int num_ctlr_slots; /* number of slots implemented */
383 if (!is_shpc_capable(pdev))
386 ctrl = kmalloc(sizeof(struct controller), GFP_KERNEL);
388 err("%s : out of memory\n", __FUNCTION__);
391 memset(ctrl, 0, sizeof(struct controller));
392 INIT_LIST_HEAD(&ctrl->slot_list);
394 rc = shpc_init(ctrl, pdev);
396 dbg("%s: controller initialization failed\n",
398 goto err_out_free_ctrl;
401 pci_set_drvdata(pdev, ctrl);
403 ctrl->pci_bus = kmalloc(sizeof (*ctrl->pci_bus), GFP_KERNEL);
404 if (!ctrl->pci_bus) {
405 err("out of memory\n");
407 goto err_out_unmap_mmio_region;
410 memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
411 ctrl->bus = pdev->bus->number;
412 ctrl->slot_bus = pdev->subordinate->number;
413 ctrl->device = PCI_SLOT(pdev->devfn);
414 ctrl->function = PCI_FUNC(pdev->devfn);
416 dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n",
417 ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
420 * Save configuration headers for this and subordinate PCI buses
422 rc = get_ctlr_slot_config(ctrl);
424 err(msg_initialization_err, rc);
425 goto err_out_free_ctrl_bus;
427 first_device_num = ctrl->slot_device_offset;
428 num_ctlr_slots = ctrl->num_slots;
430 ctrl->add_support = 1;
432 /* Setup the slot information structures */
433 rc = init_slots(ctrl);
435 err(msg_initialization_err, 6);
436 goto err_out_free_ctrl_slot;
439 /* Now hpc_functions (slot->hpc_ops->functions) are ready */
440 t_slot = shpchp_find_slot(ctrl, first_device_num);
442 /* Check for operation bus speed */
443 rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
444 dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
446 if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
447 err(SHPC_MODULE_NAME ": Can't get current bus speed. "
448 "Set to 33MHz PCI.\n");
449 ctrl->speed = PCI_SPEED_33MHz;
452 /* Finish setting up the hot plug ctrl device */
453 ctrl->next_event = 0;
455 list_add(&ctrl->ctrl_list, &shpchp_ctrl_list);
457 shpchp_create_ctrl_files(ctrl);
461 err_out_free_ctrl_slot:
463 err_out_free_ctrl_bus:
464 kfree(ctrl->pci_bus);
465 err_out_unmap_mmio_region:
466 ctrl->hpc_ops->release_ctlr(ctrl);
473 static int shpc_start_thread(void)
477 dbg("Initialize + Start the notification/polling mechanism \n");
479 retval = shpchp_event_start_thread();
481 dbg("shpchp_event_start_thread() failed\n");
488 static void __exit unload_shpchpd(void)
490 struct list_head *tmp;
491 struct list_head *next;
492 struct controller *ctrl;
494 list_for_each_safe(tmp, next, &shpchp_ctrl_list) {
495 ctrl = list_entry(tmp, struct controller, ctrl_list);
496 shpchp_remove_ctrl_files(ctrl);
498 kfree (ctrl->pci_bus);
499 ctrl->hpc_ops->release_ctlr(ctrl);
503 /* Stop the notification mechanism */
504 shpchp_event_stop_thread();
508 static struct pci_device_id shpcd_pci_tbl[] = {
509 {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
510 { /* end: all zeroes */ }
512 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
514 static struct pci_driver shpc_driver = {
515 .name = SHPC_MODULE_NAME,
516 .id_table = shpcd_pci_tbl,
518 /* remove: shpc_remove_one, */
521 static int __init shpcd_init(void)
525 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
526 shpchp_poll_mode = 1;
529 retval = shpc_start_thread();
533 retval = pci_register_driver(&shpc_driver);
534 dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
535 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
539 shpchp_event_stop_thread();
544 static void __exit shpcd_cleanup(void)
546 dbg("unload_shpchpd()\n");
549 pci_unregister_driver(&shpc_driver);
551 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
554 module_init(shpcd_init);
555 module_exit(shpcd_cleanup);