share/man/man4/ppi.4

   1 .\" Copyright (c) 1997
   2 .\"      Michael Smith
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS''
  15 .\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
  18 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24 .\" POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/share/man/man4/ppi.4,v 1.4.2.7 2001/12/17 11:30:12 ru Exp $
  27 .\" $DragonFly: src/share/man/man4/ppi.4,v 1.4 2007/12/15 10:33:38 swildner Exp $
  28 .\"
  29 .Dd January 2, 1998
  30 .Dt PPI 4
  31 .Os
  32 .Sh NAME
  33 .Nm ppi
  34 .Nd "user-space interface to ppbus parallel 'geek' port"
  35 .Sh SYNOPSIS
  36 .Cd "device ppi"
  37 .Pp
  38 Minor numbering:  Unit numbers correspond directly to ppbus numbers.
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 driver provides a convenient means for user applications to manipulate the
  43 state of the parallel port, enabling easy low-speed I/O operations without
  44 the security problems inherent with the use of the
  45 .Pa /dev/io
  46 interface.
  47 .Sh PROGRAMMING INTERFACE
  48 .In dev/misc/ppi/ppi.h
  49 .In bus/ppbus/ppbconf.h
  50 .Pp
  51 All I/O on the
  52 .Nm
  53 interface is performed using
  54 .Fn ioctl
  55 calls.  Each command takes a single
  56 .Ft u_int8_t
  57 argument, transferring one byte of data.  The following commands are
  58 available:
  59 .Bl -tag -width indent
  60 .It Dv PPIGDATA , PPISDATA
  61 Get and set the contents of the data register.
  62 .It Dv PPIGSTATUS , PPISSTATUS
  63 Get and set the contents of the status register.
  64 .It Dv PPIGCTRL , PPISCTRL
  65 Get and set the contents of the control register.
  66 The following defines correspond to bits in this register.  Setting
  67 a bit in the control register drives the corresponding output low.
  68 .Bl -tag -width indent -compact
  69 .It Dv STROBE
  70 .It Dv AUTOFEED
  71 .It Dv nINIT
  72 .It Dv SELECTIN
  73 .It Dv PCD
  74 .El
  75 .It Dv PPIGEPPA , PPISEPPA
  76 Get and set the address bits of the EPP control register.
  77 .It Dv PPIGEPPD , PPISEPPD
  78 Get and set the data bits of the EPP control register.
  79 .It Dv PPIGECR , PPISECR
  80 Get and set the contents of the ECP control register.
  81 .It Dv PPIGFIFO , PPISFIFO
  82 Read and write the ECP FIFO (8-bit operations only).
  83 .El
  84 .Sh EXAMPLES
  85 To present the value 0x5a to the data port, drive STROBE low and then high
  86 again, the following code fragment can be used:
  87 .Bd -literal -compact
  88
  89         int             fd;
  90         u_int8_t        val;
  91
  92         val = 0x5a;
  93         ioctl(fd, PPISDATA, &val);
  94         ioctl(fd, PPIGCTRL, &val);
  95         val |= STROBE;
  96         ioctl(fd, PPISCTRL, &val);
  97         val &= ~STROBE;
  98         ioctl(fd, PPISCTRL, &val);
  99
 100 .Ed
 101 .Sh BUGS
 102 The inverse sense of signals is confusing.
 103 .Pp
 104 The
 105 .Fn ioctl
 106 interface is slow, and there is no way (yet) to chain multiple operations together.
 107 .Pp
 108 The headers required for user applications are not installed as part of the
 109 standard system.