[deliverable/linux.git] / include / linux / irq.h

#ifndef _LINUX_IRQ_H
#define _LINUX_IRQ_H

/*
 * Please do not include this file in generic code.  There is currently
 * no requirement for any architecture to implement anything held
 * within this file.
 *
 * Thanks. --rmk
 */

#include <linux/smp.h>

#ifndef CONFIG_S390

#include <linux/linkage.h>
#include <linux/cache.h>
#include <linux/spinlock.h>
#include <linux/cpumask.h>
#include <linux/gfp.h>
#include <linux/irqreturn.h>
#include <linux/irqnr.h>
#include <linux/errno.h>
#include <linux/topology.h>
#include <linux/wait.h>

#include <asm/irq.h>
#include <asm/ptrace.h>
#include <asm/irq_regs.h>

struct irq_desc;
typedef	void (*irq_flow_handler_t)(unsigned int irq,
					    struct irq_desc *desc);


/*
 * IRQ line status.
 *
 * Bits 0-7 are reserved for the IRQF_* bits in linux/interrupt.h
 *
 * IRQ types
 */
#define IRQ_TYPE_NONE		0x00000000	/* Default, unspecified type */
#define IRQ_TYPE_EDGE_RISING	0x00000001	/* Edge rising type */
#define IRQ_TYPE_EDGE_FALLING	0x00000002	/* Edge falling type */
#define IRQ_TYPE_EDGE_BOTH (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING)
#define IRQ_TYPE_LEVEL_HIGH	0x00000004	/* Level high type */
#define IRQ_TYPE_LEVEL_LOW	0x00000008	/* Level low type */
#define IRQ_TYPE_SENSE_MASK	0x0000000f	/* Mask of the above */
#define IRQ_TYPE_PROBE		0x00000010	/* Probing in progress */

/* Internal flags */

#ifndef CONFIG_GENERIC_HARDIRQS_NO_COMPAT
#define IRQ_INPROGRESS		0x00000100	/* DEPRECATED */
#define IRQ_REPLAY		0x00000200	/* DEPRECATED */
#define IRQ_WAITING		0x00000400	/* DEPRECATED */
#define IRQ_DISABLED		0x00000800	/* DEPRECATED */
#define IRQ_PENDING		0x00001000	/* DEPRECATED */
#define IRQ_MASKED		0x00002000	/* DEPRECATED */
#endif

#define IRQ_LEVEL		0x00004000	/* IRQ level triggered */
#define IRQ_PER_CPU		0x00010000	/* IRQ is per CPU */
#define IRQ_NOPROBE		0x00020000	/* IRQ is not valid for probing */
#define IRQ_NOREQUEST		0x00040000	/* IRQ cannot be requested */
#define IRQ_NOAUTOEN		0x00080000	/* IRQ will not be enabled on request irq */
#define IRQ_WAKEUP		0x00100000	/* IRQ triggers system wakeup */
#define IRQ_MOVE_PENDING	0x00200000	/* need to re-target IRQ destination */
#define IRQ_NO_BALANCING	0x00400000	/* IRQ is excluded from balancing */
#define IRQ_MOVE_PCNTXT		0x01000000	/* IRQ migration from process context */
#define IRQ_AFFINITY_SET	0x02000000	/* IRQ affinity was set from userspace*/
#define IRQ_NESTED_THREAD	0x10000000	/* IRQ is nested into another, no own handler thread */

#define IRQF_MODIFY_MASK	\
	(IRQ_TYPE_SENSE_MASK | IRQ_NOPROBE | IRQ_NOREQUEST | \
	 IRQ_NOAUTOEN | IRQ_MOVE_PCNTXT | IRQ_LEVEL | IRQ_NO_BALANCING | \
	 IRQ_PER_CPU | IRQ_NESTED_THREAD)

#ifdef CONFIG_IRQ_PER_CPU
# define CHECK_IRQ_PER_CPU(var) ((var) & IRQ_PER_CPU)
# define IRQ_NO_BALANCING_MASK	(IRQ_PER_CPU | IRQ_NO_BALANCING)
#else
# define CHECK_IRQ_PER_CPU(var) 0
# define IRQ_NO_BALANCING_MASK	IRQ_NO_BALANCING
#endif

/*
 * Return value for chip->irq_set_affinity()
 *
 * IRQ_SET_MASK_OK	- OK, core updates irq_data.affinity
 * IRQ_SET_MASK_NOCPY	- OK, chip did update irq_data.affinity
 */
enum {
	IRQ_SET_MASK_OK = 0,
	IRQ_SET_MASK_OK_NOCOPY,
};

struct msi_desc;

/**
 * struct irq_data - per irq and irq chip data passed down to chip functions
 * @irq:		interrupt number
 * @node:		node index useful for balancing
 * @chip:		low level interrupt hardware access
 * @handler_data:	per-IRQ data for the irq_chip methods
 * @chip_data:		platform-specific per-chip private data for the chip
 *			methods, to allow shared chip implementations
 * @msi_desc:		MSI descriptor
 * @affinity:		IRQ affinity on SMP
 *
 * The fields here need to overlay the ones in irq_desc until we
 * cleaned up the direct references and switched everything over to
 * irq_data.
 */
struct irq_data {
	unsigned int		irq;
	unsigned int		node;
	struct irq_chip		*chip;
	void			*handler_data;
	void			*chip_data;
	struct msi_desc		*msi_desc;
#ifdef CONFIG_SMP
	cpumask_var_t		affinity;
#endif
};

/**
 * struct irq_chip - hardware interrupt chip descriptor
 *
 * @name:		name for /proc/interrupts
 * @startup:		deprecated, replaced by irq_startup
 * @shutdown:		deprecated, replaced by irq_shutdown
 * @enable:		deprecated, replaced by irq_enable
 * @disable:		deprecated, replaced by irq_disable
 * @ack:		deprecated, replaced by irq_ack
 * @mask:		deprecated, replaced by irq_mask
 * @mask_ack:		deprecated, replaced by irq_mask_ack
 * @unmask:		deprecated, replaced by irq_unmask
 * @eoi:		deprecated, replaced by irq_eoi
 * @end:		deprecated, will go away with __do_IRQ()
 * @set_affinity:	deprecated, replaced by irq_set_affinity
 * @retrigger:		deprecated, replaced by irq_retrigger
 * @set_type:		deprecated, replaced by irq_set_type
 * @set_wake:		deprecated, replaced by irq_wake
 * @bus_lock:		deprecated, replaced by irq_bus_lock
 * @bus_sync_unlock:	deprecated, replaced by irq_bus_sync_unlock
 *
 * @irq_startup:	start up the interrupt (defaults to ->enable if NULL)
 * @irq_shutdown:	shut down the interrupt (defaults to ->disable if NULL)
 * @irq_enable:		enable the interrupt (defaults to chip->unmask if NULL)
 * @irq_disable:	disable the interrupt
 * @irq_ack:		start of a new interrupt
 * @irq_mask:		mask an interrupt source
 * @irq_mask_ack:	ack and mask an interrupt source
 * @irq_unmask:		unmask an interrupt source
 * @irq_eoi:		end of interrupt
 * @irq_set_affinity:	set the CPU affinity on SMP machines
 * @irq_retrigger:	resend an IRQ to the CPU
 * @irq_set_type:	set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
 * @irq_set_wake:	enable/disable power-management wake-on of an IRQ
 * @irq_bus_lock:	function to lock access to slow bus (i2c) chips
 * @irq_bus_sync_unlock:function to sync and unlock slow bus (i2c) chips
 *
 * @release:		release function solely used by UML
 */
struct irq_chip {
	const char	*name;
#ifndef CONFIG_GENERIC_HARDIRQS_NO_DEPRECATED
	unsigned int	(*startup)(unsigned int irq);
	void		(*shutdown)(unsigned int irq);
	void		(*enable)(unsigned int irq);
	void		(*disable)(unsigned int irq);

	void		(*ack)(unsigned int irq);
	void		(*mask)(unsigned int irq);
	void		(*mask_ack)(unsigned int irq);
	void		(*unmask)(unsigned int irq);
	void		(*eoi)(unsigned int irq);

	void		(*end)(unsigned int irq);
	int		(*set_affinity)(unsigned int irq,
					const struct cpumask *dest);
	int		(*retrigger)(unsigned int irq);
	int		(*set_type)(unsigned int irq, unsigned int flow_type);
	int		(*set_wake)(unsigned int irq, unsigned int on);

	void		(*bus_lock)(unsigned int irq);
	void		(*bus_sync_unlock)(unsigned int irq);
#endif
	unsigned int	(*irq_startup)(struct irq_data *data);
	void		(*irq_shutdown)(struct irq_data *data);
	void		(*irq_enable)(struct irq_data *data);
	void		(*irq_disable)(struct irq_data *data);

	void		(*irq_ack)(struct irq_data *data);
	void		(*irq_mask)(struct irq_data *data);
	void		(*irq_mask_ack)(struct irq_data *data);
	void		(*irq_unmask)(struct irq_data *data);
	void		(*irq_eoi)(struct irq_data *data);

	int		(*irq_set_affinity)(struct irq_data *data, const struct cpumask *dest, bool force);
	int		(*irq_retrigger)(struct irq_data *data);
	int		(*irq_set_type)(struct irq_data *data, unsigned int flow_type);
	int		(*irq_set_wake)(struct irq_data *data, unsigned int on);

	void		(*irq_bus_lock)(struct irq_data *data);
	void		(*irq_bus_sync_unlock)(struct irq_data *data);

	/* Currently used only by UML, might disappear one day.*/
#ifdef CONFIG_IRQ_RELEASE_METHOD
	void		(*release)(unsigned int irq, void *dev_id);
#endif
};

/* This include will go away once we isolated irq_desc usage to core code */
#include <linux/irqdesc.h>

/*
 * Pick up the arch-dependent methods:
 */
#include <asm/hw_irq.h>

#ifndef NR_IRQS_LEGACY
# define NR_IRQS_LEGACY 0
#endif

#ifndef ARCH_IRQ_INIT_FLAGS
# define ARCH_IRQ_INIT_FLAGS	0
#endif

#define IRQ_DEFAULT_INIT_FLAGS	ARCH_IRQ_INIT_FLAGS

struct irqaction;
extern int setup_irq(unsigned int irq, struct irqaction *new);
extern void remove_irq(unsigned int irq, struct irqaction *act);

#ifdef CONFIG_GENERIC_HARDIRQS

#if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_PENDING_IRQ)
void move_native_irq(int irq);
void move_masked_irq(int irq);
#else
static inline void move_native_irq(int irq) { }
static inline void move_masked_irq(int irq) { }
#endif

extern int no_irq_affinity;

/* Handle irq action chains: */
extern irqreturn_t handle_IRQ_event(unsigned int irq, struct irqaction *action);

/*
 * Built-in IRQ handlers for various IRQ types,
 * callable via desc->handle_irq()
 */
extern void handle_level_irq(unsigned int irq, struct irq_desc *desc);
extern void handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
extern void handle_edge_irq(unsigned int irq, struct irq_desc *desc);
extern void handle_simple_irq(unsigned int irq, struct irq_desc *desc);
extern void handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
extern void handle_bad_irq(unsigned int irq, struct irq_desc *desc);
extern void handle_nested_irq(unsigned int irq);

/* Handling of unhandled and spurious interrupts: */
extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
			   irqreturn_t action_ret);


/* Enable/disable irq debugging output: */
extern int noirqdebug_setup(char *str);

/* Checks whether the interrupt can be requested by request_irq(): */
extern int can_request_irq(unsigned int irq, unsigned long irqflags);

/* Dummy irq-chip implementations: */
extern struct irq_chip no_irq_chip;
extern struct irq_chip dummy_irq_chip;

extern void
set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
			 irq_flow_handler_t handle);
extern void
set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
			      irq_flow_handler_t handle, const char *name);

extern void
__set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
		  const char *name);

/*
 * Set a highlevel flow handler for a given IRQ:
 */
static inline void
set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
{
	__set_irq_handler(irq, handle, 0, NULL);
}

/*
 * Set a highlevel chained flow handler for a given IRQ.
 * (a chained handler is automatically enabled and set to
 *  IRQ_NOREQUEST and IRQ_NOPROBE)
 */
static inline void
set_irq_chained_handler(unsigned int irq, irq_flow_handler_t handle)
{
	__set_irq_handler(irq, handle, 1, NULL);
}

void irq_modify_status(unsigned int irq, unsigned long clr, unsigned long set);

static inline void irq_set_status_flags(unsigned int irq, unsigned long set)
{
	irq_modify_status(irq, 0, set);
}

static inline void irq_clear_status_flags(unsigned int irq, unsigned long clr)
{
	irq_modify_status(irq, clr, 0);
}

static inline void irq_set_noprobe(unsigned int irq)
{
	irq_modify_status(irq, 0, IRQ_NOPROBE);
}

static inline void irq_set_probe(unsigned int irq)
{
	irq_modify_status(irq, IRQ_NOPROBE, 0);
}

static inline void irq_set_nested_thread(unsigned int irq, bool nest)
{
	if (nest)
		irq_set_status_flags(irq, IRQ_NESTED_THREAD);
	else
		irq_clear_status_flags(irq, IRQ_NESTED_THREAD);
}

/* Handle dynamic irq creation and destruction */
extern unsigned int create_irq_nr(unsigned int irq_want, int node);
extern int create_irq(void);
extern void destroy_irq(unsigned int irq);

/*
 * Dynamic irq helper functions. Obsolete. Use irq_alloc_desc* and
 * irq_free_desc instead.
 */
extern void dynamic_irq_cleanup(unsigned int irq);
static inline void dynamic_irq_init(unsigned int irq)
{
	dynamic_irq_cleanup(irq);
}

/* Set/get chip/data for an IRQ: */
extern int irq_set_chip(unsigned int irq, struct irq_chip *chip);
extern int irq_set_handler_data(unsigned int irq, void *data);
extern int irq_set_chip_data(unsigned int irq, void *data);
extern int irq_set_irq_type(unsigned int irq, unsigned int type);
extern int irq_set_msi_desc(unsigned int irq, struct msi_desc *entry);
extern struct irq_data *irq_get_irq_data(unsigned int irq);

static inline struct irq_chip *irq_get_chip(unsigned int irq)
{
	struct irq_data *d = irq_get_irq_data(irq);
	return d ? d->chip : NULL;
}

static inline struct irq_chip *irq_data_get_irq_chip(struct irq_data *d)
{
	return d->chip;
}

static inline void *irq_get_chip_data(unsigned int irq)
{
	struct irq_data *d = irq_get_irq_data(irq);
	return d ? d->chip_data : NULL;
}

static inline void *irq_data_get_irq_chip_data(struct irq_data *d)
{
	return d->chip_data;
}

static inline void *irq_get_handler_data(unsigned int irq)
{
	struct irq_data *d = irq_get_irq_data(irq);
	return d ? d->handler_data : NULL;
}

static inline void *irq_data_get_irq_handler_data(struct irq_data *d)
{
	return d->handler_data;
}

static inline struct msi_desc *irq_get_msi_desc(unsigned int irq)
{
	struct irq_data *d = irq_get_irq_data(irq);
	return d ? d->msi_desc : NULL;
}

static inline struct msi_desc *irq_data_get_msi(struct irq_data *d)
{
	return d->msi_desc;
}

#ifndef CONFIG_GENERIC_HARDIRQS_NO_COMPAT
/* Please do not use: Use the replacement functions instead */
static inline int set_irq_chip(unsigned int irq, struct irq_chip *chip)
{
	return irq_set_chip(irq, chip);
}
static inline int set_irq_data(unsigned int irq, void *data)
{
	return irq_set_handler_data(irq, data);
}
static inline int set_irq_chip_data(unsigned int irq, void *data)
{
	return irq_set_chip_data(irq, data);
}
static inline int set_irq_type(unsigned int irq, unsigned int type)
{
	return irq_set_irq_type(irq, type);
}
static inline int set_irq_msi(unsigned int irq, struct msi_desc *entry)
{
	return irq_set_msi_desc(irq, entry);
}
static inline struct irq_chip *get_irq_chip(unsigned int irq)
{
	return irq_get_chip(irq);
}
static inline void *get_irq_chip_data(unsigned int irq)
{
	return irq_get_chip_data(irq);
}
static inline void *get_irq_data(unsigned int irq)
{
	return irq_get_handler_data(irq);
}
static inline void *irq_data_get_irq_data(struct irq_data *d)
{
	return irq_data_get_irq_handler_data(d);
}
static inline struct msi_desc *get_irq_msi(unsigned int irq)
{
	return irq_get_msi_desc(irq);
}
static inline void set_irq_noprobe(unsigned int irq)
{
	irq_set_noprobe(irq);
}
static inline void set_irq_probe(unsigned int irq)
{
	irq_set_probe(irq);
}
static inline void set_irq_nested_thread(unsigned int irq, int nest)
{
	irq_set_nested_thread(irq, nest);
}
#endif

int irq_alloc_descs(int irq, unsigned int from, unsigned int cnt, int node);
void irq_free_descs(unsigned int irq, unsigned int cnt);
int irq_reserve_irqs(unsigned int from, unsigned int cnt);

static inline int irq_alloc_desc(int node)
{
	return irq_alloc_descs(-1, 0, 1, node);
}

static inline int irq_alloc_desc_at(unsigned int at, int node)
{
	return irq_alloc_descs(at, at, 1, node);
}

static inline int irq_alloc_desc_from(unsigned int from, int node)
{
	return irq_alloc_descs(-1, from, 1, node);
}

static inline void irq_free_desc(unsigned int irq)
{
	irq_free_descs(irq, 1);
}

static inline int irq_reserve_irq(unsigned int irq)
{
	return irq_reserve_irqs(irq, 1);
}

#endif /* CONFIG_GENERIC_HARDIRQS */

#endif /* !CONFIG_S390 */

#endif /* _LINUX_IRQ_H */
Commit	Line	Data
06fcb0c6 IM	1	#ifndef _LINUX_IRQ_H
06fcb0c6 IM	2	#define _LINUX_IRQ_H
1da177e4 LT	3
	4	/*
	5	* Please do not include this file in generic code. There is currently
	6	* no requirement for any architecture to implement anything held
	7	* within this file.
	8	*
	9	* Thanks. --rmk
	10	*/
	11
23f9b317	12	#include <linux/smp.h>
1da177e4	13
06fcb0c6	14	#ifndef CONFIG_S390
1da177e4 LT	15
	16	#include <linux/linkage.h>
	17	#include <linux/cache.h>
	18	#include <linux/spinlock.h>
	19	#include <linux/cpumask.h>
503e5763	20	#include <linux/gfp.h>
908dcecd	21	#include <linux/irqreturn.h>
dd3a1db9	22	#include <linux/irqnr.h>
77904fd6	23	#include <linux/errno.h>
503e5763	24	#include <linux/topology.h>
3aa551c9	25	#include <linux/wait.h>
1da177e4 LT	26
	27	#include <asm/irq.h>
	28	#include <asm/ptrace.h>
7d12e780	29	#include <asm/irq_regs.h>
1da177e4	30
57a58a94	31	struct irq_desc;
ec701584	32	typedef void (*irq_flow_handler_t)(unsigned int irq,
7d12e780	33	struct irq_desc *desc);
57a58a94 DH	34
57a58a94 DH	35
1da177e4 LT	36	/*
1da177e4 LT	37	* IRQ line status.
6e213616	38	*
950f4427	39	* Bits 0-7 are reserved for the IRQF_* bits in linux/interrupt.h
6e213616 TG	40	*
6e213616 TG	41	* IRQ types
1da177e4	42	*/
6e213616 TG	43	#define IRQ_TYPE_NONE 0x00000000 /* Default, unspecified type */
	44	#define IRQ_TYPE_EDGE_RISING 0x00000001 /* Edge rising type */
	45	#define IRQ_TYPE_EDGE_FALLING 0x00000002 /* Edge falling type */
	46	#define IRQ_TYPE_EDGE_BOTH (IRQ_TYPE_EDGE_FALLING \| IRQ_TYPE_EDGE_RISING)
	47	#define IRQ_TYPE_LEVEL_HIGH 0x00000004 /* Level high type */
	48	#define IRQ_TYPE_LEVEL_LOW 0x00000008 /* Level low type */
	49	#define IRQ_TYPE_SENSE_MASK 0x0000000f /* Mask of the above */
	50	#define IRQ_TYPE_PROBE 0x00000010 /* Probing in progress */
	51
	52	/* Internal flags */
009b4c3b TG	53
	54	#ifndef CONFIG_GENERIC_HARDIRQS_NO_COMPAT
	55	#define IRQ_INPROGRESS 0x00000100 /* DEPRECATED */
163ef309 TG	56	#define IRQ_REPLAY 0x00000200 /* DEPRECATED */
163ef309 TG	57	#define IRQ_WAITING 0x00000400 /* DEPRECATED */
c1594b77	58	#define IRQ_DISABLED 0x00000800 /* DEPRECATED */
2a0d6fb3	59	#define IRQ_PENDING 0x00001000 /* DEPRECATED */
6e40262e	60	#define IRQ_MASKED 0x00002000 /* DEPRECATED */
009b4c3b TG	61	#endif
009b4c3b TG	62
950f4427	63	#define IRQ_LEVEL 0x00004000 /* IRQ level triggered */
950f4427 TG	64	#define IRQ_PER_CPU 0x00010000 /* IRQ is per CPU */
	65	#define IRQ_NOPROBE 0x00020000 /* IRQ is not valid for probing */
	66	#define IRQ_NOREQUEST 0x00040000 /* IRQ cannot be requested */
	67	#define IRQ_NOAUTOEN 0x00080000 /* IRQ will not be enabled on request irq */
d7e25f33 IM	68	#define IRQ_WAKEUP 0x00100000 /* IRQ triggers system wakeup */
	69	#define IRQ_MOVE_PENDING 0x00200000 /* need to re-target IRQ destination */
	70	#define IRQ_NO_BALANCING 0x00400000 /* IRQ is excluded from balancing */
f6d87f4b TG	71	#define IRQ_MOVE_PCNTXT 0x01000000 /* IRQ migration from process context */
f6d87f4b TG	72	#define IRQ_AFFINITY_SET 0x02000000 /* IRQ affinity was set from userspace*/
399b5da2	73	#define IRQ_NESTED_THREAD 0x10000000 /* IRQ is nested into another, no own handler thread */
950f4427	74
44247184 TG	75	#define IRQF_MODIFY_MASK \
44247184 TG	76	(IRQ_TYPE_SENSE_MASK \| IRQ_NOPROBE \| IRQ_NOREQUEST \| \
872434d6	77	IRQ_NOAUTOEN \| IRQ_MOVE_PCNTXT \| IRQ_LEVEL \| IRQ_NO_BALANCING \| \
6f91a52d	78	IRQ_PER_CPU \| IRQ_NESTED_THREAD)
44247184	79
0d7012a9	80	#ifdef CONFIG_IRQ_PER_CPU
f26fdd59	81	# define CHECK_IRQ_PER_CPU(var) ((var) & IRQ_PER_CPU)
950f4427	82	# define IRQ_NO_BALANCING_MASK (IRQ_PER_CPU \| IRQ_NO_BALANCING)
f26fdd59 KW	83	#else
f26fdd59 KW	84	# define CHECK_IRQ_PER_CPU(var) 0
950f4427	85	# define IRQ_NO_BALANCING_MASK IRQ_NO_BALANCING
f26fdd59	86	#endif
1da177e4	87
3b8249e7 TG	88	/*
	89	* Return value for chip->irq_set_affinity()
	90	*
	91	* IRQ_SET_MASK_OK - OK, core updates irq_data.affinity
	92	* IRQ_SET_MASK_NOCPY - OK, chip did update irq_data.affinity
	93	*/
	94	enum {
	95	IRQ_SET_MASK_OK = 0,
	96	IRQ_SET_MASK_OK_NOCOPY,
	97	};
	98
5b912c10	99	struct msi_desc;
6a6de9ef	100
ff7dcd44 TG	101	/**
	102	* struct irq_data - per irq and irq chip data passed down to chip functions
	103	* @irq: interrupt number
	104	* @node: node index useful for balancing
	105	* @chip: low level interrupt hardware access
	106	* @handler_data: per-IRQ data for the irq_chip methods
	107	* @chip_data: platform-specific per-chip private data for the chip
	108	* methods, to allow shared chip implementations
	109	* @msi_desc: MSI descriptor
	110	* @affinity: IRQ affinity on SMP
ff7dcd44 TG	111	*
	112	* The fields here need to overlay the ones in irq_desc until we
	113	* cleaned up the direct references and switched everything over to
	114	* irq_data.
	115	*/
	116	struct irq_data {
	117	unsigned int irq;
	118	unsigned int node;
	119	struct irq_chip *chip;
	120	void *handler_data;
	121	void *chip_data;
	122	struct msi_desc *msi_desc;
	123	#ifdef CONFIG_SMP
	124	cpumask_var_t affinity;
	125	#endif
ff7dcd44 TG	126	};
ff7dcd44 TG	127
8fee5c36	128	/**
6a6de9ef	129	* struct irq_chip - hardware interrupt chip descriptor
8fee5c36 IM	130	*
8fee5c36 IM	131	* @name: name for /proc/interrupts
f8822657 TG	132	* @startup: deprecated, replaced by irq_startup
	133	* @shutdown: deprecated, replaced by irq_shutdown
	134	* @enable: deprecated, replaced by irq_enable
	135	* @disable: deprecated, replaced by irq_disable
	136	* @ack: deprecated, replaced by irq_ack
	137	* @mask: deprecated, replaced by irq_mask
	138	* @mask_ack: deprecated, replaced by irq_mask_ack
	139	* @unmask: deprecated, replaced by irq_unmask
	140	* @eoi: deprecated, replaced by irq_eoi
	141	* @end: deprecated, will go away with __do_IRQ()
	142	* @set_affinity: deprecated, replaced by irq_set_affinity
	143	* @retrigger: deprecated, replaced by irq_retrigger
	144	* @set_type: deprecated, replaced by irq_set_type
	145	* @set_wake: deprecated, replaced by irq_wake
	146	* @bus_lock: deprecated, replaced by irq_bus_lock
	147	* @bus_sync_unlock: deprecated, replaced by irq_bus_sync_unlock
8fee5c36	148	*
f8822657 TG	149	* @irq_startup: start up the interrupt (defaults to ->enable if NULL)
	150	* @irq_shutdown: shut down the interrupt (defaults to ->disable if NULL)
	151	* @irq_enable: enable the interrupt (defaults to chip->unmask if NULL)
	152	* @irq_disable: disable the interrupt
	153	* @irq_ack: start of a new interrupt
	154	* @irq_mask: mask an interrupt source
	155	* @irq_mask_ack: ack and mask an interrupt source
	156	* @irq_unmask: unmask an interrupt source
	157	* @irq_eoi: end of interrupt
	158	* @irq_set_affinity: set the CPU affinity on SMP machines
	159	* @irq_retrigger: resend an IRQ to the CPU
	160	* @irq_set_type: set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
	161	* @irq_set_wake: enable/disable power-management wake-on of an IRQ
	162	* @irq_bus_lock: function to lock access to slow bus (i2c) chips
	163	* @irq_bus_sync_unlock:function to sync and unlock slow bus (i2c) chips
70aedd24	164	*
8fee5c36	165	* @release: release function solely used by UML
1da177e4	166	*/
6a6de9ef TG	167	struct irq_chip {
6a6de9ef TG	168	const char *name;
bd151412	169	#ifndef CONFIG_GENERIC_HARDIRQS_NO_DEPRECATED
71d218b7 IM	170	unsigned int (*startup)(unsigned int irq);
	171	void (*shutdown)(unsigned int irq);
	172	void (*enable)(unsigned int irq);
	173	void (*disable)(unsigned int irq);
6a6de9ef	174
71d218b7	175	void (*ack)(unsigned int irq);
6a6de9ef TG	176	void (*mask)(unsigned int irq);
	177	void (*mask_ack)(unsigned int irq);
	178	void (*unmask)(unsigned int irq);
47c2a3aa	179	void (*eoi)(unsigned int irq);
6a6de9ef	180
71d218b7	181	void (*end)(unsigned int irq);
d5dedd45	182	int (*set_affinity)(unsigned int irq,
0de26520	183	const struct cpumask *dest);
c0ad90a3	184	int (*retrigger)(unsigned int irq);
6a6de9ef TG	185	int (*set_type)(unsigned int irq, unsigned int flow_type);
6a6de9ef TG	186	int (*set_wake)(unsigned int irq, unsigned int on);
c0ad90a3	187
70aedd24 TG	188	void (*bus_lock)(unsigned int irq);
70aedd24 TG	189	void (*bus_sync_unlock)(unsigned int irq);
bd151412	190	#endif
f8822657 TG	191	unsigned int (irq_startup)(struct irq_data data);
	192	void (irq_shutdown)(struct irq_data data);
	193	void (irq_enable)(struct irq_data data);
	194	void (irq_disable)(struct irq_data data);
	195
	196	void (irq_ack)(struct irq_data data);
	197	void (irq_mask)(struct irq_data data);
	198	void (irq_mask_ack)(struct irq_data data);
	199	void (irq_unmask)(struct irq_data data);
	200	void (irq_eoi)(struct irq_data data);
	201
	202	int (irq_set_affinity)(struct irq_data data, const struct cpumask *dest, bool force);
	203	int (irq_retrigger)(struct irq_data data);
	204	int (irq_set_type)(struct irq_data data, unsigned int flow_type);
	205	int (irq_set_wake)(struct irq_data data, unsigned int on);
	206
	207	void (irq_bus_lock)(struct irq_data data);
	208	void (irq_bus_sync_unlock)(struct irq_data data);
	209
b77d6adc PBG	210	/* Currently used only by UML, might disappear one day.*/
b77d6adc PBG	211	#ifdef CONFIG_IRQ_RELEASE_METHOD
71d218b7	212	void (release)(unsigned int irq, void dev_id);
b77d6adc	213	#endif
1da177e4 LT	214	};
1da177e4 LT	215
e144710b TG	216	/* This include will go away once we isolated irq_desc usage to core code */
e144710b TG	217	#include <linux/irqdesc.h>
0b8f1efa	218
34ffdb72 IM	219	/*
	220	* Pick up the arch-dependent methods:
	221	*/
	222	#include <asm/hw_irq.h>
1da177e4	223
b683de2b TG	224	#ifndef NR_IRQS_LEGACY
	225	# define NR_IRQS_LEGACY 0
	226	#endif
	227
1318a481 TG	228	#ifndef ARCH_IRQ_INIT_FLAGS
	229	# define ARCH_IRQ_INIT_FLAGS 0
	230	#endif
	231
c1594b77	232	#define IRQ_DEFAULT_INIT_FLAGS ARCH_IRQ_INIT_FLAGS
1318a481	233
e144710b	234	struct irqaction;
06fcb0c6	235	extern int setup_irq(unsigned int irq, struct irqaction *new);
cbf94f06	236	extern void remove_irq(unsigned int irq, struct irqaction *act);
1da177e4 LT	237
1da177e4 LT	238	#ifdef CONFIG_GENERIC_HARDIRQS
06fcb0c6	239
3a3856d0	240	#if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_PENDING_IRQ)
c777ac55	241	void move_native_irq(int irq);
e7b946e9	242	void move_masked_irq(int irq);
e144710b TG	243	#else
	244	static inline void move_native_irq(int irq) { }
	245	static inline void move_masked_irq(int irq) { }
	246	#endif
54d5d424	247
1da177e4	248	extern int no_irq_affinity;
1da177e4	249
6a6de9ef	250	/* Handle irq action chains: */
bedd30d9	251	extern irqreturn_t handle_IRQ_event(unsigned int irq, struct irqaction *action);
6a6de9ef TG	252
	253	/*
	254	* Built-in IRQ handlers for various IRQ types,
bebd04cc	255	* callable via desc->handle_irq()
6a6de9ef	256	*/
ec701584 HH	257	extern void handle_level_irq(unsigned int irq, struct irq_desc *desc);
	258	extern void handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
	259	extern void handle_edge_irq(unsigned int irq, struct irq_desc *desc);
	260	extern void handle_simple_irq(unsigned int irq, struct irq_desc *desc);
	261	extern void handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
	262	extern void handle_bad_irq(unsigned int irq, struct irq_desc *desc);
31b47cf7	263	extern void handle_nested_irq(unsigned int irq);
6a6de9ef	264
6a6de9ef	265	/* Handling of unhandled and spurious interrupts: */
34ffdb72	266	extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
bedd30d9	267	irqreturn_t action_ret);
1da177e4	268
a4633adc	269
6a6de9ef TG	270	/* Enable/disable irq debugging output: */
	271	extern int noirqdebug_setup(char *str);
	272
	273	/* Checks whether the interrupt can be requested by request_irq(): */
	274	extern int can_request_irq(unsigned int irq, unsigned long irqflags);
	275
f8b5473f	276	/* Dummy irq-chip implementations: */
6a6de9ef	277	extern struct irq_chip no_irq_chip;
f8b5473f	278	extern struct irq_chip dummy_irq_chip;
6a6de9ef	279
145fc655 IM	280	extern void
	281	set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
	282	irq_flow_handler_t handle);
6a6de9ef	283	extern void
a460e745 IM	284	set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
	285	irq_flow_handler_t handle, const char *name);
	286
6a6de9ef	287	extern void
a460e745 IM	288	__set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
a460e745 IM	289	const char *name);
1da177e4	290
6a6de9ef TG	291	/*
	292	* Set a highlevel flow handler for a given IRQ:
	293	*/
	294	static inline void
57a58a94	295	set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
6a6de9ef	296	{
a460e745	297	__set_irq_handler(irq, handle, 0, NULL);
6a6de9ef TG	298	}
	299
	300	/*
	301	* Set a highlevel chained flow handler for a given IRQ.
	302	* (a chained handler is automatically enabled and set to
	303	* IRQ_NOREQUEST and IRQ_NOPROBE)
	304	*/
	305	static inline void
a0cd9ca2	306	set_irq_chained_handler(unsigned int irq, irq_flow_handler_t handle)
6a6de9ef	307	{
a460e745	308	__set_irq_handler(irq, handle, 1, NULL);
6a6de9ef TG	309	}
6a6de9ef TG	310
44247184 TG	311	void irq_modify_status(unsigned int irq, unsigned long clr, unsigned long set);
	312
	313	static inline void irq_set_status_flags(unsigned int irq, unsigned long set)
	314	{
	315	irq_modify_status(irq, 0, set);
	316	}
	317
	318	static inline void irq_clear_status_flags(unsigned int irq, unsigned long clr)
	319	{
	320	irq_modify_status(irq, clr, 0);
	321	}
	322
a0cd9ca2	323	static inline void irq_set_noprobe(unsigned int irq)
44247184 TG	324	{
	325	irq_modify_status(irq, 0, IRQ_NOPROBE);
	326	}
	327
a0cd9ca2	328	static inline void irq_set_probe(unsigned int irq)
44247184 TG	329	{
	330	irq_modify_status(irq, IRQ_NOPROBE, 0);
	331	}
46f4f8f6	332
6f91a52d TG	333	static inline void irq_set_nested_thread(unsigned int irq, bool nest)
	334	{
	335	if (nest)
	336	irq_set_status_flags(irq, IRQ_NESTED_THREAD);
	337	else
	338	irq_clear_status_flags(irq, IRQ_NESTED_THREAD);
	339	}
	340
3a16d713	341	/* Handle dynamic irq creation and destruction */
d047f53a	342	extern unsigned int create_irq_nr(unsigned int irq_want, int node);
3a16d713 EB	343	extern int create_irq(void);
	344	extern void destroy_irq(unsigned int irq);
	345
b7b29338 TG	346	/*
	347	* Dynamic irq helper functions. Obsolete. Use irq_alloc_desc* and
	348	* irq_free_desc instead.
	349	*/
3a16d713	350	extern void dynamic_irq_cleanup(unsigned int irq);
b7b29338 TG	351	static inline void dynamic_irq_init(unsigned int irq)
	352	{
	353	dynamic_irq_cleanup(irq);
	354	}
dd87eb3a	355
3a16d713	356	/* Set/get chip/data for an IRQ: */
a0cd9ca2 TG	357	extern int irq_set_chip(unsigned int irq, struct irq_chip *chip);
	358	extern int irq_set_handler_data(unsigned int irq, void *data);
	359	extern int irq_set_chip_data(unsigned int irq, void *data);
	360	extern int irq_set_irq_type(unsigned int irq, unsigned int type);
	361	extern int irq_set_msi_desc(unsigned int irq, struct msi_desc *entry);
f303a6dd	362	extern struct irq_data *irq_get_irq_data(unsigned int irq);
dd87eb3a	363
a0cd9ca2	364	static inline struct irq_chip *irq_get_chip(unsigned int irq)
f303a6dd TG	365	{
	366	struct irq_data *d = irq_get_irq_data(irq);
	367	return d ? d->chip : NULL;
	368	}
	369
	370	static inline struct irq_chip irq_data_get_irq_chip(struct irq_data d)
	371	{
	372	return d->chip;
	373	}
	374
a0cd9ca2	375	static inline void *irq_get_chip_data(unsigned int irq)
f303a6dd TG	376	{
	377	struct irq_data *d = irq_get_irq_data(irq);
	378	return d ? d->chip_data : NULL;
	379	}
	380
	381	static inline void irq_data_get_irq_chip_data(struct irq_data d)
	382	{
	383	return d->chip_data;
	384	}
	385
a0cd9ca2	386	static inline void *irq_get_handler_data(unsigned int irq)
f303a6dd TG	387	{
	388	struct irq_data *d = irq_get_irq_data(irq);
	389	return d ? d->handler_data : NULL;
	390	}
	391
a0cd9ca2	392	static inline void irq_data_get_irq_handler_data(struct irq_data d)
f303a6dd TG	393	{
	394	return d->handler_data;
	395	}
	396
a0cd9ca2	397	static inline struct msi_desc *irq_get_msi_desc(unsigned int irq)
f303a6dd TG	398	{
	399	struct irq_data *d = irq_get_irq_data(irq);
	400	return d ? d->msi_desc : NULL;
	401	}
	402
	403	static inline struct msi_desc irq_data_get_msi(struct irq_data d)
	404	{
	405	return d->msi_desc;
	406	}
	407
a0cd9ca2 TG	408	#ifndef CONFIG_GENERIC_HARDIRQS_NO_COMPAT
	409	/* Please do not use: Use the replacement functions instead */
	410	static inline int set_irq_chip(unsigned int irq, struct irq_chip *chip)
	411	{
	412	return irq_set_chip(irq, chip);
	413	}
	414	static inline int set_irq_data(unsigned int irq, void *data)
	415	{
	416	return irq_set_handler_data(irq, data);
	417	}
	418	static inline int set_irq_chip_data(unsigned int irq, void *data)
	419	{
	420	return irq_set_chip_data(irq, data);
	421	}
	422	static inline int set_irq_type(unsigned int irq, unsigned int type)
	423	{
	424	return irq_set_irq_type(irq, type);
	425	}
	426	static inline int set_irq_msi(unsigned int irq, struct msi_desc *entry)
	427	{
	428	return irq_set_msi_desc(irq, entry);
	429	}
	430	static inline struct irq_chip *get_irq_chip(unsigned int irq)
	431	{
	432	return irq_get_chip(irq);
	433	}
	434	static inline void *get_irq_chip_data(unsigned int irq)
	435	{
	436	return irq_get_chip_data(irq);
	437	}
	438	static inline void *get_irq_data(unsigned int irq)
	439	{
	440	return irq_get_handler_data(irq);
	441	}
	442	static inline void irq_data_get_irq_data(struct irq_data d)
	443	{
	444	return irq_data_get_irq_handler_data(d);
	445	}
	446	static inline struct msi_desc *get_irq_msi(unsigned int irq)
	447	{
	448	return irq_get_msi_desc(irq);
	449	}
	450	static inline void set_irq_noprobe(unsigned int irq)
	451	{
	452	irq_set_noprobe(irq);
	453	}
	454	static inline void set_irq_probe(unsigned int irq)
	455	{
	456	irq_set_probe(irq);
	457	}
6f91a52d TG	458	static inline void set_irq_nested_thread(unsigned int irq, int nest)
	459	{
	460	irq_set_nested_thread(irq, nest);
	461	}
a0cd9ca2 TG	462	#endif
a0cd9ca2 TG	463
1f5a5b87 TG	464	int irq_alloc_descs(int irq, unsigned int from, unsigned int cnt, int node);
1f5a5b87 TG	465	void irq_free_descs(unsigned int irq, unsigned int cnt);
06f6c339	466	int irq_reserve_irqs(unsigned int from, unsigned int cnt);
1f5a5b87 TG	467
	468	static inline int irq_alloc_desc(int node)
	469	{
	470	return irq_alloc_descs(-1, 0, 1, node);
	471	}
	472
	473	static inline int irq_alloc_desc_at(unsigned int at, int node)
	474	{
	475	return irq_alloc_descs(at, at, 1, node);
	476	}
	477
	478	static inline int irq_alloc_desc_from(unsigned int from, int node)
	479	{
	480	return irq_alloc_descs(-1, from, 1, node);
	481	}
	482
	483	static inline void irq_free_desc(unsigned int irq)
	484	{
	485	irq_free_descs(irq, 1);
	486	}
	487
639bd12f PM	488	static inline int irq_reserve_irq(unsigned int irq)
	489	{
	490	return irq_reserve_irqs(irq, 1);
	491	}
	492
6a6de9ef	493	#endif /* CONFIG_GENERIC_HARDIRQS */
1da177e4	494
06fcb0c6	495	#endif /* !CONFIG_S390 */
1da177e4	496
06fcb0c6	497	#endif /* _LINUX_IRQ_H */