status_led.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Raspberry Pi (Trading) Ltd.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

 
#ifndef _PICO_STATUS_LED_H
#define _PICO_STATUS_LED_H
 
#include "hardware/gpio.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(CYW43_WL_GPIO_LED_PIN)
#include "cyw43.h"
#endif
 
struct async_context;
 
 
// PICO_CONFIG: PICO_STATUS_LED_AVAILABLE, Indicate whether a single-color status LED is available, type=bool, default=1 if PICO_DEFAULT_LED_PIN or CYW43_WL_GPIO_LED_PIN is defined; may be set by the user to 0 to not use either even if they are available, group=pico_status_led
#ifndef PICO_STATUS_LED_AVAILABLE
#if defined(PICO_DEFAULT_LED_PIN) || defined(CYW43_WL_GPIO_LED_PIN)
#define PICO_STATUS_LED_AVAILABLE 1
#else
#define PICO_STATUS_LED_AVAILABLE 0
#endif
#endif
 
// PICO_CONFIG: PICO_COLORED_STATUS_LED_AVAILABLE, Indicate whether a colored status LED is available, type=bool, default=1 if PICO_DEFAULT_WS2812_PIN is defined; may be set by the user to 0 to not use the colored status LED even if available, group=pico_status_led
#ifndef PICO_COLORED_STATUS_LED_AVAILABLE
#ifdef PICO_DEFAULT_WS2812_PIN
#define PICO_COLORED_STATUS_LED_AVAILABLE 1
#else
#define PICO_COLORED_STATUS_LED_AVAILABLE 0
#endif
#endif    
 
// PICO_CONFIG: PICO_STATUS_LED_VIA_COLORED_STATUS_LED, Indicate if the colored status LED should be used for both status_led and colored_status_led APIs, type=bool, default=1 if PICO_COLORED_STATUS_LED_AVAILABLE is 1 and PICO_STATUS_LED_AVAILABLE is 0, group=pico_status_led
#ifndef PICO_STATUS_LED_VIA_COLORED_STATUS_LED
#define PICO_STATUS_LED_VIA_COLORED_STATUS_LED (PICO_COLORED_STATUS_LED_AVAILABLE && !PICO_STATUS_LED_AVAILABLE)
#endif
 
// PICO_CONFIG: PICO_COLORED_STATUS_LED_USES_WRGB, Indicate if the colored status LED supports WRGB, type=bool, default=0, group=pico_status_led
#ifndef PICO_COLORED_STATUS_LED_USES_WRGB
#define PICO_COLORED_STATUS_LED_USES_WRGB 0
#endif

#ifndef PICO_COLORED_STATUS_LED_COLOR_FROM_RGB
#define PICO_COLORED_STATUS_LED_COLOR_FROM_RGB(r, g, b) (((r) << 16) | ((g) << 8) | (b))
#endif

#ifndef PICO_COLORED_STATUS_LED_COLOR_FROM_WRGB
#define PICO_COLORED_STATUS_LED_COLOR_FROM_WRGB(w, r, g, b) (((w) << 24) | ((r) << 16) | ((g) << 8) | (b))
#endif
 
// PICO_CONFIG: PICO_DEFAULT_COLORED_STATUS_LED_ON_COLOR, the default pixel color value of the colored status LED when it is on, type=int, group=pico_status_led
#ifndef PICO_DEFAULT_COLORED_STATUS_LED_ON_COLOR
#if PICO_COLORED_STATUS_LED_USES_WRGB
#define PICO_DEFAULT_COLORED_STATUS_LED_ON_COLOR PICO_COLORED_STATUS_LED_COLOR_FROM_WRGB(0xaa, 0, 0, 0)
#else
#define PICO_DEFAULT_COLORED_STATUS_LED_ON_COLOR PICO_COLORED_STATUS_LED_COLOR_FROM_RGB(0xaa, 0xaa, 0xaa)
#endif
#endif

bool status_led_init(void);

bool status_led_init_with_context(struct async_context *context);

static inline bool colored_status_led_supported(void) {
    return PICO_COLORED_STATUS_LED_AVAILABLE;
}

static inline bool status_led_via_colored_status_led(void) {
    return PICO_STATUS_LED_VIA_COLORED_STATUS_LED;
}

static inline bool status_led_supported(void) {
    if (status_led_via_colored_status_led()) {
        return colored_status_led_supported();
    }
    return PICO_STATUS_LED_AVAILABLE;
}

bool colored_status_led_set_state(bool led_on);

bool colored_status_led_get_state(void);
    
bool colored_status_led_set_on_with_color(uint32_t color);

uint32_t colored_status_led_get_on_color(void);

static inline bool status_led_set_state(bool led_on) {
    if (status_led_via_colored_status_led()) {
        return colored_status_led_set_state(led_on);
    } else if (status_led_supported()) {
#if defined(PICO_DEFAULT_LED_PIN)
    #if PICO_DEFAULT_LED_PIN_INVERTED
        gpio_put(PICO_DEFAULT_LED_PIN, !led_on);
    #else
        gpio_put(PICO_DEFAULT_LED_PIN, led_on);
    #endif
        return true;
#elif defined(CYW43_WL_GPIO_LED_PIN)
        cyw43_gpio_set(&cyw43_state, CYW43_WL_GPIO_LED_PIN, led_on);
        return true;
#endif
    }
    return false;
}

static inline bool status_led_get_state() {
    if (status_led_via_colored_status_led()) {
        return colored_status_led_get_state();
    } else if (status_led_supported()) {
#if defined(PICO_DEFAULT_LED_PIN)
    #if PICO_DEFAULT_LED_PIN_INVERTED
        return !gpio_get(PICO_DEFAULT_LED_PIN);
    #else
        return gpio_get(PICO_DEFAULT_LED_PIN);
    #endif
#elif defined CYW43_WL_GPIO_LED_PIN
        bool value = false;
        cyw43_gpio_get(&cyw43_state, CYW43_WL_GPIO_LED_PIN, &value);
        return value;
#endif
    }
    return false;
}

void status_led_deinit();
 
#ifdef __cplusplus
}
#endif
 
#endif