xref: /netbsd-src/share/man/man4/irframe.4 (revision 3d9a1fa87fc18e9ef566ef1d490b06ea414d10dc)
1.\" $NetBSD: irframe.4,v 1.14 2013/05/28 12:24:24 kiyohara 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 udsir?"
39.Cd "irframe* at uirda?"
40.Cd "irframe* at ustir?"
41.Cd "pseudo-device irframetty"
42.Pp
43.In dev/irdaio.h
44.Sh DESCRIPTION
45The
46.Nm
47driver provides support for IrDA frame level transmission.
48It does not contain the IrDA protocol stack per se, but the stack
49can be built on top of the
50.Nm
51driver.
52.Pp
53Access to frames is via the
54.Xr read 2
55and
56.Xr write 2
57system calls.  Each write constitutes one frame, and each read yields one frame.
58The
59.Xr poll 2
60system call can be used to check for availability of frames.
61There are also a number of
62.Xr ioctl 2
63calls to manipulate the device:
64.Bl -tag -width xxxxxx
65.It Dv IRDA_RESET_PARAMS
66Reset the parameters set by
67.Dv IRDA_SET_PARAMS .
68.It Dv IRDA_SET_PARAMS Fa "(struct irda_params)"
69Set the speed, extra beginning of frame bytes, and maximum frame size.
70.It Dv IRDA_GET_SPEEDMASK Fa (int)
71Get the set of allowable speeds.
72.It Dv IRDA_GET_TURNAROUNDMASK Fa (int)
73Get the set of allowable turn around times.
74.El
75.Sh SEE ALSO
76.Xr cir 4 ,
77.Xr irframetty 4 ,
78.Xr oboe 4 ,
79.Xr uirda 4 ,
80.Xr ustir 4
81.\" .Xr smccir 4 ,
82.\" .Xr ircomm 8 ,
83.\" .Xr irobex 8
84.Pp
85comms/birda package
86.Sh HISTORY
87The
88.Nm
89driver
90appeared in
91.Nx 1.6 .
92