kernel/usb4bsd: Bring in the axge(4) ethernet driver.
[dragonfly.git] / share / man / man4 / urio.4
1 .\" Copyright (c) 2000 Dirk-Willem van Gulik
2 .\"     <dirkx@webweaving.org>. All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by Bill Paul.
15 .\" 4. Neither the name of the author nor the names of any co-contributors
16 .\"    may be used to endorse or promote products derived from this software
17 .\"   without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY NICK HIBMA AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL NICK HIBMA OR THE VOICES IN HIS HEAD
23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29 .\" THE POSSIBILITY OF SUCH DAMAGE.
30 .\"
31 .\"     $FreeBSD: src/share/man/man4/urio.4,v 1.5.2.3 2001/08/17 13:08:39 ru Exp $
32 .\"
33 .Dd August 6, 2009
34 .Dt URIO 4
35 .Os
36 .Sh NAME
37 .Nm urio
38 .Nd USB driver for the Rio500 MP3 player
39 .Sh SYNOPSIS
40 .Cd "device urio0"
41 .Sh DESCRIPTION
42 The
43 .Nm
44 driver provides support for the Rio500 MP3 player from Diamond MultiMedia
45 which attaches to the USB port.
46 The
47 .Nm
48 device must be configured in the kernel, along with
49 .Em usb
50 and one of the
51 .Em uhci
52 or
53 .Em ohci
54 controllers.
55 .Pp
56 Subsequently, the
57 .Pa /dev/urio0
58 device can be used by the Rio500 userland applications.
59 .Sh FILES
60 .Bl -tag -width /dev/ums0 -compact
61 .It Pa /dev/urio0
62 blocking device node
63 .El
64 .Sh EXAMPLES
65 The following line in the kernel configuration file adds the
66 .Nm
67 driver to the kernel:
68 .Dl device urio
69 .Pp
70 To download a song over the
71 .Tn USB
72 connection into the Rio500 using the
73 .Xr rio_add_song 1
74 utility (see the
75 .Sx SEE ALSO
76 section):
77 .Dl rio_add_song /usr/local/MP3/TraceyChapman/02-Fast-Car.mp3
78 .Sh SEE ALSO
79 .Xr ohci 4 ,
80 .Xr uhci 4 ,
81 .Xr usb 4
82 .Rs
83 .%T The Rio 500 SourceForge Project Web Page
84 .%O http://rio500.sourceforge.net/
85 .Re
86 .Pp
87 The Rio500 tools from SourceForge
88 are the actual userland tools used to download,
89 format or rename songs on players.
90 When compiling these tools,
91 the following pre-build configuration command will ensure that
92 .Pa rio_usb.h
93 is available in the include path
94 and that the device used is
95 .Pa /dev/urio0 :
96 .Bd -literal -offset indent
97 CFLAGS="-I/usr/include/dev/usb" ./configure \\
98     --with-devicepath='/dev' --with-deviceentry='urio0'
99 .Ed
100 .Sh AUTHORS
101 .An -nosplit
102 The
103 .Nm
104 driver was written by
105 .An Iwasa Kazmi Aq Mt kzmi@ca2.so-net.ne.jp
106 for
107 .Fx .
108 .Pp
109 This manual page was written by
110 .An Dirk-Willem van Gulik Aq Mt dirkx@webweaving.org .