xref: /netbsd-src/share/man/man4/irframe.4 (revision 5e4c038a45edbc7d63b7c2daa76e29f88b64a4e3)
1.\" $NetBSD: irframe.4,v 1.10 2002/02/13 08:17:39 ross 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.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd December 2, 2001
38.Dt IRFRAME 4
39.Os
40.Sh NAME
41.Nm irframe
42.Nd IrDA frame level driver
43.Sh SYNOPSIS
44.Cd "irframe* at oboe?"
45.Cd "irframe* at uirda?"
46.Cd "irframe* at ustir?"
47.Cd "pseudo-device irframetty"
48.Pp
49.Cd "#include \*[Lt]dev/irdaio.h\*[Gt]"
50.Sh DESCRIPTION
51The
52.Nm
53driver provides support for IrDA frame level transmission.
54It does not contain the IrDA protocol stack per se, but the stack
55can be built on top of the
56.Nm
57driver.
58.Pp
59Access to frames is via the
60.Xr read 2
61and
62.Xr write 2
63system calls.  Each write constitutes one frame, and each read yields one frame.
64The
65.Xr poll 2
66system call can be used to check for availability of frames.
67There are also a number of
68.Xr ioctl 2
69calls to manipulate the device:
70.Bl -tag -width xxxxxx
71.It Dv IRDA_RESET_PARAMS
72Reset the parameters set by
73.Dv IRDA_SET_PARAMS .
74.It Dv IRDA_SET_PARAMS Fa "(struct irda_params)"
75Set the speed, extra beginning of frame bytes, and maximum frame size.
76.It Dv IRDA_GET_SPEEDMASK Fa (int)
77Get the set of allowable speeds.
78.It Dv IRDA_GET_TURNAROUNDMASK Fa (int)
79Get the set of allowable turn around times.
80.El
81.Sh SEE ALSO
82.Xr cir 4 ,
83.Xr irframetty 4 ,
84.Xr oboe 4 ,
85.Xr uirda 4 ,
86.Xr ustir 4
87.\" .Xr smccir 4 ,
88.\" .Xr ircomm 8 ,
89.\" .Xr irobex 8
90.br
91comms/birda package
92.Sh HISTORY
93The
94.Nm
95driver
96appeared in
97.Nx 1.6 .
98