xref: /dflybsd-src/share/man/man9/VOP_IOCTL.9 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino.\" Copyright (c) 1996 Doug Rabson
286d7f5d3SJohn Marino.\"
386d7f5d3SJohn Marino.\" All rights reserved.
486d7f5d3SJohn Marino.\"
586d7f5d3SJohn Marino.\" This program is free software.
686d7f5d3SJohn Marino.\"
786d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without
886d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions
986d7f5d3SJohn Marino.\" are met:
1086d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
1186d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
1286d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
1386d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
1486d7f5d3SJohn Marino.\"    documentation and/or other materials provided with the distribution.
1586d7f5d3SJohn Marino.\"
1686d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
1786d7f5d3SJohn Marino.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1886d7f5d3SJohn Marino.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1986d7f5d3SJohn Marino.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
2086d7f5d3SJohn Marino.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
2186d7f5d3SJohn Marino.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2286d7f5d3SJohn Marino.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2386d7f5d3SJohn Marino.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2486d7f5d3SJohn Marino.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2586d7f5d3SJohn Marino.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2686d7f5d3SJohn Marino.\"
2786d7f5d3SJohn Marino.\" $FreeBSD: src/share/man/man9/VOP_IOCTL.9,v 1.5.2.1 2001/12/17 11:30:18 ru Exp $
2886d7f5d3SJohn Marino.\"
2986d7f5d3SJohn Marino.Dd July 24, 1996
3086d7f5d3SJohn Marino.Dt VOP_IOCTL 9
3186d7f5d3SJohn Marino.Os
3286d7f5d3SJohn Marino.Sh NAME
3386d7f5d3SJohn Marino.Nm VOP_IOCTL
3486d7f5d3SJohn Marino.Nd device specific control
3586d7f5d3SJohn Marino.Sh SYNOPSIS
3686d7f5d3SJohn Marino.In sys/param.h
3786d7f5d3SJohn Marino.In sys/vnode.h
3886d7f5d3SJohn Marino.Ft int
3986d7f5d3SJohn Marino.Fn VOP_IOCTL "struct vnode *vp" "u_long command" "caddr_t data" "int fflag" "struct ucred *cred" "struct proc *p"
4086d7f5d3SJohn Marino.Sh DESCRIPTION
4186d7f5d3SJohn MarinoManipulate a file in device dependent ways.
4286d7f5d3SJohn Marino.Pp
4386d7f5d3SJohn MarinoIts arguments are:
4486d7f5d3SJohn Marino.Bl -tag -width command
4586d7f5d3SJohn Marino.It Ar vp
4686d7f5d3SJohn Marinothe vnode of the file (normally representing a device)
4786d7f5d3SJohn Marino.It Ar command
4886d7f5d3SJohn Marinothe device specific operation to perform
4986d7f5d3SJohn Marino.It Ar cnp
5086d7f5d3SJohn Marinoextra data for the specified operation
5186d7f5d3SJohn Marino.It Ar fflag
5286d7f5d3SJohn Marinosome flags ???
5386d7f5d3SJohn Marino.It Ar cred
5486d7f5d3SJohn Marinothe caller's credentials
5586d7f5d3SJohn Marino.It Ar p
5686d7f5d3SJohn Marinothe calling process
5786d7f5d3SJohn Marino.El
5886d7f5d3SJohn Marino.Pp
5986d7f5d3SJohn MarinoMost filesystems do not implement this entry point.
6086d7f5d3SJohn Marino.Sh LOCKS
6186d7f5d3SJohn MarinoThe file should not be locked on entry.
6286d7f5d3SJohn Marino.Sh RETURN VALUES
6386d7f5d3SJohn MarinoIf successful, zero is returned, otherwise an appropriate error code.
6486d7f5d3SJohn Marino.Sh PSEUDOCODE
6586d7f5d3SJohn Marino.Bd -literal
6686d7f5d3SJohn Marinoint
6786d7f5d3SJohn Marinovop_ioctl(struct vnode *vp, int command, caddr_t data, int fflag,
6886d7f5d3SJohn Marino	  struct ucred *cred, struct proc *p)
6986d7f5d3SJohn Marino{
7086d7f5d3SJohn Marino    return EOPNOTSUPP;
7186d7f5d3SJohn Marino}
7286d7f5d3SJohn Marino.Ed
7386d7f5d3SJohn Marino.Sh SEE ALSO
7486d7f5d3SJohn Marino.Xr vnode 9
7586d7f5d3SJohn Marino.Sh AUTHORS
7686d7f5d3SJohn MarinoThis man page was written by
7786d7f5d3SJohn Marino.An Doug Rabson .
78