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) {
130 mutex_unlock(&slot
->ctrl
->crit_sect
);
134 /* see what our current state is */
135 retval
= get_lock_status(hotplug_slot
, &value
);
136 if (retval
|| (value
== status
))
139 slot
->hpc_ops
->toggle_emi(slot
);
141 mutex_unlock(&slot
->ctrl
->crit_sect
);
146 * sysfs interface which allows the user to toggle the Electro Mechanical
147 * Interlock. Valid values are either 0 or 1. 0 == unlock, 1 == lock
149 static ssize_t
lock_write_file(struct hotplug_slot
*hotplug_slot
,
150 const char *buf
, size_t count
)
152 struct slot
*slot
= hotplug_slot
->private;
157 llock
= simple_strtoul(buf
, NULL
, 10);
158 lock
= (u8
)(llock
& 0xff);
163 retval
= set_lock_status(hotplug_slot
, lock
);
166 ctrl_err(slot
->ctrl
, "%d is an invalid lock value\n",
175 static struct hotplug_slot_attribute hotplug_slot_attr_lock
= {
176 .attr
= {.name
= "lock", .mode
= S_IFREG
| S_IRUGO
| S_IWUSR
},
177 .show
= lock_read_file
,
178 .store
= lock_write_file
182 * release_slot - free up the memory used by a slot
183 * @hotplug_slot: slot to free
185 static void release_slot(struct hotplug_slot
*hotplug_slot
)
187 struct slot
*slot
= hotplug_slot
->private;
189 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
190 __func__
, hotplug_slot_name(hotplug_slot
));
192 kfree(hotplug_slot
->info
);
196 static int init_slots(struct controller
*ctrl
)
199 struct hotplug_slot
*hotplug_slot
;
200 struct hotplug_slot_info
*info
;
201 char name
[SLOT_NAME_SIZE
];
202 int retval
= -ENOMEM
;
204 list_for_each_entry(slot
, &ctrl
->slot_list
, slot_list
) {
205 hotplug_slot
= kzalloc(sizeof(*hotplug_slot
), GFP_KERNEL
);
209 info
= kzalloc(sizeof(*info
), GFP_KERNEL
);
213 /* register this slot with the hotplug pci core */
214 hotplug_slot
->info
= info
;
215 hotplug_slot
->private = slot
;
216 hotplug_slot
->release
= &release_slot
;
217 hotplug_slot
->ops
= &pciehp_hotplug_slot_ops
;
218 slot
->hotplug_slot
= hotplug_slot
;
219 snprintf(name
, SLOT_NAME_SIZE
, "%u", slot
->number
);
221 ctrl_dbg(ctrl
, "Registering domain:bus:dev=%04x:%02x:%02x "
222 "hp_slot=%x sun=%x slot_device_offset=%x\n",
223 pci_domain_nr(ctrl
->pci_dev
->subordinate
),
224 slot
->bus
, slot
->device
, slot
->hp_slot
, slot
->number
,
225 ctrl
->slot_device_offset
);
226 retval
= pci_hp_register(hotplug_slot
,
227 ctrl
->pci_dev
->subordinate
,
231 ctrl_err(ctrl
, "pci_hp_register failed with error %d\n",
235 get_power_status(hotplug_slot
, &info
->power_status
);
236 get_attention_status(hotplug_slot
, &info
->attention_status
);
237 get_latch_status(hotplug_slot
, &info
->latch_status
);
238 get_adapter_status(hotplug_slot
, &info
->adapter_status
);
239 /* create additional sysfs entries */
241 retval
= sysfs_create_file(&hotplug_slot
->pci_slot
->kobj
,
242 &hotplug_slot_attr_lock
.attr
);
244 pci_hp_deregister(hotplug_slot
);
245 ctrl_err(ctrl
, "Cannot create additional sysfs "
261 static void cleanup_slots(struct controller
*ctrl
)
265 list_for_each_entry(slot
, &ctrl
->slot_list
, slot_list
) {
267 sysfs_remove_file(&slot
->hotplug_slot
->pci_slot
->kobj
,
268 &hotplug_slot_attr_lock
.attr
);
269 pci_hp_deregister(slot
->hotplug_slot
);
274 * set_attention_status - Turns the Amber LED for a slot on, off or blink
276 static int set_attention_status(struct hotplug_slot
*hotplug_slot
, u8 status
)
278 struct slot
*slot
= hotplug_slot
->private;
280 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
281 __func__
, slot_name(slot
));
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 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
297 __func__
, slot_name(slot
));
299 return pciehp_sysfs_enable_slot(slot
);
303 static int disable_slot(struct hotplug_slot
*hotplug_slot
)
305 struct slot
*slot
= hotplug_slot
->private;
307 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
308 __func__
, slot_name(slot
));
310 return pciehp_sysfs_disable_slot(slot
);
313 static int get_power_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
315 struct slot
*slot
= hotplug_slot
->private;
318 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
319 __func__
, slot_name(slot
));
321 retval
= slot
->hpc_ops
->get_power_status(slot
, value
);
323 *value
= hotplug_slot
->info
->power_status
;
328 static int get_attention_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
330 struct slot
*slot
= hotplug_slot
->private;
333 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
334 __func__
, slot_name(slot
));
336 retval
= slot
->hpc_ops
->get_attention_status(slot
, value
);
338 *value
= hotplug_slot
->info
->attention_status
;
343 static int get_latch_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
345 struct slot
*slot
= hotplug_slot
->private;
348 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
349 __func__
, slot_name(slot
));
351 retval
= slot
->hpc_ops
->get_latch_status(slot
, value
);
353 *value
= hotplug_slot
->info
->latch_status
;
358 static int get_adapter_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
360 struct slot
*slot
= hotplug_slot
->private;
363 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
364 __func__
, slot_name(slot
));
366 retval
= slot
->hpc_ops
->get_adapter_status(slot
, value
);
368 *value
= hotplug_slot
->info
->adapter_status
;
373 static int get_max_bus_speed(struct hotplug_slot
*hotplug_slot
,
374 enum pci_bus_speed
*value
)
376 struct slot
*slot
= hotplug_slot
->private;
379 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
380 __func__
, slot_name(slot
));
382 retval
= slot
->hpc_ops
->get_max_bus_speed(slot
, value
);
384 *value
= PCI_SPEED_UNKNOWN
;
389 static int get_cur_bus_speed(struct hotplug_slot
*hotplug_slot
, enum pci_bus_speed
*value
)
391 struct slot
*slot
= hotplug_slot
->private;
394 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
395 __func__
, slot_name(slot
));
397 retval
= slot
->hpc_ops
->get_cur_bus_speed(slot
, value
);
399 *value
= PCI_SPEED_UNKNOWN
;
404 static int pciehp_probe(struct pcie_device
*dev
, const struct pcie_port_service_id
*id
)
407 struct controller
*ctrl
;
410 struct pci_dev
*pdev
= dev
->port
;
413 dev_info(&dev
->device
,
414 "Bypassing BIOS check for pciehp use on %s\n",
416 else if (pciehp_get_hp_hw_control_from_firmware(pdev
))
419 ctrl
= pcie_init(dev
);
421 dev_err(&dev
->device
, "Controller initialization failed\n");
424 set_service_data(dev
, ctrl
);
426 /* Setup the slot information structures */
427 rc
= init_slots(ctrl
);
430 ctrl_warn(ctrl
, "Slot already registered by another "
433 ctrl_err(ctrl
, "Slot initialization failed\n");
434 goto err_out_release_ctlr
;
437 /* Check if slot is occupied */
438 t_slot
= pciehp_find_slot(ctrl
, ctrl
->slot_device_offset
);
439 t_slot
->hpc_ops
->get_adapter_status(t_slot
, &value
);
442 pciehp_enable_slot(t_slot
);
444 /* Power off slot if not occupied */
445 if (POWER_CTRL(ctrl
)) {
446 rc
= t_slot
->hpc_ops
->power_off_slot(t_slot
);
448 goto err_out_free_ctrl_slot
;
454 err_out_free_ctrl_slot
:
456 err_out_release_ctlr
:
457 ctrl
->hpc_ops
->release_ctlr(ctrl
);
462 static void pciehp_remove (struct pcie_device
*dev
)
464 struct controller
*ctrl
= get_service_data(dev
);
467 ctrl
->hpc_ops
->release_ctlr(ctrl
);
471 static int pciehp_suspend (struct pcie_device
*dev
, pm_message_t state
)
473 dev_info(&dev
->device
, "%s ENTRY\n", __func__
);
477 static int pciehp_resume (struct pcie_device
*dev
)
479 dev_info(&dev
->device
, "%s ENTRY\n", __func__
);
481 struct controller
*ctrl
= get_service_data(dev
);
485 /* reinitialize the chipset's event detection logic */
486 pcie_enable_notification(ctrl
);
488 t_slot
= pciehp_find_slot(ctrl
, ctrl
->slot_device_offset
);
490 /* Check if slot is occupied */
491 t_slot
->hpc_ops
->get_adapter_status(t_slot
, &status
);
493 pciehp_enable_slot(t_slot
);
495 pciehp_disable_slot(t_slot
);
501 static struct pcie_port_service_id port_pci_ids
[] = { {
502 .vendor
= PCI_ANY_ID
,
503 .device
= PCI_ANY_ID
,
504 .port_type
= PCIE_ANY_PORT
,
505 .service_type
= PCIE_PORT_SERVICE_HP
,
507 }, { /* end: all zeroes */ }
510 static struct pcie_port_service_driver hpdriver_portdrv
= {
511 .name
= PCIE_MODULE_NAME
,
512 .id_table
= &port_pci_ids
[0],
514 .probe
= pciehp_probe
,
515 .remove
= pciehp_remove
,
518 .suspend
= pciehp_suspend
,
519 .resume
= pciehp_resume
,
523 static int __init
pcied_init(void)
527 pciehp_firmware_init();
528 retval
= pcie_port_service_register(&hpdriver_portdrv
);
529 dbg("pcie_port_service_register = %d\n", retval
);
530 info(DRIVER_DESC
" version: " DRIVER_VERSION
"\n");
532 dbg("Failure to register service\n");
536 static void __exit
pcied_cleanup(void)
538 dbg("unload_pciehpd()\n");
539 pcie_port_service_unregister(&hpdriver_portdrv
);
540 info(DRIVER_DESC
" version: " DRIVER_VERSION
" unloaded\n");
543 module_init(pcied_init
);
544 module_exit(pcied_cleanup
);