Copyright (c) 2009, 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]
#include <sys/dditypes.h> #include <sys/sunddi.h> void ddi_periodic_delete(ddi_periodic_t req);
Solaris DDI specific (Solaris DDI)
req
ddi_periodic_t opaque value returned by ddi_periodic_add(9F)
The ddi_periodic_delete() function cancels the ddi_periodic_add(9F) request that was previously issued.
As with untimeout(9F), calling ddi_periodic_delete() against a periodic timeout request which is either running on another CPU, or has already been canceled causes no problems. Unlike untimeout(9F), there are no restrictions on the lock which might be held across the call to ddi_periodic_delete().
The ddi_periodic_delete() function may be called from user or kernel context.
Example 1 Cancelling a timeout request
In the following example, the device driver cancels the timeout request by calling ddi_periodic_delete() against the request that was previously issued.
/*
* Stop the periodic timer
*/
static void
stop_periodic_timer(struct my_state *statep)
{
ddi_periodic_delete(statep->periodic_id);
delay(1); /* wait for one tick */
mutex_destory(&statep->lock);
}
static void
start_periodic_timer(struct my_state *statep)
{
hrtime_t interval = CHECK_INTERVAL;
mutex_init(&statep->lock, NULL, MUTEX_DRIVER,
(void *)DDI_IPL_0);
/*
* Register my_callback which is invoked periodically
* in CHECK_INTERVAL in kernel context.
*/
statep->periodic_id = ddi_periodic_add(my_periodic_func,
statep, interval, DDI_IPL_0);
}
static void
my_periodic_func(void *arg)
{
/*
* This handler is invoked periodically.
*/
struct my_state *statep = (struct my_state *)arg;
mutex_enter(&statep->lock);
if (load_unbalanced(statep)) {
balance_tasks(statep);
}
mutex_exit(&statep->lock);
}
cv_timedwait(9F), ddi_intr_get_pri(9F), ddi_periodic_add(9F), delay(9F), drv_usectohz(9F), qtimeout(9F), quntimeout(9F), timeout(9F), untimeout(9F)
There might be a race between a callback invocation and ddi_periodic_delete(). A device driver should take a responsibility for this avoidance if needed by using the kernel synchronization such as a mutex lock or calling delay(9F) as in the example above.