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>
32 #include <linux/types.h>
33 #include <linux/pci.h>
34 #include <linux/pci_hotplug.h>
35 #include <linux/delay.h>
36 #include <linux/sched.h> /* signal_pending() */
37 #include <linux/pcieport_if.h>
38 #include <linux/mutex.h>
40 #define MY_NAME "pciehp"
42 extern int pciehp_poll_mode;
43 extern int pciehp_poll_time;
44 extern int pciehp_debug;
45 extern int pciehp_force;
47 /*#define dbg(format, arg...) do { if (pciehp_debug) printk(KERN_DEBUG "%s: " format, MY_NAME , ## arg); } while (0)*/
48 #define dbg(format, arg...) do { if (pciehp_debug) printk("%s: " format, MY_NAME , ## arg); } while (0)
49 #define err(format, arg...) printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
50 #define info(format, arg...) printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
51 #define warn(format, arg...) printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
53 #define SLOT_NAME_SIZE 10
60 struct timer_list task_event;
62 struct controller *ctrl;
63 struct hpc_ops *hpc_ops;
64 struct hotplug_slot *hotplug_slot;
65 struct list_head slot_list;
66 char name[SLOT_NAME_SIZE];
74 typedef u8(*php_intr_callback_t) (u8 hp_slot, void *instance_id);
76 struct php_ctlr_state_s {
77 struct php_ctlr_state_s *pnext;
78 struct pci_dev *pci_dev;
80 unsigned long flags; /* spinlock's */
81 u32 slot_device_offset;
83 struct timer_list int_poll_timer; /* Added for poll event */
84 php_intr_callback_t attention_button_callback;
85 php_intr_callback_t switch_change_callback;
86 php_intr_callback_t presence_change_callback;
87 php_intr_callback_t power_fault_callback;
88 void *callback_instance_id;
89 struct ctrl_reg *creg; /* Ptr to controller register space */
94 struct controller *next;
95 struct mutex crit_sect; /* critical section mutex */
96 struct mutex ctrl_lock; /* controller lock */
97 struct php_ctlr_state_s *hpc_ctlr_handle; /* HPC controller handle */
98 int num_slots; /* Number of slots on ctlr */
99 int slot_num_inc; /* 1 or -1 */
100 struct pci_dev *pci_dev;
101 struct pci_bus *pci_bus;
102 struct event_info event_queue[MAX_EVENTS];
104 struct hpc_ops *hpc_ops;
105 wait_queue_head_t queue; /* sleep & wake process */
110 u8 slot_device_offset;
111 u32 first_slot; /* First physical slot number */ /* PCIE only has 1 slot */
112 u8 slot_bus; /* Bus where the slots handled by this controller sit */
118 #define INT_BUTTON_IGNORE 0
119 #define INT_PRESENCE_ON 1
120 #define INT_PRESENCE_OFF 2
121 #define INT_SWITCH_CLOSE 3
122 #define INT_SWITCH_OPEN 4
123 #define INT_POWER_FAULT 5
124 #define INT_POWER_FAULT_CLEAR 6
125 #define INT_BUTTON_PRESS 7
126 #define INT_BUTTON_RELEASE 8
127 #define INT_BUTTON_CANCEL 9
129 #define STATIC_STATE 0
130 #define BLINKINGON_STATE 1
131 #define BLINKINGOFF_STATE 2
132 #define POWERON_STATE 3
133 #define POWEROFF_STATE 4
135 #define PCI_TO_PCI_BRIDGE_CLASS 0x00060400
138 #define INTERLOCK_OPEN 0x00000002
139 #define ADD_NOT_SUPPORTED 0x00000003
140 #define CARD_FUNCTIONING 0x00000005
141 #define ADAPTER_NOT_SAME 0x00000006
142 #define NO_ADAPTER_PRESENT 0x00000009
143 #define NOT_ENOUGH_RESOURCES 0x0000000B
144 #define DEVICE_TYPE_NOT_SUPPORTED 0x0000000C
145 #define WRONG_BUS_FREQUENCY 0x0000000D
146 #define POWER_FAILURE 0x0000000E
148 #define REMOVE_NOT_SUPPORTED 0x00000003
150 #define DISABLE_CARD 1
152 /* Field definitions in Slot Capabilities Register */
153 #define ATTN_BUTTN_PRSN 0x00000001
154 #define PWR_CTRL_PRSN 0x00000002
155 #define MRL_SENS_PRSN 0x00000004
156 #define ATTN_LED_PRSN 0x00000008
157 #define PWR_LED_PRSN 0x00000010
158 #define HP_SUPR_RM_SUP 0x00000020
160 #define ATTN_BUTTN(cap) (cap & ATTN_BUTTN_PRSN)
161 #define POWER_CTRL(cap) (cap & PWR_CTRL_PRSN)
162 #define MRL_SENS(cap) (cap & MRL_SENS_PRSN)
163 #define ATTN_LED(cap) (cap & ATTN_LED_PRSN)
164 #define PWR_LED(cap) (cap & PWR_LED_PRSN)
165 #define HP_SUPR_RM(cap) (cap & HP_SUPR_RM_SUP)
170 #define msg_initialization_err "Initialization failure, error=%d\n"
171 #define msg_button_on "PCI slot #%s - powering on due to button press.\n"
172 #define msg_button_off "PCI slot #%s - powering off due to button press.\n"
173 #define msg_button_cancel "PCI slot #%s - action canceled due to button press.\n"
174 #define msg_button_ignore "PCI slot #%s - button press ignored. (action in progress...)\n"
176 /* controller functions */
177 extern int pciehp_event_start_thread (void);
178 extern void pciehp_event_stop_thread (void);
179 extern int pciehp_enable_slot (struct slot *slot);
180 extern int pciehp_disable_slot (struct slot *slot);
182 extern u8 pciehp_handle_attention_button (u8 hp_slot, void *inst_id);
183 extern u8 pciehp_handle_switch_change (u8 hp_slot, void *inst_id);
184 extern u8 pciehp_handle_presence_change (u8 hp_slot, void *inst_id);
185 extern u8 pciehp_handle_power_fault (u8 hp_slot, void *inst_id);
186 /* extern void long_delay (int delay); */
189 extern int pciehp_configure_device (struct slot *p_slot);
190 extern int pciehp_unconfigure_device (struct slot *p_slot);
194 /* Global variables */
195 extern struct controller *pciehp_ctrl_list;
197 /* Inline functions */
199 static inline struct slot *pciehp_find_slot(struct controller *ctrl, u8 device)
201 struct slot *p_slot, *tmp_slot = NULL;
205 while (p_slot && (p_slot->device != device)) {
207 p_slot = p_slot->next;
209 if (p_slot == NULL) {
210 err("ERROR: pciehp_find_slot device=0x%x\n", device);
217 static inline int wait_for_ctrl_irq(struct controller *ctrl)
221 DECLARE_WAITQUEUE(wait, current);
223 add_wait_queue(&ctrl->queue, &wait);
224 if (!pciehp_poll_mode)
225 /* Sleep for up to 1 second */
226 msleep_interruptible(1000);
228 msleep_interruptible(2500);
230 remove_wait_queue(&ctrl->queue, &wait);
231 if (signal_pending(current))
243 int pcie_init(struct controller *ctrl, struct pcie_device *dev);
245 /* This has no meaning for PCI Express, as there is only 1 slot per port */
246 int pcie_get_ctlr_slot_config(struct controller *ctrl,
248 int *first_device_num,
249 int *physical_slot_num,
253 int (*power_on_slot) (struct slot *slot);
254 int (*power_off_slot) (struct slot *slot);
255 int (*get_power_status) (struct slot *slot, u8 *status);
256 int (*get_attention_status) (struct slot *slot, u8 *status);
257 int (*set_attention_status) (struct slot *slot, u8 status);
258 int (*get_latch_status) (struct slot *slot, u8 *status);
259 int (*get_adapter_status) (struct slot *slot, u8 *status);
261 int (*get_max_bus_speed) (struct slot *slot, enum pci_bus_speed *speed);
262 int (*get_cur_bus_speed) (struct slot *slot, enum pci_bus_speed *speed);
264 int (*get_max_lnk_width) (struct slot *slot, enum pcie_link_width *value);
265 int (*get_cur_lnk_width) (struct slot *slot, enum pcie_link_width *value);
267 int (*query_power_fault) (struct slot *slot);
268 void (*green_led_on) (struct slot *slot);
269 void (*green_led_off) (struct slot *slot);
270 void (*green_led_blink) (struct slot *slot);
271 void (*release_ctlr) (struct controller *ctrl);
272 int (*check_lnk_status) (struct controller *ctrl);
277 #include <acpi/acpi.h>
278 #include <acpi/acpi_bus.h>
279 #include <acpi/actypes.h>
280 #include <linux/pci-acpi.h>
282 #define pciehp_get_hp_hw_control_from_firmware(dev) \
283 pciehp_acpi_get_hp_hw_control_from_firmware(dev)
284 static inline int pciehp_get_hp_params_from_firmware(struct pci_dev *dev,
285 struct hotplug_params *hpp)
287 if (ACPI_FAILURE(acpi_get_hp_params_from_firmware(dev->bus, hpp)))
292 #define pciehp_get_hp_hw_control_from_firmware(dev) 0
293 #define pciehp_get_hp_params_from_firmware(dev, hpp) (-ENODEV)
294 #endif /* CONFIG_ACPI */
295 #endif /* _PCIEHP_H */