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$
  32 .\"
  33 .Dd September 26, 2004
  34 .Dt URIO 4
  35 .Os
  36 .Sh NAME
  37 .Nm urio
  38 .Nd "USB driver for the Rio MP3 players"
  39 .Sh SYNOPSIS
  40 .Cd "device urio0"
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 driver provides support for Rio MP3 players 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 Rio userland applications.
  59 .Sh HARDWARE
  60 The following devices are supported by the
  61 .Nm
  62 driver:
  63 .Pp
  64 .Bl -bullet -compact
  65 .It
  66 Diamond MultiMedia Rio 500
  67 .It
  68 Diamond MultiMedia Rio 600
  69 .It
  70 Diamond MultiMedia Rio 800
  71 .El
  72 .Sh FILES
  73 .Bl -tag -width /dev/ums0 -compact
  74 .It Pa /dev/urio0
  75 blocking device node
  76 .El
  77 .Sh EXAMPLES
  78 The following line in the kernel configuration file adds the
  79 .Nm
  80 driver to the kernel:
  81 .Dl device urio
  82 .Pp
  83 To download a song over the
  84 .Tn USB
  85 connection into the Rio using the
  86 .Xr rio_add_song 1
  87 utility (see the
  88 .Sx SEE ALSO
  89 section):
  90 .Dl rio_add_song /usr/local/MP3/TracyChapman/02-Fast-Car.mp3
  91 .Sh SEE ALSO
  92 .Xr ohci 4 ,
  93 .Xr uhci 4 ,
  94 .Xr usb 4
  95 .Rs
  96 .%T The Rio 500 SourceForge Project Web Page
  97 .%O http://rio500.sourceforge.net/
  98 .Re
  99 .Pp
 100 The Rio500 tools from SourceForge
 101 are the actual userland tools used to download,
 102 format or rename songs on players.
 103 When compiling these tools,
 104 the following pre-build configuration command will ensure that
 105 .Pa rio_usb.h
 106 is available in the include path
 107 and that the device used is
 108 .Pa /dev/urio0 :
 109 .Bd -literal -offset indent
 110 CFLAGS="-I/usr/include/dev/usb" ./configure \\
 111     --with-devicepath='/dev' --with-deviceentry='urio0'
 112 .Ed
 113 .\".Sh HISTORY
 114 .Sh AUTHORS
 115 .An -nosplit
 116 The
 117 .Nm
 118 driver was written by
 119 .An Iwasa Kazmi Aq kzmi@ca2.so-net.ne.jp
 120 for
 121 .Fx .
 122 .Pp
 123 This manual page was written by
 124 .An Dirk-Willem van Gulik Aq dirkx@webweaving.org .