xref: /freebsd/share/man/man4/urio.4 (revision 8e648814b040d481f0429a2675e62af92b23bdd0)
1.\" Copyright (c) 2000 Dirk-Willem van Gulik <dirkx@webweaving.org>
2.\" 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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd November 22, 2006
28.Dt URIO 4
29.Os
30.Sh NAME
31.Nm urio
32.Nd "USB driver for the Rio MP3 players"
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following line in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device urio"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45urio_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50driver provides support for Rio MP3 players from Diamond MultiMedia
51which attaches to the USB port.
52The
53.Nm
54device must be configured in the kernel, along with
55.Em usb
56and one of the
57.Em uhci
58or
59.Em ohci
60controllers.
61.Pp
62Subsequently, the
63.Pa /dev/urio0
64device can be used by the Rio userland applications.
65.Sh HARDWARE
66The following devices are supported by the
67.Nm
68driver:
69.Pp
70.Bl -bullet -compact
71.It
72Diamond MultiMedia Rio 500
73.It
74Diamond MultiMedia Rio 600
75.It
76Diamond MultiMedia Rio 800
77.El
78.Sh FILES
79.Bl -tag -width /dev/ums0 -compact
80.It Pa /dev/urio0
81blocking device node
82.El
83.Sh EXAMPLES
84The following line in the kernel configuration file adds the
85.Nm
86driver to the kernel:
87.Dl device urio
88.Pp
89To download a song over the
90.Tn USB
91connection into the Rio using the
92.Xr rio_add_song 1
93utility (see the
94.Sx SEE ALSO
95section):
96.Dl rio_add_song /usr/local/MP3/TracyChapman/02-Fast-Car.mp3
97.Sh SEE ALSO
98.Xr ohci 4 ,
99.Xr uhci 4 ,
100.Xr usb 4
101.Rs
102.%T The Rio 500 SourceForge Project Web Page
103.%U http://rio500.sourceforge.net/
104.Re
105.Pp
106The Rio500 tools from SourceForge
107are the actual userland tools used to download,
108format or rename songs on players.
109When compiling these tools,
110the following pre-build configuration command will ensure that
111.Pa rio_usb.h
112is available in the include path
113and that the device used is
114.Pa /dev/urio0 :
115.Bd -literal -offset indent
116CFLAGS="-I/usr/include/dev/usb" ./configure \\
117    --with-devicepath='/dev' --with-deviceentry='urio0'
118.Ed
119.\".Sh HISTORY
120.Sh AUTHORS
121.An -nosplit
122The
123.Nm
124driver was written by
125.An Iwasa Kazmi Aq Mt kzmi@ca2.so-net.ne.jp
126for
127.Fx .
128.Pp
129This manual page was written by
130.An Dirk-Willem van Gulik Aq Mt dirkx@webweaving.org .
131