blob: 0a368547e6339d41ed7a80c08c9c6509d4d57007 [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 Kaneshige5d386e12007-03-06 15:02:26 -080046extern struct workqueue_struct *pciehp_wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Kenji Kaneshige15232ec2006-12-21 17:01:07 -080048#define dbg(format, arg...) \
Frank Seidel1c35b8e2009-02-06 10:23:36 +010049do { \
50 if (pciehp_debug) \
51 printk(KERN_DEBUG "%s: " format, MY_NAME , ## arg); \
52} while (0)
Kenji Kaneshige15232ec2006-12-21 17:01:07 -080053#define err(format, arg...) \
54 printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
55#define info(format, arg...) \
56 printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
57#define warn(format, arg...) \
58 printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Taku Izumi7f2feec2008-09-05 12:11:26 +090060#define ctrl_dbg(ctrl, format, arg...) \
61 do { \
62 if (pciehp_debug) \
Frank Seidel1c35b8e2009-02-06 10:23:36 +010063 dev_printk(KERN_DEBUG, &ctrl->pcie->device, \
Taku Izumi7f2feec2008-09-05 12:11:26 +090064 format, ## arg); \
65 } while (0)
66#define ctrl_err(ctrl, format, arg...) \
67 dev_err(&ctrl->pcie->device, format, ## arg)
68#define ctrl_info(ctrl, format, arg...) \
69 dev_info(&ctrl->pcie->device, format, ## arg)
70#define ctrl_warn(ctrl, format, arg...) \
71 dev_warn(&ctrl->pcie->device, format, ## arg)
72
Kenji Kaneshigea0b17252006-12-21 17:01:02 -080073#define SLOT_NAME_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -070074struct slot {
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 u8 bus;
76 u8 device;
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 u8 state;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 u8 hp_slot;
Alex Chiange1acb242008-10-20 17:41:38 -060079 u32 number;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 struct controller *ctrl;
81 struct hpc_ops *hpc_ops;
82 struct hotplug_slot *hotplug_slot;
83 struct list_head slot_list;
Kristen Carlson Accardi34d03412007-01-09 13:02:36 -080084 unsigned long last_emi_toggle;
Kenji Kaneshige5d386e12007-03-06 15:02:26 -080085 struct delayed_work work; /* work for button event */
86 struct mutex lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087};
88
Linus Torvalds1da177e2005-04-16 15:20:36 -070089struct event_info {
90 u32 event_type;
Kenji Kaneshige5d386e12007-03-06 15:02:26 -080091 struct slot *p_slot;
92 struct work_struct work;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093};
94
95struct controller {
Ingo Molnar6aa4cdd2006-01-13 16:02:15 +010096 struct mutex crit_sect; /* critical section mutex */
Kenji Kaneshigedd5619c2006-09-22 10:17:29 -070097 struct mutex ctrl_lock; /* controller lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 int num_slots; /* Number of slots on ctlr */
99 int slot_num_inc; /* 1 or -1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 struct pci_dev *pci_dev;
Kenji Kaneshigef7a10e32008-08-22 17:16:48 +0900101 struct pcie_device *pcie; /* PCI Express port service */
Kenji Kaneshige2410fa42006-12-21 17:01:03 -0800102 struct list_head slot_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 struct hpc_ops *hpc_ops;
104 wait_queue_head_t queue; /* sleep & wake process */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 u8 slot_device_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 u32 first_slot; /* First physical slot number */ /* PCIE only has 1 slot */
107 u8 slot_bus; /* Bus where the slots handled by this controller sit */
Kenji Kaneshigeae416e62008-04-25 14:39:06 -0700108 u32 slot_cap;
Dely Sy8b245e42005-05-06 17:19:09 -0700109 u8 cap_base;
Kenji Kaneshige48fe3912006-12-21 17:01:04 -0800110 struct timer_list poll_timer;
Kenji Kaneshige6a82e212009-02-03 15:06:18 +0900111 unsigned int cmd_busy:1;
Kenji Kaneshige58086392008-05-27 19:04:30 +0900112 unsigned int no_cmd_complete:1;
Kenji Kaneshigef18e9622008-10-22 14:31:44 +0900113 unsigned int link_active_reporting:1;
Eric W. Biedermandbc7e1e2009-01-28 19:31:18 -0800114 unsigned int notification_enabled:1;
Kenji Kaneshige99f01692009-02-03 15:06:16 +0900115 unsigned int power_fault_detected;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116};
117
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118#define INT_BUTTON_IGNORE 0
119#define INT_PRESENCE_ON 1
120#define INT_PRESENCE_OFF 2
121#define INT_SWITCH_CLOSE 3
122#define INT_SWITCH_OPEN 4
123#define INT_POWER_FAULT 5
124#define INT_POWER_FAULT_CLEAR 6
125#define INT_BUTTON_PRESS 7
126#define INT_BUTTON_RELEASE 8
127#define INT_BUTTON_CANCEL 9
128
129#define STATIC_STATE 0
130#define BLINKINGON_STATE 1
131#define BLINKINGOFF_STATE 2
132#define POWERON_STATE 3
133#define POWEROFF_STATE 4
134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135/* Error messages */
136#define INTERLOCK_OPEN 0x00000002
137#define ADD_NOT_SUPPORTED 0x00000003
138#define CARD_FUNCTIONING 0x00000005
139#define ADAPTER_NOT_SAME 0x00000006
140#define NO_ADAPTER_PRESENT 0x00000009
141#define NOT_ENOUGH_RESOURCES 0x0000000B
142#define DEVICE_TYPE_NOT_SUPPORTED 0x0000000C
143#define WRONG_BUS_FREQUENCY 0x0000000D
144#define POWER_FAILURE 0x0000000E
145
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146/* Field definitions in Slot Capabilities Register */
147#define ATTN_BUTTN_PRSN 0x00000001
148#define PWR_CTRL_PRSN 0x00000002
149#define MRL_SENS_PRSN 0x00000004
150#define ATTN_LED_PRSN 0x00000008
151#define PWR_LED_PRSN 0x00000010
152#define HP_SUPR_RM_SUP 0x00000020
Kristen Carlson Accardi34d03412007-01-09 13:02:36 -0800153#define EMI_PRSN 0x00020000
Kenji Kaneshige58086392008-05-27 19:04:30 +0900154#define NO_CMD_CMPL_SUP 0x00040000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
Kenji Kaneshigeae416e62008-04-25 14:39:06 -0700156#define ATTN_BUTTN(ctrl) ((ctrl)->slot_cap & ATTN_BUTTN_PRSN)
157#define POWER_CTRL(ctrl) ((ctrl)->slot_cap & PWR_CTRL_PRSN)
158#define MRL_SENS(ctrl) ((ctrl)->slot_cap & MRL_SENS_PRSN)
159#define ATTN_LED(ctrl) ((ctrl)->slot_cap & ATTN_LED_PRSN)
160#define PWR_LED(ctrl) ((ctrl)->slot_cap & PWR_LED_PRSN)
161#define HP_SUPR_RM(ctrl) ((ctrl)->slot_cap & HP_SUPR_RM_SUP)
162#define EMI(ctrl) ((ctrl)->slot_cap & EMI_PRSN)
Kenji Kaneshige58086392008-05-27 19:04:30 +0900163#define NO_CMD_CMPL(ctrl) ((ctrl)->slot_cap & NO_CMD_CMPL_SUP)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Kenji Kaneshige5d386e12007-03-06 15:02:26 -0800165extern int pciehp_sysfs_enable_slot(struct slot *slot);
166extern int pciehp_sysfs_disable_slot(struct slot *slot);
Kenji Kaneshigedbd79ae2008-05-27 19:03:16 +0900167extern u8 pciehp_handle_attention_button(struct slot *p_slot);
168 extern u8 pciehp_handle_switch_change(struct slot *p_slot);
169extern u8 pciehp_handle_presence_change(struct slot *p_slot);
170extern u8 pciehp_handle_power_fault(struct slot *p_slot);
Kenji Kaneshige15232ec2006-12-21 17:01:07 -0800171extern int pciehp_configure_device(struct slot *p_slot);
172extern int pciehp_unconfigure_device(struct slot *p_slot);
Kristen Carlson Accardie325e1f2007-03-21 11:45:31 -0700173extern void pciehp_queue_pushbutton_work(struct work_struct *work);
Kenji Kaneshigec4635eb2008-06-20 12:07:08 +0900174struct controller *pcie_init(struct pcie_device *dev);
Eric W. Biedermandbc7e1e2009-01-28 19:31:18 -0800175int pcie_init_notification(struct controller *ctrl);
Mark Lord0a3c33d2007-11-28 15:11:28 -0800176int pciehp_enable_slot(struct slot *p_slot);
Mark Lordcd2fe832007-11-28 15:12:00 -0800177int pciehp_disable_slot(struct slot *p_slot);
Kenji Kaneshigec4635eb2008-06-20 12:07:08 +0900178int pcie_enable_notification(struct controller *ctrl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
Alex Chiange1acb242008-10-20 17:41:38 -0600180static inline const char *slot_name(struct slot *slot)
181{
182 return hotplug_slot_name(slot->hotplug_slot);
183}
184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185static inline struct slot *pciehp_find_slot(struct controller *ctrl, u8 device)
186{
Kenji Kaneshige2410fa42006-12-21 17:01:03 -0800187 struct slot *slot;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
Kenji Kaneshige2410fa42006-12-21 17:01:03 -0800189 list_for_each_entry(slot, &ctrl->slot_list, slot_list) {
190 if (slot->device == device)
191 return slot;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 }
193
Taku Izumi18b341b2008-10-23 11:47:32 +0900194 ctrl_err(ctrl, "Slot (device=0x%02x) not found\n", device);
Kenji Kaneshige2410fa42006-12-21 17:01:03 -0800195 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196}
197
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198struct hpc_ops {
Kenji Kaneshige15232ec2006-12-21 17:01:07 -0800199 int (*power_on_slot)(struct slot *slot);
200 int (*power_off_slot)(struct slot *slot);
201 int (*get_power_status)(struct slot *slot, u8 *status);
202 int (*get_attention_status)(struct slot *slot, u8 *status);
203 int (*set_attention_status)(struct slot *slot, u8 status);
204 int (*get_latch_status)(struct slot *slot, u8 *status);
205 int (*get_adapter_status)(struct slot *slot, u8 *status);
Kristen Carlson Accardi34d03412007-01-09 13:02:36 -0800206 int (*get_emi_status)(struct slot *slot, u8 *status);
207 int (*toggle_emi)(struct slot *slot);
Kenji Kaneshige15232ec2006-12-21 17:01:07 -0800208 int (*get_max_bus_speed)(struct slot *slot, enum pci_bus_speed *speed);
209 int (*get_cur_bus_speed)(struct slot *slot, enum pci_bus_speed *speed);
210 int (*get_max_lnk_width)(struct slot *slot, enum pcie_link_width *val);
211 int (*get_cur_lnk_width)(struct slot *slot, enum pcie_link_width *val);
212 int (*query_power_fault)(struct slot *slot);
213 void (*green_led_on)(struct slot *slot);
214 void (*green_led_off)(struct slot *slot);
215 void (*green_led_blink)(struct slot *slot);
216 void (*release_ctlr)(struct controller *ctrl);
217 int (*check_lnk_status)(struct controller *ctrl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218};
219
Kristen Accardi783c49f2006-03-03 10:16:05 -0800220#ifdef CONFIG_ACPI
Kristen Carlson Accardie50d1082006-08-08 09:44:26 -0400221#include <acpi/acpi.h>
222#include <acpi/acpi_bus.h>
Kristen Carlson Accardie50d1082006-08-08 09:44:26 -0400223#include <linux/pci-acpi.h>
224
Kenji Kaneshigec9ffa5a2008-12-17 12:07:38 +0900225extern void __init pciehp_acpi_slot_detection_init(void);
226extern int pciehp_acpi_slot_detection_check(struct pci_dev *dev);
227
228static inline void pciehp_firmware_init(void)
229{
230 pciehp_acpi_slot_detection_init();
231}
232
Kenji Kaneshigeac9c0522008-05-28 15:01:03 +0900233static inline int pciehp_get_hp_hw_control_from_firmware(struct pci_dev *dev)
234{
Kenji Kaneshigec9ffa5a2008-12-17 12:07:38 +0900235 int retval;
Kenji Kaneshigeac9c0522008-05-28 15:01:03 +0900236 u32 flags = (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL |
237 OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL);
Kenji Kaneshigec9ffa5a2008-12-17 12:07:38 +0900238 retval = acpi_get_hp_hw_control_from_firmware(dev, flags);
239 if (retval)
240 return retval;
241 return pciehp_acpi_slot_detection_check(dev);
Kenji Kaneshigeac9c0522008-05-28 15:01:03 +0900242}
243
Kristen Accardi783c49f2006-03-03 10:16:05 -0800244static inline int pciehp_get_hp_params_from_firmware(struct pci_dev *dev,
245 struct hotplug_params *hpp)
246{
Kenji Kaneshige7430e342006-05-02 10:54:50 +0900247 if (ACPI_FAILURE(acpi_get_hp_params_from_firmware(dev->bus, hpp)))
Kristen Accardi783c49f2006-03-03 10:16:05 -0800248 return -ENODEV;
249 return 0;
250}
251#else
Kenji Kaneshigec9ffa5a2008-12-17 12:07:38 +0900252#define pciehp_firmware_init() do {} while (0)
Kristen Accardi783c49f2006-03-03 10:16:05 -0800253#define pciehp_get_hp_hw_control_from_firmware(dev) 0
254#define pciehp_get_hp_params_from_firmware(dev, hpp) (-ENODEV)
255#endif /* CONFIG_ACPI */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256#endif /* _PCIEHP_H */