[net-next-2.6.git] / drivers / pci / hotplug / pciehp.h

/*
 * PCI Express Hot Plug Controller Driver
 *
 * Copyright (C) 1995,2001 Compaq Computer Corporation
 * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
 * Copyright (C) 2001 IBM Corp.
 * Copyright (C) 2003-2004 Intel Corporation
 *
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
 * NON INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * Send feedback to <greg@kroah.com>, <kristen.c.accardi@intel.com>
 *
 */
#ifndef _PCIEHP_H
#define _PCIEHP_H

#include <linux/types.h>
#include <linux/pci.h>
#include <linux/pci_hotplug.h>
#include <linux/delay.h>
#include <linux/sched.h>		/* signal_pending() */
#include <linux/pcieport_if.h>
#include <linux/mutex.h>

#define MY_NAME	"pciehp"

extern int pciehp_poll_mode;
extern int pciehp_poll_time;
extern int pciehp_debug;
extern int pciehp_force;
extern struct workqueue_struct *pciehp_wq;

#define dbg(format, arg...)						\
	do {								\
		if (pciehp_debug)					\
			printk("%s: " format, MY_NAME , ## arg);	\
	} while (0)
#define err(format, arg...)						\
	printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
#define info(format, arg...)						\
	printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
#define warn(format, arg...)						\
	printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)

#define SLOT_NAME_SIZE 10
struct slot {
	u8 bus;
	u8 device;
	u32 number;
	u8 state;
	struct timer_list task_event;
	u8 hp_slot;
	struct controller *ctrl;
	struct hpc_ops *hpc_ops;
	struct hotplug_slot *hotplug_slot;
	struct list_head	slot_list;
	char name[SLOT_NAME_SIZE];
	unsigned long last_emi_toggle;
	struct delayed_work work;	/* work for button event */
	struct mutex lock;
};

struct event_info {
	u32 event_type;
	struct slot *p_slot;
	struct work_struct work;
};

struct controller {
	struct mutex crit_sect;		/* critical section mutex */
	struct mutex ctrl_lock;		/* controller lock */
	int num_slots;			/* Number of slots on ctlr */
	int slot_num_inc;		/* 1 or -1 */
	struct pci_dev *pci_dev;
	struct pcie_device *pcie;	/* PCI Express port service */
	struct list_head slot_list;
	struct hpc_ops *hpc_ops;
	wait_queue_head_t queue;	/* sleep & wake process */
	u8 slot_device_offset;
	u32 first_slot;		/* First physical slot number */  /* PCIE only has 1 slot */
	u8 slot_bus;		/* Bus where the slots handled by this controller sit */
	u32 slot_cap;
	u8 cap_base;
	struct timer_list poll_timer;
	int cmd_busy;
	unsigned int no_cmd_complete:1;
};

#define INT_BUTTON_IGNORE		0
#define INT_PRESENCE_ON			1
#define INT_PRESENCE_OFF		2
#define INT_SWITCH_CLOSE		3
#define INT_SWITCH_OPEN			4
#define INT_POWER_FAULT			5
#define INT_POWER_FAULT_CLEAR		6
#define INT_BUTTON_PRESS		7
#define INT_BUTTON_RELEASE		8
#define INT_BUTTON_CANCEL		9

#define STATIC_STATE			0
#define BLINKINGON_STATE		1
#define BLINKINGOFF_STATE		2
#define POWERON_STATE			3
#define POWEROFF_STATE			4

/* Error messages */
#define INTERLOCK_OPEN			0x00000002
#define ADD_NOT_SUPPORTED		0x00000003
#define CARD_FUNCTIONING		0x00000005
#define ADAPTER_NOT_SAME		0x00000006
#define NO_ADAPTER_PRESENT		0x00000009
#define NOT_ENOUGH_RESOURCES		0x0000000B
#define DEVICE_TYPE_NOT_SUPPORTED	0x0000000C
#define WRONG_BUS_FREQUENCY		0x0000000D
#define POWER_FAILURE			0x0000000E

/* Field definitions in Slot Capabilities Register */
#define ATTN_BUTTN_PRSN	0x00000001
#define	PWR_CTRL_PRSN	0x00000002
#define MRL_SENS_PRSN	0x00000004
#define ATTN_LED_PRSN	0x00000008
#define PWR_LED_PRSN	0x00000010
#define HP_SUPR_RM_SUP	0x00000020
#define EMI_PRSN	0x00020000
#define NO_CMD_CMPL_SUP	0x00040000

#define ATTN_BUTTN(ctrl)	((ctrl)->slot_cap & ATTN_BUTTN_PRSN)
#define POWER_CTRL(ctrl)	((ctrl)->slot_cap & PWR_CTRL_PRSN)
#define MRL_SENS(ctrl)		((ctrl)->slot_cap & MRL_SENS_PRSN)
#define ATTN_LED(ctrl)		((ctrl)->slot_cap & ATTN_LED_PRSN)
#define PWR_LED(ctrl)		((ctrl)->slot_cap & PWR_LED_PRSN)
#define HP_SUPR_RM(ctrl)	((ctrl)->slot_cap & HP_SUPR_RM_SUP)
#define EMI(ctrl)		((ctrl)->slot_cap & EMI_PRSN)
#define NO_CMD_CMPL(ctrl)	((ctrl)->slot_cap & NO_CMD_CMPL_SUP)

extern int pciehp_sysfs_enable_slot(struct slot *slot);
extern int pciehp_sysfs_disable_slot(struct slot *slot);
extern u8 pciehp_handle_attention_button(struct slot *p_slot);
  extern u8 pciehp_handle_switch_change(struct slot *p_slot);
extern u8 pciehp_handle_presence_change(struct slot *p_slot);
extern u8 pciehp_handle_power_fault(struct slot *p_slot);
extern int pciehp_configure_device(struct slot *p_slot);
extern int pciehp_unconfigure_device(struct slot *p_slot);
extern void pciehp_queue_pushbutton_work(struct work_struct *work);
struct controller *pcie_init(struct pcie_device *dev);
int pciehp_enable_slot(struct slot *p_slot);
int pciehp_disable_slot(struct slot *p_slot);
int pcie_enable_notification(struct controller *ctrl);

static inline struct slot *pciehp_find_slot(struct controller *ctrl, u8 device)
{
	struct slot *slot;

	list_for_each_entry(slot, &ctrl->slot_list, slot_list) {
		if (slot->device == device)
			return slot;
	}

	err("%s: slot (device=0x%x) not found\n", __func__, device);
	return NULL;
}

struct hpc_ops {
	int (*power_on_slot)(struct slot *slot);
	int (*power_off_slot)(struct slot *slot);
	int (*get_power_status)(struct slot *slot, u8 *status);
	int (*get_attention_status)(struct slot *slot, u8 *status);
	int (*set_attention_status)(struct slot *slot, u8 status);
	int (*get_latch_status)(struct slot *slot, u8 *status);
	int (*get_adapter_status)(struct slot *slot, u8 *status);
	int (*get_emi_status)(struct slot *slot, u8 *status);
	int (*toggle_emi)(struct slot *slot);
	int (*get_max_bus_speed)(struct slot *slot, enum pci_bus_speed *speed);
	int (*get_cur_bus_speed)(struct slot *slot, enum pci_bus_speed *speed);
	int (*get_max_lnk_width)(struct slot *slot, enum pcie_link_width *val);
	int (*get_cur_lnk_width)(struct slot *slot, enum pcie_link_width *val);
	int (*query_power_fault)(struct slot *slot);
	void (*green_led_on)(struct slot *slot);
	void (*green_led_off)(struct slot *slot);
	void (*green_led_blink)(struct slot *slot);
	void (*release_ctlr)(struct controller *ctrl);
	int (*check_lnk_status)(struct controller *ctrl);
};

#ifdef CONFIG_ACPI
#include <acpi/acpi.h>
#include <acpi/acpi_bus.h>
#include <acpi/actypes.h>
#include <linux/pci-acpi.h>

static inline int pciehp_get_hp_hw_control_from_firmware(struct pci_dev *dev)
{
	u32 flags = (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL |
		     OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL);
	return acpi_get_hp_hw_control_from_firmware(dev, flags);
}

static inline int pciehp_get_hp_params_from_firmware(struct pci_dev *dev,
			struct hotplug_params *hpp)
{
	if (ACPI_FAILURE(acpi_get_hp_params_from_firmware(dev->bus, hpp)))
		return -ENODEV;
	return 0;
}
#else
#define pciehp_get_hp_hw_control_from_firmware(dev) 	0
#define pciehp_get_hp_params_from_firmware(dev, hpp)    (-ENODEV)
#endif 				/* CONFIG_ACPI */
#endif				/* _PCIEHP_H */
Commit	Line	Data
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
	42	extern int pciehp_poll_mode;
	43	extern int pciehp_poll_time;
	44	extern int pciehp_debug;
a3a45ec8	45	extern int pciehp_force;
5d386e1a	46	extern struct workqueue_struct *pciehp_wq;
1da177e4	47
15232ece KK	48	#define dbg(format, arg...) \
	49	do { \
	50	if (pciehp_debug) \
	51	printk("%s: " format, MY_NAME , ## arg); \
	52	} while (0)
	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
a0b17257	60	#define SLOT_NAME_SIZE 10
1da177e4	61	struct slot {
1da177e4 LT	62	u8 bus;
	63	u8 device;
	64	u32 number;
1da177e4	65	u8 state;
1da177e4 LT	66	struct timer_list task_event;
	67	u8 hp_slot;
	68	struct controller *ctrl;
	69	struct hpc_ops *hpc_ops;
	70	struct hotplug_slot *hotplug_slot;
	71	struct list_head slot_list;
a0b17257	72	char name[SLOT_NAME_SIZE];
34d03419	73	unsigned long last_emi_toggle;
5d386e1a KK	74	struct delayed_work work; /* work for button event */
5d386e1a KK	75	struct mutex lock;
1da177e4 LT	76	};
1da177e4 LT	77
1da177e4 LT	78	struct event_info {
1da177e4 LT	79	u32 event_type;
5d386e1a KK	80	struct slot *p_slot;
5d386e1a KK	81	struct work_struct work;
1da177e4 LT	82	};
	83
	84	struct controller {
6aa4cdd0	85	struct mutex crit_sect; /* critical section mutex */
dd5619cb	86	struct mutex ctrl_lock; /* controller lock */
1da177e4 LT	87	int num_slots; /* Number of slots on ctlr */
1da177e4 LT	88	int slot_num_inc; /* 1 or -1 */
1da177e4	89	struct pci_dev *pci_dev;
f7a10e32	90	struct pcie_device pcie; / PCI Express port service */
2410fa4e	91	struct list_head slot_list;
1da177e4 LT	92	struct hpc_ops *hpc_ops;
1da177e4 LT	93	wait_queue_head_t queue; /* sleep & wake process */
1da177e4	94	u8 slot_device_offset;
1da177e4 LT	95	u32 first_slot; /* First physical slot number / / PCIE only has 1 slot */
1da177e4 LT	96	u8 slot_bus; /* Bus where the slots handled by this controller sit */
ae416e6b	97	u32 slot_cap;
8b245e45	98	u8 cap_base;
48fe3915	99	struct timer_list poll_timer;
9fce1bc9	100	int cmd_busy;
5808639b	101	unsigned int no_cmd_complete:1;
1da177e4 LT	102	};
1da177e4 LT	103
1da177e4 LT	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
	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
1da177e4 LT	121	/* 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
1da177e4 LT	132	/* 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
34d03419	139	#define EMI_PRSN 0x00020000
5808639b	140	#define NO_CMD_CMPL_SUP 0x00040000
1da177e4	141
ae416e6b KK	142	#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)
5808639b	149	#define NO_CMD_CMPL(ctrl) ((ctrl)->slot_cap & NO_CMD_CMPL_SUP)
1da177e4	150
5d386e1a KK	151	extern int pciehp_sysfs_enable_slot(struct slot *slot);
5d386e1a KK	152	extern int pciehp_sysfs_disable_slot(struct slot *slot);
dbd79aed KK	153	extern u8 pciehp_handle_attention_button(struct slot *p_slot);
	154	extern u8 pciehp_handle_switch_change(struct slot *p_slot);
	155	extern u8 pciehp_handle_presence_change(struct slot *p_slot);
	156	extern u8 pciehp_handle_power_fault(struct slot *p_slot);
15232ece KK	157	extern int pciehp_configure_device(struct slot *p_slot);
15232ece KK	158	extern int pciehp_unconfigure_device(struct slot *p_slot);
e325e1f0	159	extern void pciehp_queue_pushbutton_work(struct work_struct *work);
c4635eb0	160	struct controller pcie_init(struct pcie_device dev);
0a3c33d7	161	int pciehp_enable_slot(struct slot *p_slot);
cd2fe83a	162	int pciehp_disable_slot(struct slot *p_slot);
c4635eb0	163	int pcie_enable_notification(struct controller *ctrl);
1da177e4	164
1da177e4 LT	165	static inline struct slot pciehp_find_slot(struct controller ctrl, u8 device)
1da177e4 LT	166	{
2410fa4e	167	struct slot *slot;
1da177e4	168
2410fa4e KK	169	list_for_each_entry(slot, &ctrl->slot_list, slot_list) {
	170	if (slot->device == device)
	171	return slot;
1da177e4 LT	172	}
1da177e4 LT	173
66bef8c0	174	err("%s: slot (device=0x%x) not found\n", __func__, device);
2410fa4e	175	return NULL;
1da177e4 LT	176	}
1da177e4 LT	177
1da177e4	178	struct hpc_ops {
15232ece KK	179	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);
34d03419 KCA	186	int (get_emi_status)(struct slot slot, u8 *status);
34d03419 KCA	187	int (toggle_emi)(struct slot slot);
15232ece KK	188	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);
1da177e4 LT	198	};
1da177e4 LT	199
783c49fc	200	#ifdef CONFIG_ACPI
e50d1088 KCA	201	#include <acpi/acpi.h>
	202	#include <acpi/acpi_bus.h>
	203	#include <acpi/actypes.h>
	204	#include <linux/pci-acpi.h>
	205
ac9c052d KK	206	static 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
783c49fc KA	213	static inline int pciehp_get_hp_params_from_firmware(struct pci_dev *dev,
	214	struct hotplug_params *hpp)
	215	{
7430e34c	216	if (ACPI_FAILURE(acpi_get_hp_params_from_firmware(dev->bus, hpp)))
783c49fc KA	217	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 */
1da177e4	224	#endif /* _PCIEHP_H */