share/man/man4/urio.4

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