xref: /freebsd/share/man/man9/VOP_IOCTL.9 (revision df7f5d4de4592a8948a25ce01e5bddfbb7ce39dc)
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.\" $Id: VOP_IOCTL.9,v 1.1 1997/03/03 18:00:21 dfr Exp $
30.\"
31.Dd July 24, 1996
32.Os
33.Dt VOP_IOCTL 9
34.Sh NAME
35.Nm VOP_IOCTL
36.Nd device specific control
37.Sh SYNOPSIS
38.Fd #include <sys/vnode.h>
39.Ft int
40.Fn VOP_IOCTL "struct vnode *vp" "int command" "caddr_t data" "int fflag" "struct ucred *cred" "struct proc *p"
41.Sh DESCRIPTION
42Manipulate a file in device dependent ways.
43.Pp
44Its arguments are:
45.Bl -tag -width command
46.It Ar vp
47the vnode of the file (normally representing a device)
48.It Ar command
49the device specific operation to perform
50.It Ar cnp
51extra data for the specified operation
52.It Ar fflag
53some flags ???
54.It Ar cred
55the caller's credentials
56.It Ar p
57the calling process
58.El
59.Pp
60Most filesystems do not implement this entry point.
61.Sh LOCKS
62The file should not be locked on entry.
63.Sh RETURN VALUES
64If successful, zero is returned, otherwise an appropriate error code.
65.Sh PSEUDOCODE
66.Bd -literal
67int
68vop_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
77This man page was written by Doug Rabson.
78
79