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/delay.h>
35 #include <linux/pcieport_if.h>
36 #include "pci_hotplug.h"
38 #define MY_NAME "pciehp"
40 extern int pciehp_poll_mode;
41 extern int pciehp_poll_time;
42 extern int pciehp_debug;
43 extern int pciehp_force;
45 /*#define dbg(format, arg...) do { if (pciehp_debug) printk(KERN_DEBUG "%s: " format, MY_NAME , ## arg); } while (0)*/
46 #define dbg(format, arg...) do { if (pciehp_debug) printk("%s: " format, MY_NAME , ## arg); } while (0)
47 #define err(format, arg...) printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
48 #define info(format, arg...) printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
49 #define warn(format, arg...) printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
51 struct hotplug_params {
64 struct timer_list task_event;
66 struct controller *ctrl;
67 struct hpc_ops *hpc_ops;
68 struct hotplug_slot *hotplug_slot;
69 struct list_head slot_list;
77 typedef u8(*php_intr_callback_t) (u8 hp_slot, void *instance_id);
79 struct php_ctlr_state_s {
80 struct php_ctlr_state_s *pnext;
81 struct pci_dev *pci_dev;
83 unsigned long flags; /* spinlock's */
84 u32 slot_device_offset;
86 struct timer_list int_poll_timer; /* Added for poll event */
87 php_intr_callback_t attention_button_callback;
88 php_intr_callback_t switch_change_callback;
89 php_intr_callback_t presence_change_callback;
90 php_intr_callback_t power_fault_callback;
91 void *callback_instance_id;
92 struct ctrl_reg *creg; /* Ptr to controller register space */
97 struct controller *next;
98 struct semaphore crit_sect; /* critical section semaphore */
99 struct php_ctlr_state_s *hpc_ctlr_handle; /* HPC controller handle */
100 int num_slots; /* Number of slots on ctlr */
101 int slot_num_inc; /* 1 or -1 */
102 struct pci_dev *pci_dev;
103 struct pci_bus *pci_bus;
104 struct event_info event_queue[MAX_EVENTS];
106 struct hpc_ops *hpc_ops;
107 wait_queue_head_t queue; /* sleep & wake process */
112 u8 slot_device_offset;
113 u32 first_slot; /* First physical slot number */ /* PCIE only has 1 slot */
114 u8 slot_bus; /* Bus where the slots handled by this controller sit */
120 #define INT_BUTTON_IGNORE 0
121 #define INT_PRESENCE_ON 1
122 #define INT_PRESENCE_OFF 2
123 #define INT_SWITCH_CLOSE 3
124 #define INT_SWITCH_OPEN 4
125 #define INT_POWER_FAULT 5
126 #define INT_POWER_FAULT_CLEAR 6
127 #define INT_BUTTON_PRESS 7
128 #define INT_BUTTON_RELEASE 8
129 #define INT_BUTTON_CANCEL 9
131 #define STATIC_STATE 0
132 #define BLINKINGON_STATE 1
133 #define BLINKINGOFF_STATE 2
134 #define POWERON_STATE 3
135 #define POWEROFF_STATE 4
137 #define PCI_TO_PCI_BRIDGE_CLASS 0x00060400
140 #define INTERLOCK_OPEN 0x00000002
141 #define ADD_NOT_SUPPORTED 0x00000003
142 #define CARD_FUNCTIONING 0x00000005
143 #define ADAPTER_NOT_SAME 0x00000006
144 #define NO_ADAPTER_PRESENT 0x00000009
145 #define NOT_ENOUGH_RESOURCES 0x0000000B
146 #define DEVICE_TYPE_NOT_SUPPORTED 0x0000000C
147 #define WRONG_BUS_FREQUENCY 0x0000000D
148 #define POWER_FAILURE 0x0000000E
150 #define REMOVE_NOT_SUPPORTED 0x00000003
152 #define DISABLE_CARD 1
154 /* Field definitions in Slot Capabilities Register */
155 #define ATTN_BUTTN_PRSN 0x00000001
156 #define PWR_CTRL_PRSN 0x00000002
157 #define MRL_SENS_PRSN 0x00000004
158 #define ATTN_LED_PRSN 0x00000008
159 #define PWR_LED_PRSN 0x00000010
160 #define HP_SUPR_RM_SUP 0x00000020
162 #define ATTN_BUTTN(cap) (cap & ATTN_BUTTN_PRSN)
163 #define POWER_CTRL(cap) (cap & PWR_CTRL_PRSN)
164 #define MRL_SENS(cap) (cap & MRL_SENS_PRSN)
165 #define ATTN_LED(cap) (cap & ATTN_LED_PRSN)
166 #define PWR_LED(cap) (cap & PWR_LED_PRSN)
167 #define HP_SUPR_RM(cap) (cap & HP_SUPR_RM_SUP)
172 #define msg_initialization_err "Initialization failure, error=%d\n"
173 #define msg_button_on "PCI slot #%d - powering on due to button press.\n"
174 #define msg_button_off "PCI slot #%d - powering off due to button press.\n"
175 #define msg_button_cancel "PCI slot #%d - action canceled due to button press.\n"
176 #define msg_button_ignore "PCI slot #%d - button press ignored. (action in progress...)\n"
178 /* controller functions */
179 extern int pciehp_event_start_thread (void);
180 extern void pciehp_event_stop_thread (void);
181 extern int pciehp_enable_slot (struct slot *slot);
182 extern int pciehp_disable_slot (struct slot *slot);
184 extern u8 pciehp_handle_attention_button (u8 hp_slot, void *inst_id);
185 extern u8 pciehp_handle_switch_change (u8 hp_slot, void *inst_id);
186 extern u8 pciehp_handle_presence_change (u8 hp_slot, void *inst_id);
187 extern u8 pciehp_handle_power_fault (u8 hp_slot, void *inst_id);
188 /* extern void long_delay (int delay); */
191 extern int pciehp_configure_device (struct slot *p_slot);
192 extern int pciehp_unconfigure_device (struct slot *p_slot);
193 extern int pciehp_get_hp_hw_control_from_firmware(struct pci_dev *dev);
194 extern void pciehp_get_hp_params_from_firmware(struct pci_dev *dev,
195 struct hotplug_params *hpp);
199 /* Global variables */
200 extern struct controller *pciehp_ctrl_list;
202 /* Inline functions */
204 static inline struct slot *pciehp_find_slot(struct controller *ctrl, u8 device)
206 struct slot *p_slot, *tmp_slot = NULL;
210 while (p_slot && (p_slot->device != device)) {
212 p_slot = p_slot->next;
214 if (p_slot == NULL) {
215 err("ERROR: pciehp_find_slot device=0x%x\n", device);
222 static inline int wait_for_ctrl_irq(struct controller *ctrl)
226 DECLARE_WAITQUEUE(wait, current);
228 add_wait_queue(&ctrl->queue, &wait);
229 if (!pciehp_poll_mode)
230 /* Sleep for up to 1 second */
231 msleep_interruptible(1000);
233 msleep_interruptible(2500);
235 remove_wait_queue(&ctrl->queue, &wait);
236 if (signal_pending(current))
242 #define SLOT_NAME_SIZE 10
244 static inline void make_slot_name(char *buffer, int buffer_size, struct slot *slot)
246 snprintf(buffer, buffer_size, "%04d_%04d", slot->bus, slot->number);
255 int pcie_init(struct controller *ctrl, struct pcie_device *dev);
257 /* This has no meaning for PCI Express, as there is only 1 slot per port */
258 int pcie_get_ctlr_slot_config(struct controller *ctrl,
260 int *first_device_num,
261 int *physical_slot_num,
265 int (*power_on_slot) (struct slot *slot);
266 int (*power_off_slot) (struct slot *slot);
267 int (*get_power_status) (struct slot *slot, u8 *status);
268 int (*get_attention_status) (struct slot *slot, u8 *status);
269 int (*set_attention_status) (struct slot *slot, u8 status);
270 int (*get_latch_status) (struct slot *slot, u8 *status);
271 int (*get_adapter_status) (struct slot *slot, u8 *status);
273 int (*get_max_bus_speed) (struct slot *slot, enum pci_bus_speed *speed);
274 int (*get_cur_bus_speed) (struct slot *slot, enum pci_bus_speed *speed);
276 int (*get_max_lnk_width) (struct slot *slot, enum pcie_link_width *value);
277 int (*get_cur_lnk_width) (struct slot *slot, enum pcie_link_width *value);
279 int (*query_power_fault) (struct slot *slot);
280 void (*green_led_on) (struct slot *slot);
281 void (*green_led_off) (struct slot *slot);
282 void (*green_led_blink) (struct slot *slot);
283 void (*release_ctlr) (struct controller *ctrl);
284 int (*check_lnk_status) (struct controller *ctrl);
287 #endif /* _PCIEHP_H */