doc/README.LED_display

   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
  17  DISPLAY_MARK   -- enable mark (decimal point), if implemented
  18
  19 int display_putc(char c);
  20
  21 This function should display it's parameter on the LED display in the
  22 current position. Returns the displayed character on success or -1 in
  23 case of failure.
  24
  25 With this functions defined 'display' command will display it's
  26 arguments on the LED display (or clear the display if called without
  27 arguments).