DDI_INTR_GET_PRI(9F) Kernel Functions for Drivers DDI_INTR_GET_PRI(9F)
ddi_intr_get_pri, ddi_intr_set_pri - get or set priority of a given
interrupt
#include <sys/types.h>
#include <sys/conf.h>
#include <sys/ddi.h>
#include <sys/sunddi.h>
int ddi_intr_get_pri(ddi_intr_handle_t h, uint_t *prip);
int ddi_intr_set_pri(ddi_intr_handle_t h, uint_t pri);
illumos DDI specific (illumos DDI).
ddi_intr_get_pri()
h
DDI interrupt handle
prip
Pointer to the priority returned for this handle
ddi_intr_set_pri()
h
DDI interrupt handle
pri
Contains the priority to be set
The ddi_intr_get_pri() function returns the current priority of the
interrupt handle h of a given device. Upon a successful return, prip
points to a small integer value, typically in the
DDI_INTR_PRI_MIN...DDI_INTR_PRI_MAX range, that represents the
current software priority setting for the interrupt. See
<sys/ddi_intr.h> for values of DDI_INTR_PRI_MIN or DDI_INTR_PRI_MAX.
The ddi_intr_get_pri() function can be called any time, even if the
driver adds an interrupt handler for the interrupt specification.
The software priority returned from ddi_intr_get_pri() can be used in
calls to mutex_init() and rw_init().
The ddi_intr_set_pri() function sets the priority pri of the
interrupt handle h of a given device. The function validates that the
argument is within the supported range.
The ddi_intr_set_pri() function can only be called prior to adding
the interrupt handler or when an interrupt handler is unassigned.
DDI_FAILURE is returned in all other cases.
The ddi_intr_get_pri() and ddi_intr_set_pri() functions return:
DDI_SUCCESS
On success.
DDI_EINVAL
On encountering invalid input parameters.
DDI_FAILURE
On any implementation specific failure.
DDI_ENOTSUP
On device not supporting operation.
The ddi_intr_get_pri() and ddi_intr_set_pri() functions can be called
from kernel non-interrupt context.
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
attributes(7), ddi_intr_alloc(9F), ddi_intr_enable(9F),
mutex_init(9F), rw_init(9F)
Writing Device Drivers
The priority returned from ddi_intr_get_pri() should be typecast by
calling the DDI_INTR_PRI macro before passing it onto mutex_init(9F).
Consumers of these interfaces should verify that the return value is
not equal to DDI_SUCCESS. Incomplete checking for failure codes could
result in inconsistent behavior among platforms.
June 4, 2007 DDI_INTR_GET_PRI(9F)
NAME
ddi_intr_get_pri, ddi_intr_set_pri - get or set priority of a given
interrupt
SYNOPSIS
#include <sys/types.h>
#include <sys/conf.h>
#include <sys/ddi.h>
#include <sys/sunddi.h>
int ddi_intr_get_pri(ddi_intr_handle_t h, uint_t *prip);
int ddi_intr_set_pri(ddi_intr_handle_t h, uint_t pri);
INTERFACE LEVEL
illumos DDI specific (illumos DDI).
PARAMETERS
ddi_intr_get_pri()
h
DDI interrupt handle
prip
Pointer to the priority returned for this handle
ddi_intr_set_pri()
h
DDI interrupt handle
pri
Contains the priority to be set
DESCRIPTION
The ddi_intr_get_pri() function returns the current priority of the
interrupt handle h of a given device. Upon a successful return, prip
points to a small integer value, typically in the
DDI_INTR_PRI_MIN...DDI_INTR_PRI_MAX range, that represents the
current software priority setting for the interrupt. See
<sys/ddi_intr.h> for values of DDI_INTR_PRI_MIN or DDI_INTR_PRI_MAX.
The ddi_intr_get_pri() function can be called any time, even if the
driver adds an interrupt handler for the interrupt specification.
The software priority returned from ddi_intr_get_pri() can be used in
calls to mutex_init() and rw_init().
The ddi_intr_set_pri() function sets the priority pri of the
interrupt handle h of a given device. The function validates that the
argument is within the supported range.
The ddi_intr_set_pri() function can only be called prior to adding
the interrupt handler or when an interrupt handler is unassigned.
DDI_FAILURE is returned in all other cases.
RETURN VALUES
The ddi_intr_get_pri() and ddi_intr_set_pri() functions return:
DDI_SUCCESS
On success.
DDI_EINVAL
On encountering invalid input parameters.
DDI_FAILURE
On any implementation specific failure.
DDI_ENOTSUP
On device not supporting operation.
CONTEXT
The ddi_intr_get_pri() and ddi_intr_set_pri() functions can be called
from kernel non-interrupt context.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
SEE ALSO
attributes(7), ddi_intr_alloc(9F), ddi_intr_enable(9F),
mutex_init(9F), rw_init(9F)
Writing Device Drivers
NOTES
The priority returned from ddi_intr_get_pri() should be typecast by
calling the DDI_INTR_PRI macro before passing it onto mutex_init(9F).
Consumers of these interfaces should verify that the return value is
not equal to DDI_SUCCESS. Incomplete checking for failure codes could
result in inconsistent behavior among platforms.
June 4, 2007 DDI_INTR_GET_PRI(9F)