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