share/man/man9/VOP_IOCTL.9

   1 .\" Copyright (c) 1996 Doug Rabson
   2 .\"
   3 .\" All rights reserved.
   4 .\"
   5 .\" This program is free software.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man9/VOP_IOCTL.9,v 1.5.2.1 2001/12/17 11:30:18 ru Exp $
  28 .\" $DragonFly: src/share/man/man9/VOP_IOCTL.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
  29 .\"
  30 .Dd July 24, 1996
  31 .Os
  32 .Dt VOP_IOCTL 9
  33 .Sh NAME
  34 .Nm VOP_IOCTL
  35 .Nd device specific control
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/vnode.h
  39 .Ft int
  40 .Fn VOP_IOCTL "struct vnode *vp" "u_long command" "caddr_t data" "int fflag" "struct ucred *cred" "struct proc *p"
  41 .Sh DESCRIPTION
  42 Manipulate a file in device dependent ways.
  43 .Pp
  44 Its arguments are:
  45 .Bl -tag -width command
  46 .It Ar vp
  47 the vnode of the file (normally representing a device)
  48 .It Ar command
  49 the device specific operation to perform
  50 .It Ar cnp
  51 extra data for the specified operation
  52 .It Ar fflag
  53 some flags ???
  54 .It Ar cred
  55 the caller's credentials
  56 .It Ar p
  57 the calling process
  58 .El
  59 .Pp
  60 Most filesystems do not implement this entry point.
  61 .Sh LOCKS
  62 The file should not be locked on entry.
  63 .Sh RETURN VALUES
  64 If successful, zero is returned, otherwise an appropriate error code.
  65 .Sh PSEUDOCODE
  66 .Bd -literal
  67 int
  68 vop_ioctl(struct vnode *vp, int command, caddr_t data, int fflag,
  69           struct ucred *cred, struct proc *p)
  70 {
  71     return EOPNOTSUPP;
  72 }
  73 .Ed
  74 .Sh SEE ALSO
  75 .Xr vnode 9
  76 .Sh AUTHORS
  77 This man page was written by
  78 .An Doug Rabson .