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>, <dely.l.sy@intel.com>
30 #include <linux/config.h>
31 #include <linux/module.h>
32 #include <linux/moduleparam.h>
33 #include <linux/kernel.h>
34 #include <linux/types.h>
35 #include <linux/proc_fs.h>
36 #include <linux/miscdevice.h>
37 #include <linux/slab.h>
38 #include <linux/workqueue.h>
39 #include <linux/pci.h>
40 #include <linux/init.h>
41 #include <asm/uaccess.h>
45 /* Global variables */
49 struct controller
*pciehp_ctrl_list
;
50 struct pci_func
*pciehp_slot_list
[256];
52 #define DRIVER_VERSION "0.4"
53 #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
54 #define DRIVER_DESC "PCI Express Hot Plug Controller Driver"
56 MODULE_AUTHOR(DRIVER_AUTHOR
);
57 MODULE_DESCRIPTION(DRIVER_DESC
);
58 MODULE_LICENSE("GPL");
60 module_param(pciehp_debug
, bool, 0644);
61 module_param(pciehp_poll_mode
, bool, 0644);
62 module_param(pciehp_poll_time
, int, 0644);
63 MODULE_PARM_DESC(pciehp_debug
, "Debugging mode enabled or not");
64 MODULE_PARM_DESC(pciehp_poll_mode
, "Using polling mechanism for hot-plug events or not");
65 MODULE_PARM_DESC(pciehp_poll_time
, "Polling mechanism frequency, in seconds");
67 #define PCIE_MODULE_NAME "pciehp"
69 static int pcie_start_thread (void);
70 static int set_attention_status (struct hotplug_slot
*slot
, u8 value
);
71 static int enable_slot (struct hotplug_slot
*slot
);
72 static int disable_slot (struct hotplug_slot
*slot
);
73 static int get_power_status (struct hotplug_slot
*slot
, u8
*value
);
74 static int get_attention_status (struct hotplug_slot
*slot
, u8
*value
);
75 static int get_latch_status (struct hotplug_slot
*slot
, u8
*value
);
76 static int get_adapter_status (struct hotplug_slot
*slot
, u8
*value
);
77 static int get_max_bus_speed (struct hotplug_slot
*slot
, enum pci_bus_speed
*value
);
78 static int get_cur_bus_speed (struct hotplug_slot
*slot
, enum pci_bus_speed
*value
);
80 static struct hotplug_slot_ops pciehp_hotplug_slot_ops
= {
82 .set_attention_status
= set_attention_status
,
83 .enable_slot
= enable_slot
,
84 .disable_slot
= disable_slot
,
85 .get_power_status
= get_power_status
,
86 .get_attention_status
= get_attention_status
,
87 .get_latch_status
= get_latch_status
,
88 .get_adapter_status
= get_adapter_status
,
89 .get_max_bus_speed
= get_max_bus_speed
,
90 .get_cur_bus_speed
= get_cur_bus_speed
,
93 static int init_slots(struct controller
*ctrl
)
95 struct slot
*new_slot
;
101 dbg("%s\n",__FUNCTION__
);
103 number_of_slots
= ctrl
->num_slots
;
104 slot_device
= ctrl
->slot_device_offset
;
105 slot_number
= ctrl
->first_slot
;
107 while (number_of_slots
) {
108 new_slot
= kmalloc(sizeof(*new_slot
), GFP_KERNEL
);
112 memset(new_slot
, 0, sizeof(struct slot
));
113 new_slot
->hotplug_slot
=
114 kmalloc(sizeof(*(new_slot
->hotplug_slot
)),
116 if (!new_slot
->hotplug_slot
)
118 memset(new_slot
->hotplug_slot
, 0, sizeof(struct hotplug_slot
));
120 new_slot
->hotplug_slot
->info
=
121 kmalloc(sizeof(*(new_slot
->hotplug_slot
->info
)),
123 if (!new_slot
->hotplug_slot
->info
)
125 memset(new_slot
->hotplug_slot
->info
, 0,
126 sizeof(struct hotplug_slot_info
));
127 new_slot
->hotplug_slot
->name
= kmalloc(SLOT_NAME_SIZE
,
129 if (!new_slot
->hotplug_slot
->name
)
132 new_slot
->ctrl
= ctrl
;
133 new_slot
->bus
= ctrl
->slot_bus
;
134 new_slot
->device
= slot_device
;
135 new_slot
->hpc_ops
= ctrl
->hpc_ops
;
137 new_slot
->number
= ctrl
->first_slot
;
138 new_slot
->hp_slot
= slot_device
- ctrl
->slot_device_offset
;
140 /* register this slot with the hotplug pci core */
141 new_slot
->hotplug_slot
->private = new_slot
;
142 make_slot_name (new_slot
->hotplug_slot
->name
, SLOT_NAME_SIZE
, new_slot
);
143 new_slot
->hotplug_slot
->ops
= &pciehp_hotplug_slot_ops
;
145 new_slot
->hpc_ops
->get_power_status(new_slot
, &(new_slot
->hotplug_slot
->info
->power_status
));
146 new_slot
->hpc_ops
->get_attention_status(new_slot
, &(new_slot
->hotplug_slot
->info
->attention_status
));
147 new_slot
->hpc_ops
->get_latch_status(new_slot
, &(new_slot
->hotplug_slot
->info
->latch_status
));
148 new_slot
->hpc_ops
->get_adapter_status(new_slot
, &(new_slot
->hotplug_slot
->info
->adapter_status
));
150 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x slot_device_offset=%x\n",
151 new_slot
->bus
, new_slot
->device
, new_slot
->hp_slot
, new_slot
->number
, ctrl
->slot_device_offset
);
152 result
= pci_hp_register (new_slot
->hotplug_slot
);
154 err ("pci_hp_register failed with error %d\n", result
);
158 new_slot
->next
= ctrl
->slot
;
159 ctrl
->slot
= new_slot
;
163 slot_number
+= ctrl
->slot_num_inc
;
169 kfree(new_slot
->hotplug_slot
->name
);
171 kfree(new_slot
->hotplug_slot
->info
);
173 kfree(new_slot
->hotplug_slot
);
181 static int cleanup_slots (struct controller
* ctrl
)
183 struct slot
*old_slot
, *next_slot
;
185 old_slot
= ctrl
->slot
;
189 next_slot
= old_slot
->next
;
190 pci_hp_deregister (old_slot
->hotplug_slot
);
191 kfree(old_slot
->hotplug_slot
->info
);
192 kfree(old_slot
->hotplug_slot
->name
);
193 kfree(old_slot
->hotplug_slot
);
195 old_slot
= next_slot
;
202 static int get_ctlr_slot_config(struct controller
*ctrl
)
204 int num_ctlr_slots
; /* Not needed; PCI Express has 1 slot per port*/
205 int first_device_num
; /* Not needed */
206 int physical_slot_num
;
207 int updown
; /* Not needed */
209 int flags
; /* Not needed */
211 rc
= pcie_get_ctlr_slot_config(ctrl
, &num_ctlr_slots
, &first_device_num
, &physical_slot_num
, &updown
, &flags
);
213 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n", __FUNCTION__
, ctrl
->bus
, ctrl
->device
);
217 ctrl
->num_slots
= num_ctlr_slots
; /* PCI Express has 1 slot per port */
218 ctrl
->slot_device_offset
= first_device_num
;
219 ctrl
->first_slot
= physical_slot_num
;
220 ctrl
->slot_num_inc
= updown
; /* Not needed */ /* either -1 or 1 */
222 dbg("%s: bus(0x%x) num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d (%x:%x)\n",
223 __FUNCTION__
, ctrl
->slot_bus
, num_ctlr_slots
, first_device_num
, physical_slot_num
, updown
,
224 ctrl
->bus
, ctrl
->device
);
231 * set_attention_status - Turns the Amber LED for a slot on, off or blink
233 static int set_attention_status(struct hotplug_slot
*hotplug_slot
, u8 status
)
235 struct slot
*slot
= hotplug_slot
->private;
237 dbg("%s - physical_slot = %s\n", __FUNCTION__
, hotplug_slot
->name
);
239 hotplug_slot
->info
->attention_status
= status
;
240 slot
->hpc_ops
->set_attention_status(slot
, status
);
246 static int enable_slot(struct hotplug_slot
*hotplug_slot
)
248 struct slot
*slot
= hotplug_slot
->private;
250 dbg("%s - physical_slot = %s\n", __FUNCTION__
, hotplug_slot
->name
);
252 return pciehp_enable_slot(slot
);
256 static int disable_slot(struct hotplug_slot
*hotplug_slot
)
258 struct slot
*slot
= hotplug_slot
->private;
260 dbg("%s - physical_slot = %s\n", __FUNCTION__
, hotplug_slot
->name
);
262 return pciehp_disable_slot(slot
);
265 static int get_power_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
267 struct slot
*slot
= hotplug_slot
->private;
270 dbg("%s - physical_slot = %s\n", __FUNCTION__
, hotplug_slot
->name
);
272 retval
= slot
->hpc_ops
->get_power_status(slot
, value
);
274 *value
= hotplug_slot
->info
->power_status
;
279 static int get_attention_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
281 struct slot
*slot
= hotplug_slot
->private;
284 dbg("%s - physical_slot = %s\n", __FUNCTION__
, hotplug_slot
->name
);
286 retval
= slot
->hpc_ops
->get_attention_status(slot
, value
);
288 *value
= hotplug_slot
->info
->attention_status
;
293 static int get_latch_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
295 struct slot
*slot
= hotplug_slot
->private;
298 dbg("%s - physical_slot = %s\n", __FUNCTION__
, hotplug_slot
->name
);
300 retval
= slot
->hpc_ops
->get_latch_status(slot
, value
);
302 *value
= hotplug_slot
->info
->latch_status
;
307 static int get_adapter_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
309 struct slot
*slot
= hotplug_slot
->private;
312 dbg("%s - physical_slot = %s\n", __FUNCTION__
, hotplug_slot
->name
);
314 retval
= slot
->hpc_ops
->get_adapter_status(slot
, value
);
316 *value
= hotplug_slot
->info
->adapter_status
;
321 static int get_max_bus_speed(struct hotplug_slot
*hotplug_slot
, enum pci_bus_speed
*value
)
323 struct slot
*slot
= hotplug_slot
->private;
326 dbg("%s - physical_slot = %s\n", __FUNCTION__
, hotplug_slot
->name
);
328 retval
= slot
->hpc_ops
->get_max_bus_speed(slot
, value
);
330 *value
= PCI_SPEED_UNKNOWN
;
335 static int get_cur_bus_speed(struct hotplug_slot
*hotplug_slot
, enum pci_bus_speed
*value
)
337 struct slot
*slot
= hotplug_slot
->private;
340 dbg("%s - physical_slot = %s\n", __FUNCTION__
, hotplug_slot
->name
);
342 retval
= slot
->hpc_ops
->get_cur_bus_speed(slot
, value
);
344 *value
= PCI_SPEED_UNKNOWN
;
349 static int pcie_probe(struct pci_dev
*pdev
, const struct pci_device_id
*ent
)
352 struct controller
*ctrl
;
354 int first_device_num
= 0 ; /* first PCI device number supported by this PCIE */
355 int num_ctlr_slots
; /* number of slots supported by this HPC */
358 ctrl
= kmalloc(sizeof(*ctrl
), GFP_KERNEL
);
360 err("%s : out of memory\n", __FUNCTION__
);
363 memset(ctrl
, 0, sizeof(struct controller
));
365 dbg("%s: DRV_thread pid = %d\n", __FUNCTION__
, current
->pid
);
367 rc
= pcie_init(ctrl
, pdev
,
368 (php_intr_callback_t
) pciehp_handle_attention_button
,
369 (php_intr_callback_t
) pciehp_handle_switch_change
,
370 (php_intr_callback_t
) pciehp_handle_presence_change
,
371 (php_intr_callback_t
) pciehp_handle_power_fault
);
373 dbg("%s: controller initialization failed\n", PCIE_MODULE_NAME
);
374 goto err_out_free_ctrl
;
377 ctrl
->pci_dev
= pdev
;
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 dbg("%s: ctrl->pci_bus %p\n", __FUNCTION__
, ctrl
->pci_bus
);
388 memcpy (ctrl
->pci_bus
, pdev
->bus
, sizeof (*ctrl
->pci_bus
));
389 ctrl
->bus
= pdev
->bus
->number
; /* ctrl bus */
390 ctrl
->slot_bus
= pdev
->subordinate
->number
; /* bus controlled by this HPC */
392 ctrl
->device
= PCI_SLOT(pdev
->devfn
);
393 ctrl
->function
= PCI_FUNC(pdev
->devfn
);
394 dbg("%s: ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", __FUNCTION__
,
395 ctrl
->bus
, ctrl
->device
, ctrl
->function
, pdev
->irq
);
398 * Save configuration headers for this and subordinate PCI buses
401 rc
= get_ctlr_slot_config(ctrl
);
403 err(msg_initialization_err
, rc
);
404 goto err_out_free_ctrl_bus
;
406 first_device_num
= ctrl
->slot_device_offset
;
407 num_ctlr_slots
= ctrl
->num_slots
;
409 /* Store PCI Config Space for all devices on this bus */
410 dbg("%s: Before calling pciehp_save_config, ctrl->bus %x,ctrl->slot_bus %x\n",
411 __FUNCTION__
,ctrl
->bus
, ctrl
->slot_bus
);
412 rc
= pciehp_save_config(ctrl
, ctrl
->slot_bus
, num_ctlr_slots
, first_device_num
);
414 err("%s: unable to save PCI configuration data, error %d\n", __FUNCTION__
, rc
);
415 goto err_out_free_ctrl_bus
;
418 /* Get IO, memory, and IRQ resources for new devices */
419 rc
= pciehprm_find_available_resources(ctrl
);
420 ctrl
->add_support
= !rc
;
423 dbg("pciehprm_find_available_resources = %#x\n", rc
);
424 err("unable to locate PCI configuration resources for hot plug add.\n");
425 goto err_out_free_ctrl_bus
;
428 /* Setup the slot information structures */
429 rc
= init_slots(ctrl
);
431 err(msg_initialization_err
, 6);
432 goto err_out_free_ctrl_slot
;
435 t_slot
= pciehp_find_slot(ctrl
, first_device_num
);
436 dbg("%s: t_slot %p\n", __FUNCTION__
, t_slot
);
438 /* Finish setting up the hot plug ctrl device */
439 ctrl
->next_event
= 0;
441 if (!pciehp_ctrl_list
) {
442 pciehp_ctrl_list
= ctrl
;
445 ctrl
->next
= pciehp_ctrl_list
;
446 pciehp_ctrl_list
= ctrl
;
449 /* Wait for exclusive access to hardware */
450 down(&ctrl
->crit_sect
);
452 t_slot
->hpc_ops
->get_adapter_status(t_slot
, &value
); /* Check if slot is occupied */
453 dbg("%s: adpater value %x\n", __FUNCTION__
, value
);
455 rc
= t_slot
->hpc_ops
->power_off_slot(t_slot
); /* Power off slot if not occupied*/
457 /* Done with exclusive hardware access */
458 up(&ctrl
->crit_sect
);
459 goto err_out_free_ctrl_slot
;
461 /* Wait for the command to complete */
462 wait_for_ctrl_irq (ctrl
);
465 /* Done with exclusive hardware access */
466 up(&ctrl
->crit_sect
);
470 err_out_free_ctrl_slot
:
472 err_out_free_ctrl_bus
:
473 kfree(ctrl
->pci_bus
);
474 err_out_unmap_mmio_region
:
475 ctrl
->hpc_ops
->release_ctlr(ctrl
);
483 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");
496 dbg("Initialize slot lists\n");
497 /* One slot list for each bus in the system */
498 for (loop
= 0; loop
< 256; loop
++) {
499 pciehp_slot_list
[loop
] = NULL
;
505 static inline void __exit
506 free_pciehp_res(struct pci_resource
*res
)
508 struct pci_resource
*tres
;
517 static void __exit
unload_pciehpd(void)
519 struct pci_func
*next
;
520 struct pci_func
*TempSlot
;
522 struct controller
*ctrl
;
523 struct controller
*tctrl
;
525 ctrl
= pciehp_ctrl_list
;
530 free_pciehp_res(ctrl
->io_head
);
531 free_pciehp_res(ctrl
->mem_head
);
532 free_pciehp_res(ctrl
->p_mem_head
);
533 free_pciehp_res(ctrl
->bus_head
);
535 kfree (ctrl
->pci_bus
);
537 ctrl
->hpc_ops
->release_ctlr(ctrl
);
545 for (loop
= 0; loop
< 256; loop
++) {
546 next
= pciehp_slot_list
[loop
];
547 while (next
!= NULL
) {
548 free_pciehp_res(next
->io_head
);
549 free_pciehp_res(next
->mem_head
);
550 free_pciehp_res(next
->p_mem_head
);
551 free_pciehp_res(next
->bus_head
);
559 /* Stop the notification mechanism */
560 pciehp_event_stop_thread();
565 static struct pci_device_id pcied_pci_tbl
[] = {
567 .class = ((PCI_CLASS_BRIDGE_PCI
<< 8) | 0x00),
569 .vendor
= PCI_ANY_ID
,
570 .device
= PCI_ANY_ID
,
571 .subvendor
= PCI_ANY_ID
,
572 .subdevice
= PCI_ANY_ID
,
575 { /* end: all zeroes */ }
578 MODULE_DEVICE_TABLE(pci
, pcied_pci_tbl
);
582 static struct pci_driver pcie_driver
= {
583 .name
= PCIE_MODULE_NAME
,
584 .id_table
= pcied_pci_tbl
,
586 /* remove: pcie_remove_one, */
591 static int __init
pcied_init(void)
595 #ifdef CONFIG_HOTPLUG_PCI_PCIE_POLL_EVENT_MODE
596 pciehp_poll_mode
= 1;
599 retval
= pcie_start_thread();
603 retval
= pciehprm_init(PCI
);
605 retval
= pci_module_init(&pcie_driver
);
606 dbg("pci_module_init = %d\n", retval
);
607 info(DRIVER_DESC
" version: " DRIVER_VERSION
"\n");
613 pciehp_event_stop_thread();
615 pciehprm_print_pirt();
620 static void __exit
pcied_cleanup(void)
622 dbg("unload_pciehpd()\n");
627 dbg("pci_unregister_driver\n");
628 pci_unregister_driver(&pcie_driver
);
630 info(DRIVER_DESC
" version: " DRIVER_VERSION
" unloaded\n");
633 module_init(pcied_init
);
634 module_exit(pcied_cleanup
);