]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/pci/hotplug/pciehp.h
pciehp: cleanup slot list
[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;
1da177e4
LT
46
47/*#define dbg(format, arg...) do { if (pciehp_debug) printk(KERN_DEBUG "%s: " format, MY_NAME , ## arg); } while (0)*/
48#define dbg(format, arg...) do { if (pciehp_debug) printk("%s: " format, MY_NAME , ## arg); } while (0)
49#define err(format, arg...) printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
50#define info(format, arg...) printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
51#define warn(format, arg...) printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
52
a0b17257 53#define SLOT_NAME_SIZE 10
1da177e4 54struct slot {
1da177e4
LT
55 u8 bus;
56 u8 device;
57 u32 number;
1da177e4 58 u8 state;
1da177e4
LT
59 struct timer_list task_event;
60 u8 hp_slot;
61 struct controller *ctrl;
62 struct hpc_ops *hpc_ops;
63 struct hotplug_slot *hotplug_slot;
64 struct list_head slot_list;
a0b17257 65 char name[SLOT_NAME_SIZE];
1da177e4
LT
66};
67
1da177e4
LT
68struct event_info {
69 u32 event_type;
70 u8 hp_slot;
71};
72
ed6cbcf2
RS
73typedef u8(*php_intr_callback_t) (u8 hp_slot, void *instance_id);
74
75struct php_ctlr_state_s {
76 struct php_ctlr_state_s *pnext;
77 struct pci_dev *pci_dev;
78 unsigned int irq;
79 unsigned long flags; /* spinlock's */
80 u32 slot_device_offset;
81 u32 num_slots;
82 struct timer_list int_poll_timer; /* Added for poll event */
83 php_intr_callback_t attention_button_callback;
84 php_intr_callback_t switch_change_callback;
85 php_intr_callback_t presence_change_callback;
86 php_intr_callback_t power_fault_callback;
87 void *callback_instance_id;
88 struct ctrl_reg *creg; /* Ptr to controller register space */
89};
90
91#define MAX_EVENTS 10
1da177e4
LT
92struct controller {
93 struct controller *next;
6aa4cdd0 94 struct mutex crit_sect; /* critical section mutex */
dd5619cb 95 struct mutex ctrl_lock; /* controller lock */
ed6cbcf2 96 struct php_ctlr_state_s *hpc_ctlr_handle; /* HPC controller handle */
1da177e4
LT
97 int num_slots; /* Number of slots on ctlr */
98 int slot_num_inc; /* 1 or -1 */
1da177e4
LT
99 struct pci_dev *pci_dev;
100 struct pci_bus *pci_bus;
2410fa4e 101 struct list_head slot_list;
ed6cbcf2 102 struct event_info event_queue[MAX_EVENTS];
1da177e4
LT
103 struct slot *slot;
104 struct hpc_ops *hpc_ops;
105 wait_queue_head_t queue; /* sleep & wake process */
106 u8 next_event;
1da177e4
LT
107 u8 bus;
108 u8 device;
109 u8 function;
1da177e4 110 u8 slot_device_offset;
1da177e4
LT
111 u32 first_slot; /* First physical slot number */ /* PCIE only has 1 slot */
112 u8 slot_bus; /* Bus where the slots handled by this controller sit */
113 u8 ctrlcap;
114 u16 vendor_id;
8b245e45 115 u8 cap_base;
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
135#define PCI_TO_PCI_BRIDGE_CLASS 0x00060400
136
137/* Error messages */
138#define INTERLOCK_OPEN 0x00000002
139#define ADD_NOT_SUPPORTED 0x00000003
140#define CARD_FUNCTIONING 0x00000005
141#define ADAPTER_NOT_SAME 0x00000006
142#define NO_ADAPTER_PRESENT 0x00000009
143#define NOT_ENOUGH_RESOURCES 0x0000000B
144#define DEVICE_TYPE_NOT_SUPPORTED 0x0000000C
145#define WRONG_BUS_FREQUENCY 0x0000000D
146#define POWER_FAILURE 0x0000000E
147
148#define REMOVE_NOT_SUPPORTED 0x00000003
149
150#define DISABLE_CARD 1
151
152/* Field definitions in Slot Capabilities Register */
153#define ATTN_BUTTN_PRSN 0x00000001
154#define PWR_CTRL_PRSN 0x00000002
155#define MRL_SENS_PRSN 0x00000004
156#define ATTN_LED_PRSN 0x00000008
157#define PWR_LED_PRSN 0x00000010
158#define HP_SUPR_RM_SUP 0x00000020
159
160#define ATTN_BUTTN(cap) (cap & ATTN_BUTTN_PRSN)
161#define POWER_CTRL(cap) (cap & PWR_CTRL_PRSN)
162#define MRL_SENS(cap) (cap & MRL_SENS_PRSN)
163#define ATTN_LED(cap) (cap & ATTN_LED_PRSN)
164#define PWR_LED(cap) (cap & PWR_LED_PRSN)
165#define HP_SUPR_RM(cap) (cap & HP_SUPR_RM_SUP)
166
167/*
168 * error Messages
169 */
170#define msg_initialization_err "Initialization failure, error=%d\n"
49ed2b49
KK
171#define msg_button_on "PCI slot #%s - powering on due to button press.\n"
172#define msg_button_off "PCI slot #%s - powering off due to button press.\n"
173#define msg_button_cancel "PCI slot #%s - action canceled due to button press.\n"
174#define msg_button_ignore "PCI slot #%s - button press ignored. (action in progress...)\n"
1da177e4
LT
175
176/* controller functions */
1da177e4
LT
177extern int pciehp_event_start_thread (void);
178extern void pciehp_event_stop_thread (void);
1da177e4
LT
179extern int pciehp_enable_slot (struct slot *slot);
180extern int pciehp_disable_slot (struct slot *slot);
181
182extern u8 pciehp_handle_attention_button (u8 hp_slot, void *inst_id);
183extern u8 pciehp_handle_switch_change (u8 hp_slot, void *inst_id);
184extern u8 pciehp_handle_presence_change (u8 hp_slot, void *inst_id);
185extern u8 pciehp_handle_power_fault (u8 hp_slot, void *inst_id);
186/* extern void long_delay (int delay); */
187
1da177e4 188/* pci functions */
ca22a5e4
RS
189extern int pciehp_configure_device (struct slot *p_slot);
190extern int pciehp_unconfigure_device (struct slot *p_slot);
a8a2be94 191
1da177e4
LT
192
193
194/* Global variables */
195extern struct controller *pciehp_ctrl_list;
1da177e4
LT
196
197/* Inline functions */
198
199static inline struct slot *pciehp_find_slot(struct controller *ctrl, u8 device)
200{
2410fa4e 201 struct slot *slot;
1da177e4 202
2410fa4e
KK
203 list_for_each_entry(slot, &ctrl->slot_list, slot_list) {
204 if (slot->device == device)
205 return slot;
1da177e4
LT
206 }
207
2410fa4e
KK
208 err("%s: slot (device=0x%x) not found\n", __FUNCTION__, device);
209 return NULL;
1da177e4
LT
210}
211
212static inline int wait_for_ctrl_irq(struct controller *ctrl)
213{
214 int retval = 0;
215
216 DECLARE_WAITQUEUE(wait, current);
217
1da177e4
LT
218 add_wait_queue(&ctrl->queue, &wait);
219 if (!pciehp_poll_mode)
220 /* Sleep for up to 1 second */
221 msleep_interruptible(1000);
222 else
223 msleep_interruptible(2500);
224
225 remove_wait_queue(&ctrl->queue, &wait);
226 if (signal_pending(current))
227 retval = -EINTR;
228
1da177e4
LT
229 return retval;
230}
231
1da177e4
LT
232enum php_ctlr_type {
233 PCI,
234 ISA,
235 ACPI
236};
237
ed6cbcf2 238int pcie_init(struct controller *ctrl, struct pcie_device *dev);
1da177e4
LT
239
240/* This has no meaning for PCI Express, as there is only 1 slot per port */
241int pcie_get_ctlr_slot_config(struct controller *ctrl,
242 int *num_ctlr_slots,
243 int *first_device_num,
244 int *physical_slot_num,
245 u8 *ctrlcap);
246
247struct hpc_ops {
248 int (*power_on_slot) (struct slot *slot);
249 int (*power_off_slot) (struct slot *slot);
250 int (*get_power_status) (struct slot *slot, u8 *status);
251 int (*get_attention_status) (struct slot *slot, u8 *status);
252 int (*set_attention_status) (struct slot *slot, u8 status);
253 int (*get_latch_status) (struct slot *slot, u8 *status);
254 int (*get_adapter_status) (struct slot *slot, u8 *status);
255
256 int (*get_max_bus_speed) (struct slot *slot, enum pci_bus_speed *speed);
257 int (*get_cur_bus_speed) (struct slot *slot, enum pci_bus_speed *speed);
258
259 int (*get_max_lnk_width) (struct slot *slot, enum pcie_link_width *value);
260 int (*get_cur_lnk_width) (struct slot *slot, enum pcie_link_width *value);
261
262 int (*query_power_fault) (struct slot *slot);
263 void (*green_led_on) (struct slot *slot);
264 void (*green_led_off) (struct slot *slot);
265 void (*green_led_blink) (struct slot *slot);
266 void (*release_ctlr) (struct controller *ctrl);
267 int (*check_lnk_status) (struct controller *ctrl);
268};
269
783c49fc
KA
270
271#ifdef CONFIG_ACPI
e50d1088
KCA
272#include <acpi/acpi.h>
273#include <acpi/acpi_bus.h>
274#include <acpi/actypes.h>
275#include <linux/pci-acpi.h>
276
783c49fc
KA
277#define pciehp_get_hp_hw_control_from_firmware(dev) \
278 pciehp_acpi_get_hp_hw_control_from_firmware(dev)
279static inline int pciehp_get_hp_params_from_firmware(struct pci_dev *dev,
280 struct hotplug_params *hpp)
281{
7430e34c 282 if (ACPI_FAILURE(acpi_get_hp_params_from_firmware(dev->bus, hpp)))
783c49fc
KA
283 return -ENODEV;
284 return 0;
285}
286#else
287#define pciehp_get_hp_hw_control_from_firmware(dev) 0
288#define pciehp_get_hp_params_from_firmware(dev, hpp) (-ENODEV)
289#endif /* CONFIG_ACPI */
1da177e4 290#endif /* _PCIEHP_H */