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