document puffs_node_poll

lib/libpuffs/puffs_ops.3

@@ -1,4 +1,4 @@
-.\"	$NetBSD: puffs_ops.3,v 1.5 2007/05/09 13:46:16 pooka Exp $
+.\"	$NetBSD: puffs_ops.3,v 1.6 2007/05/18 14:38:15 pooka Exp $
 .\"
 .\" Copyright (c) 2007 Antti Kantee.  All rights reserved.
 .\"
@@ -23,7 +23,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd May 9, 2007
+.Dd May 18, 2007
 .Dt PUFFS_OPS 3
 .Os
 .Sh NAME
@@ -96,10 +96,10 @@
 .Fa "struct puffs_cc *pcc" "void *opc" "const struct vattr *va"
 .Fa "const struct puffs_cred *pcr" "pid_t pid"
 .Fc
-.\".Ft int
-.\".Fo puffs_node_poll
-.\".Fa "struct puffs_cc *pcc" "void *opc" "more args"
-.\".Fc
+.Ft int
+.Fo puffs_node_poll
+.Fa "struct puffs_cc *pcc" "void *opc" "int *events" "pid_t pid"
+.Fc
 .Ft int
 .Fo puffs_node_mmap
 .Fa "struct puffs_cc *pcc" "void *opc" "int flags"
@@ -436,6 +436,26 @@ Only fields of
 which contain a value different from
 .Dv PUFFS_VNOVAL
 (typecast to the field's type!) contain a valid value.
+.It Fn puffs_node_poll pcc opc events pid
+Poll for events on node
+.Ar opc .
+If
+.Xr poll 2
+events specified in
+.Ar events
+are available, the function should set the bitmask to match available
+events and return immediately.
+Otherwise, the function should block (yield) until some events in
+.Ar events
+become available and only then set the
+.Ar events
+bitmask and return.
+.Pp
+In case this function returns an error,
+.Dv POLLERR
+(or it's
+.Xr select 2
+equivalent) will be delivered to the calling process.
 .It Fn puffs_node_mmap "pcc" "opc" "flags" "pcr" "pid"
 Called when a regular file is being memory mapped by
 .Xr mmap 2 .