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 */
42 struct controller *pciehp_ctrl_list;
44 #define DRIVER_VERSION "0.4"
45 #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
46 #define DRIVER_DESC "PCI Express Hot Plug Controller Driver"
48 MODULE_AUTHOR(DRIVER_AUTHOR);
49 MODULE_DESCRIPTION(DRIVER_DESC);
50 MODULE_LICENSE("GPL");
52 module_param(pciehp_debug, bool, 0644);
53 module_param(pciehp_poll_mode, bool, 0644);
54 module_param(pciehp_poll_time, int, 0644);
55 MODULE_PARM_DESC(pciehp_debug, "Debugging mode enabled or not");
56 MODULE_PARM_DESC(pciehp_poll_mode, "Using polling mechanism for hot-plug events or not");
57 MODULE_PARM_DESC(pciehp_poll_time, "Polling mechanism frequency, in seconds");
59 #define PCIE_MODULE_NAME "pciehp"
61 static int pcie_start_thread (void);
62 static int set_attention_status (struct hotplug_slot *slot, u8 value);
63 static int enable_slot (struct hotplug_slot *slot);
64 static int disable_slot (struct hotplug_slot *slot);
65 static int get_power_status (struct hotplug_slot *slot, u8 *value);
66 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
67 static int get_latch_status (struct hotplug_slot *slot, u8 *value);
68 static int get_adapter_status (struct hotplug_slot *slot, u8 *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 pciehp_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_max_bus_speed = get_max_bus_speed,
82 .get_cur_bus_speed = get_cur_bus_speed,
86 * release_slot - free up the memory used by a slot
87 * @hotplug_slot: slot to free
89 static void release_slot(struct hotplug_slot *hotplug_slot)
91 struct slot *slot = hotplug_slot->private;
93 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
95 kfree(slot->hotplug_slot->info);
96 kfree(slot->hotplug_slot->name);
97 kfree(slot->hotplug_slot);
101 static int init_slots(struct controller *ctrl)
103 struct slot *new_slot;
107 int result = -ENOMEM;
109 number_of_slots = ctrl->num_slots;
110 slot_device = ctrl->slot_device_offset;
111 slot_number = ctrl->first_slot;
113 while (number_of_slots) {
114 new_slot = kmalloc(sizeof(*new_slot), GFP_KERNEL);
118 memset(new_slot, 0, sizeof(struct slot));
119 new_slot->hotplug_slot =
120 kmalloc(sizeof(*(new_slot->hotplug_slot)),
122 if (!new_slot->hotplug_slot)
124 memset(new_slot->hotplug_slot, 0, sizeof(struct hotplug_slot));
126 new_slot->hotplug_slot->info =
127 kmalloc(sizeof(*(new_slot->hotplug_slot->info)),
129 if (!new_slot->hotplug_slot->info)
131 memset(new_slot->hotplug_slot->info, 0,
132 sizeof(struct hotplug_slot_info));
133 new_slot->hotplug_slot->name = kmalloc(SLOT_NAME_SIZE,
135 if (!new_slot->hotplug_slot->name)
138 new_slot->ctrl = ctrl;
139 new_slot->bus = ctrl->slot_bus;
140 new_slot->device = slot_device;
141 new_slot->hpc_ops = ctrl->hpc_ops;
143 new_slot->number = ctrl->first_slot;
144 new_slot->hp_slot = slot_device - ctrl->slot_device_offset;
146 /* register this slot with the hotplug pci core */
147 new_slot->hotplug_slot->private = new_slot;
148 new_slot->hotplug_slot->release = &release_slot;
149 make_slot_name(new_slot->hotplug_slot->name, SLOT_NAME_SIZE, new_slot);
150 new_slot->hotplug_slot->ops = &pciehp_hotplug_slot_ops;
152 new_slot->hpc_ops->get_power_status(new_slot, &(new_slot->hotplug_slot->info->power_status));
153 new_slot->hpc_ops->get_attention_status(new_slot, &(new_slot->hotplug_slot->info->attention_status));
154 new_slot->hpc_ops->get_latch_status(new_slot, &(new_slot->hotplug_slot->info->latch_status));
155 new_slot->hpc_ops->get_adapter_status(new_slot, &(new_slot->hotplug_slot->info->adapter_status));
157 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x slot_device_offset=%x\n",
158 new_slot->bus, new_slot->device, new_slot->hp_slot, new_slot->number, ctrl->slot_device_offset);
159 result = pci_hp_register (new_slot->hotplug_slot);
161 err ("pci_hp_register failed with error %d\n", result);
165 new_slot->next = ctrl->slot;
166 ctrl->slot = new_slot;
170 slot_number += ctrl->slot_num_inc;
176 kfree(new_slot->hotplug_slot->name);
178 kfree(new_slot->hotplug_slot->info);
180 kfree(new_slot->hotplug_slot);
188 static int cleanup_slots (struct controller * ctrl)
190 struct slot *old_slot, *next_slot;
192 old_slot = ctrl->slot;
196 next_slot = old_slot->next;
197 pci_hp_deregister (old_slot->hotplug_slot);
198 old_slot = next_slot;
205 static int get_ctlr_slot_config(struct controller *ctrl)
207 int num_ctlr_slots; /* Not needed; PCI Express has 1 slot per port*/
208 int first_device_num; /* Not needed */
209 int physical_slot_num;
213 rc = pcie_get_ctlr_slot_config(ctrl, &num_ctlr_slots, &first_device_num, &physical_slot_num, &ctrlcap);
215 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n", __FUNCTION__, ctrl->bus, ctrl->device);
219 ctrl->num_slots = num_ctlr_slots; /* PCI Express has 1 slot per port */
220 ctrl->slot_device_offset = first_device_num;
221 ctrl->first_slot = physical_slot_num;
222 ctrl->ctrlcap = ctrlcap;
224 dbg("%s: bus(0x%x) num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) ctrlcap(%x) for b:d (%x:%x)\n",
225 __FUNCTION__, ctrl->slot_bus, num_ctlr_slots, first_device_num, physical_slot_num, ctrlcap,
226 ctrl->bus, ctrl->device);
233 * set_attention_status - Turns the Amber LED for a slot on, off or blink
235 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
237 struct slot *slot = hotplug_slot->private;
239 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
241 hotplug_slot->info->attention_status = status;
243 if (ATTN_LED(slot->ctrl->ctrlcap))
244 slot->hpc_ops->set_attention_status(slot, status);
250 static int enable_slot(struct hotplug_slot *hotplug_slot)
252 struct slot *slot = hotplug_slot->private;
254 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
256 return pciehp_enable_slot(slot);
260 static int disable_slot(struct hotplug_slot *hotplug_slot)
262 struct slot *slot = hotplug_slot->private;
264 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
266 return pciehp_disable_slot(slot);
269 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
271 struct slot *slot = hotplug_slot->private;
274 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
276 retval = slot->hpc_ops->get_power_status(slot, value);
278 *value = hotplug_slot->info->power_status;
283 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
285 struct slot *slot = hotplug_slot->private;
288 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
290 retval = slot->hpc_ops->get_attention_status(slot, value);
292 *value = hotplug_slot->info->attention_status;
297 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
299 struct slot *slot = hotplug_slot->private;
302 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
304 retval = slot->hpc_ops->get_latch_status(slot, value);
306 *value = hotplug_slot->info->latch_status;
311 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
313 struct slot *slot = hotplug_slot->private;
316 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
318 retval = slot->hpc_ops->get_adapter_status(slot, value);
320 *value = hotplug_slot->info->adapter_status;
325 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
327 struct slot *slot = hotplug_slot->private;
330 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
332 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
334 *value = PCI_SPEED_UNKNOWN;
339 static int get_cur_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
341 struct slot *slot = hotplug_slot->private;
344 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
346 retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
348 *value = PCI_SPEED_UNKNOWN;
353 static int pciehp_probe(struct pcie_device *dev, const struct pcie_port_service_id *id)
356 struct controller *ctrl;
358 int first_device_num = 0 ; /* first PCI device number supported by this PCIE */
359 int num_ctlr_slots; /* number of slots supported by this HPC */
361 struct pci_dev *pdev;
363 ctrl = kmalloc(sizeof(*ctrl), GFP_KERNEL);
365 err("%s : out of memory\n", __FUNCTION__);
368 memset(ctrl, 0, sizeof(struct controller));
371 ctrl->pci_dev = pdev;
373 rc = pcie_init(ctrl, dev);
375 dbg("%s: controller initialization failed\n", PCIE_MODULE_NAME);
376 goto err_out_free_ctrl;
379 pci_set_drvdata(pdev, ctrl);
381 ctrl->pci_bus = kmalloc(sizeof(*ctrl->pci_bus), GFP_KERNEL);
382 if (!ctrl->pci_bus) {
383 err("%s: out of memory\n", __FUNCTION__);
385 goto err_out_unmap_mmio_region;
387 memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
388 ctrl->bus = pdev->bus->number; /* ctrl bus */
389 ctrl->slot_bus = pdev->subordinate->number; /* bus controlled by this HPC */
391 ctrl->device = PCI_SLOT(pdev->devfn);
392 ctrl->function = PCI_FUNC(pdev->devfn);
393 dbg("%s: ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", __FUNCTION__,
394 ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
397 * Save configuration headers for this and subordinate PCI buses
400 rc = get_ctlr_slot_config(ctrl);
402 err(msg_initialization_err, rc);
403 goto err_out_free_ctrl_bus;
405 first_device_num = ctrl->slot_device_offset;
406 num_ctlr_slots = ctrl->num_slots;
408 /* Setup the slot information structures */
409 rc = init_slots(ctrl);
411 err(msg_initialization_err, 6);
412 goto err_out_free_ctrl_slot;
415 t_slot = pciehp_find_slot(ctrl, first_device_num);
417 /* Finish setting up the hot plug ctrl device */
418 ctrl->next_event = 0;
420 if (!pciehp_ctrl_list) {
421 pciehp_ctrl_list = ctrl;
424 ctrl->next = pciehp_ctrl_list;
425 pciehp_ctrl_list = ctrl;
428 /* Wait for exclusive access to hardware */
429 down(&ctrl->crit_sect);
431 t_slot->hpc_ops->get_adapter_status(t_slot, &value); /* Check if slot is occupied */
433 if ((POWER_CTRL(ctrl->ctrlcap)) && !value) {
434 rc = t_slot->hpc_ops->power_off_slot(t_slot); /* Power off slot if not occupied*/
436 /* Done with exclusive hardware access */
437 up(&ctrl->crit_sect);
438 goto err_out_free_ctrl_slot;
440 /* Wait for the command to complete */
441 wait_for_ctrl_irq (ctrl);
444 /* Done with exclusive hardware access */
445 up(&ctrl->crit_sect);
449 err_out_free_ctrl_slot:
451 err_out_free_ctrl_bus:
452 kfree(ctrl->pci_bus);
453 err_out_unmap_mmio_region:
454 ctrl->hpc_ops->release_ctlr(ctrl);
462 static int pcie_start_thread(void)
466 dbg("Initialize + Start the notification/polling mechanism \n");
468 retval = pciehp_event_start_thread();
470 dbg("pciehp_event_start_thread() failed\n");
477 static void __exit unload_pciehpd(void)
479 struct controller *ctrl;
480 struct controller *tctrl;
482 ctrl = pciehp_ctrl_list;
487 kfree (ctrl->pci_bus);
489 ctrl->hpc_ops->release_ctlr(ctrl);
497 /* Stop the notification mechanism */
498 pciehp_event_stop_thread();
502 int hpdriver_context = 0;
504 static void pciehp_remove (struct pcie_device *device)
506 printk("%s ENTRY\n", __FUNCTION__);
507 printk("%s -> Call free_irq for irq = %d\n",
508 __FUNCTION__, device->irq);
509 free_irq(device->irq, &hpdriver_context);
513 static int pciehp_suspend (struct pcie_device *dev, pm_message_t state)
515 printk("%s ENTRY\n", __FUNCTION__);
519 static int pciehp_resume (struct pcie_device *dev)
521 printk("%s ENTRY\n", __FUNCTION__);
526 static struct pcie_port_service_id port_pci_ids[] = { {
527 .vendor = PCI_ANY_ID,
528 .device = PCI_ANY_ID,
529 .port_type = PCIE_ANY_PORT,
530 .service_type = PCIE_PORT_SERVICE_HP,
532 }, { /* end: all zeroes */ }
534 static const char device_name[] = "hpdriver";
536 static struct pcie_port_service_driver hpdriver_portdrv = {
537 .name = (char *)device_name,
538 .id_table = &port_pci_ids[0],
540 .probe = pciehp_probe,
541 .remove = pciehp_remove,
544 .suspend = pciehp_suspend,
545 .resume = pciehp_resume,
549 static int __init pcied_init(void)
553 #ifdef CONFIG_HOTPLUG_PCI_PCIE_POLL_EVENT_MODE
554 pciehp_poll_mode = 1;
557 retval = pcie_start_thread();
561 retval = pcie_port_service_register(&hpdriver_portdrv);
562 dbg("pcie_port_service_register = %d\n", retval);
563 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
565 dbg("%s: Failure to register service\n", __FUNCTION__);
569 pciehp_event_stop_thread();
575 static void __exit pcied_cleanup(void)
577 dbg("unload_pciehpd()\n");
580 pcie_port_service_unregister(&hpdriver_portdrv);
582 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
585 module_init(pcied_init);
586 module_exit(pcied_cleanup);