xref: /freebsd/share/man/man9/VOP_IOCTL.9 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1fab63cc4SDoug Rabson.\" -*- nroff -*-
2fab63cc4SDoug Rabson.\"
3fab63cc4SDoug Rabson.\" Copyright (c) 1996 Doug Rabson
4fab63cc4SDoug Rabson.\"
5fab63cc4SDoug Rabson.\" All rights reserved.
6fab63cc4SDoug Rabson.\"
7fab63cc4SDoug Rabson.\" This program is free software.
8fab63cc4SDoug Rabson.\"
9fab63cc4SDoug Rabson.\" Redistribution and use in source and binary forms, with or without
10fab63cc4SDoug Rabson.\" modification, are permitted provided that the following conditions
11fab63cc4SDoug Rabson.\" are met:
12fab63cc4SDoug Rabson.\" 1. Redistributions of source code must retain the above copyright
13fab63cc4SDoug Rabson.\"    notice, this list of conditions and the following disclaimer.
14fab63cc4SDoug Rabson.\" 2. Redistributions in binary form must reproduce the above copyright
15fab63cc4SDoug Rabson.\"    notice, this list of conditions and the following disclaimer in the
16fab63cc4SDoug Rabson.\"    documentation and/or other materials provided with the distribution.
17fab63cc4SDoug Rabson.\"
18fab63cc4SDoug Rabson.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19fab63cc4SDoug Rabson.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20fab63cc4SDoug Rabson.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21fab63cc4SDoug Rabson.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22fab63cc4SDoug Rabson.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23fab63cc4SDoug Rabson.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24fab63cc4SDoug Rabson.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25fab63cc4SDoug Rabson.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26fab63cc4SDoug Rabson.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27fab63cc4SDoug Rabson.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28fab63cc4SDoug Rabson.\"
29fab63cc4SDoug Rabson.Dd July 24, 1996
30fab63cc4SDoug Rabson.Dt VOP_IOCTL 9
31*aa12cea2SUlrich Spörlein.Os
32fab63cc4SDoug Rabson.Sh NAME
33fab63cc4SDoug Rabson.Nm VOP_IOCTL
34fab63cc4SDoug Rabson.Nd device specific control
35fab63cc4SDoug Rabson.Sh SYNOPSIS
3632eef9aeSRuslan Ermilov.In sys/param.h
3732eef9aeSRuslan Ermilov.In sys/vnode.h
38fab63cc4SDoug Rabson.Ft int
39c2508101SAndrew R. Reiter.Fn VOP_IOCTL "struct vnode *vp" "u_long command" "caddr_t data" "int fflag" "struct ucred *cred" "struct thread *td"
40fab63cc4SDoug Rabson.Sh DESCRIPTION
413a9c9c6eSMike PritchardManipulate a file in device dependent ways.
42fab63cc4SDoug Rabson.Pp
43fab63cc4SDoug RabsonIts arguments are:
44fab63cc4SDoug Rabson.Bl -tag -width command
450640e9e0SHiten Pandya.It Fa vp
460a57ea7dSRuslan ErmilovThe vnode of the file (normally representing a device).
470640e9e0SHiten Pandya.It Fa command
480a57ea7dSRuslan ErmilovThe device specific operation to perform.
49e3673440SHiten Pandya.It Fa data
500a57ea7dSRuslan ErmilovExtra data for the specified operation.
510640e9e0SHiten Pandya.It Fa fflag
520a57ea7dSRuslan ErmilovSome flags ???
530640e9e0SHiten Pandya.It Fa cred
540a57ea7dSRuslan ErmilovThe caller's credentials.
550640e9e0SHiten Pandya.It Fa td
560a57ea7dSRuslan ErmilovThe calling thread.
57fab63cc4SDoug Rabson.El
58fab63cc4SDoug Rabson.Pp
59fab63cc4SDoug RabsonMost file systems do not implement this entry point.
60fab63cc4SDoug Rabson.Sh LOCKS
61fab63cc4SDoug RabsonThe file should not be locked on entry.
62fab63cc4SDoug Rabson.Sh RETURN VALUES
63fab63cc4SDoug RabsonIf successful, zero is returned, otherwise an appropriate error code.
6497c662f8SPoul-Henning Kamp.Pp
65d962d52aSRuslan ErmilovIf the ioctl is not recognized or not handled,
66d962d52aSRuslan Ermilov.Er ENOTTY
67d962d52aSRuslan Ermilovshould be returned.
68fab63cc4SDoug Rabson.Sh SEE ALSO
69fab63cc4SDoug Rabson.Xr vnode 9
70fab63cc4SDoug Rabson.Sh AUTHORS
71571dba6eSHiten PandyaThis manual page was written by
72aaf1f16eSPhilippe Charnier.An Doug Rabson .
73