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_max_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
73 static int get_cur_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
75 static struct hotplug_slot_ops pciehp_hotplug_slot_ops = {
77 .set_attention_status = set_attention_status,
78 .enable_slot = enable_slot,
79 .disable_slot = disable_slot,
80 .get_power_status = get_power_status,
81 .get_attention_status = get_attention_status,
82 .get_latch_status = get_latch_status,
83 .get_adapter_status = get_adapter_status,
84 .get_max_bus_speed = get_max_bus_speed,
85 .get_cur_bus_speed = get_cur_bus_speed,
89 * release_slot - free up the memory used by a slot
90 * @hotplug_slot: slot to free
92 static void release_slot(struct hotplug_slot *hotplug_slot)
94 struct slot *slot = hotplug_slot->private;
96 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
98 kfree(slot->hotplug_slot->info);
99 kfree(slot->hotplug_slot->name);
100 kfree(slot->hotplug_slot);
104 static int init_slots(struct controller *ctrl)
107 struct hpc_ops *hpc_ops;
108 struct hotplug_slot *hotplug_slot;
109 struct hotplug_slot_info *hotplug_slot_info;
113 int result = -ENOMEM;
115 number_of_slots = ctrl->num_slots;
116 slot_device = ctrl->slot_device_offset;
117 slot_number = ctrl->first_slot;
119 while (number_of_slots) {
120 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
125 kzalloc(sizeof(*(slot->hotplug_slot)),
127 if (!slot->hotplug_slot)
129 hotplug_slot = slot->hotplug_slot;
132 kzalloc(sizeof(*(hotplug_slot->info)),
134 if (!hotplug_slot->info)
136 hotplug_slot_info = hotplug_slot->info;
137 hotplug_slot->name = kmalloc(SLOT_NAME_SIZE, GFP_KERNEL);
138 if (!hotplug_slot->name)
142 slot->bus = ctrl->slot_bus;
143 slot->device = slot_device;
144 slot->hpc_ops = hpc_ops = ctrl->hpc_ops;
146 slot->number = ctrl->first_slot;
147 slot->hp_slot = slot_device - ctrl->slot_device_offset;
149 /* register this slot with the hotplug pci core */
150 hotplug_slot->private = slot;
151 hotplug_slot->release = &release_slot;
152 make_slot_name(hotplug_slot->name, SLOT_NAME_SIZE, slot);
153 hotplug_slot->ops = &pciehp_hotplug_slot_ops;
155 hpc_ops->get_power_status(slot,
156 &(hotplug_slot_info->power_status));
157 hpc_ops->get_attention_status(slot,
158 &(hotplug_slot_info->attention_status));
159 hpc_ops->get_latch_status(slot,
160 &(hotplug_slot_info->latch_status));
161 hpc_ops->get_adapter_status(slot,
162 &(hotplug_slot_info->adapter_status));
164 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
165 "slot_device_offset=%x\n",
166 slot->bus, slot->device, slot->hp_slot, slot->number,
167 ctrl->slot_device_offset);
168 result = pci_hp_register(hotplug_slot);
170 err ("pci_hp_register failed with error %d\n", result);
174 slot->next = ctrl->slot;
179 slot_number += ctrl->slot_num_inc;
185 kfree(hotplug_slot->name);
187 kfree(hotplug_slot_info);
197 static int cleanup_slots (struct controller * ctrl)
199 struct slot *old_slot, *next_slot;
201 old_slot = ctrl->slot;
205 next_slot = old_slot->next;
206 pci_hp_deregister (old_slot->hotplug_slot);
207 old_slot = next_slot;
214 static int get_ctlr_slot_config(struct controller *ctrl)
216 int num_ctlr_slots; /* Not needed; PCI Express has 1 slot per port*/
217 int first_device_num; /* Not needed */
218 int physical_slot_num;
222 rc = pcie_get_ctlr_slot_config(ctrl, &num_ctlr_slots, &first_device_num, &physical_slot_num, &ctrlcap);
224 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n", __FUNCTION__, ctrl->bus, ctrl->device);
228 ctrl->num_slots = num_ctlr_slots; /* PCI Express has 1 slot per port */
229 ctrl->slot_device_offset = first_device_num;
230 ctrl->first_slot = physical_slot_num;
231 ctrl->ctrlcap = ctrlcap;
233 dbg("%s: bus(0x%x) num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) ctrlcap(%x) for b:d (%x:%x)\n",
234 __FUNCTION__, ctrl->slot_bus, num_ctlr_slots, first_device_num, physical_slot_num, ctrlcap,
235 ctrl->bus, ctrl->device);
242 * set_attention_status - Turns the Amber LED for a slot on, off or blink
244 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
246 struct slot *slot = hotplug_slot->private;
248 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
250 hotplug_slot->info->attention_status = status;
252 if (ATTN_LED(slot->ctrl->ctrlcap))
253 slot->hpc_ops->set_attention_status(slot, status);
259 static int enable_slot(struct hotplug_slot *hotplug_slot)
261 struct slot *slot = hotplug_slot->private;
263 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
265 return pciehp_enable_slot(slot);
269 static int disable_slot(struct hotplug_slot *hotplug_slot)
271 struct slot *slot = hotplug_slot->private;
273 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
275 return pciehp_disable_slot(slot);
278 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
280 struct slot *slot = hotplug_slot->private;
283 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
285 retval = slot->hpc_ops->get_power_status(slot, value);
287 *value = hotplug_slot->info->power_status;
292 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
294 struct slot *slot = hotplug_slot->private;
297 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
299 retval = slot->hpc_ops->get_attention_status(slot, value);
301 *value = hotplug_slot->info->attention_status;
306 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
308 struct slot *slot = hotplug_slot->private;
311 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
313 retval = slot->hpc_ops->get_latch_status(slot, value);
315 *value = hotplug_slot->info->latch_status;
320 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
322 struct slot *slot = hotplug_slot->private;
325 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
327 retval = slot->hpc_ops->get_adapter_status(slot, value);
329 *value = hotplug_slot->info->adapter_status;
334 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
336 struct slot *slot = hotplug_slot->private;
339 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
341 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
343 *value = PCI_SPEED_UNKNOWN;
348 static int get_cur_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_cur_bus_speed(slot, value);
357 *value = PCI_SPEED_UNKNOWN;
362 static int pciehp_probe(struct pcie_device *dev, const struct pcie_port_service_id *id)
365 struct controller *ctrl;
367 int first_device_num = 0 ; /* first PCI device number supported by this PCIE */
368 int num_ctlr_slots; /* number of slots supported by this HPC */
370 struct pci_dev *pdev;
372 ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
374 err("%s : out of memory\n", __FUNCTION__);
379 ctrl->pci_dev = pdev;
381 rc = pcie_init(ctrl, dev);
383 dbg("%s: controller initialization failed\n", PCIE_MODULE_NAME);
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("%s: out of memory\n", __FUNCTION__);
393 goto err_out_unmap_mmio_region;
395 memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
396 ctrl->bus = pdev->bus->number; /* ctrl bus */
397 ctrl->slot_bus = pdev->subordinate->number; /* bus controlled by this HPC */
399 ctrl->device = PCI_SLOT(pdev->devfn);
400 ctrl->function = PCI_FUNC(pdev->devfn);
401 dbg("%s: ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", __FUNCTION__,
402 ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
405 * 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 /* Setup the slot information structures */
417 rc = init_slots(ctrl);
419 err(msg_initialization_err, 6);
420 goto err_out_free_ctrl_slot;
423 t_slot = pciehp_find_slot(ctrl, first_device_num);
425 /* Finish setting up the hot plug ctrl device */
426 ctrl->next_event = 0;
428 if (!pciehp_ctrl_list) {
429 pciehp_ctrl_list = ctrl;
432 ctrl->next = pciehp_ctrl_list;
433 pciehp_ctrl_list = ctrl;
436 /* Wait for exclusive access to hardware */
437 mutex_lock(&ctrl->crit_sect);
439 t_slot->hpc_ops->get_adapter_status(t_slot, &value); /* Check if slot is occupied */
441 if ((POWER_CTRL(ctrl->ctrlcap)) && !value) {
442 rc = t_slot->hpc_ops->power_off_slot(t_slot); /* Power off slot if not occupied*/
444 /* Done with exclusive hardware access */
445 mutex_unlock(&ctrl->crit_sect);
446 goto err_out_free_ctrl_slot;
448 /* Wait for the command to complete */
449 wait_for_ctrl_irq (ctrl);
452 /* Done with exclusive hardware access */
453 mutex_unlock(&ctrl->crit_sect);
457 err_out_free_ctrl_slot:
459 err_out_free_ctrl_bus:
460 kfree(ctrl->pci_bus);
461 err_out_unmap_mmio_region:
462 ctrl->hpc_ops->release_ctlr(ctrl);
470 static int pcie_start_thread(void)
474 dbg("Initialize + Start the notification/polling mechanism \n");
476 retval = pciehp_event_start_thread();
478 dbg("pciehp_event_start_thread() failed\n");
485 static void __exit unload_pciehpd(void)
487 struct controller *ctrl;
488 struct controller *tctrl;
490 ctrl = pciehp_ctrl_list;
495 kfree (ctrl->pci_bus);
497 ctrl->hpc_ops->release_ctlr(ctrl);
505 /* Stop the notification mechanism */
506 pciehp_event_stop_thread();
510 static int hpdriver_context = 0;
512 static void pciehp_remove (struct pcie_device *device)
514 printk("%s ENTRY\n", __FUNCTION__);
515 printk("%s -> Call free_irq for irq = %d\n",
516 __FUNCTION__, device->irq);
517 free_irq(device->irq, &hpdriver_context);
521 static int pciehp_suspend (struct pcie_device *dev, pm_message_t state)
523 printk("%s ENTRY\n", __FUNCTION__);
527 static int pciehp_resume (struct pcie_device *dev)
529 printk("%s ENTRY\n", __FUNCTION__);
534 static struct pcie_port_service_id port_pci_ids[] = { {
535 .vendor = PCI_ANY_ID,
536 .device = PCI_ANY_ID,
537 .port_type = PCIE_ANY_PORT,
538 .service_type = PCIE_PORT_SERVICE_HP,
540 }, { /* end: all zeroes */ }
542 static const char device_name[] = "hpdriver";
544 static struct pcie_port_service_driver hpdriver_portdrv = {
545 .name = (char *)device_name,
546 .id_table = &port_pci_ids[0],
548 .probe = pciehp_probe,
549 .remove = pciehp_remove,
552 .suspend = pciehp_suspend,
553 .resume = pciehp_resume,
557 static int __init pcied_init(void)
561 #ifdef CONFIG_HOTPLUG_PCI_PCIE_POLL_EVENT_MODE
562 pciehp_poll_mode = 1;
565 retval = pcie_start_thread();
569 retval = pcie_port_service_register(&hpdriver_portdrv);
570 dbg("pcie_port_service_register = %d\n", retval);
571 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
573 dbg("%s: Failure to register service\n", __FUNCTION__);
577 pciehp_event_stop_thread();
583 static void __exit pcied_cleanup(void)
585 dbg("unload_pciehpd()\n");
588 pcie_port_service_unregister(&hpdriver_portdrv);
590 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
593 module_init(pcied_init);
594 module_exit(pcied_cleanup);