[mirror_ubuntu-zesty-kernel.git] / drivers / pci / hotplug / shpchp.h

/*
 * Standard Hot Plug Controller Driver
 *
 * Copyright (C) 1995,2001 Compaq Computer Corporation
 * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
 * Copyright (C) 2001 IBM
 * 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 _SHPCHP_H
#define _SHPCHP_H

#include <linux/types.h>
#include <linux/pci.h>
#include <linux/delay.h>
#include <linux/sched.h>	/* signal_pending(), struct timer_list */

#include "pci_hotplug.h"

#if !defined(MODULE)
	#define MY_NAME	"shpchp"
#else
	#define MY_NAME	THIS_MODULE->name
#endif

extern int shpchp_poll_mode;
extern int shpchp_poll_time;
extern int shpchp_debug;

/*#define dbg(format, arg...) do { if (shpchp_debug) printk(KERN_DEBUG "%s: " format, MY_NAME , ## arg); } while (0)*/
#define dbg(format, arg...) do { if (shpchp_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_MAGIC	0x67267321
struct slot {
	u32 magic;
	struct slot *next;
	u8 bus;
	u8 device;
	u16 status;
	u32 number;
	u8 is_a_board;
	u8 state;
	u8 presence_save;
	u8 pwr_save;
	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;
};

struct event_info {
	u32 event_type;
	u8 hp_slot;
};

struct controller {
	struct controller *next;
	struct semaphore crit_sect;	/* critical section semaphore */
	struct php_ctlr_state_s *hpc_ctlr_handle; /* HPC controller handle */
	int num_slots;			/* Number of slots on ctlr */
	int slot_num_inc;		/* 1 or -1 */
	struct pci_dev *pci_dev;
	struct pci_bus *pci_bus;
	struct event_info event_queue[10];
	struct slot *slot;
	struct hpc_ops *hpc_ops;
	wait_queue_head_t queue;	/* sleep & wake process */
	u8 next_event;
	u8 bus;
	u8 device;
	u8 function;
	u8 slot_device_offset;
	u8 add_support;
	enum pci_bus_speed speed;
	u32 first_slot;		/* First physical slot number */
	u8 slot_bus;		/* Bus where the slots handled by this controller sit */
	u32 cap_offset;
	unsigned long mmio_base;
	unsigned long mmio_size;
	volatile int cmd_busy;
};

struct hotplug_params {
	u8	cache_line_size;
	u8	latency_timer;
	u8	enable_serr;
	u8	enable_perr;
};

/* Define AMD SHPC ID  */
#define PCI_DEVICE_ID_AMD_GOLAM_7450	0x7450 

#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

#define PCI_TO_PCI_BRIDGE_CLASS		0x00060400

/* 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

#define REMOVE_NOT_SUPPORTED		0x00000003

#define DISABLE_CARD			1

/*
 * error Messages
 */
#define msg_initialization_err	"Initialization failure, error=%d\n"
#define msg_button_on		"PCI slot #%d - powering on due to button press.\n"
#define msg_button_off		"PCI slot #%d - powering off due to button press.\n"
#define msg_button_cancel	"PCI slot #%d - action canceled due to button press.\n"

/* sysfs functions for the hotplug controller info */
extern void shpchp_create_ctrl_files	(struct controller *ctrl);

/* controller functions */
extern int	shpchp_event_start_thread(void);
extern void	shpchp_event_stop_thread(void);
extern int	shpchp_enable_slot(struct slot *slot);
extern int	shpchp_disable_slot(struct slot *slot);

extern u8	shpchp_handle_attention_button(u8 hp_slot, void *inst_id);
extern u8	shpchp_handle_switch_change(u8 hp_slot, void *inst_id);
extern u8	shpchp_handle_presence_change(u8 hp_slot, void *inst_id);
extern u8	shpchp_handle_power_fault(u8 hp_slot, void *inst_id);

/* pci functions */
extern int	shpchp_save_config(struct controller *ctrl, int busnumber, int num_ctlr_slots, int first_device_num);
extern int	shpchp_configure_device(struct slot *p_slot);
extern int	shpchp_unconfigure_device(struct slot *p_slot);
extern void	get_hp_hw_control_from_firmware(struct pci_dev *dev);
extern void	get_hp_params_from_firmware(struct pci_dev *dev,
		struct hotplug_params *hpp);
extern int	shpchprm_get_physical_slot_number(struct controller *ctrl,
		u32 *sun, u8 busnum, u8 devnum);
extern void	shpchp_remove_ctrl_files(struct controller *ctrl);


/* Global variables */
extern struct controller *shpchp_ctrl_list;

struct ctrl_reg {
	volatile u32 base_offset;
	volatile u32 slot_avail1;
	volatile u32 slot_avail2;
	volatile u32 slot_config;
	volatile u16 sec_bus_config;
	volatile u8  msi_ctrl;
	volatile u8  prog_interface;
	volatile u16 cmd;
	volatile u16 cmd_status;
	volatile u32 intr_loc;
	volatile u32 serr_loc;
	volatile u32 serr_intr_enable;
	volatile u32 slot1;
	volatile u32 slot2;
	volatile u32 slot3;
	volatile u32 slot4;
	volatile u32 slot5;
	volatile u32 slot6;
	volatile u32 slot7;
	volatile u32 slot8;
	volatile u32 slot9;
	volatile u32 slot10;
	volatile u32 slot11;
	volatile u32 slot12;
} __attribute__ ((packed));

/* offsets to the controller registers based on the above structure layout */
enum ctrl_offsets {
	BASE_OFFSET =	offsetof(struct ctrl_reg, base_offset),
	SLOT_AVAIL1 =	offsetof(struct ctrl_reg, slot_avail1),
	SLOT_AVAIL2	=	offsetof(struct ctrl_reg, slot_avail2),
	SLOT_CONFIG =	offsetof(struct ctrl_reg, slot_config),
	SEC_BUS_CONFIG =	offsetof(struct ctrl_reg, sec_bus_config),
	MSI_CTRL	=	offsetof(struct ctrl_reg, msi_ctrl),
	PROG_INTERFACE =	offsetof(struct ctrl_reg, prog_interface),
	CMD		=	offsetof(struct ctrl_reg, cmd),
	CMD_STATUS	=	offsetof(struct ctrl_reg, cmd_status),
	INTR_LOC	= 	offsetof(struct ctrl_reg, intr_loc),
	SERR_LOC	= 	offsetof(struct ctrl_reg, serr_loc),
	SERR_INTR_ENABLE =	offsetof(struct ctrl_reg, serr_intr_enable),
	SLOT1 =		offsetof(struct ctrl_reg, slot1),
	SLOT2 =		offsetof(struct ctrl_reg, slot2),
	SLOT3 =		offsetof(struct ctrl_reg, slot3),
	SLOT4 =		offsetof(struct ctrl_reg, slot4),
	SLOT5 =		offsetof(struct ctrl_reg, slot5),
	SLOT6 =		offsetof(struct ctrl_reg, slot6),		
	SLOT7 =		offsetof(struct ctrl_reg, slot7),
	SLOT8 =		offsetof(struct ctrl_reg, slot8),
	SLOT9 =		offsetof(struct ctrl_reg, slot9),
	SLOT10 =	offsetof(struct ctrl_reg, slot10),
	SLOT11 =	offsetof(struct ctrl_reg, slot11),
	SLOT12 =	offsetof(struct ctrl_reg, slot12),
};
typedef u8(*php_intr_callback_t) (u8 hp_slot, void *instance_id);
struct php_ctlr_state_s {
	struct php_ctlr_state_s *pnext;
	struct pci_dev *pci_dev;
	unsigned int irq;
	unsigned long flags;	/* spinlock's */
	u32 slot_device_offset;
	u32 num_slots;
    	struct timer_list	int_poll_timer;	/* Added for poll event */
	php_intr_callback_t attention_button_callback;
	php_intr_callback_t switch_change_callback;
	php_intr_callback_t presence_change_callback;
	php_intr_callback_t power_fault_callback;
	void *callback_instance_id;
	void __iomem *creg;			/* Ptr to controller register space */
};
/* Inline functions */


/* Inline functions to check the sanity of a pointer that is passed to us */
static inline int slot_paranoia_check (struct slot *slot, const char *function)
{
	if (!slot) {
		dbg("%s - slot == NULL", function);
		return -1;
	}
	if (slot->magic != SLOT_MAGIC) {
		dbg("%s - bad magic number for slot", function);
		return -1;
	}
	if (!slot->hotplug_slot) {
		dbg("%s - slot->hotplug_slot == NULL!", function);
		return -1;
	}
	return 0;
}

static inline struct slot *get_slot (struct hotplug_slot *hotplug_slot, const char *function)
{ 
	struct slot *slot;

	if (!hotplug_slot) {
		dbg("%s - hotplug_slot == NULL\n", function);
		return NULL;
	}

	slot = (struct slot *)hotplug_slot->private;
	if (slot_paranoia_check (slot, function))
                return NULL;
	return slot;
}

static inline struct slot *shpchp_find_slot (struct controller *ctrl, u8 device)
{
	struct slot *p_slot, *tmp_slot = NULL;

	if (!ctrl)
		return NULL;

	p_slot = ctrl->slot;

	while (p_slot && (p_slot->device != device)) {
		tmp_slot = p_slot;
		p_slot = p_slot->next;
	}
	if (p_slot == NULL) {
		err("ERROR: shpchp_find_slot device=0x%x\n", device);
		p_slot = tmp_slot;
	}

	return (p_slot);
}

static inline int wait_for_ctrl_irq (struct controller *ctrl)
{
    DECLARE_WAITQUEUE(wait, current);
	int retval = 0;

	add_wait_queue(&ctrl->queue, &wait);

	if (!shpchp_poll_mode) {
		/* Sleep for up to 1 second */
		msleep_interruptible(1000);
	} else {
		/* Sleep for up to 2 seconds */
		msleep_interruptible(2000);
	}
	remove_wait_queue(&ctrl->queue, &wait);
	if (signal_pending(current))
		retval =  -EINTR;

	return retval;
}

#define SLOT_NAME_SIZE 10

static inline void make_slot_name(char *buffer, int buffer_size, struct slot *slot)
{
	snprintf(buffer, buffer_size, "%04d_%04d", slot->bus, slot->number);
}

enum php_ctlr_type {
	PCI,
	ISA,
	ACPI
};

int shpc_init( struct controller *ctrl, struct pci_dev *pdev);

int shpc_get_ctlr_slot_config( struct controller *ctrl,
		int *num_ctlr_slots,
		int *first_device_num,
		int *physical_slot_num,
		int *updown,
		int *flags);

struct hpc_ops {
	int	(*power_on_slot )		(struct slot *slot);
	int	(*slot_enable )			(struct slot *slot);
	int	(*slot_disable )		(struct slot *slot);
	int	(*set_bus_speed_mode)	(struct slot *slot, enum pci_bus_speed speed);
	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_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_adapter_speed)	(struct slot *slot, enum pci_bus_speed *speed);
	int	(*get_mode1_ECC_cap)	(struct slot *slot, u8 *mode);
	int	(*get_prog_int)			(struct slot *slot, u8 *prog_int);

	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_cmd_status)		(struct controller *ctrl);
};

#endif				/* _SHPCHP_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Standard 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
	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 _SHPCHP_H
	30	#define _SHPCHP_H
	31
	32	#include <linux/types.h>
	33	#include <linux/pci.h>
	34	#include <linux/delay.h>
4e57b681 TS	35	#include <linux/sched.h> /* signal_pending(), struct timer_list */
4e57b681 TS	36
1da177e4 LT	37	#include "pci_hotplug.h"
	38
	39	#if !defined(MODULE)
	40	#define MY_NAME "shpchp"
	41	#else
	42	#define MY_NAME THIS_MODULE->name
	43	#endif
	44
	45	extern int shpchp_poll_mode;
	46	extern int shpchp_poll_time;
	47	extern int shpchp_debug;
	48
	49	/#define dbg(format, arg...) do { if (shpchp_debug) printk(KERN_DEBUG "%s: " format, MY_NAME , ## arg); } while (0)/
	50	#define dbg(format, arg...) do { if (shpchp_debug) printk("%s: " format, MY_NAME , ## arg); } while (0)
	51	#define err(format, arg...) printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
	52	#define info(format, arg...) printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
	53	#define warn(format, arg...) printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
	54
1da177e4 LT	55	#define SLOT_MAGIC 0x67267321
	56	struct slot {
	57	u32 magic;
	58	struct slot *next;
	59	u8 bus;
	60	u8 device;
2178bfad	61	u16 status;
1da177e4 LT	62	u32 number;
1da177e4 LT	63	u8 is_a_board;
1da177e4	64	u8 state;
1da177e4	65	u8 presence_save;
2178bfad	66	u8 pwr_save;
1da177e4 LT	67	struct timer_list task_event;
	68	u8 hp_slot;
	69	struct controller *ctrl;
	70	struct hpc_ops *hpc_ops;
	71	struct hotplug_slot *hotplug_slot;
	72	struct list_head slot_list;
	73	};
	74
1da177e4 LT	75	struct event_info {
	76	u32 event_type;
	77	u8 hp_slot;
	78	};
	79
	80	struct controller {
	81	struct controller *next;
	82	struct semaphore crit_sect; /* critical section semaphore */
ee138334	83	struct php_ctlr_state_s hpc_ctlr_handle; / HPC controller handle */
1da177e4 LT	84	int num_slots; /* Number of slots on ctlr */
1da177e4 LT	85	int slot_num_inc; /* 1 or -1 */
1da177e4 LT	86	struct pci_dev *pci_dev;
	87	struct pci_bus *pci_bus;
	88	struct event_info event_queue[10];
	89	struct slot *slot;
	90	struct hpc_ops *hpc_ops;
	91	wait_queue_head_t queue; /* sleep & wake process */
	92	u8 next_event;
1da177e4 LT	93	u8 bus;
	94	u8 device;
	95	u8 function;
1da177e4 LT	96	u8 slot_device_offset;
	97	u8 add_support;
	98	enum pci_bus_speed speed;
	99	u32 first_slot; /* First physical slot number */
	100	u8 slot_bus; /* Bus where the slots handled by this controller sit */
0455986c KK	101	u32 cap_offset;
	102	unsigned long mmio_base;
	103	unsigned long mmio_size;
bd62e271	104	volatile int cmd_busy;
1da177e4 LT	105	};
1da177e4 LT	106
424600f9 RS	107	struct hotplug_params {
	108	u8 cache_line_size;
	109	u8 latency_timer;
	110	u8 enable_serr;
	111	u8 enable_perr;
	112	};
	113
1da177e4 LT	114	/* Define AMD SHPC ID */
	115	#define PCI_DEVICE_ID_AMD_GOLAM_7450 0x7450
	116
	117	#define INT_BUTTON_IGNORE 0
	118	#define INT_PRESENCE_ON 1
	119	#define INT_PRESENCE_OFF 2
	120	#define INT_SWITCH_CLOSE 3
	121	#define INT_SWITCH_OPEN 4
	122	#define INT_POWER_FAULT 5
	123	#define INT_POWER_FAULT_CLEAR 6
	124	#define INT_BUTTON_PRESS 7
	125	#define INT_BUTTON_RELEASE 8
	126	#define INT_BUTTON_CANCEL 9
	127
	128	#define STATIC_STATE 0
	129	#define BLINKINGON_STATE 1
	130	#define BLINKINGOFF_STATE 2
	131	#define POWERON_STATE 3
	132	#define POWEROFF_STATE 4
	133
	134	#define PCI_TO_PCI_BRIDGE_CLASS 0x00060400
	135
	136	/* Error messages */
	137	#define INTERLOCK_OPEN 0x00000002
	138	#define ADD_NOT_SUPPORTED 0x00000003
	139	#define CARD_FUNCTIONING 0x00000005
	140	#define ADAPTER_NOT_SAME 0x00000006
	141	#define NO_ADAPTER_PRESENT 0x00000009
	142	#define NOT_ENOUGH_RESOURCES 0x0000000B
	143	#define DEVICE_TYPE_NOT_SUPPORTED 0x0000000C
	144	#define WRONG_BUS_FREQUENCY 0x0000000D
	145	#define POWER_FAILURE 0x0000000E
	146
	147	#define REMOVE_NOT_SUPPORTED 0x00000003
	148
	149	#define DISABLE_CARD 1
	150
	151	/*
	152	* error Messages
	153	*/
	154	#define msg_initialization_err "Initialization failure, error=%d\n"
1da177e4 LT	155	#define msg_button_on "PCI slot #%d - powering on due to button press.\n"
	156	#define msg_button_off "PCI slot #%d - powering off due to button press.\n"
	157	#define msg_button_cancel "PCI slot #%d - action canceled due to button press.\n"
1da177e4 LT	158
	159	/* sysfs functions for the hotplug controller info */
	160	extern void shpchp_create_ctrl_files (struct controller *ctrl);
	161
	162	/* controller functions */
1da177e4 LT	163	extern int shpchp_event_start_thread(void);
1da177e4 LT	164	extern void shpchp_event_stop_thread(void);
1da177e4 LT	165	extern int shpchp_enable_slot(struct slot *slot);
	166	extern int shpchp_disable_slot(struct slot *slot);
	167
	168	extern u8 shpchp_handle_attention_button(u8 hp_slot, void *inst_id);
	169	extern u8 shpchp_handle_switch_change(u8 hp_slot, void *inst_id);
	170	extern u8 shpchp_handle_presence_change(u8 hp_slot, void *inst_id);
	171	extern u8 shpchp_handle_power_fault(u8 hp_slot, void *inst_id);
	172
1da177e4	173	/* pci functions */
1da177e4	174	extern int shpchp_save_config(struct controller *ctrl, int busnumber, int num_ctlr_slots, int first_device_num);
dbd7a788	175	extern int shpchp_configure_device(struct slot *p_slot);
2178bfad	176	extern int shpchp_unconfigure_device(struct slot *p_slot);
424600f9 RS	177	extern void get_hp_hw_control_from_firmware(struct pci_dev *dev);
	178	extern void get_hp_params_from_firmware(struct pci_dev *dev,
	179	struct hotplug_params *hpp);
	180	extern int shpchprm_get_physical_slot_number(struct controller *ctrl,
	181	u32 *sun, u8 busnum, u8 devnum);
c2608a11	182	extern void shpchp_remove_ctrl_files(struct controller *ctrl);
1da177e4 LT	183
	184
	185	/* Global variables */
	186	extern struct controller *shpchp_ctrl_list;
1da177e4	187
1da177e4 LT	188	struct ctrl_reg {
	189	volatile u32 base_offset;
	190	volatile u32 slot_avail1;
	191	volatile u32 slot_avail2;
	192	volatile u32 slot_config;
	193	volatile u16 sec_bus_config;
	194	volatile u8 msi_ctrl;
	195	volatile u8 prog_interface;
	196	volatile u16 cmd;
	197	volatile u16 cmd_status;
	198	volatile u32 intr_loc;
	199	volatile u32 serr_loc;
	200	volatile u32 serr_intr_enable;
	201	volatile u32 slot1;
	202	volatile u32 slot2;
	203	volatile u32 slot3;
	204	volatile u32 slot4;
	205	volatile u32 slot5;
	206	volatile u32 slot6;
	207	volatile u32 slot7;
	208	volatile u32 slot8;
	209	volatile u32 slot9;
	210	volatile u32 slot10;
	211	volatile u32 slot11;
	212	volatile u32 slot12;
	213	} __attribute__ ((packed));
	214
	215	/* offsets to the controller registers based on the above structure layout */
	216	enum ctrl_offsets {
	217	BASE_OFFSET = offsetof(struct ctrl_reg, base_offset),
	218	SLOT_AVAIL1 = offsetof(struct ctrl_reg, slot_avail1),
	219	SLOT_AVAIL2 = offsetof(struct ctrl_reg, slot_avail2),
	220	SLOT_CONFIG = offsetof(struct ctrl_reg, slot_config),
	221	SEC_BUS_CONFIG = offsetof(struct ctrl_reg, sec_bus_config),
	222	MSI_CTRL = offsetof(struct ctrl_reg, msi_ctrl),
	223	PROG_INTERFACE = offsetof(struct ctrl_reg, prog_interface),
	224	CMD = offsetof(struct ctrl_reg, cmd),
	225	CMD_STATUS = offsetof(struct ctrl_reg, cmd_status),
	226	INTR_LOC = offsetof(struct ctrl_reg, intr_loc),
	227	SERR_LOC = offsetof(struct ctrl_reg, serr_loc),
	228	SERR_INTR_ENABLE = offsetof(struct ctrl_reg, serr_intr_enable),
	229	SLOT1 = offsetof(struct ctrl_reg, slot1),
	230	SLOT2 = offsetof(struct ctrl_reg, slot2),
	231	SLOT3 = offsetof(struct ctrl_reg, slot3),
	232	SLOT4 = offsetof(struct ctrl_reg, slot4),
	233	SLOT5 = offsetof(struct ctrl_reg, slot5),
	234	SLOT6 = offsetof(struct ctrl_reg, slot6),
	235	SLOT7 = offsetof(struct ctrl_reg, slot7),
	236	SLOT8 = offsetof(struct ctrl_reg, slot8),
	237	SLOT9 = offsetof(struct ctrl_reg, slot9),
	238	SLOT10 = offsetof(struct ctrl_reg, slot10),
	239	SLOT11 = offsetof(struct ctrl_reg, slot11),
	240	SLOT12 = offsetof(struct ctrl_reg, slot12),
	241	};
ee138334	242	typedef u8(php_intr_callback_t) (u8 hp_slot, void instance_id);
1da177e4 LT	243	struct php_ctlr_state_s {
	244	struct php_ctlr_state_s *pnext;
	245	struct pci_dev *pci_dev;
	246	unsigned int irq;
	247	unsigned long flags; /* spinlock's */
	248	u32 slot_device_offset;
	249	u32 num_slots;
	250	struct timer_list int_poll_timer; /* Added for poll event */
	251	php_intr_callback_t attention_button_callback;
	252	php_intr_callback_t switch_change_callback;
	253	php_intr_callback_t presence_change_callback;
	254	php_intr_callback_t power_fault_callback;
	255	void *callback_instance_id;
	256	void __iomem creg; / Ptr to controller register space */
	257	};
	258	/* Inline functions */
	259
	260
	261	/* Inline functions to check the sanity of a pointer that is passed to us */
	262	static inline int slot_paranoia_check (struct slot slot, const char function)
	263	{
	264	if (!slot) {
	265	dbg("%s - slot == NULL", function);
	266	return -1;
	267	}
	268	if (slot->magic != SLOT_MAGIC) {
	269	dbg("%s - bad magic number for slot", function);
	270	return -1;
	271	}
	272	if (!slot->hotplug_slot) {
	273	dbg("%s - slot->hotplug_slot == NULL!", function);
	274	return -1;
	275	}
	276	return 0;
	277	}
	278
	279	static inline struct slot get_slot (struct hotplug_slot hotplug_slot, const char *function)
	280	{
	281	struct slot *slot;
	282
	283	if (!hotplug_slot) {
	284	dbg("%s - hotplug_slot == NULL\n", function);
	285	return NULL;
	286	}
	287
	288	slot = (struct slot *)hotplug_slot->private;
	289	if (slot_paranoia_check (slot, function))
	290	return NULL;
	291	return slot;
	292	}
	293
	294	static inline struct slot shpchp_find_slot (struct controller ctrl, u8 device)
	295	{
	296	struct slot p_slot, tmp_slot = NULL;
	297
	298	if (!ctrl)
	299	return NULL;
	300
	301	p_slot = ctrl->slot;
	302
1da177e4 LT	303	while (p_slot && (p_slot->device != device)) {
	304	tmp_slot = p_slot;
	305	p_slot = p_slot->next;
1da177e4 LT	306	}
	307	if (p_slot == NULL) {
	308	err("ERROR: shpchp_find_slot device=0x%x\n", device);
	309	p_slot = tmp_slot;
	310	}
	311
	312	return (p_slot);
	313	}
	314
	315	static inline int wait_for_ctrl_irq (struct controller *ctrl)
	316	{
	317	DECLARE_WAITQUEUE(wait, current);
	318	int retval = 0;
	319
1da177e4 LT	320	add_wait_queue(&ctrl->queue, &wait);
	321
	322	if (!shpchp_poll_mode) {
	323	/* Sleep for up to 1 second */
	324	msleep_interruptible(1000);
	325	} else {
	326	/* Sleep for up to 2 seconds */
	327	msleep_interruptible(2000);
	328	}
	329	remove_wait_queue(&ctrl->queue, &wait);
	330	if (signal_pending(current))
	331	retval = -EINTR;
	332
1da177e4 LT	333	return retval;
	334	}
	335
1da177e4 LT	336	#define SLOT_NAME_SIZE 10
	337
	338	static inline void make_slot_name(char buffer, int buffer_size, struct slot slot)
	339	{
1248d636	340	snprintf(buffer, buffer_size, "%04d_%04d", slot->bus, slot->number);
1da177e4 LT	341	}
	342
	343	enum php_ctlr_type {
	344	PCI,
	345	ISA,
	346	ACPI
	347	};
	348
ee138334	349	int shpc_init( struct controller ctrl, struct pci_dev pdev);
1da177e4 LT	350
	351	int shpc_get_ctlr_slot_config( struct controller *ctrl,
	352	int *num_ctlr_slots,
	353	int *first_device_num,
	354	int *physical_slot_num,
	355	int *updown,
	356	int *flags);
	357
	358	struct hpc_ops {
	359	int (power_on_slot ) (struct slot slot);
	360	int (slot_enable ) (struct slot slot);
	361	int (slot_disable ) (struct slot slot);
1da177e4 LT	362	int (set_bus_speed_mode) (struct slot slot, enum pci_bus_speed speed);
	363	int (get_power_status) (struct slot slot, u8 *status);
	364	int (get_attention_status) (struct slot slot, u8 *status);
	365	int (set_attention_status) (struct slot slot, u8 status);
	366	int (get_latch_status) (struct slot slot, u8 *status);
	367	int (get_adapter_status) (struct slot slot, u8 *status);
	368
	369	int (get_max_bus_speed) (struct slot slot, enum pci_bus_speed *speed);
	370	int (get_cur_bus_speed) (struct slot slot, enum pci_bus_speed *speed);
	371	int (get_adapter_speed) (struct slot slot, enum pci_bus_speed *speed);
	372	int (get_mode1_ECC_cap) (struct slot slot, u8 *mode);
	373	int (get_prog_int) (struct slot slot, u8 *prog_int);
	374
	375	int (query_power_fault) (struct slot slot);
	376	void (green_led_on) (struct slot slot);
	377	void (green_led_off) (struct slot slot);
	378	void (green_led_blink) (struct slot slot);
	379	void (release_ctlr) (struct controller ctrl);
	380	int (check_cmd_status) (struct controller ctrl);
	381	};
	382
	383	#endif /* _SHPCHP_H */