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

   1 '\" te
   2 .\"  Copyright (c) 2007, 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 LDI_GET_EVENTCOOKIE 9F "Aug 21, 2007"
   7 .SH NAME
   8 ldi_get_eventcookie \- retrieve NDI event service cookie
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/ddi_obsolete.h>
  13
  14 \fBint\fR \fBldi_get_eventcookie\fR(\fBldi_handle_t\fR \fIlh\fR, \fIchar *name\fR
  15      \fIddi_eventcookie_t *ecp\fR);
  16 .fi
  17
  18 .SH INTERFACE LEVEL
  19 .sp
  20 .LP
  21 Obsolete
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIldi_handle_t lh\fR\fR
  27 .ad
  28 .RS 26n
  29 Layered handle.
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIchar *name\fR\fR
  36 .ad
  37 .RS 26n
  38 null-terminated string containing the event name.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fIddi_eventcookie_t *ecp\fR\fR
  45 .ad
  46 .RS 26n
  47 Pointer to the kernel event cookie.
  48 .RE
  49
  50 .SH DESCRIPTION
  51 .sp
  52 .LP
  53 This function is obsolete and is only maintained for compatibility. Use of this
  54 function is strongly discouraged. For equivalent functionality provided by new
  55 interfaces, see \fBldi_ev_get_cookie\fR(9F) and
  56 \fBldi_ev_register_callbacks\fR(9F).
  57 .sp
  58 .LP
  59 The \fBldi_get_eventcookie()\fR function queries the device tree for a cookie
  60 matching the given event name and returns a reference to that cookie. The
  61 search is performed by calling up the device tree hierarchy of the  device
  62 represented by the layered driver handle until the request is satisfied by a
  63 bus nexus driver,  or the top of the dev_info tree is reached.
  64 .sp
  65 .LP
  66 The cookie returned by this function can be used to register a callback handler
  67 with \fBldi_add_event_handler\fR(9F).
  68 .SH RETURN VALUES
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBDDI_SUCCESS\fR\fR
  73 .ad
  74 .RS 15n
  75 Cookie handle is returned.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBDDI_FAILURE\fR\fR
  82 .ad
  83 .RS 15n
  84 Request was not serviceable by any nexus driver in the target device's
  85 ancestral device tree hierarchy.
  86 .RE
  87
  88 .SH CONTEXT
  89 .sp
  90 .LP
  91 This function may be called from user or kernel contexts.
  92 .SH SEE ALSO
  93 .sp
  94 .LP
  95 \fBldi_ev_get_cookie\fR(9F), \fBldi_ev_register_callbacks\fR(9F),
  96 \fBldi_add_event_handler\fR(9F), \fBldi_remove_event_handler\fR(9F)
  97 .sp
  98 .LP
  99 \fIWriting Device Drivers\fR