]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/pci/hotplug/pciehp.h
PCI: pciehp: enable software notification on empty slots
[mirror_ubuntu-bionic-kernel.git] / drivers / pci / hotplug / pciehp.h
CommitLineData
1da177e4
LT
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 *
8cf4c195 26 * Send feedback to <greg@kroah.com>, <kristen.c.accardi@intel.com>
1da177e4
LT
27 *
28 */
29#ifndef _PCIEHP_H
30#define _PCIEHP_H
31
32#include <linux/types.h>
33#include <linux/pci.h>
7a54f25c 34#include <linux/pci_hotplug.h>
1da177e4 35#include <linux/delay.h>
de25968c 36#include <linux/sched.h> /* signal_pending() */
1da177e4 37#include <linux/pcieport_if.h>
6aa4cdd0 38#include <linux/mutex.h>
1da177e4
LT
39
40#define MY_NAME "pciehp"
41
42extern int pciehp_poll_mode;
43extern int pciehp_poll_time;
44extern int pciehp_debug;
a3a45ec8 45extern int pciehp_force;
5d386e1a 46extern struct workqueue_struct *pciehp_wq;
1da177e4 47
15232ece 48#define dbg(format, arg...) \
1c35b8e5
FS
49do { \
50 if (pciehp_debug) \
51 printk(KERN_DEBUG "%s: " format, MY_NAME , ## arg); \
52} while (0)
15232ece
KK
53#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)
1da177e4 59
7f2feec1
TI
60#define ctrl_dbg(ctrl, format, arg...) \
61 do { \
62 if (pciehp_debug) \
1c35b8e5 63 dev_printk(KERN_DEBUG, &ctrl->pcie->device, \
7f2feec1
TI
64 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
a0b17257 73#define SLOT_NAME_SIZE 10
1da177e4 74struct slot {
1da177e4
LT
75 u8 bus;
76 u8 device;
1da177e4 77 u8 state;
1da177e4 78 u8 hp_slot;
e1acb24f 79 u32 number;
1da177e4
LT
80 struct controller *ctrl;
81 struct hpc_ops *hpc_ops;
82 struct hotplug_slot *hotplug_slot;
83 struct list_head slot_list;
34d03419 84 unsigned long last_emi_toggle;
5d386e1a
KK
85 struct delayed_work work; /* work for button event */
86 struct mutex lock;
1da177e4
LT
87};
88
1da177e4
LT
89struct event_info {
90 u32 event_type;
5d386e1a
KK
91 struct slot *p_slot;
92 struct work_struct work;
1da177e4
LT
93};
94
95struct controller {
6aa4cdd0 96 struct mutex crit_sect; /* critical section mutex */
dd5619cb 97 struct mutex ctrl_lock; /* controller lock */
1da177e4
LT
98 int num_slots; /* Number of slots on ctlr */
99 int slot_num_inc; /* 1 or -1 */
1da177e4 100 struct pci_dev *pci_dev;
f7a10e32 101 struct pcie_device *pcie; /* PCI Express port service */
2410fa4e 102 struct list_head slot_list;
1da177e4
LT
103 struct hpc_ops *hpc_ops;
104 wait_queue_head_t queue; /* sleep & wake process */
1da177e4 105 u8 slot_device_offset;
1da177e4
LT
106 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 */
ae416e6b 108 u32 slot_cap;
8b245e45 109 u8 cap_base;
48fe3915 110 struct timer_list poll_timer;
9fce1bc9 111 int cmd_busy;
5808639b 112 unsigned int no_cmd_complete:1;
f18e9625 113 unsigned int link_active_reporting:1;
dbc7e1e5 114 unsigned int notification_enabled:1;
99f0169c 115 unsigned int power_fault_detected;
1da177e4
LT
116};
117
1da177e4
LT
118#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
1da177e4
LT
135/* 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
1da177e4
LT
146/* 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
34d03419 153#define EMI_PRSN 0x00020000
5808639b 154#define NO_CMD_CMPL_SUP 0x00040000
1da177e4 155
ae416e6b
KK
156#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)
5808639b 163#define NO_CMD_CMPL(ctrl) ((ctrl)->slot_cap & NO_CMD_CMPL_SUP)
1da177e4 164
5d386e1a
KK
165extern int pciehp_sysfs_enable_slot(struct slot *slot);
166extern int pciehp_sysfs_disable_slot(struct slot *slot);
dbd79aed
KK
167extern 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);
15232ece
KK
171extern int pciehp_configure_device(struct slot *p_slot);
172extern int pciehp_unconfigure_device(struct slot *p_slot);
e325e1f0 173extern void pciehp_queue_pushbutton_work(struct work_struct *work);
c4635eb0 174struct controller *pcie_init(struct pcie_device *dev);
dbc7e1e5 175int pcie_init_notification(struct controller *ctrl);
0a3c33d7 176int pciehp_enable_slot(struct slot *p_slot);
cd2fe83a 177int pciehp_disable_slot(struct slot *p_slot);
c4635eb0 178int pcie_enable_notification(struct controller *ctrl);
1da177e4 179
e1acb24f
AC
180static inline const char *slot_name(struct slot *slot)
181{
182 return hotplug_slot_name(slot->hotplug_slot);
183}
184
1da177e4
LT
185static inline struct slot *pciehp_find_slot(struct controller *ctrl, u8 device)
186{
2410fa4e 187 struct slot *slot;
1da177e4 188
2410fa4e
KK
189 list_for_each_entry(slot, &ctrl->slot_list, slot_list) {
190 if (slot->device == device)
191 return slot;
1da177e4
LT
192 }
193
18b341b7 194 ctrl_err(ctrl, "Slot (device=0x%02x) not found\n", device);
2410fa4e 195 return NULL;
1da177e4
LT
196}
197
1da177e4 198struct hpc_ops {
15232ece
KK
199 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);
34d03419
KCA
206 int (*get_emi_status)(struct slot *slot, u8 *status);
207 int (*toggle_emi)(struct slot *slot);
15232ece
KK
208 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);
1da177e4
LT
218};
219
783c49fc 220#ifdef CONFIG_ACPI
e50d1088
KCA
221#include <acpi/acpi.h>
222#include <acpi/acpi_bus.h>
e50d1088
KCA
223#include <linux/pci-acpi.h>
224
c9ffa5a5
KK
225extern 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
ac9c052d
KK
233static inline int pciehp_get_hp_hw_control_from_firmware(struct pci_dev *dev)
234{
c9ffa5a5 235 int retval;
ac9c052d
KK
236 u32 flags = (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL |
237 OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL);
c9ffa5a5
KK
238 retval = acpi_get_hp_hw_control_from_firmware(dev, flags);
239 if (retval)
240 return retval;
241 return pciehp_acpi_slot_detection_check(dev);
ac9c052d
KK
242}
243
783c49fc
KA
244static inline int pciehp_get_hp_params_from_firmware(struct pci_dev *dev,
245 struct hotplug_params *hpp)
246{
7430e34c 247 if (ACPI_FAILURE(acpi_get_hp_params_from_firmware(dev->bus, hpp)))
783c49fc
KA
248 return -ENODEV;
249 return 0;
250}
251#else
c9ffa5a5 252#define pciehp_firmware_init() do {} while (0)
783c49fc
KA
253#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 */
1da177e4 256#endif /* _PCIEHP_H */