path: root/usr/src/man/man7i/prnio.7i

'\" te
.\"  Copyright (c) 20002 Sun Microsystems, Inc.
.\"  All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH PRNIO 7I "Jan 2, 2002"
.SH NAME
prnio \- generic printer interface
.SH SYNOPSIS
.LP
.nf
\fB#include <sys/prnio.h>\fR
.fi

.SH DESCRIPTION
.sp
.LP
The \fBprnio\fR generic printer interface defines ioctl commands and data
structures for printer device drivers.
.sp
.LP
\fBprnio\fR defines and provides facilities for five basic phases of the
printing process:
.RS +4
.TP
.ie t \(bu
.el o
Identification \(em Retrieve device information/attributes
.RE
.RS +4
.TP
.ie t \(bu
.el o
Setup \(em Set device attributes
.RE
.RS +4
.TP
.ie t \(bu
.el o
Transfer \(em Transfer data to or from the device
.RE
.RS +4
.TP
.ie t \(bu
.el o
Cleanup \(em Transfer phase conclusion
.RE
.RS +4
.TP
.ie t \(bu
.el o
Abort \(em Transfer phase interruption
.RE
.sp
.LP
During the Identification phase, the application retrieves a set of device
capabilities and additional information using the \fBPRNIOC_GET_IFCAP\fR,
\fBPRNIOC_GET_STATUS\fR, \fBPRNIOC_GET_TIMEOUTS\fR, \fBPRNIOC_GET_IFINFO\fR and
\fBPRNIOC_GET_1284_DEVID\fR commands.
.sp
.LP
During the Setup phase the application sets some interface attributes and
probably resets the printer as described in the \fBPRNIOC_SET_IFCAP\fR,
\fBPRNIOC_SET_TIMEOUTS\fR and \fBPRNIOC_RESET\fR sections.
.sp
.LP
During the Transfer phase, data is transferred in a forward (host to
peripheral) or reverse direction (peripheral to host). Transfer is accomplished
using \fBwrite\fR(2) and \fBread\fR(2) system calls. For \fBprnio\fR compliant
printer drivers, forward transfer support is mandatory, while reverse transfer
support is optional. Applications can also use \fBPRNIOC_GET_STATUS\fR and
\fBPRNIOC_GET_1284_STATUS\fR commands during the transfer to monitor the device
state.
.sp
.LP
The Cleanup phase is accomplished by closing the device using \fBclose\fR(2).
Device drivers supporting \fBprnio\fR may set non-zero error code as
appropriate. Applications should explicitly \fBclose\fR(2) a device before
exiting and check \fBerrno\fR value.
.sp
.LP
The Abort phase is accomplished by interrupting the \fBwrite\fR(2) and
\fBread\fR(2) system calls. The application can perform some additional cleanup
during the Abort phase as described in \fBPRNIOC_GET_IFCAP\fR section.
.SH IOCTLS
.sp
.ne 2
.na
\fB\fBPRNIOC_GET_IFCAP\fR\fR
.ad
.RS 21n
Application can retrieve printer interface capabilities using this command. The
\fBioctl\fR(2) argument is a pointer to \fBuint_t\fR, a bit field representing
a set of properties and services provided by a printer driver. Set bit means
supported capability. The following values are defined:
.br
.in +2
\fBPRN_BIDI\fR - When this bit is set,  the interface operates in a
bidirectional mode,  instead of forward-only mode.
.in -2
.br
.in +2
\fBPRN_HOTPLUG\fR - If this bit is set, the interface allows device
hot-plugging.
.in -2
.br
.in +2
\fBPRN_1284_DEVID\fR - If this bit is set, the device is capable of returning
\fI1284\fR device ID (see \fBPRNIOC_GET_1284_DEVID\fR.)
.in -2
.br
.in +2
\fBPRN_1284_STATUS\fR - If this bit is set, the device driver can return device
status lines (see \fBPRNIOC_GET_1284_STATUS\fR). Some devices support this
ioctl in unidirectional mode only.
.in -2
.br
.in +2
\fBPRN_TIMEOUTS\fR - If this bit is set the peripheral may stall during the
transfer phase and the driver can timeout and return from the \fBwrite\fR(2)
and \fBread\fR(2) returning the number of bytes that have been transferred. If
\fBPRN_TIMEOUTS\fR is set, the driver supports this functionality and the
timeout values can be retrieved and modified via the \fBPRNIOC_GET_TIMEOUTS\fR
and \fBPRNIOC_SET_TIMEOUTS\fR ioctls. Otherwise, applications can implement
their own timeouts and abort phase.
.in -2
.br
.in +2
\fBPRN_STREAMS\fR - This bit impacts the application abort phase behaviour. If
the device claimed \fBPRN_STREAMS\fR capability, the application must issue an
\fBI_FLUSH\fR \fBioctl\fR(2) before \fBclose\fR(2) to dismiss the untransferred
data. Only STREAMS drivers can support this capability.
.in -2
.RE

.sp
.ne 2
.na
\fBPRNIOC_SET_IFCAP\fR
.ad
.RS 21n
This ioctl can be used to change interface capabilities. The argument is a
pointer to \fBuint_t\fR bit field that is described in detail in the
\fBPRNIOC_GET_IFCAP\fR section. Capabilities should be set one at a time;
otherwise the command will return \fBEINVAL\fR. The following capabilities can
be changed by this ioctl:
.br
.in +2
\fBPRN_BIDI\fR - When this capability is set, the interface operates in a
bidirectional mode, instead of forward-only mode. Devices that support only one
mode will not return error; applications should use \fBPRNIOC_GET_IFCAP\fR to
check if the mode was successfully changed. Because some capabilities may be
altered as a side effect of changing other capabilities, this command should be
followed by \fBPRNIOC_GET_IFCAP\fR.
.in -2
.RE

.sp
.ne 2
.na
\fBPRNIOC_GET_IFINFO\fR
.ad
.RS 21n
This command can be used to retrieve printer interface info string, which is an
arbitrary format string usually describing the bus type. The argument is a
pointer to \fBstruct prn_interface_info\fR as described below.
.RE

.sp
.in +2
.nf
struct prn_interface_info {
  uint_t	  if_len;   /* length of buffer */
  uint_t	  if_rlen;  /* actual info length */
  char   *if_data;  /* buffer address */
};
.fi
.in -2

.sp
.LP
The application allocates a buffer and sets \fBif_data\fR and \fBif_len\fR
values to its address and length, respectively. The driver returns the string
to this buffer and sets  \fBif_len\fR to its length. If   \fBif_len\fR is less
that \fBif_rlen\fR, the driver must return the first \fBif_len\fR bytes of the
string. The application  may then repeat the command with a bigger buffer.
.sp
.LP
Although \fBprnio\fR does not limit the contents of the interface info string,
some values are recommended and defined in <\fBsys/prnio.h\fR> by the following
macros:
.br
.in +2
\fBPRN_PARALLEL\fR - Centronics or \fIIEEE 1284\fR compatible devices
.in -2
.br
.in +2
\fBPRN_SERIAL\fR - EIA-232/EIA-485 serial ports
.in -2
.br
.in +2
\fBPRN_USB\fR - Universal Serial Bus printers
.in -2
.br
.in +2
\fBPRN_1394\fR - \fIIEEE 1394\fR peripherals
.in -2
.br
.in +2
Printer interface info string is for information only: no implications should
be made from its value.
.in -2
.sp
.ne 2
.na
\fBPRNIOC_RESET\fR
.ad
.RS 25n
Some applications may want to reset the printer state during Setup and/or
Cleanup phase using \fBPRNIOC_RESET\fR command. Reset semantics are
device-specific, and in general, applications using this command should be
aware of the printer type.
.sp
Each \fBprnio\fR compliant driver is required to accept this request, although
performed actions are completely driver-dependent. More information on the
\fBPRNIOC_RESET\fR implementation for the particular driver is available in the
corresponding man page and printer manual.
.RE

.sp
.ne 2
.na
\fBPRNIOC_GET_1284_DEVID\fR
.ad
.RS 25n
This command can be used to retrieve printer device ID as defined by \fIIEEE
1284-1994\fR.The \fBioctl\fR(2) argument is a pointer to \fBstruct
prn_1284_device_id\fR as described below.
.RE

.sp
.in +2
.nf
struct prn_1284_device_id {
   uint_t	  id_len;   /* length of buffer */
   uint_t	  id_rlen;  /* actual ID length */
   char      *id_data;  /* buffer address */
};
.fi
.in -2

.sp
.LP
For convenience, the two-byte length field is not considered part of device ID
string and is not returned in the user buffer. Instead, \fBid_rlen\fR  value
shall be set to (length - 2) by the driver, where length is the ID length field
value. If buffer length is less than \fBid_rlen\fR, the driver returns the
first \fBid_len\fR bytes of the ID.
.sp
.LP
The printer driver must return the most up-to-date value of the device ID.
.sp
.ne 2
.na
\fBPRNIOC_GET_STATUS\fR
.ad
.RS 21n
This command can be used by applications to retrieve current device status. The
argument is a pointer to \fBuint_t\fR, where the status word is returned.
Status is a combination of the following bits:
.RE

.br
.in +2
\fBPRN_ONLINE\fR - For devices that support \fBPRN_HOTPLUG\fR capability,
this bit is set when the device is online, otherwise the device is offline.
Devices without \fBPRN_HOTPLUG\fR support should always have this bit set.
.in -2
.br
.in +2
\fBPRN_READY\fR - This bit indicates if the device is ready to receive/send
data. Applications may use this bit for an outbound flow control
.in -2
.sp
.ne 2
.na
\fB\fBPRNIOC_GET_1284_STATUS\fR\fR
.ad
.RS 26n
Devices that support \fBPRN_1284_STATUS\fR capability accept this ioctl to
retrieve the device status lines defined in \fIIEEE 1284\fR for use in
Compatibility mode. The following bits may be set by the driver:
.br
.in +2
\fBPRN_1284_NOFAULT\fR - Device is not in error state
.in -2
.br
.in +2
\fBPRN_1284_SELECT\fR - Device is selected
.in -2
.br
.in +2
\fBPRN_1284_PE\fR - Paper error
.in -2
.br
.in +2
\fBPRN_1284_BUSY\fR - Device is busy
.in -2
.RE

.sp
.ne 2
.na
\fB\fBPRNIOC_GET_TIMEOUTS\fR\fR
.ad
.RS 26n
This command  retrieves current transfer timeout values for  the driver. The
argument is  a pointer to \fBstruct prn_timeouts\fR as described below.
.RE

.sp
.in +2
.nf
struct prn_timeouts {
  uint_t	tmo_forward;  /* forward transfer timeout */
  uint_t	tmo_reverse;  /* reverse transfer timeout */
	};
.fi
.in -2

.sp
.LP
\fBtmo_forward\fR and \fBtmo_reverse\fR define forward and reverse transfer
timeouts in seconds. This command is only valid for drivers that support
\fBPRN_TIMEOUTS\fR capability.
.sp
.ne 2
.na
\fB\fBPRNIOC_SET_TIMEOUTS\fR\fR
.ad
.RS 23n
This command sets current transfer  timeout values for the driver. The
argument is  a pointer to \fBstruct prn_timeouts\fR. See
\fBPRNIOC_GET_TIMEOUTS\fR for description of  this structure. This  command is
only valid for drivers that support \fBPRN_TIMEOUTS\fR capability.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Architecture	 SPARC, IA
_
Interface Stability	Evolving
.TE

.SH SEE ALSO
.sp
.LP
\fBclose\fR(2), \fBioctl\fR(2), \fBread\fR(2), \fBwrite\fR(2),
\fBattributes\fR(5), \fBecpp\fR(7D), \fBusbprn\fR(7D), \fBlp\fR(7D)
.sp
.LP
\fIIEEE Std 1284-1994\fR