xref: /freebsd/share/man/man9/BUS_CONFIG_INTR.9 (revision 4543ef516683042d46f3bd3bb8a4f3f746e00499)
1.\" Copyright (c) 2003 Marcel Moolenaar
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\"
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd January 15, 2017
27.Dt BUS_CONFIG_INTR 9
28.Os
29.\"
30.Sh NAME
31.Nm BUS_CONFIG_INTR
32.Nd "configure interrupt polarity and trigger mode"
33.\"
34.Sh SYNOPSIS
35.In sys/param.h
36.In sys/bus.h
37.Ft int
38.Fo BUS_CONFIG_INTR
39.Fa "device_t dev" "int irq" "enum intr_trigger trig" "enum intr_polarity pol"
40.Fc
41.\"
42.Sh DESCRIPTION
43The
44.Fn BUS_CONFIG_INTR
45method allows bus or device drivers to provide interrupt polarity and trigger
46mode to parent buses.
47This typically bubbles all the way up to the root bus (e.g.\& nexus) where the
48necessary actions are taken to actually program the hardware.
49Since the
50.Fn BUS_CONFIG_INTR
51method takes an interrupt number, it is assumed but not necessarily required
52that it is called prior to
53.Xr BUS_SETUP_INTR 9 .
54.Pp
55The
56.Fa trig
57argument can be one of:
58.Bl -tag -width ".Dv INTR_TRIGGER_CONFORM"
59.It Dv INTR_TRIGGER_CONFORM
60The interrupt trigger mode is standard for the bus to which the device is
61attached.
62.It Dv INTR_TRIGGER_EDGE
63The interrupt is edge triggered.
64This means that the interrupt is raised by the rising edge of the signal on
65the interrupt line.
66The signal typically reverts to the original state so as to cause a spike.
67.It Dv INTR_TRIGGER_LEVEL
68The interrupt is level triggered.
69This means that the interrupt is raised when the signal on the interrupt line
70transitions and remains unchanged after that until the interrupt has been
71serviced, after which the signal transitions back.
72.El
73.Pp
74The
75.Fa pol
76argument can be any one of:
77.Bl -tag -width ".Dv INTR_POLARITY_CONFORM"
78.It Dv INTR_POLARITY_CONFORM
79The interrupt polarity is standard for the bus to which the device is attached.
80.It Dv INTR_POLARITY_HIGH
81The interrupt is activated by a high voltage on the interrupt line.
82.It Dv INTR_POLARITY_LOW
83The interrupt is activated by a low voltage on the interrupt line.
84.El
85.\"
86.Sh RETURN VALUES
87Zero is returned on success, otherwise an appropriate error is returned.
88.\"
89.Sh SEE ALSO
90.Xr BUS_SETUP_INTR 9 ,
91.Xr BUS_TEARDOWN_INTR 9 ,
92.Xr device 9 ,
93.Xr driver 9
94.\"
95.Sh HISTORY
96The
97.Fn BUS_CONFIG_INTR
98method first appeared in
99.Fx 5.2 .
100.\"
101.Sh AUTHORS
102This manual page was written by
103.An Marcel Moolenaar Aq Mt marcel@xcllnt.net .
104