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