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 .\"     $DragonFly: src/share/man/man4/urio.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
  33 .\"
  34 .Dd March 5, 2000
  35 .Dt URIO 4
  36 .Os
  37 .Sh NAME
  38 .Nm urio
  39 .Nd USB driver for the Rio500 MP3 player
  40 .Sh SYNOPSIS
  41 .Cd "device urio0"
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 driver provides support for the Rio500 MP3 player from Diamond MultiMedia
  46 which attaches to the USB port.
  47 The
  48 .Nm
  49 device must be configured in the kernel, along with
  50 .Em usb
  51 and one of the
  52 .Em uhci
  53 or
  54 .Em ohci
  55 controllers.
  56 .Pp
  57 Subsequently, the
  58 .Pa /dev/urio0
  59 device can be used by the Rio500 userland applications.
  60 .Sh FILES
  61 .Bl -tag -width /dev/ums0 -compact
  62 .It Pa /dev/urio0
  63 blocking device node
  64 .El
  65 .Sh EXAMPLES
  66 The following line in the kernel configuration file adds the
  67 .Nm
  68 driver to the kernel:
  69 .Dl device urio
  70 .Pp
  71 The following commands create the device node in the
  72 .Pa /dev
  73 directory:
  74 .Dl cd /dev
  75 .Dl sh MAKEDEV urio0
  76 .Pp
  77 Finally, to download a song over the
  78 .Tn USB
  79 connection into the Rio500 using the
  80 .Xr rio_add_song 1
  81 utility (see the
  82 .Sx SEE ALSO
  83 section):
  84 .Dl rio_add_song /usr/local/MP3/TraceyChapman/02-Fast-Car.mp3
  85 .Sh SEE ALSO
  86 .Xr ohci 4 ,
  87 .Xr uhci 4 ,
  88 .Xr usb 4
  89 .Rs
  90 .%T The Rio 500 SourceForge Project Web Page
  91 .%O http://rio500.sourceforge.net/
  92 .Re
  93 .Pp
  94 The Rio500 tools from SourceForge
  95 are the actual userland tools used to download,
  96 format or rename songs on players.
  97 When compiling these tools,
  98 the following pre-build configuration command will ensure that
  99 .Pa rio_usb.h
 100 is available in the include path
 101 and that the device used is
 102 .Pa /dev/urio0 :
 103 .Bd -literal -offset indent
 104 CFLAGS="-I/usr/include/dev/usb" ./configure \\
 105     --with-devicepath='/dev' --with-deviceentry='urio0'
 106 .Ed
 107 .\".Sh HISTORY
 108 .Sh AUTHORS
 109 .An -nosplit
 110 The
 111 .Nm
 112 driver was written by
 113 .An Iwasa Kazmi Aq kzmi@ca2.so-net.ne.jp
 114 for
 115 .Fx .
 116 .Pp
 117 This manual page was written by
 118 .An Dirk-Willem van Gulik Aq dirkx@webweaving.org .