Blame usx2yloader/README

Packit Service b98cfc
    USX2YLOADER - Second Phase Firmware loader for Tascam USX2Y USB soundcards
Packit Service b98cfc
	    2003-09-15 Karsten Wiese <annabellesgarden@yahoo.de>
Packit Service b98cfc
Packit Service b98cfc
Packit Service b98cfc
GENERAL
Packit Service b98cfc
=======
Packit Service b98cfc
Packit Service b98cfc
Usx2yloader is a helper program to load the 2nd Phase firmware binaries
Packit Service b98cfc
onto the Tascam USX2Y USB soundcards.
Packit Service b98cfc
It has proven to work so far for the US122, US224 and US428.
Packit Service b98cfc
The snd-usb-usx2y module requires this program.
Packit Service b98cfc
Packit Service b98cfc
Packit Service b98cfc
USX2Y initialisation outlined
Packit Service b98cfc
=============================
Packit Service b98cfc
Packit Service b98cfc
A.  Phase 1
Packit Service b98cfc
A.1.  USx2y is plugged to the PC and powered on.
Packit Service b98cfc
      This makes the kernel see a new USB-device with the Vendor/Product
Packit Service b98cfc
      ID 0x1604/0x8000 (US428), 0x1604/0x8004 (US224) or 0x1604/0x8006 
Packit Service b98cfc
      (US122).
Packit Service b98cfc
      The kernel reacts by starting the usb-hotplug script.
Packit Service b98cfc
A.2.  The usb-hotplug script starts the executable fxload,
Packit Service b98cfc
      which transfers the EZUSB firmware to the USx2y.
Packit Service b98cfc
A.3.  The USx2y disconnects itself from the USB-Bus and ... (see Phase 2).
Packit Service b98cfc
Packit Service b98cfc
B.  Phase 2
Packit Service b98cfc
B.1.  The USx2y reintroduces itself as USB-device with the Vendor/Product
Packit Service b98cfc
      ID 0x1604/0x8001 (US428), 0x1604/0x8005 (US224) or 0x1604/0x8007
Packit Service b98cfc
      (US122)
Packit Service b98cfc
      The kernel reacts by loading the module snd-usb-usx2y, if it is not
Packit Service b98cfc
      already loaded.
Packit Service b98cfc
B.2   The module snd-usb-usx2y "takes" the USx2y as its device and sets up
Packit Service b98cfc
      a "hardware dependent interface".
Packit Service b98cfc
      (The module doesn't create any pcm nor midi devices now.)
Packit Service b98cfc
B.3   Subsequently the kernel starts the usb-hotplug script, which launches
Packit Service b98cfc
      usx2yloader.
Packit Service b98cfc
B.4   usx2yloader transfers the 2nd Phase firmware binary to the USx2y by means
Packit Service b98cfc
      of the "hardware dependent interface". When this transfer finishes,
Packit Service b98cfc
      the snd-usb-usx2y module creates the pcm- and midi-devices.
Packit Service b98cfc
      Initialisation is complete.
Packit Service b98cfc
Packit Service b98cfc
Packit Service b98cfc
USAGE
Packit Service b98cfc
=====
Packit Service b98cfc
Packit Service b98cfc
When usx2yloader is invoked without options, it will probe all existing
Packit Service b98cfc
soundcards until a valid USX2Y-driver is found.  If a valid USX2Y-driver is
Packit Service b98cfc
found, usx2yloader reads the board type from the driver.  The corresponding
Packit Service b98cfc
firmware binaries are then read and transferred to the driver.
Packit Service b98cfc
Finally, usx2yloader initializes the PCM, MIDI and the mixer devices on the
Packit Service b98cfc
driver for making the soundcard full functional.
Packit Service b98cfc
Packit Service b98cfc
Instead of auto-probing, you can specify the card number or the hwdep
Packit Service b98cfc
device name or the usb device name via -c, -D or -u options, respectively.
Packit Service b98cfc
Packit Service b98cfc
	% usx2yloader -c 1
Packit Service b98cfc
	% usx2yloader -D hw:0
Packit Service b98cfc
	% usx2yloader -u /proc/bus/usb/001/003
Packit Service b98cfc
Packit Service b98cfc
For loading everything automatically in response to a hotplug event
Packit Service b98cfc
there are the hotplug script files
Packit Service b98cfc
 - tascam_fw.usermap
Packit Service b98cfc
 - tascam_fw
Packit Service b98cfc
 - tascam_fpga
Packit Service b98cfc
and the Firmwarefiles.
Packit Service b98cfc
You also need fxload and hotplug to be installed.
Packit Service b98cfc
Packit Service b98cfc
Packit Service b98cfc
FIRMWAREFILES
Packit Service b98cfc
=============
Packit Service b98cfc
Packit Service b98cfc
The firmware binaries are installed on /usr/share/alsa/firmware/usx2yloader
Packit Service b98cfc
(or /usr/local/share/alsa/firmware/usx2yloader, depending to the
Packit Service b98cfc
prefix option of configure).  There will be *.conf files, which
Packit Service b98cfc
define the dsp image files for each different card type.
Packit Service b98cfc
Packit Service b98cfc
Packit Service b98cfc
COPYRIGHT
Packit Service b98cfc
=========
Packit Service b98cfc
Packit Service b98cfc
Copyright (c) 2003 Karsten Wiese <annabellesgarden@yahoo.de>
Packit Service b98cfc
Distributable under GPL.
Packit Service b98cfc
Packit Service b98cfc
The firmware files included in alsa-firmware package are copyright
Packit Service b98cfc
by Tascam / TEAC Corporation.