Copyright (c) 2009 Hudson River Trading LLC Written by: John H. Baldwin <jhb@FreeBSD.org> All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and t...
NAMEBUS_DESCRIBE_INTR bus_describe_intr - associate a description with an active interrupt handler
SYNOPSISIn sys/param.h In sys/bus.h Ft int Fo BUS_BIND_INTR Fa device_t dev device_t child struct resource *irq void *cookie Fa const char *descr Fc Ft int Fo bus_describe_intr Fa device_t dev struct resource *irq void *cookie const char *fmt Fa ... Fc
DESCRIPTIONThe Fn BUS_DESCRIBE_INTR method associates a description with an active interrupt handler. The Fa cookie parameter must be the value returned by a successful call to BUS_SETUP_INTR9 for the interrupt Fa irq .
The Fn bus_describe_intr function is a simple wrapper around Fn BUS_DESCRIBE_INTR . As a convenience, Fn bus_describe_intr allows the caller to use printf(9) style formatting to build the description string using Fa fmt .
When an interrupt handler is established by BUS_SETUP_INTR9, the handler is named after the device the handler is established for. This name is then used in various places such as interrupt statistics displayed by systat(1) and vmstat(8). For devices that use a single interrupt, the device name is sufficiently unique to identify the interrupt handler. However, for devices that use multiple interrupts it can be useful to distinguish the interrupt handlers. When a description is set for an active interrupt handler, a colon followed by the description is appended to the device name to form the interrupt handler name.