te
Copyright 2014 Nexenta Systems, Inc. All rights reserved.
Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
Copyright 1989 AT&T
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]
untimeout - cancel previous timeout function call

#include <sys/types.h>
#include <sys/conf.h>



clock_t untimeout(timeout_id_t id);

Architecture independent level 1 (DDI/DKI).

id

The untimeout() function cancels a pending timeout(9F) request. untimeout() will not return until the pending callback is cancelled or has run. Because of this, locks acquired by the callback routine must not be held across the call to untimeout() or a deadlock may result.

Since no mutex should be held across the call to untimeout(), there is a race condition between the occurrence of an expected event and the execution of the timeout handler. In particular, it should be noted that no problems will result from calling untimeout() for a timeout which is either running on another CPU, or has already completed. Drivers should be structured with the understanding that the arrival of both an interrupt and a timeout for that interrupt can occasionally occur, in either order.

The untimeout() function returns -1 if the id is not found. Otherwise, it returns an integer value greater than or equal to 0.

The untimeout() function can be called from user, interrupt, or kernel context.

In the following example, the device driver has issued an IO request and is waiting for the device to respond. If the device does not respond within 5 seconds, the device driver will print out an error message to the console.

static void
xxtimeout_handler(void *arg)
{
 struct xxstate *xsp = (struct xxstate *)arg;
 mutex_enter(&xsp->lock);
 cv_signal(&xsp->cv);
 xsp->flags |= TIMED_OUT;
 mutex_exit(&xsp->lock);
 xsp->timeout_id = 0;
}
static uint_t
xxintr(caddr_t arg)
{
 struct xxstate *xsp = (struct xxstate *)arg;
 .
 .
 .
 mutex_enter(&xsp->lock);
 /* Service interrupt */
 cv_signal(&xsp->cv);
 mutex_exit(&xsp->lock);
 if (xsp->timeout_id != 0) {
 (void) untimeout(xsp->timeout_id);
 xsp->timeout_id = 0;
 }
 return(DDI_INTR_CLAIMED);
}
static void
xxcheckcond(struct xxstate *xsp)
{
 .
 .
 .
 xsp->timeout_id = timeout(xxtimeout_handler,
 xsp, (5 * drv_usectohz(1000000)));
 mutex_enter(&xsp->lock);
 while (/* Waiting for interrupt or timeout*/)
 cv_wait(&xsp->cv, &xsp->lock);
 if (xsp->flags & TIMED_OUT)
 cmn_err(CE_WARN, "Device not responding");
 .
 .
 .
 mutex_exit(&xsp->lock);
 .
 .
 .
}

open (9E), cv_signal (9F), cv_wait_sig (9F), delay (9F), timeout (9F)

Writing Device Drivers