1/* 2 * Standard 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 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>,<kristen.c.accardi@intel.com> 27 * 28 */ 29#ifndef _SHPCHP_H 30#define _SHPCHP_H 31 32#include <linux/types.h> 33#include <linux/pci.h> 34#include <linux/pci_hotplug.h> 35#include <linux/delay.h> 36#include <linux/sched.h> /* signal_pending(), struct timer_list */ 37#include <linux/mutex.h> 38 39#if !defined(MODULE) 40 #define MY_NAME "shpchp" 41#else 42 #define MY_NAME THIS_MODULE->name 43#endif 44 45extern int shpchp_poll_mode; 46extern int shpchp_poll_time; 47extern int shpchp_debug; 48extern struct workqueue_struct *shpchp_wq; 49 50#define dbg(format, arg...) \ 51do { \ 52 if (shpchp_debug) \ 53 printk(KERN_DEBUG "%s: " format, MY_NAME , ## arg); \ 54} while (0) 55#define err(format, arg...) \ 56 printk(KERN_ERR "%s: " format, MY_NAME , ## arg) 57#define info(format, arg...) \ 58 printk(KERN_INFO "%s: " format, MY_NAME , ## arg) 59#define warn(format, arg...) \ 60 printk(KERN_WARNING "%s: " format, MY_NAME , ## arg) 61 62#define ctrl_dbg(ctrl, format, arg...) \ 63 do { \ 64 if (shpchp_debug) \ 65 dev_printk(KERN_DEBUG, &ctrl->pci_dev->dev, \ 66 format, ## arg); \ 67 } while (0) 68#define ctrl_err(ctrl, format, arg...) \ 69 dev_err(&ctrl->pci_dev->dev, format, ## arg) 70#define ctrl_info(ctrl, format, arg...) \ 71 dev_info(&ctrl->pci_dev->dev, format, ## arg) 72#define ctrl_warn(ctrl, format, arg...) \ 73 dev_warn(&ctrl->pci_dev->dev, format, ## arg) 74 75 76#define SLOT_NAME_SIZE 10 77struct slot { 78 u8 bus; 79 u8 device; 80 u16 status; 81 u32 number; 82 u8 is_a_board; 83 u8 state; 84 u8 presence_save; 85 u8 pwr_save; 86 struct controller *ctrl; 87 struct hpc_ops *hpc_ops; 88 struct hotplug_slot *hotplug_slot; 89 struct list_head slot_list; 90 struct delayed_work work; /* work for button event */ 91 struct mutex lock; 92 u8 hp_slot; 93}; 94 95struct event_info { 96 u32 event_type; 97 struct slot *p_slot; 98 struct work_struct work; 99}; 100 101struct controller { 102 struct mutex crit_sect; /* critical section mutex */ 103 struct mutex cmd_lock; /* command lock */ 104 int num_slots; /* Number of slots on ctlr */ 105 int slot_num_inc; /* 1 or -1 */ 106 struct pci_dev *pci_dev; 107 struct list_head slot_list; 108 struct hpc_ops *hpc_ops; 109 wait_queue_head_t queue; /* sleep & wake process */ 110 u8 slot_device_offset; 111 u32 pcix_misc2_reg; /* for amd pogo errata */ 112 u32 first_slot; /* First physical slot number */ 113 u32 cap_offset; 114 unsigned long mmio_base; 115 unsigned long mmio_size; 116 void __iomem *creg; 117 struct timer_list poll_timer; 118}; 119 120/* Define AMD SHPC ID */ 121#define PCI_DEVICE_ID_AMD_GOLAM_7450 0x7450 122#define PCI_DEVICE_ID_AMD_POGO_7458 0x7458 123 124/* AMD PCI-X bridge registers */ 125#define PCIX_MEM_BASE_LIMIT_OFFSET 0x1C 126#define PCIX_MISCII_OFFSET 0x48 127#define PCIX_MISC_BRIDGE_ERRORS_OFFSET 0x80 128 129/* AMD PCIX_MISCII masks and offsets */ 130#define PERRNONFATALENABLE_MASK 0x00040000 131#define PERRFATALENABLE_MASK 0x00080000 132#define PERRFLOODENABLE_MASK 0x00100000 133#define SERRNONFATALENABLE_MASK 0x00200000 134#define SERRFATALENABLE_MASK 0x00400000 135 136/* AMD PCIX_MISC_BRIDGE_ERRORS masks and offsets */ 137#define PERR_OBSERVED_MASK 0x00000001 138 139/* AMD PCIX_MEM_BASE_LIMIT masks */ 140#define RSE_MASK 0x40000000 141 142#define INT_BUTTON_IGNORE 0 143#define INT_PRESENCE_ON 1 144#define INT_PRESENCE_OFF 2 145#define INT_SWITCH_CLOSE 3 146#define INT_SWITCH_OPEN 4 147#define INT_POWER_FAULT 5 148#define INT_POWER_FAULT_CLEAR 6 149#define INT_BUTTON_PRESS 7 150#define INT_BUTTON_RELEASE 8 151#define INT_BUTTON_CANCEL 9 152 153#define STATIC_STATE 0 154#define BLINKINGON_STATE 1 155#define BLINKINGOFF_STATE 2 156#define POWERON_STATE 3 157#define POWEROFF_STATE 4 158 159/* Error messages */ 160#define INTERLOCK_OPEN 0x00000002 161#define ADD_NOT_SUPPORTED 0x00000003 162#define CARD_FUNCTIONING 0x00000005 163#define ADAPTER_NOT_SAME 0x00000006 164#define NO_ADAPTER_PRESENT 0x00000009 165#define NOT_ENOUGH_RESOURCES 0x0000000B 166#define DEVICE_TYPE_NOT_SUPPORTED 0x0000000C 167#define WRONG_BUS_FREQUENCY 0x0000000D 168#define POWER_FAILURE 0x0000000E 169 170extern int __must_check shpchp_create_ctrl_files(struct controller *ctrl); 171extern void shpchp_remove_ctrl_files(struct controller *ctrl); 172extern int shpchp_sysfs_enable_slot(struct slot *slot); 173extern int shpchp_sysfs_disable_slot(struct slot *slot); 174extern u8 shpchp_handle_attention_button(u8 hp_slot, struct controller *ctrl); 175extern u8 shpchp_handle_switch_change(u8 hp_slot, struct controller *ctrl); 176extern u8 shpchp_handle_presence_change(u8 hp_slot, struct controller *ctrl); 177extern u8 shpchp_handle_power_fault(u8 hp_slot, struct controller *ctrl); 178extern int shpchp_configure_device(struct slot *p_slot); 179extern int shpchp_unconfigure_device(struct slot *p_slot); 180extern void cleanup_slots(struct controller *ctrl); 181extern void shpchp_queue_pushbutton_work(struct work_struct *work); 182extern int shpc_init( struct controller *ctrl, struct pci_dev *pdev); 183 184static inline const char *slot_name(struct slot *slot) 185{ 186 return hotplug_slot_name(slot->hotplug_slot); 187} 188 189#ifdef CONFIG_ACPI 190#include <linux/pci-acpi.h> 191static inline int get_hp_hw_control_from_firmware(struct pci_dev *dev) 192{ 193 u32 flags = OSC_SHPC_NATIVE_HP_CONTROL; 194 return acpi_get_hp_hw_control_from_firmware(dev, flags); 195} 196#else 197#define get_hp_hw_control_from_firmware(dev) (0) 198#endif 199 200struct ctrl_reg { 201 volatile u32 base_offset; 202 volatile u32 slot_avail1; 203 volatile u32 slot_avail2; 204 volatile u32 slot_config; 205 volatile u16 sec_bus_config; 206 volatile u8 msi_ctrl; 207 volatile u8 prog_interface; 208 volatile u16 cmd; 209 volatile u16 cmd_status; 210 volatile u32 intr_loc; 211 volatile u32 serr_loc; 212 volatile u32 serr_intr_enable; 213 volatile u32 slot1; 214} __attribute__ ((packed)); 215 216/* offsets to the controller registers based on the above structure layout */ 217enum ctrl_offsets { 218 BASE_OFFSET = offsetof(struct ctrl_reg, base_offset), 219 SLOT_AVAIL1 = offsetof(struct ctrl_reg, slot_avail1), 220 SLOT_AVAIL2 = offsetof(struct ctrl_reg, slot_avail2), 221 SLOT_CONFIG = offsetof(struct ctrl_reg, slot_config), 222 SEC_BUS_CONFIG = offsetof(struct ctrl_reg, sec_bus_config), 223 MSI_CTRL = offsetof(struct ctrl_reg, msi_ctrl), 224 PROG_INTERFACE = offsetof(struct ctrl_reg, prog_interface), 225 CMD = offsetof(struct ctrl_reg, cmd), 226 CMD_STATUS = offsetof(struct ctrl_reg, cmd_status), 227 INTR_LOC = offsetof(struct ctrl_reg, intr_loc), 228 SERR_LOC = offsetof(struct ctrl_reg, serr_loc), 229 SERR_INTR_ENABLE = offsetof(struct ctrl_reg, serr_intr_enable), 230 SLOT1 = offsetof(struct ctrl_reg, slot1), 231}; 232 233static inline struct slot *get_slot(struct hotplug_slot *hotplug_slot) 234{ 235 return hotplug_slot->private; 236} 237 238static inline struct slot *shpchp_find_slot(struct controller *ctrl, u8 device) 239{ 240 struct slot *slot; 241 242 list_for_each_entry(slot, &ctrl->slot_list, slot_list) { 243 if (slot->device == device) 244 return slot; 245 } 246 247 ctrl_err(ctrl, "Slot (device=0x%02x) not found\n", device); 248 return NULL; 249} 250 251static inline void amd_pogo_errata_save_misc_reg(struct slot *p_slot) 252{ 253 u32 pcix_misc2_temp; 254 255 /* save MiscII register */ 256 pci_read_config_dword(p_slot->ctrl->pci_dev, PCIX_MISCII_OFFSET, &pcix_misc2_temp); 257 258 p_slot->ctrl->pcix_misc2_reg = pcix_misc2_temp; 259 260 /* clear SERR/PERR enable bits */ 261 pcix_misc2_temp &= ~SERRFATALENABLE_MASK; 262 pcix_misc2_temp &= ~SERRNONFATALENABLE_MASK; 263 pcix_misc2_temp &= ~PERRFLOODENABLE_MASK; 264 pcix_misc2_temp &= ~PERRFATALENABLE_MASK; 265 pcix_misc2_temp &= ~PERRNONFATALENABLE_MASK; 266 pci_write_config_dword(p_slot->ctrl->pci_dev, PCIX_MISCII_OFFSET, pcix_misc2_temp); 267} 268 269static inline void amd_pogo_errata_restore_misc_reg(struct slot *p_slot) 270{ 271 u32 pcix_misc2_temp; 272 u32 pcix_bridge_errors_reg; 273 u32 pcix_mem_base_reg; 274 u8 perr_set; 275 u8 rse_set; 276 277 /* write-one-to-clear Bridge_Errors[ PERR_OBSERVED ] */ 278 pci_read_config_dword(p_slot->ctrl->pci_dev, PCIX_MISC_BRIDGE_ERRORS_OFFSET, &pcix_bridge_errors_reg); 279 perr_set = pcix_bridge_errors_reg & PERR_OBSERVED_MASK; 280 if (perr_set) { 281 ctrl_dbg(p_slot->ctrl, 282 "Bridge_Errors[ PERR_OBSERVED = %08X] (W1C)\n", 283 perr_set); 284 285 pci_write_config_dword(p_slot->ctrl->pci_dev, PCIX_MISC_BRIDGE_ERRORS_OFFSET, perr_set); 286 } 287 288 /* write-one-to-clear Memory_Base_Limit[ RSE ] */ 289 pci_read_config_dword(p_slot->ctrl->pci_dev, PCIX_MEM_BASE_LIMIT_OFFSET, &pcix_mem_base_reg); 290 rse_set = pcix_mem_base_reg & RSE_MASK; 291 if (rse_set) { 292 ctrl_dbg(p_slot->ctrl, "Memory_Base_Limit[ RSE ] (W1C)\n"); 293 294 pci_write_config_dword(p_slot->ctrl->pci_dev, PCIX_MEM_BASE_LIMIT_OFFSET, rse_set); 295 } 296 /* restore MiscII register */ 297 pci_read_config_dword( p_slot->ctrl->pci_dev, PCIX_MISCII_OFFSET, &pcix_misc2_temp ); 298 299 if (p_slot->ctrl->pcix_misc2_reg & SERRFATALENABLE_MASK) 300 pcix_misc2_temp |= SERRFATALENABLE_MASK; 301 else 302 pcix_misc2_temp &= ~SERRFATALENABLE_MASK; 303 304 if (p_slot->ctrl->pcix_misc2_reg & SERRNONFATALENABLE_MASK) 305 pcix_misc2_temp |= SERRNONFATALENABLE_MASK; 306 else 307 pcix_misc2_temp &= ~SERRNONFATALENABLE_MASK; 308 309 if (p_slot->ctrl->pcix_misc2_reg & PERRFLOODENABLE_MASK) 310 pcix_misc2_temp |= PERRFLOODENABLE_MASK; 311 else 312 pcix_misc2_temp &= ~PERRFLOODENABLE_MASK; 313 314 if (p_slot->ctrl->pcix_misc2_reg & PERRFATALENABLE_MASK) 315 pcix_misc2_temp |= PERRFATALENABLE_MASK; 316 else 317 pcix_misc2_temp &= ~PERRFATALENABLE_MASK; 318 319 if (p_slot->ctrl->pcix_misc2_reg & PERRNONFATALENABLE_MASK) 320 pcix_misc2_temp |= PERRNONFATALENABLE_MASK; 321 else 322 pcix_misc2_temp &= ~PERRNONFATALENABLE_MASK; 323 pci_write_config_dword(p_slot->ctrl->pci_dev, PCIX_MISCII_OFFSET, pcix_misc2_temp); 324} 325 326struct hpc_ops { 327 int (*power_on_slot)(struct slot *slot); 328 int (*slot_enable)(struct slot *slot); 329 int (*slot_disable)(struct slot *slot); 330 int (*set_bus_speed_mode)(struct slot *slot, enum pci_bus_speed speed); 331 int (*get_power_status)(struct slot *slot, u8 *status); 332 int (*get_attention_status)(struct slot *slot, u8 *status); 333 int (*set_attention_status)(struct slot *slot, u8 status); 334 int (*get_latch_status)(struct slot *slot, u8 *status); 335 int (*get_adapter_status)(struct slot *slot, u8 *status); 336 int (*get_adapter_speed)(struct slot *slot, enum pci_bus_speed *speed); 337 int (*get_mode1_ECC_cap)(struct slot *slot, u8 *mode); 338 int (*get_prog_int)(struct slot *slot, u8 *prog_int); 339 int (*query_power_fault)(struct slot *slot); 340 void (*green_led_on)(struct slot *slot); 341 void (*green_led_off)(struct slot *slot); 342 void (*green_led_blink)(struct slot *slot); 343 void (*release_ctlr)(struct controller *ctrl); 344 int (*check_cmd_status)(struct controller *ctrl); 345}; 346 347#endif /* _SHPCHP_H */ 348