[linux-2.6-block.git] / Documentation / fb / metronomefb.txt

			Metronomefb
			-----------
Maintained by Jaya Kumar <jayakumar.lkml.gmail.com>
Last revised: Mar 10, 2008

Metronomefb is a driver for the Metronome display controller. The controller
is from E-Ink Corporation. It is intended to be used to drive the E-Ink
Vizplex display media. E-Ink hosts some details of this controller and the
display media here http://www.e-ink.com/products/matrix/metronome.html .

Metronome is interfaced to the host CPU through the AMLCD interface. The
host CPU generates the control information and the image in a framebuffer
which is then delivered to the AMLCD interface by a host specific method.
The display and error status are each pulled through individual GPIOs.

Metronomefb is platform independent and depends on a board specific driver
to do all physical IO work. Currently, an example is implemented for the
PXA board used in the AM-200 EPD devkit. This example is am200epd.c

Metronomefb requires waveform information which is delivered via the AMLCD
interface to the metronome controller. The waveform information is expected to
be delivered from userspace via the firmware class interface. The waveform file
can be compressed as long as your udev or hotplug script is aware of the need
to uncompress it before delivering it. metronomefb will ask for metronome.wbf
which would typically go into /lib/firmware/metronome.wbf depending on your
udev/hotplug setup. I have only tested with a single waveform file which was
originally labeled 23P01201_60_WT0107_MTC. I do not know what it stands for.
Caution should be exercised when manipulating the waveform as there may be
a possibility that it could have some permanent effects on the display media.
I neither have access to nor know exactly what the waveform does in terms of
the physical media.

Metronomefb uses the deferred IO interface so that it can provide a memory
mappable frame buffer. It has been tested with tinyx (Xfbdev). It is known
to work at this time with xeyes, xclock, xloadimage, xpdf.
Commit	Line	Data
de7c6d15 JK	1	Metronomefb
	2	-----------
	3	Maintained by Jaya Kumar <jayakumar.lkml.gmail.com>
03c33a4f	4	Last revised: Mar 10, 2008
de7c6d15 JK	5
	6	Metronomefb is a driver for the Metronome display controller. The controller
	7	is from E-Ink Corporation. It is intended to be used to drive the E-Ink
	8	Vizplex display media. E-Ink hosts some details of this controller and the
	9	display media here http://www.e-ink.com/products/matrix/metronome.html .
	10
	11	Metronome is interfaced to the host CPU through the AMLCD interface. The
	12	host CPU generates the control information and the image in a framebuffer
	13	which is then delivered to the AMLCD interface by a host specific method.
03c33a4f	14	The display and error status are each pulled through individual GPIOs.
de7c6d15	15
03c33a4f JK	16	Metronomefb is platform independent and depends on a board specific driver
	17	to do all physical IO work. Currently, an example is implemented for the
	18	PXA board used in the AM-200 EPD devkit. This example is am200epd.c
de7c6d15 JK	19
	20	Metronomefb requires waveform information which is delivered via the AMLCD
	21	interface to the metronome controller. The waveform information is expected to
	22	be delivered from userspace via the firmware class interface. The waveform file
	23	can be compressed as long as your udev or hotplug script is aware of the need
03c33a4f JK	24	to uncompress it before delivering it. metronomefb will ask for metronome.wbf
03c33a4f JK	25	which would typically go into /lib/firmware/metronome.wbf depending on your
de7c6d15 JK	26	udev/hotplug setup. I have only tested with a single waveform file which was
	27	originally labeled 23P01201_60_WT0107_MTC. I do not know what it stands for.
	28	Caution should be exercised when manipulating the waveform as there may be
	29	a possibility that it could have some permanent effects on the display media.
	30	I neither have access to nor know exactly what the waveform does in terms of
	31	the physical media.
	32
	33	Metronomefb uses the deferred IO interface so that it can provide a memory
	34	mappable frame buffer. It has been tested with tinyx (Xfbdev). It is known
	35	to work at this time with xeyes, xclock, xloadimage, xpdf.
	36