interrupt.h revision 131244 
1/*
2 * Copyright (c) 1997, Stefan Esser <se@freebsd.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice unmodified, this list of conditions, and the following
10 *    disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sys/sys/interrupt.h 131244 2004-06-28 16:21:51Z jhb $
27 */
28
29#ifndef _SYS_INTERRUPT_H_
30#define _SYS_INTERRUPT_H_
31
32#include <sys/_lock.h>
33#include <sys/_mutex.h>
34
35/*
36 * Describe a hardware interrupt handler.
37 *
38 * Multiple interrupt handlers for a specific vector can be chained
39 * together.
40 */
41struct intrhand {
42	driver_intr_t	*ih_handler;	/* Handler function. */
43	void		*ih_argument;	/* Argument to pass to handler. */
44	int		 ih_flags;
45	const char	*ih_name;	/* Name of handler. */
46	struct ithd	*ih_ithread;	/* Ithread we are connected to. */
47	int		 ih_need;	/* Needs service. */
48	TAILQ_ENTRY(intrhand) ih_next;	/* Next handler for this vector. */
49	u_char		 ih_pri;	/* Priority of this handler. */
50};
51
52/* Interrupt handle flags kept in ih_flags */
53#define	IH_FAST		0x00000001	/* Fast interrupt. */
54#define	IH_EXCLUSIVE	0x00000002	/* Exclusive interrupt. */
55#define	IH_ENTROPY	0x00000004	/* Device is a good entropy source. */
56#define	IH_DEAD		0x00000008	/* Handler should be removed. */
57#define	IH_MPSAFE	0x80000000	/* Handler does not need Giant. */
58
59/*
60 * Describe an interrupt thread.  There is one of these per interrupt vector.
61 * Note that this actually describes an interrupt source.  There may or may
62 * not be an actual kernel thread attached to a given source.
63 */
64struct ithd {
65	struct	mtx it_lock;
66	struct	thread *it_td;		/* Interrupt process. */
67	LIST_ENTRY(ithd) it_list;	/* All interrupt threads. */
68	TAILQ_HEAD(, intrhand) it_handlers; /* Interrupt handlers. */
69	struct	ithd *it_interrupted;	/* Who we interrupted. */
70	void	(*it_disable)(uintptr_t); /* Enable interrupt source. */
71	void	(*it_enable)(uintptr_t); /* Disable interrupt source. */
72	void	*it_md;			/* Hook for MD interrupt code. */
73	int	it_flags;		/* Interrupt-specific flags. */
74	int	it_need;		/* Needs service. */
75	uintptr_t it_vector;
76	char	it_name[MAXCOMLEN + 1];
77};
78
79/* Interrupt thread flags kept in it_flags */
80#define	IT_SOFT		0x000001	/* Software interrupt. */
81#define	IT_ENTROPY	0x000002	/* Interrupt is an entropy source. */
82#define	IT_DEAD		0x000004	/* Thread is waiting to exit. */
83
84/* Flags to pass to sched_swi. */
85#define	SWI_DELAY	0x2
86
87/*
88 * Software interrupt numbers in priority order.  The priority determines
89 * the priority of the corresponding interrupt thread.
90 */
91#define	SWI_TTY		0
92#define	SWI_NET		1
93#define	SWI_CAMNET	2
94#define	SWI_CAMBIO	3
95#define	SWI_VM		4
96#define	SWI_CLOCK	5
97#define	SWI_TQ_FAST	6
98#define	SWI_TQ		6
99#define	SWI_TQ_GIANT	6
100
101extern struct	ithd *tty_ithd;
102extern struct	ithd *clk_ithd;
103extern void	*net_ih;
104extern void	*softclock_ih;
105extern void	*vm_ih;
106
107/* Counts and names for statistics (defined in MD code). */
108extern u_long 	eintrcnt[];	/* end of intrcnt[] */
109extern char 	eintrnames[];	/* end of intrnames[] */
110extern u_long 	intrcnt[];	/* counts for for each device and stray */
111extern char 	intrnames[];	/* string table containing device names */
112
113#ifdef DDB
114void	db_dump_ithread(struct ithd *ithd, int handlers);
115#endif
116int	ithread_create(struct ithd **ithread, uintptr_t vector, int flags,
117	    void (*disable)(uintptr_t), void (*enable)(uintptr_t),
118	    const char *fmt, ...) __printflike(6, 7);
119int	ithread_destroy(struct ithd *ithread);
120u_char	ithread_priority(enum intr_type flags);
121int	ithread_add_handler(struct ithd *ithread, const char *name,
122	    driver_intr_t handler, void *arg, u_char pri, enum intr_type flags,
123	    void **cookiep);
124int	ithread_remove_handler(void *cookie);
125int	ithread_schedule(struct ithd *ithread, int do_switch);
126int     swi_add(struct ithd **ithdp, const char *name,
127	    driver_intr_t handler, void *arg, int pri, enum intr_type flags,
128	    void **cookiep);
129void	swi_sched(void *cookie, int flags);
130
131#endif
132