share/man/man4/irframe.4

   1 .\" $NetBSD: irframe.4,v 1.12 2008/04/30 13:10:54 martin Exp $
   2 .\"
   3 .\" Copyright (c) 2001 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Lennart Augustsson.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd December 2, 2001
  31 .Dt IRFRAME 4
  32 .Os
  33 .Sh NAME
  34 .Nm irframe
  35 .Nd IrDA frame level driver
  36 .Sh SYNOPSIS
  37 .Cd "irframe* at oboe?"
  38 .Cd "irframe* at uirda?"
  39 .Cd "irframe* at ustir?"
  40 .Cd "pseudo-device irframetty"
  41 .Pp
  42 .In dev/irdaio.h
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 driver provides support for IrDA frame level transmission.
  47 It does not contain the IrDA protocol stack per se, but the stack
  48 can be built on top of the
  49 .Nm
  50 driver.
  51 .Pp
  52 Access to frames is via the
  53 .Xr read 2
  54 and
  55 .Xr write 2
  56 system calls.  Each write constitutes one frame, and each read yields one frame.
  57 The
  58 .Xr poll 2
  59 system call can be used to check for availability of frames.
  60 There are also a number of
  61 .Xr ioctl 2
  62 calls to manipulate the device:
  63 .Bl -tag -width xxxxxx
  64 .It Dv IRDA_RESET_PARAMS
  65 Reset the parameters set by
  66 .Dv IRDA_SET_PARAMS .
  67 .It Dv IRDA_SET_PARAMS Fa "(struct irda_params)"
  68 Set the speed, extra beginning of frame bytes, and maximum frame size.
  69 .It Dv IRDA_GET_SPEEDMASK Fa (int)
  70 Get the set of allowable speeds.
  71 .It Dv IRDA_GET_TURNAROUNDMASK Fa (int)
  72 Get the set of allowable turn around times.
  73 .El
  74 .Sh SEE ALSO
  75 .Xr cir 4 ,
  76 .Xr irframetty 4 ,
  77 .Xr oboe 4 ,
  78 .Xr uirda 4 ,
  79 .Xr ustir 4
  80 .\" .Xr smccir 4 ,
  81 .\" .Xr ircomm 8 ,
  82 .\" .Xr irobex 8
  83 .Pp
  84 comms/birda package
  85 .Sh HISTORY
  86 The
  87 .Nm
  88 driver
  89 appeared in
  90 .Nx 1.6 .