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/pci_hotplug.h>
  35 #include <linux/delay.h>
  36 #include <linux/sched.h>                /* signal_pending() */
  37 #include <linux/pcieport_if.h>
  38 #include <linux/mutex.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 extern int pciehp_force;
  46
  47 /*#define dbg(format, arg...) do { if (pciehp_debug) printk(KERN_DEBUG "%s: " format, MY_NAME , ## arg); } while (0)*/
  48 #define dbg(format, arg...) do { if (pciehp_debug) printk("%s: " format, MY_NAME , ## arg); } while (0)
  49 #define err(format, arg...) printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
  50 #define info(format, arg...) printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
  51 #define warn(format, arg...) printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
  52
  53 #define SLOT_NAME_SIZE 10
  54 struct slot {
  55         u8 bus;
  56         u8 device;
  57         u32 number;
  58         u8 state;
  59         struct timer_list task_event;
  60         u8 hp_slot;
  61         struct controller *ctrl;
  62         struct hpc_ops *hpc_ops;
  63         struct hotplug_slot *hotplug_slot;
  64         struct list_head        slot_list;
  65         char name[SLOT_NAME_SIZE];
  66 };
  67
  68 struct event_info {
  69         u32 event_type;
  70         u8 hp_slot;
  71 };
  72
  73 #define MAX_EVENTS              10
  74 struct controller {
  75         struct controller *next;
  76         struct mutex crit_sect;         /* critical section mutex */
  77         struct mutex ctrl_lock;         /* controller lock */
  78         int num_slots;                  /* Number of slots on ctlr */
  79         int slot_num_inc;               /* 1 or -1 */
  80         struct pci_dev *pci_dev;
  81         struct list_head slot_list;
  82         struct event_info event_queue[MAX_EVENTS];
  83         struct slot *slot;
  84         struct hpc_ops *hpc_ops;
  85         wait_queue_head_t queue;        /* sleep & wake process */
  86         u8 next_event;
  87         u8 bus;
  88         u8 device;
  89         u8 function;
  90         u8 slot_device_offset;
  91         u32 first_slot;         /* First physical slot number */  /* PCIE only has 1 slot */
  92         u8 slot_bus;            /* Bus where the slots handled by this controller sit */
  93         u8 ctrlcap;
  94         u16 vendor_id;
  95         u8 cap_base;
  96         struct timer_list poll_timer;
  97 };
  98
  99 #define INT_BUTTON_IGNORE               0
 100 #define INT_PRESENCE_ON                 1
 101 #define INT_PRESENCE_OFF                2
 102 #define INT_SWITCH_CLOSE                3
 103 #define INT_SWITCH_OPEN                 4
 104 #define INT_POWER_FAULT                 5
 105 #define INT_POWER_FAULT_CLEAR           6
 106 #define INT_BUTTON_PRESS                7
 107 #define INT_BUTTON_RELEASE              8
 108 #define INT_BUTTON_CANCEL               9
 109
 110 #define STATIC_STATE                    0
 111 #define BLINKINGON_STATE                1
 112 #define BLINKINGOFF_STATE               2
 113 #define POWERON_STATE                   3
 114 #define POWEROFF_STATE                  4
 115
 116 #define PCI_TO_PCI_BRIDGE_CLASS         0x00060400
 117
 118 /* Error messages */
 119 #define INTERLOCK_OPEN                  0x00000002
 120 #define ADD_NOT_SUPPORTED               0x00000003
 121 #define CARD_FUNCTIONING                0x00000005
 122 #define ADAPTER_NOT_SAME                0x00000006
 123 #define NO_ADAPTER_PRESENT              0x00000009
 124 #define NOT_ENOUGH_RESOURCES            0x0000000B
 125 #define DEVICE_TYPE_NOT_SUPPORTED       0x0000000C
 126 #define WRONG_BUS_FREQUENCY             0x0000000D
 127 #define POWER_FAILURE                   0x0000000E
 128
 129 #define REMOVE_NOT_SUPPORTED            0x00000003
 130
 131 #define DISABLE_CARD                    1
 132
 133 /* Field definitions in Slot Capabilities Register */
 134 #define ATTN_BUTTN_PRSN 0x00000001
 135 #define PWR_CTRL_PRSN   0x00000002
 136 #define MRL_SENS_PRSN   0x00000004
 137 #define ATTN_LED_PRSN   0x00000008
 138 #define PWR_LED_PRSN    0x00000010
 139 #define HP_SUPR_RM_SUP  0x00000020
 140
 141 #define ATTN_BUTTN(cap)         (cap & ATTN_BUTTN_PRSN)
 142 #define POWER_CTRL(cap)         (cap & PWR_CTRL_PRSN)
 143 #define MRL_SENS(cap)           (cap & MRL_SENS_PRSN)
 144 #define ATTN_LED(cap)           (cap & ATTN_LED_PRSN)
 145 #define PWR_LED(cap)            (cap & PWR_LED_PRSN)
 146 #define HP_SUPR_RM(cap)         (cap & HP_SUPR_RM_SUP)
 147
 148 /*
 149  * error Messages
 150  */
 151 #define msg_initialization_err  "Initialization failure, error=%d\n"
 152 #define msg_button_on           "PCI slot #%s - powering on due to button press.\n"
 153 #define msg_button_off          "PCI slot #%s - powering off due to button press.\n"
 154 #define msg_button_cancel       "PCI slot #%s - action canceled due to button press.\n"
 155 #define msg_button_ignore       "PCI slot #%s - button press ignored.  (action in progress...)\n"
 156
 157 /* controller functions */
 158 extern int      pciehp_event_start_thread       (void);
 159 extern void     pciehp_event_stop_thread        (void);
 160 extern int      pciehp_enable_slot              (struct slot *slot);
 161 extern int      pciehp_disable_slot             (struct slot *slot);
 162
 163 extern u8 pciehp_handle_attention_button(u8 hp_slot, struct controller *ctrl);
 164 extern u8 pciehp_handle_switch_change(u8 hp_slot, struct controller *ctrl);
 165 extern u8 pciehp_handle_presence_change(u8 hp_slot, struct controller *ctrl);
 166 extern u8 pciehp_handle_power_fault(u8 hp_slot, struct controller *ctrl);
 167 /* extern void  long_delay (int delay); */
 168
 169 /* pci functions */
 170 extern int      pciehp_configure_device         (struct slot *p_slot);
 171 extern int      pciehp_unconfigure_device       (struct slot *p_slot);
 172
 173
 174
 175 /* Global variables */
 176 extern struct controller *pciehp_ctrl_list;
 177
 178 /* Inline functions */
 179
 180 static inline struct slot *pciehp_find_slot(struct controller *ctrl, u8 device)
 181 {
 182         struct slot *slot;
 183
 184         list_for_each_entry(slot, &ctrl->slot_list, slot_list) {
 185                 if (slot->device == device)
 186                         return slot;
 187         }
 188
 189         err("%s: slot (device=0x%x) not found\n", __FUNCTION__, device);
 190         return NULL;
 191 }
 192
 193 static inline int wait_for_ctrl_irq(struct controller *ctrl)
 194 {
 195         int retval = 0;
 196
 197         DECLARE_WAITQUEUE(wait, current);
 198
 199         add_wait_queue(&ctrl->queue, &wait);
 200         if (!pciehp_poll_mode)
 201                 /* Sleep for up to 1 second */
 202                 msleep_interruptible(1000);
 203         else
 204                 msleep_interruptible(2500);
 205
 206         remove_wait_queue(&ctrl->queue, &wait);
 207         if (signal_pending(current))
 208                 retval =  -EINTR;
 209
 210         return retval;
 211 }
 212
 213 int pcie_init(struct controller *ctrl, struct pcie_device *dev);
 214
 215 struct hpc_ops {
 216         int     (*power_on_slot)        (struct slot *slot);
 217         int     (*power_off_slot)       (struct slot *slot);
 218         int     (*get_power_status)     (struct slot *slot, u8 *status);
 219         int     (*get_attention_status) (struct slot *slot, u8 *status);
 220         int     (*set_attention_status) (struct slot *slot, u8 status);
 221         int     (*get_latch_status)     (struct slot *slot, u8 *status);
 222         int     (*get_adapter_status)   (struct slot *slot, u8 *status);
 223
 224         int     (*get_max_bus_speed)    (struct slot *slot, enum pci_bus_speed *speed);
 225         int     (*get_cur_bus_speed)    (struct slot *slot, enum pci_bus_speed *speed);
 226
 227         int     (*get_max_lnk_width)    (struct slot *slot, enum pcie_link_width *value);
 228         int     (*get_cur_lnk_width)    (struct slot *slot, enum pcie_link_width *value);
 229
 230         int     (*query_power_fault)    (struct slot *slot);
 231         void    (*green_led_on)         (struct slot *slot);
 232         void    (*green_led_off)        (struct slot *slot);
 233         void    (*green_led_blink)      (struct slot *slot);
 234         void    (*release_ctlr)         (struct controller *ctrl);
 235         int     (*check_lnk_status)     (struct controller *ctrl);
 236 };
 237
 238
 239 #ifdef CONFIG_ACPI
 240 #include <acpi/acpi.h>
 241 #include <acpi/acpi_bus.h>
 242 #include <acpi/actypes.h>
 243 #include <linux/pci-acpi.h>
 244
 245 #define pciehp_get_hp_hw_control_from_firmware(dev) \
 246         pciehp_acpi_get_hp_hw_control_from_firmware(dev)
 247 static inline int pciehp_get_hp_params_from_firmware(struct pci_dev *dev,
 248                         struct hotplug_params *hpp)
 249 {
 250         if (ACPI_FAILURE(acpi_get_hp_params_from_firmware(dev->bus, hpp)))
 251                 return -ENODEV;
 252         return 0;
 253 }
 254 #else
 255 #define pciehp_get_hp_hw_control_from_firmware(dev)     0
 256 #define pciehp_get_hp_params_from_firmware(dev, hpp)    (-ENODEV)
 257 #endif                          /* CONFIG_ACPI */
 258 #endif                          /* _PCIEHP_H */