diff options
| author | Tom Rini <[email protected]> | 2026-04-06 12:16:57 -0600 |
|---|---|---|
| committer | Tom Rini <[email protected]> | 2026-04-06 12:16:57 -0600 |
| commit | 93f84ee022a8401421cdaab84fe7d106d83fdb4a (patch) | |
| tree | fb15a4af876e8faf9893fd86c1c0e127265dbe9a /doc/api | |
| parent | 88dc2788777babfd6322fa655df549a019aa1e69 (diff) | |
| parent | e2138cf1e6088f12ffa874e87cc8f4b198378635 (diff) | |
Merge branch 'next'
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/led.rst | 63 |
1 files changed, 0 insertions, 63 deletions
diff --git a/doc/api/led.rst b/doc/api/led.rst index 9ae3f5fe252..fe1904aea0d 100644 --- a/doc/api/led.rst +++ b/doc/api/led.rst @@ -8,66 +8,3 @@ LED .. kernel-doc:: include/led.h :internal: - -Legacy LED -========== - -Please use the new LED API as defined above. This section is only for reference -for currently supported devices and to aid for migration to the new API. - -Status LED ----------- - -This README describes the status LED API. - -The API is defined by the include file include/status_led.h - -The first step is to enable CONFIG_LED_STATUS in menuconfig:: - - > Device Drivers > LED Support. - -If the LED support is only for specific board, enable -CONFIG_LED_STATUS_BOARD_SPECIFIC in the menuconfig. - -Status LEDS 0 to 5 are enabled by the following configurations at menuconfig: -CONFIG_STATUS_LED0, CONFIG_STATUS_LED1, ... CONFIG_STATUS_LED5 - -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). - -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 respect to -the other CONFIG_STATUS_LED_BIT's. Mapping the value to a physical LED is the -reponsiblity of the __led_* function. - -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. - -CONFIG_STATUS_LED_FREQ determines the LED blink frequency. -Values range from 2 to 10. - -Some other LED macros -~~~~~~~~~~~~~~~~~~~~~ - -CONFIG_STATUS_LED_BOOT is the LED to light when the board is booting. -This must be a valid LED number (0-5). - -General LED functions -~~~~~~~~~~~~~~~~~~~~~ -The following functions should be defined: - -__led_init is called once to initialize the LED to CONFIG_STATUS_LED_STATE. -One time start up code should be placed here. - -__led_set is called to change the state of the LED. - -__led_toggle is called to toggle the current state of the LED. - -TBD : Describe older board dependent macros similar to what is done for - -TBD : Describe general support via asm/status_led.h |