blob: e3a1e7e7dba246b6bc35a16dbd8a0a3f00ee885e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 *
Kristen Accardi8cf4c192005-08-16 15:16:10 -070026 * Send feedback to <greg@kroah.com>, <kristen.c.accardi@intel.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027 *
28 */
29#ifndef _PCIEHP_H
30#define _PCIEHP_H
31
32#include <linux/types.h>
33#include <linux/pci.h>
Greg Kroah-Hartman7a54f252006-10-13 20:05:19 -070034#include <linux/pci_hotplug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/delay.h>
Tim Schmielaude259682006-01-08 01:02:05 -080036#include <linux/sched.h> /* signal_pending() */
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/pcieport_if.h>
Ingo Molnar6aa4cdd2006-01-13 16:02:15 +010038#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40#define MY_NAME "pciehp"
41
42extern int pciehp_poll_mode;
43extern int pciehp_poll_time;
44extern int pciehp_debug;
rajesh.shah@intel.coma3a45ec2005-10-31 16:20:12 -080045extern int pciehp_force;
Kenji Kaneshigec4635eb2008-06-20 12:07:08 +090046extern int pciehp_slot_with_bus;
Kenji Kaneshige5d386e12007-03-06 15:02:26 -080047extern struct workqueue_struct *pciehp_wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
Kenji Kaneshige15232ec2006-12-21 17:01:07 -080049#define dbg(format, arg...) \
50 do { \
51 if (pciehp_debug) \
52 printk("%s: " format, MY_NAME , ## arg); \
53 } while (0)
54#define err(format, arg...) \
55 printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
56#define info(format, arg...) \
57 printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
58#define warn(format, arg...) \
59 printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Kenji Kaneshigea0b17252006-12-21 17:01:02 -080061#define SLOT_NAME_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -070062struct slot {
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 u8 bus;
64 u8 device;
65 u32 number;
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 u8 state;
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 struct timer_list task_event;
68 u8 hp_slot;
69 struct controller *ctrl;
70 struct hpc_ops *hpc_ops;
71 struct hotplug_slot *hotplug_slot;
72 struct list_head slot_list;
Kenji Kaneshigea0b17252006-12-21 17:01:02 -080073 char name[SLOT_NAME_SIZE];
Kristen Carlson Accardi34d03412007-01-09 13:02:36 -080074 unsigned long last_emi_toggle;
Kenji Kaneshige5d386e12007-03-06 15:02:26 -080075 struct delayed_work work; /* work for button event */
76 struct mutex lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070077};
78
Linus Torvalds1da177e2005-04-16 15:20:36 -070079struct event_info {
80 u32 event_type;
Kenji Kaneshige5d386e12007-03-06 15:02:26 -080081 struct slot *p_slot;
82 struct work_struct work;
Linus Torvalds1da177e2005-04-16 15:20:36 -070083};
84
85struct controller {
Ingo Molnar6aa4cdd2006-01-13 16:02:15 +010086 struct mutex crit_sect; /* critical section mutex */
Kenji Kaneshigedd5619c2006-09-22 10:17:29 -070087 struct mutex ctrl_lock; /* controller lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 int num_slots; /* Number of slots on ctlr */
89 int slot_num_inc; /* 1 or -1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 struct pci_dev *pci_dev;
Kenji Kaneshige2410fa42006-12-21 17:01:03 -080091 struct list_head slot_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 struct hpc_ops *hpc_ops;
93 wait_queue_head_t queue; /* sleep & wake process */
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 u8 slot_device_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 u32 first_slot; /* First physical slot number */ /* PCIE only has 1 slot */
96 u8 slot_bus; /* Bus where the slots handled by this controller sit */
Kenji Kaneshigeae416e62008-04-25 14:39:06 -070097 u32 slot_cap;
Dely Sy8b245e42005-05-06 17:19:09 -070098 u8 cap_base;
Kenji Kaneshige48fe3912006-12-21 17:01:04 -080099 struct timer_list poll_timer;
Ming Lei9fce1bc2008-07-16 22:54:30 +0800100 int cmd_busy;
Kenji Kaneshige58086392008-05-27 19:04:30 +0900101 unsigned int no_cmd_complete:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102};
103
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104#define INT_BUTTON_IGNORE 0
105#define INT_PRESENCE_ON 1
106#define INT_PRESENCE_OFF 2
107#define INT_SWITCH_CLOSE 3
108#define INT_SWITCH_OPEN 4
109#define INT_POWER_FAULT 5
110#define INT_POWER_FAULT_CLEAR 6
111#define INT_BUTTON_PRESS 7
112#define INT_BUTTON_RELEASE 8
113#define INT_BUTTON_CANCEL 9
114
115#define STATIC_STATE 0
116#define BLINKINGON_STATE 1
117#define BLINKINGOFF_STATE 2
118#define POWERON_STATE 3
119#define POWEROFF_STATE 4
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121/* Error messages */
122#define INTERLOCK_OPEN 0x00000002
123#define ADD_NOT_SUPPORTED 0x00000003
124#define CARD_FUNCTIONING 0x00000005
125#define ADAPTER_NOT_SAME 0x00000006
126#define NO_ADAPTER_PRESENT 0x00000009
127#define NOT_ENOUGH_RESOURCES 0x0000000B
128#define DEVICE_TYPE_NOT_SUPPORTED 0x0000000C
129#define WRONG_BUS_FREQUENCY 0x0000000D
130#define POWER_FAILURE 0x0000000E
131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132/* Field definitions in Slot Capabilities Register */
133#define ATTN_BUTTN_PRSN 0x00000001
134#define PWR_CTRL_PRSN 0x00000002
135#define MRL_SENS_PRSN 0x00000004
136#define ATTN_LED_PRSN 0x00000008
137#define PWR_LED_PRSN 0x00000010
138#define HP_SUPR_RM_SUP 0x00000020
Kristen Carlson Accardi34d03412007-01-09 13:02:36 -0800139#define EMI_PRSN 0x00020000
Kenji Kaneshige58086392008-05-27 19:04:30 +0900140#define NO_CMD_CMPL_SUP 0x00040000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Kenji Kaneshigeae416e62008-04-25 14:39:06 -0700142#define ATTN_BUTTN(ctrl) ((ctrl)->slot_cap & ATTN_BUTTN_PRSN)
143#define POWER_CTRL(ctrl) ((ctrl)->slot_cap & PWR_CTRL_PRSN)
144#define MRL_SENS(ctrl) ((ctrl)->slot_cap & MRL_SENS_PRSN)
145#define ATTN_LED(ctrl) ((ctrl)->slot_cap & ATTN_LED_PRSN)
146#define PWR_LED(ctrl) ((ctrl)->slot_cap & PWR_LED_PRSN)
147#define HP_SUPR_RM(ctrl) ((ctrl)->slot_cap & HP_SUPR_RM_SUP)
148#define EMI(ctrl) ((ctrl)->slot_cap & EMI_PRSN)
Kenji Kaneshige58086392008-05-27 19:04:30 +0900149#define NO_CMD_CMPL(ctrl) ((ctrl)->slot_cap & NO_CMD_CMPL_SUP)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Kenji Kaneshige5d386e12007-03-06 15:02:26 -0800151extern int pciehp_sysfs_enable_slot(struct slot *slot);
152extern int pciehp_sysfs_disable_slot(struct slot *slot);
Kenji Kaneshigedbd79ae2008-05-27 19:03:16 +0900153extern u8 pciehp_handle_attention_button(struct slot *p_slot);
154 extern u8 pciehp_handle_switch_change(struct slot *p_slot);
155extern u8 pciehp_handle_presence_change(struct slot *p_slot);
156extern u8 pciehp_handle_power_fault(struct slot *p_slot);
Kenji Kaneshige15232ec2006-12-21 17:01:07 -0800157extern int pciehp_configure_device(struct slot *p_slot);
158extern int pciehp_unconfigure_device(struct slot *p_slot);
Kristen Carlson Accardie325e1f2007-03-21 11:45:31 -0700159extern void pciehp_queue_pushbutton_work(struct work_struct *work);
Kenji Kaneshigec4635eb2008-06-20 12:07:08 +0900160struct controller *pcie_init(struct pcie_device *dev);
Mark Lord0a3c33d2007-11-28 15:11:28 -0800161int pciehp_enable_slot(struct slot *p_slot);
Mark Lordcd2fe832007-11-28 15:12:00 -0800162int pciehp_disable_slot(struct slot *p_slot);
Kenji Kaneshigec4635eb2008-06-20 12:07:08 +0900163int pcie_enable_notification(struct controller *ctrl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165static inline struct slot *pciehp_find_slot(struct controller *ctrl, u8 device)
166{
Kenji Kaneshige2410fa42006-12-21 17:01:03 -0800167 struct slot *slot;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Kenji Kaneshige2410fa42006-12-21 17:01:03 -0800169 list_for_each_entry(slot, &ctrl->slot_list, slot_list) {
170 if (slot->device == device)
171 return slot;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 }
173
Harvey Harrison66bef8c2008-03-03 19:09:46 -0800174 err("%s: slot (device=0x%x) not found\n", __func__, device);
Kenji Kaneshige2410fa42006-12-21 17:01:03 -0800175 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176}
177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178struct hpc_ops {
Kenji Kaneshige15232ec2006-12-21 17:01:07 -0800179 int (*power_on_slot)(struct slot *slot);
180 int (*power_off_slot)(struct slot *slot);
181 int (*get_power_status)(struct slot *slot, u8 *status);
182 int (*get_attention_status)(struct slot *slot, u8 *status);
183 int (*set_attention_status)(struct slot *slot, u8 status);
184 int (*get_latch_status)(struct slot *slot, u8 *status);
185 int (*get_adapter_status)(struct slot *slot, u8 *status);
Kristen Carlson Accardi34d03412007-01-09 13:02:36 -0800186 int (*get_emi_status)(struct slot *slot, u8 *status);
187 int (*toggle_emi)(struct slot *slot);
Kenji Kaneshige15232ec2006-12-21 17:01:07 -0800188 int (*get_max_bus_speed)(struct slot *slot, enum pci_bus_speed *speed);
189 int (*get_cur_bus_speed)(struct slot *slot, enum pci_bus_speed *speed);
190 int (*get_max_lnk_width)(struct slot *slot, enum pcie_link_width *val);
191 int (*get_cur_lnk_width)(struct slot *slot, enum pcie_link_width *val);
192 int (*query_power_fault)(struct slot *slot);
193 void (*green_led_on)(struct slot *slot);
194 void (*green_led_off)(struct slot *slot);
195 void (*green_led_blink)(struct slot *slot);
196 void (*release_ctlr)(struct controller *ctrl);
197 int (*check_lnk_status)(struct controller *ctrl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198};
199
Kristen Accardi783c49f2006-03-03 10:16:05 -0800200#ifdef CONFIG_ACPI
Kristen Carlson Accardie50d1082006-08-08 09:44:26 -0400201#include <acpi/acpi.h>
202#include <acpi/acpi_bus.h>
203#include <acpi/actypes.h>
204#include <linux/pci-acpi.h>
205
Kenji Kaneshigeac9c0522008-05-28 15:01:03 +0900206static inline int pciehp_get_hp_hw_control_from_firmware(struct pci_dev *dev)
207{
208 u32 flags = (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL |
209 OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL);
210 return acpi_get_hp_hw_control_from_firmware(dev, flags);
211}
212
Kristen Accardi783c49f2006-03-03 10:16:05 -0800213static inline int pciehp_get_hp_params_from_firmware(struct pci_dev *dev,
214 struct hotplug_params *hpp)
215{
Kenji Kaneshige7430e342006-05-02 10:54:50 +0900216 if (ACPI_FAILURE(acpi_get_hp_params_from_firmware(dev->bus, hpp)))
Kristen Accardi783c49f2006-03-03 10:16:05 -0800217 return -ENODEV;
218 return 0;
219}
220#else
221#define pciehp_get_hp_hw_control_from_firmware(dev) 0
222#define pciehp_get_hp_params_from_firmware(dev, hpp) (-ENODEV)
223#endif /* CONFIG_ACPI */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224#endif /* _PCIEHP_H */