leandrof/u-boot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
bfd4e660de
u-boot/doc/README.LED

78 lines
2.4 KiB
Plaintext
Raw Normal View History

LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
Status LED
========================================
This README describes the status LED API.
The API is defined by the include file include/status_led.h
status_led: Kconfig migration - introduction Move all of the status LED feature to drivers/led/Kconfig. doc/README.LED updated to reflect the Kconfig implementation. Tested boards: CL-SOM-AM57x, CM-T335 Signed-off-by: Uri Mashiach <uri.mashiach@compulab.co.il>
2017-01-19 08:51:05 +00:00
The first step is to enable CONFIG_LED_STATUS in menuconfig:
> Device Drivers > LED Support.
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
status_led: Kconfig migration - introduction Move all of the status LED feature to drivers/led/Kconfig. doc/README.LED updated to reflect the Kconfig implementation. Tested boards: CL-SOM-AM57x, CM-T335 Signed-off-by: Uri Mashiach <uri.mashiach@compulab.co.il>
2017-01-19 08:51:05 +00:00
If the LED support is only for specific board, enable
CONFIG_LED_STATUS_BOARD_SPECIFIC in the menuconfig.
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
status_led: Kconfig migration - introduction Move all of the status LED feature to drivers/led/Kconfig. doc/README.LED updated to reflect the Kconfig implementation. Tested boards: CL-SOM-AM57x, CM-T335 Signed-off-by: Uri Mashiach <uri.mashiach@compulab.co.il>
2017-01-19 08:51:05 +00:00
Status LEDS 0 to 5 are enabled by the following configurations at menuconfig:
CONFIG_STATUS_LED0, CONFIG_STATUS_LED1, ... CONFIG_STATUS_LED5
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
status_led: Kconfig migration - introduction Move all of the status LED feature to drivers/led/Kconfig. doc/README.LED updated to reflect the Kconfig implementation. Tested boards: CL-SOM-AM57x, CM-T335 Signed-off-by: Uri Mashiach <uri.mashiach@compulab.co.il>
2017-01-19 08:51:05 +00:00
The following should be configured for each of the enabled LEDs:
CONFIG_STATUS_LED_BIT<n>
CONFIG_STATUS_LED_STATE<n>
CONFIG_STATUS_LED_FREQ<n>
Where <n> is an integer 1 through 5 (empty for 0).
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
status_led: Kconfig migration - introduction Move all of the status LED feature to drivers/led/Kconfig. doc/README.LED updated to reflect the Kconfig implementation. Tested boards: CL-SOM-AM57x, CM-T335 Signed-off-by: Uri Mashiach <uri.mashiach@compulab.co.il>
2017-01-19 08:51:05 +00:00
CONFIG_STATUS_LED_BIT is passed into the __led_* functions to identify which LED
is being acted on. As such, the value choose must be unique with with respect to
the other CONFIG_STATUS_LED_BIT's. Mapping the value to a physical LED is the
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
reponsiblity of the __led_* function.
status_led: Kconfig migration - introduction Move all of the status LED feature to drivers/led/Kconfig. doc/README.LED updated to reflect the Kconfig implementation. Tested boards: CL-SOM-AM57x, CM-T335 Signed-off-by: Uri Mashiach <uri.mashiach@compulab.co.il>
2017-01-19 08:51:05 +00:00
CONFIG_STATUS_LED_STATE is the initial state of the LED. It should be set to one
of these values: CONFIG_LED_STATUS_OFF or CONFIG_LED_STATUS_ON.
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
status_led: Kconfig migration - introduction Move all of the status LED feature to drivers/led/Kconfig. doc/README.LED updated to reflect the Kconfig implementation. Tested boards: CL-SOM-AM57x, CM-T335 Signed-off-by: Uri Mashiach <uri.mashiach@compulab.co.il>
2017-01-19 08:51:05 +00:00
CONFIG_STATUS_LED_FREQ determines the LED blink frequency.
Values range from 2 to 10.
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
Some other LED macros
status_led: Kconfig migration - introduction Move all of the status LED feature to drivers/led/Kconfig. doc/README.LED updated to reflect the Kconfig implementation. Tested boards: CL-SOM-AM57x, CM-T335 Signed-off-by: Uri Mashiach <uri.mashiach@compulab.co.il>
2017-01-19 08:51:05 +00:00
---------------------
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
status_led: Kconfig migration - introduction Move all of the status LED feature to drivers/led/Kconfig. doc/README.LED updated to reflect the Kconfig implementation. Tested boards: CL-SOM-AM57x, CM-T335 Signed-off-by: Uri Mashiach <uri.mashiach@compulab.co.il>
2017-01-19 08:51:05 +00:00
CONFIG_STATUS_LED_BOOT is the LED to light when the board is booting.
This must be a valid LED number (0-5).
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
status_led: Kconfig migration - introduction Move all of the status LED feature to drivers/led/Kconfig. doc/README.LED updated to reflect the Kconfig implementation. Tested boards: CL-SOM-AM57x, CM-T335 Signed-off-by: Uri Mashiach <uri.mashiach@compulab.co.il>
2017-01-19 08:51:05 +00:00
CONFIG_STATUS_LED_RED is the red LED. It is used to signal errors. This must be
a valid LED number (0-5). Other similar color LED's macros are
CONFIG_STATUS_LED_GREEN, CONFIG_STATUS_LED_YELLOW and CONFIG_STATUS_LED_BLUE.
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
status_led: Kconfig migration - introduction Move all of the status LED feature to drivers/led/Kconfig. doc/README.LED updated to reflect the Kconfig implementation. Tested boards: CL-SOM-AM57x, CM-T335 Signed-off-by: Uri Mashiach <uri.mashiach@compulab.co.il>
2017-01-19 08:51:05 +00:00
General LED functions
---------------------
The following functions should be defined:
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
status_led: Kconfig migration - introduction Move all of the status LED feature to drivers/led/Kconfig. doc/README.LED updated to reflect the Kconfig implementation. Tested boards: CL-SOM-AM57x, CM-T335 Signed-off-by: Uri Mashiach <uri.mashiach@compulab.co.il>
2017-01-19 08:51:05 +00:00
__led_init is called once to initialize the LED to CONFIG_STATUS_LED_STATE.
One time start up code should be placed here.
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
Coding style cleanup; update CHANGELOG Signed-off-by: Wolfgang Denk <wd@denx.de>
2009-07-07 20:35:02 +00:00
__led_set is called to change the state of the LED.
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
__led_toggle is called to toggle the current state of the LED.
Colour LED
========================================
Coding style cleanup; update CHANGELOG Signed-off-by: Wolfgang Denk <wd@denx.de>
2009-07-07 20:35:02 +00:00
Colour LED's are at present only used by ARM.
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
The functions names explain their purpose.
coloured_LED_init
red_LED_on
red_LED_off
green_LED_on
green_LED_off
yellow_LED_on
yellow_LED_off
blue_LED_on
blue_LED_off
Move lib_$ARCH directories to arch/$ARCH/lib Also move lib_$ARCH/config.mk to arch/$ARCH/config.mk This change is intended to clean up the top-level directory structure and more closely mimic Linux's directory organization. Signed-off-by: Peter Tyser <ptyser@xes-inc.com>
2010-04-13 03:28:04 +00:00
These are weakly defined in arch/arm/lib/board.c to noops. Where applicable, define
LED Add documentation describing the status_led and colour led API. This document describes the u-boot status LED API. This allows common u-boot commands to use a board's leds to provide status for activities like booting and downloading files. Signed-off-by: Tom Rix <Tom.Rix@windriver.com>
2009-05-15 21:47:12 +00:00
these functions in the board specific source.
TBD : Describe older board dependent macros similar to what is done for
TBD : Describe general support via asm/status_led.h
Reference in New Issue Copy Permalink