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>, <dely.l.sy@intel.com>
32 #include <linux/types.h>
33 #include <linux/pci.h>
34 #include <asm/semaphore.h>
36 #include "pci_hotplug.h"
38 #if !defined(CONFIG_HOTPLUG_PCI_PCIE_MODULE)
39 #define MY_NAME "pciehp"
41 #define MY_NAME THIS_MODULE->name
44 extern int pciehp_poll_mode;
45 extern int pciehp_poll_time;
46 extern int pciehp_debug;
48 /*#define dbg(format, arg...) do { if (pciehp_debug) printk(KERN_DEBUG "%s: " format, MY_NAME , ## arg); } while (0)*/
49 #define dbg(format, arg...) do { if (pciehp_debug) printk("%s: " format, MY_NAME , ## arg); } while (0)
50 #define err(format, arg...) printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
51 #define info(format, arg...) printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
52 #define warn(format, arg...) printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
55 struct pci_func *next;
64 u32 base_length[0x06];
67 u32 config_space[0x20];
68 struct pci_resource *mem_head;
69 struct pci_resource *p_mem_head;
70 struct pci_resource *io_head;
71 struct pci_resource *bus_head;
72 struct pci_dev* pci_dev;
75 #define SLOT_MAGIC 0x67267321
89 struct timer_list task_event;
91 struct controller *ctrl;
92 struct hpc_ops *hpc_ops;
93 struct hotplug_slot *hotplug_slot;
94 struct list_head slot_list;
98 struct pci_resource * next;
109 struct controller *next;
110 struct semaphore crit_sect; /* critical section semaphore */
111 void * hpc_ctlr_handle; /* HPC controller handle */
112 int num_slots; /* Number of slots on ctlr */
113 int slot_num_inc; /* 1 or -1 */
114 struct pci_resource *mem_head;
115 struct pci_resource *p_mem_head;
116 struct pci_resource *io_head;
117 struct pci_resource *bus_head;
118 struct pci_dev *pci_dev;
119 struct pci_bus *pci_bus;
120 struct event_info event_queue[10];
122 struct hpc_ops *hpc_ops;
123 wait_queue_head_t queue; /* sleep & wake process */
130 u8 slot_device_offset;
132 enum pci_bus_speed speed;
133 u32 first_slot; /* First physical slot number */ /* PCIE only has 1 slot */
134 u8 slot_bus; /* Bus where the slots handled by this controller sit */
146 struct resource_lists {
147 struct pci_resource *mem_head;
148 struct pci_resource *p_mem_head;
149 struct pci_resource *io_head;
150 struct pci_resource *bus_head;
151 struct irq_mapping *irqs;
154 #define INT_BUTTON_IGNORE 0
155 #define INT_PRESENCE_ON 1
156 #define INT_PRESENCE_OFF 2
157 #define INT_SWITCH_CLOSE 3
158 #define INT_SWITCH_OPEN 4
159 #define INT_POWER_FAULT 5
160 #define INT_POWER_FAULT_CLEAR 6
161 #define INT_BUTTON_PRESS 7
162 #define INT_BUTTON_RELEASE 8
163 #define INT_BUTTON_CANCEL 9
165 #define STATIC_STATE 0
166 #define BLINKINGON_STATE 1
167 #define BLINKINGOFF_STATE 2
168 #define POWERON_STATE 3
169 #define POWEROFF_STATE 4
171 #define PCI_TO_PCI_BRIDGE_CLASS 0x00060400
174 #define INTERLOCK_OPEN 0x00000002
175 #define ADD_NOT_SUPPORTED 0x00000003
176 #define CARD_FUNCTIONING 0x00000005
177 #define ADAPTER_NOT_SAME 0x00000006
178 #define NO_ADAPTER_PRESENT 0x00000009
179 #define NOT_ENOUGH_RESOURCES 0x0000000B
180 #define DEVICE_TYPE_NOT_SUPPORTED 0x0000000C
181 #define WRONG_BUS_FREQUENCY 0x0000000D
182 #define POWER_FAILURE 0x0000000E
184 #define REMOVE_NOT_SUPPORTED 0x00000003
186 #define DISABLE_CARD 1
191 #define msg_initialization_err "Initialization failure, error=%d\n"
192 #define msg_HPC_rev_error "Unsupported revision of the PCI hot plug controller found.\n"
193 #define msg_HPC_non_pcie "The PCI hot plug controller is not supported by this driver.\n"
194 #define msg_HPC_not_supported "This system is not supported by this version of pciephd mdoule. Upgrade to a newer version of pciehpd\n"
195 #define msg_unable_to_save "Unable to store PCI hot plug add resource information. This system must be rebooted before adding any PCI devices.\n"
196 #define msg_button_on "PCI slot #%d - powering on due to button press.\n"
197 #define msg_button_off "PCI slot #%d - powering off due to button press.\n"
198 #define msg_button_cancel "PCI slot #%d - action canceled due to button press.\n"
199 #define msg_button_ignore "PCI slot #%d - button press ignored. (action in progress...)\n"
201 /* sysfs function for the hotplug controller info */
202 extern void pciehp_create_ctrl_files (struct controller *ctrl);
204 /* controller functions */
205 extern void pciehp_pushbutton_thread (unsigned long event_pointer);
206 extern int pciehprm_find_available_resources (struct controller *ctrl);
207 extern int pciehp_event_start_thread (void);
208 extern void pciehp_event_stop_thread (void);
209 extern struct pci_func *pciehp_slot_create (unsigned char busnumber);
210 extern struct pci_func *pciehp_slot_find (unsigned char bus, unsigned char device, unsigned char index);
211 extern int pciehp_enable_slot (struct slot *slot);
212 extern int pciehp_disable_slot (struct slot *slot);
214 extern u8 pciehp_handle_attention_button (u8 hp_slot, void *inst_id);
215 extern u8 pciehp_handle_switch_change (u8 hp_slot, void *inst_id);
216 extern u8 pciehp_handle_presence_change (u8 hp_slot, void *inst_id);
217 extern u8 pciehp_handle_power_fault (u8 hp_slot, void *inst_id);
218 /* extern void long_delay (int delay); */
220 /* resource functions */
221 extern int pciehp_resource_sort_and_combine (struct pci_resource **head);
224 extern int pciehp_set_irq (u8 bus_num, u8 dev_num, u8 int_pin, u8 irq_num);
225 /*extern int pciehp_get_bus_dev (struct controller *ctrl, u8 *bus_num, u8 *dev_num, struct slot *slot);*/
226 extern int pciehp_save_config (struct controller *ctrl, int busnumber, int num_ctlr_slots, int first_device_num);
227 extern int pciehp_save_used_resources (struct controller *ctrl, struct pci_func * func, int flag);
228 extern int pciehp_save_slot_config (struct controller *ctrl, struct pci_func * new_slot);
229 extern void pciehp_destroy_board_resources (struct pci_func * func);
230 extern int pciehp_return_board_resources (struct pci_func * func, struct resource_lists * resources);
231 extern void pciehp_destroy_resource_list (struct resource_lists * resources);
232 extern int pciehp_configure_device (struct controller* ctrl, struct pci_func* func);
233 extern int pciehp_unconfigure_device (struct pci_func* func);
236 /* Global variables */
237 extern struct controller *pciehp_ctrl_list;
238 extern struct pci_func *pciehp_slot_list[256];
240 /* Inline functions */
243 /* Inline functions to check the sanity of a pointer that is passed to us */
244 static inline int slot_paranoia_check (struct slot *slot, const char *function)
247 dbg("%s - slot == NULL", function);
250 if (slot->magic != SLOT_MAGIC) {
251 dbg("%s - bad magic number for slot", function);
254 if (!slot->hotplug_slot) {
255 dbg("%s - slot->hotplug_slot == NULL!", function);
261 static inline struct slot *get_slot (struct hotplug_slot *hotplug_slot, const char *function)
266 dbg("%s - hotplug_slot == NULL\n", function);
270 slot = (struct slot *)hotplug_slot->private;
271 if (slot_paranoia_check (slot, function))
276 static inline struct slot *pciehp_find_slot (struct controller *ctrl, u8 device)
278 struct slot *p_slot, *tmp_slot = NULL;
285 dbg("p_slot = %p\n", p_slot);
287 while (p_slot && (p_slot->device != device)) {
289 p_slot = p_slot->next;
290 dbg("In while loop, p_slot = %p\n", p_slot);
292 if (p_slot == NULL) {
293 err("ERROR: pciehp_find_slot device=0x%x\n", device);
300 static inline int wait_for_ctrl_irq (struct controller *ctrl)
304 DECLARE_WAITQUEUE(wait, current);
306 dbg("%s : start\n", __FUNCTION__);
307 add_wait_queue(&ctrl->queue, &wait);
308 set_current_state(TASK_INTERRUPTIBLE);
309 if (!pciehp_poll_mode) {
310 /* Sleep for up to 1 second */
311 schedule_timeout(1*HZ);
313 schedule_timeout(2.5*HZ);
315 set_current_state(TASK_RUNNING);
316 remove_wait_queue(&ctrl->queue, &wait);
317 if (signal_pending(current))
320 dbg("%s : end\n", __FUNCTION__);
324 /* Puts node back in the resource list pointed to by head */
325 static inline void return_resource(struct pci_resource **head, struct pci_resource *node)
333 #define SLOT_NAME_SIZE 10
335 static inline void make_slot_name(char *buffer, int buffer_size, struct slot *slot)
337 snprintf(buffer, buffer_size, "%d", slot->number);
346 typedef u8(*php_intr_callback_t) (unsigned int change_id, void *instance_id);
348 int pcie_init( struct controller *ctrl, struct pci_dev *pdev,
349 php_intr_callback_t attention_button_callback,
350 php_intr_callback_t switch_change_callback,
351 php_intr_callback_t presence_change_callback,
352 php_intr_callback_t power_fault_callback);
355 /* This has no meaning for PCI Express, as there is only 1 slot per port */
356 int pcie_get_ctlr_slot_config( struct controller *ctrl,
358 int *first_device_num,
359 int *physical_slot_num,
364 int (*power_on_slot ) (struct slot *slot);
365 int (*power_off_slot ) (struct slot *slot);
366 int (*get_power_status) (struct slot *slot, u8 *status);
367 int (*get_attention_status) (struct slot *slot, u8 *status);
368 int (*set_attention_status) (struct slot *slot, u8 status);
369 int (*get_latch_status) (struct slot *slot, u8 *status);
370 int (*get_adapter_status) (struct slot *slot, u8 *status);
372 int (*get_max_bus_speed) (struct slot *slot, enum pci_bus_speed *speed);
373 int (*get_cur_bus_speed) (struct slot *slot, enum pci_bus_speed *speed);
375 int (*get_max_lnk_width) (struct slot *slot, enum pcie_link_width *value);
376 int (*get_cur_lnk_width) (struct slot *slot, enum pcie_link_width *value);
378 int (*query_power_fault) (struct slot *slot);
379 void (*green_led_on) (struct slot *slot);
380 void (*green_led_off) (struct slot *slot);
381 void (*green_led_blink) (struct slot *slot);
382 void (*release_ctlr) (struct controller *ctrl);
383 int (*check_lnk_status) (struct controller *ctrl);
386 #endif /* _PCIEHP_H */