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
*slot
, const char *buf
,
154 llock
= simple_strtoul(buf
, NULL
, 10);
155 lock
= (u8
)(llock
& 0xff);
160 retval
= set_lock_status(slot
, lock
);
163 err ("%d is an invalid lock value\n", lock
);
171 static struct hotplug_slot_attribute hotplug_slot_attr_lock
= {
172 .attr
= {.name
= "lock", .mode
= S_IFREG
| S_IRUGO
| S_IWUSR
},
173 .show
= lock_read_file
,
174 .store
= lock_write_file
178 * release_slot - free up the memory used by a slot
179 * @hotplug_slot: slot to free
181 static void release_slot(struct hotplug_slot
*hotplug_slot
)
183 dbg("%s - physical_slot = %s\n", __func__
, hotplug_slot
->name
);
185 kfree(hotplug_slot
->info
);
189 static int init_slots(struct controller
*ctrl
)
192 struct hotplug_slot
*hotplug_slot
;
193 struct hotplug_slot_info
*info
;
195 int retval
= -ENOMEM
;
197 list_for_each_entry(slot
, &ctrl
->slot_list
, slot_list
) {
198 hotplug_slot
= kzalloc(sizeof(*hotplug_slot
), GFP_KERNEL
);
202 info
= kzalloc(sizeof(*info
), GFP_KERNEL
);
206 /* register this slot with the hotplug pci core */
207 hotplug_slot
->info
= info
;
208 hotplug_slot
->name
= slot
->name
;
209 hotplug_slot
->private = slot
;
210 hotplug_slot
->release
= &release_slot
;
211 hotplug_slot
->ops
= &pciehp_hotplug_slot_ops
;
212 get_power_status(hotplug_slot
, &info
->power_status
);
213 get_attention_status(hotplug_slot
, &info
->attention_status
);
214 get_latch_status(hotplug_slot
, &info
->latch_status
);
215 get_adapter_status(hotplug_slot
, &info
->adapter_status
);
216 slot
->hotplug_slot
= hotplug_slot
;
218 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
219 "slot_device_offset=%x\n", slot
->bus
, slot
->device
,
220 slot
->hp_slot
, slot
->number
, ctrl
->slot_device_offset
);
222 retval
= pci_hp_register(hotplug_slot
,
223 ctrl
->pci_dev
->subordinate
,
227 * If slot N already exists, we'll try to create
228 * slot N-1, N-2 ... N-M, until we overflow.
230 if (retval
== -EEXIST
) {
231 len
= snprintf(slot
->name
, SLOT_NAME_SIZE
,
232 "%d-%d", slot
->number
, dup
++);
233 if (len
< SLOT_NAME_SIZE
)
236 err("duplicate slot name overflow\n");
238 err("pci_hp_register failed with error %d\n", retval
);
241 /* create additional sysfs entries */
243 retval
= sysfs_create_file(&hotplug_slot
->pci_slot
->kobj
,
244 &hotplug_slot_attr_lock
.attr
);
246 pci_hp_deregister(hotplug_slot
);
247 err("cannot create additional sysfs entries\n");
262 static void cleanup_slots(struct controller
*ctrl
)
266 list_for_each_entry(slot
, &ctrl
->slot_list
, slot_list
) {
268 sysfs_remove_file(&slot
->hotplug_slot
->pci_slot
->kobj
,
269 &hotplug_slot_attr_lock
.attr
);
270 pci_hp_deregister(slot
->hotplug_slot
);
275 * set_attention_status - Turns the Amber LED for a slot on, off or blink
277 static int set_attention_status(struct hotplug_slot
*hotplug_slot
, u8 status
)
279 struct slot
*slot
= hotplug_slot
->private;
281 dbg("%s - physical_slot = %s\n", __func__
, hotplug_slot
->name
);
283 hotplug_slot
->info
->attention_status
= status
;
285 if (ATTN_LED(slot
->ctrl
))
286 slot
->hpc_ops
->set_attention_status(slot
, status
);
292 static int enable_slot(struct hotplug_slot
*hotplug_slot
)
294 struct slot
*slot
= hotplug_slot
->private;
296 dbg("%s - physical_slot = %s\n", __func__
, hotplug_slot
->name
);
298 return pciehp_sysfs_enable_slot(slot
);
302 static int disable_slot(struct hotplug_slot
*hotplug_slot
)
304 struct slot
*slot
= hotplug_slot
->private;
306 dbg("%s - physical_slot = %s\n", __func__
, hotplug_slot
->name
);
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 dbg("%s - physical_slot = %s\n", __func__
, hotplug_slot
->name
);
318 retval
= slot
->hpc_ops
->get_power_status(slot
, value
);
320 *value
= hotplug_slot
->info
->power_status
;
325 static int get_attention_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
327 struct slot
*slot
= hotplug_slot
->private;
330 dbg("%s - physical_slot = %s\n", __func__
, hotplug_slot
->name
);
332 retval
= slot
->hpc_ops
->get_attention_status(slot
, value
);
334 *value
= hotplug_slot
->info
->attention_status
;
339 static int get_latch_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
341 struct slot
*slot
= hotplug_slot
->private;
344 dbg("%s - physical_slot = %s\n", __func__
, hotplug_slot
->name
);
346 retval
= slot
->hpc_ops
->get_latch_status(slot
, value
);
348 *value
= hotplug_slot
->info
->latch_status
;
353 static int get_adapter_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
355 struct slot
*slot
= hotplug_slot
->private;
358 dbg("%s - physical_slot = %s\n", __func__
, hotplug_slot
->name
);
360 retval
= slot
->hpc_ops
->get_adapter_status(slot
, value
);
362 *value
= hotplug_slot
->info
->adapter_status
;
367 static int get_max_bus_speed(struct hotplug_slot
*hotplug_slot
,
368 enum pci_bus_speed
*value
)
370 struct slot
*slot
= hotplug_slot
->private;
373 dbg("%s - physical_slot = %s\n", __func__
, hotplug_slot
->name
);
375 retval
= slot
->hpc_ops
->get_max_bus_speed(slot
, value
);
377 *value
= PCI_SPEED_UNKNOWN
;
382 static int get_cur_bus_speed(struct hotplug_slot
*hotplug_slot
, enum pci_bus_speed
*value
)
384 struct slot
*slot
= hotplug_slot
->private;
387 dbg("%s - physical_slot = %s\n", __func__
, hotplug_slot
->name
);
389 retval
= slot
->hpc_ops
->get_cur_bus_speed(slot
, value
);
391 *value
= PCI_SPEED_UNKNOWN
;
396 static int pciehp_probe(struct pcie_device
*dev
, const struct pcie_port_service_id
*id
)
399 struct controller
*ctrl
;
402 struct pci_dev
*pdev
= dev
->port
;
405 dbg("Bypassing BIOS check for pciehp use on %s\n",
407 else if (pciehp_get_hp_hw_control_from_firmware(pdev
))
410 ctrl
= pcie_init(dev
);
412 dbg("%s: controller initialization failed\n", PCIE_MODULE_NAME
);
415 set_service_data(dev
, ctrl
);
417 /* Setup the slot information structures */
418 rc
= init_slots(ctrl
);
421 warn("%s: slot already registered by another "
422 "hotplug driver\n", PCIE_MODULE_NAME
);
424 err("%s: slot initialization failed\n",
426 goto err_out_release_ctlr
;
429 t_slot
= pciehp_find_slot(ctrl
, ctrl
->slot_device_offset
);
431 t_slot
->hpc_ops
->get_adapter_status(t_slot
, &value
); /* Check if slot is occupied */
432 if (value
&& pciehp_force
) {
433 rc
= pciehp_enable_slot(t_slot
);
434 if (rc
) /* -ENODEV: shouldn't happen, but deal with it */
437 if ((POWER_CTRL(ctrl
)) && !value
) {
438 rc
= t_slot
->hpc_ops
->power_off_slot(t_slot
); /* Power off slot if not occupied*/
440 goto err_out_free_ctrl_slot
;
445 err_out_free_ctrl_slot
:
447 err_out_release_ctlr
:
448 ctrl
->hpc_ops
->release_ctlr(ctrl
);
453 static void pciehp_remove (struct pcie_device
*dev
)
455 struct controller
*ctrl
= get_service_data(dev
);
458 ctrl
->hpc_ops
->release_ctlr(ctrl
);
462 static int pciehp_suspend (struct pcie_device
*dev
, pm_message_t state
)
464 printk("%s ENTRY\n", __func__
);
468 static int pciehp_resume (struct pcie_device
*dev
)
470 printk("%s ENTRY\n", __func__
);
472 struct controller
*ctrl
= get_service_data(dev
);
476 /* reinitialize the chipset's event detection logic */
477 pcie_enable_notification(ctrl
);
479 t_slot
= pciehp_find_slot(ctrl
, ctrl
->slot_device_offset
);
481 /* Check if slot is occupied */
482 t_slot
->hpc_ops
->get_adapter_status(t_slot
, &status
);
484 pciehp_enable_slot(t_slot
);
486 pciehp_disable_slot(t_slot
);
492 static struct pcie_port_service_id port_pci_ids
[] = { {
493 .vendor
= PCI_ANY_ID
,
494 .device
= PCI_ANY_ID
,
495 .port_type
= PCIE_ANY_PORT
,
496 .service_type
= PCIE_PORT_SERVICE_HP
,
498 }, { /* end: all zeroes */ }
500 static const char device_name
[] = "hpdriver";
502 static struct pcie_port_service_driver hpdriver_portdrv
= {
503 .name
= (char *)device_name
,
504 .id_table
= &port_pci_ids
[0],
506 .probe
= pciehp_probe
,
507 .remove
= pciehp_remove
,
510 .suspend
= pciehp_suspend
,
511 .resume
= pciehp_resume
,
515 static int __init
pcied_init(void)
519 retval
= pcie_port_service_register(&hpdriver_portdrv
);
520 dbg("pcie_port_service_register = %d\n", retval
);
521 info(DRIVER_DESC
" version: " DRIVER_VERSION
"\n");
523 dbg("%s: Failure to register service\n", __func__
);
527 static void __exit
pcied_cleanup(void)
529 dbg("unload_pciehpd()\n");
530 pcie_port_service_unregister(&hpdriver_portdrv
);
531 info(DRIVER_DESC
" version: " DRIVER_VERSION
" unloaded\n");
534 module_init(pcied_init
);
535 module_exit(pcied_cleanup
);