VOP_IOCTL (9)

Leading comments

Copyright (c) 1996 Doug Rabson

All rights reserved.

This program is free software.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in...

(The comments found at the beginning of the groff file "man9/VOP_IOCTL.9freebsd".)

NAME

VOP_IOCTL - device specific control

SYNOPSIS

In sys/param.h In sys/vnode.h Ft int Fn VOP_IOCTL struct vnode *vp u_long command caddr_t data int fflag struct ucred *cred struct thread *td

DESCRIPTION

Manipulate a file in device dependent ways.

Its arguments are:

Fa vp

The vnode of the file (normally representing a device).

Fa command

The device specific operation to perform.

Fa data

Extra data for the specified operation.

Fa fflag

Some flags ???

Fa cred

The caller's credentials.

Fa td

The calling thread.

Most file systems do not implement this entry point.

LOCKS

The file should not be locked on entry.

RETURN VALUES

If successful, zero is returned, otherwise an appropriate error code.

If the ioctl is not recognized or not handled, Er ENOTTY should be returned.

SEE ALSO

vnode(9)

AUTHORS

This manual page was written by An Doug Rabson .