[people/ms/u-boot.git] / doc / README.LED_display

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

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
arguments).
Commit	Line	Data
7f0d241d IY	1	LED display internal API
	2	=======================================
	3
	4	This README describes the LED display API.
	5
	6	The API is defined by the include file include/led-display.h
	7
	8	The first step in to define CONFIG_CMD_DISPLAY in the board config file.
	9	Then you need to provide the following functions to access LED display:
	10
	11	void display_set(int cmd);
	12
	13	This function should control the state of the LED display. Argument is
	14	an ORed combination of the following values:
	15	DISPLAY_CLEAR -- clear the display
	16	DISPLAY_HOME -- set the position to the beginning of display
7f0d241d IY	17
	18	int display_putc(char c);
	19
	20	This function should display it's parameter on the LED display in the
	21	current position. Returns the displayed character on success or -1 in
	22	case of failure.
	23
	24	With this functions defined 'display' command will display it's
	25	arguments on the LED display (or clear the display if called without
	26	arguments).