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

   1 '\" te
   2 .\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH DRV_USECWAIT 9F "Jan 16, 2006"
   8 .SH NAME
   9 drv_usecwait \- busy-wait for specified interval
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/types.h>
  14 #include <sys/ddi.h>
  15
  16
  17
  18 \fBvoid\fR \fBdrv_usecwait\fR(\fBclock_t\fR \fImicrosecs\fR);
  19 .fi
  20
  21 .SH INTERFACE LEVEL
  22 .sp
  23 .LP
  24 Architecture independent level 1 (DDI/DKI).
  25 .SH PARAMETERS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fImicrosecs\fR\fR
  30 .ad
  31 .RS 13n
  32 The number of microseconds to busy-wait.
  33 .RE
  34
  35 .SH DESCRIPTION
  36 .sp
  37 .LP
  38 The \fBdrv_usecwait()\fR function gives drivers a means of busy-waiting for a
  39 specified microsecond count. The amount of time spent busy-waiting may be
  40 greater than the microsecond count but will minimally be the number of
  41 microseconds specified.
  42 .sp
  43 .LP
  44 \fBdelay\fR(9F) can be used by a driver to delay for a specified number of
  45 system ticks, but it has two limitations. First, the granularity of the wait
  46 time is limited to one clock tick, which may be more time than is needed for
  47 the delay. Second, \fBdelay\fR(9F) can be invoked from user or kernel context
  48 and hence cannot be used at interrupt time or system initialization.
  49 .sp
  50 .LP
  51 Often, drivers need to delay for only a few microseconds, waiting for a write
  52 to a device register to be picked up by the device. In this case, even in user
  53 context, \fBdelay\fR(9F) produces too long a wait period.
  54 .SH CONTEXT
  55 .sp
  56 .LP
  57 The \fBdrv_usecwait()\fR function can be called from user, interrupt, or kernel
  58 context.
  59 .SH SEE ALSO
  60 .sp
  61 .LP
  62 \fBdelay\fR(9F), \fBtimeout\fR(9F), \fBuntimeout\fR(9F)
  63 .sp
  64 .LP
  65 \fIWriting Device Drivers\fR
  66 .SH NOTES
  67 .sp
  68 .LP
  69 The driver wastes processor time by making this call since \fBdrv_usecwait()\fR
  70 does not block but simply busy-waits. The driver should only make calls to
  71 \fBdrv_usecwait()\fR as needed, and only for as much time as needed. The
  72 \fBdrv_usecwait()\fR function does not mask out interrupts.