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 <linux/sched.h> /* signal_pending(), struct timer_list */
37 #include "pci_hotplug.h"
40 #define MY_NAME "shpchp"
42 #define MY_NAME THIS_MODULE->name
45 extern int shpchp_poll_mode
;
46 extern int shpchp_poll_time
;
47 extern int shpchp_debug
;
49 /*#define dbg(format, arg...) do { if (shpchp_debug) printk(KERN_DEBUG "%s: " format, MY_NAME , ## arg); } while (0)*/
50 #define dbg(format, arg...) do { if (shpchp_debug) printk("%s: " format, MY_NAME , ## arg); } while (0)
51 #define err(format, arg...) printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
52 #define info(format, arg...) printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
53 #define warn(format, arg...) printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
55 #define SLOT_MAGIC 0x67267321
67 struct timer_list task_event
;
69 struct controller
*ctrl
;
70 struct hpc_ops
*hpc_ops
;
71 struct hotplug_slot
*hotplug_slot
;
72 struct list_head slot_list
;
81 struct controller
*next
;
82 struct semaphore crit_sect
; /* critical section semaphore */
83 struct php_ctlr_state_s
*hpc_ctlr_handle
; /* HPC controller handle */
84 int num_slots
; /* Number of slots on ctlr */
85 int slot_num_inc
; /* 1 or -1 */
86 struct pci_dev
*pci_dev
;
87 struct pci_bus
*pci_bus
;
88 struct event_info event_queue
[10];
90 struct hpc_ops
*hpc_ops
;
91 wait_queue_head_t queue
; /* sleep & wake process */
96 u8 slot_device_offset
;
98 enum pci_bus_speed speed
;
99 u32 first_slot
; /* First physical slot number */
100 u8 slot_bus
; /* Bus where the slots handled by this controller sit */
102 unsigned long mmio_base
;
103 unsigned long mmio_size
;
106 struct hotplug_params
{
113 /* Define AMD SHPC ID */
114 #define PCI_DEVICE_ID_AMD_GOLAM_7450 0x7450
116 #define INT_BUTTON_IGNORE 0
117 #define INT_PRESENCE_ON 1
118 #define INT_PRESENCE_OFF 2
119 #define INT_SWITCH_CLOSE 3
120 #define INT_SWITCH_OPEN 4
121 #define INT_POWER_FAULT 5
122 #define INT_POWER_FAULT_CLEAR 6
123 #define INT_BUTTON_PRESS 7
124 #define INT_BUTTON_RELEASE 8
125 #define INT_BUTTON_CANCEL 9
127 #define STATIC_STATE 0
128 #define BLINKINGON_STATE 1
129 #define BLINKINGOFF_STATE 2
130 #define POWERON_STATE 3
131 #define POWEROFF_STATE 4
133 #define PCI_TO_PCI_BRIDGE_CLASS 0x00060400
136 #define INTERLOCK_OPEN 0x00000002
137 #define ADD_NOT_SUPPORTED 0x00000003
138 #define CARD_FUNCTIONING 0x00000005
139 #define ADAPTER_NOT_SAME 0x00000006
140 #define NO_ADAPTER_PRESENT 0x00000009
141 #define NOT_ENOUGH_RESOURCES 0x0000000B
142 #define DEVICE_TYPE_NOT_SUPPORTED 0x0000000C
143 #define WRONG_BUS_FREQUENCY 0x0000000D
144 #define POWER_FAILURE 0x0000000E
146 #define REMOVE_NOT_SUPPORTED 0x00000003
148 #define DISABLE_CARD 1
153 #define msg_initialization_err "Initialization failure, error=%d\n"
154 #define msg_button_on "PCI slot #%d - powering on due to button press.\n"
155 #define msg_button_off "PCI slot #%d - powering off due to button press.\n"
156 #define msg_button_cancel "PCI slot #%d - action canceled due to button press.\n"
158 /* sysfs functions for the hotplug controller info */
159 extern void shpchp_create_ctrl_files (struct controller
*ctrl
);
161 /* controller functions */
162 extern int shpchp_event_start_thread(void);
163 extern void shpchp_event_stop_thread(void);
164 extern int shpchp_enable_slot(struct slot
*slot
);
165 extern int shpchp_disable_slot(struct slot
*slot
);
167 extern u8
shpchp_handle_attention_button(u8 hp_slot
, void *inst_id
);
168 extern u8
shpchp_handle_switch_change(u8 hp_slot
, void *inst_id
);
169 extern u8
shpchp_handle_presence_change(u8 hp_slot
, void *inst_id
);
170 extern u8
shpchp_handle_power_fault(u8 hp_slot
, void *inst_id
);
173 extern int shpchp_save_config(struct controller
*ctrl
, int busnumber
, int num_ctlr_slots
, int first_device_num
);
174 extern int shpchp_configure_device(struct slot
*p_slot
);
175 extern int shpchp_unconfigure_device(struct slot
*p_slot
);
176 extern void get_hp_hw_control_from_firmware(struct pci_dev
*dev
);
177 extern void get_hp_params_from_firmware(struct pci_dev
*dev
,
178 struct hotplug_params
*hpp
);
179 extern int shpchprm_get_physical_slot_number(struct controller
*ctrl
,
180 u32
*sun
, u8 busnum
, u8 devnum
);
181 extern void shpchp_remove_ctrl_files(struct controller
*ctrl
);
184 /* Global variables */
185 extern struct controller
*shpchp_ctrl_list
;
188 volatile u32 base_offset
;
189 volatile u32 slot_avail1
;
190 volatile u32 slot_avail2
;
191 volatile u32 slot_config
;
192 volatile u16 sec_bus_config
;
193 volatile u8 msi_ctrl
;
194 volatile u8 prog_interface
;
196 volatile u16 cmd_status
;
197 volatile u32 intr_loc
;
198 volatile u32 serr_loc
;
199 volatile u32 serr_intr_enable
;
212 } __attribute__ ((packed
));
214 /* offsets to the controller registers based on the above structure layout */
216 BASE_OFFSET
= offsetof(struct ctrl_reg
, base_offset
),
217 SLOT_AVAIL1
= offsetof(struct ctrl_reg
, slot_avail1
),
218 SLOT_AVAIL2
= offsetof(struct ctrl_reg
, slot_avail2
),
219 SLOT_CONFIG
= offsetof(struct ctrl_reg
, slot_config
),
220 SEC_BUS_CONFIG
= offsetof(struct ctrl_reg
, sec_bus_config
),
221 MSI_CTRL
= offsetof(struct ctrl_reg
, msi_ctrl
),
222 PROG_INTERFACE
= offsetof(struct ctrl_reg
, prog_interface
),
223 CMD
= offsetof(struct ctrl_reg
, cmd
),
224 CMD_STATUS
= offsetof(struct ctrl_reg
, cmd_status
),
225 INTR_LOC
= offsetof(struct ctrl_reg
, intr_loc
),
226 SERR_LOC
= offsetof(struct ctrl_reg
, serr_loc
),
227 SERR_INTR_ENABLE
= offsetof(struct ctrl_reg
, serr_intr_enable
),
228 SLOT1
= offsetof(struct ctrl_reg
, slot1
),
229 SLOT2
= offsetof(struct ctrl_reg
, slot2
),
230 SLOT3
= offsetof(struct ctrl_reg
, slot3
),
231 SLOT4
= offsetof(struct ctrl_reg
, slot4
),
232 SLOT5
= offsetof(struct ctrl_reg
, slot5
),
233 SLOT6
= offsetof(struct ctrl_reg
, slot6
),
234 SLOT7
= offsetof(struct ctrl_reg
, slot7
),
235 SLOT8
= offsetof(struct ctrl_reg
, slot8
),
236 SLOT9
= offsetof(struct ctrl_reg
, slot9
),
237 SLOT10
= offsetof(struct ctrl_reg
, slot10
),
238 SLOT11
= offsetof(struct ctrl_reg
, slot11
),
239 SLOT12
= offsetof(struct ctrl_reg
, slot12
),
241 typedef u8(*php_intr_callback_t
) (u8 hp_slot
, void *instance_id
);
242 struct php_ctlr_state_s
{
243 struct php_ctlr_state_s
*pnext
;
244 struct pci_dev
*pci_dev
;
246 unsigned long flags
; /* spinlock's */
247 u32 slot_device_offset
;
249 struct timer_list int_poll_timer
; /* Added for poll event */
250 php_intr_callback_t attention_button_callback
;
251 php_intr_callback_t switch_change_callback
;
252 php_intr_callback_t presence_change_callback
;
253 php_intr_callback_t power_fault_callback
;
254 void *callback_instance_id
;
255 void __iomem
*creg
; /* Ptr to controller register space */
257 /* Inline functions */
260 /* Inline functions to check the sanity of a pointer that is passed to us */
261 static inline int slot_paranoia_check (struct slot
*slot
, const char *function
)
264 dbg("%s - slot == NULL", function
);
267 if (slot
->magic
!= SLOT_MAGIC
) {
268 dbg("%s - bad magic number for slot", function
);
271 if (!slot
->hotplug_slot
) {
272 dbg("%s - slot->hotplug_slot == NULL!", function
);
278 static inline struct slot
*get_slot (struct hotplug_slot
*hotplug_slot
, const char *function
)
283 dbg("%s - hotplug_slot == NULL\n", function
);
287 slot
= (struct slot
*)hotplug_slot
->private;
288 if (slot_paranoia_check (slot
, function
))
293 static inline struct slot
*shpchp_find_slot (struct controller
*ctrl
, u8 device
)
295 struct slot
*p_slot
, *tmp_slot
= NULL
;
302 while (p_slot
&& (p_slot
->device
!= device
)) {
304 p_slot
= p_slot
->next
;
306 if (p_slot
== NULL
) {
307 err("ERROR: shpchp_find_slot device=0x%x\n", device
);
314 static inline int wait_for_ctrl_irq (struct controller
*ctrl
)
316 DECLARE_WAITQUEUE(wait
, current
);
319 add_wait_queue(&ctrl
->queue
, &wait
);
321 if (!shpchp_poll_mode
) {
322 /* Sleep for up to 1 second */
323 msleep_interruptible(1000);
325 /* Sleep for up to 2 seconds */
326 msleep_interruptible(2000);
328 remove_wait_queue(&ctrl
->queue
, &wait
);
329 if (signal_pending(current
))
335 #define SLOT_NAME_SIZE 10
337 static inline void make_slot_name(char *buffer
, int buffer_size
, struct slot
*slot
)
339 snprintf(buffer
, buffer_size
, "%04d_%04d", slot
->bus
, slot
->number
);
348 int shpc_init( struct controller
*ctrl
, struct pci_dev
*pdev
);
350 int shpc_get_ctlr_slot_config( struct controller
*ctrl
,
352 int *first_device_num
,
353 int *physical_slot_num
,
358 int (*power_on_slot
) (struct slot
*slot
);
359 int (*slot_enable
) (struct slot
*slot
);
360 int (*slot_disable
) (struct slot
*slot
);
361 int (*set_bus_speed_mode
) (struct slot
*slot
, enum pci_bus_speed speed
);
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
);
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_adapter_speed
) (struct slot
*slot
, enum pci_bus_speed
*speed
);
371 int (*get_mode1_ECC_cap
) (struct slot
*slot
, u8
*mode
);
372 int (*get_prog_int
) (struct slot
*slot
, u8
*prog_int
);
374 int (*query_power_fault
) (struct slot
*slot
);
375 void (*green_led_on
) (struct slot
*slot
);
376 void (*green_led_off
) (struct slot
*slot
);
377 void (*green_led_blink
) (struct slot
*slot
);
378 void (*release_ctlr
) (struct controller
*ctrl
);
379 int (*check_cmd_status
) (struct controller
*ctrl
);
382 #endif /* _SHPCHP_H */