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#include <linux/workqueue.h>
40
41#define MY_NAME	"pciehp"
42
43extern bool pciehp_poll_mode;
44extern int pciehp_poll_time;
45extern bool pciehp_debug;
46
47#define dbg(format, arg...)						\
48do {									\
49	if (pciehp_debug)						\
50		printk(KERN_DEBUG "%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 ctrl_dbg(ctrl, format, arg...)					\
60	do {								\
61		if (pciehp_debug)					\
62			dev_printk(KERN_DEBUG, &ctrl->pcie->device,	\
63					format, ## arg);		\
64	} while (0)
65#define ctrl_err(ctrl, format, arg...)					\
66	dev_err(&ctrl->pcie->device, format, ## arg)
67#define ctrl_info(ctrl, format, arg...)					\
68	dev_info(&ctrl->pcie->device, format, ## arg)
69#define ctrl_warn(ctrl, format, arg...)					\
70	dev_warn(&ctrl->pcie->device, format, ## arg)
71
72#define SLOT_NAME_SIZE 10
73struct slot {
74	u8 state;
75	struct controller *ctrl;
76	struct hotplug_slot *hotplug_slot;
77	struct delayed_work work;	/* work for button event */
78	struct mutex lock;
79	struct mutex hotplug_lock;
80	struct workqueue_struct *wq;
81};
82
83struct event_info {
84	u32 event_type;
85	struct slot *p_slot;
86	struct work_struct work;
87};
88
89struct controller {
90	struct mutex ctrl_lock;		/* controller lock */
91	struct pcie_device *pcie;	/* PCI Express port service */
92	struct slot *slot;
93	wait_queue_head_t queue;	/* sleep & wake process */
94	u32 slot_cap;
95	u16 slot_ctrl;
96	struct timer_list poll_timer;
97	unsigned long cmd_started;	/* jiffies */
98	unsigned int cmd_busy:1;
99	unsigned int link_active_reporting:1;
100	unsigned int notification_enabled:1;
101	unsigned int power_fault_detected;
102};
103
104#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#define INT_LINK_UP			10
115#define INT_LINK_DOWN			11
116
117#define STATIC_STATE			0
118#define BLINKINGON_STATE		1
119#define BLINKINGOFF_STATE		2
120#define POWERON_STATE			3
121#define POWEROFF_STATE			4
122
123#define ATTN_BUTTN(ctrl)	((ctrl)->slot_cap & PCI_EXP_SLTCAP_ABP)
124#define POWER_CTRL(ctrl)	((ctrl)->slot_cap & PCI_EXP_SLTCAP_PCP)
125#define MRL_SENS(ctrl)		((ctrl)->slot_cap & PCI_EXP_SLTCAP_MRLSP)
126#define ATTN_LED(ctrl)		((ctrl)->slot_cap & PCI_EXP_SLTCAP_AIP)
127#define PWR_LED(ctrl)		((ctrl)->slot_cap & PCI_EXP_SLTCAP_PIP)
128#define HP_SUPR_RM(ctrl)	((ctrl)->slot_cap & PCI_EXP_SLTCAP_HPS)
129#define EMI(ctrl)		((ctrl)->slot_cap & PCI_EXP_SLTCAP_EIP)
130#define NO_CMD_CMPL(ctrl)	((ctrl)->slot_cap & PCI_EXP_SLTCAP_NCCS)
131#define PSN(ctrl)		(((ctrl)->slot_cap & PCI_EXP_SLTCAP_PSN) >> 19)
132
133int pciehp_sysfs_enable_slot(struct slot *slot);
134int pciehp_sysfs_disable_slot(struct slot *slot);
135u8 pciehp_handle_attention_button(struct slot *p_slot);
136u8 pciehp_handle_switch_change(struct slot *p_slot);
137u8 pciehp_handle_presence_change(struct slot *p_slot);
138u8 pciehp_handle_power_fault(struct slot *p_slot);
139void pciehp_handle_linkstate_change(struct slot *p_slot);
140int pciehp_configure_device(struct slot *p_slot);
141int pciehp_unconfigure_device(struct slot *p_slot);
142void pciehp_queue_pushbutton_work(struct work_struct *work);
143struct controller *pcie_init(struct pcie_device *dev);
144int pcie_init_notification(struct controller *ctrl);
145int pciehp_enable_slot(struct slot *p_slot);
146int pciehp_disable_slot(struct slot *p_slot);
147void pcie_enable_notification(struct controller *ctrl);
148int pciehp_power_on_slot(struct slot *slot);
149void pciehp_power_off_slot(struct slot *slot);
150void pciehp_get_power_status(struct slot *slot, u8 *status);
151void pciehp_get_attention_status(struct slot *slot, u8 *status);
152
153void pciehp_set_attention_status(struct slot *slot, u8 status);
154void pciehp_get_latch_status(struct slot *slot, u8 *status);
155void pciehp_get_adapter_status(struct slot *slot, u8 *status);
156int pciehp_query_power_fault(struct slot *slot);
157void pciehp_green_led_on(struct slot *slot);
158void pciehp_green_led_off(struct slot *slot);
159void pciehp_green_led_blink(struct slot *slot);
160int pciehp_check_link_status(struct controller *ctrl);
161bool pciehp_check_link_active(struct controller *ctrl);
162void pciehp_release_ctrl(struct controller *ctrl);
163int pciehp_reset_slot(struct slot *slot, int probe);
164
165static inline const char *slot_name(struct slot *slot)
166{
167	return hotplug_slot_name(slot->hotplug_slot);
168}
169
170#ifdef CONFIG_ACPI
171#include <linux/pci-acpi.h>
172
173void __init pciehp_acpi_slot_detection_init(void);
174int pciehp_acpi_slot_detection_check(struct pci_dev *dev);
175
176static inline void pciehp_firmware_init(void)
177{
178	pciehp_acpi_slot_detection_init();
179}
180#else
181#define pciehp_firmware_init()				do {} while (0)
182static inline int pciehp_acpi_slot_detection_check(struct pci_dev *dev)
183{
184	return 0;
185}
186#endif				/* CONFIG_ACPI */
187#endif				/* _PCIEHP_H */
188