xref: /freebsd/share/man/man4/urio.4 (revision 2be1a816b9ff69588e55be0a84cbe2a31efc0f2f)
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$
32.\"
33.Dd November 22, 2006
34.Dt URIO 4
35.Os
36.Sh NAME
37.Nm urio
38.Nd "USB driver for the Rio MP3 players"
39.Sh SYNOPSIS
40To compile this driver into the kernel,
41place the following line in your
42kernel configuration file:
43.Bd -ragged -offset indent
44.Cd "device urio"
45.Ed
46.Pp
47Alternatively, to load the driver as a
48module at boot time, place the following line in
49.Xr loader.conf 5 :
50.Bd -literal -offset indent
51urio_load="YES"
52.Ed
53.Sh DESCRIPTION
54The
55.Nm
56driver provides support for Rio MP3 players from Diamond MultiMedia
57which attaches to the USB port.
58The
59.Nm
60device must be configured in the kernel, along with
61.Em usb
62and one of the
63.Em uhci
64or
65.Em ohci
66controllers.
67.Pp
68Subsequently, the
69.Pa /dev/urio0
70device can be used by the Rio userland applications.
71.Sh HARDWARE
72The following devices are supported by the
73.Nm
74driver:
75.Pp
76.Bl -bullet -compact
77.It
78Diamond MultiMedia Rio 500
79.It
80Diamond MultiMedia Rio 600
81.It
82Diamond MultiMedia Rio 800
83.El
84.Sh FILES
85.Bl -tag -width /dev/ums0 -compact
86.It Pa /dev/urio0
87blocking device node
88.El
89.Sh EXAMPLES
90The following line in the kernel configuration file adds the
91.Nm
92driver to the kernel:
93.Dl device urio
94.Pp
95To download a song over the
96.Tn USB
97connection into the Rio using the
98.Xr rio_add_song 1
99utility (see the
100.Sx SEE ALSO
101section):
102.Dl rio_add_song /usr/local/MP3/TracyChapman/02-Fast-Car.mp3
103.Sh SEE ALSO
104.Xr ohci 4 ,
105.Xr uhci 4 ,
106.Xr usb 4
107.Rs
108.%T The Rio 500 SourceForge Project Web Page
109.%O http://rio500.sourceforge.net/
110.Re
111.Pp
112The Rio500 tools from SourceForge
113are the actual userland tools used to download,
114format or rename songs on players.
115When compiling these tools,
116the following pre-build configuration command will ensure that
117.Pa rio_usb.h
118is available in the include path
119and that the device used is
120.Pa /dev/urio0 :
121.Bd -literal -offset indent
122CFLAGS="-I/usr/include/dev/usb" ./configure \\
123    --with-devicepath='/dev' --with-deviceentry='urio0'
124.Ed
125.\".Sh HISTORY
126.Sh AUTHORS
127.An -nosplit
128The
129.Nm
130driver was written by
131.An Iwasa Kazmi Aq kzmi@ca2.so-net.ne.jp
132for
133.Fx .
134.Pp
135This manual page was written by
136.An Dirk-Willem van Gulik Aq dirkx@webweaving.org .
137