Blame doc/ieee1284_open.3

Packit d36e9b
.\"     Title: ieee1284_open
Packit d36e9b
.\"    Author: Tim Waugh <twaugh@redhat.com>
Packit d36e9b
.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
Packit d36e9b
.\"      Date: 09/18/2007
Packit d36e9b
.\"    Manual: Functions
Packit d36e9b
.\"    Source: 
Packit d36e9b
.\"
Packit d36e9b
.TH "IEEE1284_OPEN" "3" "09/18/2007" "" "Functions"
Packit d36e9b
.\" disable hyphenation
Packit d36e9b
.nh
Packit d36e9b
.\" disable justification (adjust text to left margin only)
Packit d36e9b
.ad l
Packit d36e9b
.SH "NAME"
Packit d36e9b
ieee1284_open \- open a port
Packit d36e9b
.SH "SYNOPSIS"
Packit d36e9b
.sp
Packit d36e9b
.ft B
Packit d36e9b
.nf
Packit d36e9b
#include <ieee1284.h>
Packit d36e9b
.fi
Packit d36e9b
.ft
Packit d36e9b
.HP 18
Packit d36e9b
.BI "int ieee1284_open(struct\ parport\ *" "port" ", int\ " "flags" ", int\ *" "capabilities" ");"
Packit d36e9b
.SH "DESCRIPTION"
Packit d36e9b
.PP
Packit d36e9b
In order to begin using a port it must be opened. Any initial set\-up of the port is done at this stage. When an open port is no longer needed it should be closed with
Packit d36e9b
\fBieee1284_close\fR(3).
Packit d36e9b
.PP
Packit d36e9b
The possible
Packit d36e9b
\fIflags\fR
Packit d36e9b
are:
Packit d36e9b
.PP
Packit d36e9b
\fBF1284_EXCL\fR
Packit d36e9b
.RS 4
Packit d36e9b
This device cannot share the port with any other device. If this is the case it must be declared at this stage, so that other drivers trying to access the port know not to bother; otherwise they will wait until this driver releases the port, i.e. never.
Packit d36e9b
.sp
Packit d36e9b
The iopl/dev\-port access methods don't support this yet, but the ppdev ones do.
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
If
Packit d36e9b
\fIcapabilities\fR
Packit d36e9b
is not
Packit d36e9b
\fBNULL\fR
Packit d36e9b
it must point to storage for an
Packit d36e9b
\fBint\fR, which will be treated as a set of flags, one per bit, which the library sets or clears as appropriate. If a capability is present it will be used when asked for. They are:
Packit d36e9b
.PP
Packit d36e9b
\fBCAP1284_RAW\fR
Packit d36e9b
.RS 4
Packit d36e9b
Pin\-level access is available. If this capability is present then the following functions are effective:
Packit d36e9b
\fBieee1284_write_data\fR,
Packit d36e9b
\fBieee1284_read_status\fR,
Packit d36e9b
\fBieee1284_wait_status\fR,
Packit d36e9b
\fBieee1284_write_control\fR,
Packit d36e9b
\fBieee1284_read_control\fR,
Packit d36e9b
\fBieee1284_frob_control\fR.
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBCAP1284_NIBBLE\fR
Packit d36e9b
.RS 4
Packit d36e9b
There is an implementation of nibble mode for this port.
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBCAP1284_BYTE\fR
Packit d36e9b
.RS 4
Packit d36e9b
There is an implementation of byte mode for this port.
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBCAP1284_COMPAT\fR
Packit d36e9b
.RS 4
Packit d36e9b
There is an implementation of compatibility mode for this port.
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBCAP1284_ECP\fR
Packit d36e9b
.RS 4
Packit d36e9b
There is a hardware implementation of ECP mode for this port.
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBCAP1284_ECPRLE\fR
Packit d36e9b
.RS 4
Packit d36e9b
There is an RLE\-aware implementation of ECP mode for this port (the
Packit d36e9b
\fBF1284_RLE\fR
Packit d36e9b
flag is recognised by the ECP transfer functions).
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBCAP1284_ECPSWE\fR
Packit d36e9b
.RS 4
Packit d36e9b
There is a software implementation of ECP mode for this port.
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBCAP1284_BECP\fR
Packit d36e9b
.RS 4
Packit d36e9b
There is an implementation of bounded ECP mode for this port.
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBCAP1284_EPP\fR
Packit d36e9b
.RS 4
Packit d36e9b
There is a hardware implementation of EPP mode for this port.
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBCAP1284_EPPSWE\fR
Packit d36e9b
.RS 4
Packit d36e9b
There is a software implementation of EPP mode for this port.
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBCAP1284_IRQ\fR
Packit d36e9b
.RS 4
Packit d36e9b
An interrupt line is configured for this port and interrupt notifications can be received using
Packit d36e9b
\fBieee1284_get_irq_fd\fR(3).
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBCAP1284_DMA\fR
Packit d36e9b
.RS 4
Packit d36e9b
A DMA channel is configured for this port.
Packit d36e9b
.RE
Packit d36e9b
.SH "RETURN VALUE"
Packit d36e9b
.PP
Packit d36e9b
\fBE1284_OK\fR
Packit d36e9b
.RS 4
Packit d36e9b
The port is now opened.
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBE1284_INIT\fR
Packit d36e9b
.RS 4
Packit d36e9b
There was a problem during port initialization. This could be because another driver has opened the port exclusively, or some other reason.
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBE1284_NOMEM\fR
Packit d36e9b
.RS 4
Packit d36e9b
There is not enough memory.
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBE1284_NOTAVAIL\fR
Packit d36e9b
.RS 4
Packit d36e9b
One or more of the supplied flags is not supported by this type of port.
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBE1284_INVALIDPORT\fR
Packit d36e9b
.RS 4
Packit d36e9b
The
Packit d36e9b
\fIport\fR
Packit d36e9b
parameter is invalid (for instance, the
Packit d36e9b
\fIport\fR
Packit d36e9b
may already be open).
Packit d36e9b
.RE
Packit d36e9b
.PP
Packit d36e9b
\fBE1284_SYS\fR
Packit d36e9b
.RS 4
Packit d36e9b
There was a problem at the operating system level. The global variable
Packit d36e9b
\fIerrno\fR
Packit d36e9b
has been set appropriately.
Packit d36e9b
.RE
Packit d36e9b
.SH "SEE ALSO"
Packit d36e9b
.PP
Packit d36e9b
\fBieee1284_close\fR(3)
Packit d36e9b
.SH "AUTHOR"
Packit d36e9b
.PP
Packit d36e9b
\fBTim Waugh\fR <\&twaugh@redhat.com\&>
Packit d36e9b
.sp -1n
Packit d36e9b
.IP "" 4
Packit d36e9b
Author.
Packit d36e9b
.SH "COPYRIGHT"
Packit d36e9b
Copyright \(co 2001\-2003 Tim Waugh
Packit d36e9b
.br
Packit d36e9b