Documentation/fb/metronomefb.rst

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