xref: /netbsd-src/share/man/man4/irframe.4 (revision 3d9a1fa87fc18e9ef566ef1d490b06ea414d10dc)
1*3d9a1fa8Skiyohara.\" $NetBSD: irframe.4,v 1.14 2013/05/28 12:24:24 kiyohara Exp $
202b1fff1Saugustss.\"
302b1fff1Saugustss.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
402b1fff1Saugustss.\" All rights reserved.
502b1fff1Saugustss.\"
602b1fff1Saugustss.\" This code is derived from software contributed to The NetBSD Foundation
702b1fff1Saugustss.\" by Lennart Augustsson.
802b1fff1Saugustss.\"
902b1fff1Saugustss.\" Redistribution and use in source and binary forms, with or without
1002b1fff1Saugustss.\" modification, are permitted provided that the following conditions
1102b1fff1Saugustss.\" are met:
1202b1fff1Saugustss.\" 1. Redistributions of source code must retain the above copyright
1302b1fff1Saugustss.\"    notice, this list of conditions and the following disclaimer.
1402b1fff1Saugustss.\" 2. Redistributions in binary form must reproduce the above copyright
1502b1fff1Saugustss.\"    notice, this list of conditions and the following disclaimer in the
1602b1fff1Saugustss.\"    documentation and/or other materials provided with the distribution.
1702b1fff1Saugustss.\"
1802b1fff1Saugustss.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
1902b1fff1Saugustss.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
2002b1fff1Saugustss.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
2102b1fff1Saugustss.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
2202b1fff1Saugustss.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
2302b1fff1Saugustss.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
2402b1fff1Saugustss.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
2502b1fff1Saugustss.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
2602b1fff1Saugustss.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
2702b1fff1Saugustss.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
2802b1fff1Saugustss.\" POSSIBILITY OF SUCH DAMAGE.
2902b1fff1Saugustss.\"
3002b1fff1Saugustss.Dd December 2, 2001
3102b1fff1Saugustss.Dt IRFRAME 4
3202b1fff1Saugustss.Os
3302b1fff1Saugustss.Sh NAME
3402b1fff1Saugustss.Nm irframe
3502b1fff1Saugustss.Nd IrDA frame level driver
3602b1fff1Saugustss.Sh SYNOPSIS
37d0b41e02Saugustss.Cd "irframe* at oboe?"
38*3d9a1fa8Skiyohara.Cd "irframe* at udsir?"
39e32c80d6Saugustss.Cd "irframe* at uirda?"
40929c2714Saugustss.Cd "irframe* at ustir?"
413050e58cSaugustss.Cd "pseudo-device irframetty"
4256c82209Saugustss.Pp
43d173e865Swiz.In dev/irdaio.h
4402b1fff1Saugustss.Sh DESCRIPTION
4502b1fff1SaugustssThe
4602b1fff1Saugustss.Nm
4702b1fff1Saugustssdriver provides support for IrDA frame level transmission.
4802b1fff1SaugustssIt does not contain the IrDA protocol stack per se, but the stack
4902b1fff1Saugustsscan be built on top of the
5002b1fff1Saugustss.Nm
5102b1fff1Saugustssdriver.
5256c82209Saugustss.Pp
5356c82209SaugustssAccess to frames is via the
5456c82209Saugustss.Xr read 2
5556c82209Saugustssand
5656c82209Saugustss.Xr write 2
5756c82209Saugustsssystem calls.  Each write constitutes one frame, and each read yields one frame.
5856c82209SaugustssThe
5956c82209Saugustss.Xr poll 2
6056c82209Saugustsssystem call can be used to check for availability of frames.
6156c82209SaugustssThere are also a number of
6256c82209Saugustss.Xr ioctl 2
6356c82209Saugustsscalls to manipulate the device:
6456c82209Saugustss.Bl -tag -width xxxxxx
6556c82209Saugustss.It Dv IRDA_RESET_PARAMS
6656c82209SaugustssReset the parameters set by
6756c82209Saugustss.Dv IRDA_SET_PARAMS .
6856c82209Saugustss.It Dv IRDA_SET_PARAMS Fa "(struct irda_params)"
6956c82209SaugustssSet the speed, extra beginning of frame bytes, and maximum frame size.
7056c82209Saugustss.It Dv IRDA_GET_SPEEDMASK Fa (int)
7156c82209SaugustssGet the set of allowable speeds.
7256c82209Saugustss.It Dv IRDA_GET_TURNAROUNDMASK Fa (int)
7356c82209SaugustssGet the set of allowable turn around times.
7456c82209Saugustss.El
7502b1fff1Saugustss.Sh SEE ALSO
7602b1fff1Saugustss.Xr cir 4 ,
773050e58cSaugustss.Xr irframetty 4 ,
78e32c80d6Saugustss.Xr oboe 4 ,
79c80596d5Swiz.Xr uirda 4 ,
80929c2714Saugustss.Xr ustir 4
81d0b41e02Saugustss.\" .Xr smccir 4 ,
82b68a5bd5Swiz.\" .Xr ircomm 8 ,
83b68a5bd5Swiz.\" .Xr irobex 8
84862dc79dSjoerg.Pp
85dc53d004Saugustsscomms/birda package
8602b1fff1Saugustss.Sh HISTORY
8702b1fff1SaugustssThe
8802b1fff1Saugustss.Nm
8902b1fff1Saugustssdriver
9002b1fff1Saugustssappeared in
9102b1fff1Saugustss.Nx 1.6 .
92