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)
106 struct slot *new_slot;
110 int result = -ENOMEM;
112 number_of_slots = ctrl->num_slots;
113 slot_device = ctrl->slot_device_offset;
114 slot_number = ctrl->first_slot;
116 while (number_of_slots) {
117 new_slot = kmalloc(sizeof(*new_slot), GFP_KERNEL);
121 memset(new_slot, 0, sizeof(struct slot));
122 new_slot->hotplug_slot =
123 kmalloc(sizeof(*(new_slot->hotplug_slot)),
125 if (!new_slot->hotplug_slot)
127 memset(new_slot->hotplug_slot, 0, sizeof(struct hotplug_slot));
129 new_slot->hotplug_slot->info =
130 kmalloc(sizeof(*(new_slot->hotplug_slot->info)),
132 if (!new_slot->hotplug_slot->info)
134 memset(new_slot->hotplug_slot->info, 0,
135 sizeof(struct hotplug_slot_info));
136 new_slot->hotplug_slot->name = kmalloc(SLOT_NAME_SIZE,
138 if (!new_slot->hotplug_slot->name)
141 new_slot->ctrl = ctrl;
142 new_slot->bus = ctrl->slot_bus;
143 new_slot->device = slot_device;
144 new_slot->hpc_ops = ctrl->hpc_ops;
146 new_slot->number = ctrl->first_slot;
147 new_slot->hp_slot = slot_device - ctrl->slot_device_offset;
149 /* register this slot with the hotplug pci core */
150 new_slot->hotplug_slot->private = new_slot;
151 new_slot->hotplug_slot->release = &release_slot;
152 make_slot_name(new_slot->hotplug_slot->name, SLOT_NAME_SIZE, new_slot);
153 new_slot->hotplug_slot->ops = &pciehp_hotplug_slot_ops;
155 new_slot->hpc_ops->get_power_status(new_slot, &(new_slot->hotplug_slot->info->power_status));
156 new_slot->hpc_ops->get_attention_status(new_slot, &(new_slot->hotplug_slot->info->attention_status));
157 new_slot->hpc_ops->get_latch_status(new_slot, &(new_slot->hotplug_slot->info->latch_status));
158 new_slot->hpc_ops->get_adapter_status(new_slot, &(new_slot->hotplug_slot->info->adapter_status));
160 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x slot_device_offset=%x\n",
161 new_slot->bus, new_slot->device, new_slot->hp_slot, new_slot->number, ctrl->slot_device_offset);
162 result = pci_hp_register (new_slot->hotplug_slot);
164 err ("pci_hp_register failed with error %d\n", result);
168 new_slot->next = ctrl->slot;
169 ctrl->slot = new_slot;
173 slot_number += ctrl->slot_num_inc;
179 kfree(new_slot->hotplug_slot->name);
181 kfree(new_slot->hotplug_slot->info);
183 kfree(new_slot->hotplug_slot);
191 static int cleanup_slots (struct controller * ctrl)
193 struct slot *old_slot, *next_slot;
195 old_slot = ctrl->slot;
199 next_slot = old_slot->next;
200 pci_hp_deregister (old_slot->hotplug_slot);
201 old_slot = next_slot;
208 static int get_ctlr_slot_config(struct controller *ctrl)
210 int num_ctlr_slots; /* Not needed; PCI Express has 1 slot per port*/
211 int first_device_num; /* Not needed */
212 int physical_slot_num;
216 rc = pcie_get_ctlr_slot_config(ctrl, &num_ctlr_slots, &first_device_num, &physical_slot_num, &ctrlcap);
218 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n", __FUNCTION__, ctrl->bus, ctrl->device);
222 ctrl->num_slots = num_ctlr_slots; /* PCI Express has 1 slot per port */
223 ctrl->slot_device_offset = first_device_num;
224 ctrl->first_slot = physical_slot_num;
225 ctrl->ctrlcap = ctrlcap;
227 dbg("%s: bus(0x%x) num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) ctrlcap(%x) for b:d (%x:%x)\n",
228 __FUNCTION__, ctrl->slot_bus, num_ctlr_slots, first_device_num, physical_slot_num, ctrlcap,
229 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 = hotplug_slot->private;
242 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
244 hotplug_slot->info->attention_status = status;
246 if (ATTN_LED(slot->ctrl->ctrlcap))
247 slot->hpc_ops->set_attention_status(slot, status);
253 static int enable_slot(struct hotplug_slot *hotplug_slot)
255 struct slot *slot = hotplug_slot->private;
257 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
259 return pciehp_enable_slot(slot);
263 static int disable_slot(struct hotplug_slot *hotplug_slot)
265 struct slot *slot = hotplug_slot->private;
267 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
269 return pciehp_disable_slot(slot);
272 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
274 struct slot *slot = hotplug_slot->private;
277 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
279 retval = slot->hpc_ops->get_power_status(slot, value);
281 *value = hotplug_slot->info->power_status;
286 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
288 struct slot *slot = hotplug_slot->private;
291 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
293 retval = slot->hpc_ops->get_attention_status(slot, value);
295 *value = hotplug_slot->info->attention_status;
300 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
302 struct slot *slot = hotplug_slot->private;
305 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
307 retval = slot->hpc_ops->get_latch_status(slot, value);
309 *value = hotplug_slot->info->latch_status;
314 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
316 struct slot *slot = hotplug_slot->private;
319 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
321 retval = slot->hpc_ops->get_adapter_status(slot, value);
323 *value = hotplug_slot->info->adapter_status;
328 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
330 struct slot *slot = hotplug_slot->private;
333 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
335 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
337 *value = PCI_SPEED_UNKNOWN;
342 static int get_cur_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
344 struct slot *slot = hotplug_slot->private;
347 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
349 retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
351 *value = PCI_SPEED_UNKNOWN;
356 static int pciehp_probe(struct pcie_device *dev, const struct pcie_port_service_id *id)
359 struct controller *ctrl;
361 int first_device_num = 0 ; /* first PCI device number supported by this PCIE */
362 int num_ctlr_slots; /* number of slots supported by this HPC */
364 struct pci_dev *pdev;
366 ctrl = kmalloc(sizeof(*ctrl), GFP_KERNEL);
368 err("%s : out of memory\n", __FUNCTION__);
371 memset(ctrl, 0, sizeof(struct controller));
374 ctrl->pci_dev = pdev;
376 rc = pcie_init(ctrl, dev);
378 dbg("%s: controller initialization failed\n", PCIE_MODULE_NAME);
379 goto err_out_free_ctrl;
382 pci_set_drvdata(pdev, ctrl);
384 ctrl->pci_bus = kmalloc(sizeof(*ctrl->pci_bus), GFP_KERNEL);
385 if (!ctrl->pci_bus) {
386 err("%s: out of memory\n", __FUNCTION__);
388 goto err_out_unmap_mmio_region;
390 memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
391 ctrl->bus = pdev->bus->number; /* ctrl bus */
392 ctrl->slot_bus = pdev->subordinate->number; /* bus controlled by this HPC */
394 ctrl->device = PCI_SLOT(pdev->devfn);
395 ctrl->function = PCI_FUNC(pdev->devfn);
396 dbg("%s: ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", __FUNCTION__,
397 ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
400 * Save configuration headers for this and subordinate PCI buses
403 rc = get_ctlr_slot_config(ctrl);
405 err(msg_initialization_err, rc);
406 goto err_out_free_ctrl_bus;
408 first_device_num = ctrl->slot_device_offset;
409 num_ctlr_slots = ctrl->num_slots;
411 /* Setup the slot information structures */
412 rc = init_slots(ctrl);
414 err(msg_initialization_err, 6);
415 goto err_out_free_ctrl_slot;
418 t_slot = pciehp_find_slot(ctrl, first_device_num);
420 /* Finish setting up the hot plug ctrl device */
421 ctrl->next_event = 0;
423 if (!pciehp_ctrl_list) {
424 pciehp_ctrl_list = ctrl;
427 ctrl->next = pciehp_ctrl_list;
428 pciehp_ctrl_list = ctrl;
431 /* Wait for exclusive access to hardware */
432 down(&ctrl->crit_sect);
434 t_slot->hpc_ops->get_adapter_status(t_slot, &value); /* Check if slot is occupied */
436 if ((POWER_CTRL(ctrl->ctrlcap)) && !value) {
437 rc = t_slot->hpc_ops->power_off_slot(t_slot); /* Power off slot if not occupied*/
439 /* Done with exclusive hardware access */
440 up(&ctrl->crit_sect);
441 goto err_out_free_ctrl_slot;
443 /* Wait for the command to complete */
444 wait_for_ctrl_irq (ctrl);
447 /* Done with exclusive hardware access */
448 up(&ctrl->crit_sect);
452 err_out_free_ctrl_slot:
454 err_out_free_ctrl_bus:
455 kfree(ctrl->pci_bus);
456 err_out_unmap_mmio_region:
457 ctrl->hpc_ops->release_ctlr(ctrl);
465 static int pcie_start_thread(void)
469 dbg("Initialize + Start the notification/polling mechanism \n");
471 retval = pciehp_event_start_thread();
473 dbg("pciehp_event_start_thread() failed\n");
480 static void __exit unload_pciehpd(void)
482 struct controller *ctrl;
483 struct controller *tctrl;
485 ctrl = pciehp_ctrl_list;
490 kfree (ctrl->pci_bus);
492 ctrl->hpc_ops->release_ctlr(ctrl);
500 /* Stop the notification mechanism */
501 pciehp_event_stop_thread();
505 int hpdriver_context = 0;
507 static void pciehp_remove (struct pcie_device *device)
509 printk("%s ENTRY\n", __FUNCTION__);
510 printk("%s -> Call free_irq for irq = %d\n",
511 __FUNCTION__, device->irq);
512 free_irq(device->irq, &hpdriver_context);
516 static int pciehp_suspend (struct pcie_device *dev, pm_message_t state)
518 printk("%s ENTRY\n", __FUNCTION__);
522 static int pciehp_resume (struct pcie_device *dev)
524 printk("%s ENTRY\n", __FUNCTION__);
529 static struct pcie_port_service_id port_pci_ids[] = { {
530 .vendor = PCI_ANY_ID,
531 .device = PCI_ANY_ID,
532 .port_type = PCIE_ANY_PORT,
533 .service_type = PCIE_PORT_SERVICE_HP,
535 }, { /* end: all zeroes */ }
537 static const char device_name[] = "hpdriver";
539 static struct pcie_port_service_driver hpdriver_portdrv = {
540 .name = (char *)device_name,
541 .id_table = &port_pci_ids[0],
543 .probe = pciehp_probe,
544 .remove = pciehp_remove,
547 .suspend = pciehp_suspend,
548 .resume = pciehp_resume,
552 static int __init pcied_init(void)
556 #ifdef CONFIG_HOTPLUG_PCI_PCIE_POLL_EVENT_MODE
557 pciehp_poll_mode = 1;
560 retval = pcie_start_thread();
564 retval = pcie_port_service_register(&hpdriver_portdrv);
565 dbg("pcie_port_service_register = %d\n", retval);
566 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
568 dbg("%s: Failure to register service\n", __FUNCTION__);
572 pciehp_event_stop_thread();
578 static void __exit pcied_cleanup(void)
580 dbg("unload_pciehpd()\n");
583 pcie_port_service_unregister(&hpdriver_portdrv);
585 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
588 module_init(pcied_init);
589 module_exit(pcied_cleanup);