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 <asm/semaphore.h>
  36 #include <asm/io.h>
  37 #include "pci_hotplug.h"
  38
  39 #if !defined(MODULE)
  40         #define MY_NAME "shpchp"
  41 #else
  42         #define MY_NAME THIS_MODULE->name
  43 #endif
  44
  45 extern int shpchp_poll_mode;
  46 extern int shpchp_poll_time;
  47 extern int shpchp_debug;
  48
  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)
  54
  55 struct pci_func {
  56         struct pci_func *next;
  57         u8 bus;
  58         u8 device;
  59         u8 function;
  60         u8 is_a_board;
  61         u16 status;
  62         u8 configured;
  63         u8 switch_save;
  64         u8 presence_save;
  65         u8 pwr_save;
  66         struct pci_dev* pci_dev;
  67 };
  68
  69 #define SLOT_MAGIC      0x67267321
  70 struct slot {
  71         u32 magic;
  72         struct slot *next;
  73         u8 bus;
  74         u8 device;
  75         u32 number;
  76         u8 is_a_board;
  77         u8 configured;
  78         u8 state;
  79         u8 switch_save;
  80         u8 presence_save;
  81         u32 capabilities;
  82         u16 reserved2;
  83         struct timer_list task_event;
  84         u8 hp_slot;
  85         struct controller *ctrl;
  86         struct hpc_ops *hpc_ops;
  87         struct hotplug_slot *hotplug_slot;
  88         struct list_head        slot_list;
  89 };
  90
  91 struct event_info {
  92         u32 event_type;
  93         u8 hp_slot;
  94 };
  95
  96 struct controller {
  97         struct controller *next;
  98         struct semaphore crit_sect;     /* critical section semaphore */
  99         void * hpc_ctlr_handle;         /* HPC controller handle */
 100         int num_slots;                  /* Number of slots on ctlr */
 101         int slot_num_inc;               /* 1 or -1 */
 102         struct pci_dev *pci_dev;
 103         struct pci_bus *pci_bus;
 104         struct event_info event_queue[10];
 105         struct slot *slot;
 106         struct hpc_ops *hpc_ops;
 107         wait_queue_head_t queue;        /* sleep & wake process */
 108         u8 next_event;
 109         u8 seg;
 110         u8 bus;
 111         u8 device;
 112         u8 function;
 113         u8 rev;
 114         u8 slot_device_offset;
 115         u8 add_support;
 116         enum pci_bus_speed speed;
 117         u32 first_slot;         /* First physical slot number */
 118         u8 slot_bus;            /* Bus where the slots handled by this controller sit */
 119         u8 push_flag;
 120         u16 ctlrcap;
 121         u16 vendor_id;
 122 };
 123
 124 struct hotplug_params {
 125         u8      cache_line_size;
 126         u8      latency_timer;
 127         u8      enable_serr;
 128         u8      enable_perr;
 129 };
 130
 131 /* Define AMD SHPC ID  */
 132 #define PCI_DEVICE_ID_AMD_GOLAM_7450    0x7450
 133
 134 #define INT_BUTTON_IGNORE               0
 135 #define INT_PRESENCE_ON                 1
 136 #define INT_PRESENCE_OFF                2
 137 #define INT_SWITCH_CLOSE                3
 138 #define INT_SWITCH_OPEN                 4
 139 #define INT_POWER_FAULT                 5
 140 #define INT_POWER_FAULT_CLEAR           6
 141 #define INT_BUTTON_PRESS                7
 142 #define INT_BUTTON_RELEASE              8
 143 #define INT_BUTTON_CANCEL               9
 144
 145 #define STATIC_STATE                    0
 146 #define BLINKINGON_STATE                1
 147 #define BLINKINGOFF_STATE               2
 148 #define POWERON_STATE                   3
 149 #define POWEROFF_STATE                  4
 150
 151 #define PCI_TO_PCI_BRIDGE_CLASS         0x00060400
 152
 153 /* Error messages */
 154 #define INTERLOCK_OPEN                  0x00000002
 155 #define ADD_NOT_SUPPORTED               0x00000003
 156 #define CARD_FUNCTIONING                0x00000005
 157 #define ADAPTER_NOT_SAME                0x00000006
 158 #define NO_ADAPTER_PRESENT              0x00000009
 159 #define NOT_ENOUGH_RESOURCES            0x0000000B
 160 #define DEVICE_TYPE_NOT_SUPPORTED       0x0000000C
 161 #define WRONG_BUS_FREQUENCY             0x0000000D
 162 #define POWER_FAILURE                   0x0000000E
 163
 164 #define REMOVE_NOT_SUPPORTED            0x00000003
 165
 166 #define DISABLE_CARD                    1
 167
 168 /*
 169  * error Messages
 170  */
 171 #define msg_initialization_err  "Initialization failure, error=%d\n"
 172 #define msg_HPC_rev_error       "Unsupported revision of the PCI hot plug controller found.\n"
 173 #define msg_HPC_non_shpc        "The PCI hot plug controller is not supported by this driver.\n"
 174 #define msg_HPC_not_supported   "This system is not supported by this version of shpcphd mdoule. Upgrade to a newer version of shpchpd\n"
 175 #define msg_button_on           "PCI slot #%d - powering on due to button press.\n"
 176 #define msg_button_off          "PCI slot #%d - powering off due to button press.\n"
 177 #define msg_button_cancel       "PCI slot #%d - action canceled due to button press.\n"
 178 #define msg_button_ignore       "PCI slot #%d - button press ignored.  (action in progress...)\n"
 179
 180 /* sysfs functions for the hotplug controller info */
 181 extern void shpchp_create_ctrl_files    (struct controller *ctrl);
 182
 183 /* controller functions */
 184 extern int      shpchp_event_start_thread(void);
 185 extern void     shpchp_event_stop_thread(void);
 186 extern struct   pci_func *shpchp_slot_create(unsigned char busnumber);
 187 extern struct   pci_func *shpchp_slot_find(unsigned char bus, unsigned char device, unsigned char index);
 188 extern int      shpchp_enable_slot(struct slot *slot);
 189 extern int      shpchp_disable_slot(struct slot *slot);
 190
 191 extern u8       shpchp_handle_attention_button(u8 hp_slot, void *inst_id);
 192 extern u8       shpchp_handle_switch_change(u8 hp_slot, void *inst_id);
 193 extern u8       shpchp_handle_presence_change(u8 hp_slot, void *inst_id);
 194 extern u8       shpchp_handle_power_fault(u8 hp_slot, void *inst_id);
 195
 196 /* pci functions */
 197 extern int      shpchp_save_config(struct controller *ctrl, int busnumber, int num_ctlr_slots, int first_device_num);
 198 extern int      shpchp_save_slot_config(struct controller *ctrl, struct pci_func * new_slot);
 199 extern int      shpchp_configure_device(struct slot *p_slot);
 200 extern int      shpchp_unconfigure_device(struct pci_func* func);
 201 extern void     get_hp_hw_control_from_firmware(struct pci_dev *dev);
 202 extern void     get_hp_params_from_firmware(struct pci_dev *dev,
 203                 struct hotplug_params *hpp);
 204 extern int      shpchprm_get_physical_slot_number(struct controller *ctrl,
 205                 u32 *sun, u8 busnum, u8 devnum);
 206
 207
 208 /* Global variables */
 209 extern struct controller *shpchp_ctrl_list;
 210 extern struct pci_func *shpchp_slot_list[256];
 211
 212 struct ctrl_reg {
 213         volatile u32 base_offset;
 214         volatile u32 slot_avail1;
 215         volatile u32 slot_avail2;
 216         volatile u32 slot_config;
 217         volatile u16 sec_bus_config;
 218         volatile u8  msi_ctrl;
 219         volatile u8  prog_interface;
 220         volatile u16 cmd;
 221         volatile u16 cmd_status;
 222         volatile u32 intr_loc;
 223         volatile u32 serr_loc;
 224         volatile u32 serr_intr_enable;
 225         volatile u32 slot1;
 226         volatile u32 slot2;
 227         volatile u32 slot3;
 228         volatile u32 slot4;
 229         volatile u32 slot5;
 230         volatile u32 slot6;
 231         volatile u32 slot7;
 232         volatile u32 slot8;
 233         volatile u32 slot9;
 234         volatile u32 slot10;
 235         volatile u32 slot11;
 236         volatile u32 slot12;
 237 } __attribute__ ((packed));
 238
 239 /* offsets to the controller registers based on the above structure layout */
 240 enum ctrl_offsets {
 241         BASE_OFFSET =   offsetof(struct ctrl_reg, base_offset),
 242         SLOT_AVAIL1 =   offsetof(struct ctrl_reg, slot_avail1),
 243         SLOT_AVAIL2     =       offsetof(struct ctrl_reg, slot_avail2),
 244         SLOT_CONFIG =   offsetof(struct ctrl_reg, slot_config),
 245         SEC_BUS_CONFIG =        offsetof(struct ctrl_reg, sec_bus_config),
 246         MSI_CTRL        =       offsetof(struct ctrl_reg, msi_ctrl),
 247         PROG_INTERFACE =        offsetof(struct ctrl_reg, prog_interface),
 248         CMD             =       offsetof(struct ctrl_reg, cmd),
 249         CMD_STATUS      =       offsetof(struct ctrl_reg, cmd_status),
 250         INTR_LOC        =       offsetof(struct ctrl_reg, intr_loc),
 251         SERR_LOC        =       offsetof(struct ctrl_reg, serr_loc),
 252         SERR_INTR_ENABLE =      offsetof(struct ctrl_reg, serr_intr_enable),
 253         SLOT1 =         offsetof(struct ctrl_reg, slot1),
 254         SLOT2 =         offsetof(struct ctrl_reg, slot2),
 255         SLOT3 =         offsetof(struct ctrl_reg, slot3),
 256         SLOT4 =         offsetof(struct ctrl_reg, slot4),
 257         SLOT5 =         offsetof(struct ctrl_reg, slot5),
 258         SLOT6 =         offsetof(struct ctrl_reg, slot6),
 259         SLOT7 =         offsetof(struct ctrl_reg, slot7),
 260         SLOT8 =         offsetof(struct ctrl_reg, slot8),
 261         SLOT9 =         offsetof(struct ctrl_reg, slot9),
 262         SLOT10 =        offsetof(struct ctrl_reg, slot10),
 263         SLOT11 =        offsetof(struct ctrl_reg, slot11),
 264         SLOT12 =        offsetof(struct ctrl_reg, slot12),
 265 };
 266 typedef u8(*php_intr_callback_t) (unsigned int change_id, void *instance_id);
 267 struct php_ctlr_state_s {
 268         struct php_ctlr_state_s *pnext;
 269         struct pci_dev *pci_dev;
 270         unsigned int irq;
 271         unsigned long flags;    /* spinlock's */
 272         u32 slot_device_offset;
 273         u32 num_slots;
 274         struct timer_list       int_poll_timer; /* Added for poll event */
 275         php_intr_callback_t attention_button_callback;
 276         php_intr_callback_t switch_change_callback;
 277         php_intr_callback_t presence_change_callback;
 278         php_intr_callback_t power_fault_callback;
 279         void *callback_instance_id;
 280         void __iomem *creg;                     /* Ptr to controller register space */
 281 };
 282 /* Inline functions */
 283
 284
 285 /* Inline functions to check the sanity of a pointer that is passed to us */
 286 static inline int slot_paranoia_check (struct slot *slot, const char *function)
 287 {
 288         if (!slot) {
 289                 dbg("%s - slot == NULL", function);
 290                 return -1;
 291         }
 292         if (slot->magic != SLOT_MAGIC) {
 293                 dbg("%s - bad magic number for slot", function);
 294                 return -1;
 295         }
 296         if (!slot->hotplug_slot) {
 297                 dbg("%s - slot->hotplug_slot == NULL!", function);
 298                 return -1;
 299         }
 300         return 0;
 301 }
 302
 303 static inline struct slot *get_slot (struct hotplug_slot *hotplug_slot, const char *function)
 304 {
 305         struct slot *slot;
 306
 307         if (!hotplug_slot) {
 308                 dbg("%s - hotplug_slot == NULL\n", function);
 309                 return NULL;
 310         }
 311
 312         slot = (struct slot *)hotplug_slot->private;
 313         if (slot_paranoia_check (slot, function))
 314                 return NULL;
 315         return slot;
 316 }
 317
 318 static inline struct slot *shpchp_find_slot (struct controller *ctrl, u8 device)
 319 {
 320         struct slot *p_slot, *tmp_slot = NULL;
 321
 322         if (!ctrl)
 323                 return NULL;
 324
 325         p_slot = ctrl->slot;
 326
 327         dbg("p_slot = %p\n", p_slot);
 328
 329         while (p_slot && (p_slot->device != device)) {
 330                 tmp_slot = p_slot;
 331                 p_slot = p_slot->next;
 332                 dbg("In while loop, p_slot = %p\n", p_slot);
 333         }
 334         if (p_slot == NULL) {
 335                 err("ERROR: shpchp_find_slot device=0x%x\n", device);
 336                 p_slot = tmp_slot;
 337         }
 338
 339         return (p_slot);
 340 }
 341
 342 static inline int wait_for_ctrl_irq (struct controller *ctrl)
 343 {
 344     DECLARE_WAITQUEUE(wait, current);
 345         int retval = 0;
 346
 347         dbg("%s : start\n",__FUNCTION__);
 348
 349         add_wait_queue(&ctrl->queue, &wait);
 350
 351         if (!shpchp_poll_mode) {
 352                 /* Sleep for up to 1 second */
 353                 msleep_interruptible(1000);
 354         } else {
 355                 /* Sleep for up to 2 seconds */
 356                 msleep_interruptible(2000);
 357         }
 358         remove_wait_queue(&ctrl->queue, &wait);
 359         if (signal_pending(current))
 360                 retval =  -EINTR;
 361
 362         dbg("%s : end\n", __FUNCTION__);
 363         return retval;
 364 }
 365
 366 #define SLOT_NAME_SIZE 10
 367
 368 static inline void make_slot_name(char *buffer, int buffer_size, struct slot *slot)
 369 {
 370         snprintf(buffer, buffer_size, "%04d_%04d", slot->bus, slot->number);
 371 }
 372
 373 enum php_ctlr_type {
 374         PCI,
 375         ISA,
 376         ACPI
 377 };
 378
 379 int shpc_init( struct controller *ctrl, struct pci_dev *pdev,
 380                 php_intr_callback_t attention_button_callback,
 381                 php_intr_callback_t switch_change_callback,
 382                 php_intr_callback_t presence_change_callback,
 383                 php_intr_callback_t power_fault_callback);
 384
 385 int shpc_get_ctlr_slot_config( struct controller *ctrl,
 386                 int *num_ctlr_slots,
 387                 int *first_device_num,
 388                 int *physical_slot_num,
 389                 int *updown,
 390                 int *flags);
 391
 392 struct hpc_ops {
 393         int     (*power_on_slot )               (struct slot *slot);
 394         int     (*slot_enable )                 (struct slot *slot);
 395         int     (*slot_disable )                (struct slot *slot);
 396         int     (*enable_all_slots)             (struct slot *slot);
 397         int     (*pwr_on_all_slots)             (struct slot *slot);
 398         int     (*set_bus_speed_mode)   (struct slot *slot, enum pci_bus_speed speed);
 399         int     (*get_power_status)             (struct slot *slot, u8 *status);
 400         int     (*get_attention_status) (struct slot *slot, u8 *status);
 401         int     (*set_attention_status) (struct slot *slot, u8 status);
 402         int     (*get_latch_status)             (struct slot *slot, u8 *status);
 403         int     (*get_adapter_status)   (struct slot *slot, u8 *status);
 404
 405         int     (*get_max_bus_speed)    (struct slot *slot, enum pci_bus_speed *speed);
 406         int     (*get_cur_bus_speed)    (struct slot *slot, enum pci_bus_speed *speed);
 407         int     (*get_adapter_speed)    (struct slot *slot, enum pci_bus_speed *speed);
 408         int     (*get_mode1_ECC_cap)    (struct slot *slot, u8 *mode);
 409         int     (*get_prog_int)                 (struct slot *slot, u8 *prog_int);
 410
 411         int     (*query_power_fault)    (struct slot *slot);
 412         void    (*green_led_on)         (struct slot *slot);
 413         void    (*green_led_off)        (struct slot *slot);
 414         void    (*green_led_blink)      (struct slot *slot);
 415         void    (*release_ctlr)         (struct controller *ctrl);
 416         int (*check_cmd_status)         (struct controller *ctrl);
 417 };
 418
 419 #endif                          /* _SHPCHP_H */