share/man/man9f/nochpoll.9f

   1 '\" te
   2 .\"  Copyright (c) 2006, 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 NOCHPOLL 9F "Jan 16, 2006"
   7 .SH NAME
   8 nochpoll \- error return function for non-pollable devices
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/ddi.h>
  13 #include <sys/sunddi.h>
  14
  15
  16
  17 \fBint\fR \fBnochpoll\fR(\fBdev_t\fR \fIdev\fR, \fBshort\fR \fIevents\fR, \fBint\fR \fIanyyet\fR, \fBshort\fR \fI*reventsp\fR,
  18       \fBstruct pollhead\fR \fI**pollhdrp\fR);
  19 .fi
  20
  21 .SH INTERFACE LEVEL
  22 .sp
  23 .LP
  24 Solaris DDI specific (Solaris DDI).
  25 .SH PARAMETERS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fIdev\fR\fR
  30 .ad
  31 .RS 12n
  32 Device number.
  33 .RE
  34
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fIevents\fR\fR
  39 .ad
  40 .RS 12n
  41 Event flags.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fIanyyet\fR\fR
  48 .ad
  49 .RS 12n
  50 Check current events only.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fIreventsp\fR\fR
  57 .ad
  58 .RS 12n
  59 Event flag pointer.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fIpollhdrp\fR\fR
  66 .ad
  67 .RS 12n
  68 Poll head pointer.
  69 .RE
  70
  71 .SH DESCRIPTION
  72 .sp
  73 .LP
  74 The \fBnochpoll()\fR function is a routine that simply returns the value
  75 \fBENXIO\fR. It is intended to be used in the \fBcb_ops\fR(9S) structure of a
  76 device driver for devices that do not support the \fBpoll\fR(2) system call.
  77 .SH RETURN VALUES
  78 .sp
  79 .LP
  80 The \fBnochpoll()\fR function returns \fBENXIO\fR.
  81 .SH CONTEXT
  82 .sp
  83 .LP
  84 The \fBnochpoll()\fR function can be called from user, interrupt, or kernel
  85 context.
  86 .SH SEE ALSO
  87 .sp
  88 .LP
  89 \fBpoll\fR(2), \fBchpoll\fR(9E), \fBcb_ops\fR(9S)
  90 .sp
  91 .LP
  92 \fIWriting Device Drivers\fR