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>
37 #include <linux/time.h>
39 /* Global variables */
44 struct workqueue_struct
*pciehp_wq
;
46 #define DRIVER_VERSION "0.4"
47 #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
48 #define DRIVER_DESC "PCI Express Hot Plug Controller Driver"
50 MODULE_AUTHOR(DRIVER_AUTHOR
);
51 MODULE_DESCRIPTION(DRIVER_DESC
);
52 MODULE_LICENSE("GPL");
54 module_param(pciehp_debug
, bool, 0644);
55 module_param(pciehp_poll_mode
, bool, 0644);
56 module_param(pciehp_poll_time
, int, 0644);
57 module_param(pciehp_force
, bool, 0644);
58 MODULE_PARM_DESC(pciehp_debug
, "Debugging mode enabled or not");
59 MODULE_PARM_DESC(pciehp_poll_mode
, "Using polling mechanism for hot-plug events or not");
60 MODULE_PARM_DESC(pciehp_poll_time
, "Polling mechanism frequency, in seconds");
61 MODULE_PARM_DESC(pciehp_force
, "Force pciehp, even if _OSC and OSHP are missing");
63 #define PCIE_MODULE_NAME "pciehp"
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 * Check the status of the Electro Mechanical Interlock (EMI)
91 static int get_lock_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
93 struct slot
*slot
= hotplug_slot
->private;
94 return (slot
->hpc_ops
->get_emi_status(slot
, value
));
98 * sysfs interface for the Electro Mechanical Interlock (EMI)
99 * 1 == locked, 0 == unlocked
101 static ssize_t
lock_read_file(struct hotplug_slot
*slot
, char *buf
)
106 retval
= get_lock_status(slot
, &value
);
109 retval
= sprintf (buf
, "%d\n", value
);
116 * Change the status of the Electro Mechanical Interlock (EMI)
117 * This is a toggle - in addition there must be at least 1 second
118 * in between toggles.
120 static int set_lock_status(struct hotplug_slot
*hotplug_slot
, u8 status
)
122 struct slot
*slot
= hotplug_slot
->private;
126 mutex_lock(&slot
->ctrl
->crit_sect
);
128 /* has it been >1 sec since our last toggle? */
129 if ((get_seconds() - slot
->last_emi_toggle
) < 1)
132 /* see what our current state is */
133 retval
= get_lock_status(hotplug_slot
, &value
);
134 if (retval
|| (value
== status
))
137 slot
->hpc_ops
->toggle_emi(slot
);
139 mutex_unlock(&slot
->ctrl
->crit_sect
);
144 * sysfs interface which allows the user to toggle the Electro Mechanical
145 * Interlock. Valid values are either 0 or 1. 0 == unlock, 1 == lock
147 static ssize_t
lock_write_file(struct hotplug_slot
*hotplug_slot
,
148 const char *buf
, size_t count
)
150 struct slot
*slot
= hotplug_slot
->private;
155 llock
= simple_strtoul(buf
, NULL
, 10);
156 lock
= (u8
)(llock
& 0xff);
161 retval
= set_lock_status(hotplug_slot
, lock
);
164 ctrl_err(slot
->ctrl
, "%d is an invalid lock value\n",
173 static struct hotplug_slot_attribute hotplug_slot_attr_lock
= {
174 .attr
= {.name
= "lock", .mode
= S_IFREG
| S_IRUGO
| S_IWUSR
},
175 .show
= lock_read_file
,
176 .store
= lock_write_file
180 * release_slot - free up the memory used by a slot
181 * @hotplug_slot: slot to free
183 static void release_slot(struct hotplug_slot
*hotplug_slot
)
185 struct slot
*slot
= hotplug_slot
->private;
187 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
188 __func__
, hotplug_slot_name(hotplug_slot
));
190 kfree(hotplug_slot
->info
);
194 static int init_slots(struct controller
*ctrl
)
197 struct hotplug_slot
*hotplug_slot
;
198 struct hotplug_slot_info
*info
;
199 char name
[SLOT_NAME_SIZE
];
200 int retval
= -ENOMEM
;
202 list_for_each_entry(slot
, &ctrl
->slot_list
, slot_list
) {
203 hotplug_slot
= kzalloc(sizeof(*hotplug_slot
), GFP_KERNEL
);
207 info
= kzalloc(sizeof(*info
), GFP_KERNEL
);
211 /* register this slot with the hotplug pci core */
212 hotplug_slot
->info
= info
;
213 hotplug_slot
->private = slot
;
214 hotplug_slot
->release
= &release_slot
;
215 hotplug_slot
->ops
= &pciehp_hotplug_slot_ops
;
216 slot
->hotplug_slot
= hotplug_slot
;
217 snprintf(name
, SLOT_NAME_SIZE
, "%u", slot
->number
);
219 ctrl_dbg(ctrl
, "Registering domain:bus:dev=%04x:%02x:%02x "
220 "hp_slot=%x sun=%x slot_device_offset=%x\n",
221 pci_domain_nr(ctrl
->pci_dev
->subordinate
),
222 slot
->bus
, slot
->device
, slot
->hp_slot
, slot
->number
,
223 ctrl
->slot_device_offset
);
224 retval
= pci_hp_register(hotplug_slot
,
225 ctrl
->pci_dev
->subordinate
,
229 ctrl_err(ctrl
, "pci_hp_register failed with error %d\n",
233 get_power_status(hotplug_slot
, &info
->power_status
);
234 get_attention_status(hotplug_slot
, &info
->attention_status
);
235 get_latch_status(hotplug_slot
, &info
->latch_status
);
236 get_adapter_status(hotplug_slot
, &info
->adapter_status
);
237 /* create additional sysfs entries */
239 retval
= sysfs_create_file(&hotplug_slot
->pci_slot
->kobj
,
240 &hotplug_slot_attr_lock
.attr
);
242 pci_hp_deregister(hotplug_slot
);
243 ctrl_err(ctrl
, "Cannot create additional sysfs "
259 static void cleanup_slots(struct controller
*ctrl
)
263 list_for_each_entry(slot
, &ctrl
->slot_list
, slot_list
) {
265 sysfs_remove_file(&slot
->hotplug_slot
->pci_slot
->kobj
,
266 &hotplug_slot_attr_lock
.attr
);
267 pci_hp_deregister(slot
->hotplug_slot
);
272 * set_attention_status - Turns the Amber LED for a slot on, off or blink
274 static int set_attention_status(struct hotplug_slot
*hotplug_slot
, u8 status
)
276 struct slot
*slot
= hotplug_slot
->private;
278 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
279 __func__
, slot_name(slot
));
281 hotplug_slot
->info
->attention_status
= status
;
283 if (ATTN_LED(slot
->ctrl
))
284 slot
->hpc_ops
->set_attention_status(slot
, status
);
290 static int enable_slot(struct hotplug_slot
*hotplug_slot
)
292 struct slot
*slot
= hotplug_slot
->private;
294 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
295 __func__
, slot_name(slot
));
297 return pciehp_sysfs_enable_slot(slot
);
301 static int disable_slot(struct hotplug_slot
*hotplug_slot
)
303 struct slot
*slot
= hotplug_slot
->private;
305 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
306 __func__
, slot_name(slot
));
308 return pciehp_sysfs_disable_slot(slot
);
311 static int get_power_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
313 struct slot
*slot
= hotplug_slot
->private;
316 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
317 __func__
, slot_name(slot
));
319 retval
= slot
->hpc_ops
->get_power_status(slot
, value
);
321 *value
= hotplug_slot
->info
->power_status
;
326 static int get_attention_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
328 struct slot
*slot
= hotplug_slot
->private;
331 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
332 __func__
, slot_name(slot
));
334 retval
= slot
->hpc_ops
->get_attention_status(slot
, value
);
336 *value
= hotplug_slot
->info
->attention_status
;
341 static int get_latch_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
343 struct slot
*slot
= hotplug_slot
->private;
346 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
347 __func__
, slot_name(slot
));
349 retval
= slot
->hpc_ops
->get_latch_status(slot
, value
);
351 *value
= hotplug_slot
->info
->latch_status
;
356 static int get_adapter_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
358 struct slot
*slot
= hotplug_slot
->private;
361 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
362 __func__
, slot_name(slot
));
364 retval
= slot
->hpc_ops
->get_adapter_status(slot
, value
);
366 *value
= hotplug_slot
->info
->adapter_status
;
371 static int get_max_bus_speed(struct hotplug_slot
*hotplug_slot
,
372 enum pci_bus_speed
*value
)
374 struct slot
*slot
= hotplug_slot
->private;
377 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
378 __func__
, slot_name(slot
));
380 retval
= slot
->hpc_ops
->get_max_bus_speed(slot
, value
);
382 *value
= PCI_SPEED_UNKNOWN
;
387 static int get_cur_bus_speed(struct hotplug_slot
*hotplug_slot
, enum pci_bus_speed
*value
)
389 struct slot
*slot
= hotplug_slot
->private;
392 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
393 __func__
, slot_name(slot
));
395 retval
= slot
->hpc_ops
->get_cur_bus_speed(slot
, value
);
397 *value
= PCI_SPEED_UNKNOWN
;
402 static int pciehp_probe(struct pcie_device
*dev
, const struct pcie_port_service_id
*id
)
405 struct controller
*ctrl
;
408 struct pci_dev
*pdev
= dev
->port
;
411 dev_info(&dev
->device
,
412 "Bypassing BIOS check for pciehp use on %s\n",
414 else if (pciehp_get_hp_hw_control_from_firmware(pdev
))
417 ctrl
= pcie_init(dev
);
419 dev_err(&dev
->device
, "Controller initialization failed\n");
422 set_service_data(dev
, ctrl
);
424 /* Setup the slot information structures */
425 rc
= init_slots(ctrl
);
428 ctrl_warn(ctrl
, "Slot already registered by another "
431 ctrl_err(ctrl
, "Slot initialization failed\n");
432 goto err_out_release_ctlr
;
435 /* Check if slot is occupied */
436 t_slot
= pciehp_find_slot(ctrl
, ctrl
->slot_device_offset
);
437 t_slot
->hpc_ops
->get_adapter_status(t_slot
, &value
);
440 pciehp_enable_slot(t_slot
);
442 /* Power off slot if not occupied */
443 if (POWER_CTRL(ctrl
)) {
444 rc
= t_slot
->hpc_ops
->power_off_slot(t_slot
);
446 goto err_out_free_ctrl_slot
;
452 err_out_free_ctrl_slot
:
454 err_out_release_ctlr
:
455 ctrl
->hpc_ops
->release_ctlr(ctrl
);
460 static void pciehp_remove (struct pcie_device
*dev
)
462 struct controller
*ctrl
= get_service_data(dev
);
465 ctrl
->hpc_ops
->release_ctlr(ctrl
);
469 static int pciehp_suspend (struct pcie_device
*dev
, pm_message_t state
)
471 dev_info(&dev
->device
, "%s ENTRY\n", __func__
);
475 static int pciehp_resume (struct pcie_device
*dev
)
477 dev_info(&dev
->device
, "%s ENTRY\n", __func__
);
479 struct controller
*ctrl
= get_service_data(dev
);
483 /* reinitialize the chipset's event detection logic */
484 pcie_enable_notification(ctrl
);
486 t_slot
= pciehp_find_slot(ctrl
, ctrl
->slot_device_offset
);
488 /* Check if slot is occupied */
489 t_slot
->hpc_ops
->get_adapter_status(t_slot
, &status
);
491 pciehp_enable_slot(t_slot
);
493 pciehp_disable_slot(t_slot
);
499 static struct pcie_port_service_id port_pci_ids
[] = { {
500 .vendor
= PCI_ANY_ID
,
501 .device
= PCI_ANY_ID
,
502 .port_type
= PCIE_ANY_PORT
,
503 .service_type
= PCIE_PORT_SERVICE_HP
,
505 }, { /* end: all zeroes */ }
508 static struct pcie_port_service_driver hpdriver_portdrv
= {
509 .name
= PCIE_MODULE_NAME
,
510 .id_table
= &port_pci_ids
[0],
512 .probe
= pciehp_probe
,
513 .remove
= pciehp_remove
,
516 .suspend
= pciehp_suspend
,
517 .resume
= pciehp_resume
,
521 static int __init
pcied_init(void)
525 retval
= pcie_port_service_register(&hpdriver_portdrv
);
526 dbg("pcie_port_service_register = %d\n", retval
);
527 info(DRIVER_DESC
" version: " DRIVER_VERSION
"\n");
529 dbg("Failure to register service\n");
533 static void __exit
pcied_cleanup(void)
535 dbg("unload_pciehpd()\n");
536 pcie_port_service_unregister(&hpdriver_portdrv
);
537 info(DRIVER_DESC
" version: " DRIVER_VERSION
" unloaded\n");
540 module_init(pcied_init
);
541 module_exit(pcied_cleanup
);