drivers/pci/hotplug/shpchp.h

   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/delay.h>
  35 #include <linux/sched.h>        /* signal_pending(), struct timer_list */
  36 #include <linux/mutex.h>
  37
  38 #include "pci_hotplug.h"
  39
  40 #if !defined(MODULE)
  41         #define MY_NAME "shpchp"
  42 #else
  43         #define MY_NAME THIS_MODULE->name
  44 #endif
  45
  46 extern int shpchp_poll_mode;
  47 extern int shpchp_poll_time;
  48 extern int shpchp_debug;
  49 extern struct workqueue_struct *shpchp_wq;
  50
  51 /*#define dbg(format, arg...) do { if (shpchp_debug) printk(KERN_DEBUG "%s: " format, MY_NAME , ## arg); } while (0)*/
  52 #define dbg(format, arg...) do { if (shpchp_debug) printk("%s: " format, MY_NAME , ## arg); } while (0)
  53 #define err(format, arg...) printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
  54 #define info(format, arg...) printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
  55 #define warn(format, arg...) printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
  56
  57 #define SLOT_NAME_SIZE 10
  58 struct slot {
  59         u8 bus;
  60         u8 device;
  61         u16 status;
  62         u32 number;
  63         u8 is_a_board;
  64         u8 state;
  65         u8 presence_save;
  66         u8 pwr_save;
  67         struct timer_list task_event;
  68         u8 hp_slot;
  69         struct controller *ctrl;
  70         struct hpc_ops *hpc_ops;
  71         struct hotplug_slot *hotplug_slot;
  72         struct list_head        slot_list;
  73         char name[SLOT_NAME_SIZE];
  74         struct work_struct work;        /* work for button event */
  75         struct mutex lock;
  76 };
  77
  78 struct event_info {
  79         u32 event_type;
  80         struct slot *p_slot;
  81         struct work_struct work;
  82 };
  83
  84 struct controller {
  85         struct mutex crit_sect;         /* critical section mutex */
  86         struct mutex cmd_lock;          /* command lock */
  87         struct php_ctlr_state_s *hpc_ctlr_handle; /* HPC controller handle */
  88         int num_slots;                  /* Number of slots on ctlr */
  89         int slot_num_inc;               /* 1 or -1 */
  90         struct pci_dev *pci_dev;
  91         struct list_head slot_list;
  92         struct hpc_ops *hpc_ops;
  93         wait_queue_head_t queue;        /* sleep & wake process */
  94         u8 bus;
  95         u8 device;
  96         u8 function;
  97         u8 slot_device_offset;
  98         u8 add_support;
  99         u32 pcix_misc2_reg;     /* for amd pogo errata */
 100         enum pci_bus_speed speed;
 101         u32 first_slot;         /* First physical slot number */
 102         u8 slot_bus;            /* Bus where the slots handled by this controller sit */
 103         u32 cap_offset;
 104         unsigned long mmio_base;
 105         unsigned long mmio_size;
 106         volatile int cmd_busy;
 107 };
 108
 109 struct hotplug_params {
 110         u8      cache_line_size;
 111         u8      latency_timer;
 112         u8      enable_serr;
 113         u8      enable_perr;
 114 };
 115
 116 /* Define AMD SHPC ID  */
 117 #define PCI_DEVICE_ID_AMD_GOLAM_7450    0x7450
 118 #define PCI_DEVICE_ID_AMD_POGO_7458     0x7458
 119
 120 /* AMD PCIX bridge registers */
 121
 122 #define PCIX_MEM_BASE_LIMIT_OFFSET      0x1C
 123 #define PCIX_MISCII_OFFSET              0x48
 124 #define PCIX_MISC_BRIDGE_ERRORS_OFFSET  0x80
 125
 126 /* AMD PCIX_MISCII masks and offsets */
 127 #define PERRNONFATALENABLE_MASK         0x00040000
 128 #define PERRFATALENABLE_MASK            0x00080000
 129 #define PERRFLOODENABLE_MASK            0x00100000
 130 #define SERRNONFATALENABLE_MASK         0x00200000
 131 #define SERRFATALENABLE_MASK            0x00400000
 132
 133 /* AMD PCIX_MISC_BRIDGE_ERRORS masks and offsets */
 134 #define PERR_OBSERVED_MASK              0x00000001
 135
 136 /* AMD PCIX_MEM_BASE_LIMIT masks */
 137 #define RSE_MASK                        0x40000000
 138
 139 #define INT_BUTTON_IGNORE               0
 140 #define INT_PRESENCE_ON                 1
 141 #define INT_PRESENCE_OFF                2
 142 #define INT_SWITCH_CLOSE                3
 143 #define INT_SWITCH_OPEN                 4
 144 #define INT_POWER_FAULT                 5
 145 #define INT_POWER_FAULT_CLEAR           6
 146 #define INT_BUTTON_PRESS                7
 147 #define INT_BUTTON_RELEASE              8
 148 #define INT_BUTTON_CANCEL               9
 149
 150 #define STATIC_STATE                    0
 151 #define BLINKINGON_STATE                1
 152 #define BLINKINGOFF_STATE               2
 153 #define POWERON_STATE                   3
 154 #define POWEROFF_STATE                  4
 155
 156 #define PCI_TO_PCI_BRIDGE_CLASS         0x00060400
 157
 158 /* Error messages */
 159 #define INTERLOCK_OPEN                  0x00000002
 160 #define ADD_NOT_SUPPORTED               0x00000003
 161 #define CARD_FUNCTIONING                0x00000005
 162 #define ADAPTER_NOT_SAME                0x00000006
 163 #define NO_ADAPTER_PRESENT              0x00000009
 164 #define NOT_ENOUGH_RESOURCES            0x0000000B
 165 #define DEVICE_TYPE_NOT_SUPPORTED       0x0000000C
 166 #define WRONG_BUS_FREQUENCY             0x0000000D
 167 #define POWER_FAILURE                   0x0000000E
 168
 169 #define REMOVE_NOT_SUPPORTED            0x00000003
 170
 171 #define DISABLE_CARD                    1
 172
 173 /*
 174  * error Messages
 175  */
 176 #define msg_initialization_err  "Initialization failure, error=%d\n"
 177 #define msg_button_on           "PCI slot #%d - powering on due to button press.\n"
 178 #define msg_button_off          "PCI slot #%d - powering off due to button press.\n"
 179 #define msg_button_cancel       "PCI slot #%d - action canceled due to button press.\n"
 180
 181 /* sysfs functions for the hotplug controller info */
 182 extern void shpchp_create_ctrl_files    (struct controller *ctrl);
 183
 184 extern int      shpchp_sysfs_enable_slot(struct slot *slot);
 185 extern int      shpchp_sysfs_disable_slot(struct slot *slot);
 186
 187 extern u8       shpchp_handle_attention_button(u8 hp_slot, void *inst_id);
 188 extern u8       shpchp_handle_switch_change(u8 hp_slot, void *inst_id);
 189 extern u8       shpchp_handle_presence_change(u8 hp_slot, void *inst_id);
 190 extern u8       shpchp_handle_power_fault(u8 hp_slot, void *inst_id);
 191
 192 /* pci functions */
 193 extern int      shpchp_save_config(struct controller *ctrl, int busnumber, int num_ctlr_slots, int first_device_num);
 194 extern int      shpchp_configure_device(struct slot *p_slot);
 195 extern int      shpchp_unconfigure_device(struct slot *p_slot);
 196 extern void     get_hp_hw_control_from_firmware(struct pci_dev *dev);
 197 extern void     get_hp_params_from_firmware(struct pci_dev *dev,
 198                 struct hotplug_params *hpp);
 199 extern int      shpchprm_get_physical_slot_number(struct controller *ctrl,
 200                 u32 *sun, u8 busnum, u8 devnum);
 201 extern void     shpchp_remove_ctrl_files(struct controller *ctrl);
 202 extern void     cleanup_slots(struct controller *ctrl);
 203 extern void     queue_pushbutton_work(void *data);
 204
 205 struct ctrl_reg {
 206         volatile u32 base_offset;
 207         volatile u32 slot_avail1;
 208         volatile u32 slot_avail2;
 209         volatile u32 slot_config;
 210         volatile u16 sec_bus_config;
 211         volatile u8  msi_ctrl;
 212         volatile u8  prog_interface;
 213         volatile u16 cmd;
 214         volatile u16 cmd_status;
 215         volatile u32 intr_loc;
 216         volatile u32 serr_loc;
 217         volatile u32 serr_intr_enable;
 218         volatile u32 slot1;
 219         volatile u32 slot2;
 220         volatile u32 slot3;
 221         volatile u32 slot4;
 222         volatile u32 slot5;
 223         volatile u32 slot6;
 224         volatile u32 slot7;
 225         volatile u32 slot8;
 226         volatile u32 slot9;
 227         volatile u32 slot10;
 228         volatile u32 slot11;
 229         volatile u32 slot12;
 230 } __attribute__ ((packed));
 231
 232 /* offsets to the controller registers based on the above structure layout */
 233 enum ctrl_offsets {
 234         BASE_OFFSET =   offsetof(struct ctrl_reg, base_offset),
 235         SLOT_AVAIL1 =   offsetof(struct ctrl_reg, slot_avail1),
 236         SLOT_AVAIL2     =       offsetof(struct ctrl_reg, slot_avail2),
 237         SLOT_CONFIG =   offsetof(struct ctrl_reg, slot_config),
 238         SEC_BUS_CONFIG =        offsetof(struct ctrl_reg, sec_bus_config),
 239         MSI_CTRL        =       offsetof(struct ctrl_reg, msi_ctrl),
 240         PROG_INTERFACE =        offsetof(struct ctrl_reg, prog_interface),
 241         CMD             =       offsetof(struct ctrl_reg, cmd),
 242         CMD_STATUS      =       offsetof(struct ctrl_reg, cmd_status),
 243         INTR_LOC        =       offsetof(struct ctrl_reg, intr_loc),
 244         SERR_LOC        =       offsetof(struct ctrl_reg, serr_loc),
 245         SERR_INTR_ENABLE =      offsetof(struct ctrl_reg, serr_intr_enable),
 246         SLOT1 =         offsetof(struct ctrl_reg, slot1),
 247         SLOT2 =         offsetof(struct ctrl_reg, slot2),
 248         SLOT3 =         offsetof(struct ctrl_reg, slot3),
 249         SLOT4 =         offsetof(struct ctrl_reg, slot4),
 250         SLOT5 =         offsetof(struct ctrl_reg, slot5),
 251         SLOT6 =         offsetof(struct ctrl_reg, slot6),
 252         SLOT7 =         offsetof(struct ctrl_reg, slot7),
 253         SLOT8 =         offsetof(struct ctrl_reg, slot8),
 254         SLOT9 =         offsetof(struct ctrl_reg, slot9),
 255         SLOT10 =        offsetof(struct ctrl_reg, slot10),
 256         SLOT11 =        offsetof(struct ctrl_reg, slot11),
 257         SLOT12 =        offsetof(struct ctrl_reg, slot12),
 258 };
 259 typedef u8(*php_intr_callback_t) (u8 hp_slot, void *instance_id);
 260 struct php_ctlr_state_s {
 261         struct php_ctlr_state_s *pnext;
 262         struct pci_dev *pci_dev;
 263         unsigned int irq;
 264         unsigned long flags;    /* spinlock's */
 265         u32 slot_device_offset;
 266         u32 num_slots;
 267         struct timer_list       int_poll_timer; /* Added for poll event */
 268         php_intr_callback_t attention_button_callback;
 269         php_intr_callback_t switch_change_callback;
 270         php_intr_callback_t presence_change_callback;
 271         php_intr_callback_t power_fault_callback;
 272         void *callback_instance_id;
 273         void __iomem *creg;                     /* Ptr to controller register space */
 274 };
 275 /* Inline functions */
 276
 277
 278 /* Inline functions to check the sanity of a pointer that is passed to us */
 279 static inline int slot_paranoia_check (struct slot *slot, const char *function)
 280 {
 281         if (!slot) {
 282                 dbg("%s - slot == NULL", function);
 283                 return -1;
 284         }
 285         if (!slot->hotplug_slot) {
 286                 dbg("%s - slot->hotplug_slot == NULL!", function);
 287                 return -1;
 288         }
 289         return 0;
 290 }
 291
 292 static inline struct slot *get_slot (struct hotplug_slot *hotplug_slot, const char *function)
 293 {
 294         struct slot *slot;
 295
 296         if (!hotplug_slot) {
 297                 dbg("%s - hotplug_slot == NULL\n", function);
 298                 return NULL;
 299         }
 300
 301         slot = (struct slot *)hotplug_slot->private;
 302         if (slot_paranoia_check (slot, function))
 303                 return NULL;
 304         return slot;
 305 }
 306
 307 static inline struct slot *shpchp_find_slot (struct controller *ctrl, u8 device)
 308 {
 309         struct slot *slot;
 310
 311         if (!ctrl)
 312                 return NULL;
 313
 314         list_for_each_entry(slot, &ctrl->slot_list, slot_list) {
 315                 if (slot->device == device)
 316                         return slot;
 317         }
 318
 319         err("%s: slot (device=0x%x) not found\n", __FUNCTION__, device);
 320
 321         return NULL;
 322 }
 323
 324 static inline void amd_pogo_errata_save_misc_reg(struct slot *p_slot)
 325 {
 326         u32 pcix_misc2_temp;
 327
 328         /* save MiscII register */
 329         pci_read_config_dword(p_slot->ctrl->pci_dev, PCIX_MISCII_OFFSET, &pcix_misc2_temp);
 330
 331         p_slot->ctrl->pcix_misc2_reg = pcix_misc2_temp;
 332
 333         /* clear SERR/PERR enable bits */
 334         pcix_misc2_temp &= ~SERRFATALENABLE_MASK;
 335         pcix_misc2_temp &= ~SERRNONFATALENABLE_MASK;
 336         pcix_misc2_temp &= ~PERRFLOODENABLE_MASK;
 337         pcix_misc2_temp &= ~PERRFATALENABLE_MASK;
 338         pcix_misc2_temp &= ~PERRNONFATALENABLE_MASK;
 339         pci_write_config_dword(p_slot->ctrl->pci_dev, PCIX_MISCII_OFFSET, pcix_misc2_temp);
 340 }
 341
 342 static inline void amd_pogo_errata_restore_misc_reg(struct slot *p_slot)
 343 {
 344         u32 pcix_misc2_temp;
 345         u32 pcix_bridge_errors_reg;
 346         u32 pcix_mem_base_reg;
 347         u8  perr_set;
 348         u8  rse_set;
 349
 350         /* write-one-to-clear Bridge_Errors[ PERR_OBSERVED ] */
 351         pci_read_config_dword(p_slot->ctrl->pci_dev, PCIX_MISC_BRIDGE_ERRORS_OFFSET, &pcix_bridge_errors_reg);
 352         perr_set = pcix_bridge_errors_reg & PERR_OBSERVED_MASK;
 353         if (perr_set) {
 354                 dbg ("%s  W1C: Bridge_Errors[ PERR_OBSERVED = %08X]\n",__FUNCTION__ , perr_set);
 355
 356                 pci_write_config_dword(p_slot->ctrl->pci_dev, PCIX_MISC_BRIDGE_ERRORS_OFFSET, perr_set);
 357         }
 358
 359         /* write-one-to-clear Memory_Base_Limit[ RSE ] */
 360         pci_read_config_dword(p_slot->ctrl->pci_dev, PCIX_MEM_BASE_LIMIT_OFFSET, &pcix_mem_base_reg);
 361         rse_set = pcix_mem_base_reg & RSE_MASK;
 362         if (rse_set) {
 363                 dbg ("%s  W1C: Memory_Base_Limit[ RSE ]\n",__FUNCTION__ );
 364
 365                 pci_write_config_dword(p_slot->ctrl->pci_dev, PCIX_MEM_BASE_LIMIT_OFFSET, rse_set);
 366         }
 367         /* restore MiscII register */
 368         pci_read_config_dword( p_slot->ctrl->pci_dev, PCIX_MISCII_OFFSET, &pcix_misc2_temp );
 369
 370         if (p_slot->ctrl->pcix_misc2_reg & SERRFATALENABLE_MASK)
 371                 pcix_misc2_temp |= SERRFATALENABLE_MASK;
 372         else
 373                 pcix_misc2_temp &= ~SERRFATALENABLE_MASK;
 374
 375         if (p_slot->ctrl->pcix_misc2_reg & SERRNONFATALENABLE_MASK)
 376                 pcix_misc2_temp |= SERRNONFATALENABLE_MASK;
 377         else
 378                 pcix_misc2_temp &= ~SERRNONFATALENABLE_MASK;
 379
 380         if (p_slot->ctrl->pcix_misc2_reg & PERRFLOODENABLE_MASK)
 381                 pcix_misc2_temp |= PERRFLOODENABLE_MASK;
 382         else
 383                 pcix_misc2_temp &= ~PERRFLOODENABLE_MASK;
 384
 385         if (p_slot->ctrl->pcix_misc2_reg & PERRFATALENABLE_MASK)
 386                 pcix_misc2_temp |= PERRFATALENABLE_MASK;
 387         else
 388                 pcix_misc2_temp &= ~PERRFATALENABLE_MASK;
 389
 390         if (p_slot->ctrl->pcix_misc2_reg & PERRNONFATALENABLE_MASK)
 391                 pcix_misc2_temp |= PERRNONFATALENABLE_MASK;
 392         else
 393                 pcix_misc2_temp &= ~PERRNONFATALENABLE_MASK;
 394         pci_write_config_dword(p_slot->ctrl->pci_dev, PCIX_MISCII_OFFSET, pcix_misc2_temp);
 395 }
 396
 397 enum php_ctlr_type {
 398         PCI,
 399         ISA,
 400         ACPI
 401 };
 402
 403 int shpc_init( struct controller *ctrl, struct pci_dev *pdev);
 404
 405 int shpc_get_ctlr_slot_config( struct controller *ctrl,
 406                 int *num_ctlr_slots,
 407                 int *first_device_num,
 408                 int *physical_slot_num,
 409                 int *updown,
 410                 int *flags);
 411
 412 struct hpc_ops {
 413         int     (*power_on_slot )               (struct slot *slot);
 414         int     (*slot_enable )                 (struct slot *slot);
 415         int     (*slot_disable )                (struct slot *slot);
 416         int     (*set_bus_speed_mode)   (struct slot *slot, enum pci_bus_speed speed);
 417         int     (*get_power_status)             (struct slot *slot, u8 *status);
 418         int     (*get_attention_status) (struct slot *slot, u8 *status);
 419         int     (*set_attention_status) (struct slot *slot, u8 status);
 420         int     (*get_latch_status)             (struct slot *slot, u8 *status);
 421         int     (*get_adapter_status)   (struct slot *slot, u8 *status);
 422
 423         int     (*get_max_bus_speed)    (struct slot *slot, enum pci_bus_speed *speed);
 424         int     (*get_cur_bus_speed)    (struct slot *slot, enum pci_bus_speed *speed);
 425         int     (*get_adapter_speed)    (struct slot *slot, enum pci_bus_speed *speed);
 426         int     (*get_mode1_ECC_cap)    (struct slot *slot, u8 *mode);
 427         int     (*get_prog_int)                 (struct slot *slot, u8 *prog_int);
 428
 429         int     (*query_power_fault)    (struct slot *slot);
 430         void    (*green_led_on)         (struct slot *slot);
 431         void    (*green_led_off)        (struct slot *slot);
 432         void    (*green_led_blink)      (struct slot *slot);
 433         void    (*release_ctlr)         (struct controller *ctrl);
 434         int (*check_cmd_status)         (struct controller *ctrl);
 435 };
 436
 437 #endif                          /* _SHPCHP_H */