3 .\" Copyright (c) 2009 Hudson River Trading LLC
4 .\" Written by: John H. Baldwin <jhb@FreeBSD.org>
5 .\" All rights reserved.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .Dt BUS_DESCRIBE_INTR 9
34 .Nm BUS_DESCRIBE_INTR ,
36 .Nd "associate a description with an active interrupt handler"
42 .Fa "device_t dev" "device_t child" "struct resource *irq" "void *cookie"
43 .Fa "const char *descr"
47 .Fa "device_t dev" "struct resource *irq" "void *cookie" "const char *fmt"
53 method associates a description with an active interrupt handler.
56 parameter must be the value returned by a successful call to
63 function is a simple wrapper around
64 .Fn BUS_DESCRIBE_INTR .
67 allows the caller to use
69 style formatting to build the description string using
72 When an interrupt handler is established by
73 .Xr BUS_SETUP_INTR 9 ,
74 the handler is named after the device the handler is established for.
75 This name is then used in various places such as interrupt statistics
80 For devices that use a single interrupt,
81 the device name is sufficiently unique to identify the interrupt handler.
82 However, for devices that use multiple interrupts it can be useful to
83 distinguish the interrupt handlers.
84 When a description is set for an active interrupt handler,
85 a colon followed by the description is appended to the device name to form
86 the interrupt handler name.
88 Zero is returned on success, otherwise an appropriate error is returned.
90 .Xr BUS_SETUP_INTR 9 ,
100 functions first appeared in
103 It is not currently possible to remove a description from an active interrupt