diff options
author | Mauro Carvalho Chehab <mchehab+samsung@kernel.org> | 2019-06-12 20:52:45 +0300 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2019-06-14 23:21:11 +0300 |
commit | ab42b818954c040fa13639dc031d8541edcecb4b (patch) | |
tree | baf9142b53b039fa58ca66af479156f4886c9cc8 /Documentation/fb/metronomefb.rst | |
parent | 10ffebbed5503b1830c7920ef528075785351be6 (diff) | |
download | linux-ab42b818954c040fa13639dc031d8541edcecb4b.tar.xz |
docs: fb: convert docs to ReST and rename to *.rst
The conversion is actually:
- add blank lines and identation in order to identify paragraphs;
- fix tables markups;
- add some lists markups;
- mark literal blocks;
- adjust title markups.
At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.
Also, removed the Maintained by, as requested by Geert.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/fb/metronomefb.rst')
-rw-r--r-- | Documentation/fb/metronomefb.rst | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/Documentation/fb/metronomefb.rst b/Documentation/fb/metronomefb.rst new file mode 100644 index 000000000000..63e1d31a7e54 --- /dev/null +++ b/Documentation/fb/metronomefb.rst @@ -0,0 +1,38 @@ +=========== +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. |