1 /*
2 * PCI Express Hot Plug Controller Driver
3 *
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
8 *
9 * All rights reserved.
10 *
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.
15 *
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
20 * details.
21 *
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.
25 *
26 * Send feedback to <greg@kroah.com>, <dely.l.sy@intel.com>
27 *
28 */
29 #ifndef _PCIEHP_H
30 #define _PCIEHP_H
31
32 #include <linux/types.h>
33 #include <linux/pci.h>
34 #include <asm/semaphore.h>
35 #include <asm/io.h>
36 #include "pci_hotplug.h"
37
38 #if !defined(CONFIG_HOTPLUG_PCI_PCIE_MODULE)
39 #define MY_NAME "pciehp.o"
40 #else
41 #define MY_NAME THIS_MODULE->name
42 #endif
43
44 extern int pciehp_poll_mode;
45 extern int pciehp_poll_time;
46 extern int pciehp_debug;
47
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)
53
54 struct pci_func {
55 struct pci_func *next;
56 u8 bus;
57 u8 device;
58 u8 function;
59 u8 is_a_board;
60 u16 status;
61 u8 configured;
62 u8 switch_save;
63 u8 presence_save;
64 u32 base_length[0x06];
65 u8 base_type[0x06];
66 u16 reserved2;
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;
73 };
74
75 #define SLOT_MAGIC 0x67267321
76 struct slot {
77 u32 magic;
78 struct slot *next;
79 u8 bus;
80 u8 device;
81 u32 number;
82 u8 is_a_board;
83 u8 configured;
84 u8 state;
85 u8 switch_save;
86 u8 presence_save;
87 u32 capabilities;
88 u16 reserved2;
89 struct timer_list task_event;
90 u8 hp_slot;
91 struct controller *ctrl;
92 struct hpc_ops *hpc_ops;
93 struct hotplug_slot *hotplug_slot;
94 struct list_head slot_list;
95 };
96
97 struct pci_resource {
98 struct pci_resource * next;
99 u32 base;
100 u32 length;
101 };
102
103 struct event_info {
104 u32 event_type;
105 u8 hp_slot;
106 };
107
108 struct controller {
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];
121 struct slot *slot;
122 struct hpc_ops *hpc_ops;
123 wait_queue_head_t queue; /* sleep & wake process */
124 u8 next_event;
125 u8 seg;
126 u8 bus;
127 u8 device;
128 u8 function;
129 u8 rev;
130 u8 slot_device_offset;
131 u8 add_support;
132 enum pci_bus_speed speed;
133 u32 first_slot; /* First physical slot number; PCI-E only has 1 slot */
134 u8 slot_bus; /* Bus where the slots handled by this controller sit */
135 u8 push_flag;
136 u16 ctlrcap;
137 u16 vendor_id;
138 };
139
140 struct irq_mapping {
141 u8 barber_pole;
142 u8 valid_INT;
143 u8 interrupt[4];
144 };
145
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;
152 };
153
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
164
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
170
171 #define PCI_TO_PCI_BRIDGE_CLASS 0x00060400
172
173 /* Error messages */
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
183
184 #define REMOVE_NOT_SUPPORTED 0x00000003
185
186 #define DISABLE_CARD 1
187
188 /*
189 * error Messages
190 */
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"
200
201 /* controller functions */
202 extern void pciehp_pushbutton_thread (unsigned long event_pointer);
203 extern int pciehprm_find_available_resources (struct controller *ctrl);
204 extern int pciehp_event_start_thread (void);
205 extern void pciehp_event_stop_thread (void);
206 extern struct pci_func *pciehp_slot_create (unsigned char busnumber);
207 extern struct pci_func *pciehp_slot_find (unsigned char bus, unsigned char device, unsigned char index);
208 extern int pciehp_enable_slot (struct slot *slot);
209 extern int pciehp_disable_slot (struct slot *slot);
210
211 extern u8 pciehp_handle_attention_button (u8 hp_slot, void *inst_id);
212 extern u8 pciehp_handle_switch_change (u8 hp_slot, void *inst_id);
213 extern u8 pciehp_handle_presence_change (u8 hp_slot, void *inst_id);
214 extern u8 pciehp_handle_power_fault (u8 hp_slot, void *inst_id);
215 /* extern void long_delay (int delay); */
216
217 /* resource functions */
218 extern int pciehp_resource_sort_and_combine (struct pci_resource **head);
219
220 /* pci functions */
221 extern int pciehp_set_irq (u8 bus_num, u8 dev_num, u8 int_pin, u8 irq_num);
222 extern int pciehp_save_config (struct controller *ctrl, int busnumber, int num_ctlr_slots, int first_device_num);
223 extern int pciehp_save_used_resources (struct controller *ctrl, struct pci_func * func, int flag);
224 extern int pciehp_save_slot_config (struct controller *ctrl, struct pci_func * new_slot);
225 extern void pciehp_destroy_board_resources (struct pci_func * func);
226 extern int pciehp_return_board_resources (struct pci_func * func, struct resource_lists * resources);
227 extern void pciehp_destroy_resource_list (struct resource_lists * resources);
228 extern int pciehp_configure_device (struct controller* ctrl, struct pci_func* func);
229 extern int pciehp_unconfigure_device (struct pci_func* func);
230
231
232 /* Global variables */
233 extern struct controller *pciehp_ctrl_list;
234 extern struct pci_func *pciehp_slot_list[256];
235
236 /* Inline functions */
237
238
239 /* Inline functions to check the sanity of a pointer that is passed to us */
slot_paranoia_check(struct slot * slot,const char * function)240 static inline int slot_paranoia_check (struct slot *slot, const char *function)
241 {
242 if (!slot) {
243 dbg("%s - slot == NULL", function);
244 return -1;
245 }
246 if (slot->magic != SLOT_MAGIC) {
247 dbg("%s - bad magic number for slot", function);
248 return -1;
249 }
250 if (!slot->hotplug_slot) {
251 dbg("%s - slot->hotplug_slot == NULL!", function);
252 return -1;
253 }
254 return 0;
255 }
256
get_slot(struct hotplug_slot * hotplug_slot,const char * function)257 static inline struct slot *get_slot (struct hotplug_slot *hotplug_slot, const char *function)
258 {
259 struct slot *slot;
260
261 if (!hotplug_slot) {
262 dbg("%s - hotplug_slot == NULL\n", function);
263 return NULL;
264 }
265
266 slot = (struct slot *)hotplug_slot->private;
267 if (slot_paranoia_check (slot, function))
268 return NULL;
269 return slot;
270 }
271
pciehp_find_slot(struct controller * ctrl,u8 device)272 static inline struct slot *pciehp_find_slot (struct controller *ctrl, u8 device)
273 {
274 struct slot *p_slot, *tmp_slot = NULL;
275
276 if (!ctrl)
277 return NULL;
278
279 p_slot = ctrl->slot;
280
281 dbg("p_slot = %p\n", p_slot);
282
283 while (p_slot && (p_slot->device != device)) {
284 tmp_slot = p_slot;
285 p_slot = p_slot->next;
286 dbg("In while loop, p_slot = %p\n", p_slot);
287 }
288 if (p_slot == NULL) {
289 err("ERROR: pciehp_find_slot device=0x%x\n", device);
290 p_slot = tmp_slot;
291 }
292
293 return (p_slot);
294 }
295
wait_for_ctrl_irq(struct controller * ctrl)296 static inline int wait_for_ctrl_irq (struct controller *ctrl)
297 {
298 int retval = 0;
299
300 DECLARE_WAITQUEUE(wait, current);
301
302 dbg("%s : start\n", __FUNCTION__);
303 add_wait_queue(&ctrl->queue, &wait);
304 set_current_state(TASK_INTERRUPTIBLE);
305 if (!pciehp_poll_mode) {
306 /* Sleep for up to 1 second */
307 schedule_timeout(1*HZ);
308 } else
309 schedule_timeout(2.5*HZ);
310 set_current_state(TASK_RUNNING);
311 remove_wait_queue(&ctrl->queue, &wait);
312 if (signal_pending(current))
313 retval = -EINTR;
314
315 dbg("%s : end\n", __FUNCTION__);
316
317 return retval;
318 }
319
320
321 /* Puts node back in the resource list pointed to by head */
return_resource(struct pci_resource ** head,struct pci_resource * node)322 static inline void return_resource(struct pci_resource **head, struct pci_resource *node)
323 {
324 if (!node || !head)
325 return;
326 node->next = *head;
327 *head = node;
328 }
329
330 #define SLOT_NAME_SIZE 10
331
make_slot_name(char * buffer,int buffer_size,struct slot * slot)332 static inline void make_slot_name(char *buffer, int buffer_size, struct slot *slot)
333 {
334 snprintf(buffer, buffer_size, "%d", slot->number);
335 }
336
337 enum php_ctlr_type {
338 PCI,
339 ISA,
340 ACPI
341 };
342
343 typedef u8(*php_intr_callback_t) (unsigned int change_id, void *instance_id);
344
345 int pcie_init( struct controller *ctrl, struct pci_dev *pdev,
346 php_intr_callback_t attention_button_callback,
347 php_intr_callback_t switch_change_callback,
348 php_intr_callback_t presence_change_callback,
349 php_intr_callback_t power_fault_callback);
350
351 /* This has no meaning for PCI Express, as there is only 1 slot per port */
352 int pcie_get_ctlr_slot_config( struct controller *ctrl,
353 int *num_ctlr_slots,
354 int *first_device_num,
355 int *physical_slot_num,
356 int *updown,
357 int *flags);
358
359 struct hpc_ops {
360 int (*power_on_slot ) (struct slot *slot);
361 int (*power_off_slot ) (struct slot *slot);
362 int (*get_power_status) (struct slot *slot, u8 *status);
363 int (*get_attention_status) (struct slot *slot, u8 *status);
364 int (*set_attention_status) (struct slot *slot, u8 status);
365 int (*get_latch_status) (struct slot *slot, u8 *status);
366 int (*get_adapter_status) (struct slot *slot, u8 *status);
367
368 int (*get_max_bus_speed) (struct slot *slot, enum pci_bus_speed *speed);
369 int (*get_cur_bus_speed) (struct slot *slot, enum pci_bus_speed *speed);
370 int (*get_max_lnk_width) (struct slot *slot, enum pcie_link_width *value);
371 int (*get_cur_lnk_width) (struct slot *slot, enum pcie_link_width *value);
372
373 int (*query_power_fault) (struct slot *slot);
374 void (*green_led_on) (struct slot *slot);
375 void (*green_led_off) (struct slot *slot);
376 void (*green_led_blink) (struct slot *slot);
377 void (*release_ctlr) (struct controller *ctrl);
378 int (*check_lnk_status) (struct controller *ctrl);
379 };
380
381 #endif /* _PCIEHP_H */
382