interrupt.h revision 77582 
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 77582 2001-06-01 13:23:28Z tmm $
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	proc *it_proc;		/* 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)(int);	/* Enable interrupt source. */
71	void	(*it_enable)(int);	/* 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	int	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_NOSWITCH	0x0
86#define	SWI_SWITCH	0x1
87#define	SWI_DELAY	0x2	/* implies NOSWITCH */
88
89/*
90 * Software interrupt bit numbers in priority order.  The priority only
91 * determines which swi will be dispatched next; a higher priority swi
92 * may be dispatched when a nested h/w interrupt handler returns.
93 */
94#define	SWI_TTY		0
95#define	SWI_NET		1
96#define	SWI_CAMNET	2
97#define	SWI_CAMBIO	3
98#define	SWI_VM		4
99#define	SWI_TQ		5
100#define	SWI_CLOCK	6
101
102extern struct	ithd *tty_ithd;
103extern struct	ithd *clk_ithd;
104extern void	*net_ih;
105extern void	*softclock_ih;
106extern void	*vm_ih;
107
108/* Counts and names for statistics (defined in MD code). */
109extern u_long 	eintrcnt[];	/* end of intrcnt[] */
110extern char 	eintrnames[];	/* end of intrnames[] */
111extern u_long 	intrcnt[];	/* counts for for each device and stray */
112extern char 	intrnames[];	/* string table containing device names */
113
114int	ithread_create __P((struct ithd **ithread, int vector, int flags,
115	    void (*disable)(int), void (*enable)(int), const char *fmt, ...))
116	    __printflike(6, 7);
117int	ithread_destroy __P((struct ithd *ithread));
118u_char	ithread_priority __P((enum intr_type flags));
119int	ithread_add_handler __P((struct ithd *ithread, const char *name,
120	    driver_intr_t handler, void *arg, u_char pri, enum intr_type flags,
121	    void **cookiep));
122int	ithread_remove_handler __P((void *cookie));
123int	ithread_schedule __P((struct ithd *ithread, int do_switch));
124int     swi_add __P((struct ithd **ithdp, const char *name,
125	    driver_intr_t handler, void *arg, int pri, enum intr_type flags,
126	    void **cookiep));
127void	swi_sched __P((void *cookie, int flags));
128
129#endif
130