xref: /freebsd/share/man/man9/BUS_CONFIG_INTR.9 (revision e2012b81cb87793be589cffa0a89d9b230df7c93)
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 16, 2025
27.Dt BUS_CONFIG_INTR 9
28.Os
29.\"
30.Sh NAME
31.Nm BUS_CONFIG_INTR ,
32.Nm bus_config_intr
33.Nd "configure interrupt polarity and trigger mode"
34.\"
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/bus.h
38.Ft int
39.Fo BUS_CONFIG_INTR
40.Fa "device_t bus" "device_t dev" "int irq" "enum intr_trigger trig"
41.Fa "enum intr_polarity pol"
42.Fc
43.Ft int
44.Fo bus_config_intr
45.Fa "device_t dev" "int irq" "enum intr_trigger trig" "enum intr_polarity pol"
46.Fc
47.Sh DESCRIPTION
48The
49.Fn BUS_CONFIG_INTR
50method allows bus or device drivers to provide interrupt polarity and trigger
51mode to parent buses.
52This typically bubbles all the way up to the root bus (e.g.\& nexus) where the
53necessary actions are taken to actually program the hardware.
54Since the
55.Fn BUS_CONFIG_INTR
56method takes an interrupt number, it is assumed but not necessarily required
57that it is called prior to
58.Xr BUS_SETUP_INTR 9 .
59.Pp
60The
61.Fn bus_config_intr
62function is a simple wrapper around
63.Fn BUS_CONFIG_INTR .
64.Pp
65The
66.Fa trig
67argument can be one of:
68.Bl -tag -width ".Dv INTR_TRIGGER_CONFORM"
69.It Dv INTR_TRIGGER_CONFORM
70The interrupt trigger mode is standard for the bus to which the device is
71attached.
72.It Dv INTR_TRIGGER_EDGE
73The interrupt is edge triggered.
74This means that the interrupt is raised by the rising edge of the signal on
75the interrupt line.
76The signal typically reverts to the original state so as to cause a spike.
77.It Dv INTR_TRIGGER_LEVEL
78The interrupt is level triggered.
79This means that the interrupt is raised when the signal on the interrupt line
80transitions and remains unchanged after that until the interrupt has been
81serviced, after which the signal transitions back.
82.El
83.Pp
84The
85.Fa pol
86argument can be any one of:
87.Bl -tag -width ".Dv INTR_POLARITY_CONFORM"
88.It Dv INTR_POLARITY_CONFORM
89The interrupt polarity is standard for the bus to which the device is attached.
90.It Dv INTR_POLARITY_HIGH
91The interrupt is activated by a high voltage on the interrupt line.
92.It Dv INTR_POLARITY_LOW
93The interrupt is activated by a low voltage on the interrupt line.
94.El
95.\"
96.Sh RETURN VALUES
97Zero is returned on success, otherwise an appropriate error is returned.
98.\"
99.Sh SEE ALSO
100.Xr BUS_SETUP_INTR 9 ,
101.Xr BUS_TEARDOWN_INTR 9 ,
102.Xr device 9 ,
103.Xr driver 9
104.\"
105.Sh HISTORY
106The
107.Fn BUS_CONFIG_INTR
108method first appeared in
109.Fx 5.2 .
110.\"
111.Sh AUTHORS
112This manual page was written by
113.An Marcel Moolenaar Aq Mt marcel@xcllnt.net .
114