err.no Git - linux-2.6/blob - drivers/pci/hotplug/pciehp.h

   1 /*
   2  * PCI Express 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 Corp.
   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 _PCIEHP_H
  30 #define _PCIEHP_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 <linux/pcieport_if.h>
  38 #include "pci_hotplug.h"
  39
  40 #define MY_NAME "pciehp"
  41
  42 extern int pciehp_poll_mode;
  43 extern int pciehp_poll_time;
  44 extern int pciehp_debug;
  45
  46 /*#define dbg(format, arg...) do { if (pciehp_debug) printk(KERN_DEBUG "%s: " format, MY_NAME , ## arg); } while (0)*/
  47 #define dbg(format, arg...) do { if (pciehp_debug) printk("%s: " format, MY_NAME , ## arg); } while (0)
  48 #define err(format, arg...) printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
  49 #define info(format, arg...) printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
  50 #define warn(format, arg...) printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
  51
  52 struct hotplug_params {
  53         u8 cache_line_size;
  54         u8 latency_timer;
  55         u8 enable_serr;
  56         u8 enable_perr;
  57 };
  58
  59 struct slot {
  60         struct slot *next;
  61         u8 bus;
  62         u8 device;
  63         u16 status;
  64         u32 number;
  65         u8 is_a_board;
  66         u8 configured;
  67         u8 state;
  68         u8 switch_save;
  69         u8 presence_save;
  70         u32 capabilities;
  71         u16 reserved2;
  72         struct timer_list task_event;
  73         u8 hp_slot;
  74         struct controller *ctrl;
  75         struct hpc_ops *hpc_ops;
  76         struct hotplug_slot *hotplug_slot;
  77         struct list_head        slot_list;
  78 };
  79
  80 struct event_info {
  81         u32 event_type;
  82         u8 hp_slot;
  83 };
  84
  85 struct controller {
  86         struct controller *next;
  87         struct semaphore crit_sect;     /* critical section semaphore */
  88         void *hpc_ctlr_handle;          /* HPC controller handle */
  89         int num_slots;                  /* Number of slots on ctlr */
  90         int slot_num_inc;               /* 1 or -1 */
  91         struct pci_dev *pci_dev;
  92         struct pci_bus *pci_bus;
  93         struct event_info event_queue[10];
  94         struct slot *slot;
  95         struct hpc_ops *hpc_ops;
  96         wait_queue_head_t queue;        /* sleep & wake process */
  97         u8 next_event;
  98         u8 seg;
  99         u8 bus;
 100         u8 device;
 101         u8 function;
 102         u8 rev;
 103         u8 slot_device_offset;
 104         u8 add_support;
 105         enum pci_bus_speed speed;
 106         u32 first_slot;         /* First physical slot number */  /* PCIE only has 1 slot */
 107         u8 slot_bus;            /* Bus where the slots handled by this controller sit */
 108         u8 ctrlcap;
 109         u16 vendor_id;
 110         u8 cap_base;
 111 };
 112
 113 #define INT_BUTTON_IGNORE               0
 114 #define INT_PRESENCE_ON                 1
 115 #define INT_PRESENCE_OFF                2
 116 #define INT_SWITCH_CLOSE                3
 117 #define INT_SWITCH_OPEN                 4
 118 #define INT_POWER_FAULT                 5
 119 #define INT_POWER_FAULT_CLEAR           6
 120 #define INT_BUTTON_PRESS                7
 121 #define INT_BUTTON_RELEASE              8
 122 #define INT_BUTTON_CANCEL               9
 123
 124 #define STATIC_STATE                    0
 125 #define BLINKINGON_STATE                1
 126 #define BLINKINGOFF_STATE               2
 127 #define POWERON_STATE                   3
 128 #define POWEROFF_STATE                  4
 129
 130 #define PCI_TO_PCI_BRIDGE_CLASS         0x00060400
 131
 132 /* Error messages */
 133 #define INTERLOCK_OPEN                  0x00000002
 134 #define ADD_NOT_SUPPORTED               0x00000003
 135 #define CARD_FUNCTIONING                0x00000005
 136 #define ADAPTER_NOT_SAME                0x00000006
 137 #define NO_ADAPTER_PRESENT              0x00000009
 138 #define NOT_ENOUGH_RESOURCES            0x0000000B
 139 #define DEVICE_TYPE_NOT_SUPPORTED       0x0000000C
 140 #define WRONG_BUS_FREQUENCY             0x0000000D
 141 #define POWER_FAILURE                   0x0000000E
 142
 143 #define REMOVE_NOT_SUPPORTED            0x00000003
 144
 145 #define DISABLE_CARD                    1
 146
 147 /* Field definitions in Slot Capabilities Register */
 148 #define ATTN_BUTTN_PRSN 0x00000001
 149 #define PWR_CTRL_PRSN   0x00000002
 150 #define MRL_SENS_PRSN   0x00000004
 151 #define ATTN_LED_PRSN   0x00000008
 152 #define PWR_LED_PRSN    0x00000010
 153 #define HP_SUPR_RM_SUP  0x00000020
 154
 155 #define ATTN_BUTTN(cap)         (cap & ATTN_BUTTN_PRSN)
 156 #define POWER_CTRL(cap)         (cap & PWR_CTRL_PRSN)
 157 #define MRL_SENS(cap)           (cap & MRL_SENS_PRSN)
 158 #define ATTN_LED(cap)           (cap & ATTN_LED_PRSN)
 159 #define PWR_LED(cap)            (cap & PWR_LED_PRSN)
 160 #define HP_SUPR_RM(cap)         (cap & HP_SUPR_RM_SUP)
 161
 162 /*
 163  * error Messages
 164  */
 165 #define msg_initialization_err  "Initialization failure, error=%d\n"
 166 #define msg_button_on           "PCI slot #%d - powering on due to button press.\n"
 167 #define msg_button_off          "PCI slot #%d - powering off due to button press.\n"
 168 #define msg_button_cancel       "PCI slot #%d - action canceled due to button press.\n"
 169 #define msg_button_ignore       "PCI slot #%d - button press ignored.  (action in progress...)\n"
 170
 171 /* controller functions */
 172 extern int      pciehp_event_start_thread       (void);
 173 extern void     pciehp_event_stop_thread        (void);
 174 extern int      pciehp_enable_slot              (struct slot *slot);
 175 extern int      pciehp_disable_slot             (struct slot *slot);
 176
 177 extern u8       pciehp_handle_attention_button  (u8 hp_slot, void *inst_id);
 178 extern u8       pciehp_handle_switch_change     (u8 hp_slot, void *inst_id);
 179 extern u8       pciehp_handle_presence_change   (u8 hp_slot, void *inst_id);
 180 extern u8       pciehp_handle_power_fault       (u8 hp_slot, void *inst_id);
 181 /* extern void  long_delay (int delay); */
 182
 183 /* pci functions */
 184 extern int      pciehp_configure_device         (struct slot *p_slot);
 185 extern int      pciehp_unconfigure_device       (struct slot *p_slot);
 186 extern int      get_hp_hw_control_from_firmware(struct pci_dev *dev);
 187 extern void     get_hp_params_from_firmware(struct pci_dev *dev,
 188                 struct hotplug_params *hpp);
 189
 190
 191
 192 /* Global variables */
 193 extern struct controller *pciehp_ctrl_list;
 194
 195 /* Inline functions */
 196
 197 static inline struct slot *pciehp_find_slot(struct controller *ctrl, u8 device)
 198 {
 199         struct slot *p_slot, *tmp_slot = NULL;
 200
 201         p_slot = ctrl->slot;
 202
 203         dbg("p_slot = %p\n", p_slot);
 204
 205         while (p_slot && (p_slot->device != device)) {
 206                 tmp_slot = p_slot;
 207                 p_slot = p_slot->next;
 208                 dbg("In while loop, p_slot = %p\n", p_slot);
 209         }
 210         if (p_slot == NULL) {
 211                 err("ERROR: pciehp_find_slot device=0x%x\n", device);
 212                 p_slot = tmp_slot;
 213         }
 214
 215         return p_slot;
 216 }
 217
 218 static inline int wait_for_ctrl_irq(struct controller *ctrl)
 219 {
 220         int retval = 0;
 221
 222         DECLARE_WAITQUEUE(wait, current);
 223
 224         dbg("%s : start\n", __FUNCTION__);
 225         add_wait_queue(&ctrl->queue, &wait);
 226         if (!pciehp_poll_mode)
 227                 /* Sleep for up to 1 second */
 228                 msleep_interruptible(1000);
 229         else
 230                 msleep_interruptible(2500);
 231
 232         remove_wait_queue(&ctrl->queue, &wait);
 233         if (signal_pending(current))
 234                 retval =  -EINTR;
 235
 236         dbg("%s : end\n", __FUNCTION__);
 237         return retval;
 238 }
 239
 240 #define SLOT_NAME_SIZE 10
 241
 242 static inline void make_slot_name(char *buffer, int buffer_size, struct slot *slot)
 243 {
 244         snprintf(buffer, buffer_size, "%04d_%04d", slot->bus, slot->number);
 245 }
 246
 247 enum php_ctlr_type {
 248         PCI,
 249         ISA,
 250         ACPI
 251 };
 252
 253 typedef u8(*php_intr_callback_t) (unsigned int change_id, void *instance_id);
 254
 255 int pcie_init(struct controller *ctrl, struct pcie_device *dev,
 256                 php_intr_callback_t attention_button_callback,
 257                 php_intr_callback_t switch_change_callback,
 258                 php_intr_callback_t presence_change_callback,
 259                 php_intr_callback_t power_fault_callback);
 260
 261
 262 /* This has no meaning for PCI Express, as there is only 1 slot per port */
 263 int pcie_get_ctlr_slot_config(struct controller *ctrl,
 264                 int *num_ctlr_slots,
 265                 int *first_device_num,
 266                 int *physical_slot_num,
 267                 u8 *ctrlcap);
 268
 269 struct hpc_ops {
 270         int     (*power_on_slot)        (struct slot *slot);
 271         int     (*power_off_slot)       (struct slot *slot);
 272         int     (*get_power_status)     (struct slot *slot, u8 *status);
 273         int     (*get_attention_status) (struct slot *slot, u8 *status);
 274         int     (*set_attention_status) (struct slot *slot, u8 status);
 275         int     (*get_latch_status)     (struct slot *slot, u8 *status);
 276         int     (*get_adapter_status)   (struct slot *slot, u8 *status);
 277
 278         int     (*get_max_bus_speed)    (struct slot *slot, enum pci_bus_speed *speed);
 279         int     (*get_cur_bus_speed)    (struct slot *slot, enum pci_bus_speed *speed);
 280
 281         int     (*get_max_lnk_width)    (struct slot *slot, enum pcie_link_width *value);
 282         int     (*get_cur_lnk_width)    (struct slot *slot, enum pcie_link_width *value);
 283
 284         int     (*query_power_fault)    (struct slot *slot);
 285         void    (*green_led_on)         (struct slot *slot);
 286         void    (*green_led_off)        (struct slot *slot);
 287         void    (*green_led_blink)      (struct slot *slot);
 288         void    (*release_ctlr)         (struct controller *ctrl);
 289         int     (*check_lnk_status)     (struct controller *ctrl);
 290 };
 291
 292 #endif                          /* _PCIEHP_H */