Staging: frontier: Updated documentation

Signed-off-by: David Täht <d@teklibre.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
This commit is contained in:
David Täht 2009-01-20 08:33:23 -06:00 committed by Greg Kroah-Hartman
parent 7f84642b2f
commit b3bc12dac7

View file

@ -1,28 +1,47 @@
This directory contains the USB Tranzport and Alphatrack Kernel drivers for Linux. This directory contains the Linux USB Tranzport and Alphatrack Kernel drivers.
At present the tranzport does reads/writes of 8 byte cmds to /dev/tranzport0 to control See http://www.frontierdesign.com for details on these devices.
the lights and screen and wheel
At present the alphatrack accepts reads/writes of 12 byte cmds to /dev/tranzport0 to control Userspace test code is available from
the lights and screen and fader.
Both drivers also have some sysfs hooks that are non-functional at the moment. git://toutatis.isc.org/home/d/src/git/frontier.git
The API is currently closely tied to the ardour revision and WILL change. At present the tranzport does reads/writes of 8 byte cmds to
/dev/tranzport0 to control the lights, screen, and wheel.
A sysfs interface is PERFECT for simple userspace apps to do fun things with the At present the alphatrack accepts reads/writes of 12 byte cmds to
lights and screen. It's fairly lousy for handling input events and very lousy /dev/tranzport0 to control the lights, screen, fader and touchpad.
for watching the state of the shuttle wheel.
A linux input events interface is great for the input events and shuttle wheel. It's The tranzport driver provides a rudimentary sysfs interface for the status of
theoretically OK on LEDs. A Fader can be mapped to an absolute mouse device. the device and a writable parameter for turning wheel compression on and off.
But there is no LCD support at all.
In the end this is going to be driven by a midi layer, which handles all those The API is nothing more than the USB commands issued to the device. Why?
cases via a defined API, but - among other things - is slow, doesn't do
flow control, and is a LOT of extra work. Frankly, I'd like to keep the The control wheel/fader can generate events far too quickly for
a typical userspace application to keep up with them via libusb. Input
needs to be 100% accurate and fast in order for the alphatrack or tranzport
to be useful.
UIO would be useful except that usb disconnect events need
to be handled correctly.
A sysfs interface is perfect for simple userspace apps to do fun things with
the lights and screen. But it's fairly lousy for handling input events and
very lousy for watching the state of the shuttle wheel.
A linux input events interface is great for the input events and shuttle wheel.
* It's theoretically OK on LEDs.
* A fader can be mapped to an absolute mouse device.
* But there is no LCD support at all, or fader feedback support in that API
So, thus, these stubby drivers exist.
In the end this could be driven by a midi layer, which handles all those
cases via a well defined API, but - among other things - is slow, doesn't do
flow control, and is a LOT of extra work, none of which is required at
the kernel level (probably). Frankly, I'd like to keep the
core driver simple because the only realtime work really required is core driver simple because the only realtime work really required is
the bottom half interrupt handler and the output overlapping. the bottom half interrupt handler and the output overlapping.
Exposing some sort of clean aio api to userspace would be perfect. What that Exposing some sort of clean api to userspace would be perfect. What that
API looks like? Gah. beats me. API looks like? Gah. beats me.