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...)                                             \
  48         do {                                                            \
  49                 if (pciehp_debug)                                       \
  50                         printk("%s: " format, MY_NAME , ## arg);        \
  51         } while (0)
  52 #define err(format, arg...)                                             \
  53         printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
  54 #define info(format, arg...)                                            \
  55         printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
  56 #define warn(format, arg...)                                            \
  57         printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
  58
  59 #define SLOT_NAME_SIZE 10
  60 struct slot {
  61         u8 bus;
  62         u8 device;
  63         u32 number;
  64         u8 state;
  65         struct timer_list task_event;
  66         u8 hp_slot;
  67         struct controller *ctrl;
  68         struct hpc_ops *hpc_ops;
  69         struct hotplug_slot *hotplug_slot;
  70         struct list_head        slot_list;
  71         char name[SLOT_NAME_SIZE];
  72 };
  73
  74 struct event_info {
  75         u32 event_type;
  76         u8 hp_slot;
  77 };
  78
  79 #define MAX_EVENTS              10
  80 struct controller {
  81         struct controller *next;
  82         struct mutex crit_sect;         /* critical section mutex */
  83         struct mutex ctrl_lock;         /* controller lock */
  84         int num_slots;                  /* Number of slots on ctlr */
  85         int slot_num_inc;               /* 1 or -1 */
  86         struct pci_dev *pci_dev;
  87         struct list_head slot_list;
  88         struct event_info event_queue[MAX_EVENTS];
  89         struct slot *slot;
  90         struct hpc_ops *hpc_ops;
  91         wait_queue_head_t queue;        /* sleep & wake process */
  92         u8 next_event;
  93         u8 bus;
  94         u8 device;
  95         u8 function;
  96         u8 slot_device_offset;
  97         u32 first_slot;         /* First physical slot number */  /* PCIE only has 1 slot */
  98         u8 slot_bus;            /* Bus where the slots handled by this controller sit */
  99         u8 ctrlcap;
 100         u16 vendor_id;
 101         u8 cap_base;
 102         struct timer_list poll_timer;
 103 };
 104
 105 #define INT_BUTTON_IGNORE               0
 106 #define INT_PRESENCE_ON                 1
 107 #define INT_PRESENCE_OFF                2
 108 #define INT_SWITCH_CLOSE                3
 109 #define INT_SWITCH_OPEN                 4
 110 #define INT_POWER_FAULT                 5
 111 #define INT_POWER_FAULT_CLEAR           6
 112 #define INT_BUTTON_PRESS                7
 113 #define INT_BUTTON_RELEASE              8
 114 #define INT_BUTTON_CANCEL               9
 115
 116 #define STATIC_STATE                    0
 117 #define BLINKINGON_STATE                1
 118 #define BLINKINGOFF_STATE               2
 119 #define POWERON_STATE                   3
 120 #define POWEROFF_STATE                  4
 121
 122 /* Error messages */
 123 #define INTERLOCK_OPEN                  0x00000002
 124 #define ADD_NOT_SUPPORTED               0x00000003
 125 #define CARD_FUNCTIONING                0x00000005
 126 #define ADAPTER_NOT_SAME                0x00000006
 127 #define NO_ADAPTER_PRESENT              0x00000009
 128 #define NOT_ENOUGH_RESOURCES            0x0000000B
 129 #define DEVICE_TYPE_NOT_SUPPORTED       0x0000000C
 130 #define WRONG_BUS_FREQUENCY             0x0000000D
 131 #define POWER_FAILURE                   0x0000000E
 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 extern int pciehp_event_start_thread(void);
 149 extern void pciehp_event_stop_thread(void);
 150 extern int pciehp_enable_slot(struct slot *slot);
 151 extern int pciehp_disable_slot(struct slot *slot);
 152 extern u8 pciehp_handle_attention_button(u8 hp_slot, struct controller *ctrl);
 153 extern u8 pciehp_handle_switch_change(u8 hp_slot, struct controller *ctrl);
 154 extern u8 pciehp_handle_presence_change(u8 hp_slot, struct controller *ctrl);
 155 extern u8 pciehp_handle_power_fault(u8 hp_slot, struct controller *ctrl);
 156 extern int pciehp_configure_device(struct slot *p_slot);
 157 extern int pciehp_unconfigure_device(struct slot *p_slot);
 158 int pcie_init(struct controller *ctrl, struct pcie_device *dev);
 159
 160 /* Global variables */
 161 extern struct controller *pciehp_ctrl_list;
 162
 163 static inline struct slot *pciehp_find_slot(struct controller *ctrl, u8 device)
 164 {
 165         struct slot *slot;
 166
 167         list_for_each_entry(slot, &ctrl->slot_list, slot_list) {
 168                 if (slot->device == device)
 169                         return slot;
 170         }
 171
 172         err("%s: slot (device=0x%x) not found\n", __FUNCTION__, device);
 173         return NULL;
 174 }
 175
 176 struct hpc_ops {
 177         int (*power_on_slot)(struct slot *slot);
 178         int (*power_off_slot)(struct slot *slot);
 179         int (*get_power_status)(struct slot *slot, u8 *status);
 180         int (*get_attention_status)(struct slot *slot, u8 *status);
 181         int (*set_attention_status)(struct slot *slot, u8 status);
 182         int (*get_latch_status)(struct slot *slot, u8 *status);
 183         int (*get_adapter_status)(struct slot *slot, u8 *status);
 184         int (*get_max_bus_speed)(struct slot *slot, enum pci_bus_speed *speed);
 185         int (*get_cur_bus_speed)(struct slot *slot, enum pci_bus_speed *speed);
 186         int (*get_max_lnk_width)(struct slot *slot, enum pcie_link_width *val);
 187         int (*get_cur_lnk_width)(struct slot *slot, enum pcie_link_width *val);
 188         int (*query_power_fault)(struct slot *slot);
 189         void (*green_led_on)(struct slot *slot);
 190         void (*green_led_off)(struct slot *slot);
 191         void (*green_led_blink)(struct slot *slot);
 192         void (*release_ctlr)(struct controller *ctrl);
 193         int (*check_lnk_status)(struct controller *ctrl);
 194 };
 195
 196 #ifdef CONFIG_ACPI
 197 #include <acpi/acpi.h>
 198 #include <acpi/acpi_bus.h>
 199 #include <acpi/actypes.h>
 200 #include <linux/pci-acpi.h>
 201
 202 #define pciehp_get_hp_hw_control_from_firmware(dev)                     \
 203         pciehp_acpi_get_hp_hw_control_from_firmware(dev)
 204 static inline int pciehp_get_hp_params_from_firmware(struct pci_dev *dev,
 205                         struct hotplug_params *hpp)
 206 {
 207         if (ACPI_FAILURE(acpi_get_hp_params_from_firmware(dev->bus, hpp)))
 208                 return -ENODEV;
 209         return 0;
 210 }
 211 #else
 212 #define pciehp_get_hp_hw_control_from_firmware(dev)     0
 213 #define pciehp_get_hp_params_from_firmware(dev, hpp)    (-ENODEV)
 214 #endif                          /* CONFIG_ACPI */
 215 #endif                          /* _PCIEHP_H */