path: root/doc
diff options
authorIlya Yanok <yanok@emcraft.com>2010-09-09 23:03:32 +0200
committerWolfgang Denk <wd@denx.de>2010-10-12 22:44:33 +0200
commit7f0d241d5ce8c7d0dff49f74498bf5708002424e (patch)
treeb387723c6e648381087103c11e9e95ee28f772a0 /doc
parent9531a2388ccaeaabb33a359a0bbf2e1d792c7dde (diff)
led_display: split led display support into generic and hw-dependent parts
Split the display command into generic interface and hardware-specific realization for PDSP188x LED display found on hmi1001 and manroland boards. Simple interface for LED displays is defined in include/led-display.h and described in doc/README.LED_display. Driver-specific implementation was moved into drivers/misc/pdsp188x.c file (enabled with CONFIG_PDSP188x set). Signed-off-by: Ilya Yanok <yanok@emcraft.com>
Diffstat (limited to 'doc')
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/README.LED_display b/doc/README.LED_display
new file mode 100644
index 000000000..521746e12
--- /dev/null
+++ b/doc/README.LED_display
@@ -0,0 +1,27 @@
+LED display internal API
+This README describes the LED display API.
+The API is defined by the include file include/led-display.h
+The first step in to define CONFIG_CMD_DISPLAY in the board config file.
+Then you need to provide the following functions to access LED display:
+void display_set(int cmd);
+This function should control the state of the LED display. Argument is
+an ORed combination of the following values:
+ DISPLAY_CLEAR -- clear the display
+ DISPLAY_HOME -- set the position to the beginning of display
+ DISPLAY_MARK -- enable mark (decimal point), if implemented
+int display_putc(char c);
+This function should display it's parameter on the LED display in the
+current position. Returns the displayed character on success or -1 in
+case of failure.
+With this functions defined 'display' command will display it's
+arguments on the LED display (or clear the display if called without