[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/irqreturn.h>
#include <linux/irqnr.h>
#include <linux/errno.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 */
#define IRQ_INPROGRESS		0x00000100	/* IRQ handler active - do not enter! */
#define IRQ_DISABLED		0x00000200	/* IRQ disabled - do not enter! */
#define IRQ_PENDING		0x00000400	/* IRQ pending - replay on enable */
#define IRQ_REPLAY		0x00000800	/* IRQ has been replayed but not acked yet */
#define IRQ_AUTODETECT		0x00001000	/* IRQ is being autodetected */
#define IRQ_WAITING		0x00002000	/* IRQ not yet seen - for autodetection */
#define IRQ_LEVEL		0x00004000	/* IRQ level triggered */
#define IRQ_MASKED		0x00008000	/* IRQ masked - shouldn't be seen again */
#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_SPURIOUS_DISABLED	0x00800000	/* IRQ was disabled by the spurious trap */
#define IRQ_MOVE_PCNTXT		0x01000000	/* IRQ migration from process context */
#define IRQ_AFFINITY_SET	0x02000000	/* IRQ affinity was set from userspace*/

#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

struct proc_dir_entry;
struct msi_desc;

/**
 * struct irq_chip - hardware interrupt chip descriptor
 *
 * @name:		name for /proc/interrupts
 * @startup:		start up the interrupt (defaults to ->enable if NULL)
 * @shutdown:		shut down the interrupt (defaults to ->disable if NULL)
 * @enable:		enable the interrupt (defaults to chip->unmask if NULL)
 * @disable:		disable the interrupt (defaults to chip->mask if NULL)
 * @ack:		start of a new interrupt
 * @mask:		mask an interrupt source
 * @mask_ack:		ack and mask an interrupt source
 * @unmask:		unmask an interrupt source
 * @eoi:		end of interrupt - chip level
 * @end:		end of interrupt - flow level
 * @set_affinity:	set the CPU affinity on SMP machines
 * @retrigger:		resend an IRQ to the CPU
 * @set_type:		set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
 * @set_wake:		enable/disable power-management wake-on of an IRQ
 *
 * @release:		release function solely used by UML
 * @typename:		obsoleted by name, kept as migration helper
 */
struct irq_chip {
	const char	*name;
	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);
	void		(*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);

	/* Currently used only by UML, might disappear one day.*/
#ifdef CONFIG_IRQ_RELEASE_METHOD
	void		(*release)(unsigned int irq, void *dev_id);
#endif
	/*
	 * For compatibility, ->typename is copied into ->name.
	 * Will disappear.
	 */
	const char	*typename;
};

struct timer_rand_state;
struct irq_2_iommu;
/**
 * struct irq_desc - interrupt descriptor
 * @irq:		interrupt number for this descriptor
 * @timer_rand_state:	pointer to timer rand state struct
 * @kstat_irqs:		irq stats per cpu
 * @irq_2_iommu:	iommu with this irq
 * @handle_irq:		highlevel irq-events handler [if NULL, __do_IRQ()]
 * @chip:		low level interrupt hardware access
 * @msi_desc:		MSI descriptor
 * @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
 * @action:		the irq action chain
 * @status:		status information
 * @depth:		disable-depth, for nested irq_disable() calls
 * @wake_depth:		enable depth, for multiple set_irq_wake() callers
 * @irq_count:		stats field to detect stalled irqs
 * @last_unhandled:	aging timer for unhandled count
 * @irqs_unhandled:	stats field for spurious unhandled interrupts
 * @lock:		locking for SMP
 * @affinity:		IRQ affinity on SMP
 * @cpu:		cpu index useful for balancing
 * @pending_mask:	pending rebalanced interrupts
 * @dir:		/proc/irq/ procfs entry
 * @name:		flow handler name for /proc/interrupts output
 */
struct irq_desc {
	unsigned int		irq;
#ifdef CONFIG_SPARSE_IRQ
	struct timer_rand_state *timer_rand_state;
	unsigned int            *kstat_irqs;
# ifdef CONFIG_INTR_REMAP
	struct irq_2_iommu      *irq_2_iommu;
# endif
#endif
	irq_flow_handler_t	handle_irq;
	struct irq_chip		*chip;
	struct msi_desc		*msi_desc;
	void			*handler_data;
	void			*chip_data;
	struct irqaction	*action;	/* IRQ action list */
	unsigned int		status;		/* IRQ status */

	unsigned int		depth;		/* nested irq disables */
	unsigned int		wake_depth;	/* nested wake enables */
	unsigned int		irq_count;	/* For detecting broken IRQs */
	unsigned long		last_unhandled;	/* Aging timer for unhandled count */
	unsigned int		irqs_unhandled;
	spinlock_t		lock;
#ifdef CONFIG_SMP
	cpumask_t		affinity;
	unsigned int		cpu;
#endif
#ifdef CONFIG_GENERIC_PENDING_IRQ
	cpumask_t		pending_mask;
#endif
#ifdef CONFIG_PROC_FS
	struct proc_dir_entry	*dir;
#endif
	const char		*name;
} ____cacheline_internodealigned_in_smp;

extern void arch_init_copy_chip_data(struct irq_desc *old_desc,
					struct irq_desc *desc, int cpu);
extern void arch_free_chip_data(struct irq_desc *old_desc, struct irq_desc *desc);

#ifndef CONFIG_SPARSE_IRQ
extern struct irq_desc irq_desc[NR_IRQS];
#else /* CONFIG_SPARSE_IRQ */
extern struct irq_desc *move_irq_desc(struct irq_desc *old_desc, int cpu);

#define kstat_irqs_this_cpu(DESC) \
	((DESC)->kstat_irqs[smp_processor_id()])
#define kstat_incr_irqs_this_cpu(irqno, DESC) \
	((DESC)->kstat_irqs[smp_processor_id()]++)

#endif /* CONFIG_SPARSE_IRQ */

extern struct irq_desc *irq_to_desc_alloc_cpu(unsigned int irq, int cpu);

static inline struct irq_desc *
irq_remap_to_desc(unsigned int irq, struct irq_desc *desc)
{
#ifdef CONFIG_NUMA_MIGRATE_IRQ_DESC
	return irq_to_desc(irq);
#else
	return desc;
#endif
}

/*
 * Migration helpers for obsolete names, they will go away:
 */
#define hw_interrupt_type	irq_chip
typedef struct irq_chip		hw_irq_controller;
#define no_irq_type		no_irq_chip
typedef struct irq_desc		irq_desc_t;

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

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

#ifdef CONFIG_GENERIC_HARDIRQS

#ifdef CONFIG_SMP

#ifdef CONFIG_GENERIC_PENDING_IRQ

void move_native_irq(int irq);
void move_masked_irq(int irq);

#else /* CONFIG_GENERIC_PENDING_IRQ */

static inline void move_irq(int irq)
{
}

static inline void move_native_irq(int irq)
{
}

static inline void move_masked_irq(int irq)
{
}

#endif /* CONFIG_GENERIC_PENDING_IRQ */

#else /* CONFIG_SMP */

#define move_native_irq(x)
#define move_masked_irq(x)

#endif /* CONFIG_SMP */

extern int no_irq_affinity;

static inline int irq_balancing_disabled(unsigned int irq)
{
	struct irq_desc *desc;

	desc = irq_to_desc(irq);
	return desc->status & IRQ_NO_BALANCING_MASK;
}

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

/*
 * Built-in IRQ handlers for various IRQ types,
 * callable via desc->chip->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);

/*
 * Monolithic do_IRQ implementation.
 */
#ifndef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
extern unsigned int __do_IRQ(unsigned int irq);
#endif

/*
 * Architectures call this to let the generic IRQ layer
 * handle an interrupt. If the descriptor is attached to an
 * irqchip-style controller then we call the ->handle_irq() handler,
 * and it calls __do_IRQ() if it's attached to an irqtype-style controller.
 */
static inline void generic_handle_irq_desc(unsigned int irq, struct irq_desc *desc)
{
#ifdef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
	desc->handle_irq(irq, desc);
#else
	if (likely(desc->handle_irq))
		desc->handle_irq(irq, desc);
	else
		__do_IRQ(irq);
#endif
}

static inline void generic_handle_irq(unsigned int irq)
{
	generic_handle_irq_desc(irq, irq_to_desc(irq));
}

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

/* Resending of interrupts :*/
void check_irq_resend(struct irq_desc *desc, unsigned int irq);

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

/* caller has locked the irq_desc and both params are valid */
static inline void __set_irq_handler_unlocked(int irq,
					      irq_flow_handler_t handler)
{
	struct irq_desc *desc;

	desc = irq_to_desc(irq);
	desc->handle_irq = handler;
}

/*
 * 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);
}

extern void set_irq_noprobe(unsigned int irq);
extern void set_irq_probe(unsigned int irq);

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

/* Test to see if a driver has successfully requested an irq */
static inline int irq_has_action(unsigned int irq)
{
	struct irq_desc *desc = irq_to_desc(irq);
	return desc->action != NULL;
}

/* Dynamic irq helper functions */
extern void dynamic_irq_init(unsigned int irq);
extern void dynamic_irq_cleanup(unsigned int irq);

/* Set/get chip/data for an IRQ: */
extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
extern int set_irq_data(unsigned int irq, void *data);
extern int set_irq_chip_data(unsigned int irq, void *data);
extern int set_irq_type(unsigned int irq, unsigned int type);
extern int set_irq_msi(unsigned int irq, struct msi_desc *entry);

#define get_irq_chip(irq)	(irq_to_desc(irq)->chip)
#define get_irq_chip_data(irq)	(irq_to_desc(irq)->chip_data)
#define get_irq_data(irq)	(irq_to_desc(irq)->handler_data)
#define get_irq_msi(irq)	(irq_to_desc(irq)->msi_desc)

#define get_irq_desc_chip(desc)		((desc)->chip)
#define get_irq_desc_chip_data(desc)	((desc)->chip_data)
#define get_irq_desc_data(desc)		((desc)->handler_data)
#define get_irq_desc_msi(desc)		((desc)->msi_desc)

#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>
908dcecd	20	#include <linux/irqreturn.h>
dd3a1db9	21	#include <linux/irqnr.h>
77904fd6	22	#include <linux/errno.h>
1da177e4 LT	23
	24	#include <asm/irq.h>
	25	#include <asm/ptrace.h>
7d12e780	26	#include <asm/irq_regs.h>
1da177e4	27
57a58a94	28	struct irq_desc;
ec701584	29	typedef void (*irq_flow_handler_t)(unsigned int irq,
7d12e780	30	struct irq_desc *desc);
57a58a94 DH	31
57a58a94 DH	32
1da177e4 LT	33	/*
1da177e4 LT	34	* IRQ line status.
6e213616	35	*
950f4427	36	* Bits 0-7 are reserved for the IRQF_* bits in linux/interrupt.h
6e213616 TG	37	*
6e213616 TG	38	* IRQ types
1da177e4	39	*/
6e213616 TG	40	#define IRQ_TYPE_NONE 0x00000000 /* Default, unspecified type */
	41	#define IRQ_TYPE_EDGE_RISING 0x00000001 /* Edge rising type */
	42	#define IRQ_TYPE_EDGE_FALLING 0x00000002 /* Edge falling type */
	43	#define IRQ_TYPE_EDGE_BOTH (IRQ_TYPE_EDGE_FALLING \| IRQ_TYPE_EDGE_RISING)
	44	#define IRQ_TYPE_LEVEL_HIGH 0x00000004 /* Level high type */
	45	#define IRQ_TYPE_LEVEL_LOW 0x00000008 /* Level low type */
	46	#define IRQ_TYPE_SENSE_MASK 0x0000000f /* Mask of the above */
	47	#define IRQ_TYPE_PROBE 0x00000010 /* Probing in progress */
	48
	49	/* Internal flags */
950f4427 TG	50	#define IRQ_INPROGRESS 0x00000100 /* IRQ handler active - do not enter! */
	51	#define IRQ_DISABLED 0x00000200 /* IRQ disabled - do not enter! */
	52	#define IRQ_PENDING 0x00000400 /* IRQ pending - replay on enable */
	53	#define IRQ_REPLAY 0x00000800 /* IRQ has been replayed but not acked yet */
	54	#define IRQ_AUTODETECT 0x00001000 /* IRQ is being autodetected */
	55	#define IRQ_WAITING 0x00002000 /* IRQ not yet seen - for autodetection */
	56	#define IRQ_LEVEL 0x00004000 /* IRQ level triggered */
	57	#define IRQ_MASKED 0x00008000 /* IRQ masked - shouldn't be seen again */
	58	#define IRQ_PER_CPU 0x00010000 /* IRQ is per CPU */
	59	#define IRQ_NOPROBE 0x00020000 /* IRQ is not valid for probing */
	60	#define IRQ_NOREQUEST 0x00040000 /* IRQ cannot be requested */
	61	#define IRQ_NOAUTOEN 0x00080000 /* IRQ will not be enabled on request irq */
d7e25f33 IM	62	#define IRQ_WAKEUP 0x00100000 /* IRQ triggers system wakeup */
	63	#define IRQ_MOVE_PENDING 0x00200000 /* need to re-target IRQ destination */
	64	#define IRQ_NO_BALANCING 0x00400000 /* IRQ is excluded from balancing */
1adb0850	65	#define IRQ_SPURIOUS_DISABLED 0x00800000 /* IRQ was disabled by the spurious trap */
f6d87f4b TG	66	#define IRQ_MOVE_PCNTXT 0x01000000 /* IRQ migration from process context */
f6d87f4b TG	67	#define IRQ_AFFINITY_SET 0x02000000 /* IRQ affinity was set from userspace*/
950f4427	68
0d7012a9	69	#ifdef CONFIG_IRQ_PER_CPU
f26fdd59	70	# define CHECK_IRQ_PER_CPU(var) ((var) & IRQ_PER_CPU)
950f4427	71	# define IRQ_NO_BALANCING_MASK (IRQ_PER_CPU \| IRQ_NO_BALANCING)
f26fdd59 KW	72	#else
f26fdd59 KW	73	# define CHECK_IRQ_PER_CPU(var) 0
950f4427	74	# define IRQ_NO_BALANCING_MASK IRQ_NO_BALANCING
f26fdd59	75	#endif
1da177e4	76
6a6de9ef	77	struct proc_dir_entry;
5b912c10	78	struct msi_desc;
6a6de9ef	79
8fee5c36	80	/**
6a6de9ef	81	* struct irq_chip - hardware interrupt chip descriptor
8fee5c36 IM	82	*
	83	* @name: name for /proc/interrupts
	84	* @startup: start up the interrupt (defaults to ->enable if NULL)
	85	* @shutdown: shut down the interrupt (defaults to ->disable if NULL)
	86	* @enable: enable the interrupt (defaults to chip->unmask if NULL)
	87	* @disable: disable the interrupt (defaults to chip->mask if NULL)
8fee5c36 IM	88	* @ack: start of a new interrupt
	89	* @mask: mask an interrupt source
	90	* @mask_ack: ack and mask an interrupt source
	91	* @unmask: unmask an interrupt source
47c2a3aa IM	92	* @eoi: end of interrupt - chip level
47c2a3aa IM	93	* @end: end of interrupt - flow level
8fee5c36 IM	94	* @set_affinity: set the CPU affinity on SMP machines
	95	* @retrigger: resend an IRQ to the CPU
	96	* @set_type: set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
	97	* @set_wake: enable/disable power-management wake-on of an IRQ
	98	*
	99	* @release: release function solely used by UML
6a6de9ef	100	* @typename: obsoleted by name, kept as migration helper
1da177e4	101	*/
6a6de9ef TG	102	struct irq_chip {
6a6de9ef TG	103	const char *name;
71d218b7 IM	104	unsigned int (*startup)(unsigned int irq);
	105	void (*shutdown)(unsigned int irq);
	106	void (*enable)(unsigned int irq);
	107	void (*disable)(unsigned int irq);
6a6de9ef	108
71d218b7	109	void (*ack)(unsigned int irq);
6a6de9ef TG	110	void (*mask)(unsigned int irq);
	111	void (*mask_ack)(unsigned int irq);
	112	void (*unmask)(unsigned int irq);
47c2a3aa	113	void (*eoi)(unsigned int irq);
6a6de9ef	114
71d218b7	115	void (*end)(unsigned int irq);
0de26520 RR	116	void (*set_affinity)(unsigned int irq,
0de26520 RR	117	const struct cpumask *dest);
c0ad90a3	118	int (*retrigger)(unsigned int irq);
6a6de9ef TG	119	int (*set_type)(unsigned int irq, unsigned int flow_type);
6a6de9ef TG	120	int (*set_wake)(unsigned int irq, unsigned int on);
c0ad90a3	121
b77d6adc PBG	122	/* Currently used only by UML, might disappear one day.*/
b77d6adc PBG	123	#ifdef CONFIG_IRQ_RELEASE_METHOD
71d218b7	124	void (release)(unsigned int irq, void dev_id);
b77d6adc	125	#endif
6a6de9ef TG	126	/*
	127	* For compatibility, ->typename is copied into ->name.
	128	* Will disappear.
	129	*/
	130	const char *typename;
1da177e4 LT	131	};
1da177e4 LT	132
0b8f1efa YL	133	struct timer_rand_state;
0b8f1efa YL	134	struct irq_2_iommu;
8fee5c36 IM	135	/**
8fee5c36 IM	136	* struct irq_desc - interrupt descriptor
2ed1cdcf	137	* @irq: interrupt number for this descriptor
078a55db YL	138	* @timer_rand_state: pointer to timer rand state struct
	139	* @kstat_irqs: irq stats per cpu
	140	* @irq_2_iommu: iommu with this irq
6a6de9ef TG	141	* @handle_irq: highlevel irq-events handler [if NULL, __do_IRQ()]
6a6de9ef TG	142	* @chip: low level interrupt hardware access
472900b8	143	* @msi_desc: MSI descriptor
6a6de9ef TG	144	* @handler_data: per-IRQ data for the irq_chip methods
	145	* @chip_data: platform-specific per-chip private data for the chip
	146	* methods, to allow shared chip implementations
8fee5c36 IM	147	* @action: the irq action chain
	148	* @status: status information
	149	* @depth: disable-depth, for nested irq_disable() calls
15a647eb	150	* @wake_depth: enable depth, for multiple set_irq_wake() callers
8fee5c36	151	* @irq_count: stats field to detect stalled irqs
5ac4d823	152	* @last_unhandled: aging timer for unhandled count
e262a7ba	153	* @irqs_unhandled: stats field for spurious unhandled interrupts
8fee5c36 IM	154	* @lock: locking for SMP
8fee5c36 IM	155	* @affinity: IRQ affinity on SMP
6a6de9ef	156	* @cpu: cpu index useful for balancing
8fee5c36	157	* @pending_mask: pending rebalanced interrupts
8fee5c36	158	* @dir: /proc/irq/ procfs entry
a460e745	159	* @name: flow handler name for /proc/interrupts output
1da177e4	160	*/
34ffdb72	161	struct irq_desc {
08678b08	162	unsigned int irq;
0b8f1efa YL	163	#ifdef CONFIG_SPARSE_IRQ
	164	struct timer_rand_state *timer_rand_state;
	165	unsigned int *kstat_irqs;
	166	# ifdef CONFIG_INTR_REMAP
	167	struct irq_2_iommu *irq_2_iommu;
	168	# endif
	169	#endif
57a58a94	170	irq_flow_handler_t handle_irq;
6a6de9ef	171	struct irq_chip *chip;
5b912c10	172	struct msi_desc *msi_desc;
6a6de9ef	173	void *handler_data;
71d218b7 IM	174	void *chip_data;
	175	struct irqaction action; / IRQ action list */
	176	unsigned int status; /* IRQ status */
6a6de9ef	177
71d218b7	178	unsigned int depth; /* nested irq disables */
15a647eb	179	unsigned int wake_depth; /* nested wake enables */
71d218b7	180	unsigned int irq_count; /* For detecting broken IRQs */
4f27c00b	181	unsigned long last_unhandled; /* Aging timer for unhandled count */
e262a7ba	182	unsigned int irqs_unhandled;
71d218b7	183	spinlock_t lock;
a53da52f	184	#ifdef CONFIG_SMP
71d218b7	185	cpumask_t affinity;
6a6de9ef	186	unsigned int cpu;
a53da52f	187	#endif
8b8e8c1b	188	#ifdef CONFIG_GENERIC_PENDING_IRQ
cd916d31	189	cpumask_t pending_mask;
54d5d424	190	#endif
4a733ee1	191	#ifdef CONFIG_PROC_FS
a460e745	192	struct proc_dir_entry *dir;
4a733ee1	193	#endif
a460e745	194	const char *name;
e729aa16	195	} ____cacheline_internodealigned_in_smp;
1da177e4	196
0b8f1efa YL	197	extern void arch_init_copy_chip_data(struct irq_desc *old_desc,
	198	struct irq_desc *desc, int cpu);
	199	extern void arch_free_chip_data(struct irq_desc old_desc, struct irq_desc desc);
9059d8fa	200
0b8f1efa	201	#ifndef CONFIG_SPARSE_IRQ
34ffdb72	202	extern struct irq_desc irq_desc[NR_IRQS];
f9af0e70	203	#else /* CONFIG_SPARSE_IRQ */
0b8f1efa YL	204	extern struct irq_desc move_irq_desc(struct irq_desc old_desc, int cpu);
0b8f1efa YL	205
0b8f1efa YL	206	#define kstat_irqs_this_cpu(DESC) \
	207	((DESC)->kstat_irqs[smp_processor_id()])
	208	#define kstat_incr_irqs_this_cpu(irqno, DESC) \
	209	((DESC)->kstat_irqs[smp_processor_id()]++)
	210
f9af0e70 KM	211	#endif /* CONFIG_SPARSE_IRQ */
	212
	213	extern struct irq_desc *irq_to_desc_alloc_cpu(unsigned int irq, int cpu);
0b8f1efa	214
48a1b10a YL	215	static inline struct irq_desc *
	216	irq_remap_to_desc(unsigned int irq, struct irq_desc *desc)
	217	{
	218	#ifdef CONFIG_NUMA_MIGRATE_IRQ_DESC
	219	return irq_to_desc(irq);
	220	#else
	221	return desc;
	222	#endif
c6b7674f TG	223	}
c6b7674f TG	224
34ffdb72 IM	225	/*
	226	* Migration helpers for obsolete names, they will go away:
	227	*/
6a6de9ef TG	228	#define hw_interrupt_type irq_chip
	229	typedef struct irq_chip hw_irq_controller;
	230	#define no_irq_type no_irq_chip
34ffdb72 IM	231	typedef struct irq_desc irq_desc_t;
	232
	233	/*
	234	* Pick up the arch-dependent methods:
	235	*/
	236	#include <asm/hw_irq.h>
1da177e4	237
06fcb0c6	238	extern int setup_irq(unsigned int irq, struct irqaction *new);
f21cfb25	239	extern struct irqaction remove_irq(unsigned int irq, void dev_id);
1da177e4 LT	240
1da177e4 LT	241	#ifdef CONFIG_GENERIC_HARDIRQS
06fcb0c6	242
54d5d424 AR	243	#ifdef CONFIG_SMP
54d5d424 AR	244
8b8e8c1b	245	#ifdef CONFIG_GENERIC_PENDING_IRQ
54d5d424	246
c777ac55	247	void move_native_irq(int irq);
e7b946e9	248	void move_masked_irq(int irq);
54d5d424	249
8b8e8c1b	250	#else /* CONFIG_GENERIC_PENDING_IRQ */
06fcb0c6 IM	251
	252	static inline void move_irq(int irq)
	253	{
	254	}
	255
	256	static inline void move_native_irq(int irq)
	257	{
	258	}
	259
e7b946e9 EB	260	static inline void move_masked_irq(int irq)
	261	{
	262	}
	263
06fcb0c6	264	#endif /* CONFIG_GENERIC_PENDING_IRQ */
54d5d424	265
06fcb0c6	266	#else /* CONFIG_SMP */
54d5d424	267
54d5d424	268	#define move_native_irq(x)
e7b946e9	269	#define move_masked_irq(x)
54d5d424	270
06fcb0c6	271	#endif /* CONFIG_SMP */
54d5d424	272
1da177e4	273	extern int no_irq_affinity;
1da177e4	274
950f4427 TG	275	static inline int irq_balancing_disabled(unsigned int irq)
950f4427 TG	276	{
08678b08 YL	277	struct irq_desc *desc;
	278
	279	desc = irq_to_desc(irq);
	280	return desc->status & IRQ_NO_BALANCING_MASK;
950f4427 TG	281	}
950f4427 TG	282
6a6de9ef	283	/* Handle irq action chains: */
7d12e780	284	extern int handle_IRQ_event(unsigned int irq, struct irqaction *action);
6a6de9ef TG	285
	286	/*
	287	* Built-in IRQ handlers for various IRQ types,
	288	* callable via desc->chip->handle_irq()
	289	*/
ec701584 HH	290	extern void handle_level_irq(unsigned int irq, struct irq_desc *desc);
	291	extern void handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
	292	extern void handle_edge_irq(unsigned int irq, struct irq_desc *desc);
	293	extern void handle_simple_irq(unsigned int irq, struct irq_desc *desc);
	294	extern void handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
	295	extern void handle_bad_irq(unsigned int irq, struct irq_desc *desc);
6a6de9ef	296
2e60bbb6	297	/*
6a6de9ef	298	* Monolithic do_IRQ implementation.
2e60bbb6	299	*/
af8c65b5	300	#ifndef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
ec701584	301	extern unsigned int __do_IRQ(unsigned int irq);
af8c65b5	302	#endif
2e60bbb6	303
dae86204 IM	304	/*
	305	* Architectures call this to let the generic IRQ layer
	306	* handle an interrupt. If the descriptor is attached to an
	307	* irqchip-style controller then we call the ->handle_irq() handler,
	308	* and it calls __do_IRQ() if it's attached to an irqtype-style controller.
	309	*/
46926b67	310	static inline void generic_handle_irq_desc(unsigned int irq, struct irq_desc *desc)
dae86204	311	{
af8c65b5	312	#ifdef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
7d12e780	313	desc->handle_irq(irq, desc);
af8c65b5	314	#else
dae86204	315	if (likely(desc->handle_irq))
7d12e780	316	desc->handle_irq(irq, desc);
dae86204	317	else
7d12e780	318	__do_IRQ(irq);
af8c65b5	319	#endif
dae86204 IM	320	}
dae86204 IM	321
46926b67 YL	322	static inline void generic_handle_irq(unsigned int irq)
	323	{
	324	generic_handle_irq_desc(irq, irq_to_desc(irq));
	325	}
	326
6a6de9ef	327	/* Handling of unhandled and spurious interrupts: */
34ffdb72	328	extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
7d12e780	329	int action_ret);
1da177e4	330
a4633adc TG	331	/* Resending of interrupts :*/
	332	void check_irq_resend(struct irq_desc *desc, unsigned int irq);
	333
6a6de9ef TG	334	/* Enable/disable irq debugging output: */
	335	extern int noirqdebug_setup(char *str);
	336
	337	/* Checks whether the interrupt can be requested by request_irq(): */
	338	extern int can_request_irq(unsigned int irq, unsigned long irqflags);
	339
f8b5473f	340	/* Dummy irq-chip implementations: */
6a6de9ef	341	extern struct irq_chip no_irq_chip;
f8b5473f	342	extern struct irq_chip dummy_irq_chip;
6a6de9ef	343
145fc655 IM	344	extern void
	345	set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
	346	irq_flow_handler_t handle);
6a6de9ef	347	extern void
a460e745 IM	348	set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
	349	irq_flow_handler_t handle, const char *name);
	350
6a6de9ef	351	extern void
a460e745 IM	352	__set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
a460e745 IM	353	const char *name);
1da177e4	354
b019e573 KH	355	/* caller has locked the irq_desc and both params are valid */
	356	static inline void __set_irq_handler_unlocked(int irq,
	357	irq_flow_handler_t handler)
	358	{
08678b08 YL	359	struct irq_desc *desc;
	360
	361	desc = irq_to_desc(irq);
	362	desc->handle_irq = handler;
b019e573 KH	363	}
b019e573 KH	364
6a6de9ef TG	365	/*
	366	* Set a highlevel flow handler for a given IRQ:
	367	*/
	368	static inline void
57a58a94	369	set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
6a6de9ef	370	{
a460e745	371	__set_irq_handler(irq, handle, 0, NULL);
6a6de9ef TG	372	}
	373
	374	/*
	375	* Set a highlevel chained flow handler for a given IRQ.
	376	* (a chained handler is automatically enabled and set to
	377	* IRQ_NOREQUEST and IRQ_NOPROBE)
	378	*/
	379	static inline void
	380	set_irq_chained_handler(unsigned int irq,
57a58a94	381	irq_flow_handler_t handle)
6a6de9ef	382	{
a460e745	383	__set_irq_handler(irq, handle, 1, NULL);
6a6de9ef TG	384	}
6a6de9ef TG	385
46f4f8f6 RB	386	extern void set_irq_noprobe(unsigned int irq);
	387	extern void set_irq_probe(unsigned int irq);
	388
3a16d713	389	/* Handle dynamic irq creation and destruction */
6d50bc26	390	extern unsigned int create_irq_nr(unsigned int irq_want);
3a16d713 EB	391	extern int create_irq(void);
	392	extern void destroy_irq(unsigned int irq);
	393
1f80025e EB	394	/* Test to see if a driver has successfully requested an irq */
	395	static inline int irq_has_action(unsigned int irq)
	396	{
08678b08	397	struct irq_desc *desc = irq_to_desc(irq);
1f80025e EB	398	return desc->action != NULL;
	399	}
	400
3a16d713 EB	401	/* Dynamic irq helper functions */
	402	extern void dynamic_irq_init(unsigned int irq);
	403	extern void dynamic_irq_cleanup(unsigned int irq);
dd87eb3a	404
3a16d713	405	/* Set/get chip/data for an IRQ: */
dd87eb3a TG	406	extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
	407	extern int set_irq_data(unsigned int irq, void *data);
	408	extern int set_irq_chip_data(unsigned int irq, void *data);
	409	extern int set_irq_type(unsigned int irq, unsigned int type);
5b912c10	410	extern int set_irq_msi(unsigned int irq, struct msi_desc *entry);
dd87eb3a	411
08678b08 YL	412	#define get_irq_chip(irq) (irq_to_desc(irq)->chip)
	413	#define get_irq_chip_data(irq) (irq_to_desc(irq)->chip_data)
	414	#define get_irq_data(irq) (irq_to_desc(irq)->handler_data)
	415	#define get_irq_msi(irq) (irq_to_desc(irq)->msi_desc)
dd87eb3a	416
0b8f1efa YL	417	#define get_irq_desc_chip(desc) ((desc)->chip)
	418	#define get_irq_desc_chip_data(desc) ((desc)->chip_data)
	419	#define get_irq_desc_data(desc) ((desc)->handler_data)
	420	#define get_irq_desc_msi(desc) ((desc)->msi_desc)
	421
6a6de9ef	422	#endif /* CONFIG_GENERIC_HARDIRQS */
1da177e4	423
06fcb0c6	424	#endif /* !CONFIG_S390 */
1da177e4	425
06fcb0c6	426	#endif /* _LINUX_IRQ_H */