xref: /dragonfly/share/man/man9/VOP_IOCTL.9 (revision 279dd846)
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.\"
29.Dd July 24, 1996
30.Dt VOP_IOCTL 9
31.Os
32.Sh NAME
33.Nm VOP_IOCTL
34.Nd device specific control
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/vnode.h
38.Ft int
39.Fn VOP_IOCTL "struct vnode *vp" "u_long command" "caddr_t data" "int fflag" "struct ucred *cred" "struct proc *p"
40.Sh DESCRIPTION
41Manipulate a file in device dependent ways.
42.Pp
43Its arguments are:
44.Bl -tag -width command
45.It Ar vp
46the vnode of the file (normally representing a device)
47.It Ar command
48the device specific operation to perform
49.It Ar cnp
50extra data for the specified operation
51.It Ar fflag
52some flags ???
53.It Ar cred
54the caller's credentials
55.It Ar p
56the calling process
57.El
58.Pp
59Most filesystems do not implement this entry point.
60.Sh LOCKS
61The file should not be locked on entry.
62.Sh RETURN VALUES
63If successful, zero is returned, otherwise an appropriate error code.
64.Sh PSEUDOCODE
65.Bd -literal
66int
67vop_ioctl(struct vnode *vp, int command, caddr_t data, int fflag,
68	  struct ucred *cred, struct proc *p)
69{
70    return EOPNOTSUPP;
71}
72.Ed
73.Sh SEE ALSO
74.Xr vnode 9
75.Sh AUTHORS
76This man page was written by
77.An Doug Rabson .
78