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$ 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.In sys/param.h 39.In sys/vnode.h 40.Ft int 41.Fn VOP_IOCTL "struct vnode *vp" "u_long command" "caddr_t data" "int fflag" "struct ucred *cred" "struct thread *td" 42.Sh DESCRIPTION 43Manipulate a file in device dependent ways. 44.Pp 45Its arguments are: 46.Bl -tag -width command 47.It Fa vp 48The vnode of the file (normally representing a device). 49.It Fa command 50The device specific operation to perform. 51.It Fa data 52Extra data for the specified operation. 53.It Fa fflag 54Some flags ??? 55.It Fa cred 56The caller's credentials. 57.It Fa td 58The calling thread. 59.El 60.Pp 61Most file systems do not implement this entry point. 62.Sh LOCKS 63The file should not be locked on entry. 64.Sh RETURN VALUES 65If successful, zero is returned, otherwise an appropriate error code. 66.Pp 67If the ioctl is not recognized or not handled, 68.Er ENOTTY 69should be returned. 70.Sh PSEUDOCODE 71.Bd -literal 72int 73vop_ioctl(struct vnode *vp, int command, caddr_t data, int fflag, 74 struct ucred *cred, struct thread *td) 75{ 76 77 return ENOTTY; 78} 79.Ed 80.Sh SEE ALSO 81.Xr vnode 9 82.Sh AUTHORS 83This manual page was written by 84.An Doug Rabson . 85