2 * Standard 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
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 "pci_hotplug.h"
38 #define MY_NAME "shpchp"
40 #define MY_NAME THIS_MODULE->name
43 extern int shpchp_poll_mode;
44 extern int shpchp_poll_time;
45 extern int shpchp_debug;
47 /*#define dbg(format, arg...) do { if (shpchp_debug) printk(KERN_DEBUG "%s: " format, MY_NAME , ## arg); } while (0)*/
48 #define dbg(format, arg...) do { if (shpchp_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_MAGIC 0x67267321
65 struct timer_list task_event;
67 struct controller *ctrl;
68 struct hpc_ops *hpc_ops;
69 struct hotplug_slot *hotplug_slot;
70 struct list_head slot_list;
79 struct controller *next;
80 struct semaphore crit_sect; /* critical section semaphore */
81 struct php_ctlr_state_s *hpc_ctlr_handle; /* HPC controller handle */
82 int num_slots; /* Number of slots on ctlr */
83 int slot_num_inc; /* 1 or -1 */
84 struct pci_dev *pci_dev;
85 struct pci_bus *pci_bus;
86 struct event_info event_queue[10];
88 struct hpc_ops *hpc_ops;
89 wait_queue_head_t queue; /* sleep & wake process */
94 u8 slot_device_offset;
96 enum pci_bus_speed speed;
97 u32 first_slot; /* First physical slot number */
98 u8 slot_bus; /* Bus where the slots handled by this controller sit */
101 struct hotplug_params {
108 /* Define AMD SHPC ID */
109 #define PCI_DEVICE_ID_AMD_GOLAM_7450 0x7450
111 #define INT_BUTTON_IGNORE 0
112 #define INT_PRESENCE_ON 1
113 #define INT_PRESENCE_OFF 2
114 #define INT_SWITCH_CLOSE 3
115 #define INT_SWITCH_OPEN 4
116 #define INT_POWER_FAULT 5
117 #define INT_POWER_FAULT_CLEAR 6
118 #define INT_BUTTON_PRESS 7
119 #define INT_BUTTON_RELEASE 8
120 #define INT_BUTTON_CANCEL 9
122 #define STATIC_STATE 0
123 #define BLINKINGON_STATE 1
124 #define BLINKINGOFF_STATE 2
125 #define POWERON_STATE 3
126 #define POWEROFF_STATE 4
128 #define PCI_TO_PCI_BRIDGE_CLASS 0x00060400
131 #define INTERLOCK_OPEN 0x00000002
132 #define ADD_NOT_SUPPORTED 0x00000003
133 #define CARD_FUNCTIONING 0x00000005
134 #define ADAPTER_NOT_SAME 0x00000006
135 #define NO_ADAPTER_PRESENT 0x00000009
136 #define NOT_ENOUGH_RESOURCES 0x0000000B
137 #define DEVICE_TYPE_NOT_SUPPORTED 0x0000000C
138 #define WRONG_BUS_FREQUENCY 0x0000000D
139 #define POWER_FAILURE 0x0000000E
141 #define REMOVE_NOT_SUPPORTED 0x00000003
143 #define DISABLE_CARD 1
148 #define msg_initialization_err "Initialization failure, error=%d\n"
149 #define msg_button_on "PCI slot #%d - powering on due to button press.\n"
150 #define msg_button_off "PCI slot #%d - powering off due to button press.\n"
151 #define msg_button_cancel "PCI slot #%d - action canceled due to button press.\n"
153 /* sysfs functions for the hotplug controller info */
154 extern void shpchp_create_ctrl_files (struct controller *ctrl);
156 /* controller functions */
157 extern int shpchp_event_start_thread(void);
158 extern void shpchp_event_stop_thread(void);
159 extern int shpchp_enable_slot(struct slot *slot);
160 extern int shpchp_disable_slot(struct slot *slot);
162 extern u8 shpchp_handle_attention_button(u8 hp_slot, void *inst_id);
163 extern u8 shpchp_handle_switch_change(u8 hp_slot, void *inst_id);
164 extern u8 shpchp_handle_presence_change(u8 hp_slot, void *inst_id);
165 extern u8 shpchp_handle_power_fault(u8 hp_slot, void *inst_id);
168 extern int shpchp_save_config(struct controller *ctrl, int busnumber, int num_ctlr_slots, int first_device_num);
169 extern int shpchp_configure_device(struct slot *p_slot);
170 extern int shpchp_unconfigure_device(struct slot *p_slot);
171 extern void get_hp_hw_control_from_firmware(struct pci_dev *dev);
172 extern void get_hp_params_from_firmware(struct pci_dev *dev,
173 struct hotplug_params *hpp);
174 extern int shpchprm_get_physical_slot_number(struct controller *ctrl,
175 u32 *sun, u8 busnum, u8 devnum);
176 extern void shpchp_remove_ctrl_files(struct controller *ctrl);
179 /* Global variables */
180 extern struct controller *shpchp_ctrl_list;
183 volatile u32 base_offset;
184 volatile u32 slot_avail1;
185 volatile u32 slot_avail2;
186 volatile u32 slot_config;
187 volatile u16 sec_bus_config;
188 volatile u8 msi_ctrl;
189 volatile u8 prog_interface;
191 volatile u16 cmd_status;
192 volatile u32 intr_loc;
193 volatile u32 serr_loc;
194 volatile u32 serr_intr_enable;
207 } __attribute__ ((packed));
209 /* offsets to the controller registers based on the above structure layout */
211 BASE_OFFSET = offsetof(struct ctrl_reg, base_offset),
212 SLOT_AVAIL1 = offsetof(struct ctrl_reg, slot_avail1),
213 SLOT_AVAIL2 = offsetof(struct ctrl_reg, slot_avail2),
214 SLOT_CONFIG = offsetof(struct ctrl_reg, slot_config),
215 SEC_BUS_CONFIG = offsetof(struct ctrl_reg, sec_bus_config),
216 MSI_CTRL = offsetof(struct ctrl_reg, msi_ctrl),
217 PROG_INTERFACE = offsetof(struct ctrl_reg, prog_interface),
218 CMD = offsetof(struct ctrl_reg, cmd),
219 CMD_STATUS = offsetof(struct ctrl_reg, cmd_status),
220 INTR_LOC = offsetof(struct ctrl_reg, intr_loc),
221 SERR_LOC = offsetof(struct ctrl_reg, serr_loc),
222 SERR_INTR_ENABLE = offsetof(struct ctrl_reg, serr_intr_enable),
223 SLOT1 = offsetof(struct ctrl_reg, slot1),
224 SLOT2 = offsetof(struct ctrl_reg, slot2),
225 SLOT3 = offsetof(struct ctrl_reg, slot3),
226 SLOT4 = offsetof(struct ctrl_reg, slot4),
227 SLOT5 = offsetof(struct ctrl_reg, slot5),
228 SLOT6 = offsetof(struct ctrl_reg, slot6),
229 SLOT7 = offsetof(struct ctrl_reg, slot7),
230 SLOT8 = offsetof(struct ctrl_reg, slot8),
231 SLOT9 = offsetof(struct ctrl_reg, slot9),
232 SLOT10 = offsetof(struct ctrl_reg, slot10),
233 SLOT11 = offsetof(struct ctrl_reg, slot11),
234 SLOT12 = offsetof(struct ctrl_reg, slot12),
236 typedef u8(*php_intr_callback_t) (u8 hp_slot, void *instance_id);
237 struct php_ctlr_state_s {
238 struct php_ctlr_state_s *pnext;
239 struct pci_dev *pci_dev;
241 unsigned long flags; /* spinlock's */
242 u32 slot_device_offset;
244 struct timer_list int_poll_timer; /* Added for poll event */
245 php_intr_callback_t attention_button_callback;
246 php_intr_callback_t switch_change_callback;
247 php_intr_callback_t presence_change_callback;
248 php_intr_callback_t power_fault_callback;
249 void *callback_instance_id;
250 void __iomem *creg; /* Ptr to controller register space */
252 /* Inline functions */
255 /* Inline functions to check the sanity of a pointer that is passed to us */
256 static inline int slot_paranoia_check (struct slot *slot, const char *function)
259 dbg("%s - slot == NULL", function);
262 if (slot->magic != SLOT_MAGIC) {
263 dbg("%s - bad magic number for slot", function);
266 if (!slot->hotplug_slot) {
267 dbg("%s - slot->hotplug_slot == NULL!", function);
273 static inline struct slot *get_slot (struct hotplug_slot *hotplug_slot, const char *function)
278 dbg("%s - hotplug_slot == NULL\n", function);
282 slot = (struct slot *)hotplug_slot->private;
283 if (slot_paranoia_check (slot, function))
288 static inline struct slot *shpchp_find_slot (struct controller *ctrl, u8 device)
290 struct slot *p_slot, *tmp_slot = NULL;
297 while (p_slot && (p_slot->device != device)) {
299 p_slot = p_slot->next;
301 if (p_slot == NULL) {
302 err("ERROR: shpchp_find_slot device=0x%x\n", device);
309 static inline int wait_for_ctrl_irq (struct controller *ctrl)
311 DECLARE_WAITQUEUE(wait, current);
314 add_wait_queue(&ctrl->queue, &wait);
316 if (!shpchp_poll_mode) {
317 /* Sleep for up to 1 second */
318 msleep_interruptible(1000);
320 /* Sleep for up to 2 seconds */
321 msleep_interruptible(2000);
323 remove_wait_queue(&ctrl->queue, &wait);
324 if (signal_pending(current))
330 #define SLOT_NAME_SIZE 10
332 static inline void make_slot_name(char *buffer, int buffer_size, struct slot *slot)
334 snprintf(buffer, buffer_size, "%04d_%04d", slot->bus, slot->number);
343 int shpc_init( struct controller *ctrl, struct pci_dev *pdev);
345 int shpc_get_ctlr_slot_config( struct controller *ctrl,
347 int *first_device_num,
348 int *physical_slot_num,
353 int (*power_on_slot ) (struct slot *slot);
354 int (*slot_enable ) (struct slot *slot);
355 int (*slot_disable ) (struct slot *slot);
356 int (*set_bus_speed_mode) (struct slot *slot, enum pci_bus_speed speed);
357 int (*get_power_status) (struct slot *slot, u8 *status);
358 int (*get_attention_status) (struct slot *slot, u8 *status);
359 int (*set_attention_status) (struct slot *slot, u8 status);
360 int (*get_latch_status) (struct slot *slot, u8 *status);
361 int (*get_adapter_status) (struct slot *slot, u8 *status);
363 int (*get_max_bus_speed) (struct slot *slot, enum pci_bus_speed *speed);
364 int (*get_cur_bus_speed) (struct slot *slot, enum pci_bus_speed *speed);
365 int (*get_adapter_speed) (struct slot *slot, enum pci_bus_speed *speed);
366 int (*get_mode1_ECC_cap) (struct slot *slot, u8 *mode);
367 int (*get_prog_int) (struct slot *slot, u8 *prog_int);
369 int (*query_power_fault) (struct slot *slot);
370 void (*green_led_on) (struct slot *slot);
371 void (*green_led_off) (struct slot *slot);
372 void (*green_led_blink) (struct slot *slot);
373 void (*release_ctlr) (struct controller *ctrl);
374 int (*check_cmd_status) (struct controller *ctrl);
377 #endif /* _SHPCHP_H */