usr/src/man/man9f/ddi_add_event_handler.9f

   1 '\" te
   2 .\"  Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH DDI_ADD_EVENT_HANDLER 9F "Nov 2, 2003"
   7 .SH NAME
   8 ddi_add_event_handler \- add an NDI event service callback handler
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/dditypes.h>
  13 #include <sys/sunddi.h>
  14
  15 \fBint\fR \fBddi_add_event_handler\fR(\fBdev_info_t *\fR\fIdip\fR, \fBddi_eventcookie_t\fR \fIcookie\fR,
  16      \fBvoid (*\fR\fIhandler\fR)(dev_info_t *, ddi_eventcookie_t, void *, void *),
  17      \fBvoid *\fR\fIarg\fR, \fBddi_registration_id_t *\fR\fIid\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris DDI specific (Solaris DDI).
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fBdev_info_t *\fR\fIdip\fR\fR
  29 .ad
  30 .sp .6
  31 .RS 4n
  32 Device node registering the callback.
  33 .RE
  34
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fBddi_eventcookie_t\fR \fIcookie\fR\fR
  39 .ad
  40 .sp .6
  41 .RS 4n
  42 Cookie returned from call to \fBddi_get_eventcookie\fR(9F).
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBvoid (*\fR\fIhandler\fR\fB)(dev_info_t *, ddi_eventcookie_t, void *, void
  49 *)\fR\fR
  50 .ad
  51 .sp .6
  52 .RS 4n
  53 Callback handler responsible for handling an NDI event service notification.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBvoid *\fR\fIarg\fR\fR
  60 .ad
  61 .sp .6
  62 .RS 4n
  63 Pointer to opaque data supplied by the caller. Typically, this would be a
  64 pointer to the driver's \fBsoftstate\fR structure.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBddi_registration_id_t *\fR\fIid\fR\fR
  71 .ad
  72 .sp .6
  73 .RS 4n
  74 Pointer to registration ID where a unique registration id will be returned.
  75 Registration ID must be saved and used when calling
  76 \fBddi_remove_event_handler\fR(9F) to unregister a callback.
  77 .RE
  78
  79 .SH DESCRIPTION
  80 .sp
  81 .LP
  82 The \fBddi_add_event_handler()\fR function adds a callback handler to be
  83 invoked in the face of the event specifed by \fIcookie\fR. The process of
  84 adding a callback handler is also known as subscribing to an event. Upon
  85 successful subscription, the handler will be invoked by the system when the
  86 event occurs. The handler can be unregistered by using
  87 \fBddi_remove_event_handler\fR(9F).
  88 .sp
  89 .LP
  90 An instance of a driver can register multiple handlers for an event or a single
  91 handler for multiple events. Callback order is not defined and should assumed
  92 to be random.
  93 .sp
  94 .LP
  95 The routine handler will be invoked with the following arguments:
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBdev_info_t *\fR\fIdip\fR\fR
 100 .ad
 101 .RS 28n
 102 Device node requesting the notification.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBddi_eventcookie_t\fR \fIcookie\fR\fR
 109 .ad
 110 .RS 28n
 111 Structure describing event that occurred.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBvoid *\fR\fIarg\fR\fR
 118 .ad
 119 .RS 28n
 120 Opaque data pointer provided, by the driver, during callback registration.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBvoid *\fR\fIimpl_data\fR\fR
 127 .ad
 128 .RS 28n
 129 Pointer to event specific data defined by the framework which invokes the
 130 callback function.
 131 .RE
 132
 133 .SH RETURN VALUES
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fBDDI_SUCCESS\fR\fR
 138 .ad
 139 .RS 15n
 140 Callback handler registered successfully.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBDDI_FAILURE\fR\fR
 147 .ad
 148 .RS 15n
 149 Failed to register callback handler. Possible reasons include lack of resources
 150 or a bad cookie.
 151 .RE
 152
 153 .SH CONTEXT
 154 .sp
 155 .LP
 156 The \fBddi_add_event_handler()\fR and \fBhandler()\fR function can be called
 157 from user and kernel contexts only.
 158 .SH ATTRIBUTES
 159 .sp
 160 .LP
 161 See \fBattributes\fR(5) for a description of the following attributes:
 162 .sp
 163
 164 .sp
 165 .TS
 166 box;
 167 c | c
 168 l | l .
 169 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 170 _
 171 Stability Level Committed
 172 .TE
 173
 174 .SH SEE ALSO
 175 .sp
 176 .LP
 177 \fBattributes\fR(5), \fBddi_get_eventcookie\fR(9F),
 178 \fBddi_remove_event_handler\fR(9F)
 179 .sp
 180 .LP
 181 \fIWriting Device Drivers\fR
 182 .SH NOTES
 183 .sp
 184 .LP
 185 Drivers must remove all registered callback handlers for a device instance by
 186 calling \fBddi_remove_event_handler\fR(9F) before detach completes.