xref: /netbsd-src/share/man/man4/irframetty.4 (revision 11a6dbe72840351315e0652b2fc6663628c84cad)
1.\" $NetBSD: irframetty.4,v 1.6 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 3, 2001
31.Dt IRFRAMETTY 4
32.Os
33.Sh NAME
34.Nm irframetty
35.Nd IrDA frame over serial line driver
36.Sh SYNOPSIS
37.Cd "pseudo-device irframetty"
38.Pp
39.In dev/irdaio.h
40.Sh DESCRIPTION
41The
42.Nm
43driver provides a
44.Xr tty 4
45line discipline to send and receive IrDA frames over a serial line
46via an IrDA dongle.
47.Pp
48Access to the frames is via the
49.Xr irframe 4
50driver.
51.Pp
52Different dongles require different handling.
53The connected dongle type can be set with
54.Xr ioctl 2
55calls:
56.Bl -tag -width xxxxxx
57.It Dv IRFRAMETTY_SET_DONGLE Fa (int)
58Set the dongle type.  See the include file for possible dongles.
59.It Dv IRFRAMETTY_GET_DONGLE Fa (int)
60Get the dongle type.
61.It Dv IRFRAMETTY_GET_DEVICE Fa (int)
62Get the number of the
63.Xr irframe 4
64device that must be used to access the frames.
65.El
66.Sh SEE ALSO
67.Xr irframe 4 ,
68.Xr irdaattach 8
69.Sh HISTORY
70The
71.Nm
72driver
73appeared in
74.Nx 1.6 .
75