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