man/man9f/ddi_get_eventcookie.9f

         te
 Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
 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.
 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.
 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]
 ddi_get_eventcookie 9F "6 Nov 2003" "SunOS 5.11" "Kernel Functions for Drivers"
 NAME
ddi_get_eventcookie - retrieve a NDI event service cookie handle
 SYNOPSIS

#include <sys/dditypes.h>
#include <sys/sunddi.h>

int ddi_get_eventcookie(dev_info_t *dip, char *name,
 ddi_eventcookie_t *event_cookiep);


 INTERFACE LEVEL

Solaris DDI specific (Solaris DDI).
 PARAMETERS

dev_info_t *dip

Child device node requesting the cookie.


char *name

NULL-terminated string containing the name of the event.


ddi_eventcookie_t *event_cookiep

Pointer to cookie where event cookie will be returned.


 DESCRIPTION

The ddi_get_eventcookie() function queries the device tree for a cookie
matching the given event name and returns a reference to that cookie. The
search is performed by a calling up the device tree hierarchy until the request
is satisfied by a bus nexus driver, or the top of the dev_info tree is
reached.

The cookie returned by this function can be used to register a callback
handler, unregister a callback handler, or post an event.
 RETURN VALUES

DDI_SUCCESS

Cookie handle is returned.


DDI_FAILURE

Request was not serviceable by any nexus driver in the driver's ancestral
device tree hierarchy.


 CONTEXT

The ddi_get_eventcookie() function can be called from user and kernel
contexts only.
 ATTRIBUTES

See attributes(5) for a description of the following attributes:


ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityCommitted


 SEE ALSO

attributes(5), ddi_add_event_handler(9F),
ddi_remove_event_handler(9F)

Writing Device Drivers