Merge branch 'vendor/AWK'
[dragonfly.git] / sys / sys / machintr.h
1 /*
2  * Copyright (c) 2005 The DragonFly Project.  All rights reserved.
3  * 
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  * 
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  * 
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  * 
34  * $DragonFly: src/sys/sys/machintr.h,v 1.7 2007/04/30 16:46:01 dillon Exp $
35  */
36 /*
37  * This module defines the ABI for the machine-independant cpu interrupt
38  * vector and masking layer.
39  */
40
41 #ifndef _SYS_BUS_H_
42 #include <sys/bus.h>
43 #endif
44 #ifndef _SYS_QUEUE_H_
45 #include <sys/queue.h>
46 #endif
47
48 enum machintr_type { MACHINTR_GENERIC, MACHINTR_ICU, MACHINTR_IOAPIC };
49
50 #define MACHINTR_VAR_SIZEMASK   0xFFFF
51
52 #define MACHINTR_VAR_IMCR_PRESENT       (0x00010000|sizeof(int))
53
54 #define MACHINTR_VECTOR_SETUP           1
55 #define MACHINTR_VECTOR_TEARDOWN        2
56
57 /*
58  * Machine interrupt ABIs - registered at boot-time
59  */
60 struct machintr_abi {
61     enum machintr_type type;
62     void        (*intrdis)(int);                /* hardware disable irq */
63     void        (*intren)(int);                 /* hardware enable irq */
64     int         (*vectorctl)(int, int, int);    /* hardware intr vector ctl */
65     int         (*setvar)(int, const void *);   /* set miscellanious info */
66     int         (*getvar)(int, void *);         /* get miscellanious info */
67     void        (*finalize)(void);              /* final before ints enabled */
68     void        (*cleanup)(void);               /* cleanup */
69     void        (*setdefault)(void);            /* set default vectors */
70     void        (*stabilize)(void);             /* stable before ints enabled */
71     void        (*initmap)(void);               /* init irq mapping */
72     void        (*intr_config)                  /* config intr */
73                 (int, enum intr_trigger, enum intr_polarity);
74 };
75
76 #define machintr_intren(intr)   MachIntrABI.intren(intr)
77 #define machintr_intrdis(intr)  MachIntrABI.intrdis(intr)
78 #define machintr_vector_setup(intr, flags)      \
79             MachIntrABI.vectorctl(MACHINTR_VECTOR_SETUP, intr, flags)
80 #define machintr_vector_teardown(intr)          \
81             MachIntrABI.vectorctl(MACHINTR_VECTOR_TEARDOWN, intr, 0)
82
83 #define machintr_intr_config(intr, trig, pola)  \
84             MachIntrABI.intr_config((intr), (trig), (pola))
85
86 #ifdef _KERNEL
87
88 extern struct machintr_abi MachIntrABI;
89 extern int machintr_setvar_simple(int, int);
90
91 #endif