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 unsigned long last_emi_toggle; 73 }; 74 75 struct event_info { 76 u32 event_type; 77 u8 hp_slot; 78 }; 79 80 #define MAX_EVENTS 10 81 struct controller { 82 struct controller *next; 83 struct mutex crit_sect; /* critical section mutex */ 84 struct mutex ctrl_lock; /* controller lock */ 85 int num_slots; /* Number of slots on ctlr */ 86 int slot_num_inc; /* 1 or -1 */ 87 struct pci_dev *pci_dev; 88 struct list_head slot_list; 89 struct event_info event_queue[MAX_EVENTS]; 90 struct slot *slot; 91 struct hpc_ops *hpc_ops; 92 wait_queue_head_t queue; /* sleep & wake process */ 93 u8 next_event; 94 u8 bus; 95 u8 device; 96 u8 function; 97 u8 slot_device_offset; 98 u32 first_slot; /* First physical slot number */ /* PCIE only has 1 slot */ 99 u8 slot_bus; /* Bus where the slots handled by this controller sit */ 100 u8 ctrlcap; 101 u16 vendor_id; 102 u8 cap_base; 103 struct timer_list poll_timer; 104 volatile int cmd_busy; 105 }; 106 107 #define INT_BUTTON_IGNORE 0 108 #define INT_PRESENCE_ON 1 109 #define INT_PRESENCE_OFF 2 110 #define INT_SWITCH_CLOSE 3 111 #define INT_SWITCH_OPEN 4 112 #define INT_POWER_FAULT 5 113 #define INT_POWER_FAULT_CLEAR 6 114 #define INT_BUTTON_PRESS 7 115 #define INT_BUTTON_RELEASE 8 116 #define INT_BUTTON_CANCEL 9 117 118 #define STATIC_STATE 0 119 #define BLINKINGON_STATE 1 120 #define BLINKINGOFF_STATE 2 121 #define POWERON_STATE 3 122 #define POWEROFF_STATE 4 123 124 /* Error messages */ 125 #define INTERLOCK_OPEN 0x00000002 126 #define ADD_NOT_SUPPORTED 0x00000003 127 #define CARD_FUNCTIONING 0x00000005 128 #define ADAPTER_NOT_SAME 0x00000006 129 #define NO_ADAPTER_PRESENT 0x00000009 130 #define NOT_ENOUGH_RESOURCES 0x0000000B 131 #define DEVICE_TYPE_NOT_SUPPORTED 0x0000000C 132 #define WRONG_BUS_FREQUENCY 0x0000000D 133 #define POWER_FAILURE 0x0000000E 134 135 /* Field definitions in Slot Capabilities Register */ 136 #define ATTN_BUTTN_PRSN 0x00000001 137 #define PWR_CTRL_PRSN 0x00000002 138 #define MRL_SENS_PRSN 0x00000004 139 #define ATTN_LED_PRSN 0x00000008 140 #define PWR_LED_PRSN 0x00000010 141 #define HP_SUPR_RM_SUP 0x00000020 142 #define EMI_PRSN 0x00020000 143 144 #define ATTN_BUTTN(cap) (cap & ATTN_BUTTN_PRSN) 145 #define POWER_CTRL(cap) (cap & PWR_CTRL_PRSN) 146 #define MRL_SENS(cap) (cap & MRL_SENS_PRSN) 147 #define ATTN_LED(cap) (cap & ATTN_LED_PRSN) 148 #define PWR_LED(cap) (cap & PWR_LED_PRSN) 149 #define HP_SUPR_RM(cap) (cap & HP_SUPR_RM_SUP) 150 #define EMI(cap) (cap & EMI_PRSN) 151 152 extern int pciehp_event_start_thread(void); 153 extern void pciehp_event_stop_thread(void); 154 extern int pciehp_enable_slot(struct slot *slot); 155 extern int pciehp_disable_slot(struct slot *slot); 156 extern u8 pciehp_handle_attention_button(u8 hp_slot, struct controller *ctrl); 157 extern u8 pciehp_handle_switch_change(u8 hp_slot, struct controller *ctrl); 158 extern u8 pciehp_handle_presence_change(u8 hp_slot, struct controller *ctrl); 159 extern u8 pciehp_handle_power_fault(u8 hp_slot, struct controller *ctrl); 160 extern int pciehp_configure_device(struct slot *p_slot); 161 extern int pciehp_unconfigure_device(struct slot *p_slot); 162 int pcie_init(struct controller *ctrl, struct pcie_device *dev); 163 164 /* Global variables */ 165 extern struct controller *pciehp_ctrl_list; 166 167 static inline struct slot *pciehp_find_slot(struct controller *ctrl, u8 device) 168 { 169 struct slot *slot; 170 171 list_for_each_entry(slot, &ctrl->slot_list, slot_list) { 172 if (slot->device == device) 173 return slot; 174 } 175 176 err("%s: slot (device=0x%x) not found\n", __FUNCTION__, device); 177 return NULL; 178 } 179 180 struct hpc_ops { 181 int (*power_on_slot)(struct slot *slot); 182 int (*power_off_slot)(struct slot *slot); 183 int (*get_power_status)(struct slot *slot, u8 *status); 184 int (*get_attention_status)(struct slot *slot, u8 *status); 185 int (*set_attention_status)(struct slot *slot, u8 status); 186 int (*get_latch_status)(struct slot *slot, u8 *status); 187 int (*get_adapter_status)(struct slot *slot, u8 *status); 188 int (*get_emi_status)(struct slot *slot, u8 *status); 189 int (*toggle_emi)(struct slot *slot); 190 int (*get_max_bus_speed)(struct slot *slot, enum pci_bus_speed *speed); 191 int (*get_cur_bus_speed)(struct slot *slot, enum pci_bus_speed *speed); 192 int (*get_max_lnk_width)(struct slot *slot, enum pcie_link_width *val); 193 int (*get_cur_lnk_width)(struct slot *slot, enum pcie_link_width *val); 194 int (*query_power_fault)(struct slot *slot); 195 void (*green_led_on)(struct slot *slot); 196 void (*green_led_off)(struct slot *slot); 197 void (*green_led_blink)(struct slot *slot); 198 void (*release_ctlr)(struct controller *ctrl); 199 int (*check_lnk_status)(struct controller *ctrl); 200 }; 201 202 #ifdef CONFIG_ACPI 203 #include <acpi/acpi.h> 204 #include <acpi/acpi_bus.h> 205 #include <acpi/actypes.h> 206 #include <linux/pci-acpi.h> 207 208 #define pciehp_get_hp_hw_control_from_firmware(dev) \ 209 pciehp_acpi_get_hp_hw_control_from_firmware(dev) 210 static inline int pciehp_get_hp_params_from_firmware(struct pci_dev *dev, 211 struct hotplug_params *hpp) 212 { 213 if (ACPI_FAILURE(acpi_get_hp_params_from_firmware(dev->bus, hpp))) 214 return -ENODEV; 215 return 0; 216 } 217 #else 218 #define pciehp_get_hp_hw_control_from_firmware(dev) 0 219 #define pciehp_get_hp_params_from_firmware(dev, hpp) (-ENODEV) 220 #endif /* CONFIG_ACPI */ 221 #endif /* _PCIEHP_H */ 222