share/man/man9/VOP_IOCTL.9

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