2 * PCI Express 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>
36 #include <linux/interrupt.h>
38 /* Global variables */
43 struct controller *pciehp_ctrl_list;
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 "PCI Express Hot Plug Controller Driver"
49 MODULE_AUTHOR(DRIVER_AUTHOR);
50 MODULE_DESCRIPTION(DRIVER_DESC);
51 MODULE_LICENSE("GPL");
53 module_param(pciehp_debug, bool, 0644);
54 module_param(pciehp_poll_mode, bool, 0644);
55 module_param(pciehp_poll_time, int, 0644);
56 module_param(pciehp_force, bool, 0644);
57 MODULE_PARM_DESC(pciehp_debug, "Debugging mode enabled or not");
58 MODULE_PARM_DESC(pciehp_poll_mode, "Using polling mechanism for hot-plug events or not");
59 MODULE_PARM_DESC(pciehp_poll_time, "Polling mechanism frequency, in seconds");
60 MODULE_PARM_DESC(pciehp_force, "Force pciehp, even if _OSC and OSHP are missing");
62 #define PCIE_MODULE_NAME "pciehp"
64 static int pcie_start_thread (void);
65 static int set_attention_status (struct hotplug_slot *slot, u8 value);
66 static int enable_slot (struct hotplug_slot *slot);
67 static int disable_slot (struct hotplug_slot *slot);
68 static int get_power_status (struct hotplug_slot *slot, u8 *value);
69 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
70 static int get_latch_status (struct hotplug_slot *slot, u8 *value);
71 static int get_adapter_status (struct hotplug_slot *slot, u8 *value);
72 static int get_address (struct hotplug_slot *slot, u32 *value);
73 static int get_max_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
74 static int get_cur_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
76 static struct hotplug_slot_ops pciehp_hotplug_slot_ops = {
78 .set_attention_status = set_attention_status,
79 .enable_slot = enable_slot,
80 .disable_slot = disable_slot,
81 .get_power_status = get_power_status,
82 .get_attention_status = get_attention_status,
83 .get_latch_status = get_latch_status,
84 .get_adapter_status = get_adapter_status,
85 .get_address = get_address,
86 .get_max_bus_speed = get_max_bus_speed,
87 .get_cur_bus_speed = get_cur_bus_speed,
91 * release_slot - free up the memory used by a slot
92 * @hotplug_slot: slot to free
94 static void release_slot(struct hotplug_slot *hotplug_slot)
96 struct slot *slot = hotplug_slot->private;
98 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
100 kfree(slot->hotplug_slot->info);
101 kfree(slot->hotplug_slot->name);
102 kfree(slot->hotplug_slot);
106 static int init_slots(struct controller *ctrl)
109 struct hpc_ops *hpc_ops;
110 struct hotplug_slot *hotplug_slot;
111 struct hotplug_slot_info *hotplug_slot_info;
115 int result = -ENOMEM;
117 number_of_slots = ctrl->num_slots;
118 slot_device = ctrl->slot_device_offset;
119 slot_number = ctrl->first_slot;
121 while (number_of_slots) {
122 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
127 kzalloc(sizeof(*(slot->hotplug_slot)),
129 if (!slot->hotplug_slot)
131 hotplug_slot = slot->hotplug_slot;
134 kzalloc(sizeof(*(hotplug_slot->info)),
136 if (!hotplug_slot->info)
138 hotplug_slot_info = hotplug_slot->info;
139 hotplug_slot->name = kmalloc(SLOT_NAME_SIZE, GFP_KERNEL);
140 if (!hotplug_slot->name)
144 slot->bus = ctrl->slot_bus;
145 slot->device = slot_device;
146 slot->hpc_ops = hpc_ops = ctrl->hpc_ops;
148 slot->number = ctrl->first_slot;
149 slot->hp_slot = slot_device - ctrl->slot_device_offset;
151 /* register this slot with the hotplug pci core */
152 hotplug_slot->private = slot;
153 hotplug_slot->release = &release_slot;
154 make_slot_name(hotplug_slot->name, SLOT_NAME_SIZE, slot);
155 hotplug_slot->ops = &pciehp_hotplug_slot_ops;
157 hpc_ops->get_power_status(slot,
158 &(hotplug_slot_info->power_status));
159 hpc_ops->get_attention_status(slot,
160 &(hotplug_slot_info->attention_status));
161 hpc_ops->get_latch_status(slot,
162 &(hotplug_slot_info->latch_status));
163 hpc_ops->get_adapter_status(slot,
164 &(hotplug_slot_info->adapter_status));
166 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
167 "slot_device_offset=%x\n",
168 slot->bus, slot->device, slot->hp_slot, slot->number,
169 ctrl->slot_device_offset);
170 result = pci_hp_register(hotplug_slot);
172 err ("pci_hp_register failed with error %d\n", result);
176 slot->next = ctrl->slot;
181 slot_number += ctrl->slot_num_inc;
187 kfree(hotplug_slot->name);
189 kfree(hotplug_slot_info);
199 static int cleanup_slots (struct controller * ctrl)
201 struct slot *old_slot, *next_slot;
203 old_slot = ctrl->slot;
207 next_slot = old_slot->next;
208 pci_hp_deregister (old_slot->hotplug_slot);
209 old_slot = next_slot;
216 static int get_ctlr_slot_config(struct controller *ctrl)
218 int num_ctlr_slots; /* Not needed; PCI Express has 1 slot per port*/
219 int first_device_num; /* Not needed */
220 int physical_slot_num;
224 rc = pcie_get_ctlr_slot_config(ctrl, &num_ctlr_slots, &first_device_num, &physical_slot_num, &ctrlcap);
226 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n", __FUNCTION__, ctrl->bus, ctrl->device);
230 ctrl->num_slots = num_ctlr_slots; /* PCI Express has 1 slot per port */
231 ctrl->slot_device_offset = first_device_num;
232 ctrl->first_slot = physical_slot_num;
233 ctrl->ctrlcap = ctrlcap;
235 dbg("%s: bus(0x%x) num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) ctrlcap(%x) for b:d (%x:%x)\n",
236 __FUNCTION__, ctrl->slot_bus, num_ctlr_slots, first_device_num, physical_slot_num, ctrlcap,
237 ctrl->bus, ctrl->device);
244 * set_attention_status - Turns the Amber LED for a slot on, off or blink
246 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
248 struct slot *slot = hotplug_slot->private;
250 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
252 hotplug_slot->info->attention_status = status;
254 if (ATTN_LED(slot->ctrl->ctrlcap))
255 slot->hpc_ops->set_attention_status(slot, status);
261 static int enable_slot(struct hotplug_slot *hotplug_slot)
263 struct slot *slot = hotplug_slot->private;
265 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
267 return pciehp_enable_slot(slot);
271 static int disable_slot(struct hotplug_slot *hotplug_slot)
273 struct slot *slot = hotplug_slot->private;
275 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
277 return pciehp_disable_slot(slot);
280 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
282 struct slot *slot = hotplug_slot->private;
285 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
287 retval = slot->hpc_ops->get_power_status(slot, value);
289 *value = hotplug_slot->info->power_status;
294 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
296 struct slot *slot = hotplug_slot->private;
299 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
301 retval = slot->hpc_ops->get_attention_status(slot, value);
303 *value = hotplug_slot->info->attention_status;
308 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
310 struct slot *slot = hotplug_slot->private;
313 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
315 retval = slot->hpc_ops->get_latch_status(slot, value);
317 *value = hotplug_slot->info->latch_status;
322 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
324 struct slot *slot = hotplug_slot->private;
327 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
329 retval = slot->hpc_ops->get_adapter_status(slot, value);
331 *value = hotplug_slot->info->adapter_status;
336 static int get_address(struct hotplug_slot *hotplug_slot, u32 *value)
338 struct slot *slot = hotplug_slot->private;
339 struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
341 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
343 *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
348 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
350 struct slot *slot = hotplug_slot->private;
353 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
355 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
357 *value = PCI_SPEED_UNKNOWN;
362 static int get_cur_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
364 struct slot *slot = hotplug_slot->private;
367 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
369 retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
371 *value = PCI_SPEED_UNKNOWN;
376 static int pciehp_probe(struct pcie_device *dev, const struct pcie_port_service_id *id)
379 struct controller *ctrl;
381 int first_device_num = 0 ; /* first PCI device number supported by this PCIE */
382 int num_ctlr_slots; /* number of slots supported by this HPC */
384 struct pci_dev *pdev;
386 ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
388 err("%s : out of memory\n", __FUNCTION__);
393 ctrl->pci_dev = pdev;
395 rc = pcie_init(ctrl, dev);
397 dbg("%s: controller initialization failed\n", PCIE_MODULE_NAME);
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("%s: out of memory\n", __FUNCTION__);
407 goto err_out_unmap_mmio_region;
409 memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
410 ctrl->bus = pdev->bus->number; /* ctrl bus */
411 ctrl->slot_bus = pdev->subordinate->number; /* bus controlled by this HPC */
413 ctrl->device = PCI_SLOT(pdev->devfn);
414 ctrl->function = PCI_FUNC(pdev->devfn);
415 dbg("%s: ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", __FUNCTION__,
416 ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
419 * 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 /* Setup the slot information structures */
431 rc = init_slots(ctrl);
433 err(msg_initialization_err, 6);
434 goto err_out_free_ctrl_slot;
437 t_slot = pciehp_find_slot(ctrl, first_device_num);
439 /* Finish setting up the hot plug ctrl device */
440 ctrl->next_event = 0;
442 if (!pciehp_ctrl_list) {
443 pciehp_ctrl_list = ctrl;
446 ctrl->next = pciehp_ctrl_list;
447 pciehp_ctrl_list = ctrl;
450 /* Wait for exclusive access to hardware */
451 mutex_lock(&ctrl->ctrl_lock);
453 t_slot->hpc_ops->get_adapter_status(t_slot, &value); /* Check if slot is occupied */
455 if ((POWER_CTRL(ctrl->ctrlcap)) && !value) {
456 rc = t_slot->hpc_ops->power_off_slot(t_slot); /* Power off slot if not occupied*/
458 /* Done with exclusive hardware access */
459 mutex_unlock(&ctrl->ctrl_lock);
460 goto err_out_free_ctrl_slot;
462 /* Wait for the command to complete */
463 wait_for_ctrl_irq (ctrl);
466 /* Done with exclusive hardware access */
467 mutex_unlock(&ctrl->ctrl_lock);
471 err_out_free_ctrl_slot:
473 err_out_free_ctrl_bus:
474 kfree(ctrl->pci_bus);
475 err_out_unmap_mmio_region:
476 ctrl->hpc_ops->release_ctlr(ctrl);
484 static int pcie_start_thread(void)
488 dbg("Initialize + Start the notification/polling mechanism \n");
490 retval = pciehp_event_start_thread();
492 dbg("pciehp_event_start_thread() failed\n");
499 static void __exit unload_pciehpd(void)
501 struct controller *ctrl;
502 struct controller *tctrl;
504 ctrl = pciehp_ctrl_list;
509 kfree (ctrl->pci_bus);
511 ctrl->hpc_ops->release_ctlr(ctrl);
519 /* Stop the notification mechanism */
520 pciehp_event_stop_thread();
524 static int hpdriver_context = 0;
526 static void pciehp_remove (struct pcie_device *device)
528 printk("%s ENTRY\n", __FUNCTION__);
529 printk("%s -> Call free_irq for irq = %d\n",
530 __FUNCTION__, device->irq);
531 free_irq(device->irq, &hpdriver_context);
535 static int pciehp_suspend (struct pcie_device *dev, pm_message_t state)
537 printk("%s ENTRY\n", __FUNCTION__);
541 static int pciehp_resume (struct pcie_device *dev)
543 printk("%s ENTRY\n", __FUNCTION__);
548 static struct pcie_port_service_id port_pci_ids[] = { {
549 .vendor = PCI_ANY_ID,
550 .device = PCI_ANY_ID,
551 .port_type = PCIE_ANY_PORT,
552 .service_type = PCIE_PORT_SERVICE_HP,
554 }, { /* end: all zeroes */ }
556 static const char device_name[] = "hpdriver";
558 static struct pcie_port_service_driver hpdriver_portdrv = {
559 .name = (char *)device_name,
560 .id_table = &port_pci_ids[0],
562 .probe = pciehp_probe,
563 .remove = pciehp_remove,
566 .suspend = pciehp_suspend,
567 .resume = pciehp_resume,
571 static int __init pcied_init(void)
575 #ifdef CONFIG_HOTPLUG_PCI_PCIE_POLL_EVENT_MODE
576 pciehp_poll_mode = 1;
579 retval = pcie_start_thread();
583 retval = pcie_port_service_register(&hpdriver_portdrv);
584 dbg("pcie_port_service_register = %d\n", retval);
585 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
587 dbg("%s: Failure to register service\n", __FUNCTION__);
591 pciehp_event_stop_thread();
597 static void __exit pcied_cleanup(void)
599 dbg("unload_pciehpd()\n");
602 pcie_port_service_unregister(&hpdriver_portdrv);
604 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
607 module_init(pcied_init);
608 module_exit(pcied_cleanup);