ioctl(2) [osf1 man page]

ioctl(2)							System Calls Manual							  ioctl(2)

NAME

       ioctl - Controls devices

SYNOPSIS

       #include <stropts.h>

       int ioctl(
	       int fildes,
	       int request,
	       ... /* arg */);

STANDARDS

       Interfaces documented on this reference page conform to industry standards as follows:

       ioctl(): XSH5.0

       Refer to the standards(5) reference page for more information about industry standards and associated tags.

PARAMETERS

       Specifies  the  file  descriptor of the requested device.  Specifies the ioctl command to be performed on the device.  Specifies parameters
       for this request.  The type of arg is dependent on the specific ioctl() request and device to which the ioctl is targeted.  See the  appro-
       priate Section 7 reference page or the documentation accompanying the device for more information.

DESCRIPTION

       The  ioctl()  function  performs  a variety of control functions on devices and STREAMS.  For non-STREAMS files, the functions performed by
       this call are device-specific control functions.  The request and arg parameters are passed to the file designated by fildes and are inter-
       preted  by  the	device	driver.  This control is occasionally used on non-STREAMS devices, with the basic input/output functions performed
       through the read() and write() system calls.

       An ioctl() request has encoded in it whether the parameter is an "in" parameter or "out" parameter, and the size of the	arg  parameter	in
       bytes.  Macros and defines used to specify an ioctl() request are located in the <stropts.h> header file.

       For STREAMS files, specific functions are performed by the ioctl() function as described in streamio(7).

       STREAMS errors are described in streamio(7).

RETURN VALUES

       Upon successful completion, the ioctl() function returns a value other than -1 that depends upon the STREAMS device control function.

       If an error occurs, a value of -1 is returned and errno is set to indicate the error.

ERRORS

       The ioctl() function sets errno to the specified values for the following general conditions: The fildes parameter is not a valid open file
       descriptor.  A signal was caught during the ioctl() operation.  The STREAM or multiplexer referenced by fildes is linked (directly or indi-
       rectly) downstream from a multiplexer.

       If  an  underlying  device driver detects an error, errno may be set to one of the following values: Either the request or arg parameter is
       not valid.  Some physical I/O error has occurred.  The fildes parameter is not associated with a STREAMS device that accepts control  func-
       tions.  (Defined  for  Issue 4 Version 2 and higher issues of the XSH specification.)  [Tru64 UNIX]  The fildes parameter is not associated
       with a character special device, or the specified request does not apply to the kind of object that the fildes parameter  references.   The
       request	and  arg  parameters  are valid for this device driver, but the service requested cannot be performed on the particular subdevice.
       The fildes parameter refers to a valid STREAMS device, but the corresponding device driver does not support the ioctl() function.

RELATED INFORMATION

       Functions: exec(2), fcntl(2)

       Files: tty(7), streamio(7)

       Standards: standards(5) delim off

																	  ioctl(2)

Check Out this Related Man Page

ldi_ioctl(9F)						   Kernel Functions for Drivers 					     ldi_ioctl(9F)

NAME

       ldi_ioctl - send an ioctl to a device

SYNOPSIS

       #include <sys/sunldi.h>

       int ldi_ioctl(ldi_handle_t lh, int cmd, intptr_t arg, int mode,
	    cred_t  *cr, int *rvalp);

PARAMETERS

       lh	Layered handle.

       cr	Pointer to a credential structure used to open a device.

       rvalp	Caller return value. (May be set by driver and is valid only if the ioctl() succeeds).

       cmd	Command argument. Interpreted by driver ioctl() as the operation to be performed.

       arg	Driver parameter. Argument interpretation is driver dependent and usually depends on the command type.

       mode	Bit field that contains:

		FKIOCTL    Inform the target device that the ioctl originated from within the kernel.

DESCRIPTION

       The  ldi_ioctl()  function passes an ioctl request to the device entry point for the device specified by the layered handle. This operation
       is supported for block, character, and streams devices.

       If arg is interpreted  as a pointer (that is, as not an immediate value) and the data pointed to by arg is in the  kernels  address  space,
       the FKIOCTL flag should be set. This indicates to the target driver that no data model conversion is necessary.

       If the caller of ldi_ioctl() is not the originator of the ioctl data pointed to by arg, (for example, when passing on an ioctl request from
       a user process), the caller must pass on the mode parameter from the original ioctl. This is because the mode parameter contains  the  con-
       tains  the FMODELS bits that enable the target driver to determine the data model of the process which originated the ioctl and perform any
       necessary conversions. See ddi_model_convert_from(9F) for more information.

STREAM IOCTLS

       For a general description of streams ioctls see streamio(7I). ldi_ioctl() supports a number of streams ioctls, using layered handles in the
       place  of file descriptors. When issuing streams ioctls the FKIOCTL parameter should be specified. The possible return values for supported
       ioctl commands are also documented in streamio(7I).

       The following streams ioctls are supported:

       I_PLINK	    Behaves as documented in streamio(7I). The layered handle lh should point to the streams multiplexer. The arg parameter should
		    point to a layered handle for another streams driver.

       I_UNPLINK    Behaves  as  documented in streamio(7I)).  The layered handle lh should point to the streams multiplexer. The arg parameter is
		    the multiplexor ID number returned by I_PLINK when the streams were linked.

RETURN VALUES

       The ldi_ioctl() function returns 0 upon success. If a failure occurs before the request is passed on to the device, possible return  values
       are shown below. Otherwise any other error number may be returned by the device.

       EINVAL	  Invalid input parameters.

       ENOTSUP	  Operation is not supported for this device.

CONTEXT

       These functions can be called from user or kernel context.

SEE ALSO

       streamio(7I), ddi_model_convert_from(9F)

SunOS 5.11							    3 June 2003 						     ldi_ioctl(9F)

Linux and UNIX Man Pages

ioctl(2) [osf1 man page]

Check Out this Related Man Page